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

Instances

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

Show Binary

Defined in Auth.Biscuit.Datalog.AST

Methods

showsPrec :: Int -> Binary -> ShowS

show :: Binary -> String

showList :: [Binary] -> ShowS

Lift Binary

Defined in Auth.Biscuit.Datalog.AST

Methods

lift :: Binary -> Q Exp

liftTyped :: Binary -> Q (TExp Binary)

type Block = Block' 'RegularString

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}); |]

data Block' (ctx :: ParsedAs)

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

Constructors

Block

Fields

• bRules :: [Rule' ctx]
• bFacts :: [Predicate' 'InFact ctx]
• bChecks :: [Check' ctx]
• bContext :: Maybe Text

Instances

Show Block

Defined in Auth.Biscuit.Datalog.AST

Methods

showsPrec :: Int -> Block -> ShowS

show :: Block -> String

showList :: [Block] -> ShowS

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

Defined in Auth.Biscuit.Datalog.AST

Methods

lift :: Block' ctx -> Q Exp

liftTyped :: Block' ctx -> Q (TExp (Block' ctx))

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

Defined in Auth.Biscuit.Datalog.AST

Methods

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

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

Semigroup (Block' ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

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

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

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

Monoid (Block' ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

mempty :: Block' ctx

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

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

data BlockElement' ctx

Constructors

BlockFact (Predicate' 'InFact ctx)

BlockRule (Rule' ctx)

BlockCheck (Check' ctx)

BlockComment

Instances

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

Defined in Auth.Biscuit.Datalog.AST

Methods

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

show :: BlockElement' ctx -> String

showList :: [BlockElement' ctx] -> ShowS

type Check = Query

type Check' ctx = Query' ctx

type Expression = Expression' 'RegularString

data Expression' (ctx :: ParsedAs)

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 :: Expression' ctx -> Q Exp

liftTyped :: Expression' ctx -> Q (TExp (Expression' ctx))

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

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

type Fact = Predicate' 'InFact 'RegularString

class ToTerm t 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 'RegularString

How to turn a value into a datalog item

Instances

ToTerm Bool

Defined in Auth.Biscuit.Datalog.AST

Methods

toTerm :: forall (inSet :: IsWithinSet) (pof :: PredicateOrFact). Bool -> Term' inSet pof 'RegularString

ToTerm Int

Defined in Auth.Biscuit.Datalog.AST

Methods

toTerm :: forall (inSet :: IsWithinSet) (pof :: PredicateOrFact). Int -> Term' inSet pof 'RegularString

ToTerm Integer

Defined in Auth.Biscuit.Datalog.AST

Methods

toTerm :: forall (inSet :: IsWithinSet) (pof :: PredicateOrFact). Integer -> Term' inSet pof 'RegularString

ToTerm ByteString

Defined in Auth.Biscuit.Datalog.AST

Methods

toTerm :: forall (inSet :: IsWithinSet) (pof :: PredicateOrFact). ByteString -> Term' inSet pof 'RegularString

ToTerm Text

Defined in Auth.Biscuit.Datalog.AST

Methods

toTerm :: forall (inSet :: IsWithinSet) (pof :: PredicateOrFact). Text -> Term' inSet pof 'RegularString

ToTerm UTCTime

Defined in Auth.Biscuit.Datalog.AST

Methods

toTerm :: forall (inSet :: IsWithinSet) (pof :: PredicateOrFact). UTCTime -> Term' inSet pof 'RegularString

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 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

FromValue Integer

Defined in Auth.Biscuit.Datalog.AST

Methods

fromValue :: Value -> Maybe Integer

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 Value

Defined in Auth.Biscuit.Datalog.AST

Methods

fromValue :: Value -> Maybe Value

type Term = Term' 'NotWithinSet 'InPredicate 'RegularString

In a regular AST, slices have already been eliminated

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

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 :: Term' inSet pof ctx -> Q Exp

liftTyped :: Term' inSet pof ctx -> Q (TExp (Term' inSet pof ctx))

(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

(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

data IsWithinSet

Constructors

NotWithinSet

WithinSet

data Op

Constructors

VOp Term

UOp Unary

BOp Binary

data ParsedAs

Constructors

RegularString

QuasiQuote

type Policy = (PolicyType, Query)

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

data PolicyType

Constructors

Allow

Deny

Instances

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

Show PolicyType

Defined in Auth.Biscuit.Datalog.AST

Methods

showsPrec :: Int -> PolicyType -> ShowS

show :: PolicyType -> String

showList :: [PolicyType] -> ShowS

Lift PolicyType

Defined in Auth.Biscuit.Datalog.AST

Methods

lift :: PolicyType -> Q Exp

liftTyped :: PolicyType -> Q (TExp PolicyType)

type Predicate = Predicate' 'InPredicate 'RegularString

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

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 :: Predicate' pof ctx -> Q Exp

liftTyped :: Predicate' pof ctx -> Q (TExp (Predicate' pof ctx))

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

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

data PredicateOrFact

Constructors

InPredicate

InFact

type QQTerm = Term' 'NotWithinSet 'InPredicate 'QuasiQuote

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

type Query = Query' 'RegularString

type Query' ctx = [QueryItem' ctx]

