Copyright	© Clément Delafargue 2021
License	BSD-3-Clause
Maintainer	clement@delafargue.name
Safe Haskell	Safe-Inferred
Language	Haskell2010

Auth.Biscuit.Crypto

Description

Cryptographic helpers for biscuit signatures

Synopsis

type SignedBlock = (ByteString, Signature, PublicKey, Maybe (Signature, PublicKey), Maybe Int)
type Blocks = NonEmpty SignedBlock
signAuthority :: SecretKey -> (ByteString, Int) -> IO (SignedBlock, SecretKey)
signAttenuationBlock :: SecretKey -> Signature -> (ByteString, Int) -> Maybe (Signature, PublicKey) -> IO (SignedBlock, SecretKey)
signExternalBlock :: SecretKey -> Signature -> (ByteString, Int) -> SecretKey -> IO (SignedBlock, SecretKey)
sign3rdPartyBlockV1 :: SecretKey -> Signature -> ByteString -> (Signature, PublicKey)
verifyBlocks :: Blocks -> PublicKey -> Bool
verifySecretProof :: SecretKey -> SignedBlock -> Bool
verifySignatureProof :: Signature -> SignedBlock -> Bool
getSignatureProof :: SignedBlock -> SecretKey -> Signature
verifyExternalSigV1 :: Signature -> (ByteString, Signature, PublicKey) -> Bool
data PublicKey
pkBytes :: PublicKey -> ByteString
readEd25519PublicKey :: ByteString -> Maybe PublicKey
data SecretKey
skBytes :: SecretKey -> ByteString
readEd25519SecretKey :: ByteString -> Maybe SecretKey
data Signature
sigBytes :: Signature -> ByteString
signature :: ByteString -> Signature
generateSecretKey :: IO SecretKey
toPublic :: SecretKey -> PublicKey
sign :: SecretKey -> PublicKey -> ByteString -> Signature

Documentation

type SignedBlock = (ByteString, Signature, PublicKey, Maybe (Signature, PublicKey), Maybe Int) Source #

type Blocks = NonEmpty SignedBlock Source #

signAuthority :: SecretKey -> (ByteString, Int) -> IO (SignedBlock, SecretKey) Source #

signAttenuationBlock :: SecretKey -> Signature -> (ByteString, Int) -> Maybe (Signature, PublicKey) -> IO (SignedBlock, SecretKey) Source #

signExternalBlock :: SecretKey -> Signature -> (ByteString, Int) -> SecretKey -> IO (SignedBlock, SecretKey) Source #

sign3rdPartyBlockV1 :: SecretKey -> Signature -> ByteString -> (Signature, PublicKey) Source #

verifyBlocks :: Blocks -> PublicKey -> Bool Source #

verifySecretProof :: SecretKey -> SignedBlock -> Bool Source #

verifySignatureProof :: Signature -> SignedBlock -> Bool Source #

getSignatureProof :: SignedBlock -> SecretKey -> Signature Source #

verifyExternalSigV1 :: Signature -> (ByteString, Signature, PublicKey) -> Bool Source #

When adding a pre-signed third-party block to a token, we make sure the third-party block is correctly signed (pk-signature match, and the third-party block is pinned to the last biscuit block)

data PublicKey Source #

Instances

Instances details

Show PublicKey Source #
Instance details Defined in Auth.Biscuit.Crypto Methods showsPrec :: Int -> PublicKey -> ShowS # show :: PublicKey -> String # showList :: [PublicKey] -> ShowS #
Eq PublicKey Source #
Instance details Defined in Auth.Biscuit.Crypto Methods (==) :: PublicKey -> PublicKey -> Bool # (/=) :: PublicKey -> PublicKey -> Bool #
Ord PublicKey Source #
Instance details Defined in Auth.Biscuit.Crypto 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 #
Lift PublicKey Source #
Instance details Defined in Auth.Biscuit.Crypto Methods lift :: Quote m => PublicKey -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => PublicKey -> Code m PublicKey #

pkBytes :: PublicKey -> ByteString Source #

readEd25519PublicKey :: ByteString -> Maybe PublicKey Source #

data SecretKey Source #

Instances

Instances details

Show SecretKey Source #
Instance details Defined in Auth.Biscuit.Crypto Methods showsPrec :: Int -> SecretKey -> ShowS # show :: SecretKey -> String # showList :: [SecretKey] -> ShowS #
Eq SecretKey Source #
Instance details Defined in Auth.Biscuit.Crypto Methods (==) :: SecretKey -> SecretKey -> Bool # (/=) :: SecretKey -> SecretKey -> Bool #

skBytes :: SecretKey -> ByteString Source #

readEd25519SecretKey :: ByteString -> Maybe SecretKey Source #

data Signature Source #

Instances

Instances details

Show Signature Source #
Instance details Defined in Auth.Biscuit.Crypto Methods showsPrec :: Int -> Signature -> ShowS # show :: Signature -> String # showList :: [Signature] -> ShowS #
Eq Signature Source #
Instance details Defined in Auth.Biscuit.Crypto Methods (==) :: Signature -> Signature -> Bool # (/=) :: Signature -> Signature -> Bool #

sigBytes :: Signature -> ByteString Source #

signature :: ByteString -> Signature Source #

generateSecretKey :: IO SecretKey Source #

toPublic :: SecretKey -> PublicKey Source #

Generate a public key from a secret key

sign :: SecretKey -> PublicKey -> ByteString -> Signature Source #