libssh  0.8.3
The SSH library
Macros | Functions
The SSH helper functions.
Collaboration diagram for The SSH helper functions.:

Macros

#define NSS_BUFLEN_PASSWD   4096
 
#define CLOCK   CLOCK_REALTIME
 

Functions

int ssh_getpass (const char *prompt, char *buf, size_t len, int echo, int verify)
 Get a password from the console. More...
 
char * ssh_get_user_home_dir (void)
 
int ssh_file_readaccess_ok (const char *file)
 
char * ssh_get_local_username (void)
 
int ssh_is_ipaddr_v4 (const char *str)
 
int ssh_is_ipaddr (const char *str)
 
char * ssh_lowercase (const char *str)
 
char * ssh_hostport (const char *host, int port)
 
const char * ssh_version (int req_version)
 Check if libssh is the required version or get the version string. More...
 
struct ssh_listssh_list_new (void)
 
void ssh_list_free (struct ssh_list *list)
 
struct ssh_iteratorssh_list_get_iterator (const struct ssh_list *list)
 
struct ssh_iteratorssh_list_find (const struct ssh_list *list, void *value)
 
size_t ssh_list_count (const struct ssh_list *list)
 Get the number of elements in the list. More...
 
int ssh_list_append (struct ssh_list *list, const void *data)
 
int ssh_list_prepend (struct ssh_list *list, const void *data)
 
void ssh_list_remove (struct ssh_list *list, struct ssh_iterator *iterator)
 
const void * _ssh_list_pop_head (struct ssh_list *list)
 
char * ssh_dirname (const char *path)
 Parse directory component. More...
 
char * ssh_basename (const char *path)
 basename - parse filename component. 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...
 
char * ssh_path_expand_escape (ssh_session session, const char *s)
 
int ssh_analyze_banner (ssh_session session, int server)
 
void ssh_timestamp_init (struct ssh_timestamp *ts)
 
int ssh_make_milliseconds (long sec, long usec)
 
int ssh_timeout_elapsed (struct ssh_timestamp *ts, int timeout)
 
int ssh_timeout_update (struct ssh_timestamp *ts, int timeout)
 updates a timeout value so it reflects the remaining time More...
 
int ssh_match_group (const char *group, const char *object)
 
void explicit_bzero (void *s, size_t n)
 
char * strndup (const char *s, size_t n)
 

Detailed Description

Different helper functions used in the SSH Library.

Function Documentation

◆ ssh_basename()

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.

Parameters
[in]pathThe path to parse.
Returns
The filename of path or NULL if we can't allocate memory. If path is a the string "/", basename returns the string "/". If path is NULL or an empty string, "." is returned.

◆ ssh_dirname()

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.

Parameters
[in]pathThe path to parse.
Returns
The dirname of path or NULL if we can't allocate memory. If path does not contain a slash, c_dirname() returns the string ".". If path is the string "/", it returns the string "/". If path is NULL or an empty string, "." is returned.

◆ ssh_getpass()

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.

char username[128];
snprintf(username, sizeof(username), "john");
ssh_getpass("Username:", username, sizeof(username), 1, 0);

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.

Parameters
[in]promptThe prompt to show to ask for the password.
[out]bufThe buffer the password should be stored. It NEEDS to be empty or filled out.
[in]lenThe length of the buffer.
[in]echoShould we echo what you type.
[in]verifyShould we ask for the password twice.
Returns
0 on success, -1 on error.

◆ ssh_list_count()

size_t ssh_list_count ( const struct ssh_list list)

Get the number of elements in the list.

Parameters
[in]listThe list to count.
Returns
The number of elements in the list.

◆ ssh_mkdir()

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.

Parameters
[in]pathnameThe path name to create the directory.
[in]modeThe permissions to use.
Returns
0 on success, < 0 on error with errno set.

◆ ssh_path_expand_tilde()

char* ssh_path_expand_tilde ( const char *  d)

Expand a directory starting with a tilde '~'.

Parameters
[in]dThe directory to expand.
Returns
The expanded directory, NULL on error.

◆ ssh_timeout_update()

int ssh_timeout_update ( struct ssh_timestamp ts,
int  timeout 
)

updates a timeout value so it reflects the remaining time

Parameters
[in]tspointer to an existing timestamp
[in]timeouttimeout in milliseconds. Negative values mean infinite timeout
Returns
remaining time in milliseconds, 0 if elapsed, -1 if never.

◆ ssh_version()

const char* ssh_version ( int  req_version)

Check if libssh is the required version or get the version string.

Parameters
[in]req_versionThe version required.
Returns
If the version of libssh is newer than the version required it will return a version string. NULL if the version is older.

Example:

if (ssh_version(SSH_VERSION_INT(0,2,1)) == NULL) {
fprintf(stderr, "libssh version is too old!\n");
exit(1);
}
if (debug) {
printf("libssh %s\n", ssh_version(0));
}