package cohttp

You can search for identifiers within the package.

in-package search v0.2.0

package cohttp

cohttp
- Cohttp
  - Accept
  - Auth
  - Body
  - Code
  - Conf
  - Connection
  - Cookie
    
    Cookie_hdr
    
    Set_cookie_hdr
  - Header
  - Link
    
    Arc
    
    Charset
    
    Ext
    
    Language
    
    Rel
  - Path
  - Request
    
    Make
    
    IO
  - Response
    
    Make
    
    IO
  - S
    
    Body
    
    Http_io
    
    IO
    
    IO
    
    Request
    
    Response
  - Transfer

Legend:
Library
Module
Module type
Parameter
Class
Class type

HTTP Authentication and Authorization header parsing and generation

type challenge = [

| `Basic of string
(*
Basic authentication within a realm
*)

]

HTTP authentication challenge types

val sexp_of_challenge : challenge -> Sexplib0.Sexp.t

val challenge_of_sexp : Sexplib0.Sexp.t -> challenge

val __challenge_of_sexp__ : Sexplib0.Sexp.t -> challenge

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

val sexp_of_credential : credential -> Sexplib0.Sexp.t

val credential_of_sexp : Sexplib0.Sexp.t -> credential

val __credential_of_sexp__ : Sexplib0.Sexp.t -> credential

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.