module Crypto.JOSE.JWE
(
JWEHeader(..)
, JWE(..)
) where
import Control.Applicative ((<|>))
import Data.Bifunctor (bimap)
import Data.Maybe (catMaybes, fromMaybe)
import Data.Monoid ((<>))
import Data.Aeson
import Data.Aeson.Types
import qualified Data.ByteArray as BA
import qualified Data.ByteString as B
import qualified Data.ByteString.Lazy as L
import qualified Data.Text as T
import Data.List.NonEmpty (NonEmpty)
import Crypto.Cipher.AES
import Crypto.Cipher.Types
import Crypto.Data.Padding
import Crypto.Error
import Crypto.Hash
import Crypto.MAC.HMAC
import Crypto.PubKey.MaskGenFunction
import qualified Crypto.PubKey.RSA.OAEP as OAEP
import Crypto.JOSE.AESKW
import Crypto.JOSE.Error
import Crypto.JOSE.Header
import Crypto.JOSE.JWA.JWE
import Crypto.JOSE.JWK
import qualified Crypto.JOSE.Types as Types
import qualified Crypto.JOSE.Types.Internal as Types
critInvalidNames :: [T.Text]
critInvalidNames =
[ "alg" , "enc" , "zip" , "jku" , "jwk" , "kid"
, "x5u" , "x5c" , "x5t" , "x5t#S256" , "typ" , "cty" , "crit" ]
newtype CritParameters = CritParameters (NonEmpty (T.Text, Value))
deriving (Eq, Show)
data JWEHeader = JWEHeader
{ _jweAlg :: Maybe AlgWithParams
, _jweEnc :: HeaderParam Enc
, _jweZip :: Maybe String
, _jweJku :: Maybe (HeaderParam Types.URI)
, _jweJwk :: Maybe (HeaderParam JWK)
, _jweKid :: Maybe (HeaderParam String)
, _jweX5u :: Maybe (HeaderParam Types.URI)
, _jweX5c :: Maybe (HeaderParam (NonEmpty Types.Base64X509))
, _jweX5t :: Maybe (HeaderParam Types.Base64SHA1)
, _jweX5tS256 :: Maybe (HeaderParam Types.Base64SHA256)
, _jweTyp :: Maybe (HeaderParam String)
, _jweCty :: Maybe (HeaderParam String)
, _jweCrit :: Maybe (NonEmpty T.Text)
}
deriving (Eq, Show)
newJWEHeader :: AlgWithParams -> Enc -> JWEHeader
newJWEHeader alg enc =
JWEHeader (Just alg) (HeaderParam Unprotected enc) z z z z z z z z z z z
where z = Nothing
instance HasParams JWEHeader where
parseParamsFor proxy hp hu = JWEHeader
<$> parseJSON (Object (fromMaybe mempty hp <> fromMaybe mempty hu))
<*> headerRequired "enc" hp hu
<*> headerOptionalProtected "zip" hp hu
<*> headerOptional "jku" hp hu
<*> headerOptional "jwk" hp hu
<*> headerOptional "kid" hp hu
<*> headerOptional "x5u" hp hu
<*> headerOptional "x5c" hp hu
<*> headerOptional "x5t" hp hu
<*> headerOptional "x5t#S256" hp hu
<*> headerOptional "typ" hp hu
<*> headerOptional "cty" hp hu
<*> (headerOptionalProtected "crit" hp hu
>>= parseCrit critInvalidNames (extensions proxy)
(fromMaybe mempty hp <> fromMaybe mempty hu))
params (JWEHeader alg enc zip' jku jwk kid x5u x5c x5t x5tS256 typ cty crit) =
catMaybes
[ undefined
, Just (protection enc, "enc" .= param enc)
, fmap (\p -> (Protected, "zip" .= p)) zip'
, fmap (\p -> (protection p, "jku" .= param p)) jku
, fmap (\p -> (protection p, "jwk" .= param p)) jwk
, fmap (\p -> (protection p, "kid" .= param p)) kid
, fmap (\p -> (protection p, "x5u" .= param p)) x5u
, fmap (\p -> (protection p, "x5c" .= param p)) x5c
, fmap (\p -> (protection p, "x5t" .= param p)) x5t
, fmap (\p -> (protection p, "x5t#S256" .= param p)) x5tS256
, fmap (\p -> (protection p, "typ" .= param p)) typ
, fmap (\p -> (protection p, "cty" .= param p)) cty
, fmap (\p -> (Protected, "crit" .= p)) crit
]
data JWERecipient a = JWERecipient
{ _jweHeader :: a
, _jweEncryptedKey :: Maybe Types.Base64Octets
}
instance FromJSON (JWERecipient a) where
parseJSON = withObject "JWE Recipient" $ \o -> JWERecipient
<$> undefined
<*> o .:? "encrypted_key"
parseRecipient :: HasParams a => Maybe Object -> Maybe Object -> Value -> Parser (JWERecipient a)
parseRecipient hp hu = withObject "JWE Recipient" $ \o -> do
hr <- o .:? "header"
JWERecipient
<$> parseParams hp (hu <> hr)
<*> o .:? "encrypted_key"
data JWE a = JWE
{ _protectedRaw :: (Maybe T.Text)
, _jweIv :: Maybe Types.Base64Octets
, _jweAad :: Maybe Types.Base64Octets
, _jweCiphertext :: Types.Base64Octets
, _jweTag :: Maybe Types.Base64Octets
, _jweRecipients :: [JWERecipient a]
}
instance HasParams a => FromJSON (JWE a) where
parseJSON = withObject "JWE JSON Serialization" $ \o -> do
hpB64 <- o .:? "protected"
hp <- maybe
(pure Nothing)
(withText "base64url-encoded header params"
(Types.parseB64Url (maybe
(fail "protected header contains invalid JSON")
pure . decode . L.fromStrict)))
hpB64
hu <- o .:? "unprotected"
JWE
<$> (Just <$> (o .: "protected" <|> pure ""))
<*> o .:? "iv"
<*> o .:? "aad"
<*> o .: "ciphertext"
<*> o .:? "tag"
<*> (o .: "recipients" >>= traverse (parseRecipient hp hu))
wrap
:: MonadRandom m
=> AlgWithParams
-> KeyMaterial
-> B.ByteString
-> m (Either Error (AlgWithParams, B.ByteString))
wrap alg@RSA_OAEP (RSAKeyMaterial k) m = bimap RSAError (alg,) <$>
OAEP.encrypt (OAEP.OAEPParams SHA1 (mgf1 SHA1) Nothing) (rsaPublicKey k) m
wrap RSA_OAEP _ _ = return $ Left $ AlgorithmMismatch "Cannot use RSA_OAEP with non-RSA key"
wrap alg@RSA_OAEP_256 (RSAKeyMaterial k) m = bimap RSAError (alg,) <$>
OAEP.encrypt (OAEP.OAEPParams SHA256 (mgf1 SHA256) Nothing) (rsaPublicKey k) m
wrap RSA_OAEP_256 _ _ = return $ Left $ AlgorithmMismatch "Cannot use RSA_OAEP_256 with non-RSA key"
wrap A128KW (OctKeyMaterial (OctKeyParameters _ (Types.Base64Octets k))) m
= return $ (A128KW,) <$> wrapAESKW (cipherInit k :: CryptoFailable AES128) m
wrap A192KW (OctKeyMaterial (OctKeyParameters _ (Types.Base64Octets k))) m
= return $ (A192KW,) <$> wrapAESKW (cipherInit k :: CryptoFailable AES192) m
wrap A256KW (OctKeyMaterial (OctKeyParameters _ (Types.Base64Octets k))) m
= return $ (A256KW,) <$> wrapAESKW (cipherInit k :: CryptoFailable AES256) m
wrap (A128GCMKW _) k m = wrapAESGCM A128GCMKW A128GCM k m
wrap (A192GCMKW _) k m = wrapAESGCM A192GCMKW A192GCM k m
wrap (A256GCMKW _) k m = wrapAESGCM A256GCMKW A256GCM k m
wrap _ _ _ = return $ Left AlgorithmNotImplemented
wrapAESKW
:: BlockCipher128 cipher
=> CryptoFailable cipher
-> B.ByteString
-> Either Error B.ByteString
wrapAESKW cipher m = case cipher of
CryptoFailed e -> Left (CryptoError e)
CryptoPassed cipher' -> Right (aesKeyWrap cipher' m)
wrapAESGCM
:: MonadRandom m
=> (AESGCMParameters -> AlgWithParams)
-> Enc
-> KeyMaterial
-> B.ByteString
-> m (Either Error (AlgWithParams, B.ByteString))
wrapAESGCM f enc (OctKeyMaterial (OctKeyParameters _ (Types.Base64Octets k))) m =
fmap (\(iv, tag, m') -> (f (AESGCMParameters (Types.Base64Octets iv) (Types.Base64Octets tag)), m'))
<$> encrypt enc k m ""
wrapAESGCM _ _ _ _ = return $ Left $ AlgorithmMismatch "Cannot use AESGCMKW with non-Oct key"
encrypt
:: MonadRandom m
=> Enc
-> B.ByteString
-> B.ByteString
-> B.ByteString
-> m (Either Error (B.ByteString, B.ByteString, B.ByteString))
encrypt A128CBC_HS256 k m a = case B.length k of
32 -> _cbcHmacEnc (undefined :: AES128) SHA256 k m a
_ -> return $ Left KeySizeTooSmall
encrypt A192CBC_HS384 k m a = case B.length k of
48 -> _cbcHmacEnc (undefined :: AES192) SHA384 k m a
_ -> return $ Left KeySizeTooSmall
encrypt A256CBC_HS512 k m a = case B.length k of
64 -> _cbcHmacEnc (undefined :: AES256) SHA512 k m a
_ -> return $ Left KeySizeTooSmall
encrypt A128GCM k m a = case B.length k of
16 -> _gcmEnc (undefined :: AES128) k m a
_ -> return $ Left KeySizeTooSmall
encrypt A192GCM k m a = case B.length k of
24 -> _gcmEnc (undefined :: AES192) k m a
_ -> return $ Left KeySizeTooSmall
encrypt A256GCM k m a = case B.length k of
32 -> _gcmEnc (undefined :: AES256) k m a
_ -> return $ Left KeySizeTooSmall
_cbcHmacEnc
:: forall e h m. (BlockCipher e, HashAlgorithm h, MonadRandom m)
=> e
-> h
-> B.ByteString
-> B.ByteString
-> B.ByteString
-> m (Either Error (B.ByteString, B.ByteString, B.ByteString))
_cbcHmacEnc _ _ k m aad = do
let
kLen = B.length k `div` 2
(eKey, mKey) = B.splitAt kLen k
aadLen = B.reverse $ fst $ B.unfoldrN 8 (\x -> Just (fromIntegral x, x `div` 256)) (B.length aad)
case cipherInit eKey of
CryptoFailed _ -> return $ Left AlgorithmNotImplemented
CryptoPassed (e :: e) -> do
iv <- getRandomBytes 16
let Just iv' = makeIV iv
let m' = pad (PKCS7 $ blockSize e) m
let c = cbcEncrypt e iv' m'
let hmacInput = B.concat [aad, iv, c, aadLen]
let tag = B.take kLen $ BA.pack $ BA.unpack (hmac mKey hmacInput :: HMAC h)
return $ Right (iv, c, tag)
_gcmEnc
:: forall e m. (BlockCipher e, MonadRandom m)
=> e
-> B.ByteString
-> B.ByteString
-> B.ByteString
-> m (Either Error (B.ByteString, B.ByteString, B.ByteString))
_gcmEnc _ k m aad = do
iv <- getRandomBytes 12
case cipherInit k of
CryptoFailed _ -> return $ Left AlgorithmNotImplemented
CryptoPassed (e :: e) -> case aeadInit AEAD_GCM e iv of
CryptoFailed _ -> return $ Left AlgorithmNotImplemented
CryptoPassed aead -> do
let m' = pad (PKCS7 $ blockSize e) m
let (c, aeadFinal) = aeadEncrypt (aeadAppendHeader aead aad) m'
let tag = BA.pack $ BA.unpack $ aeadFinalize aeadFinal 16
return $ Right (iv, tag, c)