aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAris Adamantiadis <aris@0xbadc0de.be>2010-10-15 16:53:18 +0200
committerAris Adamantiadis <aris@0xbadc0de.be>2010-10-15 16:53:18 +0200
commitb1291818098daffe17574b15d8f12495a1802286 (patch)
treeda48f15d59fbc83ac249ca6acda7d2fc1d25fc5e
parent3253ece2a2fb6d12f4bc3b97c760d718bcd4359d (diff)
downloadlibssh-b1291818098daffe17574b15d8f12495a1802286.tar.gz
libssh-b1291818098daffe17574b15d8f12495a1802286.tar.xz
libssh-b1291818098daffe17574b15d8f12495a1802286.zip
Adapt comments in options to give parameters types
-rw-r--r--src/options.c322
1 files changed, 161 insertions, 161 deletions
diff --git a/src/options.c b/src/options.c
index e069ea03..515c77f6 100644
--- a/src/options.c
+++ b/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.
*
- * @param session An allocated ssh option structure.
- *
- * @param type The option type to set. This could be one of the
- * following:
- *
- * - SSH_OPTIONS_HOST:
- * The hostname or ip address to connect to (string).
- *
- * - SSH_OPTIONS_PORT:
- * The port to connect to (integer).
- *
- * - SSH_OPTIONS_PORT_STR:
- * The port to connect to (string).
- *
- * - SSH_OPTIONS_FD:
- * The file descriptor to use (socket_t).\n
- * \n
- * If you wish to open the socket yourself for a reason
- * or another, set the file descriptor. Don't forget to
- * set the hostname as the hostname is used as a key in
- * the known_host mechanism.
- *
- * - SSH_OPTIONS_BINDADDR:
- * The address to bind the client to (string).
- *
- * - SSH_OPTIONS_USER:
- * The username for authentication (string).\n
- * \n
- * If the value is NULL, the username is set to the
- * default username.
- *
- * - SSH_OPTIONS_SSH_DIR:
- * Set the ssh directory (format string).\n
- * \n
- * If the value is NULL, the directory is set to the
- * default ssh directory.\n
- * \n
- * The ssh directory is used for files like known_hosts
- * and identity (private and public key). It may include
- * "%s" which will be replaced by the user home
- * directory.
- *
- * - SSH_OPTIONS_KNOWNHOSTS:
- * Set the known hosts file name (format string).\n
- * \n
- * If the value is NULL, the directory is set to the
- * default known hosts file, normally
- * ~/.ssh/known_hosts.\n
- * \n
- * The known hosts file is used to certify remote hosts
- * are genuine. It may include "%s" which will be
- * replaced by the user home directory.
- *
- * - SSH_OPTIONS_IDENTITY:
- * Set the identity file name (format string).\n
- * \n
- * By default identity, id_dsa and id_rsa are checked.\n
- * \n
- * The identity file used authenticate with public key.
- * It may include "%s" which will be replaced by the
- * user home directory.
- *
- * - SSH_OPTIONS_TIMEOUT:
- * Set a timeout for the connection in seconds (integer).
- *
- * - SSH_OPTIONS_TIMEOUT_USEC:
- * Set a timeout for the connection in micro seconds
- * (integer).
- *
- * - SSH_OPTIONS_SSH1:
- * Allow or deny the connection to SSH1 servers
- * (integer).
- *
- * - SSH_OPTIONS_SSH2:
- * Allow or deny the connection to SSH2 servers
- * (integer).
- *
- * - SSH_OPTIONS_LOG_VERBOSITY:
- * Set the session logging verbosity (integer).\n
- * \n
- * The verbosity of the messages. Every log smaller or
- * equal to verbosity will be shown.
- * - SSH_LOG_NOLOG: No logging
- * - SSH_LOG_RARE: Rare conditions or warnings
- * - SSH_LOG_ENTRY: API-accessible entrypoints
- * - SSH_LOG_PACKET: Packet id and size
- * - SSH_LOG_FUNCTIONS: Function entering and leaving
- *
- * - SSH_OPTIONS_LOG_VERBOSITY_STR:
- * Set the session logging verbosity (string).\n
- * \n
- * The verbosity of the messages. Every log smaller or
- * equal to verbosity will be shown.
- * - SSH_LOG_NOLOG: No logging
- * - SSH_LOG_RARE: Rare conditions or warnings
- * - SSH_LOG_ENTRY: API-accessible entrypoints
- * - SSH_LOG_PACKET: Packet id and size
- * - SSH_LOG_FUNCTIONS: Function entering and leaving
- * \n
- * See the corresponding numbers in libssh.h.
- *
- * - SSH_OPTTIONS_AUTH_CALLBACK:
- * Set a callback to use your own authentication function
- * (function pointer).
- *
- * - SSH_OPTTIONS_AUTH_USERDATA:
- * Set the user data passed to the authentication
- * function (generic pointer).
- *
- * - SSH_OPTTIONS_LOG_CALLBACK:
- * Set a callback to use your own logging function
- * (function pointer).
- *
- * - SSH_OPTTIONS_LOG_USERDATA:
- * Set the user data passed to the logging function
- * (generic pointer).
- *
- * - SSH_OPTTIONS_STATUS_CALLBACK:
- * Set a callback to show connection status in realtime
- * (function pointer).\n
- * \n
- * @code
- * fn(void *arg, float status)
- * @endcode
- * \n
- * During ssh_connect(), libssh will call the callback
- * with status from 0.0 to 1.0.
- *
- * - SSH_OPTTIONS_STATUS_ARG:
- * Set the status argument which should be passed to the
- * status callback (generic pointer).
- *
- * - SSH_OPTIONS_CIPHERS_C_S:
- * Set the symmetric cipher client to server (string,
- * comma-separated list).
- *
- * - SSH_OPTIONS_CIPHERS_S_C:
- * Set the symmetric cipher server to client (string,
- * comma-separated list).
- *
- * - SSH_OPTIONS_COMPRESSION_C_S:
- * Set the compression to use for client to server
- * communication (string, "none" or "zlib").
- *
- * - SSH_OPTIONS_COMPRESSION_S_C:
- * Set the compression to use for server to client
- * communication (string, "none" or "zlib").
- *
- * - SSH_OPTIONS_STRICTHOSTKEYCHECK:
- * Set the parameter StrictHostKeyChecking to avoid
- * asking about a fingerprint (integer, 0 = false).
- *
- * - SSH_OPTIONS_PROXYCOMMAND:
- * Set the command to be executed in order to connect to
- * server.
- *
- * @param value The value to set. This is a generic pointer and the
- * datatype which is used should be set according to the
- * type set.
- *
- * @return 0 on success, < 0 on error.
+ * @param session An allocated SSH session structure.
+ *
+ * @param type The option type to set. This could be one of the
+ * following:
+ *
+ * - SSH_OPTIONS_HOST:
+ * The hostname or ip address to connect to (const char *).
+ *
+ * - SSH_OPTIONS_PORT:
+ * The port to connect to (unsigned int).
+ *
+ * - SSH_OPTIONS_PORT_STR:
+ * The port to connect to (const char *).
+ *
+ * - SSH_OPTIONS_FD:
+ * The file descriptor to use (socket_t).\n
+ * \n
+ * If you wish to open the socket yourself for a reason
+ * or another, set the file descriptor. Don't forget to
+ * set the hostname as the hostname is used as a key in
+ * the known_host mechanism.
+ *
+ * - SSH_OPTIONS_BINDADDR:
+ * The address to bind the client to (const char *).
+ *
+ * - SSH_OPTIONS_USER:
+ * The username for authentication (const char *).\n
+ * \n
+ * If the value is NULL, the username is set to the
+ * default username.
+ *
+ * - SSH_OPTIONS_SSH_DIR:
+ * Set the ssh directory (const char *,format string).\n
+ * \n
+ * If the value is NULL, the directory is set to the
+ * default ssh directory.\n
+ * \n
+ * The ssh directory is used for files like known_hosts
+ * and identity (private and public key). It may include
+ * "%s" which will be replaced by the user home
+ * directory.
+ *
+ * - SSH_OPTIONS_KNOWNHOSTS:
+ * Set the known hosts file name (const char *,format string).\n
+ * \n
+ * If the value is NULL, the directory is set to the
+ * default known hosts file, normally
+ * ~/.ssh/known_hosts.\n
+ * \n
+ * The known hosts file is used to certify remote hosts
+ * are genuine. It may include "%s" which will be
+ * replaced by the user home directory.
+ *
+ * - SSH_OPTIONS_IDENTITY:
+ * Set the identity file name (const char *,format string).\n
+ * \n
+ * By default identity, id_dsa and id_rsa are checked.\n
+ * \n
+ * The identity file used authenticate with public key.
+ * It may include "%s" which will be replaced by the
+ * user home directory.
+ *
+ * - SSH_OPTIONS_TIMEOUT:
+ * Set a timeout for the connection in seconds (long).
+ *
+ * - SSH_OPTIONS_TIMEOUT_USEC:
+ * Set a timeout for the connection in micro seconds
+ * (long).
+ *
+ * - SSH_OPTIONS_SSH1:
+ * Allow or deny the connection to SSH1 servers
+ * (int, 0 is false).
+ *
+ * - SSH_OPTIONS_SSH2:
+ * Allow or deny the connection to SSH2 servers
+ * (int, 0 is false).
+ *
+ * - SSH_OPTIONS_LOG_VERBOSITY:
+ * Set the session logging verbosity (int).\n
+ * \n
+ * The verbosity of the messages. Every log smaller or
+ * equal to verbosity will be shown.
+ * - SSH_LOG_NOLOG: No logging
+ * - SSH_LOG_RARE: Rare conditions or warnings
+ * - SSH_LOG_ENTRY: API-accessible entrypoints
+ * - SSH_LOG_PACKET: Packet id and size
+ * - SSH_LOG_FUNCTIONS: Function entering and leaving
+ *
+ * - SSH_OPTIONS_LOG_VERBOSITY_STR:
+ * Set the session logging verbosity (const char *).\n
+ * \n
+ * The verbosity of the messages. Every log smaller or
+ * equal to verbosity will be shown.
+ * - SSH_LOG_NOLOG: No logging
+ * - SSH_LOG_RARE: Rare conditions or warnings
+ * - SSH_LOG_ENTRY: API-accessible entrypoints
+ * - SSH_LOG_PACKET: Packet id and size
+ * - SSH_LOG_FUNCTIONS: Function entering and leaving
+ * \n
+ * See the corresponding numbers in libssh.h.
+ *
+ * - SSH_OPTTIONS_AUTH_CALLBACK:
+ * Set a callback to use your own authentication function
+ * (function pointer).
+ *
+ * - SSH_OPTTIONS_AUTH_USERDATA:
+ * Set the user data passed to the authentication
+ * function (generic pointer).
+ *
+ * - SSH_OPTTIONS_LOG_CALLBACK:
+ * Set a callback to use your own logging function
+ * (function pointer).
+ *
+ * - SSH_OPTTIONS_LOG_USERDATA:
+ * Set the user data passed to the logging function
+ * (generic pointer).
+ *
+ * - SSH_OPTTIONS_STATUS_CALLBACK:
+ * Set a callback to show connection status in realtime
+ * (function pointer).\n
+ * \n
+ * @code
+ * fn(void *arg, float status)
+ * @endcode
+ * \n
+ * During ssh_connect(), libssh will call the callback
+ * with status from 0.0 to 1.0.
+ *
+ * - SSH_OPTTIONS_STATUS_ARG:
+ * Set the status argument which should be passed to the
+ * status callback (generic pointer).
+ *
+ * - SSH_OPTIONS_CIPHERS_C_S:
+ * Set the symmetric cipher client to server (const char *,
+ * comma-separated list).
+ *
+ * - SSH_OPTIONS_CIPHERS_S_C:
+ * Set the symmetric cipher server to client (const char *,
+ * comma-separated list).
+ *
+ * - SSH_OPTIONS_COMPRESSION_C_S:
+ * Set the compression to use for client to server
+ * communication (const char *, "none" or "zlib").
+ *
+ * - SSH_OPTIONS_COMPRESSION_S_C:
+ * Set the compression to use for server to client
+ * communication (const char *, "none" or "zlib").
+ *
+ * - SSH_OPTIONS_STRICTHOSTKEYCHECK:
+ * Set the parameter StrictHostKeyChecking to avoid
+ * asking about a fingerprint (int, 0 = false).
+ *
+ * - SSH_OPTIONS_PROXYCOMMAND:
+ * Set the command to be executed in order to connect to
+ * server (const char *).
+ *
+ * @param value The value to set. This is a generic pointer and the
+ * datatype which is used should be set according to the
+ * type set.
+ *
+ * @return 0 on success, < 0 on error.
*/
int ssh_options_set(ssh_session session, enum ssh_options_e type,
const void *value) {