Auth.Biscuit.Datalog.AST

The Datalog elements

Documentation

data Binary

Constructors

LessThan

GreaterThan

LessOrEqual

GreaterOrEqual

Equal

Contains

Prefix

Suffix

Regex

Add

Sub

Mul

Div

And

Or

Intersection

Union

BitwiseAnd

BitwiseOr

BitwiseXor

Instances

Show Binary

Defined in Auth.Biscuit.Datalog.AST

Methods

showsPrec :: Int -> Binary -> ShowS

show :: Binary -> String

showList :: [Binary] -> ShowS

Eq Binary

Defined in Auth.Biscuit.Datalog.AST

Methods

(==) :: Binary -> Binary -> Bool

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

Ord Binary

Defined in Auth.Biscuit.Datalog.AST

Methods

compare :: Binary -> Binary -> Ordering

(<) :: Binary -> Binary -> Bool

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

(>) :: Binary -> Binary -> Bool

(>=) :: Binary -> Binary -> Bool

max :: Binary -> Binary -> Binary

min :: Binary -> Binary -> Binary

Lift Binary

Defined in Auth.Biscuit.Datalog.AST

Methods

lift :: Quote m => Binary -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => Binary -> Code m Binary

type Block = Block' 'Repr 'Representation

A biscuit block, containing facts, rules and checks.

Block has a Monoid instance, which is the expected way to build composite blocks (eg if you need to generate a list of facts):

-- build a block from multiple variables v1, v2, v3
[block| value({v1}); |] <>
[block| value({v2}); |] <>
[block| value({v3}); |]

type EvalBlock = Block' 'Eval 'Representation

data Block' (evalCtx :: EvaluationContext) (ctx :: DatalogContext)

A biscuit block, that may or may not contain slices referencing haskell variables

Constructors

Block

Fields

