libssh
0.6.3
|
Different helper functions used in the SSH Library. More...
Functions | |
char * | ssh_basename (const char *path) |
basename - parse filename component. More... | |
int | ssh_check_hostname_syntax (const char *hostname) |
Checks syntax of a domain name. More... | |
int | ssh_check_username_syntax (const char *username) |
Checks syntax of a username. More... | |
char * | ssh_dirname (const char *path) |
Parse directory component. More... | |
int | ssh_getpass (const char *prompt, char *buf, size_t len, int echo, int verify) |
Get a password from the console. More... | |
int | ssh_mkdir (const char *pathname, mode_t mode) |
Attempts to create a directory with the given pathname. More... | |
char * | ssh_path_expand_tilde (const char *d) |
Expand a directory starting with a tilde '~'. More... | |
int | ssh_timeout_update (struct ssh_timestamp *ts, int timeout) |
updates a timeout value so it reflects the remaining time More... | |
const char * | ssh_version (int req_version) |
Check if libssh is the required version or get the version string. More... | |
Different helper functions used in the SSH Library.
char* ssh_basename | ( | const char * | path | ) |
basename - parse filename component.
basename breaks a null-terminated pathname string into a filename component. ssh_basename() returns the component following the final '/'. Trailing '/' characters are not counted as part of the pathname.
[in] | path | The path to parse. |
Referenced by ssh_scp_push_directory(), and ssh_scp_push_file64().
int ssh_check_hostname_syntax | ( | const char * | hostname | ) |
Checks syntax of a domain name.
The check is made based on the RFC1035 section 2.3.1 Allowed characters are: hyphen, period, digits (0-9) and letters (a-zA-Z)
The label should be no longer than 63 characters The label should start with a letter and end with a letter or number The label in this implementation can start with a number to allow virtual URLs to pass. Note that this will make IPv4 addresses to pass this check too.
hostname | The domain name to be checked, has to be null terminated |
int ssh_check_username_syntax | ( | const char * | username | ) |
Checks syntax of a username.
This check disallows metacharacters in the username
username | The username to be checked, has to be null terminated |
Referenced by ssh_options_set().
char* ssh_dirname | ( | const char * | path | ) |
Parse directory component.
dirname breaks a null-terminated pathname string into a directory component. In the usual case, ssh_dirname() returns the string up to, but not including, the final '/'. Trailing '/' characters are not counted as part of the pathname. The caller must free the memory.
[in] | path | The path to parse. |
Referenced by ssh_write_knownhost().
int ssh_getpass | ( | const char * | prompt, |
char * | buf, | ||
size_t | len, | ||
int | echo, | ||
int | verify | ||
) |
Get a password from the console.
You should make sure that the buffer is an empty string!
You can also use this function to ask for a username. Then you can fill the buffer with the username and it is shows to the users. If the users just presses enter the buffer will be untouched.
The prompt will look like this:
Username: [john]
If you press enter then john is used as the username, or you can type it in to change it.
[in] | prompt | The prompt to show to ask for the password. |
[out] | buf | The buffer the password should be stored. It NEEDS to be empty or filled out. |
[in] | len | The length of the buffer. |
[in] | echo | Should we echo what you type. |
[in] | verify | Should we ask for the password twice. |
int ssh_mkdir | ( | const char * | pathname, |
mode_t | mode | ||
) |
Attempts to create a directory with the given pathname.
This is the portable version of mkdir, mode is ignored on Windows systems.
[in] | pathname | The path name to create the directory. |
[in] | mode | The permissions to use. |
Referenced by ssh_write_knownhost().
char* ssh_path_expand_tilde | ( | const char * | d | ) |
Expand a directory starting with a tilde '~'.
[in] | d | The directory to expand. |
Referenced by ssh_options_set().
int ssh_timeout_update | ( | struct ssh_timestamp * | ts, |
int | timeout | ||
) |
updates a timeout value so it reflects the remaining time
[in] | ts | pointer to an existing timestamp |
[in] | timeout | timeout in milliseconds. Negative values mean infinite timeout |
References SSH_LOG_WARNING.
Referenced by ssh_channel_select(), ssh_select(), and ssh_set_fd_except().
const char* ssh_version | ( | int | req_version | ) |
Check if libssh is the required version or get the version string.
[in] | req_version | The version required. |
Example: