Proxy-Authorization Header [SIP Headers]

The Proxy-Authorization header consists of credentials containing the authentication information of the user agent for the proxy and/or realm of the resource being requested. More...

Defines
#define	sip_proxy_authorization(sip)
	Access a SIP Proxy-Authorization header structure sip_proxy_authorization_t from sip_t.
#define	SIP_PROXY_AUTHORIZATION_INIT()
	Initializer for structure sip_proxy_authorization_t.
#define	SIPTAG_PROXY_AUTHORIZATION(x)
	Tag list item for pointer to a Proxy-Authorization header structure sip_proxy_authorization_t.
#define	SIPTAG_PROXY_AUTHORIZATION_REF(x)
	Tag list item for reference to a Proxy-Authorization header pointer.
#define	SIPTAG_PROXY_AUTHORIZATION_STR(s)
	Tag list item for string with Proxy-Authorization header value.
#define	SIPTAG_PROXY_AUTHORIZATION_STR_REF(x)
	Tag list item for reference to a Proxy-Authorization header string.
Typedefs
typedef struct msg_auth_s	sip_proxy_authorization_t
	The structure sip_proxy_authorization_t contains representation of SIP Proxy-Authorization header.
Functions
issize_t	sip_proxy_authorization_d (su_home_t *, msg_header_t *, char *s, isize_t slen)
	Parse a SIP Proxy-Authorization header.
issize_t	sip_proxy_authorization_e (char b[], isize_t bsiz, msg_header_t const *h, int flags)
	Print a SIP Proxy-Authorization header.
sip_proxy_authorization_t *	sip_proxy_authorization_init (sip_proxy_authorization_t x[1])
	Initialize a structure sip_proxy_authorization_t.
int	sip_is_proxy_authorization (sip_header_t const *header)
	Test if header object is instance of sip_proxy_authorization_t.
sip_proxy_authorization_t *	sip_proxy_authorization_dup (su_home_t *home, sip_proxy_authorization_t const *hdr))
	Duplicate a list of Proxy-Authorization header header structures sip_proxy_authorization_t.
sip_proxy_authorization_t *	sip_proxy_authorization_copy (su_home_t *home, sip_proxy_authorization_t const *hdr))
	Copy a list of Proxy-Authorization header header structures sip_proxy_authorization_t.
sip_proxy_authorization_t *	sip_proxy_authorization_make (su_home_t *home, char const *s))
	Make a Proxy-Authorization header structure sip_proxy_authorization_t.
sip_proxy_authorization_t *	sip_proxy_authorization_format (su_home_t *home, char const *fmt,...)))
	Make a Proxy-Authorization header from formatting result.
Variables
msg_hclass_t	sip_proxy_authorization_class []
	Header class for Proxy-Authorization header.
tag_typedef_t	siptag_proxy_authorization
	Tag for Proxy-Authorization header object.
tag_typedef_t	siptag_proxy_authorization_str
	Tag for string with Proxy-Authorization header value.

---

Detailed Description

The Proxy-Authorization header consists of credentials containing the authentication information of the user agent for the proxy and/or realm of the resource being requested.

Its syntax is defined in RFC 3261 as follows:

    Proxy-Authorization  = "Proxy-Authorization" ":" credentials
    credentials          =  ("Digest" LWS digest-response)
                            / other-response

See also:

auth_mod_verify(), auth_mod_check(), auth_get_params(), auth_digest_response_get().

The parsed Proxy-Authorization header is stored in sip_proxy_authorization_t structure.

---

Define Documentation

#define SIP_PROXY_AUTHORIZATION_INIT

(

)

Initializer for structure sip_proxy_authorization_t.

A static sip_proxy_authorization_t structure for Proxy-Authorization header must be initialized with the SIP_PROXY_AUTHORIZATION_INIT() macro. For instance,

  sip_proxy_authorization_t sip_proxy_authorization = SIP_PROXY_AUTHORIZATION_INIT;

#define SIPTAG_PROXY_AUTHORIZATION

(

x

)

Tag list item for pointer to a Proxy-Authorization header structure sip_proxy_authorization_t.

The SIPTAG_PROXY_AUTHORIZATION() macro is used to include a tag item with a pointer to a sip_proxy_authorization_t structure in a tag list.

Parameters:

x

pointer to a sip_proxy_authorization_t structure, or NULL.

The corresponding tag taking reference parameter is SIPTAG_PROXY_AUTHORIZATION_REF().

#define SIPTAG_PROXY_AUTHORIZATION_STR

(

s

)

Tag list item for string with Proxy-Authorization header value.

The SIPTAG_PROXY_AUTHORIZATION_STR() macro is used to include a tag item with a string containing value of a sip_proxy_authorization_t header in a tag list.

Parameters:

s

pointer to a string containing Proxy-Authorization header value, or NULL.

