Low-level bindings

ssh_finalize()

Upstream documentation.

ssh_init()

Upstream documentation.

Value returned when the function is in non-blocking mode and must be called again.

Auth method enum (upstream documentation).

Auth method enum (upstream documentation).

Auth method enum (upstream documentation).

Auth method enum (upstream documentation).

Auth method enum (upstream documentation).

Auth method enum (upstream documentation).

Auth method enum (upstream documentation).

Value returned if an error occurred.

Value returned on success.

Upstream documentation.

ssh_set_agent_channel(session, channel)

Upstream documentation.

ssh_set_agent_socket(session, fd)

Upstream documentation.

ssh_userauth_agent(session, username)

Upstream documentation.

ssh_userauth_gssapi(session)

Upstream documentation.

ssh_userauth_kbdint(session, user, submethods)

Upstream documentation.

ssh_userauth_kbdint_getanswer(session, i; throw = true)

Auto-generated wrapper around ssh_userauth_kbdint_getanswer().

ssh_userauth_kbdint_getinstruction(session)

Upstream documentation.

ssh_userauth_kbdint_getname(session; throw = true)

Auto-generated wrapper around ssh_userauth_kbdint_getname().

ssh_userauth_kbdint_getnanswers(session)

Upstream documentation.

ssh_userauth_kbdint_getnprompts(session)

Upstream documentation.

ssh_userauth_kbdint_getprompt(session, i, echo; throw = true)

Auto-generated wrapper around ssh_userauth_kbdint_getprompt().

ssh_userauth_kbdint_setanswer(session, i, answer)

Upstream documentation.

ssh_userauth_list(session, username)

Upstream documentation.

ssh_userauth_none(session, username)

Upstream documentation.

ssh_userauth_password(session, username, password)

Upstream documentation.

ssh_userauth_publickey(session, username, privkey)

Upstream documentation.

ssh_userauth_publickey_auto(session, username, passphrase)

Upstream documentation.

ssh_userauth_publickey_auto_get_current_identity(session, value)

Upstream documentation.

ssh_userauth_try_publickey(session, username, pubkey)

Upstream documentation.

ssh_buffer_add_data(buffer, data, len)

Upstream documentation.

ssh_buffer_free(buffer)

Upstream documentation.

ssh_buffer_get(buffer)

Upstream documentation.

ssh_buffer_get_data(buffer, data, requestedlen)

Upstream documentation.

ssh_buffer_get_len(buffer)

Upstream documentation.

ssh_buffer_new()

Upstream documentation.

ssh_buffer_reinit(buffer)

Upstream documentation.

ssh_add_channel_callbacks(channel, cb)

Add channel callback functions

This function will add channel callback functions to the channel callback list. Callbacks missing from a callback structure will be probed in the next on the list.

Arguments

• channel: The channel to set the callback structure.
• cb: The callback structure itself.

Returns

SSH_OK on success, SSH_ERROR on error.

See also

ssh_set_channel_callbacks

ssh_remove_channel_callbacks(channel, cb)

Remove a channel callback.

The channel has been added with ssh_add_channel_callbacks or ssh_set_channel_callbacks in this case.

Arguments

• channel: The channel to remove the callback structure from.
• cb: The callback structure to remove

Returns

SSH_OK on success, SSH_ERROR on error.

ssh_set_callbacks(session, cb)

Set the session callback functions.

This functions sets the callback structure to use your own callback functions for auth, logging and status.

Note, that the callback structure is not copied into the session so it needs to be valid for the whole session lifetime.

 struct ssh_callbacks_struct cb = {
   .userdata = data,
   .auth_function = my_auth_function
 };
 ssh_callbacks_init(&cb);
 ssh_set_callbacks(session, &cb);

Arguments

• session: The session to set the callback structure.
• cb: The callback structure itself.

Returns

SSH_OK on success, SSH_ERROR on error.

ssh_set_channel_callbacks(channel, cb)

Set the channel callback functions.

This functions sets the callback structure to use your own callback functions for channel data and exceptions.

Note, that the structure is not copied to the channel structure so it needs to be valid as for the whole life of the channel or until it is removed with ssh_remove_channel_callbacks().

 struct ssh_channel_callbacks_struct cb = {
   .userdata = data,
   .channel_data_function = my_channel_data_function
 };
 ssh_callbacks_init(&cb);
 ssh_set_channel_callbacks(channel, &cb);

Arguments

• channel: The channel to set the callback structure.
• cb: The callback structure itself.

Returns

SSH_OK on success, SSH_ERROR on error.

ssh_set_server_callbacks(session, cb)

Set the session server callback functions.

This functions sets the callback structure to use your own callback functions for user authentication, new channels and requests.

Note, that the structure is not copied to the session structure so it needs to be valid for the whole session lifetime.

 struct ssh_server_callbacks_struct cb = {
   .userdata = data,
   .auth_password_function = my_auth_function
 };
 ssh_callbacks_init(&cb);
 ssh_set_server_callbacks(session, &cb);

Arguments

• session: The session to set the callback structure.
• cb: The callback structure itself.

Returns

SSH_OK on success, SSH_ERROR on error.

channel_read_buffer(channel, buffer, count, is_stderr)

Upstream documentation.

ssh_channel_accept_forward(session, timeout_ms, destination_port)

Upstream documentation.

ssh_channel_accept_x11(channel, timeout_ms)

Upstream documentation.

ssh_channel_cancel_forward(session, address, port)

Upstream documentation.

ssh_channel_change_pty_size(channel, cols, rows)

Upstream documentation.

ssh_channel_close(channel)

Upstream documentation.

ssh_channel_free(channel)

Upstream documentation.

ssh_channel_get_exit_state(channel, pexit_code, pexit_signal, pcore_dumped)

Upstream documentation.

ssh_channel_get_exit_status(channel)

Upstream documentation.

ssh_channel_get_session(channel)

Upstream documentation.

ssh_channel_is_closed(channel)

Upstream documentation.

ssh_channel_is_eof(channel)

Upstream documentation.

ssh_channel_is_open(channel)

Upstream documentation.

ssh_channel_listen_forward(session, address, port, bound_port)

Upstream documentation.

ssh_channel_new(session)

Upstream documentation.

ssh_channel_open_auth_agent(channel)

Upstream documentation.

ssh_channel_open_forward(channel, remotehost, remoteport, sourcehost, localport)

Upstream documentation.

ssh_channel_open_forward_port(session, timeout_ms, destination_port, originator, originator_port)

Upstream documentation.

ssh_channel_open_forward_unix(channel, remotepath, sourcehost, localport)

Upstream documentation.

ssh_channel_open_reverse_forward(channel, remotehost, remoteport, sourcehost, localport)

Upstream documentation.

ssh_channel_open_session(channel)

Upstream documentation.

ssh_channel_open_x11(channel, orig_addr, orig_port)

Upstream documentation.

ssh_channel_poll(channel, is_stderr)

Upstream documentation.

ssh_channel_poll_timeout(channel, timeout, is_stderr)

Upstream documentation.

ssh_channel_read(channel, dest, count, is_stderr)

Upstream documentation.

ssh_channel_read_nonblocking(channel, dest, count, is_stderr)

Upstream documentation.

ssh_channel_read_timeout(channel, dest, count, is_stderr, timeout_ms)

Upstream documentation.

ssh_channel_request_auth_agent(channel)

Upstream documentation.

ssh_channel_request_env(channel, name, value)

Upstream documentation.

ssh_channel_request_exec(channel, cmd)

