Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
HTTP Authentication and Authorization header parsing and generation
HTTP authentication challenge types
include sig ... end
val challenge_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> challenge
val __challenge_of_sexp__ : Ppx_sexp_conv_lib.Sexp.t -> challenge
val sexp_of_challenge : challenge -> Ppx_sexp_conv_lib.Sexp.t
type credential = [
| `Basic of string * string
Basic authorization with a username and password
*)| `Other of string
An unknown credential type that will be passed straight through to the application layer
*) ]
HTTP authorization credential types
include sig ... end
val credential_of_sexp : Ppx_sexp_conv_lib.Sexp.t -> credential
val __credential_of_sexp__ : Ppx_sexp_conv_lib.Sexp.t -> credential
val sexp_of_credential : credential -> Ppx_sexp_conv_lib.Sexp.t
val string_of_credential : credential -> string
string_of_credential
converts the credential
to a string compatible with the HTTP/1.1 wire format for authorization credentials ("responses")
val credential_of_string : string -> credential
credential_of_string cred_s
converts an HTTP response to an authentication challenge into a credential
. If the credential is not recognized, `Other cred_s
is returned.
val string_of_challenge : challenge -> string
string_of_challenge challenge
converts the challenge
to a string compatible with the HTTP/1.1 wire format for authentication challenges.
For example, a `Basic
challenge with realm "foo"
will be marshalled to "Basic realm=foo"
, which can then be combined with a www-authenticate
HTTP header and sent back to the client. There is a helper function Header.add_authorization_req
that does just this.