7 API documentation
The section contains the documentation extracted from the header files of library API. Only the public part of the API is exposed.
The internal part of the API is exposed in an other manual.
7.1 Headers list [link]
| Name | Description |
|---|---|
| assh/assh.h | Constants and forward declarations |
| assh/assh_algo.h | SSH algorithms base descriptor structure and related functions |
| assh/assh_alloc.h | Pluggable memory allocation functions used by the library |
| assh/assh_buffer.h | SSH string buffers |
| assh/assh_cipher.h | SSH cipher module interface |
| assh/assh_compress.h | SSH compression module interface |
| assh/assh_connection.h | SSH connection service (rfc4254 channels and requests) |
| assh/assh_context.h | Main context structure and related functions |
| assh/assh_event.h | Event reporting structure and related functions |
| assh/assh_kex.h | SSH key exchange module interface and helpers |
| assh/assh_key.h | SSH keys base structure and related functions |
| assh/assh_mac.h | SSH message authentication code module interface |
| assh/assh_packet.h | SSH packets management |
| assh/assh_prng.h | Random generator module interface |
| assh/assh_service.h | SSH service module interface |
| assh/assh_session.h | Session structure and related functions |
| assh/assh_sign.h | SSH signature module interface |
| assh/assh_transport.h | SSH transport layer protocol (rfc4253) |
| assh/assh_userauth.h | Common declarations for the ssh-userauth service (rfc4252) |
| assh/assh_userauth_client.h | Implementation of the client side ssh-userauth service (rfc4252) |
| assh/assh_userauth_server.h | Implementation of the server side ssh-userauth service (rfc4252) |
| assh/helper_client.h | SSH client application helpers |
| assh/helper_interactive.h | SSH interactive session helpers (rfc4254 interactive sessions) |
| assh/helper_io.h | IO events handling and IO related helper functions |
| assh/helper_key.h | SSH keys file IO |
| assh/helper_portfwd.h | SSH port forwarding helpers (rfc4254 port forwarding) |
| assh/helper_server.h | SSH server application helpers |
| assh/mod_builtin.h | Descriptors for builtin algorithms and modules |
| assh/mod_gcrypt.h | Descriptors for algorithms and modules based on Libgcrypt |
| assh/mod_openssl.h | Descriptors for algorithms and modules based on OpenSSL |
| assh/mod_sodium.h | Descriptors for algorithms and modules based on libsodium |
| assh/mod_zlib.h | Descriptors for algorithms and modules based on zlib |
| doc/config.h | Build configuration macro examples |