package obus

  1. Overview
  2. Docs
On This Page
  1. Communication
package obus
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module OBus_authSource

Handle authentication mechanisms

Sourcetype data = string

Data for an authentication mechanism

Sourceexception Auth_failure of string

Exception raised when authentication fail

Sourcetype capability = [
  1. | `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

Sourceval 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.

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