License	MIT
Maintainer	Jean-Pierre Rupp <root@haskoin.com>
Stability	experimental
Portability	POSIX
Safe Haskell	None
Language	Haskell2010

Crypto.Secp256k1

Contents

Messages
Secret Keys
Public Keys
Signatures
- DER
- Compact
Recoverable
Addition & Multiplication

Description

Crytpographic functions from Bitcoin’s secp256k1 library.

Synopsis

data Msg
msg :: ByteString -> Maybe Msg
getMsg :: Msg -> ByteString
data SecKey
secKey :: ByteString -> Maybe SecKey
getSecKey :: SecKey -> ByteString
derivePubKey :: SecKey -> PubKey
data PubKey
importPubKey :: ByteString -> Maybe PubKey
exportPubKey :: Bool -> PubKey -> ByteString
data Sig
signMsg :: SecKey -> Msg -> Sig
verifySig :: PubKey -> Sig -> Msg -> Bool
normalizeSig :: Sig -> (Sig, Bool)
importSig :: ByteString -> Maybe Sig
exportSig :: Sig -> ByteString
data CompactSig = CompactSig {
- getCompactSigR :: !ShortByteString
- getCompactSigS :: !ShortByteString
}
exportCompactSig :: Sig -> CompactSig
importCompactSig :: CompactSig -> Maybe Sig
data RecSig
data CompactRecSig = CompactRecSig {
- getCompactRecSigR :: !ShortByteString
- getCompactRecSigS :: !ShortByteString
- getCompactRecSigV :: !Word8
}
importCompactRecSig :: CompactRecSig -> Maybe RecSig
exportCompactRecSig :: RecSig -> CompactRecSig
convertRecSig :: RecSig -> Sig
signRecMsg :: SecKey -> Msg -> RecSig
recover :: RecSig -> Msg -> Maybe PubKey
data Tweak
tweak :: ByteString -> Maybe Tweak
getTweak :: Tweak -> ByteString
tweakAddSecKey :: SecKey -> Tweak -> Maybe SecKey
tweakMulSecKey :: SecKey -> Tweak -> Maybe SecKey
tweakAddPubKey :: PubKey -> Tweak -> Maybe PubKey
tweakMulPubKey :: PubKey -> Tweak -> Maybe PubKey
combinePubKeys :: [PubKey] -> Maybe PubKey

Messages

data Msg Source #

Instances

Eq Msg Source #
Instance details Defined in Crypto.Secp256k1 Methods (==) :: Msg -> Msg -> Bool # (/=) :: Msg -> Msg -> Bool #
Read Msg Source #
Instance details Defined in Crypto.Secp256k1 Methods readsPrec :: Int -> ReadS Msg # readList :: ReadS [Msg] # readPrec :: ReadPrec Msg # readListPrec :: ReadPrec [Msg] #
Show Msg Source #
Instance details Defined in Crypto.Secp256k1 Methods showsPrec :: Int -> Msg -> ShowS # show :: Msg -> String # showList :: [Msg] -> ShowS #
IsString Msg Source #
Instance details Defined in Crypto.Secp256k1 Methods fromString :: String -> Msg #
Arbitrary Msg Source #
Instance details Defined in Crypto.Secp256k1 Methods arbitrary :: Gen Msg # shrink :: Msg -> [Msg] #

msg :: ByteString -> Maybe Msg Source #

Import 32-byte ByteString as Msg.

getMsg :: Msg -> ByteString Source #

Get 32-byte message.

Secret Keys

data SecKey Source #

Instances

Eq SecKey Source #
Instance details Defined in Crypto.Secp256k1 Methods (==) :: SecKey -> SecKey -> Bool # (/=) :: SecKey -> SecKey -> Bool #
Read SecKey Source #
Instance details Defined in Crypto.Secp256k1 Methods readsPrec :: Int -> ReadS SecKey # readList :: ReadS [SecKey] # readPrec :: ReadPrec SecKey # readListPrec :: ReadPrec [SecKey] #
Show SecKey Source #
Instance details Defined in Crypto.Secp256k1 Methods showsPrec :: Int -> SecKey -> ShowS # show :: SecKey -> String # showList :: [SecKey] -> ShowS #
IsString SecKey Source #
Instance details Defined in Crypto.Secp256k1 Methods fromString :: String -> SecKey #
Arbitrary SecKey Source #
Instance details Defined in Crypto.Secp256k1 Methods arbitrary :: Gen SecKey # shrink :: SecKey -> [SecKey] #

secKey :: ByteString -> Maybe SecKey Source #

Import 32-byte ByteString as SecKey.

getSecKey :: SecKey -> ByteString Source #

Get 32-byte secret key.

derivePubKey :: SecKey -> PubKey Source #

Public Keys

data PubKey Source #

Instances

