Safe Haskell	None
Language	Haskell2010

Network.Oz.Types

Synopsis

Documentation

data OzTicket Source #

An object describing a ticket and its public properties. An Oz ticket is a set of Hawk credentials used by the application to access protected resources. Just like any other Hawk credentials.

Constructors

OzTicket

Fields

ozTicketExp :: POSIXTime
Ticket expiration time.
ozTicketApp :: OzAppId
The application id the ticket was issued to.
ozTicketUser :: Maybe OzUserId
The user id if the ticket represents access to user resources. If no user id is included, the ticket allows the application access to the application own resources only.
ozTicketScope :: OzScope
The ticket scope. Defaults to [] if no scope is specified.
ozTicketGrant :: Maybe OzGrantId
If user is set, includes the grant identifier referencing the authorization granted by the user to the application. Can be a unique identifier or string encoding the grant information as long as the server is able to parse the information later.
ozTicketDelegate :: Bool
If false, the ticket cannot be delegated regardless of the application permissions. Defaults to true which means use the application permissions to delegate.
ozTicketDlg :: Maybe OzAppId
If the ticket is the result of access delegation, the application id of the delegating application.

Instances

Show OzTicket Source #
Methods showsPrec :: Int -> OzTicket -> ShowS # show :: OzTicket -> String # showList :: [OzTicket] -> ShowS #
Generic OzTicket Source #
Associated Types type Rep OzTicket :: * -> * # Methods from :: OzTicket -> Rep OzTicket x # to :: Rep OzTicket x -> OzTicket #
type Rep OzTicket Source #
type Rep OzTicket = D1 (MetaData "OzTicket" "Network.Oz.Types" "hsoz-0.0.1.0-5r17DkUA43zE9P6QhuhthQ" False) (C1 (MetaCons "OzTicket" PrefixI True) ((::) ((::) (S1 (MetaSel (Just Symbol "ozTicketExp") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 POSIXTime)) ((::) (S1 (MetaSel (Just Symbol "ozTicketApp") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OzAppId)) (S1 (MetaSel (Just Symbol "ozTicketUser") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe OzUserId))))) ((::) ((::) (S1 (MetaSel (Just Symbol "ozTicketScope") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OzScope)) (S1 (MetaSel (Just Symbol "ozTicketGrant") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe OzGrantId)))) ((::) (S1 (MetaSel (Just Symbol "ozTicketDelegate") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "ozTicketDlg") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe OzAppId)))))))

data OzSealedTicket Source #

A sealed ticket is the result of issue. It is JSON-encoded and given to the app.

Unlike most Hawk credential identifiers, the Oz ticket identifier is an encoded Iron string which when decoded contains an OzTicket

Constructors

OzSealedTicket
Fields ozTicket :: OzTicket ozTicketKey :: Key A shared secret used to authenticate. ozTicketAlgorithm :: HawkAlgo The HMAC algorithm used to authenticate (e.g. HMAC-SHA256). ozTicketExt :: Object Custom server public data attached to the ticket. ozTicketId :: OzTicketId The ticket identifier used for making authenticated Hawk requests.

Instances

Show OzSealedTicket Source #
Methods showsPrec :: Int -> OzSealedTicket -> ShowS # show :: OzSealedTicket -> String # showList :: [OzSealedTicket] -> ShowS #
Generic OzSealedTicket Source #
Associated Types type Rep OzSealedTicket :: * -> * # Methods from :: OzSealedTicket -> Rep OzSealedTicket x # to :: Rep OzSealedTicket x -> OzSealedTicket #
type Rep OzSealedTicket Source #
type Rep OzSealedTicket = D1 (MetaData "OzSealedTicket" "Network.Oz.Types" "hsoz-0.0.1.0-5r17DkUA43zE9P6QhuhthQ" False) (C1 (MetaCons "OzSealedTicket" PrefixI True) ((::) ((::) (S1 (MetaSel (Just Symbol "ozTicket") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OzTicket)) (S1 (MetaSel (Just Symbol "ozTicketKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Key))) ((::) (S1 (MetaSel (Just Symbol "ozTicketAlgorithm") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 HawkAlgo)) ((::) (S1 (MetaSel (Just Symbol "ozTicketExt") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Object)) (S1 (MetaSel (Just Symbol "ozTicketId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OzTicketId))))))

data OzApp Source #

An object describing an application.

Constructors

OzApp
Fields ozAppId :: OzAppId The application identifier ozAppScope :: Maybe OzScope An array with the default application scope. ozAppDelegate :: Bool If true, the application is allowed to delegate a ticket to another application. Defaults to false. ozAppKey :: Key The shared secret used to authenticate. ozAppAlgorithm :: HawkAlgo The HMAC algorithm used to authenticate.

Instances