Upstream documentation.

ssh_channel_request_pty(channel)

Upstream documentation.

ssh_channel_request_pty_size_modes(channel, term, cols, rows, modes, modes_len)

Upstream documentation.

ssh_channel_request_send_break(channel, length)

Upstream documentation.

ssh_channel_request_send_exit_signal(channel, signum, core, errmsg, lang)

Upstream documentation.

ssh_channel_request_send_exit_status(channel, exit_status)

Upstream documentation.

ssh_channel_request_send_signal(channel, signum)

Upstream documentation.

ssh_channel_request_sftp(channel)

Upstream documentation.

ssh_channel_request_shell(channel)

Upstream documentation.

ssh_channel_request_subsystem(channel, subsystem)

Upstream documentation.

ssh_channel_request_x11(channel, single_connection, protocol, cookie, screen_number)

Upstream documentation.

ssh_channel_select(readchans, writechans, exceptchans, timeout)

Upstream documentation.

ssh_channel_send_eof(channel)

Upstream documentation.

ssh_channel_set_blocking(channel, blocking)

Upstream documentation.

ssh_channel_set_counter(channel, counter)

Upstream documentation.

ssh_channel_window_size(channel)

Upstream documentation.

ssh_channel_write(channel, data, len)

Upstream documentation.

ssh_channel_write_stderr(channel, data, len)

Upstream documentation.

ssh_get_error(error)

Upstream documentation.

ssh_get_error_code(error)

Upstream documentation.

ssh_basename(path)

Upstream documentation.

ssh_dirname(path)

Upstream documentation.

ssh_get_hexa(what, len)

Upstream documentation.

ssh_get_random(where, len, strong)

Upstream documentation.

ssh_getpass(prompt, buf, len, echo, verify)

Upstream documentation.

ssh_mkdir(pathname, mode)

Upstream documentation.

ssh_print_hexa(descr, what, len)

Upstream documentation.

ssh_version(req_version)

Upstream documentation.

ssh_get_log_callback()

Get the pointer to the logging callback function.

Returns

The pointer the the callback or NULL if none set.

ssh_get_log_level()

Upstream documentation.

ssh_get_log_userdata()

Upstream documentation.

ssh_set_log_callback(cb)

Set the logging callback function.

Arguments

• cb:[in] The callback to set.

Returns

0 on success, < 0 on error.

ssh_set_log_level(level)

Upstream documentation.

ssh_set_log_userdata(data)

Upstream documentation.

ssh_message_free(msg)

Upstream documentation.

ssh_message_get(session)

Upstream documentation.

ssh_message_subtype(msg)

Upstream documentation.

ssh_message_type(msg)

Upstream documentation.

ssh_event_add_connector(event, connector)

Upstream documentation.

ssh_event_add_fd(event, fd, events, cb, userdata)

Upstream documentation.

ssh_event_add_session(event, session)

Upstream documentation.

ssh_event_dopoll(event, timeout)

Upstream documentation.

ssh_event_free(event)

Upstream documentation.

ssh_event_new()

Upstream documentation.

ssh_event_remove_connector(event, connector)

Upstream documentation.

ssh_event_remove_fd(event, fd)

Upstream documentation.

ssh_event_remove_session(event, session)

Upstream documentation.

ssh_key_cmp(k1, k2, what)

Upstream documentation.

ssh_key_dup(key)

Upstream documentation.

ssh_key_free(key)

Upstream documentation.

ssh_key_is_private(k)

Upstream documentation.

ssh_key_is_public(k)

Upstream documentation.

ssh_key_new()

Upstream documentation.

ssh_key_type(key)

Upstream documentation.

ssh_key_type_from_name(name)

Upstream documentation.

ssh_key_type_to_char(type)

Upstream documentation.

ssh_pki_copy_cert_to_privkey(cert_key, privkey)

Upstream documentation.

ssh_pki_export_privkey_base64(privkey, passphrase, auth_fn, auth_data, b64_key)

Upstream documentation.

ssh_pki_export_privkey_base64_format(privkey, passphrase, auth_fn, auth_data, b64_key, format)

Upstream documentation.

ssh_pki_export_privkey_file(privkey, passphrase, auth_fn, auth_data, filename)

Upstream documentation.

ssh_pki_export_privkey_file_format(privkey, passphrase, auth_fn, auth_data, filename, format)

Upstream documentation.

ssh_pki_export_privkey_to_pubkey(privkey, pkey)

Upstream documentation.

ssh_pki_export_pubkey_base64(key, b64_key)

Upstream documentation.

ssh_pki_export_pubkey_file(key, filename)

Upstream documentation.

ssh_pki_generate(type, parameter, pkey)

Upstream documentation.

ssh_pki_import_cert_base64(b64_cert, type, pkey)

Upstream documentation.

ssh_pki_import_cert_file(filename, pkey)

Upstream documentation.

ssh_pki_import_privkey_base64(b64_key, passphrase, auth_fn, auth_data, pkey)

Upstream documentation.

ssh_pki_import_privkey_file(filename, passphrase, auth_fn, auth_data, pkey)

Upstream documentation.

ssh_pki_import_pubkey_base64(b64_key, type, pkey)

Upstream documentation.

ssh_pki_import_pubkey_file(filename, pkey)

Upstream documentation.

ssh_pki_key_ecdsa_name(key)

Upstream documentation.

ssh_bind_accept(ssh_bind_o, session)

Accept an incoming ssh connection and initialize the session.

Arguments

• ssh_bind_o: The ssh server bind to accept a connection.
• session: A preallocated ssh session

Returns

SSH_OK when a connection is established

See also

ssh_new

ssh_bind_accept_fd(ssh_bind_o, session, fd)

Accept an incoming ssh connection on the given file descriptor and initialize the session.

Arguments

• ssh_bind_o: The ssh server bind to accept a connection.
• session: A preallocated ssh session
• fd: A file descriptor of an already established TCP inbound connection

Returns

SSH_OK when a connection is established

See also

ssh_new, ssh_bind_accept

ssh_bind_fd_toaccept(ssh_bind_o)

Allow the file descriptor to accept new sessions.

Arguments

• ssh_bind_o: The ssh server bind to use.

ssh_bind_free(ssh_bind_o)

Free a ssh servers bind.

Note that this will also free options that have been set on the bind, including keys set with SSH_BIND_OPTIONS_IMPORT_KEY.

Arguments

• ssh_bind_o: The ssh server bind to free.

ssh_bind_get_fd(ssh_bind_o)

Recover the file descriptor from the session.

Arguments

• ssh_bind_o: The ssh server bind to get the fd from.

Returns

The file descriptor.

ssh_bind_listen(ssh_bind_o)

Start listening to the socket.

Arguments

• ssh_bind_o: The ssh server bind to use.

Returns

0 on success, < 0 on error.

ssh_bind_new()

Creates a new SSH server bind.

Returns

A newly allocated ssh_bind session pointer.

ssh_bind_options_parse_config(sshbind, filename)

Upstream documentation.

ssh_bind_options_set(sshbind, type, value)

Upstream documentation.

ssh_bind_set_blocking(ssh_bind_o, blocking)

Set the session to blocking/nonblocking mode.

Arguments

• ssh_bind_o: The ssh server bind to use.
• blocking: Zero for nonblocking mode.

ssh_bind_set_callbacks(sshbind, callbacks, userdata)

Set the callback for this bind.

     struct ssh_callbacks_struct cb = {
         .userdata = data,
         .auth_function = my_auth_function
     };
     ssh_callbacks_init(&cb);
     ssh_bind_set_callbacks(session, &cb);

