doc: Improve and consolidate ssh_bind_options_set docs
Signed-off-by: Alan Dunn <amdunn@gmail.com> Reviewed-by: Andreas Schneider <asn@cryptomilk.org>
Этот коммит содержится в:
Alan Dunn
Andreas Schneider
родитель
8e2590b535
Коммит
47bd0b6d1f
@ -81,69 +81,6 @@ typedef struct ssh_bind_callbacks_struct *ssh_bind_callbacks;
|
|||||||
*/
|
*/
|
||||||
LIBSSH_API ssh_bind ssh_bind_new(void);
|
LIBSSH_API ssh_bind ssh_bind_new(void);
|
||||||
|
|
||||||
/**
|
|
||||||
* @brief Set the options for the current SSH server bind.
|
|
||||||
*
|
|
||||||
* @param sshbind The ssh server bind to configure.
|
|
||||||
*
|
|
||||||
* @param type The option type to set. This could be one of the
|
|
||||||
* following:
|
|
||||||
*
|
|
||||||
* - SSH_BIND_OPTIONS_BINDADDR
|
|
||||||
* The ip address to bind (const char *).
|
|
||||||
*
|
|
||||||
* - SSH_BIND_OPTIONS_BINDPORT
|
|
||||||
* The port to bind (unsigned int).
|
|
||||||
*
|
|
||||||
* - SSH_BIND_OPTIONS_BINDPORT_STR
|
|
||||||
* The port to bind (const char *).
|
|
||||||
*
|
|
||||||
* - SSH_BIND_OPTIONS_HOSTKEY
|
|
||||||
* This specifies the file containing the private host key used
|
|
||||||
* by SSHv1. (const char *).
|
|
||||||
*
|
|
||||||
* - SSH_BIND_OPTIONS_DSAKEY
|
|
||||||
* This specifies the file containing the private host dsa key
|
|
||||||
* used by SSHv2. (const char *).
|
|
||||||
*
|
|
||||||
* - SSH_BIND_OPTIONS_RSAKEY
|
|
||||||
* This specifies the file containing the private host dsa key
|
|
||||||
* used by SSHv2. (const char *).
|
|
||||||
*
|
|
||||||
* - SSH_BIND_OPTIONS_BANNER
|
|
||||||
* That the server banner (version string) for SSH.
|
|
||||||
* (const char *).
|
|
||||||
*
|
|
||||||
* - SSH_BIND_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_BIND_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.
|
|
||||||
*
|
|
||||||
* @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.
|
|
||||||
*
|
|
||||||
* @returns SSH_OK on success, SSH_ERROR on invalid option or parameter.
|
|
||||||
*/
|
|
||||||
LIBSSH_API int ssh_bind_options_set(ssh_bind sshbind,
|
LIBSSH_API int ssh_bind_options_set(ssh_bind sshbind,
|
||||||
enum ssh_bind_options_e type, const void *value);
|
enum ssh_bind_options_e type, const void *value);
|
||||||
|
|
||||||
|
|||||||
@ -1320,62 +1320,67 @@ static int ssh_bind_set_key(ssh_bind sshbind, char **key_loc,
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief This function can set all possible ssh bind options.
|
* @brief Set options for an SSH server bind.
|
||||||
*
|
*
|
||||||
* @param sshbind An allocated ssh bind structure.
|
* @param sshbind The ssh server bind to configure.
|
||||||
*
|
*
|
||||||
* @param type The option type to set. This could be one of the
|
* @param type The option type to set. This should be one of the
|
||||||
* following:
|
* following:
|
||||||
*
|
*
|
||||||
* SSH_BIND_OPTIONS_LOG_VERBOSITY:
|
* - SSH_BIND_OPTIONS_HOSTKEY:
|
||||||
* Set the session logging verbosity (integer).
|
|
||||||
*
|
|
||||||
* 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_BIND_OPTIONS_LOG_VERBOSITY_STR:
|
|
||||||
* Set the session logging verbosity (integer).
|
|
||||||
*
|
|
||||||
* 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_BIND_OPTIONS_BINDADDR:
|
|
||||||
* Set the bind address.
|
|
||||||
*
|
|
||||||
* SSH_BIND_OPTIONS_BINDPORT:
|
|
||||||
* Set the bind port, default is 22.
|
|
||||||
*
|
|
||||||
* SSH_BIND_OPTIONS_HOSTKEY:
|
|
||||||
* Set the server public key type: ssh-rsa or ssh-dss
|
* Set the server public key type: ssh-rsa or ssh-dss
|
||||||
* (string).
|
* (const char *).
|
||||||
*
|
*
|
||||||
* SSH_BIND_OPTIONS_DSAKEY:
|
* - SSH_BIND_OPTIONS_BINDADDR:
|
||||||
* Set the path to the ssh host dsa key (string).
|
* Set the IP address to bind (const char *).
|
||||||
*
|
*
|
||||||
* SSH_BIND_OPTIONS_RSAKEY:
|
* - SSH_BIND_OPTIONS_BINDPORT:
|
||||||
* Set the path to the ssh host rsa key (string).
|
* Set the port to bind (unsigned int *).
|
||||||
*
|
*
|
||||||
* SSH_BIND_OPTIONS_ECDSAKEY:
|
* - SSH_BIND_OPTIONS_BINDPORT_STR:
|
||||||
* Set the path to the ssh host ecdsa key (string).
|
* Set the port to bind (const char *).
|
||||||
*
|
*
|
||||||
* SSH_BIND_OPTIONS_BANNER:
|
* - SSH_BIND_OPTIONS_LOG_VERBOSITY:
|
||||||
* Set the server banner sent to clients (string).
|
* Set the session logging verbosity (int *).
|
||||||
|
* The logging verbosity should have one of the
|
||||||
|
* following values, which are listed in order
|
||||||
|
* of increasing verbosity. Every log message
|
||||||
|
* with verbosity less than or equal to the
|
||||||
|
* logging 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_BIND_OPTIONS_LOG_VERBOSITY_STR:
|
||||||
|
* Set the session logging verbosity via a
|
||||||
|
* string that will be converted to a numerical
|
||||||
|
* value (e.g. "3") and interpreted according
|
||||||
|
* to the values of
|
||||||
|
* SSH_BIND_OPTIONS_LOG_VERBOSITY above (const
|
||||||
|
* char *).
|
||||||
|
*
|
||||||
|
* - SSH_BIND_OPTIONS_DSAKEY:
|
||||||
|
* Set the path to the ssh host dsa key, SSHv2
|
||||||
|
* only (const char *).
|
||||||
|
*
|
||||||
|
* - SSH_BIND_OPTIONS_RSAKEY:
|
||||||
|
* Set the path to the ssh host rsa key, SSHv2
|
||||||
|
* only (const char *).
|
||||||
|
*
|
||||||
|
* - SSH_BIND_OPTIONS_ECDSAKEY:
|
||||||
|
* Set the path to the ssh host ecdsa key,
|
||||||
|
* SSHv2 only (const char *).
|
||||||
|
*
|
||||||
|
* - SSH_BIND_OPTIONS_BANNER:
|
||||||
|
* Set the server banner sent to clients (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 should be used is described at the
|
||||||
* type set.
|
* corresponding value of type above.
|
||||||
*
|
*
|
||||||
* @return 0 on success, < 0 on error.
|
* @return 0 on success, < 0 on error, invalid option, or parameter.
|
||||||
*/
|
*/
|
||||||
int ssh_bind_options_set(ssh_bind sshbind, enum ssh_bind_options_e type,
|
int ssh_bind_options_set(ssh_bind sshbind, enum ssh_bind_options_e type,
|
||||||
const void *value) {
|
const void *value) {
|
||||||
|
|||||||
Загрузка…
x
Ссылка в новой задаче
Block a user