Eq PubKey Source #
Instance details Defined in Crypto.Secp256k1 Methods (==) :: PubKey -> PubKey -> Bool # (/=) :: PubKey -> PubKey -> Bool #
Read PubKey Source #
Instance details Defined in Crypto.Secp256k1 Methods readsPrec :: Int -> ReadS PubKey # readList :: ReadS [PubKey] # readPrec :: ReadPrec PubKey # readListPrec :: ReadPrec [PubKey] #
Show PubKey Source #
Instance details Defined in Crypto.Secp256k1 Methods showsPrec :: Int -> PubKey -> ShowS # show :: PubKey -> String # showList :: [PubKey] -> ShowS #
IsString PubKey Source #
Instance details Defined in Crypto.Secp256k1 Methods fromString :: String -> PubKey #
Arbitrary PubKey Source #
Instance details Defined in Crypto.Secp256k1 Methods arbitrary :: Gen PubKey # shrink :: PubKey -> [PubKey] #

importPubKey :: ByteString -> Maybe PubKey Source #

Import DER-encoded public key.

exportPubKey :: Bool -> PubKey -> ByteString Source #

Encode public key as DER. First argument True for compressed output.

Signatures

data Sig Source #

Instances

Eq Sig Source #
Instance details Defined in Crypto.Secp256k1 Methods (==) :: Sig -> Sig -> Bool # (/=) :: Sig -> Sig -> Bool #
Read Sig Source #
Instance details Defined in Crypto.Secp256k1 Methods readsPrec :: Int -> ReadS Sig # readList :: ReadS [Sig] # readPrec :: ReadPrec Sig # readListPrec :: ReadPrec [Sig] #
Show Sig Source #
Instance details Defined in Crypto.Secp256k1 Methods showsPrec :: Int -> Sig -> ShowS # show :: Sig -> String # showList :: [Sig] -> ShowS #
IsString Sig Source #
Instance details Defined in Crypto.Secp256k1 Methods fromString :: String -> Sig #

signMsg :: SecKey -> Msg -> Sig Source #

verifySig :: PubKey -> Sig -> Msg -> Bool Source #

Verify message signature. True means that the signature is correct.

normalizeSig :: Sig -> (Sig, Bool) Source #

Convert signature to a normalized lower-S form. Boolean value True indicates that the signature changed, False indicates that it was already normal.

DER

importSig :: ByteString -> Maybe Sig Source #

Import DER-encoded signature.

exportSig :: Sig -> ByteString Source #

Encode signature as strict DER.

Compact

data CompactSig Source #

Constructors

CompactSig
Fields getCompactSigR :: !ShortByteString getCompactSigS :: !ShortByteString

Instances

Eq CompactSig Source #
Instance details Defined in Crypto.Secp256k1.Internal Methods (==) :: CompactSig -> CompactSig -> Bool # (/=) :: CompactSig -> CompactSig -> Bool #
Ord CompactSig Source #
Instance details Defined in Crypto.Secp256k1.Internal Methods compare :: CompactSig -> CompactSig -> Ordering # (<) :: CompactSig -> CompactSig -> Bool # (<=) :: CompactSig -> CompactSig -> Bool # (>) :: CompactSig -> CompactSig -> Bool # (>=) :: CompactSig -> CompactSig -> Bool # max :: CompactSig -> CompactSig -> CompactSig # min :: CompactSig -> CompactSig -> CompactSig #
Show CompactSig Source #
Instance details Defined in Crypto.Secp256k1.Internal Methods showsPrec :: Int -> CompactSig -> ShowS # show :: CompactSig -> String # showList :: [CompactSig] -> ShowS #
Storable CompactSig Source #
Instance details Defined in Crypto.Secp256k1.Internal Methods sizeOf :: CompactSig -> Int # alignment :: CompactSig -> Int # peekElemOff :: Ptr CompactSig -> Int -> IO CompactSig # pokeElemOff :: Ptr CompactSig -> Int -> CompactSig -> IO () # peekByteOff :: Ptr b -> Int -> IO CompactSig # pokeByteOff :: Ptr b -> Int -> CompactSig -> IO () # peek :: Ptr CompactSig -> IO CompactSig # poke :: Ptr CompactSig -> CompactSig -> IO () #
Serialize CompactSig Source #
Instance details Defined in Crypto.Secp256k1.Internal Methods put :: Putter CompactSig # get :: Get CompactSig #

exportCompactSig :: Sig -> CompactSig Source #

importCompactSig :: CompactSig -> Maybe Sig Source #

Recoverable

data RecSig Source #

Instances

