Up

module Uq_ssl

: sig

Asynchronous SSL connections

#
exception Ssl_error of Ssl.ssl_error

Used in when_done callbacks to indicate an SSL-specific error code

#
type ssl_socket_state = [
| `Unset
| `Client
| `Server
| `Unclean
| `Clean
]
#
class type ssl_multiplex_controller =
inherit Uq_engines.multiplex_controller
#
method ssl_socket : Ssl.socket
#
method ssl_socket_state : ssl_socket_state

Returns the socket state:

  • `Unset: A fresh socket
  • `Client: A socket playing the SSL client role
  • `Server: A socket playing the SSL server role
  • `Unclean: The socket state is unclean. The socket is no longer usable.
  • `Clean: The SSL connection has been cleanly shut down.
#
method ssl_connecting : bool

Whether the initial SSL handshake is in progress that makes this socket a client.

#
method ssl_accepting : bool

Whether the initial SSL handshake is in progress that makes this socket a server.

#
method start_ssl_connecting : when_done:(exn option -> unit) -> unit -> unit

Makes the socket an SSL client socket by initiating the handshake. The when_done callback is invoked when the handshake is done.

One can neither read nor write before that.

#
method start_ssl_accepting : when_done:(exn option -> unit) -> unit -> unit

Makes the socket an SSL server socket by initiating the handshake. The when_done callback is invoked when the handshake is done.

One can neither read nor write before that.

#
method inactivate_no_close : unit -> unit

Inactivates the controller by deleting all event handlers. The file descriptor, however, is not closed. Normal users should not call this method.

The ssl_multiplex_controller is an extended multiplex controller which can also control SSL handshakes.

Important note: SSL/TLS does not support half-open connections. When one party closes the connection, the other party must immediately close the connection, too, throwing away any pending writes. See RFC 2246.

#
val create_ssl_multiplex_controller : ?close_inactive_descr:bool -> ?preclose:(unit -> unit) -> ?initial_state:ssl_socket_state -> ?timeout:float * exn -> ?ssl_socket:Ssl.socket -> Unix.file_descr -> Ssl.context -> Unixqueue.event_system -> ssl_multiplex_controller

Creates a multiplex controller for an SSL socket. The descriptor must be a connected socket descriptor.

close_inactive_descr: Whether to close the file descriptor by inactivate.

preclose: This function is called immediately before closing the descriptor

initial_state: can be set to `Client or `Server if the context is already established. Defaults to `Unset

timeout: if set to (t, x), started operations time out after t seconds and pass the exception x back. A timeout is only indicated when all started operations are inactive for t seconds.

ssl_socket: If passed, this socket is used instead of creating a new one for the file descriptor. It is required that the descriptor and the SSL context are connected with this SSL socket.

#
val ssl_connect_engine : ssl_multiplex_controller -> unit Uq_engines.engine

This engine performs the client handshake.

#
val ssl_accept_engine : ssl_multiplex_controller -> unit Uq_engines.engine

This engine performs the server handshake.

Debugging

#
module Debug : sig
#
val enable : bool Pervasives.ref

Enables [root:Netlog]-style debugging of this module

#
val dump_data : bool Pervasives.ref

If also enable, output a full dump of payload data

end
end