data QueryItem' ctx

Constructors

QueryItem

Fields

• qBody :: [Predicate' 'InPredicate ctx]
• qExpressions :: [Expression' ctx]

Instances

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

Defined in Auth.Biscuit.Datalog.AST

Methods

lift :: QueryItem' ctx -> Q Exp

liftTyped :: QueryItem' ctx -> Q (TExp (QueryItem' ctx))

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

Defined in Auth.Biscuit.Datalog.AST

Methods

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

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

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

Defined in Auth.Biscuit.Datalog.AST

Methods

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

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

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

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

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

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

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

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

Defined in Auth.Biscuit.Datalog.AST

Methods

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

show :: QueryItem' ctx -> String

showList :: [QueryItem' ctx] -> ShowS

type Rule = Rule' 'RegularString

data Rule' ctx

Constructors

Rule

Fields

• rhead :: Predicate' 'InPredicate ctx
• body :: [Predicate' 'InPredicate ctx]
• expressions :: [Expression' ctx]

Instances

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

Defined in Auth.Biscuit.Datalog.AST

Methods

lift :: Rule' ctx -> Q Exp

liftTyped :: Rule' ctx -> Q (TExp (Rule' ctx))

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

Defined in Auth.Biscuit.Datalog.AST

Methods

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

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

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

Defined in Auth.Biscuit.Datalog.AST

Methods

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

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

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

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

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

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

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

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

Defined in Auth.Biscuit.Datalog.AST

Methods

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

show :: Rule' ctx -> String

showList :: [Rule' ctx] -> ShowS

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

Equations

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

SetType 'WithinSet ctx = Void

newtype Slice

Constructors

Slice String

Instances

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

Show Slice

Defined in Auth.Biscuit.Datalog.AST

Methods

showsPrec :: Int -> Slice -> ShowS

show :: Slice -> String

showList :: [Slice] -> ShowS

IsString Slice

Defined in Auth.Biscuit.Datalog.AST

Methods

fromString :: String -> Slice

Lift Slice

Defined in Auth.Biscuit.Datalog.AST

Methods

lift :: Slice -> Q Exp

liftTyped :: Slice -> Q (TExp Slice)

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

Equations

SliceType 'RegularString = Void

SliceType 'QuasiQuote = Slice

data Unary

Constructors

Negate

Parens

Length

Instances

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

Show Unary

Defined in Auth.Biscuit.Datalog.AST

Methods

showsPrec :: Int -> Unary -> ShowS

show :: Unary -> String

showList :: [Unary] -> ShowS

Lift Unary

Defined in Auth.Biscuit.Datalog.AST

Methods

lift :: Unary -> Q Exp

liftTyped :: Unary -> Q (TExp Unary)

type Value = Term' 'NotWithinSet 'InFact 'RegularString

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' 'RegularString

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

data Authorizer' (ctx :: ParsedAs)

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' ctx]

  the allow / deny policies.

• vBlock :: Block' ctx

  the facts, rules and checks

Instances

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

Defined in Auth.Biscuit.Datalog.AST

Methods

lift :: Authorizer' ctx -> Q Exp

liftTyped :: Authorizer' ctx -> Q (TExp (Authorizer' ctx))

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

Defined in Auth.Biscuit.Datalog.AST

Methods

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

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

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

Defined in Auth.Biscuit.Datalog.AST

Methods

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

show :: Authorizer' ctx -> String

showList :: [Authorizer' ctx] -> ShowS

Semigroup (Authorizer' ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

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

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

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

Monoid (Authorizer' ctx)

Defined in Auth.Biscuit.Datalog.AST

Methods

mempty :: Authorizer' ctx

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

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

data AuthorizerElement' ctx

Constructors

AuthorizerPolicy (Policy' ctx)

BlockElement (BlockElement' ctx)

Instances

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

Defined in Auth.Biscuit.Datalog.AST

Methods

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

show :: AuthorizerElement' ctx -> String

showList :: [AuthorizerElement' ctx] -> ShowS

elementToBlock :: BlockElement' ctx -> Block' ctx

elementToAuthorizer :: AuthorizerElement' ctx -> Authorizer' ctx

fromStack :: [Op] -> Either String Expression

listSymbolsInBlock :: Block' 'RegularString -> Set Text

renderBlock :: Block -> Text

renderFact :: Fact -> Text

renderRule :: Rule' 'RegularString -> Text

toSetTerm :: Value -> Maybe (Term' 'WithinSet 'InFact 'RegularString)

toStack :: Expression -> [Op]