Arguments

• sshbind:[in] The bind to set the callback on.
• callbacks:[in] An already set up ssh_bind_callbacks instance.
• userdata:[in] A pointer to private data to pass to the callbacks.

Returns

SSH_OK on success, SSH_ERROR if an error occurred.

ssh_bind_set_fd(ssh_bind_o, fd)

Set the file descriptor for a session.

Arguments

• ssh_bind_o: The ssh server bind to set the fd.
• fd: The file descriptssh_bind B

ssh_gssapi_get_creds(session)

Upstream documentation.

ssh_handle_key_exchange(session)

Handles the key exchange and set up encryption

Arguments

• session: A connected ssh session

Returns

SSH_OK if the key exchange was successful

See also

ssh_bind_accept

ssh_message_auth_kbdint_is_response(msg)

Auto-generated wrapper around ssh_message_auth_kbdint_is_response().

ssh_message_auth_password(msg; throw = true)

Auto-generated wrapper around ssh_message_auth_password(). Original upstream documentation is below.

Get the password of the authenticated user.

Arguments

• msg:[in] The message to get the password from.

Returns

The password or NULL if an error occurred.

See also

ssh_message_get(), ssh_message_type()

ssh_message_auth_pubkey(msg)

Get the publickey of the authenticated user.

If you need the key for later user you should duplicate it.

Arguments

• msg:[in] The message to get the public key from.

Returns

The public key or NULL.

See also

ssh_key_dup(), ssh_key_cmp(), ssh_message_get(), ssh_message_type()

ssh_message_auth_publickey_state(msg)

Arguments

• msg:[in] The message to get the public key state from.

ssh_message_auth_reply_pk_ok(msg, algo, pubkey)

Upstream documentation.

ssh_message_auth_reply_pk_ok_simple(msg)

Upstream documentation.

ssh_message_auth_set_methods(msg, methods; throw = true)

Auto-generated wrapper around ssh_message_auth_set_methods().

ssh_message_auth_user(msg; throw = true)

Auto-generated wrapper around ssh_message_auth_user(). Original upstream documentation is below.

Get the name of the authenticated user.

Arguments

• msg:[in] The message to get the username from.

Returns

The username or NULL if an error occurred.

See also

ssh_message_get(), ssh_message_type()

ssh_message_global_request_reply_success(msg, bound_port)

Upstream documentation.

ssh_message_reply_default(msg; throw = true)

Auto-generated wrapper around ssh_message_reply_default(). Original upstream documentation is below.

Reply with a standard reject message.

Use this function if you don't know what to respond or if you want to reject a request.

Arguments

• msg:[in] The message to use for the reply.

Returns

0 on success, -1 on error.

See also

ssh_message_get()

ssh_message_service_reply_success(msg)

Upstream documentation.

ssh_message_service_service(msg)

Upstream documentation.

ssh_send_issue_banner(session, banner)

Send the server's issue-banner to client.

Arguments

• session:[in] The server session.
• banner:[in] The server's banner.

Returns

SSH_OK on success, SSH_ERROR on error.

ssh_send_keepalive(session)

Upstream documentation.

ssh_server_init_kex(session)

Initialize the set of key exchange, hostkey, ciphers, MACs, and compression algorithms for the given ssh_session.

The selection of algorithms and keys used are determined by the options that are currently set in the given ssh_session structure. May only be called before the initial key exchange has begun.

Arguments

• session: The session structure to initialize.

Returns

SSH_OK if initialization succeeds.

See also

ssh_handle_key_exchange, ssh_options_set

ssh_set_auth_methods(session, auth_methods)

Set the acceptable authentication methods to be sent to the client.

Supported methods are:

SSH_AUTH_METHOD_PASSWORD SSH_AUTH_METHOD_PUBLICKEY SSH_AUTH_METHOD_HOSTBASED SSH_AUTH_METHOD_INTERACTIVE SSH_AUTH_METHOD_GSSAPI_MIC

Arguments

• session:[in] The server session
• auth_methods:[in] The authentication methods we will support, which can be bitwise-or'd.

ssh_set_message_callback(session, ssh_bind_message_callback, data)

Upstream documentation.

ssh_blocking_flush(session, timeout)

Upstream documentation.

ssh_clean_pubkey_hash(hash)

Upstream documentation.

ssh_connect(session)

Upstream documentation.

ssh_copyright()

Upstream documentation.

ssh_disconnect(session)

Upstream documentation.

ssh_dump_knownhost(session)

Upstream documentation.

ssh_free(session)

Upstream documentation.

ssh_get_cipher_in(session)

Upstream documentation.

ssh_get_cipher_out(session)

Upstream documentation.

ssh_get_clientbanner(session)

Upstream documentation.

ssh_get_disconnect_message(session)

Upstream documentation.

ssh_get_fd(session)

Upstream documentation.

ssh_get_fingerprint_hash(type, hash, len)

Upstream documentation.

ssh_get_hmac_in(session)

Upstream documentation.

ssh_get_hmac_out(session)

Upstream documentation.

ssh_get_issue_banner(session)

Upstream documentation.

ssh_get_kex_algo(session)

Upstream documentation.

ssh_get_openssh_version(session)

Upstream documentation.

ssh_get_poll_flags(session)

Upstream documentation.

ssh_get_pubkey_hash(session, hash)

Upstream documentation.

ssh_get_publickey(session, key)

Upstream documentation.

ssh_get_publickey_hash(key, type, hash, hlen)

Upstream documentation.

ssh_get_server_publickey(session, key)

Upstream documentation.

ssh_get_serverbanner(session)

Upstream documentation.

ssh_get_status(session)

Upstream documentation.

ssh_get_version(session)

Upstream documentation.

ssh_is_blocking(session)

Upstream documentation.

ssh_is_connected(session)

Upstream documentation.

ssh_is_server_known(session)

Upstream documentation.

ssh_known_hosts_parse_line(host, line, entry)

Upstream documentation.

ssh_knownhosts_entry_free(entry)

Upstream documentation.

ssh_new()

Upstream documentation.

ssh_options_copy(src, dest)

Upstream documentation.

ssh_options_get(session, type, value; throw = true)

Auto-generated wrapper around ssh_options_get().

ssh_options_get_port(session, port_target; throw = true)

Auto-generated wrapper around ssh_options_get_port().

ssh_options_getopt(session, argcptr, argv)

Upstream documentation.

ssh_options_parse_config(session, filename)

Upstream documentation.

ssh_options_set(session, type, value; throw = true)

Auto-generated wrapper around ssh_options_set().

ssh_print_hash(type, hash, len)

Upstream documentation.

ssh_request_no_more_sessions(session)

Upstream documentation.

ssh_select(channels, outchannels, maxfd, readfds, timeout)

Upstream documentation.

ssh_send_debug(session, message, always_display)

Upstream documentation.

ssh_send_ignore(session, data)

Upstream documentation.

ssh_session_export_known_hosts_entry(session, pentry_string)

Upstream documentation.

ssh_session_get_known_hosts_entry(session, pentry)

Upstream documentation.

ssh_session_has_known_hosts_entry(session)

Upstream documentation.

ssh_session_is_known_server(session)

Upstream documentation.

ssh_session_set_disconnect_message(session, message)

Upstream documentation.

ssh_session_update_known_hosts(session)

Upstream documentation.

ssh_set_blocking(session, blocking)

Upstream documentation.

ssh_set_counters(session, scounter, rcounter)

