Allow sign/verify digest directly

currently sign/verify works on message directly, it would be nice if PSS could sign/verify digest directly. This is useful for:

  1) for some signing server it only has a digest (without message)
  2) message could be very large, for cases when client need request a singing server to sign, it may make more sense for the client to compute digest, then ask server to (PSS) sign the digest
  3) openSSL pkeyutl (PSS) sign operation signs with digest only, not the message, it would be nice to work with openSSL more easily 

*openSSL command line:
```shell
openssl pkeyutl -pkeyopt rsa_padding_mode:pss -pkeyopt rsa_pss_saltlen:-1  -pkeyopt digest:sha256 -sign -inkey "pri.key" -in hmac.bin > sig.bin
openssl pkeyutl -pkeyopt rsa_padding_mode:pss -pkeyopt rsa_pss_saltlen:-1  -pkeyopt digest:sha256 -verify -inkey "pri.key" -in hmac.bin -sigfile sig.bin
```
This commit is contained in:
Baojun Wang 2017-05-15 19:42:19 -07:00 committed by GitHub
parent 554f0fc701
commit f9a0bc3c53

View File

@ -11,9 +11,13 @@ module Crypto.PubKey.RSA.PSS
, defaultPSSParamsSHA1 , defaultPSSParamsSHA1
-- * Sign and verify functions -- * Sign and verify functions
, signWithSalt , signWithSalt
, signDigestWithSalt
, sign , sign
, signDigest
, signSafer , signSafer
, signDigestSafer
, verify , verify
, verifyDigest
) where ) where
import Crypto.Random.Types import Crypto.Random.Types
@ -27,6 +31,7 @@ import Data.Word
import Crypto.Internal.ByteArray (ByteArrayAccess, ByteArray) import Crypto.Internal.ByteArray (ByteArrayAccess, ByteArray)
import qualified Crypto.Internal.ByteArray as B (convert) import qualified Crypto.Internal.ByteArray as B (convert)
import Data.ByteString (ByteString) import Data.ByteString (ByteString)
import qualified Data.ByteString as B import qualified Data.ByteString as B
@ -53,6 +58,32 @@ defaultPSSParams hashAlg =
defaultPSSParamsSHA1 :: PSSParams SHA1 ByteString ByteString defaultPSSParamsSHA1 :: PSSParams SHA1 ByteString ByteString
defaultPSSParamsSHA1 = defaultPSSParams SHA1 defaultPSSParamsSHA1 = defaultPSSParams SHA1
-- | Sign using the PSS parameters and the salt explicitely passed as parameters.
--
-- the function ignore SaltLength from the PSS Parameters
signDigestWithSalt :: HashAlgorithm hash
=> ByteString -- ^ Salt to use
-> Maybe Blinder -- ^ optional blinder to use
-> PSSParams hash ByteString ByteString -- ^ PSS Parameters to use
-> PrivateKey -- ^ RSA Private Key
-> ByteString -- ^ Message digest
-> Either Error ByteString
signDigestWithSalt salt blinder params pk mHash
| k < hashLen + saltLen + 2 = Left InvalidParameters
| hashLen /= B.length mHash = Left InvalidParameters
| otherwise = Right $ dp blinder pk em
where k = private_size pk
dbLen = k - hashLen - 1
saltLen = B.length salt
hashLen = hashDigestSize (pssHash params)
pubBits = private_size pk * 8 -- to change if public_size is converted in bytes
m' = B.concat [B.replicate 8 0,mHash,salt]
h = B.convert $ hashWith (pssHash params) m'
db = B.concat [B.replicate (dbLen - saltLen - 1) 0,B.singleton 1,salt]
dbmask = (pssMaskGenAlg params) h dbLen
maskedDB = B.pack $ normalizeToKeySize pubBits $ B.zipWith xor db dbmask
em = B.concat [maskedDB, h, B.singleton (pssTrailerField params)]
-- | Sign using the PSS parameters and the salt explicitely passed as parameters. -- | Sign using the PSS parameters and the salt explicitely passed as parameters.
-- --
-- the function ignore SaltLength from the PSS Parameters -- the function ignore SaltLength from the PSS Parameters
@ -63,22 +94,8 @@ signWithSalt :: HashAlgorithm hash
-> PrivateKey -- ^ RSA Private Key -> PrivateKey -- ^ RSA Private Key
-> ByteString -- ^ Message to sign -> ByteString -- ^ Message to sign
-> Either Error ByteString -> Either Error ByteString
signWithSalt salt blinder params pk m signWithSalt salt blinder params pk m = signDigestWithSalt salt blinder params pk mHash
| k < hashLen + saltLen + 2 = Left InvalidParameters
| otherwise = Right $ dp blinder pk em
where mHash = B.convert $ hashWith (pssHash params) m where mHash = B.convert $ hashWith (pssHash params) m
k = private_size pk
dbLen = k - hashLen - 1
saltLen = B.length salt
hashLen = hashDigestSize (pssHash params)
pubBits = private_size pk * 8 -- to change if public_size is converted in bytes
m' = B.concat [B.replicate 8 0,mHash,salt]
h = B.convert $ hashWith (pssHash params) m'
db = B.concat [B.replicate (dbLen - saltLen - 1) 0,B.singleton 1,salt]
dbmask = (pssMaskGenAlg params) h dbLen
maskedDB = B.pack $ normalizeToKeySize pubBits $ B.zipWith xor db dbmask
em = B.concat [maskedDB, h, B.singleton (pssTrailerField params)]
-- | Sign using the PSS Parameters -- | Sign using the PSS Parameters
sign :: (HashAlgorithm hash, MonadRandom m) sign :: (HashAlgorithm hash, MonadRandom m)
@ -91,6 +108,17 @@ sign blinder params pk m = do
salt <- getRandomBytes (pssSaltLength params) salt <- getRandomBytes (pssSaltLength params)
return (signWithSalt salt blinder params pk m) return (signWithSalt salt blinder params pk m)
-- | Sign using the PSS Parameters
signDigest :: (HashAlgorithm hash, MonadRandom m)
=> Maybe Blinder -- ^ optional blinder to use
-> PSSParams hash ByteString ByteString -- ^ PSS Parameters to use
-> PrivateKey -- ^ RSA Private Key
-> ByteString -- ^ Message digest
-> m (Either Error ByteString)
signDigest blinder params pk digest = do
salt <- getRandomBytes (pssSaltLength params)
return (signDigestWithSalt salt blinder params pk digest)
-- | Sign using the PSS Parameters and an automatically generated blinder. -- | Sign using the PSS Parameters and an automatically generated blinder.
signSafer :: (HashAlgorithm hash, MonadRandom m) signSafer :: (HashAlgorithm hash, MonadRandom m)
=> PSSParams hash ByteString ByteString -- ^ PSS Parameters to use => PSSParams hash ByteString ByteString -- ^ PSS Parameters to use
@ -101,6 +129,16 @@ signSafer params pk m = do
blinder <- generateBlinder (private_n pk) blinder <- generateBlinder (private_n pk)
sign (Just blinder) params pk m sign (Just blinder) params pk m
-- | Sign using the PSS Parameters and an automatically generated blinder.
signDigestSafer :: (HashAlgorithm hash, MonadRandom m)
=> PSSParams hash ByteString ByteString -- ^ PSS Parameters to use
-> PrivateKey -- ^ private key
-> ByteString -- ^ message digst
-> m (Either Error ByteString)
signDigestSafer params pk digest = do
blinder <- generateBlinder (private_n pk)
signDigest (Just blinder) params pk digest
-- | Verify a signature using the PSS Parameters -- | Verify a signature using the PSS Parameters
verify :: HashAlgorithm hash verify :: HashAlgorithm hash
=> PSSParams hash ByteString ByteString => PSSParams hash ByteString ByteString
@ -110,7 +148,19 @@ verify :: HashAlgorithm hash
-> ByteString -- ^ Message to verify -> ByteString -- ^ Message to verify
-> ByteString -- ^ Signature -> ByteString -- ^ Signature
-> Bool -> Bool
verify params pk m s verify params pk m s = verifyDigest params pk mHash s
where mHash = B.convert $ hashWith (pssHash params) m
-- | Verify a signature using the PSS Parameters
verifyDigest :: HashAlgorithm hash
=> PSSParams hash ByteString ByteString
-- ^ PSS Parameters to use to verify,
-- this need to be identical to the parameters when signing
-> PublicKey -- ^ RSA Public Key
-> ByteString -- ^ Digest to verify
-> ByteString -- ^ Signature
-> Bool
verifyDigest params pk mHash s
| public_size pk /= B.length s = False | public_size pk /= B.length s = False
| B.last em /= pssTrailerField params = False | B.last em /= pssTrailerField params = False
| not (B.all (== 0) ps0) = False | not (B.all (== 0) ps0) = False
@ -128,7 +178,6 @@ verify params pk m s
db = B.pack $ normalizeToKeySize pubBits $ B.zipWith xor maskedDB dbmask db = B.pack $ normalizeToKeySize pubBits $ B.zipWith xor maskedDB dbmask
(ps0,z) = B.break (== 1) db (ps0,z) = B.break (== 1) db
(b1,salt) = B.splitAt 1 z (b1,salt) = B.splitAt 1 z
mHash = B.convert $ hashWith (pssHash params) m
m' = B.concat [B.replicate 8 0,mHash,salt] m' = B.concat [B.replicate 8 0,mHash,salt]
h' = hashWith (pssHash params) m' h' = hashWith (pssHash params) m'
@ -137,3 +186,4 @@ normalizeToKeySize _ [] = [] -- very unlikely
normalizeToKeySize bits (x:xs) = x .&. mask : xs normalizeToKeySize bits (x:xs) = x .&. mask : xs
where mask = if sh > 0 then 0xff `shiftR` (8-sh) else 0xff where mask = if sh > 0 then 0xff `shiftR` (8-sh) else 0xff
sh = ((bits-1) .&. 0x7) sh = ((bits-1) .&. 0x7)