OBus_auth (p.obus.1.2.5.doc.obus.OBus

Sourcetype data = string

Data for an authentication mechanism

Sourceexception Auth_failure of string

Exception raised when authentication fail

Sourcetype capability = [

| `Unix_fd
(*
The transport supports unix fd passing
*)

]

List of capabilities clients/servers may support

Sourceval capabilities : capability list

List of all capabilities

Communication

Sourcetype stream

A stream is a way of communication for an authentication procedure

Source

val make_stream : 
  recv:(unit -> string Lwt.t) ->
  send:(string -> unit Lwt.t) ->
  stream

Creates a stream for authentication.

parameter recv
must read a complete line, ending with "\r\n",

parameter send
must send the given line.

Source

val stream_of_channels : 
  (Lwt_io.input_channel * Lwt_io.output_channel) ->
  stream

Creates a stream from a pair of channels

Sourceval stream_of_fd : Lwt_unix.file_descr -> stream

Creates a stream from a file descriptor. Note that the stream created by this function is not really efficient because it has to read characters one by one to ensure it does not consume too much.

Sourceval max_line_length : int

Maximum length accepted for lines of the authentication protocol. Beyond this limit, authentication will fail.

Sourcemodule Client : sig ... end

Client-side authentication

Sourcemodule Server : sig ... end

Server-side authentication