Crypto.PubKey.DSA

cryptonite-0.30: Cryptography Primitives sink

License | BSD-style
Maintainer | Vincent Hanquez <vincent@snarc.org>
Stability | experimental
Portability | Good
Safe Haskell | Safe-Inferred
Language | Haskell2010

Crypto.PubKey.DSA

Contents

- Generation
- Signature primitive
- Verification primitive
- Key pair

Description

An implementation of the Digital Signature Algorithm (DSA)

Synopsis

- data Params = Params {
  - params_p :: Integer
  - params_g :: Integer
  - params_q :: Integer
  }
- data Signature = Signature {
  - sign_r :: Integer
  - sign_s :: Integer
  }
- data PublicKey = PublicKey {
  - public_params :: Params
  - public_y :: PublicNumber
  }
- data PrivateKey = PrivateKey {
  - private_params :: Params
  - private_x :: PrivateNumber
  }
- type PublicNumber = Integer
- type PrivateNumber = Integer
- generatePrivate :: MonadRandom m => Params -> m PrivateNumber
- calculatePublic :: Params -> PrivateNumber -> PublicNumber
- sign :: (ByteArrayAccess msg, HashAlgorithm hash, MonadRandom m) => PrivateKey -> hash -> msg -> m Signature
- signWith :: (ByteArrayAccess msg, HashAlgorithm hash) => Integer -> PrivateKey -> hash -> msg -> Maybe Signature
- verify :: (ByteArrayAccess msg, HashAlgorithm hash) => hash -> PublicKey -> Signature -> msg -> Bool
- data KeyPair = KeyPair Params PublicNumber PrivateNumber
- toPublicKey :: KeyPair -> PublicKey
- toPrivateKey :: KeyPair -> PrivateKey

# Documentation

data Params #

Represent DSA parameters namely P, G, and Q.

Constructors

Params |
Fields params_p :: Integer DSA p params_g :: Integer DSA g params_q :: Integer DSA q

#### Instances

Instances details

Data Params # |
Instance details Defined in Crypto.PubKey.DSA Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Params -> c Params # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Params # toConstr :: Params -> Constr # dataTypeOf :: Params -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Params) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Params) # gmapT :: (forall b. Data b => b -> b) -> Params -> Params # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Params -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Params -> r # gmapQ :: (forall d. Data d => d -> u) -> Params -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Params -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Params -> m Params # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Params -> m Params # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Params -> m Params #
Read Params # |
Instance details Defined in Crypto.PubKey.DSA Methods readsPrec :: Int -> ReadS Params readList :: ReadS [Params] readPrec :: ReadPrec Params readListPrec :: ReadPrec [Params]
Show Params # |
Instance details Defined in Crypto.PubKey.DSA Methods showsPrec :: Int -> Params -> ShowS # show :: Params -> String # showList :: [Params] -> ShowS #
NFData Params # |
Instance details Defined in Crypto.PubKey.DSA Methods rnf :: Params -> ()
Eq Params # |
Instance details Defined in Crypto.PubKey.DSA Methods (==) :: Params -> Params -> Bool # (/=) :: Params -> Params -> Bool #

data Signature #

Represent a DSA signature namely R and S.

Constructors

Signature |
Fields sign_r :: Integer DSA r sign_s :: Integer DSA s

#### Instances

Instances details

Data Signature # |
Instance details Defined in Crypto.PubKey.DSA Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Signature -> c Signature # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Signature # toConstr :: Signature -> Constr # dataTypeOf :: Signature -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Signature) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Signature) # gmapT :: (forall b. Data b => b -> b) -> Signature -> Signature # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Signature -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Signature -> r # gmapQ :: (forall d. Data d => d -> u) -> Signature -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Signature -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Signature -> m Signature # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Signature -> m Signature # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Signature -> m Signature #
Read Signature # |
Instance details Defined in Crypto.PubKey.DSA Methods readsPrec :: Int -> ReadS Signature readList :: ReadS [Signature] readPrec :: ReadPrec Signature readListPrec :: ReadPrec [Signature]
Show Signature # |
Instance details Defined in Crypto.PubKey.DSA Methods showsPrec :: Int -> Signature -> ShowS # show :: Signature -> String # showList :: [Signature] -> ShowS #
NFData Signature # |
Instance details Defined in Crypto.PubKey.DSA Methods rnf :: Signature -> ()
Eq Signature # |
Instance details Defined in Crypto.PubKey.DSA Methods (==) :: Signature -> Signature -> Bool # (/=) :: Signature -> Signature -> Bool #

data PublicKey #

Represent a DSA public key.

Constructors

PublicKey |
Fields public_params :: Params DSA parameters public_y :: PublicNumber DSA public Y

#### Instances

Instances details

