mirror of
https://git.libssh.org/projects/libssh.git
synced 2025-11-30 13:01:23 +03:00
Adapt comments in options to give parameters types
This commit is contained in:
Aris Adamantiadis
262
src/options.c
262
src/options.c
@@ -170,167 +170,167 @@ int ssh_options_set_algo(ssh_session session, int algo,
|
|||||||
/**
|
/**
|
||||||
* @brief This function can set all possible ssh options.
|
* @brief This function can set all possible ssh options.
|
||||||
*
|
*
|
||||||
* @param session An allocated ssh option structure.
|
* @param session An allocated SSH session structure.
|
||||||
*
|
*
|
||||||
* @param type The option type to set. This could be one of the
|
* @param type The option type to set. This could be one of the
|
||||||
* following:
|
* following:
|
||||||
*
|
*
|
||||||
* - SSH_OPTIONS_HOST:
|
* - SSH_OPTIONS_HOST:
|
||||||
* The hostname or ip address to connect to (string).
|
* The hostname or ip address to connect to (const char *).
|
||||||
*
|
*
|
||||||
* - SSH_OPTIONS_PORT:
|
* - SSH_OPTIONS_PORT:
|
||||||
* The port to connect to (integer).
|
* The port to connect to (unsigned int).
|
||||||
*
|
*
|
||||||
* - SSH_OPTIONS_PORT_STR:
|
* - SSH_OPTIONS_PORT_STR:
|
||||||
* The port to connect to (string).
|
* The port to connect to (const char *).
|
||||||
*
|
*
|
||||||
* - SSH_OPTIONS_FD:
|
* - SSH_OPTIONS_FD:
|
||||||
* The file descriptor to use (socket_t).\n
|
* The file descriptor to use (socket_t).\n
|
||||||
* \n
|
* \n
|
||||||
* If you wish to open the socket yourself for a reason
|
* If you wish to open the socket yourself for a reason
|
||||||
* or another, set the file descriptor. Don't forget to
|
* or another, set the file descriptor. Don't forget to
|
||||||
* set the hostname as the hostname is used as a key in
|
* set the hostname as the hostname is used as a key in
|
||||||
* the known_host mechanism.
|
* the known_host mechanism.
|
||||||
*
|
*
|
||||||
* - SSH_OPTIONS_BINDADDR:
|
* - SSH_OPTIONS_BINDADDR:
|
||||||
* The address to bind the client to (string).
|
* The address to bind the client to (const char *).
|
||||||
*
|
*
|
||||||
* - SSH_OPTIONS_USER:
|
* - SSH_OPTIONS_USER:
|
||||||
* The username for authentication (string).\n
|
* The username for authentication (const char *).\n
|
||||||
* \n
|
* \n
|
||||||
* If the value is NULL, the username is set to the
|
* If the value is NULL, the username is set to the
|
||||||
* default username.
|
* default username.
|
||||||
*
|
*
|
||||||
* - SSH_OPTIONS_SSH_DIR:
|
* - SSH_OPTIONS_SSH_DIR:
|
||||||
* Set the ssh directory (format string).\n
|
* Set the ssh directory (const char *,format string).\n
|
||||||
* \n
|
* \n
|
||||||
* If the value is NULL, the directory is set to the
|
* If the value is NULL, the directory is set to the
|
||||||
* default ssh directory.\n
|
* default ssh directory.\n
|
||||||
* \n
|
* \n
|
||||||
* The ssh directory is used for files like known_hosts
|
* The ssh directory is used for files like known_hosts
|
||||||
* and identity (private and public key). It may include
|
* and identity (private and public key). It may include
|
||||||
* "%s" which will be replaced by the user home
|
* "%s" which will be replaced by the user home
|
||||||
* directory.
|
* directory.
|
||||||
*
|
*
|
||||||
* - SSH_OPTIONS_KNOWNHOSTS:
|
* - SSH_OPTIONS_KNOWNHOSTS:
|
||||||
* Set the known hosts file name (format string).\n
|
* Set the known hosts file name (const char *,format string).\n
|
||||||
* \n
|
* \n
|
||||||
* If the value is NULL, the directory is set to the
|
* If the value is NULL, the directory is set to the
|
||||||
* default known hosts file, normally
|
* default known hosts file, normally
|
||||||
* ~/.ssh/known_hosts.\n
|
* ~/.ssh/known_hosts.\n
|
||||||
* \n
|
* \n
|
||||||
* The known hosts file is used to certify remote hosts
|
* The known hosts file is used to certify remote hosts
|
||||||
* are genuine. It may include "%s" which will be
|
* are genuine. It may include "%s" which will be
|
||||||
* replaced by the user home directory.
|
* replaced by the user home directory.
|
||||||
*
|
*
|
||||||
* - SSH_OPTIONS_IDENTITY:
|
* - SSH_OPTIONS_IDENTITY:
|
||||||
* Set the identity file name (format string).\n
|
* Set the identity file name (const char *,format string).\n
|
||||||
* \n
|
* \n
|
||||||
* By default identity, id_dsa and id_rsa are checked.\n
|
* By default identity, id_dsa and id_rsa are checked.\n
|
||||||
* \n
|
* \n
|
||||||
* The identity file used authenticate with public key.
|
* The identity file used authenticate with public key.
|
||||||
* It may include "%s" which will be replaced by the
|
* It may include "%s" which will be replaced by the
|
||||||
* user home directory.
|
* user home directory.
|
||||||
*
|
*
|
||||||
* - SSH_OPTIONS_TIMEOUT:
|
* - SSH_OPTIONS_TIMEOUT:
|
||||||
* Set a timeout for the connection in seconds (integer).
|
* Set a timeout for the connection in seconds (long).
|
||||||
*
|
*
|
||||||
* - SSH_OPTIONS_TIMEOUT_USEC:
|
* - SSH_OPTIONS_TIMEOUT_USEC:
|
||||||
* Set a timeout for the connection in micro seconds
|
* Set a timeout for the connection in micro seconds
|
||||||
* (integer).
|
* (long).
|
||||||
*
|
*
|
||||||
* - SSH_OPTIONS_SSH1:
|
* - SSH_OPTIONS_SSH1:
|
||||||
* Allow or deny the connection to SSH1 servers
|
* Allow or deny the connection to SSH1 servers
|
||||||
* (integer).
|
* (int, 0 is false).
|
||||||
*
|
*
|
||||||
* - SSH_OPTIONS_SSH2:
|
* - SSH_OPTIONS_SSH2:
|
||||||
* Allow or deny the connection to SSH2 servers
|
* Allow or deny the connection to SSH2 servers
|
||||||
* (integer).
|
* (int, 0 is false).
|
||||||
*
|
*
|
||||||
* - SSH_OPTIONS_LOG_VERBOSITY:
|
* - SSH_OPTIONS_LOG_VERBOSITY:
|
||||||
* Set the session logging verbosity (integer).\n
|
* Set the session logging verbosity (int).\n
|
||||||
* \n
|
* \n
|
||||||
* The verbosity of the messages. Every log smaller or
|
* The verbosity of the messages. Every log smaller or
|
||||||
* equal to verbosity will be shown.
|
* equal to verbosity will be shown.
|
||||||
* - SSH_LOG_NOLOG: No logging
|
* - SSH_LOG_NOLOG: No logging
|
||||||
* - SSH_LOG_RARE: Rare conditions or warnings
|
* - SSH_LOG_RARE: Rare conditions or warnings
|
||||||
* - SSH_LOG_ENTRY: API-accessible entrypoints
|
* - SSH_LOG_ENTRY: API-accessible entrypoints
|
||||||
* - SSH_LOG_PACKET: Packet id and size
|
* - SSH_LOG_PACKET: Packet id and size
|
||||||
* - SSH_LOG_FUNCTIONS: Function entering and leaving
|
* - SSH_LOG_FUNCTIONS: Function entering and leaving
|
||||||
*
|
*
|
||||||
* - SSH_OPTIONS_LOG_VERBOSITY_STR:
|
* - SSH_OPTIONS_LOG_VERBOSITY_STR:
|
||||||
* Set the session logging verbosity (string).\n
|
* Set the session logging verbosity (const char *).\n
|
||||||
* \n
|
* \n
|
||||||
* The verbosity of the messages. Every log smaller or
|
* The verbosity of the messages. Every log smaller or
|
||||||
* equal to verbosity will be shown.
|
* equal to verbosity will be shown.
|
||||||
* - SSH_LOG_NOLOG: No logging
|
* - SSH_LOG_NOLOG: No logging
|
||||||
* - SSH_LOG_RARE: Rare conditions or warnings
|
* - SSH_LOG_RARE: Rare conditions or warnings
|
||||||
* - SSH_LOG_ENTRY: API-accessible entrypoints
|
* - SSH_LOG_ENTRY: API-accessible entrypoints
|
||||||
* - SSH_LOG_PACKET: Packet id and size
|
* - SSH_LOG_PACKET: Packet id and size
|
||||||
* - SSH_LOG_FUNCTIONS: Function entering and leaving
|
* - SSH_LOG_FUNCTIONS: Function entering and leaving
|
||||||
* \n
|
* \n
|
||||||
* See the corresponding numbers in libssh.h.
|
* See the corresponding numbers in libssh.h.
|
||||||
*
|
*
|
||||||
* - SSH_OPTTIONS_AUTH_CALLBACK:
|
* - SSH_OPTTIONS_AUTH_CALLBACK:
|
||||||
* Set a callback to use your own authentication function
|
* Set a callback to use your own authentication function
|
||||||
* (function pointer).
|
* (function pointer).
|
||||||
*
|
*
|
||||||
* - SSH_OPTTIONS_AUTH_USERDATA:
|
* - SSH_OPTTIONS_AUTH_USERDATA:
|
||||||
* Set the user data passed to the authentication
|
* Set the user data passed to the authentication
|
||||||
* function (generic pointer).
|
* function (generic pointer).
|
||||||
*
|
*
|
||||||
* - SSH_OPTTIONS_LOG_CALLBACK:
|
* - SSH_OPTTIONS_LOG_CALLBACK:
|
||||||
* Set a callback to use your own logging function
|
* Set a callback to use your own logging function
|
||||||
* (function pointer).
|
* (function pointer).
|
||||||
*
|
*
|
||||||
* - SSH_OPTTIONS_LOG_USERDATA:
|
* - SSH_OPTTIONS_LOG_USERDATA:
|
||||||
* Set the user data passed to the logging function
|
* Set the user data passed to the logging function
|
||||||
* (generic pointer).
|
* (generic pointer).
|
||||||
*
|
*
|
||||||
* - SSH_OPTTIONS_STATUS_CALLBACK:
|
* - SSH_OPTTIONS_STATUS_CALLBACK:
|
||||||
* Set a callback to show connection status in realtime
|
* Set a callback to show connection status in realtime
|
||||||
* (function pointer).\n
|
* (function pointer).\n
|
||||||
* \n
|
* \n
|
||||||
* @code
|
* @code
|
||||||
* fn(void *arg, float status)
|
* fn(void *arg, float status)
|
||||||
* @endcode
|
* @endcode
|
||||||
* \n
|
* \n
|
||||||
* During ssh_connect(), libssh will call the callback
|
* During ssh_connect(), libssh will call the callback
|
||||||
* with status from 0.0 to 1.0.
|
* with status from 0.0 to 1.0.
|
||||||
*
|
*
|
||||||
* - SSH_OPTTIONS_STATUS_ARG:
|
* - SSH_OPTTIONS_STATUS_ARG:
|
||||||
* Set the status argument which should be passed to the
|
* Set the status argument which should be passed to the
|
||||||
* status callback (generic pointer).
|
* status callback (generic pointer).
|
||||||
*
|
*
|
||||||
* - SSH_OPTIONS_CIPHERS_C_S:
|
* - SSH_OPTIONS_CIPHERS_C_S:
|
||||||
* Set the symmetric cipher client to server (string,
|
* Set the symmetric cipher client to server (const char *,
|
||||||
* comma-separated list).
|
* comma-separated list).
|
||||||
*
|
*
|
||||||
* - SSH_OPTIONS_CIPHERS_S_C:
|
* - SSH_OPTIONS_CIPHERS_S_C:
|
||||||
* Set the symmetric cipher server to client (string,
|
* Set the symmetric cipher server to client (const char *,
|
||||||
* comma-separated list).
|
* comma-separated list).
|
||||||
*
|
*
|
||||||
* - SSH_OPTIONS_COMPRESSION_C_S:
|
* - SSH_OPTIONS_COMPRESSION_C_S:
|
||||||
* Set the compression to use for client to server
|
* Set the compression to use for client to server
|
||||||
* communication (string, "none" or "zlib").
|
* communication (const char *, "none" or "zlib").
|
||||||
*
|
*
|
||||||
* - SSH_OPTIONS_COMPRESSION_S_C:
|
* - SSH_OPTIONS_COMPRESSION_S_C:
|
||||||
* Set the compression to use for server to client
|
* Set the compression to use for server to client
|
||||||
* communication (string, "none" or "zlib").
|
* communication (const char *, "none" or "zlib").
|
||||||
*
|
*
|
||||||
* - SSH_OPTIONS_STRICTHOSTKEYCHECK:
|
* - SSH_OPTIONS_STRICTHOSTKEYCHECK:
|
||||||
* Set the parameter StrictHostKeyChecking to avoid
|
* Set the parameter StrictHostKeyChecking to avoid
|
||||||
* asking about a fingerprint (integer, 0 = false).
|
* asking about a fingerprint (int, 0 = false).
|
||||||
*
|
*
|
||||||
* - SSH_OPTIONS_PROXYCOMMAND:
|
* - SSH_OPTIONS_PROXYCOMMAND:
|
||||||
* Set the command to be executed in order to connect to
|
* Set the command to be executed in order to connect to
|
||||||
* server.
|
* server (const char *).
|
||||||
*
|
*
|
||||||
* @param value The value to set. This is a generic pointer and the
|
* @param value The value to set. This is a generic pointer and the
|
||||||
* datatype which is used should be set according to the
|
* datatype which is used should be set according to the
|
||||||
* type set.
|
* type set.
|
||||||
*
|
*
|
||||||
* @return 0 on success, < 0 on error.
|
* @return 0 on success, < 0 on error.
|
||||||
*/
|
*/
|
||||||
int ssh_options_set(ssh_session session, enum ssh_options_e type,
|
int ssh_options_set(ssh_session session, enum ssh_options_e type,
|
||||||
const void *value) {
|
const void *value) {
|
||||||
|
|||||||
Reference in New Issue
Block a user