• bRules :: [Rule' evalCtx ctx]
• bFacts :: [Predicate' 'InFact ctx]
• bChecks :: [Check' evalCtx ctx]
• bContext :: Maybe Text
• bScope :: Set (RuleScope' evalCtx ctx)

Instances

Show Block

Defined in Auth.Biscuit.Datalog.AST

Methods

showsPrec :: Int -> Block -> ShowS

show :: Block -> String

showList :: [Block] -> ShowS

ToEvaluation Block'

Defined in Auth.Biscuit.Datalog.AST

Methods

toEvaluation :: [Maybe PublicKey] -> Block' 'Repr 'Representation -> Block' 'Eval 'Representation

toRepresentation :: Block' 'Eval 'Representation -> Block' 'Repr 'Representation

(Lift (Predicate' 'InFact ctx), Lift (Rule' evalCtx ctx), Lift (QueryItem' evalCtx ctx), Lift (RuleScope' evalCtx ctx)) => Lift (Block' evalCtx ctx :: Type)

Defined in Auth.Biscuit.Datalog.AST

Methods

lift :: Quote m => Block' evalCtx ctx -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => Block' evalCtx ctx -> Code m (Block' evalCtx ctx)

Monoid (Block' evalCtx ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

mempty :: Block' evalCtx ctx

mappend :: Block' evalCtx ctx -> Block' evalCtx ctx -> Block' evalCtx ctx

mconcat :: [Block' evalCtx ctx] -> Block' evalCtx ctx

Semigroup (Block' evalCtx ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

(<>) :: Block' evalCtx ctx -> Block' evalCtx ctx -> Block' evalCtx ctx

sconcat :: NonEmpty (Block' evalCtx ctx) -> Block' evalCtx ctx

stimes :: Integral b => b -> Block' evalCtx ctx -> Block' evalCtx ctx

(Eq (Predicate' 'InFact ctx), Eq (Rule' evalCtx ctx), Eq (QueryItem' evalCtx ctx), Eq (RuleScope' evalCtx ctx)) => Eq (Block' evalCtx ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

(==) :: Block' evalCtx ctx -> Block' evalCtx ctx -> Bool

(/=) :: Block' evalCtx ctx -> Block' evalCtx ctx -> Bool

data BlockElement' evalCtx ctx

Constructors

BlockFact (Predicate' 'InFact ctx)

BlockRule (Rule' evalCtx ctx)

BlockCheck (Check' evalCtx ctx)

BlockComment

Instances

(Show (Predicate' 'InFact ctx), Show (Rule' evalCtx ctx), Show (QueryItem' evalCtx ctx)) => Show (BlockElement' evalCtx ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

showsPrec :: Int -> BlockElement' evalCtx ctx -> ShowS

show :: BlockElement' evalCtx ctx -> String

showList :: [BlockElement' evalCtx ctx] -> ShowS

data CheckKind

Constructors

One

All

Instances

Show CheckKind

Defined in Auth.Biscuit.Datalog.AST

Methods

showsPrec :: Int -> CheckKind -> ShowS

show :: CheckKind -> String

showList :: [CheckKind] -> ShowS

Eq CheckKind

Defined in Auth.Biscuit.Datalog.AST

Methods

(==) :: CheckKind -> CheckKind -> Bool

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

Ord CheckKind

Defined in Auth.Biscuit.Datalog.AST

Methods

compare :: CheckKind -> CheckKind -> Ordering

(<) :: CheckKind -> CheckKind -> Bool

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

(>) :: CheckKind -> CheckKind -> Bool

(>=) :: CheckKind -> CheckKind -> Bool

max :: CheckKind -> CheckKind -> CheckKind

min :: CheckKind -> CheckKind -> CheckKind

Lift CheckKind

Defined in Auth.Biscuit.Datalog.AST

Methods

lift :: Quote m => CheckKind -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => CheckKind -> Code m CheckKind

type Check = Check' 'Repr 'Representation

type EvalCheck = Check' 'Eval 'Representation

data Check' evalCtx ctx

Constructors

Check

Fields

• cQueries :: Query' evalCtx ctx
• cKind :: CheckKind

Instances

ToEvaluation Check'

Defined in Auth.Biscuit.Datalog.AST

Methods

toEvaluation :: [Maybe PublicKey] -> Check' 'Repr 'Representation -> Check' 'Eval 'Representation

toRepresentation :: Check' 'Eval 'Representation -> Check' 'Repr 'Representation

Lift (QueryItem' evalCtx ctx) => Lift (Check' evalCtx ctx :: Type)

Defined in Auth.Biscuit.Datalog.AST

Methods

lift :: Quote m => Check' evalCtx ctx -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => Check' evalCtx ctx -> Code m (Check' evalCtx ctx)

Show (QueryItem' evalCtx ctx) => Show (Check' evalCtx ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

showsPrec :: Int -> Check' evalCtx ctx -> ShowS

show :: Check' evalCtx ctx -> String

showList :: [Check' evalCtx ctx] -> ShowS

Eq (QueryItem' evalCtx ctx) => Eq (Check' evalCtx ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

(==) :: Check' evalCtx ctx -> Check' evalCtx ctx -> Bool

(/=) :: Check' evalCtx ctx -> Check' evalCtx ctx -> Bool

Ord (QueryItem' evalCtx ctx) => Ord (Check' evalCtx ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

compare :: Check' evalCtx ctx -> Check' evalCtx ctx -> Ordering

(<) :: Check' evalCtx ctx -> Check' evalCtx ctx -> Bool

(<=) :: Check' evalCtx ctx -> Check' evalCtx ctx -> Bool

(>) :: Check' evalCtx ctx -> Check' evalCtx ctx -> Bool

(>=) :: Check' evalCtx ctx -> Check' evalCtx ctx -> Bool

max :: Check' evalCtx ctx -> Check' evalCtx ctx -> Check' evalCtx ctx

min :: Check' evalCtx ctx -> Check' evalCtx ctx -> Check' evalCtx ctx

type Expression = Expression' 'Representation

data Expression' (ctx :: DatalogContext)

Constructors

EValue (Term' 'NotWithinSet 'InPredicate ctx)

EUnary Unary (Expression' ctx)

EBinary Binary (Expression' ctx) (Expression' ctx)

Instances

Lift (Term' 'NotWithinSet 'InPredicate ctx) => Lift (Expression' ctx :: Type)

Defined in Auth.Biscuit.Datalog.AST

Methods

lift :: Quote m => Expression' ctx -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => Expression' ctx -> Code m (Expression' ctx)

Show (Term' 'NotWithinSet 'InPredicate ctx) => Show (Expression' ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

showsPrec :: Int -> Expression' ctx -> ShowS

show :: Expression' ctx -> String

showList :: [Expression' ctx] -> ShowS

Eq (Term' 'NotWithinSet 'InPredicate ctx) => Eq (Expression' ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

(==) :: Expression' ctx -> Expression' ctx -> Bool

(/=) :: Expression' ctx -> Expression' ctx -> Bool

Ord (Term' 'NotWithinSet 'InPredicate ctx) => Ord (Expression' ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

compare :: Expression' ctx -> Expression' ctx -> Ordering

(<) :: Expression' ctx -> Expression' ctx -> Bool

(<=) :: Expression' ctx -> Expression' ctx -> Bool

(>) :: Expression' ctx -> Expression' ctx -> Bool

(>=) :: Expression' ctx -> Expression' ctx -> Bool

max :: Expression' ctx -> Expression' ctx -> Expression' ctx

min :: Expression' ctx -> Expression' ctx -> Expression' ctx

type Fact = Predicate' 'InFact 'Representation

class ToTerm t inSet pof where

This class describes how to turn a haskell value into a datalog value. | This is used when slicing a haskell variable in a datalog expression

Methods

toTerm :: t -> Term' inSet pof 'Representation

How to turn a value into a datalog item

Instances

ToTerm ByteString inSet pof

Defined in Auth.Biscuit.Datalog.AST

Methods

toTerm :: ByteString -> Term' inSet pof 'Representation

ToTerm Text inSet pof

Defined in Auth.Biscuit.Datalog.AST

Methods

toTerm :: Text -> Term' inSet pof 'Representation

ToTerm UTCTime inSet pof

Defined in Auth.Biscuit.Datalog.AST

Methods

toTerm :: UTCTime -> Term' inSet pof 'Representation

ToTerm Integer inSet pof

Defined in Auth.Biscuit.Datalog.AST

Methods

toTerm :: Integer -> Term' inSet pof 'Representation

ToTerm Bool inSet pof

Defined in Auth.Biscuit.Datalog.AST

Methods

toTerm :: Bool -> Term' inSet pof 'Representation

ToTerm Int inSet pof

Defined in Auth.Biscuit.Datalog.AST

Methods

toTerm :: Int -> Term' inSet pof 'Representation

(Foldable f, ToTerm a 'WithinSet 'InFact) => ToTerm (f a) 'NotWithinSet pof

Defined in Auth.Biscuit.Datalog.AST

Methods

toTerm :: f a -> Term' 'NotWithinSet pof 'Representation

class FromValue t where

This class describes how to turn a datalog value into a regular haskell value.

Methods

fromValue :: Value -> Maybe t

Instances

FromValue Value

Defined in Auth.Biscuit.Datalog.AST

Methods

fromValue :: Value -> Maybe Value

FromValue ByteString

Defined in Auth.Biscuit.Datalog.AST

Methods

fromValue :: Value -> Maybe ByteString

FromValue Text

Defined in Auth.Biscuit.Datalog.AST

Methods

fromValue :: Value -> Maybe Text

FromValue UTCTime

Defined in Auth.Biscuit.Datalog.AST

Methods

fromValue :: Value -> Maybe UTCTime

FromValue Integer

Defined in Auth.Biscuit.Datalog.AST

Methods

fromValue :: Value -> Maybe Integer

FromValue Bool

Defined in Auth.Biscuit.Datalog.AST

Methods

fromValue :: Value -> Maybe Bool

FromValue Int

Defined in Auth.Biscuit.Datalog.AST

Methods

fromValue :: Value -> Maybe Int

type Term = Term' 'NotWithinSet 'InPredicate 'Representation

In a regular AST, slices have already been eliminated

data Term' (inSet :: IsWithinSet) (pof :: PredicateOrFact) (ctx :: DatalogContext)

A single datalog item. | This can be a value, a set of items, or a slice (a value that will be injected later), | depending on the context

Constructors

Variable (VariableType inSet pof)

A variable (eg. $0)

LInteger Int

An integer literal (eg. 42)

LString Text

A string literal (eg. "file1")

LDate UTCTime

A date literal (eg. 2021-05-26T18:00:00Z)

LBytes ByteString

A hex literal (eg. hex:ff9900)

LBool Bool

A bool literal (eg. true)

Antiquote (SliceType ctx)

A slice (eg. {name})

TermSet (SetType inSet ctx)

A set (eg. [true, false])

Instances

FromValue Value

Defined in Auth.Biscuit.Datalog.AST

Methods

fromValue :: Value -> Maybe Value

(Lift (VariableType inSet pof), Lift (SetType inSet ctx), Lift (SliceType ctx)) => Lift (Term' inSet pof ctx :: Type)

Defined in Auth.Biscuit.Datalog.AST

Methods

lift :: Quote m => Term' inSet pof ctx -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => Term' inSet pof ctx -> Code m (Term' inSet pof ctx)

(Show (VariableType inSet pof), Show (SliceType ctx), Show (SetType inSet ctx)) => Show (Term' inSet pof ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

showsPrec :: Int -> Term' inSet pof ctx -> ShowS

show :: Term' inSet pof ctx -> String

showList :: [Term' inSet pof ctx] -> ShowS

(Eq (VariableType inSet pof), Eq (SliceType ctx), Eq (SetType inSet ctx)) => Eq (Term' inSet pof ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

(==) :: Term' inSet pof ctx -> Term' inSet pof ctx -> Bool

(/=) :: Term' inSet pof ctx -> Term' inSet pof ctx -> Bool

(Ord (VariableType inSet pof), Ord (SliceType ctx), Ord (SetType inSet ctx)) => Ord (Term' inSet pof ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

compare :: Term' inSet pof ctx -> Term' inSet pof ctx -> Ordering

(<) :: Term' inSet pof ctx -> Term' inSet pof ctx -> Bool

(<=) :: Term' inSet pof ctx -> Term' inSet pof ctx -> Bool

(>) :: Term' inSet pof ctx -> Term' inSet pof ctx -> Bool

(>=) :: Term' inSet pof ctx -> Term' inSet pof ctx -> Bool

max :: Term' inSet pof ctx -> Term' inSet pof ctx -> Term' inSet pof ctx

min :: Term' inSet pof ctx -> Term' inSet pof ctx -> Term' inSet pof ctx

data IsWithinSet

Constructors

NotWithinSet

WithinSet

data Op

Constructors

VOp Term

UOp Unary

BOp Binary

data DatalogContext

Constructors

WithSlices

Intermediate Datalog representation, which may contain references to external variables (currently, only sliced in through TemplateHaskell, but it could also be done at runtime, a bit like parameter substitution in SQL queries)

Representation

A datalog representation faithful to its text display. There are no external variables, and the authorized blocks are identified through their public keys

data EvaluationContext

Constructors

Repr

Eval

type Policy = Policy' 'Repr 'Representation

type EvalPolicy = Policy' 'Eval 'Representation

type Policy' evalCtx ctx = (PolicyType, Query' evalCtx ctx)

data PolicyType

Constructors

Allow

Deny

Instances

Show PolicyType

Defined in Auth.Biscuit.Datalog.AST

Methods

showsPrec :: Int -> PolicyType -> ShowS

show :: PolicyType -> String

showList :: [PolicyType] -> ShowS

Eq PolicyType

Defined in Auth.Biscuit.Datalog.AST

Methods

(==) :: PolicyType -> PolicyType -> Bool

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

Ord PolicyType

Defined in Auth.Biscuit.Datalog.AST

Methods

compare :: PolicyType -> PolicyType -> Ordering

(<) :: PolicyType -> PolicyType -> Bool

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

(>) :: PolicyType -> PolicyType -> Bool

(>=) :: PolicyType -> PolicyType -> Bool

max :: PolicyType -> PolicyType -> PolicyType

min :: PolicyType -> PolicyType -> PolicyType

Lift PolicyType

Defined in Auth.Biscuit.Datalog.AST

Methods

lift :: Quote m => PolicyType -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => PolicyType -> Code m PolicyType

type Predicate = Predicate' 'InPredicate 'Representation

data Predicate' (pof :: PredicateOrFact) (ctx :: DatalogContext)

Constructors

Predicate

Fields

• name :: Text
• terms :: [Term' 'NotWithinSet pof ctx]

Instances

Lift (Term' 'NotWithinSet pof ctx) => Lift (Predicate' pof ctx :: Type)

Defined in Auth.Biscuit.Datalog.AST

Methods

lift :: Quote m => Predicate' pof ctx -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => Predicate' pof ctx -> Code m (Predicate' pof ctx)

Show (Term' 'NotWithinSet pof ctx) => Show (Predicate' pof ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

showsPrec :: Int -> Predicate' pof ctx -> ShowS

show :: Predicate' pof ctx -> String

showList :: [Predicate' pof ctx] -> ShowS

Eq (Term' 'NotWithinSet pof ctx) => Eq (Predicate' pof ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

(==) :: Predicate' pof ctx -> Predicate' pof ctx -> Bool

(/=) :: Predicate' pof ctx -> Predicate' pof ctx -> Bool

Ord (Term' 'NotWithinSet pof ctx) => Ord (Predicate' pof ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

compare :: Predicate' pof ctx -> Predicate' pof ctx -> Ordering

(<) :: Predicate' pof ctx -> Predicate' pof ctx -> Bool

(<=) :: Predicate' pof ctx -> Predicate' pof ctx -> Bool

(>) :: Predicate' pof ctx -> Predicate' pof ctx -> Bool

(>=) :: Predicate' pof ctx -> Predicate' pof ctx -> Bool

max :: Predicate' pof ctx -> Predicate' pof ctx -> Predicate' pof ctx

min :: Predicate' pof ctx -> Predicate' pof ctx -> Predicate' pof ctx

data PredicateOrFact

Constructors

InPredicate

InFact

type QQTerm = Term' 'NotWithinSet 'InPredicate 'WithSlices

In an AST parsed from a WithSlicesr, there might be references to haskell variables

type Query = Query' 'Repr 'Representation

type Query' evalCtx ctx = [QueryItem' evalCtx ctx]

data QueryItem' evalCtx ctx

Constructors

QueryItem

Fields

• qBody :: [Predicate' 'InPredicate ctx]
• qExpressions :: [Expression' ctx]
• qScope :: Set (RuleScope' evalCtx ctx)

Instances

ToEvaluation QueryItem'

Defined in Auth.Biscuit.Datalog.AST

Methods

toEvaluation :: [Maybe PublicKey] -> QueryItem' 'Repr 'Representation -> QueryItem' 'Eval 'Representation

toRepresentation :: QueryItem' 'Eval 'Representation -> QueryItem' 'Repr 'Representation

(Lift (Predicate' 'InPredicate ctx), Lift (Expression' ctx), Lift (RuleScope' evalCtx ctx)) => Lift (QueryItem' evalCtx ctx :: Type)

Defined in Auth.Biscuit.Datalog.AST

Methods

lift :: Quote m => QueryItem' evalCtx ctx -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => QueryItem' evalCtx ctx -> Code m (QueryItem' evalCtx ctx)

(Show (Predicate' 'InPredicate ctx), Show (Expression' ctx), Show (RuleScope' evalCtx ctx)) => Show (QueryItem' evalCtx ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

showsPrec :: Int -> QueryItem' evalCtx ctx -> ShowS

show :: QueryItem' evalCtx ctx -> String

showList :: [QueryItem' evalCtx ctx] -> ShowS

(Eq (Predicate' 'InPredicate ctx), Eq (Expression' ctx), Eq (RuleScope' evalCtx ctx)) => Eq (QueryItem' evalCtx ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

(==) :: QueryItem' evalCtx ctx -> QueryItem' evalCtx ctx -> Bool

(/=) :: QueryItem' evalCtx ctx -> QueryItem' evalCtx ctx -> Bool

(Ord (Predicate' 'InPredicate ctx), Ord (Expression' ctx), Ord (RuleScope' evalCtx ctx)) => Ord (QueryItem' evalCtx ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

compare :: QueryItem' evalCtx ctx -> QueryItem' evalCtx ctx -> Ordering

(<) :: QueryItem' evalCtx ctx -> QueryItem' evalCtx ctx -> Bool

(<=) :: QueryItem' evalCtx ctx -> QueryItem' evalCtx ctx -> Bool

(>) :: QueryItem' evalCtx ctx -> QueryItem' evalCtx ctx -> Bool

(>=) :: QueryItem' evalCtx ctx -> QueryItem' evalCtx ctx -> Bool

max :: QueryItem' evalCtx ctx -> QueryItem' evalCtx ctx -> QueryItem' evalCtx ctx

min :: QueryItem' evalCtx ctx -> QueryItem' evalCtx ctx -> QueryItem' evalCtx ctx

type Rule = Rule' 'Repr 'Representation

type EvalRule = Rule' 'Eval 'Representation

data Rule' evalCtx ctx

Constructors

Rule

Fields

• rhead :: Predicate' 'InPredicate ctx
• body :: [Predicate' 'InPredicate ctx]
• expressions :: [Expression' ctx]
• scope :: Set (RuleScope' evalCtx ctx)

Instances

ToEvaluation Rule'

Defined in Auth.Biscuit.Datalog.AST

Methods

toEvaluation :: [Maybe PublicKey] -> Rule' 'Repr 'Representation -> Rule' 'Eval 'Representation

toRepresentation :: Rule' 'Eval 'Representation -> Rule' 'Repr 'Representation

(Lift (Predicate' 'InPredicate ctx), Lift (Expression' ctx), Lift (RuleScope' evalCtx ctx)) => Lift (Rule' evalCtx ctx :: Type)

Defined in Auth.Biscuit.Datalog.AST

Methods

lift :: Quote m => Rule' evalCtx ctx -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => Rule' evalCtx ctx -> Code m (Rule' evalCtx ctx)

(Show (Predicate' 'InPredicate ctx), Show (Expression' ctx), Show (RuleScope' evalCtx ctx)) => Show (Rule' evalCtx ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

showsPrec :: Int -> Rule' evalCtx ctx -> ShowS

show :: Rule' evalCtx ctx -> String

showList :: [Rule' evalCtx ctx] -> ShowS

(Eq (Predicate' 'InPredicate ctx), Eq (Expression' ctx), Eq (RuleScope' evalCtx ctx)) => Eq (Rule' evalCtx ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

(==) :: Rule' evalCtx ctx -> Rule' evalCtx ctx -> Bool

(/=) :: Rule' evalCtx ctx -> Rule' evalCtx ctx -> Bool

(Ord (Predicate' 'InPredicate ctx), Ord (Expression' ctx), Ord (RuleScope' evalCtx ctx)) => Ord (Rule' evalCtx ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

compare :: Rule' evalCtx ctx -> Rule' evalCtx ctx -> Ordering

(<) :: Rule' evalCtx ctx -> Rule' evalCtx ctx -> Bool

(<=) :: Rule' evalCtx ctx -> Rule' evalCtx ctx -> Bool

(>) :: Rule' evalCtx ctx -> Rule' evalCtx ctx -> Bool

(>=) :: Rule' evalCtx ctx -> Rule' evalCtx ctx -> Bool

max :: Rule' evalCtx ctx -> Rule' evalCtx ctx -> Rule' evalCtx ctx

min :: Rule' evalCtx ctx -> Rule' evalCtx ctx -> Rule' evalCtx ctx

data RuleScope' (evalCtx :: EvaluationContext) (ctx :: DatalogContext)

Constructors

OnlyAuthority

Previous

BlockId (BlockIdType evalCtx ctx)

Instances

Lift (BlockIdType evalCtx ctx) => Lift (RuleScope' evalCtx ctx :: Type)

Defined in Auth.Biscuit.Datalog.AST

Methods

lift :: Quote m => RuleScope' evalCtx ctx -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => RuleScope' evalCtx ctx -> Code m (RuleScope' evalCtx ctx)

Show (BlockIdType evalCtx ctx) => Show (RuleScope' evalCtx ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

showsPrec :: Int -> RuleScope' evalCtx ctx -> ShowS

show :: RuleScope' evalCtx ctx -> String

showList :: [RuleScope' evalCtx ctx] -> ShowS

Eq (BlockIdType evalCtx ctx) => Eq (RuleScope' evalCtx ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

(==) :: RuleScope' evalCtx ctx -> RuleScope' evalCtx ctx -> Bool

(/=) :: RuleScope' evalCtx ctx -> RuleScope' evalCtx ctx -> Bool

Ord (BlockIdType evalCtx ctx) => Ord (RuleScope' evalCtx ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

compare :: RuleScope' evalCtx ctx -> RuleScope' evalCtx ctx -> Ordering

(<) :: RuleScope' evalCtx ctx -> RuleScope' evalCtx ctx -> Bool

(<=) :: RuleScope' evalCtx ctx -> RuleScope' evalCtx ctx -> Bool

(>) :: RuleScope' evalCtx ctx -> RuleScope' evalCtx ctx -> Bool

(>=) :: RuleScope' evalCtx ctx -> RuleScope' evalCtx ctx -> Bool

max :: RuleScope' evalCtx ctx -> RuleScope' evalCtx ctx -> RuleScope' evalCtx ctx

min :: RuleScope' evalCtx ctx -> RuleScope' evalCtx ctx -> RuleScope' evalCtx ctx

type RuleScope = RuleScope' 'Repr 'Representation

type EvalRuleScope = RuleScope' 'Eval 'Representation

type family SetType (inSet :: IsWithinSet) (ctx :: DatalogContext) where ...

Equations

SetType 'NotWithinSet ctx = Set (Term' 'WithinSet 'InFact ctx)

SetType 'WithinSet ctx = Void

newtype Slice

Constructors

Slice Text

Instances

IsString Slice

Defined in Auth.Biscuit.Datalog.AST

Methods

fromString :: String -> Slice

Show Slice

Defined in Auth.Biscuit.Datalog.AST

Methods

showsPrec :: Int -> Slice -> ShowS

show :: Slice -> String

showList :: [Slice] -> ShowS

Eq Slice

Defined in Auth.Biscuit.Datalog.AST

Methods

(==) :: Slice -> Slice -> Bool

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

Ord Slice

Defined in Auth.Biscuit.Datalog.AST

Methods

compare :: Slice -> Slice -> Ordering

(<) :: Slice -> Slice -> Bool

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

(>) :: Slice -> Slice -> Bool

(>=) :: Slice -> Slice -> Bool

max :: Slice -> Slice -> Slice

min :: Slice -> Slice -> Slice

Lift Slice

Defined in Auth.Biscuit.Datalog.AST

Methods

lift :: Quote m => Slice -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => Slice -> Code m Slice

data PkOrSlice

Constructors

PkSlice Text

Pk PublicKey

Instances

Show PkOrSlice

Defined in Auth.Biscuit.Datalog.AST

Methods

showsPrec :: Int -> PkOrSlice -> ShowS

show :: PkOrSlice -> String

showList :: [PkOrSlice] -> ShowS

Eq PkOrSlice

Defined in Auth.Biscuit.Datalog.AST

Methods

(==) :: PkOrSlice -> PkOrSlice -> Bool

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

Ord PkOrSlice

Defined in Auth.Biscuit.Datalog.AST

Methods

compare :: PkOrSlice -> PkOrSlice -> Ordering

(<) :: PkOrSlice -> PkOrSlice -> Bool

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

(>) :: PkOrSlice -> PkOrSlice -> Bool

(>=) :: PkOrSlice -> PkOrSlice -> Bool

max :: PkOrSlice -> PkOrSlice -> PkOrSlice

min :: PkOrSlice -> PkOrSlice -> PkOrSlice

Lift PkOrSlice

Defined in Auth.Biscuit.Datalog.AST

Methods

lift :: Quote m => PkOrSlice -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => PkOrSlice -> Code m PkOrSlice

type family SliceType (ctx :: DatalogContext) where ...

Equations

SliceType 'Representation = Void

SliceType 'WithSlices = Slice

type family BlockIdType (evalCtx :: EvaluationContext) (ctx :: DatalogContext) where ...

Equations

BlockIdType 'Repr 'WithSlices = PkOrSlice

BlockIdType 'Repr 'Representation = PublicKey

BlockIdType 'Eval 'Representation = (Set Natural, PublicKey)

data Unary

Constructors

Negate

Parens

Length

Instances

Show Unary

Defined in Auth.Biscuit.Datalog.AST

Methods

showsPrec :: Int -> Unary -> ShowS

show :: Unary -> String

showList :: [Unary] -> ShowS

Eq Unary

Defined in Auth.Biscuit.Datalog.AST

Methods

(==) :: Unary -> Unary -> Bool

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

Ord Unary

Defined in Auth.Biscuit.Datalog.AST

Methods

compare :: Unary -> Unary -> Ordering

(<) :: Unary -> Unary -> Bool

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

(>) :: Unary -> Unary -> Bool

(>=) :: Unary -> Unary -> Bool

max :: Unary -> Unary -> Unary

min :: Unary -> Unary -> Unary

Lift Unary

Defined in Auth.Biscuit.Datalog.AST

Methods

lift :: Quote m => Unary -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => Unary -> Code m Unary

type Value = Term' 'NotWithinSet 'InFact 'Representation

A term that is not a variable

type family VariableType (inSet :: IsWithinSet) (pof :: PredicateOrFact) where ...

Equations

VariableType 'NotWithinSet 'InPredicate = Text

VariableType inSet pof = Void

type Authorizer = Authorizer' 'Repr 'Representation

A biscuit authorizer, containing, facts, rules, checks and policies

data Authorizer' (evalCtx :: EvaluationContext) (ctx :: DatalogContext)

The context in which a biscuit policies and checks are verified. A authorizer may add policies (`deny if` / `allow if` conditions), as well as rules, facts, and checks. A authorizer may or may not contain slices referencing haskell variables.

Constructors

Authorizer

Fields

• vPolicies :: [Policy' evalCtx ctx]

  the allow / deny policies.

• vBlock :: Block' evalCtx ctx

  the facts, rules and checks

Instances

ToEvaluation Authorizer'

Defined in Auth.Biscuit.Datalog.AST

Methods

toEvaluation :: [Maybe PublicKey] -> Authorizer' 'Repr 'Representation -> Authorizer' 'Eval 'Representation

toRepresentation :: Authorizer' 'Eval 'Representation -> Authorizer' 'Repr 'Representation

(Lift (Block' evalCtx ctx), Lift (QueryItem' evalCtx ctx)) => Lift (Authorizer' evalCtx ctx :: Type)

Defined in Auth.Biscuit.Datalog.AST

Methods

lift :: Quote m => Authorizer' evalCtx ctx -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => Authorizer' evalCtx ctx -> Code m (Authorizer' evalCtx ctx)

Monoid (Authorizer' evalCtx ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

mempty :: Authorizer' evalCtx ctx

mappend :: Authorizer' evalCtx ctx -> Authorizer' evalCtx ctx -> Authorizer' evalCtx ctx

mconcat :: [Authorizer' evalCtx ctx] -> Authorizer' evalCtx ctx

Semigroup (Authorizer' evalCtx ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

(<>) :: Authorizer' evalCtx ctx -> Authorizer' evalCtx ctx -> Authorizer' evalCtx ctx

sconcat :: NonEmpty (Authorizer' evalCtx ctx) -> Authorizer' evalCtx ctx

stimes :: Integral b => b -> Authorizer' evalCtx ctx -> Authorizer' evalCtx ctx

(Show (Block' evalCtx ctx), Show (QueryItem' evalCtx ctx)) => Show (Authorizer' evalCtx ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

showsPrec :: Int -> Authorizer' evalCtx ctx -> ShowS

show :: Authorizer' evalCtx ctx -> String

showList :: [Authorizer' evalCtx ctx] -> ShowS

(Eq (Block' evalCtx ctx), Eq (QueryItem' evalCtx ctx)) => Eq (Authorizer' evalCtx ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

(==) :: Authorizer' evalCtx ctx -> Authorizer' evalCtx ctx -> Bool

(/=) :: Authorizer' evalCtx ctx -> Authorizer' evalCtx ctx -> Bool

data AuthorizerElement' evalCtx ctx

Constructors

AuthorizerPolicy (Policy' evalCtx ctx)

BlockElement (BlockElement' evalCtx ctx)

Instances

(Show (Predicate' 'InFact ctx), Show (Rule' evalCtx ctx), Show (QueryItem' evalCtx ctx)) => Show (AuthorizerElement' evalCtx ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

showsPrec :: Int -> AuthorizerElement' evalCtx ctx -> ShowS

show :: AuthorizerElement' evalCtx ctx -> String

showList :: [AuthorizerElement' evalCtx ctx] -> ShowS

class ToEvaluation elem where

Methods

toEvaluation :: [Maybe PublicKey] -> elem 'Repr 'Representation -> elem 'Eval 'Representation

toRepresentation :: elem 'Eval 'Representation -> elem 'Repr 'Representation

Instances

ToEvaluation Authorizer'

Defined in Auth.Biscuit.Datalog.AST

Methods

toEvaluation :: [Maybe PublicKey] -> Authorizer' 'Repr 'Representation -> Authorizer' 'Eval 'Representation

toRepresentation :: Authorizer' 'Eval 'Representation -> Authorizer' 'Repr 'Representation

ToEvaluation Block'

Defined in Auth.Biscuit.Datalog.AST

Methods

toEvaluation :: [Maybe PublicKey] -> Block' 'Repr 'Representation -> Block' 'Eval 'Representation

toRepresentation :: Block' 'Eval 'Representation -> Block' 'Repr 'Representation

ToEvaluation Check'

Defined in Auth.Biscuit.Datalog.AST

Methods

toEvaluation :: [Maybe PublicKey] -> Check' 'Repr 'Representation -> Check' 'Eval 'Representation

toRepresentation :: Check' 'Eval 'Representation -> Check' 'Repr 'Representation

ToEvaluation QueryItem'

Defined in Auth.Biscuit.Datalog.AST

Methods

toEvaluation :: [Maybe PublicKey] -> QueryItem' 'Repr 'Representation -> QueryItem' 'Eval 'Representation

toRepresentation :: QueryItem' 'Eval 'Representation -> QueryItem' 'Repr 'Representation

ToEvaluation Rule'

Defined in Auth.Biscuit.Datalog.AST

Methods

toEvaluation :: [Maybe PublicKey] -> Rule' 'Repr 'Representation -> Rule' 'Eval 'Representation

toRepresentation :: Rule' 'Eval 'Representation -> Rule' 'Repr 'Representation

makeRule :: Predicate' 'InPredicate ctx -> [Predicate' 'InPredicate ctx] -> [Expression' ctx] -> Set (RuleScope' 'Repr ctx) -> Validation (NonEmpty Text) (Rule' 'Repr ctx)

makeQueryItem :: [Predicate' 'InPredicate ctx] -> [Expression' ctx] -> Set (RuleScope' 'Repr ctx) -> Validation (NonEmpty Text) (QueryItem' 'Repr ctx)

checkToEvaluation :: [Maybe PublicKey] -> Check -> EvalCheck

policyToEvaluation :: [Maybe PublicKey] -> Policy -> EvalPolicy

elementToBlock :: BlockElement' evalCtx ctx -> Block' evalCtx ctx

elementToAuthorizer :: AuthorizerElement' evalCtx ctx -> Authorizer' evalCtx ctx

extractVariables :: [Predicate' 'InPredicate ctx] -> Set Text

fromStack :: [Op] -> Either String Expression

listSymbolsInBlock :: Block -> Set Text

listPublicKeysInBlock :: Block -> Set PublicKey

queryHasNoScope :: Query -> Bool

queryHasNoV4Operators :: Query -> Bool

ruleHasNoScope :: Rule -> Bool

ruleHasNoV4Operators :: Rule -> Bool

isCheckOne :: Check' evalCtx ctx -> Bool

renderBlock :: Block -> Text

renderAuthorizer :: Authorizer -> Text

renderFact :: Fact -> Text

renderRule :: Rule -> Text

valueToSetTerm :: Value -> Maybe (Term' 'WithinSet 'InFact 'Representation)

toStack :: Expression -> [Op]

substituteAuthorizer :: Map Text Value -> Map Text PublicKey -> Authorizer' 'Repr 'WithSlices -> Validation (NonEmpty Text) Authorizer

substituteBlock :: Map Text Value -> Map Text PublicKey -> Block' 'Repr 'WithSlices -> Validation (NonEmpty Text) Block

substituteCheck :: Map Text Value -> Map Text PublicKey -> Check' 'Repr 'WithSlices -> Validation (NonEmpty Text) Check

substituteExpression :: Map Text Value -> Expression' 'WithSlices -> Validation (NonEmpty Text) Expression

substituteFact :: Map Text Value -> Predicate' 'InFact 'WithSlices -> Validation (NonEmpty Text) Fact

substitutePolicy :: Map Text Value -> Map Text PublicKey -> Policy' 'Repr 'WithSlices -> Validation (NonEmpty Text) Policy

substitutePredicate :: Map Text Value -> Predicate' 'InPredicate 'WithSlices -> Validation (NonEmpty Text) (Predicate' 'InPredicate 'Representation)

substitutePTerm :: Map Text Value -> Term' 'NotWithinSet 'InPredicate 'WithSlices -> Validation (NonEmpty Text) (Term' 'NotWithinSet 'InPredicate 'Representation)

substituteQuery :: Map Text Value -> Map Text PublicKey -> QueryItem' 'Repr 'WithSlices -> Validation (NonEmpty Text) (QueryItem' 'Repr 'Representation)

substituteRule :: Map Text Value -> Map Text PublicKey -> Rule' 'Repr 'WithSlices -> Validation (NonEmpty Text) Rule

substituteTerm :: Map Text Value -> Term' 'NotWithinSet 'InFact 'WithSlices -> Validation (NonEmpty Text) Value