Upstream documentation.

ssh_set_fd_except(session)

Upstream documentation.

ssh_set_fd_toread(session)

Upstream documentation.

ssh_set_fd_towrite(session)

Upstream documentation.

ssh_silent_disconnect(session)

Upstream documentation.

ssh_write_knownhost(session)

Upstream documentation.

ssh_string_burn(str)

Upstream documentation.

ssh_string_copy(str)

Upstream documentation.

ssh_string_data(str)

Upstream documentation.

ssh_string_fill(str, data, len)

Upstream documentation.

ssh_string_free(str)

Upstream documentation.

ssh_string_free_char(s)

Upstream documentation.

ssh_string_from_char(what)

Upstream documentation.

ssh_string_get_char(str)

Upstream documentation.

ssh_string_len(str)

Upstream documentation.

ssh_string_new(size)

Upstream documentation.

ssh_string_to_char(str)

Upstream documentation.

ssh_scp_accept_request(scp)

Upstream documentation.

ssh_scp_close(scp)

Upstream documentation.

ssh_scp_deny_request(scp, reason)

Upstream documentation.

ssh_scp_free(scp)

Upstream documentation.

ssh_scp_init(scp)

Upstream documentation.

ssh_scp_leave_directory(scp)

Upstream documentation.

ssh_scp_new(session, mode, location)

Upstream documentation.

ssh_scp_pull_request(scp)

Upstream documentation.

ssh_scp_push_directory(scp, dirname, mode)

Upstream documentation.

ssh_scp_push_file(scp, filename, size, perms)

Upstream documentation.

ssh_scp_push_file64(scp, filename, size, perms)

Upstream documentation.

ssh_scp_read(scp, buffer, size)

Upstream documentation.

ssh_scp_request_get_filename(scp)

Upstream documentation.

ssh_scp_request_get_permissions(scp)

Upstream documentation.

ssh_scp_request_get_size(scp)

Upstream documentation.

ssh_scp_request_get_size64(scp)

Upstream documentation.

ssh_scp_request_get_warning(scp)

Upstream documentation.

ssh_scp_write(scp, buffer, len)

Upstream documentation.

sftp_aio_begin_read(file, len, aio)

Start an asynchronous read from a file using an opened sftp file handle.

Its goal is to avoid the slowdowns related to the request/response pattern of a synchronous read. To do so, you must call 2 functions :

sftp_aio_begin_read() and sftp_aio_wait_read().

• The first step is to call sftp_aio_begin_read(). This function sends a read request to the sftp server, dynamically allocates memory to store information about the sent request and provides the caller an sftp aio handle to that memory.

• The second step is to call sftp_aio_wait_read() and pass it the address of a location storing the sftp aio handle provided by sftp_aio_begin_read().

These two functions do not close the open sftp file handle passed to sftp_aio_begin_read() irrespective of whether they fail or not.

It is the responsibility of the caller to ensure that the open sftp file handle passed to sftp_aio_begin_read() must not be closed before the corresponding call to sftp_aio_wait_read(). After sftp_aio_wait_read() returns, it is caller's decision whether to immediately close the file by calling sftp_close() or to keep it open and perform some more operations on it.

This function caps the length a user is allowed to read from an sftp file, the value of len parameter after capping is returned on success.

The value used for the cap is same as the value of the max_read_length field of the sftp_limits_t returned by sftp_limits().

Arguments

• file: The opened sftp file handle to be read from.
• len: Number of bytes to read.
• aio: Pointer to a location where the sftp aio handle (corresponding to the sent request) should be stored.

Returns

On success, the number of bytes the server is requested to read (value of len parameter after capping). On error, SSH_ERROR with sftp and ssh errors set.

See also

sftp_aio_wait_read(), sftp_aio_free(), sftp_open(), sftp_close(), sftp_get_error(), ssh_get_error()

sftp_aio_begin_write(file, buf, len, aio)

Start an asynchronous write to a file using an opened sftp file handle.

Its goal is to avoid the slowdowns related to the request/response pattern of a synchronous write. To do so, you must call 2 functions :

sftp_aio_begin_write() and sftp_aio_wait_write().

• The first step is to call sftp_aio_begin_write(). This function sends a write request to the sftp server, dynamically allocates memory to store information about the sent request and provides the caller an sftp aio handle to that memory.

• The second step is to call sftp_aio_wait_write() and pass it the address of a location storing the sftp aio handle provided by sftp_aio_begin_write().

These two functions do not close the open sftp file handle passed to sftp_aio_begin_write() irrespective of whether they fail or not.

It is the responsibility of the caller to ensure that the open sftp file handle passed to sftp_aio_begin_write() must not be closed before the corresponding call to sftp_aio_wait_write(). After sftp_aio_wait_write() returns, it is caller's decision whether to immediately close the file by calling sftp_close() or to keep it open and perform some more operations on it.

This function caps the length a user is allowed to write to an sftp file, the value of len parameter after capping is returned on success.

The value used for the cap is same as the value of the max_write_length field of the sftp_limits_t returned by sftp_limits().

Arguments

• file: The opened sftp file handle to write to.
• buf: Pointer to the buffer containing data to write.
• len: Number of bytes to write.
• aio: Pointer to a location where the sftp aio handle (corresponding to the sent request) should be stored.

Returns

On success, the number of bytes the server is requested to write (value of len parameter after capping). On error, SSH_ERROR with sftp and ssh errors set.

See also

sftp_aio_wait_write(), sftp_aio_free(), sftp_open(), sftp_close(), sftp_get_error(), ssh_get_error()

sftp_aio_free(aio)

Deallocate memory corresponding to a sftp aio handle.

This function deallocates memory corresponding to the aio handle returned by the sftp_aio_begin_*() functions. Users can use this function to free memory corresponding to an aio handle for an outstanding async i/o request on encountering some error.

Arguments

• aio: sftp aio handle corresponding to which memory has to be deallocated.

See also

sftp_aio_begin_read(), sftp_aio_wait_read(), sftp_aio_begin_write(), sftp_aio_wait_write()

sftp_aio_wait_read(aio::Ptr{sftp_aio}, buf::Ptr{Cvoid}, buf_size::Csize_t)

Auto-generated wrapper around sftp_aio_wait_read(). Original upstream documentation is below.

Wait for an asynchronous read to complete and store the read data in the supplied buffer.

A pointer to an sftp aio handle should be passed while calling this function. Except when the return value is SSH_AGAIN, this function releases the memory corresponding to the supplied aio handle and assigns NULL to that aio handle using the passed pointer to that handle.

If the file is opened in non-blocking mode and the request hasn't been executed yet, this function returns SSH_AGAIN and must be called again using the same sftp aio handle.

Arguments

• aio: Pointer to the sftp aio handle returned by sftp_aio_begin_read().
• buf: Pointer to the buffer in which read data will be stored.
• buf_size: Size of the buffer in bytes. It should be bigger or equal to the length parameter of the sftp_aio_begin_read() call.

Returns

Number of bytes read, 0 on EOF, SSH_ERROR if an error occurred, SSH_AGAIN if the file is opened in nonblocking mode and the request hasn't been executed yet.

See also

sftp_aio_begin_read(), sftp_aio_free()

sftp_aio_wait_write(aio::Ptr{sftp_aio})

Auto-generated wrapper around sftp_aio_wait_write(). Original upstream documentation is below.

Wait for an asynchronous write to complete.

A pointer to an sftp aio handle should be passed while calling this function. Except when the return value is SSH_AGAIN, this function releases the memory corresponding to the supplied aio handle and assigns NULL to that aio handle using the passed pointer to that handle.

