Network.Oz.Application

Provides a Network.Wai Application for managing Oz tickets.

The Oz ticket endpoints can be run with Warp or embedded within another application.

Documentation

ozApp :: OzServerOpts -> IO Application

Starts the Application.

ozAuth :: OzServerOpts -> Middleware

Network.Wai Middleware for Oz authentication. Resources can be selectively protected by applying ifRequest to the middleware.

data OzServerOpts

Constructors

OzServerOpts

Fields

• ozSecret :: Key

  The password for encrypting Oz tickets

• ozLoadApp :: OzLoadApp

  Callback to look up registered apps

• ozLoadGrant :: OzLoadGrant

  Callback to look up grants

• ozTicketOpts :: TicketOpts

  Ticket generation options

• ozHawk :: AuthReqOpts

  Configuration of Hawk for this server

• ozEndpoints :: Endpoints

  URL route configuration of API endpoints

type OzLoadApp = OzAppId -> IO (Either String OzApp)

User-supplied function to look up an Oz app definition by its identifier.

type OzLoadGrant = OzGrantId -> IO (Either String (OzGrant, Maybe OzExt))

User-supplied function to look up an Oz grant by its identifier.

defaultOzServerOpts :: Key -> OzServerOpts

An empty Oz endpoint configuration. The password should be set to something secret.

ozAppScotty :: OzServerOpts -> ScottyM ()

The Oz endpoints are actually implemented using Web.Scotty. This provides the ScottyM application which can be embedded within other Scotty apps.