Snap.Snaplet.SqliteSimple.JwtAuth.JwtAuth

Documentation

data SqliteJwt

Constructors

SqliteJwt

Fields

• siteSecret :: Secret
• sqliteJwtConn :: MVar Connection

data User

User account User ID and login name.

If you need to store additional fields for your user accounts, persist them in your application SQL tables and key them by userId.

Constructors

User

Fields

• userId :: Int

  The database ID of the user account

• userLogin :: Text

  The login name

Instances

Eq User

Methods

(==) :: User -> User -> Bool

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

Show User

Methods

showsPrec :: Int -> User -> ShowS

show :: User -> String

showList :: [User] -> ShowS

ToJSON User

Methods

toJSON :: User -> Value

toEncoding :: User -> Encoding

toJSONList :: [User] -> Value

toEncodingList :: [User] -> Encoding

FromJSON User

Methods

parseJSON :: Value -> Parser User

parseJSONList :: Value -> Parser [User]

data AuthFailure

Types of errors that can happen on login or new user creation.

Constructors

UnknownUser

The login name does not exist.

DuplicateLogin

The login name already exists.

WrongPassword

Failed the password check.

Instances

Eq AuthFailure

Methods

(==) :: AuthFailure -> AuthFailure -> Bool

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

Show AuthFailure

Methods

showsPrec :: Int -> AuthFailure -> ShowS

show :: AuthFailure -> String

showList :: [AuthFailure] -> ShowS

sqliteJwtInit

Arguments

:: String

JWT secret signing key filename

-> Snaplet Sqlite

The sqlite-simple snaplet

-> SnapletInit b SqliteJwt

Initializer for the sqlite-simple JwtAuth snaplet.

If the secret random key jwtSigningKeyFname doesn't exist in the current working directory, a new random key will be generated. Otherwise the existing key will be loaded as the site signing key. This key is used to sign the JWTs generated by the login procedure.

Initialization will automatically setup SQL tables used to store user accounts. It will also automatically upgrade the SQL schema if necessary.

requireAuth :: (User -> Handler b SqliteJwt a) -> Handler b SqliteJwt a

Run a handler with the currently logged in user.

Verify authentication from the JWT token passed in the Authorization header, and run the user provided action with the logged in user.

On errors such as missing or malformed JWT or failure to verify the JWT, error out early and issue an HTTP 401 error.

registerUser :: Handler b SqliteJwt ()

loginUser :: Handler b SqliteJwt ()

createUser

Arguments

:: Text

Login name of the user to be created

-> Text

Password of the new user

-> Handler b SqliteJwt (Either AuthFailure User)

Create a new user.

login

Arguments

:: Text

Login name of the user logging in

-> Text

Password

-> Handler b SqliteJwt (Either AuthFailure User)

Login a user

jsonResponse :: MonadSnap m => m ()

writeJSON :: (MonadSnap m, ToJSON a) => a -> m ()

reqJSON :: (MonadSnap m, FromJSON b) => m b

Demand the presence of JSON in the body assuming it is not larger than 50000 bytes.