If the file is opened in non-blocking mode and the request hasn't been executed yet, this function returns SSH_AGAIN and must be called again using the same sftp aio handle.

Arguments

• aio: Pointer to the sftp aio handle returned by sftp_aio_begin_write().

Returns

Number of bytes written on success, SSH_ERROR if an error occurred, SSH_AGAIN if the file is opened in nonblocking mode and the request hasn't been executed yet.

See also

sftp_aio_begin_write(), sftp_aio_free()

sftp_async_read(file, data, len, id)

Wait for an asynchronous read to complete and save the data.

Arguments

• file: The opened sftp file handle to be read from.
• data: Pointer to buffer to receive read data.
• len: Size of the buffer in bytes. It should be bigger or equal to the length parameter of the sftp_async_read_begin() call.
• id: The identifier returned by the sftp_async_read_begin() function.

Returns

Number of bytes read, 0 on EOF, SSH_ERROR if an error occurred, SSH_AGAIN if the file is opened in nonblocking mode and the request hasn't been executed yet.

See also

sftp_async_read_begin()

sftp_async_read_begin(file, len)

Start an asynchronous read from a file using an opened sftp file handle.

Its goal is to avoid the slowdowns related to the request/response pattern of a synchronous read. To do so, you must call 2 functions:

sftp_async_read_begin() and sftp_async_read().

The first step is to call sftp_async_read_begin(). This function returns a request identifier. The second step is to call sftp_async_read() using the returned identifier.

Arguments

• file: The opened sftp file handle to be read from.
• len: Size to read in bytes.

Returns

An identifier corresponding to the sent request, < 0 on error.

See also

sftp_async_read(), sftp_open()

sftp_attributes_free(file)

Free a sftp attribute structure.

Arguments

• file: The sftp attribute structure to free.

sftp_canonicalize_path(sftp, path)

Canonicalize a sftp path.

Arguments

• sftp: The sftp session handle.
• path: The path to be canonicalized.

Returns

A pointer to the newly allocated canonicalized path, NULL on error. The caller needs to free the memory using ssh_string_free_char().

sftp_chmod(sftp, file, mode)

Change permissions of a file

Arguments

• sftp: The sftp session handle.
• file: The file which owner and group should be changed.
• mode: Specifies the permissions to use. It is modified by the process's umask in the usual way: The permissions of the created file are (mode & ~umask)

Returns

0 on success, < 0 on error with ssh and sftp error set.

See also

sftp_get_error()

sftp_chown(sftp, file, owner, group)

Change the file owner and group

Arguments

• sftp: The sftp session handle.
• file: The file which owner and group should be changed.
• owner: The new owner which should be set.
• group: The new group which should be set.

Returns

0 on success, < 0 on error with ssh and sftp error set.

See also

sftp_get_error()

sftp_close(file::sftp_file)

Auto-generated wrapper around sftp_close(). Original upstream documentation is below.

Close an open file handle.

Arguments

• file: The open sftp file handle to close.

Returns

Returns SSH_NO_ERROR or SSH_ERROR if an error occurred.

See also

sftp_open()

sftp_closedir(dir::sftp_dir)

Auto-generated wrapper around sftp_closedir(). Original upstream documentation is below.

Close a directory handle opened by sftp_opendir().

Arguments

• dir: The sftp directory handle to close.

Returns

Returns SSH_NO_ERROR or SSH_ERROR if an error occurred.

sftp_dir_eof(dir)

Tell if the directory has reached EOF (End Of File).

Arguments

• dir: The sftp directory handle.

Returns

1 if the directory is EOF, 0 if not.

See also

sftp_readdir()

sftp_expand_path(sftp, path)

Canonicalize path using expand-path.com extension

Arguments

• sftp: The sftp session handle.
• path: The path to be canonicalized.

Returns

A pointer to the newly allocated canonicalized path, NULL on error. The caller needs to free the memory using ssh_string_free_char().

sftp_extension_supported(sftp, name, data)

Check if the given extension is supported.

Example:

 sftp_extension_supported(sftp, "statvfs@openssh.com", "2");

Arguments

• sftp: The sftp session to use.
• name: The name of the extension.
• data: The data of the extension.

Returns

1 if supported, 0 if not.

sftp_extensions_get_count(sftp)

Get the count of extensions provided by the server.

Arguments

• sftp: The sftp session to use.

Returns

The count of extensions provided by the server, 0 on error or not available.

sftp_extensions_get_data(sftp, indexn; throw = true)

Auto-generated wrapper around sftp_extensions_get_data(). Original upstream documentation is below.

Get the data of the extension provided by the server.

This is normally the version number of the extension.

Arguments

• sftp: The sftp session to use.
• indexn: The index number of the extension data you want.

Returns

The data of the extension.

sftp_extensions_get_name(sftp, indexn; throw = true)

Auto-generated wrapper around sftp_extensions_get_name(). Original upstream documentation is below.

Get the name of the extension provided by the server.

Arguments

• sftp: The sftp session to use.
• indexn: The index number of the extension name you want.

Returns

The name of the extension.

sftp_file_set_blocking(handle)

Make the sftp communication for this file handle blocking.

Arguments

• handle:[in] The file handle to set blocking.

sftp_file_set_nonblocking(handle)

Make the sftp communication for this file handle non blocking.

Arguments

• handle:[in] The file handle to set non blocking.

sftp_free(sftp)

Close and deallocate a sftp session.

Arguments

• sftp: The sftp session handle to free.

sftp_fstat(file)

Get information about a file or directory from a file handle.

Arguments

• file: The sftp file handle to get the stat information.

Returns

The sftp attributes structure of the file or directory, NULL on error with ssh and sftp error set.

See also

sftp_get_error()

sftp_fstatvfs(file)

Get information about a mounted file system.

Arguments

• file: An opened file.

Returns

A statvfs structure or NULL on error.

See also

sftp_get_error()

sftp_fsync(file)

Synchronize a file's in-core state with storage device

This calls the "fsync@openssh.com" extension. You should check if the extensions is supported using:

 int supported = sftp_extension_supported(sftp, "fsync@openssh.com", "1");

Arguments

• file: The opened sftp file handle to sync

Returns

0 on success, < 0 on error with ssh and sftp error set.

sftp_get_error(sftp)

Get the last sftp error.

Use this function to get the latest error set by a posix like sftp function.

Arguments

• sftp: The sftp session where the error is saved.

Returns

The saved error (see server responses), < 0 if an error in the function occurred.

See also

Server responses

sftp_hardlink(sftp, oldpath, newpath)

Create a hard link.

Arguments

• sftp: The sftp session handle.
• oldpath: Specifies the pathname of the file for which the new hardlink is to be created.
• newpath: Specifies the pathname of the hardlink to be created.

Returns

0 on success, -1 on error with ssh and sftp error set.

See also

sftp_get_error()

sftp_home_directory(sftp::sftp_session, username::Ptr{Cchar})

Auto-generated wrapper around sftp_home_directory(). Original upstream documentation is below.

Get the specified user's home directory

This calls the "home-directory" extension. You should check if the extension is supported using:

 int supported  = sftp_extension_supported(sftp, "home-directory", "1");

Arguments

• sftp: The sftp session handle.
• username: username of the user whose home directory is requested.

Returns

On success, a newly allocated string containing the absolute real-path of the home directory of the user. NULL on error. The caller needs to free the memory using ssh_string_free_char().

sftp_init(sftp::sftp_session)

