Header menu logo FSharp.ATProto

Auth Module

Authentication middleware for XRPC servers. Accepts a user-supplied verification function -- no direct crypto dependency.

Functions and values

Function or value Description

ClaimsPrincipalKey

Full Usage: ClaimsPrincipalKey

Returns: string

Key used to store the authenticated ClaimsPrincipal in HttpContext.Items.

Returns: string

extractBearerToken ctx

Full Usage: extractBearerToken ctx

Parameters:
Returns: string option

Extract the Bearer token from the Authorization header.

ctx : HttpContext
Returns: string option

getClaim claimType ctx

Full Usage: getClaim claimType ctx

Parameters:
Returns: string option

Get a specific claim value from the authenticated principal.

claimType : string
ctx : HttpContext
Returns: string option

getPrincipal ctx

Full Usage: getPrincipal ctx

Parameters:
Returns: ClaimsPrincipal option

Retrieve the authenticated ClaimsPrincipal from HttpContext.Items. Returns None if the request was not authenticated.

ctx : HttpContext
Returns: ClaimsPrincipal option

verifyRequest verifyToken ctx

Full Usage: verifyRequest verifyToken ctx

Parameters:
Returns: Task<Result<ClaimsPrincipal, string>>

Verify the request's bearer token using the supplied verification function. On success, stores the ClaimsPrincipal in HttpContext.Items. Returns Ok with the principal on success, or Error with a message on failure.

verifyToken : string -> Task<Result<ClaimsPrincipal, string>>
ctx : HttpContext
Returns: Task<Result<ClaimsPrincipal, string>>

Type something to start searching.