oSIP www-authenticate header definition.

Collaboration diagram for oSIP www-authenticate header definition.:

Data Structures
struct	osip_www_authenticate
	Definition of the WWW-Authenticate header. More...

Macros
#define	osip_www_authenticate_set_stale_true(header)   osip_www_authenticate_set_stale(header,osip_strdup("true"))
	Add a stale parameter set to "true" in a Www-Authenticate element. More...
#define	osip_www_authenticate_set_stale_false(header)   osip_www_authenticate_set_stale(header,osip_strdup("false"))
	Add a stale parameter set to "false" in a Www-Authenticate element. More...
#define	osip_www_authenticate_set_algorithm_MD5(header)   osip_www_authenticate_set_algorithm(header,osip_strdup("MD5"))
	Add the algorithm parameter set to "MD5" in a Www-Authenticate element. More...

Typedefs
typedef struct osip_www_authenticate	osip_www_authenticate_t
	Structure for WWW-Authenticate headers. More...

Functions
int	osip_www_authenticate_init (osip_www_authenticate_t **header)
	Allocate a Www-Authenticate element. More...
int	osip_www_authenticate_parse (osip_www_authenticate_t *header, const char *hvalue)
	Parse a Www-Authenticate element. More...
int	osip_www_authenticate_to_str (const osip_www_authenticate_t *header, char **dest)
	Get a string representation of a Www-Authenticate element. More...
void	osip_www_authenticate_free (osip_www_authenticate_t *header)
	Free a Www-Authenticate element. More...
int	osip_www_authenticate_clone (const osip_www_authenticate_t *header, osip_www_authenticate_t **dest)
	Clone a Www-Authenticate element. More...
char *	osip_www_authenticate_get_auth_type (osip_www_authenticate_t *header)
	Get value of the auth_type parameter from a Www-Authenticate element. More...
void	osip_www_authenticate_set_auth_type (osip_www_authenticate_t *header, char *value)
	Add the auth_type parameter from a Www-Authenticate element. More...
char *	osip_www_authenticate_get_realm (osip_www_authenticate_t *header)
	Get value of the realm parameter from a Www-Authenticate element. More...
void	osip_www_authenticate_set_realm (osip_www_authenticate_t *header, char *value)
	Add the realm parameter from a Www-Authenticate element. More...
char *	osip_www_authenticate_get_domain (osip_www_authenticate_t *header)
	Get value of the domain parameter from a Www-Authenticate element. More...
void	osip_www_authenticate_set_domain (osip_www_authenticate_t *header, char *value)
	Add the domain parameter from a Www-Authenticate element. More...
char *	osip_www_authenticate_get_nonce (osip_www_authenticate_t *header)
	Get value of the nonce parameter from a Www-Authenticate element. More...
void	osip_www_authenticate_set_nonce (osip_www_authenticate_t *header, char *value)
	Add the nonce parameter from a Www-Authenticate element. More...
char *	osip_www_authenticate_get_opaque (osip_www_authenticate_t *header)
	Get value of the opaque parameter from a Www-Authenticate element. More...
void	osip_www_authenticate_set_opaque (osip_www_authenticate_t *header, char *value)
	Add the opaque parameter from a Www-Authenticate element. More...
char *	osip_www_authenticate_get_stale (osip_www_authenticate_t *header)
	Get value of the stale parameter from a Www-Authenticate element. More...
void	osip_www_authenticate_set_stale (osip_www_authenticate_t *header, char *value)
	Add the stale parameter in a Www-Authenticate element. More...
char *	osip_www_authenticate_get_algorithm (osip_www_authenticate_t *header)
	Get value of the algorithm parameter from a Www-Authenticate element. More...
void	osip_www_authenticate_set_algorithm (osip_www_authenticate_t *header, char *value)
	Add the algorithm parameter in a Www-Authenticate element. More...
char *	osip_www_authenticate_get_qop_options (osip_www_authenticate_t *header)
	Get value of the qop_options parameter from a Www-Authenticate element. More...
void	osip_www_authenticate_set_qop_options (osip_www_authenticate_t *header, char *value)
	Add the qop_options parameter from a Www-Authenticate element. More...
char *	osip_www_authenticate_get_version (osip_www_authenticate_t *header)
	Get value of the version parameter from a Www-Authenticate element. More...
void	osip_www_authenticate_set_version (osip_www_authenticate_t *header, char *value)
	Add the version parameter from a Www-Authenticate element. More...
char *	osip_www_authenticate_get_targetname (osip_www_authenticate_t *header)
	Get value of the targetname parameter from a Www-Authenticate element. More...
void	osip_www_authenticate_set_targetname (osip_www_authenticate_t *header, char *value)
	Add the targetname parameter from a Www-Authenticate element. More...
char *	osip_www_authenticate_get_gssapi_data (osip_www_authenticate_t *header)
	Get value of the gssapi_data parameter from a Www-Authenticate element. More...
void	osip_www_authenticate_set_gssapi_data (osip_www_authenticate_t *header, char *value)
	Add the gssapi_data parameter from a Www-Authenticate element. More...

Detailed Description

Macro Definition Documentation

#define osip_www_authenticate_set_algorithm_MD5

(

header

)

osip_www_authenticate_set_algorithm(header,osip_strdup("MD5"))

#include <osip_www_authenticate.h>

Add the algorithm parameter set to "MD5" in a Www-Authenticate element.

Parameters

header

The element to work on.

Definition at line 191 of file osip_www_authenticate.h.

#define osip_www_authenticate_set_stale_false

(

header

)

osip_www_authenticate_set_stale(header,osip_strdup("false"))

#include <osip_www_authenticate.h>

Add a stale parameter set to "false" in a Www-Authenticate element.

Parameters

header

The element to work on.

Definition at line 174 of file osip_www_authenticate.h.

#define osip_www_authenticate_set_stale_true

(

header

)

osip_www_authenticate_set_stale(header,osip_strdup("true"))

#include <osip_www_authenticate.h>

Add a stale parameter set to "true" in a Www-Authenticate element.

Parameters

header

The element to work on.

Definition at line 169 of file osip_www_authenticate.h.

Typedef Documentation

osip_www_authenticate_t

#include <osip_www_authenticate.h>

Structure for WWW-Authenticate headers.

Definition at line 40 of file osip_www_authenticate.h.

Function Documentation

int osip_www_authenticate_clone	(	const osip_www_authenticate_t *	header,
		osip_www_authenticate_t **	dest
	)

#include <osip_www_authenticate.h>

Clone a Www-Authenticate element.

Parameters

header	The element to work on.
dest	A pointer on the copy of the element.

void osip_www_authenticate_free

(

osip_www_authenticate_t *

header

)

#include <osip_www_authenticate.h>

Free a Www-Authenticate element.

Parameters

header

The element to work on.

char* osip_www_authenticate_get_algorithm

(

osip_www_authenticate_t *

header

)

#include <osip_www_authenticate.h>

Get value of the algorithm parameter from a Www-Authenticate element.

Parameters

header

The element to work on.

char* osip_www_authenticate_get_auth_type

(

osip_www_authenticate_t *

header

)

#include <osip_www_authenticate.h>

Get value of the auth_type parameter from a Www-Authenticate element.

Parameters

header

The element to work on.

char* osip_www_authenticate_get_domain

(

osip_www_authenticate_t *

header

)

#include <osip_www_authenticate.h>

Get value of the domain parameter from a Www-Authenticate element.

Parameters

header

The element to work on.

char* osip_www_authenticate_get_gssapi_data

(

osip_www_authenticate_t *

header

)

#include <osip_www_authenticate.h>

Get value of the gssapi_data parameter from a Www-Authenticate element.

Parameters

header

The element to work on.

char* osip_www_authenticate_get_nonce

(

osip_www_authenticate_t *

header

)

#include <osip_www_authenticate.h>

Get value of the nonce parameter from a Www-Authenticate element.

Parameters

header

The element to work on.

char* osip_www_authenticate_get_opaque

(

osip_www_authenticate_t *

header

)

#include <osip_www_authenticate.h>

Get value of the opaque parameter from a Www-Authenticate element.

Parameters

header

The element to work on.

char* osip_www_authenticate_get_qop_options

(

osip_www_authenticate_t *

header

)

#include <osip_www_authenticate.h>

Get value of the qop_options parameter from a Www-Authenticate element.

Parameters

header

The element to work on.

char* osip_www_authenticate_get_realm

(

osip_www_authenticate_t *

header

)

#include <osip_www_authenticate.h>

Get value of the realm parameter from a Www-Authenticate element.

Parameters

header

The element to work on.

char* osip_www_authenticate_get_stale

(

osip_www_authenticate_t *

header

)

#include <osip_www_authenticate.h>

Get value of the stale parameter from a Www-Authenticate element.

Parameters

header

The element to work on.

char* osip_www_authenticate_get_targetname

(

osip_www_authenticate_t *

header

)

#include <osip_www_authenticate.h>

Get value of the targetname parameter from a Www-Authenticate element.

Parameters

header

The element to work on.

char* osip_www_authenticate_get_version

(

osip_www_authenticate_t *

header

)

#include <osip_www_authenticate.h>

Get value of the version parameter from a Www-Authenticate element.

Parameters

header

The element to work on.

int osip_www_authenticate_init

(

osip_www_authenticate_t **

header

)

#include <osip_www_authenticate.h>

Allocate a Www-Authenticate element.

Parameters

header

The element to work on.

int osip_www_authenticate_parse	(	osip_www_authenticate_t *	header,
		const char *	hvalue
	)

#include <osip_www_authenticate.h>

Parse a Www-Authenticate element.

Parameters

header	The element to work on.
hvalue	The string to parse.

void osip_www_authenticate_set_algorithm	(	osip_www_authenticate_t *	header,
		char *	value
	)

#include <osip_www_authenticate.h>

Add the algorithm parameter in a Www-Authenticate element.

Parameters

header	The element to work on.
value	The value of the new parameter.

void osip_www_authenticate_set_auth_type	(	osip_www_authenticate_t *	header,
		char *	value
	)

#include <osip_www_authenticate.h>

Add the auth_type parameter from a Www-Authenticate element.

Parameters

header	The element to work on.
value	The value of the new parameter.

void osip_www_authenticate_set_domain	(	osip_www_authenticate_t *	header,
		char *	value
	)

#include <osip_www_authenticate.h>

Add the domain parameter from a Www-Authenticate element.

Parameters

header	The element to work on.
value	The value of the new parameter.

void osip_www_authenticate_set_gssapi_data	(	osip_www_authenticate_t *	header,
		char *	value
	)

#include <osip_www_authenticate.h>

Add the gssapi_data parameter from a Www-Authenticate element.

Parameters

header	The element to work on.
value	The value of the new parameter.

void osip_www_authenticate_set_nonce	(	osip_www_authenticate_t *	header,
		char *	value
	)

#include <osip_www_authenticate.h>

Add the nonce parameter from a Www-Authenticate element.

Parameters

header	The element to work on.
value	The value of the new parameter.

void osip_www_authenticate_set_opaque	(	osip_www_authenticate_t *	header,
		char *	value
	)

#include <osip_www_authenticate.h>

Add the opaque parameter from a Www-Authenticate element.

Parameters

header	The element to work on.
value	The value of the new parameter.

void osip_www_authenticate_set_qop_options	(	osip_www_authenticate_t *	header,
		char *	value
	)

#include <osip_www_authenticate.h>

Add the qop_options parameter from a Www-Authenticate element.

Parameters

header	The element to work on.
value	The value of the new parameter.

void osip_www_authenticate_set_realm	(	osip_www_authenticate_t *	header,
		char *	value
	)

#include <osip_www_authenticate.h>

Add the realm parameter from a Www-Authenticate element.

Parameters

header	The element to work on.
value	The value of the new parameter.

void osip_www_authenticate_set_stale	(	osip_www_authenticate_t *	header,
		char *	value
	)

#include <osip_www_authenticate.h>

Add the stale parameter in a Www-Authenticate element.

Parameters

header	The element to work on.
value	The value of the new parameter.

void osip_www_authenticate_set_targetname	(	osip_www_authenticate_t *	header,
		char *	value
	)

#include <osip_www_authenticate.h>

Add the targetname parameter from a Www-Authenticate element.

Parameters

header	The element to work on.
value	The value of the new parameter.

void osip_www_authenticate_set_version	(	osip_www_authenticate_t *	header,
		char *	value
	)

#include <osip_www_authenticate.h>

Add the version parameter from a Www-Authenticate element.

Parameters

header	The element to work on.
value	The value of the new parameter.

int osip_www_authenticate_to_str	(	const osip_www_authenticate_t *	header,
		char **	dest
	)

#include <osip_www_authenticate.h>

Get a string representation of a Www-Authenticate element.

Parameters

header	The element to work on.
dest	A pointer on the new allocated string.