The SSH string functions
[The libssh API]

String manipulations used in libssh. More...

Functions
void	ssh_string_burn (struct ssh_string_struct *s)
	Destroy the data in a string so it couldn't appear in a core dump.
ssh_string_struct *	ssh_string_copy (struct ssh_string_struct *s)
	Copy a string, return a newly allocated string.
void *	ssh_string_data (struct ssh_string_struct *s)
	Get the payload of the string.
int	ssh_string_fill (struct ssh_string_struct *s, const void *data, size_t len)
	Fill a string with given data.
void	ssh_string_free (struct ssh_string_struct *s)
	Deallocate a SSH string object.
void	ssh_string_free_char (char *s)
	Deallocate a char string object.
ssh_string_struct *	ssh_string_from_char (const char *what)
	Create a ssh string using a C string.
size_t	ssh_string_len (struct ssh_string_struct *s)
	Return the size of a SSH string.
ssh_string_struct *	ssh_string_new (size_t size)
	Create a new SSH String object.
char *	ssh_string_to_char (struct ssh_string_struct *s)
	Convert a SSH string to a C nul-terminated string.

---

Detailed Description

String manipulations used in libssh.

---

Function Documentation

void ssh_string_burn

(

struct ssh_string_struct *

s

)

Destroy the data in a string so it couldn't appear in a core dump.

Parameters:

[in]

s

The string to burn.

struct ssh_string_struct* ssh_string_copy

(

struct ssh_string_struct *

s

)

Copy a string, return a newly allocated string.

The caller has to free the string.

Parameters:

[in]

s

String to copy.

Returns:

Newly allocated copy of the string, NULL on error.

void* ssh_string_data

(

struct ssh_string_struct *

s

)

Get the payload of the string.

Parameters:

s

The string to get the data from.

Returns:

Return the data of the string or NULL on error.

int ssh_string_fill	(	struct ssh_string_struct *	s,
		const void *	data,
		size_t	len
	)

Fill a string with given data.

The string should be big enough.

Parameters:

	s	An allocated string to fill with data.
	data	The data to fill the string with.
	len	Size of data.

Returns:

0 on success, < 0 on error.

void ssh_string_free

(

struct ssh_string_struct *

s

)

Deallocate a SSH string object.

Parameters:

[in]

s

The SSH string to delete.

void ssh_string_free_char

(

char *

s

)

Deallocate a char string object.

Parameters:

[in]

s

The string to delete.

struct ssh_string_struct* ssh_string_from_char

(

const char *

what

)

Create a ssh string using a C string.

Parameters:

[in]

what

The source 0-terminated C string.

Returns:

The newly allocated string, NULL on error with errno set.

Note:

The nul byte is not copied nor counted in the ouput string.

size_t ssh_string_len

(

struct ssh_string_struct *

s

)

Return the size of a SSH string.

Parameters:

[in]

s

The the input SSH string.

Returns:

The size of the content of the string, 0 on error.

struct ssh_string_struct* ssh_string_new

(

size_t

size

)

Create a new SSH String object.

Parameters:

[in]

size

The size of the string.

Returns:

The newly allocated string, NULL on error.

char* ssh_string_to_char

(

struct ssh_string_struct *

s

)

Convert a SSH string to a C nul-terminated string.

Parameters:

[in]

s

The SSH input string.

Returns:

An allocated string pointer, NULL on error with errno set.

Note:

If the input SSH string contains zeroes, some parts of the output string may not be readable with regular libc functions.

---