Data PublicKey # |
Instance details Defined in Crypto.PubKey.DSA Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PublicKey -> c PublicKey # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PublicKey # toConstr :: PublicKey -> Constr # dataTypeOf :: PublicKey -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PublicKey) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PublicKey) # gmapT :: (forall b. Data b => b -> b) -> PublicKey -> PublicKey # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PublicKey -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PublicKey -> r # gmapQ :: (forall d. Data d => d -> u) -> PublicKey -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PublicKey -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PublicKey -> m PublicKey # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PublicKey -> m PublicKey # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PublicKey -> m PublicKey #
Read PublicKey # |
Instance details Defined in Crypto.PubKey.DSA Methods readsPrec :: Int -> ReadS PublicKey readList :: ReadS [PublicKey] readPrec :: ReadPrec PublicKey readListPrec :: ReadPrec [PublicKey]
Show PublicKey # |
Instance details Defined in Crypto.PubKey.DSA Methods showsPrec :: Int -> PublicKey -> ShowS # show :: PublicKey -> String # showList :: [PublicKey] -> ShowS #
NFData PublicKey # |
Instance details Defined in Crypto.PubKey.DSA Methods rnf :: PublicKey -> ()
Eq PublicKey # |
Instance details Defined in Crypto.PubKey.DSA Methods (==) :: PublicKey -> PublicKey -> Bool # (/=) :: PublicKey -> PublicKey -> Bool #

data PrivateKey #

Represent a DSA private key.

Only x need to be secret. the DSA parameters are publicly shared with the other side.

Constructors

PrivateKey |
Fields private_params :: Params DSA parameters private_x :: PrivateNumber DSA private X

#### Instances

Instances details

Data PrivateKey # |
Instance details Defined in Crypto.PubKey.DSA Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PrivateKey -> c PrivateKey # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PrivateKey # toConstr :: PrivateKey -> Constr # dataTypeOf :: PrivateKey -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PrivateKey) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PrivateKey) # gmapT :: (forall b. Data b => b -> b) -> PrivateKey -> PrivateKey # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PrivateKey -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PrivateKey -> r # gmapQ :: (forall d. Data d => d -> u) -> PrivateKey -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PrivateKey -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PrivateKey -> m PrivateKey # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PrivateKey -> m PrivateKey # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PrivateKey -> m PrivateKey #
Read PrivateKey # |
Instance details Defined in Crypto.PubKey.DSA Methods readsPrec :: Int -> ReadS PrivateKey readList :: ReadS [PrivateKey] readPrec :: ReadPrec PrivateKey readListPrec :: ReadPrec [PrivateKey]
Show PrivateKey # |
Instance details Defined in Crypto.PubKey.DSA Methods showsPrec :: Int -> PrivateKey -> ShowS # show :: PrivateKey -> String # showList :: [PrivateKey] -> ShowS #
NFData PrivateKey # |
Instance details Defined in Crypto.PubKey.DSA Methods rnf :: PrivateKey -> ()
Eq PrivateKey # |
Instance details Defined in Crypto.PubKey.DSA Methods (==) :: PrivateKey -> PrivateKey -> Bool # (/=) :: PrivateKey -> PrivateKey -> Bool #

type PublicNumber = Integer #

DSA Public Number, usually embedded in DSA Public Key

type PrivateNumber = Integer #

DSA Private Number, usually embedded in DSA Private Key

# Generation

generatePrivate :: MonadRandom m => Params -> m PrivateNumber #

generate a private number with no specific property this number is usually called X in DSA text.

calculatePublic :: Params -> PrivateNumber -> PublicNumber #

Calculate the public number from the parameters and the private key

# Signature primitive

sign :: (ByteArrayAccess msg, HashAlgorithm hash, MonadRandom m) => PrivateKey -> hash -> msg -> m Signature #

sign message using the private key.

signWith #

Arguments

:: (ByteArrayAccess msg, HashAlgorithm hash) |
=> Integer | k random number
-> PrivateKey | private key
-> hash | hash function
-> msg | message to sign
-> Maybe Signature |

sign message using the private key and an explicit k number.

# Verification primitive

verify :: (ByteArrayAccess msg, HashAlgorithm hash) => hash -> PublicKey -> Signature -> msg -> Bool #

verify a bytestring using the public key.

# Key pair

data KeyPair #

Represent a DSA key pair

Constructors

KeyPair Params PublicNumber PrivateNumber |

#### Instances

Instances details

Data KeyPair # |
Instance details Defined in Crypto.PubKey.DSA Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> KeyPair -> c KeyPair # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c KeyPair # toConstr :: KeyPair -> Constr # dataTypeOf :: KeyPair -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c KeyPair) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c KeyPair) # gmapT :: (forall b. Data b => b -> b) -> KeyPair -> KeyPair # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> KeyPair -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> KeyPair -> r # gmapQ :: (forall d. Data d => d -> u) -> KeyPair -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> KeyPair -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> KeyPair -> m KeyPair # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> KeyPair -> m KeyPair # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> KeyPair -> m KeyPair #
Read KeyPair # |
Instance details Defined in Crypto.PubKey.DSA Methods readsPrec :: Int -> ReadS KeyPair readList :: ReadS [KeyPair] readPrec :: ReadPrec KeyPair readListPrec :: ReadPrec [KeyPair]
Show KeyPair # |
Instance details Defined in Crypto.PubKey.DSA Methods showsPrec :: Int -> KeyPair -> ShowS # show :: KeyPair -> String # showList :: [KeyPair] -> ShowS #
NFData KeyPair # |
Instance details Defined in Crypto.PubKey.DSA Methods rnf :: KeyPair -> ()
Eq KeyPair # |
Instance details Defined in Crypto.PubKey.DSA Methods (==) :: KeyPair -> KeyPair -> Bool # (/=) :: KeyPair -> KeyPair -> Bool #

toPublicKey :: KeyPair -> PublicKey #

Public key of a DSA Key pair

toPrivateKey :: KeyPair -> PrivateKey #

Private key of a DSA Key pair