awa 0.4.0 (latest) · OCaml Package

val version_banner : string

val max_pkt_len : int

val max_len : int

val channel_win_len : int32

val channel_win_adj_threshold : int32

val channel_max_pkt_len : int32

val max_channels : int

val min_dh : int32

val n : int32

val max_dh : int32

val guard_sshlen : int -> (unit, string) result

val guard_sshlen_exn : int -> unit

type message_id =

| MSG_DISCONNECT
| MSG_IGNORE
| MSG_UNIMPLEMENTED
| MSG_DEBUG
| MSG_SERVICE_REQUEST
| MSG_SERVICE_ACCEPT
| MSG_EXT_INFO
| MSG_KEXINIT
| MSG_NEWKEYS
| MSG_KEX_0
| MSG_KEX_1
| MSG_KEX_2
| MSG_KEX_3
| MSG_KEX_4
| MSG_USERAUTH_REQUEST
| MSG_USERAUTH_FAILURE
| MSG_USERAUTH_SUCCESS
| MSG_USERAUTH_BANNER
| MSG_USERAUTH_1
| MSG_USERAUTH_2
| MSG_GLOBAL_REQUEST
| MSG_REQUEST_SUCCESS
| MSG_REQUEST_FAILURE
| MSG_CHANNEL_OPEN
| MSG_CHANNEL_OPEN_CONFIRMATION
| MSG_CHANNEL_OPEN_FAILURE
| MSG_CHANNEL_WINDOW_ADJUST
| MSG_CHANNEL_DATA
| MSG_CHANNEL_EXTENDED_DATA
| MSG_CHANNEL_EOF
| MSG_CHANNEL_CLOSE
| MSG_CHANNEL_REQUEST
| MSG_CHANNEL_SUCCESS
| MSG_CHANNEL_FAILURE
| MSG_VERSION

val message_id_to_int : message_id -> int

val int_to_message_id : int -> message_id option

type kexinit = {

cookie : Cstruct.t;
kex_algs : string list;
ext_info : [ `Ext_info_c | `Ext_info_s ] option;
server_host_key_algs : string list;
encryption_algs_ctos : string list;
encryption_algs_stoc : string list;
mac_algs_ctos : string list;
mac_algs_stoc : string list;
compression_algs_ctos : string list;
compression_algs_stoc : string list;
languages_ctos : string list;
languages_stoc : string list;
first_kex_packet_follows : bool;
rawkex : Cstruct.t;

}

val pp_kexinit : Format.formatter -> kexinit -> unit

type extension =

| Extension of {
1. name : string;
2. value : string;
}

val pp_extension : Format.formatter -> extension -> unit

type disconnect_code =

| DISCONNECT_HOST_NOT_ALLOWED_TO_CONNECT
| DISCONNECT_PROTOCOL_ERROR
| DISCONNECT_KEY_EXCHANGE_FAILED
| DISCONNECT_RESERVED
| DISCONNECT_MAC_ERROR
| DISCONNECT_COMPRESSION_ERROR
| DISCONNECT_SERVICE_NOT_AVAILABLE
| DISCONNECT_PROTOCOL_VERSION_NOT_SUPPORTED
| DISCONNECT_HOST_KEY_NOT_VERIFIABLE
| DISCONNECT_CONNECTION_LOST
| DISCONNECT_BY_APPLICATION
| DISCONNECT_TOO_MANY_CONNECTIONS
| DISCONNECT_AUTH_CANCELLED_BY_USER
| DISCONNECT_NO_MORE_AUTH_METHODS_AVAILABLE
| DISCONNECT_ILLEGAL_USER_NAME

val disconnect_code_to_int : disconnect_code -> int32

val int_to_disconnect_code : int32 -> disconnect_code

val disconnect_code_to_string : disconnect_code -> string

type channel_open_code =

| OPEN_ADMINISTRATIVELY_PROHIBITED
| OPEN_CONNECT_FAILED
| OPEN_UNKNOWN_CHANNEL_TYPE
| OPEN_RESOURCE_SHORTAGE

val channel_open_code_to_int : channel_open_code -> int32

val int_to_channel_open_code : int32 -> channel_open_code option

type mpint = Z.t

type global_request =

| Tcpip_forward of string * int32
| Cancel_tcpip_forward of string * int32
| Unknown_request of string

type channel_request =

| Pty_req of string * int32 * int32 * int32 * int32 * string
| X11_req of bool * string * string * int32
| Env of string * string
| Shell
| Exec of string
| Subsystem of string
| Window_change of int32 * int32 * int32 * int32
| Xon_xoff of bool
| Signal of string
| Exit_status of int32
| Exit_signal of string * bool * string * string
| Raw_data of Cstruct.t

type channel_open =

| Session
| X11 of string * int32
| Forwarded_tcpip of string * int32 * string * int32
| Direct_tcpip of string * int32 * string * int32
| Raw_data of Cstruct.t

type password = string

type auth_method =

| Pubkey of string * Cstruct.t * (string * string) option
| Password of password * password option
| Keyboard_interactive of string option * string list
| Authnone

val pp_auth_method : Format.formatter -> auth_method -> unit

val opt_eq : ('a -> 'b -> bool) -> 'a option -> 'b option -> bool

val auth_method_equal : auth_method -> auth_method -> bool

type message =

| Msg_disconnect of disconnect_code * string * string
| Msg_ignore of string
| Msg_unimplemented of int32
| Msg_debug of bool * string * string
| Msg_service_request of string
| Msg_service_accept of string
| Msg_kexinit of kexinit
| Msg_ext_info of extension list
| Msg_newkeys
| Msg_kexdh_reply of Hostkey.pub * mpint * Hostkey.alg * string
| Msg_kexdh_init of mpint
| Msg_kexecdh_reply of Hostkey.pub * mpint * Hostkey.alg * string
| Msg_kexecdh_init of mpint
| Msg_kexdh_gex_request of int32 * int32 * int32
| Msg_kexdh_gex_group of mpint * mpint
| Msg_kexdh_gex_init of mpint
| Msg_kexdh_gex_reply of Hostkey.pub * mpint * Hostkey.alg * string
| Msg_kex of message_id * Cstruct.t
| Msg_userauth_request of string * string * auth_method
| Msg_userauth_failure of string list * bool
| Msg_userauth_success
| Msg_userauth_banner of string * string
| Msg_userauth_1 of Cstruct.t
| Msg_userauth_2 of Cstruct.t
| Msg_userauth_pk_ok of Hostkey.pub
| Msg_userauth_info_request of string * string * string * (string * bool) list
| Msg_userauth_info_response of password list
| Msg_global_request of string * bool * global_request
| Msg_request_success of Cstruct.t option
| Msg_request_failure
| Msg_channel_open of int32 * int32 * int32 * channel_open
| Msg_channel_open_confirmation of int32 * int32 * int32 * int32 * Cstruct.t
| Msg_channel_open_failure of int32 * int32 * string * string
| Msg_channel_window_adjust of int32 * int32
| Msg_channel_data of int32 * Cstruct.t
| Msg_channel_extended_data of int32 * int32 * Cstruct.t
| Msg_channel_eof of int32
| Msg_channel_close of int32
| Msg_channel_request of int32 * bool * channel_request
| Msg_channel_success of int32
| Msg_channel_failure of int32
| Msg_version of string

val message_to_id : message -> message_id

val pp_lang : Format.formatter -> string -> unit

val pp_message : Format.formatter -> message -> unit

val message_to_int : message -> int

val disconnect_msg : disconnect_code -> string -> message

package awa