Show OzApp Source #
Methods showsPrec :: Int -> OzApp -> ShowS # show :: OzApp -> String # showList :: [OzApp] -> ShowS #
Generic OzApp Source #
Associated Types type Rep OzApp :: * -> * # Methods from :: OzApp -> Rep OzApp x # to :: Rep OzApp x -> OzApp #
type Rep OzApp Source #
type Rep OzApp = D1 (MetaData "OzApp" "Network.Oz.Types" "hsoz-0.0.1.0-5r17DkUA43zE9P6QhuhthQ" False) (C1 (MetaCons "OzApp" PrefixI True) ((::) ((::) (S1 (MetaSel (Just Symbol "ozAppId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OzAppId)) (S1 (MetaSel (Just Symbol "ozAppScope") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe OzScope)))) ((::) (S1 (MetaSel (Just Symbol "ozAppDelegate") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) ((::) (S1 (MetaSel (Just Symbol "ozAppKey") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Key)) (S1 (MetaSel (Just Symbol "ozAppAlgorithm") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 HawkAlgo))))))

data OzGrant Source #

A grant is the authorization given to an application by a user to access the user's protected resources. Grants can be persisted in a database (usually to support revocation) or can be self describing (using an encoded identifier).

Constructors

OzGrant
Fields ozGrantId :: OzGrantId The grant identifier ozGrantApp :: OzAppId The application identifier. ozGrantUser :: OzUserId The user identifier. ozGrantExp :: POSIXTime Grant expiration time ozGrantScope :: Maybe OzScope An array with the scope granted by the user to the application.

Instances

Show OzGrant Source #
Methods showsPrec :: Int -> OzGrant -> ShowS # show :: OzGrant -> String # showList :: [OzGrant] -> ShowS #
Generic OzGrant Source #
Associated Types type Rep OzGrant :: * -> * # Methods from :: OzGrant -> Rep OzGrant x # to :: Rep OzGrant x -> OzGrant #
type Rep OzGrant Source #
type Rep OzGrant = D1 (MetaData "OzGrant" "Network.Oz.Types" "hsoz-0.0.1.0-5r17DkUA43zE9P6QhuhthQ" False) (C1 (MetaCons "OzGrant" PrefixI True) ((::) ((::) (S1 (MetaSel (Just Symbol "ozGrantId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OzGrantId)) (S1 (MetaSel (Just Symbol "ozGrantApp") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OzAppId))) ((::) (S1 (MetaSel (Just Symbol "ozGrantUser") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OzUserId)) ((::) (S1 (MetaSel (Just Symbol "ozGrantExp") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 POSIXTime)) (S1 (MetaSel (Just Symbol "ozGrantScope") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe OzScope)))))))

data OzExt Source #

An object used to include custom server data in the ticket and response. The public part is included in the Oz reponse under ticket.ext. The private part is only available within the encoded ticket.

Constructors

OzExt
Fields ozExtPublic :: Object Public ext; included in response ozExtPrivate :: Object Private ext; only in encoded ticket.

Instances

Eq OzExt Source #
Methods (==) :: OzExt -> OzExt -> Bool # (/=) :: OzExt -> OzExt -> Bool #
Show OzExt Source #
Methods showsPrec :: Int -> OzExt -> ShowS # show :: OzExt -> String # showList :: [OzExt] -> ShowS #
Generic OzExt Source #
Associated Types type Rep OzExt :: * -> * # Methods from :: OzExt -> Rep OzExt x # to :: Rep OzExt x -> OzExt #
Monoid OzExt Source #
Methods mempty :: OzExt # mappend :: OzExt -> OzExt -> OzExt # mconcat :: [OzExt] -> OzExt #
type Rep OzExt Source #
type Rep OzExt = D1 (MetaData "OzExt" "Network.Oz.Types" "hsoz-0.0.1.0-5r17DkUA43zE9P6QhuhthQ" False) (C1 (MetaCons "OzExt" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "ozExtPublic") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Object)) (S1 (MetaSel (Just Symbol "ozExtPrivate") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Object))))

data TicketOpts Source #

Ticket generation options. The default values are:

One hour ticket lifetime.
One minute RSVP lifetime.
Use the application permissions to delegate.
defaults Iron configuration.
32 byte Hawk key length.
SHA256 message authentication.
No ext data.

Constructors

TicketOpts

Fields

ticketOptsTicketTtl :: NominalDiffTime
Ticket lifetime
ticketOptsRsvpTtl :: NominalDiffTime
RSVP lifetime
ticketOptsDelegate :: Bool
If false, the ticket cannot be delegated regardless of the application permissions.
ticketOptsIron :: Options
Overrides the default Iron configuration.
ticketOptsKeyBytes :: Int
The Hawk key length in bytes.
ticketOptsHmacAlgorithm :: HawkAlgo
The Hawk HMAC algorithm.
ticketOptsExt :: OzExt
Custom server data to be included in the ticket.