Auto-generated wrapper around sftp_init(). Original upstream documentation is below.

Initialize the sftp protocol with the server.

This function involves the SFTP protocol initialization (as described in the SFTP specification), including the version and extensions negotiation.

Arguments

• sftp: The sftp session to initialize.

Returns

0 on success, < 0 on error with ssh error set.

See also

sftp_new()

sftp_limits(sftp)

Get information about the various limits the server might impose.

Arguments

• sftp: The sftp session handle.

Returns

A limits structure or NULL on error.

See also

sftp_get_error()

sftp_limits_free(limits)

Free the memory of an allocated limits.

Arguments

• limits: The limits to free.

sftp_lsetstat(sftp, file, attr)

This request is like setstat (excluding mode and size) but sets file attributes on symlinks themselves.

Note, that this function can only set time values using 32 bit values due to the restrictions in the SFTP protocol version 3 implemented by libssh. The support for 64 bit time values was introduced in SFTP version 5, which is not implemented by libssh nor any major SFTP servers.

Arguments

• sftp: The sftp session handle.
• file: The symbolic link which attributes should be changed.
• attr: The file attributes structure with the attributes set which should be changed.

Returns

0 on success, < 0 on error with ssh and sftp error set.

See also

sftp_get_error()

sftp_lstat(session, path)

Get information about a file or directory.

Identical to sftp_stat, but if the file or directory is a symbolic link, then the link itself is stated, not the file that it refers to.

Arguments

• session: The sftp session handle.
• path: The path to the file or directory to obtain the information.

Returns

The sftp attributes structure of the file or directory, NULL on error with ssh and sftp error set.

See also

sftp_get_error()

sftp_mkdir(sftp::sftp_session, directory::Ptr{Cchar}, mode::mode_t)

Auto-generated wrapper around sftp_mkdir(). Original upstream documentation is below.

Create a directory.

Arguments

• sftp: The sftp session handle.
• directory: The directory to create.
• mode: Specifies the permissions to use. It is modified by the process's umask in the usual way: The permissions of the created file are (mode & ~umask)

Returns

0 on success, < 0 on error with ssh and sftp error set.

See also

sftp_get_error()

sftp_new(session::ssh_session)

Auto-generated wrapper around sftp_new(). Original upstream documentation is below.

Creates a new sftp session.

This function creates a new sftp session and allocates a new sftp channel with the server inside of the provided ssh session. This function call is usually followed by the sftp_init(), which initializes SFTP protocol itself.

Arguments

• session: The ssh session to use.

Returns

A new sftp session or NULL on error.

See also

sftp_free(), sftp_init()

sftp_new_channel(session, channel)

Start a new sftp session with an existing channel.

Arguments

• session: The ssh session to use.
• channel: An open session channel with subsystem already allocated

Returns

A new sftp session or NULL on error.

See also

sftp_free()

sftp_open(session::sftp_session, file::Ptr{Cchar}, accesstype::Cint, mode::mode_t)

Auto-generated wrapper around sftp_open(). Original upstream documentation is below.

Open a file on the server.

Arguments

• session: The sftp session handle.
• file: The file to be opened.
• accesstype: Is one of O_RDONLY, O_WRONLY or O_RDWR which request opening the file read-only,write-only or read/write. Acesss may also be bitwise-or'd with one or more of the following: O_CREAT - If the file does not exist it will be created. O_EXCL - When used with O_CREAT, if the file already exists it is an error and the open will fail. O_TRUNC - If the file already exists it will be truncated.
• mode: Mode specifies the permissions to use if a new file is created. It is modified by the process's umask in the usual way: The permissions of the created file are (mode & ~umask)

Returns

A sftp file handle, NULL on error with ssh and sftp error set.

See also

sftp_get_error()

sftp_opendir(session::sftp_session, path::Ptr{Cchar})

Auto-generated wrapper around sftp_opendir(). Original upstream documentation is below.

Open a directory used to obtain directory entries.

Arguments

• session: The sftp session handle to open the directory.
• path: The path of the directory to open.

Returns

A sftp directory handle or NULL on error with ssh and sftp error set.

See also

sftp_readdir, sftp_closedir

sftp_read(file, buf, count)

Read from a file using an opened sftp file handle.

This function caps the length a user is allowed to read from an sftp file.

The value used for the cap is same as the value of the max_read_length field of the sftp_limits_t returned by sftp_limits().

Arguments

• file: The opened sftp file handle to be read from.
• buf: Pointer to buffer to receive read data.
• count: Size of the buffer in bytes.

Returns

Number of bytes read, < 0 on error with ssh and sftp error set.

See also

sftp_get_error()

sftp_readdir(session::sftp_session, dir::sftp_dir)

Auto-generated wrapper around sftp_readdir(). Original upstream documentation is below.

Get a single file attributes structure of a directory.

Arguments

• session: The sftp session handle to read the directory entry.
• dir: The opened sftp directory handle to read from.

Returns

A file attribute structure or NULL at the end of the directory.

See also

sftp_opendir(), sftp_attribute_free(), sftp_closedir()

sftp_readlink(sftp, path)

Read the value of a symbolic link.

Arguments

• sftp: The sftp session handle.
• path: Specifies the path name of the symlink to be read.

Returns

The target of the link, NULL on error. The caller needs to free the memory using ssh_string_free_char().

See also

sftp_get_error()

sftp_rename(sftp::sftp_session, original::Ptr{Cchar}, newname::Ptr{Cchar})

Auto-generated wrapper around sftp_rename(). Original upstream documentation is below.

Rename or move a file or directory.

Arguments

• sftp: The sftp session handle.
• original: The original url (source url) of file or directory to be moved.
• newname: The new url (destination url) of the file or directory after the move.

Returns

0 on success, < 0 on error with ssh and sftp error set.

See also

sftp_get_error()

sftp_rewind(file)

Rewinds the position of the file pointer to the beginning of the file.

Arguments

• file: Open sftp file handle.

sftp_rmdir(sftp::sftp_session, directory::Ptr{Cchar})

Auto-generated wrapper around sftp_rmdir(). Original upstream documentation is below.

Remove a directory.

Arguments

• sftp: The sftp session handle.
• directory: The directory to remove.

Returns

0 on success, < 0 on error with ssh and sftp error set.

See also

sftp_get_error()

sftp_seek(file, new_offset)

Seek to a specific location in a file.

Arguments

• file: Open sftp file handle to seek in.
• new_offset: Offset in bytes to seek.

Returns

0 on success, < 0 on error.

sftp_seek64(file, new_offset)

Seek to a specific location in a file. This is the 64bit version.

Arguments

• file: Open sftp file handle to seek in.
• new_offset: Offset in bytes to seek.

Returns

0 on success, < 0 on error.

sftp_server_free(sftp)

Close and deallocate a sftp server session.

Arguments

• sftp: The sftp session handle to free.

sftp_server_init(sftp)

Initialize the sftp server.

Arguments

• sftp: The sftp session to init.

Returns

0 on success, < 0 on error.

sftp_server_new(session, chan)

Create a new sftp server session.

Arguments

• session: The ssh session to use.
• chan: The ssh channel to use.

Returns

A new sftp server session.

sftp_server_version(sftp)

Get the version of the SFTP protocol supported by the server

Arguments

• sftp: The sftp session handle.

Returns

The server version.

sftp_setstat(sftp, file, attr)

Set file attributes on a file, directory or symbolic link.

