biscuit-haskell-0.3.0.0: Library support for the Biscuit security token

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

Auth.Biscuit.ProtoBufAdapter

Description

Conversion functions between biscuit components and protobuf-encoded components

Synopsis

data Symbols
buildSymbolTable :: Symbols -> Block -> BlockSymbols
pbToBlock :: Maybe PublicKey -> Block -> StateT Symbols (Either String) Block
blockToPb :: Bool -> Symbols -> Block -> (BlockSymbols, Block)
pbToSignedBlock :: SignedBlock -> Either String SignedBlock
signedBlockToPb :: SignedBlock -> SignedBlock
pbToProof :: Proof -> Either String (Either Signature SecretKey)
pbToThirdPartyBlockRequest :: ThirdPartyBlockRequest -> Either String (PublicKey, [PublicKey])
thirdPartyBlockRequestToPb :: (PublicKey, [PublicKey]) -> ThirdPartyBlockRequest
pbToThirdPartyBlockContents :: ThirdPartyBlockContents -> Either String (ByteString, Signature, PublicKey)
thirdPartyBlockContentsToPb :: (ByteString, Signature, PublicKey) -> ThirdPartyBlockContents

Documentation

data Symbols Source #

Instances

Instances details

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

buildSymbolTable :: Symbols -> Block -> BlockSymbols Source #

pbToBlock :: Maybe PublicKey -> Block -> StateT Symbols (Either String) Block Source #

blockToPb :: Bool -> Symbols -> Block -> (BlockSymbols, Block) Source #

Turn a biscuit block into a protobuf block, for serialization, along with the newly defined symbols

pbToSignedBlock :: SignedBlock -> Either String SignedBlock Source #

Parse a protobuf signed block into a signed biscuit block

signedBlockToPb :: SignedBlock -> SignedBlock Source #

pbToProof :: Proof -> Either String (Either Signature SecretKey) Source #

pbToThirdPartyBlockRequest :: ThirdPartyBlockRequest -> Either String (PublicKey, [PublicKey]) Source #

thirdPartyBlockRequestToPb :: (PublicKey, [PublicKey]) -> ThirdPartyBlockRequest Source #

pbToThirdPartyBlockContents :: ThirdPartyBlockContents -> Either String (ByteString, Signature, PublicKey) Source #

thirdPartyBlockContentsToPb :: (ByteString, Signature, PublicKey) -> ThirdPartyBlockContents Source #