Copyright	(c) Joseph Abrahamson 2013
License	MIT
Maintainer	me@jspha.com
Stability	experimental
Portability	non-portable
Safe Haskell	Safe-Inferred
Language	Haskell2010

Crypto.Saltine.Core.Sign

Description

The newKeypair function randomly generates a secret key and a corresponding public key. The sign function signs a message ByteString using the signer's secret key and returns the resulting signed message. The signOpen function verifies the signature in a signed message using the signer's public key then returns the message without its signature.

Crypto.Saltine.Core.Sign is an EdDSA signature using elliptic-curve Curve25519 (see: http://ed25519.cr.yp.to/). See also, "Daniel J. Bernstein, Niels Duif, Tanja Lange, Peter Schwabe, Bo-Yin Yang. High-speed high-security signatures. Journal of Cryptographic Engineering 2 (2012), 77–89." http://ed25519.cr.yp.to/ed25519-20110926.pdf.

This is current information as of 2013 June 6.

Synopsis

data SecretKey
data PublicKey
data Keypair = Keypair {
- secretKey :: SecretKey
- publicKey :: PublicKey
}
data Signature
newKeypair :: IO Keypair
sign :: SecretKey -> ByteString -> ByteString
signOpen :: PublicKey -> ByteString -> Maybe ByteString
signDetached :: SecretKey -> ByteString -> Signature
signVerifyDetached :: PublicKey -> Signature -> ByteString -> Bool

Documentation

data SecretKey Source #

An opaque box cryptographic secret key.

Instances

Instances details

Data SecretKey Source #
Instance details Defined in Crypto.Saltine.Internal.Sign Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SecretKey -> c SecretKey # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SecretKey # toConstr :: SecretKey -> Constr # dataTypeOf :: SecretKey -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c SecretKey) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SecretKey) # gmapT :: (forall b. Data b => b -> b) -> SecretKey -> SecretKey # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SecretKey -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SecretKey -> r # gmapQ :: (forall d. Data d => d -> u) -> SecretKey -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> SecretKey -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> SecretKey -> m SecretKey # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SecretKey -> m SecretKey # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SecretKey -> m SecretKey #
Generic SecretKey Source #
Instance details Defined in Crypto.Saltine.Internal.Sign Associated Types type Rep SecretKey :: Type -> Type # Methods from :: SecretKey -> Rep SecretKey x # to :: Rep SecretKey x -> SecretKey #
Show SecretKey Source #
Instance details Defined in Crypto.Saltine.Internal.Sign Methods showsPrec :: Int -> SecretKey -> ShowS # show :: SecretKey -> String # showList :: [SecretKey] -> ShowS #
NFData SecretKey Source #
Instance details Defined in Crypto.Saltine.Internal.Sign Methods rnf :: SecretKey -> () #
Eq SecretKey Source #
Instance details Defined in Crypto.Saltine.Internal.Sign Methods (==) :: SecretKey -> SecretKey -> Bool # (/=) :: SecretKey -> SecretKey -> Bool #
Ord SecretKey Source #
Instance details Defined in Crypto.Saltine.Internal.Sign Methods compare :: SecretKey -> SecretKey -> Ordering # (<) :: SecretKey -> SecretKey -> Bool # (<=) :: SecretKey -> SecretKey -> Bool # (>) :: SecretKey -> SecretKey -> Bool # (>=) :: SecretKey -> SecretKey -> Bool # max :: SecretKey -> SecretKey -> SecretKey # min :: SecretKey -> SecretKey -> SecretKey #
Hashable SecretKey Source #
Instance details Defined in Crypto.Saltine.Internal.Sign Methods hashWithSalt :: Int -> SecretKey -> Int # hash :: SecretKey -> Int #
IsEncoding SecretKey Source #
Instance details Defined in Crypto.Saltine.Internal.Sign Methods encode :: SecretKey -> ByteString Source # decode :: ByteString -> Maybe SecretKey Source # encoded :: (Choice p, Applicative f) => p SecretKey (f SecretKey) -> p ByteString (f ByteString) Source #
type Rep SecretKey Source #
Instance details Defined in Crypto.Saltine.Internal.Sign type Rep SecretKey = D1 ('MetaData "SecretKey" "Crypto.Saltine.Internal.Sign" "saltine-0.2.1.0-inplace" 'True) (C1 ('MetaCons "SK" 'PrefixI 'True) (S1 ('MetaSel ('Just "unSK") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

data PublicKey Source #

An opaque box cryptographic public key.

Instances

Instances details

Data PublicKey Source #
Instance details Defined in Crypto.Saltine.Internal.Sign 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 #
Generic PublicKey Source #
Instance details Defined in Crypto.Saltine.Internal.Sign Associated Types type Rep PublicKey :: Type -> Type # Methods from :: PublicKey -> Rep PublicKey x # to :: Rep PublicKey x -> PublicKey #
Show PublicKey Source #
Instance details Defined in Crypto.Saltine.Internal.Sign Methods showsPrec :: Int -> PublicKey -> ShowS # show :: PublicKey -> String # showList :: [PublicKey] -> ShowS #
NFData PublicKey Source #
Instance details Defined in Crypto.Saltine.Internal.Sign Methods rnf :: PublicKey -> () #
Eq PublicKey Source #
Instance details Defined in Crypto.Saltine.Internal.Sign Methods (==) :: PublicKey -> PublicKey -> Bool # (/=) :: PublicKey -> PublicKey -> Bool #
Ord PublicKey Source #
Instance details Defined in Crypto.Saltine.Internal.Sign Methods compare :: PublicKey -> PublicKey -> Ordering # (<) :: PublicKey -> PublicKey -> Bool # (<=) :: PublicKey -> PublicKey -> Bool # (>) :: PublicKey -> PublicKey -> Bool # (>=) :: PublicKey -> PublicKey -> Bool # max :: PublicKey -> PublicKey -> PublicKey # min :: PublicKey -> PublicKey -> PublicKey #
Hashable PublicKey Source #
Instance details Defined in Crypto.Saltine.Internal.Sign Methods hashWithSalt :: Int -> PublicKey -> Int # hash :: PublicKey -> Int #
IsEncoding PublicKey Source #
Instance details Defined in Crypto.Saltine.Internal.Sign Methods encode :: PublicKey -> ByteString Source # decode :: ByteString -> Maybe PublicKey Source # encoded :: (Choice p, Applicative f) => p PublicKey (f PublicKey) -> p ByteString (f ByteString) Source #
type Rep PublicKey Source #
Instance details Defined in Crypto.Saltine.Internal.Sign type Rep PublicKey = D1 ('MetaData "PublicKey" "Crypto.Saltine.Internal.Sign" "saltine-0.2.1.0-inplace" 'True) (C1 ('MetaCons "PK" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPK") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

data Keypair Source #

A convenience type for keypairs

Constructors

Keypair
Fields secretKey :: SecretKey publicKey :: PublicKey

Instances

Instances details

Data Keypair Source #
Instance details Defined in Crypto.Saltine.Internal.Sign 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 #
Generic Keypair Source #
Instance details Defined in Crypto.Saltine.Internal.Sign Associated Types type Rep Keypair :: Type -> Type # Methods from :: Keypair -> Rep Keypair x # to :: Rep Keypair x -> Keypair #
Show Keypair Source #
Instance details Defined in Crypto.Saltine.Internal.Sign Methods showsPrec :: Int -> Keypair -> ShowS # show :: Keypair -> String # showList :: [Keypair] -> ShowS #
NFData Keypair Source #
Instance details Defined in Crypto.Saltine.Internal.Sign Methods rnf :: Keypair -> () #
Eq Keypair Source #
Instance details Defined in Crypto.Saltine.Internal.Sign Methods (==) :: Keypair -> Keypair -> Bool # (/=) :: Keypair -> Keypair -> Bool #
Ord Keypair Source #
Instance details Defined in Crypto.Saltine.Internal.Sign Methods compare :: Keypair -> Keypair -> Ordering # (<) :: Keypair -> Keypair -> Bool # (<=) :: Keypair -> Keypair -> Bool # (>) :: Keypair -> Keypair -> Bool # (>=) :: Keypair -> Keypair -> Bool # max :: Keypair -> Keypair -> Keypair # min :: Keypair -> Keypair -> Keypair #
Hashable Keypair Source #
Instance details Defined in Crypto.Saltine.Internal.Sign Methods hashWithSalt :: Int -> Keypair -> Int # hash :: Keypair -> Int #
type Rep Keypair Source #
Instance details Defined in Crypto.Saltine.Internal.Sign type Rep Keypair = D1 ('MetaData "Keypair" "Crypto.Saltine.Internal.Sign" "saltine-0.2.1.0-inplace" 'False) (C1 ('MetaCons "Keypair" 'PrefixI 'True) (S1 ('MetaSel ('Just "secretKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SecretKey) :*: S1 ('MetaSel ('Just "publicKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PublicKey)))

data Signature Source #

A signature for a Message

Instances

Instances details

Data Signature Source #
Instance details Defined in Crypto.Saltine.Internal.Sign 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 #
Generic Signature Source #
Instance details Defined in Crypto.Saltine.Internal.Sign Associated Types type Rep Signature :: Type -> Type # Methods from :: Signature -> Rep Signature x # to :: Rep Signature x -> Signature #
Show Signature Source #
Instance details Defined in Crypto.Saltine.Internal.Sign Methods showsPrec :: Int -> Signature -> ShowS # show :: Signature -> String # showList :: [Signature] -> ShowS #
NFData Signature Source #
Instance details Defined in Crypto.Saltine.Internal.Sign Methods rnf :: Signature -> () #
Eq Signature Source #
Instance details Defined in Crypto.Saltine.Internal.Sign Methods (==) :: Signature -> Signature -> Bool # (/=) :: Signature -> Signature -> Bool #
Ord Signature Source #
Instance details Defined in Crypto.Saltine.Internal.Sign Methods compare :: Signature -> Signature -> Ordering # (<) :: Signature -> Signature -> Bool # (<=) :: Signature -> Signature -> Bool # (>) :: Signature -> Signature -> Bool # (>=) :: Signature -> Signature -> Bool # max :: Signature -> Signature -> Signature # min :: Signature -> Signature -> Signature #
Hashable Signature Source #
Instance details Defined in Crypto.Saltine.Internal.Sign Methods hashWithSalt :: Int -> Signature -> Int # hash :: Signature -> Int #
IsEncoding Signature Source #	Actual signatures may be shorter, but not when generated with saltine.
Instance details Defined in Crypto.Saltine.Internal.Sign Methods encode :: Signature -> ByteString Source # decode :: ByteString -> Maybe Signature Source # encoded :: (Choice p, Applicative f) => p Signature (f Signature) -> p ByteString (f ByteString) Source #
type Rep Signature Source #
Instance details Defined in Crypto.Saltine.Internal.Sign type Rep Signature = D1 ('MetaData "Signature" "Crypto.Saltine.Internal.Sign" "saltine-0.2.1.0-inplace" 'True) (C1 ('MetaCons "Signature" 'PrefixI 'True) (S1 ('MetaSel ('Just "unSignature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

newKeypair :: IO Keypair Source #

Creates a random key of the correct size for sign and signOpen of form (secretKey, publicKey).

sign Source #

Arguments

:: SecretKey
-> ByteString	Message
-> ByteString	Signed message

Augments a message with a signature forming a "signed message".

signOpen Source #

Arguments

:: PublicKey
-> ByteString	Signed message
-> Maybe ByteString	Maybe the restored message

Checks a "signed message" returning Just the original message iff the signature was generated using the SecretKey corresponding to the given PublicKey. Returns Nothing otherwise.

signDetached Source #

Arguments

:: SecretKey
-> ByteString	Message
-> Signature	Signature

Returns just the signature for a message using a SecretKey.

signVerifyDetached Source #

Arguments

:: PublicKey
-> Signature	Signature
-> ByteString	Message (not signed)
-> Bool

Returns True if the signature is valid for the given public key and message.