Note, that this function can only set time values using 32 bit values due to the restrictions in the SFTP protocol version 3 implemented by libssh. The support for 64 bit time values was introduced in SFTP version 5, which is not implemented by libssh nor any major SFTP servers.

Arguments

• sftp: The sftp session handle.
• file: The file which attributes should be changed.
• attr: The file attributes structure with the attributes set which should be changed.

Returns

0 on success, < 0 on error with ssh and sftp error set.

See also

sftp_get_error()

sftp_stat(session::sftp_session, path::Ptr{Cchar})

Auto-generated wrapper around sftp_stat(). Original upstream documentation is below.

Get information about a file or directory.

Arguments

• session: The sftp session handle.
• path: The path to the file or directory to obtain the information.

Returns

The sftp attributes structure of the file or directory, NULL on error with ssh and sftp error set.

See also

sftp_get_error()

sftp_statvfs(sftp, path)

Get information about a mounted file system.

Arguments

• sftp: The sftp session handle.
• path: The pathname of any file within the mounted file system.

Returns

A statvfs structure or NULL on error.

See also

sftp_get_error()

sftp_statvfs_free(statvfs_o)

Free the memory of an allocated statvfs.

Arguments

• statvfs_o: The statvfs to free.

sftp_symlink(sftp, target, dest)

Create a symbolic link.

Arguments

• sftp: The sftp session handle.
• target: Specifies the target of the symlink.
• dest: Specifies the path name of the symlink to be created.

Returns

0 on success, < 0 on error with ssh and sftp error set.

See also

sftp_get_error()

sftp_tell(file)

Report current byte position in file.

Arguments

• file: Open sftp file handle.

Returns

The offset of the current byte relative to the beginning of the file associated with the file descriptor. < 0 on error.

sftp_tell64(file)

Report current byte position in file.

Arguments

• file: Open sftp file handle.

Returns

The offset of the current byte relative to the beginning of the file associated with the file descriptor.

sftp_unlink(sftp::sftp_session, file::Ptr{Cchar})

Auto-generated wrapper around sftp_unlink(). Original upstream documentation is below.

Unlink (delete) a file.

Arguments

• sftp: The sftp session handle.
• file: The file to unlink/delete.

Returns

0 on success, < 0 on error with ssh and sftp error set.

See also

sftp_get_error()

sftp_utimes(sftp, file, times)

Change the last modification and access time of a file.

Arguments

• sftp: The sftp session handle.
• file: The file which owner and group should be changed.
• times: A timeval structure which contains the desired access and modification time.

Returns

0 on success, < 0 on error with ssh and sftp error set.

See also

sftp_get_error()

sftp_write(file, buf, count)

Write to a file using an opened sftp file handle.

This function caps the length a user is allowed to write to an sftp file.

The value used for the cap is same as the value of the max_write_length field of the sftp_limits_t returned by sftp_limits().

Arguments

• file: Open sftp file handle to write to.
• buf: Pointer to buffer to write data.
• count: Size of buffer in bytes.

Returns

Number of bytes written, < 0 on error with ssh and sftp error set.

See also

sftp_open(), sftp_read(), sftp_close()

ssh_threads_get_default()

Returns a pointer to the appropriate callbacks structure for the environment, to be used with ssh_threads_set_callbacks.

Returns

A pointer to a ssh_threads_callbacks_struct to be used with ssh_threads_set_callbacks.

See also

ssh_threads_set_callbacks

ssh_threads_get_noop()

Get the noop threads callbacks structure

This can be used with ssh_threads_set_callbacks. These callbacks do nothing and are being used by default.

Returns

Always returns a valid pointer to the noop callbacks structure.

See also

ssh_threads_set_callbacks

ssh_threads_get_pthread()

Returns a pointer on the pthread threads callbacks, to be used with ssh_threads_set_callbacks.

See also

ssh_threads_set_callbacks

ssh_threads_set_callbacks(cb)

Set the thread callbacks structure.

This is necessary if your program is using libssh in a multithreaded fashion. This function must be called first, outside of any threading context (in your main() function for instance), before you call ssh_init().

Arguments

• cb:[in] A pointer to a ssh_threads_callbacks_struct structure, which contains the different callbacks to be set.

Returns

Always returns SSH_OK.

See also

ssh_threads_callbacks_struct, SSH_THREADS_PTHREAD

ssh_message_auth_interactive_request(msg, name, instruction, num_prompts, prompts, echo)

Initiate keyboard-interactive authentication from a server.

ssh_message_auth_reply_success(msg, partial; throw = true)

Auto-generated wrapper around ssh_message_auth_reply_success().

sftp_limits_struct

SFTP limits structure.

Pointer to a sftp_limits_struct

sftp_statvfs_struct

SFTP statvfs structure.

SSH authentication callback for password and publickey auth.

Arguments

• prompt: Prompt to be displayed.
• buf: Buffer to save the password. You should null-terminate it.
• len: Length of the buffer.
• echo: Enable or disable the echo of what you type.
• verify: Should the password be verified?
• userdata: Userdata to be passed to the callback function. Useful for GUI applications.

Returns

0 on success, < 0 on error.

SSH authentication callback. Tries to authenticates user with the "gssapi-with-mic" method

Arguments

• session: Current session handler
• user: Username of the user (can be spoofed)
• principal: Authenticated principal of the user, including realm.
• userdata: Userdata to be passed to the callback function.

Returns

SSH_AUTH_DENIED Authentication failed.

SSH authentication callback. Tries to authenticates user with the "none" method which is anonymous or passwordless.

Arguments

• session: Current session handler
• user: User that wants to authenticate
• userdata: Userdata to be passed to the callback function.

Returns

SSH_AUTH_DENIED Authentication failed.

SSH authentication callback.

Arguments

• session: Current session handler
• user: User that wants to authenticate
• password: Password used for authentication
• userdata: Userdata to be passed to the callback function.

Returns

SSH_AUTH_DENIED Authentication failed.

SSH authentication callback.

Arguments

• session: Current session handler
• user: User that wants to authenticate
• pubkey: public key used for authentication
• signature_state: SSH_PUBLICKEY_STATE_NONE if the key is not signed (simple public key probe), SSH_PUBLICKEY_STATE_VALID if the signature is valid. Others values should be replied with a SSH_AUTH_DENIED.
• userdata: Userdata to be passed to the callback function.

Returns

SSH_AUTH_DENIED Authentication failed.

Server struct

Callbacks for a ssh_bind (upstream documentation).

ssh_bind_callbacks_struct

These are the callbacks exported by the ssh_bind structure.

They are called by the server module when events appear on the network.

Incoming connection callback. This callback is called when a ssh_bind has a new incoming connection.

Arguments

• sshbind: Current sshbind session handler
• userdata: Userdata to be passed to the callback function.

 @brief callback for data received messages.
 @param data data retrieved from the socket or stream
 @param len number of bytes available from this stream
 @param user user-supplied pointer sent along with all callback messages
 @returns number of bytes processed by the callee. The remaining bytes will
 be sent in the next callback message, when more data is available.
 

 @brief callback to process simple codes
 @param code value to transmit
 @param user Userdata to pass in callback
 

ssh_callbacks_struct

The structure to replace libssh functions with appropriate callbacks.

SSH auth-agent-request from the client. This request is sent by a client when agent forwarding is available. Server is free to ignore this callback, no answer is expected.

Arguments

• session: the session
• channel: the channel
• userdata: Userdata to be passed to the callback function.

SSH channel close callback. Called when a channel is closed by remote peer

Arguments

