Safe Haskell	None
Language	Haskell2010

AccessControl

Description

This module defines the kinds of permissions used in icepeak and provides functions checking for sufficient permissions for certain operations.

Synopsis

data AccessMode
- = ModeRead
- | ModeWrite
data AuthPath = AuthPath {
- authPathPrefix :: Path
- authPathModes :: [AccessMode]
}
data IcepeakClaim = IcepeakClaim {
- icepeakClaimWhitelist :: [AuthPath]
}
type Path = [Text]
allowEverything :: IcepeakClaim
accessModeToText :: AccessMode -> Text
textToAccessMode :: Text -> Maybe AccessMode
isAuthorizedByClaim :: IcepeakClaim -> Path -> AccessMode -> Bool

Documentation

data AccessMode Source #

Different modes for accessing the JSON store

Constructors

ModeRead
ModeWrite

Instances

Bounded AccessMode Source #
Instance details Defined in AccessControl Methods minBound :: AccessMode # maxBound :: AccessMode #
Enum AccessMode Source #
Instance details Defined in AccessControl Methods succ :: AccessMode -> AccessMode # pred :: AccessMode -> AccessMode # toEnum :: Int -> AccessMode # fromEnum :: AccessMode -> Int # enumFrom :: AccessMode -> [AccessMode] # enumFromThen :: AccessMode -> AccessMode -> [AccessMode] # enumFromTo :: AccessMode -> AccessMode -> [AccessMode] # enumFromThenTo :: AccessMode -> AccessMode -> AccessMode -> [AccessMode] #
Eq AccessMode Source #
Instance details Defined in AccessControl Methods (==) :: AccessMode -> AccessMode -> Bool # (/=) :: AccessMode -> AccessMode -> Bool #
Ord AccessMode Source #
Instance details Defined in AccessControl Methods compare :: AccessMode -> AccessMode -> Ordering # (<) :: AccessMode -> AccessMode -> Bool # (<=) :: AccessMode -> AccessMode -> Bool # (>) :: AccessMode -> AccessMode -> Bool # (>=) :: AccessMode -> AccessMode -> Bool # max :: AccessMode -> AccessMode -> AccessMode # min :: AccessMode -> AccessMode -> AccessMode #
Read AccessMode Source #
Instance details Defined in AccessControl Methods readsPrec :: Int -> ReadS AccessMode # readList :: ReadS [AccessMode] # readPrec :: ReadPrec AccessMode # readListPrec :: ReadPrec [AccessMode] #
Show AccessMode Source #
Instance details Defined in AccessControl Methods showsPrec :: Int -> AccessMode -> ShowS # show :: AccessMode -> String # showList :: [AccessMode] -> ShowS #
ToJSON AccessMode Source #
Instance details Defined in AccessControl Methods toJSON :: AccessMode -> Value # toEncoding :: AccessMode -> Encoding # toJSONList :: [AccessMode] -> Value # toEncodingList :: [AccessMode] -> Encoding #
FromJSON AccessMode Source #
Instance details Defined in AccessControl Methods parseJSON :: Value -> Parser AccessMode # parseJSONList :: Value -> Parser [AccessMode] #

data AuthPath Source #

Constructors

AuthPath
Fields authPathPrefix :: Path The prefix of all the paths to which this authorization applies. authPathModes :: [AccessMode] The modes that are authorized on this path prefix.

Instances

Eq AuthPath Source #
Instance details Defined in AccessControl Methods (==) :: AuthPath -> AuthPath -> Bool # (/=) :: AuthPath -> AuthPath -> Bool #
Ord AuthPath Source #
Instance details Defined in AccessControl Methods compare :: AuthPath -> AuthPath -> Ordering # (<) :: AuthPath -> AuthPath -> Bool # (<=) :: AuthPath -> AuthPath -> Bool # (>) :: AuthPath -> AuthPath -> Bool # (>=) :: AuthPath -> AuthPath -> Bool # max :: AuthPath -> AuthPath -> AuthPath # min :: AuthPath -> AuthPath -> AuthPath #
Read AuthPath Source #
Instance details Defined in AccessControl Methods readsPrec :: Int -> ReadS AuthPath # readList :: ReadS [AuthPath] # readPrec :: ReadPrec AuthPath # readListPrec :: ReadPrec [AuthPath] #
Show AuthPath Source #
Instance details Defined in AccessControl Methods showsPrec :: Int -> AuthPath -> ShowS # show :: AuthPath -> String # showList :: [AuthPath] -> ShowS #
ToJSON AuthPath Source #
Instance details Defined in AccessControl Methods toJSON :: AuthPath -> Value # toEncoding :: AuthPath -> Encoding # toJSONList :: [AuthPath] -> Value # toEncodingList :: [AuthPath] -> Encoding #
FromJSON AuthPath Source #
Instance details Defined in AccessControl Methods parseJSON :: Value -> Parser AuthPath # parseJSONList :: Value -> Parser [AuthPath] #

data IcepeakClaim Source #

Defines the structure of a JWT claim for Icepeak.

Constructors

IcepeakClaim
Fields icepeakClaimWhitelist :: [AuthPath] The whitelist containing all authorizations.

Instances

Eq IcepeakClaim Source #
Instance details Defined in AccessControl Methods (==) :: IcepeakClaim -> IcepeakClaim -> Bool # (/=) :: IcepeakClaim -> IcepeakClaim -> Bool #
Ord IcepeakClaim Source #
Instance details Defined in AccessControl Methods compare :: IcepeakClaim -> IcepeakClaim -> Ordering # (<) :: IcepeakClaim -> IcepeakClaim -> Bool # (<=) :: IcepeakClaim -> IcepeakClaim -> Bool # (>) :: IcepeakClaim -> IcepeakClaim -> Bool # (>=) :: IcepeakClaim -> IcepeakClaim -> Bool # max :: IcepeakClaim -> IcepeakClaim -> IcepeakClaim # min :: IcepeakClaim -> IcepeakClaim -> IcepeakClaim #
Read IcepeakClaim Source #
Instance details Defined in AccessControl Methods readsPrec :: Int -> ReadS IcepeakClaim # readList :: ReadS [IcepeakClaim] # readPrec :: ReadPrec IcepeakClaim # readListPrec :: ReadPrec [IcepeakClaim] #
Show IcepeakClaim Source #
Instance details Defined in AccessControl Methods showsPrec :: Int -> IcepeakClaim -> ShowS # show :: IcepeakClaim -> String # showList :: [IcepeakClaim] -> ShowS #
ToJSON IcepeakClaim Source #
Instance details Defined in AccessControl Methods toJSON :: IcepeakClaim -> Value # toEncoding :: IcepeakClaim -> Encoding # toJSONList :: [IcepeakClaim] -> Value # toEncodingList :: [IcepeakClaim] -> Encoding #
FromJSON IcepeakClaim Source #
Instance details Defined in AccessControl Methods parseJSON :: Value -> Parser IcepeakClaim # parseJSONList :: Value -> Parser [IcepeakClaim] #

type Path = [Text] Source #

allowEverything :: IcepeakClaim Source #

A claim that allows all operations.

accessModeToText :: AccessMode -> Text Source #

textToAccessMode :: Text -> Maybe AccessMode Source #

isAuthorizedByClaim :: IcepeakClaim -> Path -> AccessMode -> Bool Source #

Check whether accessing the given path with the given mode is authorized by the supplied claim.