Eq RecSig Source #
Instance details Defined in Crypto.Secp256k1 Methods (==) :: RecSig -> RecSig -> Bool # (/=) :: RecSig -> RecSig -> Bool #
Read RecSig Source #
Instance details Defined in Crypto.Secp256k1 Methods readsPrec :: Int -> ReadS RecSig # readList :: ReadS [RecSig] # readPrec :: ReadPrec RecSig # readListPrec :: ReadPrec [RecSig] #
Show RecSig Source #
Instance details Defined in Crypto.Secp256k1 Methods showsPrec :: Int -> RecSig -> ShowS # show :: RecSig -> String # showList :: [RecSig] -> ShowS #
IsString RecSig Source #
Instance details Defined in Crypto.Secp256k1 Methods fromString :: String -> RecSig #

data CompactRecSig Source #

Constructors

CompactRecSig
Fields getCompactRecSigR :: !ShortByteString getCompactRecSigS :: !ShortByteString getCompactRecSigV :: !Word8

Instances

Eq CompactRecSig Source #
Instance details Defined in Crypto.Secp256k1.Internal Methods (==) :: CompactRecSig -> CompactRecSig -> Bool # (/=) :: CompactRecSig -> CompactRecSig -> Bool #
Ord CompactRecSig Source #
Instance details Defined in Crypto.Secp256k1.Internal Methods compare :: CompactRecSig -> CompactRecSig -> Ordering # (<) :: CompactRecSig -> CompactRecSig -> Bool # (<=) :: CompactRecSig -> CompactRecSig -> Bool # (>) :: CompactRecSig -> CompactRecSig -> Bool # (>=) :: CompactRecSig -> CompactRecSig -> Bool # max :: CompactRecSig -> CompactRecSig -> CompactRecSig # min :: CompactRecSig -> CompactRecSig -> CompactRecSig #
Show CompactRecSig Source #
Instance details Defined in Crypto.Secp256k1.Internal Methods showsPrec :: Int -> CompactRecSig -> ShowS # show :: CompactRecSig -> String # showList :: [CompactRecSig] -> ShowS #
Storable CompactRecSig Source #
Instance details Defined in Crypto.Secp256k1.Internal Methods sizeOf :: CompactRecSig -> Int # alignment :: CompactRecSig -> Int # peekElemOff :: Ptr CompactRecSig -> Int -> IO CompactRecSig # pokeElemOff :: Ptr CompactRecSig -> Int -> CompactRecSig -> IO () # peekByteOff :: Ptr b -> Int -> IO CompactRecSig # pokeByteOff :: Ptr b -> Int -> CompactRecSig -> IO () # peek :: Ptr CompactRecSig -> IO CompactRecSig # poke :: Ptr CompactRecSig -> CompactRecSig -> IO () #
Serialize CompactRecSig Source #
Instance details Defined in Crypto.Secp256k1.Internal Methods put :: Putter CompactRecSig # get :: Get CompactRecSig #

importCompactRecSig :: CompactRecSig -> Maybe RecSig Source #

Parse a compact ECDSA signature (64 bytes + recovery id).

exportCompactRecSig :: RecSig -> CompactRecSig Source #

Serialize an ECDSA signature in compact format (64 bytes + recovery id).

convertRecSig :: RecSig -> Sig Source #

Convert a recoverable signature into a normal signature.

signRecMsg :: SecKey -> Msg -> RecSig Source #

Create a recoverable ECDSA signature.

recover :: RecSig -> Msg -> Maybe PubKey Source #

Recover an ECDSA public key from a signature.

Addition & Multiplication

data Tweak Source #

Instances

Eq Tweak Source #
Instance details Defined in Crypto.Secp256k1 Methods (==) :: Tweak -> Tweak -> Bool # (/=) :: Tweak -> Tweak -> Bool #
Read Tweak Source #
Instance details Defined in Crypto.Secp256k1 Methods readsPrec :: Int -> ReadS Tweak # readList :: ReadS [Tweak] # readPrec :: ReadPrec Tweak # readListPrec :: ReadPrec [Tweak] #
Show Tweak Source #
Instance details Defined in Crypto.Secp256k1 Methods showsPrec :: Int -> Tweak -> ShowS # show :: Tweak -> String # showList :: [Tweak] -> ShowS #
IsString Tweak Source #
Instance details Defined in Crypto.Secp256k1 Methods fromString :: String -> Tweak #

tweak :: ByteString -> Maybe Tweak Source #

32-Byte ByteString as Tweak.

getTweak :: Tweak -> ByteString Source #

Get 32-byte tweak.

tweakAddSecKey :: SecKey -> Tweak -> Maybe SecKey Source #

Add tweak to secret key.

tweakMulSecKey :: SecKey -> Tweak -> Maybe SecKey Source #

Multiply secret key by tweak.

tweakAddPubKey :: PubKey -> Tweak -> Maybe PubKey Source #

Add tweak to public key. Tweak is multiplied first by G to obtain a point.

tweakMulPubKey :: PubKey -> Tweak -> Maybe PubKey Source #

Multiply public key by tweak. Tweak is multiplied first by G to obtain a point.

combinePubKeys :: [PubKey] -> Maybe PubKey Source #

Add multiple public keys together.