• session: Current session handler
• channel: the actual channel
• userdata: Userdata to be passed to the callback function.

SSH channel data callback. Called when data is available on a channel

Arguments

• session: Current session handler
• channel: the actual channel
• data: the data that has been read on the channel
• len: the length of the data
• is_stderr: is 0 for stdout or 1 for stderr
• userdata: Userdata to be passed to the callback function.

Returns

number of bytes processed by the callee. The remaining bytes will be sent in the next callback message, when more data is available.

SSH channel environment request from a client.

Arguments

• session: the session
• channel: the channel
• env_name: name of the environment value to be set
• env_value: value of the environment value to be set
• userdata: Userdata to be passed to the callback function.

Returns

1 if the request is denied

SSH channel eof callback. Called when a channel receives EOF

Arguments

• session: Current session handler
• channel: the actual channel
• userdata: Userdata to be passed to the callback function.

SSH channel Exec request from a client.

Arguments

• session: the session
• channel: the channel
• command: the shell command to be executed
• userdata: Userdata to be passed to the callback function.

Returns

1 if the request is denied

SSH channel exit signal callback. Called when a channel has received an exit signal

Arguments

• session: Current session handler
• channel: the actual channel
• signal: the signal name (without the SIG prefix)
• core: a boolean telling whether a core has been dumped or not
• errmsg: the description of the exception
• lang: the language of the description (format: RFC 3066)
• userdata: Userdata to be passed to the callback function.

SSH channel exit status callback. Called when a channel has received an exit status

Arguments

• session: Current session handler
• channel: the actual channel
• exit_status: Exit status of the ran command
• userdata: Userdata to be passed to the callback function.

Handles an SSH new channel open "auth-agent" request. This happens when the server sends back an "auth-agent" connection attempt. This is a client-side API

Arguments

• session: current session handler
• userdata: Userdata to be passed to the callback function.

Returns

NULL if the request should not be allowed

Handles an SSH new channel open "forwarded-tcpip" request. This happens when the server forwards an incoming TCP connection on a port it was previously requested to listen on. This is a client-side API

Arguments

• session: current session handler
• destination_address: the address that the TCP connection connected to
• destination_port: the port that the TCP connection connected to
• originator_address: the originator IP address
• originator_port: the originator port
• userdata: Userdata to be passed to the callback function.

Returns

NULL if the request should not be allowed

Handles an SSH new channel open session request

Arguments

• session: current session handler
• userdata: Userdata to be passed to the callback function.

Returns

NULL if the request should not be allowed

Handles an SSH new channel open X11 request. This happens when the server sends back an X11 connection attempt. This is a client-side API

Arguments

• session: current session handler
• userdata: Userdata to be passed to the callback function.
• originator_address: IP address of the machine who sent the request
• originator_port: port number of the machine who sent the request

Returns

NULL if the request should not be allowed

SSH channel open callback. Called when a channel open succeeds or fails.

Arguments

• session: Current session handler
• channel: the actual channel
• is_success: is 1 when the open succeeds, and 0 otherwise.
• userdata: Userdata to be passed to the callback function.

SSH channel PTY request from a client.

Arguments

• session: the session
• channel: the channel
• term: The type of terminal emulation
• width: width of the terminal, in characters
• height: height of the terminal, in characters
• pxwidth: width of the terminal, in pixels
• pwheight: height of the terminal, in pixels
• userdata: Userdata to be passed to the callback function.

Returns

-1 if the request is denied

SSH channel PTY windows change (terminal size) from a client.

Arguments

• session: the session
• channel: the channel
• width: width of the terminal, in characters
• height: height of the terminal, in characters
• pxwidth: width of the terminal, in pixels
• pwheight: height of the terminal, in pixels
• userdata: Userdata to be passed to the callback function.

Returns

-1 if the request is denied

SSH channel request response callback. Called when a response to the pending request is received.

Arguments

• session: Current session handler
• channel: the actual channel
• userdata: Userdata to be passed to the callback function.

SSH channel Shell request from a client.

Arguments

• session: the session
• channel: the channel
• userdata: Userdata to be passed to the callback function.

Returns

1 if the request is denied

SSH channel signal callback. Called when a channel has received a signal

Arguments

• session: Current session handler
• channel: the actual channel
• signal: the signal name (without the SIG prefix)
• userdata: Userdata to be passed to the callback function.

SSH channel subsystem request from a client.

Arguments

• session: the session
• channel: the channel
• subsystem: the subsystem required
• userdata: Userdata to be passed to the callback function.

Returns

1 if the request is denied

SSH channel write will not block (flow control).

Arguments

• session: the session
• channel: the channel
• bytes:[in] size of the remote window in bytes. Writing as much data will not block.
• userdata:[in] Userdata to be passed to the callback function.

Returns

0 default return value (other return codes may be added in future).

SSH X11 request from the client. This request is sent by a client when X11 forwarding is requested(and available). Server is free to ignore this callback, no answer is expected.

Arguments

• session: the session
• channel: the channel
• single_connection: If true, only one channel should be forwarded
• auth_protocol: The X11 authentication method to be used
• auth_cookie: Authentication cookie encoded hexadecimal
• screen_number: Screen number
• userdata: Userdata to be passed to the callback function.

ssh_control_master_options_e

@}

ssh_file_format_e

@}

SSH global request callback. All global request will go through this callback.

Arguments

• session: Current session handler
• message: the actual message
• userdata: Userdata to be passed to the callback function.

SSH proxyjump user authentication callback. Authenticate the user.

Arguments

• session: Jump session handler
• userdata: Userdata to be passed to the callback function.

Returns

0 on success, < 0 on error.

SSH proxyjump before connection callback. Called before calling ssh_connect()

Arguments

• session: Jump session handler
• userdata: Userdata to be passed to the callback function.

Returns

0 on success, < 0 on error.

SSH proxyjump verify knownhost callback. Verify the host. If not specified default function will be used.

Arguments

• session: Jump session handler
• userdata: Userdata to be passed to the callback function.

Returns

0 on success, < 0 on error.

SSH log callback. All logging messages will go through this callback

Arguments

• session: Current session handler
• priority: Priority of the log, the smaller being the more important
• message: the actual message
• userdata: Userdata to be passed to the callback function.

SSH log callback.

All logging messages will go through this callback.

Arguments

• priority: Priority of the log, the smaller being the more important.
• function: The function name calling the logging functions.
• buffer: The actual message
• userdata: Userdata to be passed to the callback function.

Prototype for a packet callback, to be called when a new packet arrives

Arguments

• session: The current session of the packet
• type: packet type (see ssh2.h)
• packet: buffer containing the packet, excluding size, type and padding fields
• user: user argument to the callback and are called each time a packet shows up

Returns

SSH_PACKET_NOT_USED Packet was not used or understood, processing must continue

ssh_server_callbacks_struct

This structure can be used to implement a libssh server, with appropriate callbacks.

Handles an SSH service request

Arguments

• session: current session handler
• service: name of the service (e.g. "ssh-userauth") requested
• userdata: Userdata to be passed to the callback function.

Returns

-1 if the request should not be allowed

Session struct (upstream documentation).

ssh_socket_callbacks_struct

These are the callbacks exported by the socket structure They are called by the socket module when a socket event appears

SSH Connection status callback.

Arguments

• session: Current session handler
• status: Percentage of connection status, going from 0.0 to 1.0 once connection is done.
• userdata: Userdata to be passed to the callback function.

libssh_threads

@{

ssh_threads_callbacks_struct

Threads callbacks. See ssh_threads_set_callbacks