Data.Signable

Digital signature is common security-related practice. One of the main difficulties of digital signature usage is necessity of determenistic data serialization agreement. This library provides Signable class which represents the idea of such agreement. Also worth mentioning generic proto-lens compatible implementation of serialization/signing algorithm described here. It's implemented as separate protoc plugin signable-haskell-protoc which generates Signable class instances for given proto-lens messages and enums.

Documentation

safeFromIntegral :: forall a b. (Integral a, Integral b, Bounded b) => a -> Maybe b

ifThenElse :: (a -> Bool) -> (a -> b) -> (a -> b) -> a -> b

class Signable a where

Methods

toBinary :: a -> ByteString

Instances

Signable Bool

Defined in Data.Signable.Class

Methods

toBinary :: Bool -> ByteString

Signable Double

Defined in Data.Signable.Class

Methods

toBinary :: Double -> ByteString

Signable Float

Defined in Data.Signable.Class

Methods

toBinary :: Float -> ByteString

Signable Int32

Defined in Data.Signable.Class

Methods

toBinary :: Int32 -> ByteString

Signable Int64

Defined in Data.Signable.Class

Methods

toBinary :: Int64 -> ByteString

Signable Word32

Defined in Data.Signable.Class

Methods

toBinary :: Word32 -> ByteString

Signable Word64

Defined in Data.Signable.Class

Methods

toBinary :: Word64 -> ByteString

Signable ByteString

Defined in Data.Signable.Class

Methods

toBinary :: ByteString -> ByteString

Signable ByteString

Defined in Data.Signable.Class

Methods

toBinary :: ByteString -> ByteString0

Signable Text

Defined in Data.Signable.Class

Methods

toBinary :: Text -> ByteString

(Foldable f, Signable a) => Signable (f a)

Defined in Data.Signable.Class

Methods

toBinary :: f a -> ByteString

data Sig

Instances

Eq Sig

Defined in Data.Signable.Class

Methods

(==) :: Sig -> Sig -> Bool

(/=) :: Sig -> Sig -> Bool

Show Sig

Defined in Data.Signable.Class

Methods

showsPrec :: Int -> Sig -> ShowS

show :: Sig -> String

showList :: [Sig] -> ShowS

data PrvKey

Instances

Eq PrvKey

Defined in Data.Signable.Class

Methods

(==) :: PrvKey -> PrvKey -> Bool

(/=) :: PrvKey -> PrvKey -> Bool

Show PrvKey

Defined in Data.Signable.Class

Methods

showsPrec :: Int -> PrvKey -> ShowS

show :: PrvKey -> String

showList :: [PrvKey] -> ShowS

data PubKey

Instances

Eq PubKey

Defined in Data.Signable.Class

Methods

(==) :: PubKey -> PubKey -> Bool

(/=) :: PubKey -> PubKey -> Bool

Show PubKey

Defined in Data.Signable.Class

Methods

showsPrec :: Int -> PubKey -> ShowS

show :: PubKey -> String

showList :: [PubKey] -> ShowS

data ECPointFormat

Constructors

ECPointCompressed

ECPointUncompressed

Instances

Eq ECPointFormat

Defined in Data.Signable.Class

Methods

(==) :: ECPointFormat -> ECPointFormat -> Bool

(/=) :: ECPointFormat -> ECPointFormat -> Bool

Ord ECPointFormat

Defined in Data.Signable.Class

Methods

compare :: ECPointFormat -> ECPointFormat -> Ordering

(<) :: ECPointFormat -> ECPointFormat -> Bool

(<=) :: ECPointFormat -> ECPointFormat -> Bool

(>) :: ECPointFormat -> ECPointFormat -> Bool

(>=) :: ECPointFormat -> ECPointFormat -> Bool

max :: ECPointFormat -> ECPointFormat -> ECPointFormat

min :: ECPointFormat -> ECPointFormat -> ECPointFormat

Show ECPointFormat

Defined in Data.Signable.Class

Methods

showsPrec :: Int -> ECPointFormat -> ShowS

show :: ECPointFormat -> String

showList :: [ECPointFormat] -> ShowS

data SignableError

Constructors

InvalidPem

TooFewPemChunks

TooManyPemChunks

InvalidAsn1

TooFewAsn1Chunks

TooManyAsn1Chunks

InvalidPubKeyDer

InvalidPrvKeyRaw

Instances

Eq SignableError

Defined in Data.Signable.Class

Methods

(==) :: SignableError -> SignableError -> Bool

(/=) :: SignableError -> SignableError -> Bool

Ord SignableError

Defined in Data.Signable.Class

Methods

compare :: SignableError -> SignableError -> Ordering

(<) :: SignableError -> SignableError -> Bool

(<=) :: SignableError -> SignableError -> Bool

(>) :: SignableError -> SignableError -> Bool

(>=) :: SignableError -> SignableError -> Bool

max :: SignableError -> SignableError -> SignableError

min :: SignableError -> SignableError -> SignableError

Show SignableError

Defined in Data.Signable.Class

Methods

showsPrec :: Int -> SignableError -> ShowS

show :: SignableError -> String

showList :: [SignableError] -> ShowS

data Alg

Constructors

AlgSecp256k1

Instances

Eq Alg

Defined in Data.Signable.Class

Methods

(==) :: Alg -> Alg -> Bool

(/=) :: Alg -> Alg -> Bool

Ord Alg

Defined in Data.Signable.Class

Methods

compare :: Alg -> Alg -> Ordering

(<) :: Alg -> Alg -> Bool

(<=) :: Alg -> Alg -> Bool

(>) :: Alg -> Alg -> Bool

(>=) :: Alg -> Alg -> Bool

max :: Alg -> Alg -> Alg

min :: Alg -> Alg -> Alg

Show Alg

Defined in Data.Signable.Class

Methods

showsPrec :: Int -> Alg -> ShowS

show :: Alg -> String

showList :: [Alg] -> ShowS

pubKey2Alg :: PubKey -> Alg

prvKey2Alg :: PrvKey -> Alg

sig2Alg :: Sig -> Alg

importPubKeyDer :: Alg -> ByteString -> Maybe PubKey

importPubKeyPem :: Alg -> ByteString -> Either SignableError PubKey

exportPubKeyDer :: ECPointFormat -> PubKey -> ByteString

derivePubKey :: PrvKey -> PubKey

importPrvKeyRaw :: Alg -> ByteString -> Maybe PrvKey

importPrvKeyPem :: Alg -> ByteString -> Either SignableError PrvKey

exportPrvKeyRaw :: PrvKey -> ByteString

newRandomPrvKey :: (MonadIO m, MonadFail m) => Alg -> m PrvKey

importSigDer :: Alg -> ByteString -> Maybe Sig

exportSigDer :: Sig -> ByteString

sign :: Signable a => PrvKey -> a -> Sig

verify :: Signable a => PubKey -> Sig -> a -> Bool