The string in SIPTAG_PROXY_AUTHORIZATION_STR() can be converted to a sip_proxy_authorization_t header structure by giving the string s has second argument to function sip_proxy_authorization_make().

The corresponding tag taking reference parameter is SIPTAG_PROXY_AUTHORIZATION_STR_REF().

---

Typedef Documentation

typedef struct sip_proxy_authorization_s sip_proxy_authorization_t

The structure sip_proxy_authorization_t contains representation of SIP Proxy-Authorization header.

The sip_proxy_authorization_t is defined as follows:

 typedef struct msg_auth_s {
   msg_common_t       au_common[1];  // Common fragment info
   msg_auth_t        *au_next;       // Link to next header
   char const        *au_scheme;     // Auth-scheme like "Basic" or "Digest"
   msg_param_t const *au_params;     // Comma-separated parameters
 } sip_proxy_authorization_t;

---

Function Documentation

int sip_is_proxy_authorization

(

sip_header_t const *

header

)

[inline]

Test if header object is instance of sip_proxy_authorization_t.

Check if the header class is an instance of Proxy-Authorization header object and return true (nonzero), otherwise return false (zero).

Parameters:

header

pointer to the header structure to be tested

Return values:

	1	(true) if the header is an instance of header proxy_authorization
	0	(false) otherwise

sip_proxy_authorization_t * sip_proxy_authorization_copy	(	su_home_t *	home,
		sip_proxy_authorization_t const *	hdr
	)			[inline]

Copy a list of Proxy-Authorization header header structures sip_proxy_authorization_t.

The function sip_proxy_authorization_copy() copies a header structure hdr. If the header structure hdr contains a reference (hdr->h_next) to a list of headers, all the headers in that list are copied, too. The function uses given memory home to allocate all the memory areas used to copy the list of header structure hdr.

Parameters:

	home	memory home used to allocate new structure
	hdr	pointer to the header structure to be copied

When copying, only the header structure and parameter lists attached to it are duplicated. The new header structure retains all the references to the strings within the old hdr header, including the encoding of the old header, if present.

Example

   proxy_authorization = sip_proxy_authorization_copy(home, sip->sip_proxy_authorization);

Returns:

A pointer to newly copied header structure, or NULL upon an error.

sip_proxy_authorization_t * sip_proxy_authorization_dup	(	su_home_t *	home,
		sip_proxy_authorization_t const *	hdr
	)			[inline]

Duplicate a list of Proxy-Authorization header header structures sip_proxy_authorization_t.

Duplicate a header structure hdr. If the header structure hdr contains a reference (hdr->x_next) to a list of headers, all the headers in the list are duplicated, too.

Parameters:

	home	memory home used to allocate new structure
	hdr	header structure to be duplicated

When duplicating, all parameter lists and non-constant strings attached to the header are copied, too. The function uses given memory home to allocate all the memory areas used to copy the header.

Example

   proxy_authorization = sip_proxy_authorization_dup(home, sip->sip_proxy_authorization);

Returns:

A pointer to the newly duplicated sip_proxy_authorization_t header structure, or NULL upon an error.

sip_proxy_authorization_t * sip_proxy_authorization_format	(	su_home_t *	home,
		char const *	fmt,
			...
	)			[inline]

Make a Proxy-Authorization header from formatting result.

Make a new sip_proxy_authorization_t object using formatting result as its value. The function first prints the arguments according to the format fmt specified. Then it allocates a new header structure, and parses the formatting result to the structure sip_proxy_authorization_t.

Parameters:

	home	memory home used to allocate new header structure.
	fmt	string used as a printf()-style format
	...	argument list for format

Returns:

A pointer to newly makes header structure, or NULL upon an error.

sip_proxy_authorization_t* sip_proxy_authorization_init

(

sip_proxy_authorization_t

x[1]

)

[inline]

Initialize a structure sip_proxy_authorization_t.

An sip_proxy_authorization_t structure for Proxy-Authorization header can be initialized with the sip_proxy_authorization_init() function/macro. For instance,

  sip_proxy_authorization_t sip_proxy_authorization;

  sip_proxy_authorization_init(&sip_proxy_authorization);

sip_proxy_authorization_t * sip_proxy_authorization_make	(	su_home_t *	home,
		char const *	s
	)			[inline]

Make a Proxy-Authorization header structure sip_proxy_authorization_t.

The function sip_proxy_authorization_make() makes a new sip_proxy_authorization_t header structure. It allocates a new header structure, and decodes the string s as the value of the structure.

Parameters:

	home	memory home used to allocate new header structure.
	s	string to be decoded as value of the new header structure

Returns:

A pointer to newly maked sip_proxy_authorization_t header structure, or NULL upon an error.

---

Variable Documentation

msg_hclass_t sip_proxy_authorization_class[]

Header class for Proxy-Authorization header.

The header class sip_proxy_authorization_class defines how a SIP Proxy-Authorization header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_proxy_authorization_t header structure.