Collaboration diagram for Proxy-Authenticate Header:
![]() |
Its syntax is defined in [H14.33, S10.31] as follows:
Proxy-Authenticate = "Proxy-Authenticate" HCOLON challenge challenge = ("Digest" LWS digest-cln *(COMMA digest-cln)) / other-challenge other-challenge = auth-scheme LWS auth-param *(COMMA auth-param) digest-cln = realm / domain / nonce / opaque / stale / algorithm / qop-options / auth-param realm = "realm" EQUAL realm-value realm-value = quoted-string domain = "domain" EQUAL LDQUOT URI *( 1*SP URI ) RDQUOT URI = absoluteURI / abs-path nonce = "nonce" EQUAL nonce-value nonce-value = quoted-string opaque = "opaque" EQUAL quoted-string stale = "stale" EQUAL ( "true" / "false" ) algorithm = "algorithm" EQUAL ( "MD5" / "MD5-sess" / token ) qop-options = "qop" EQUAL LDQUOT qop-value *("," qop-value) RDQUOT qop-value = "auth" / "auth-int" / token
Defines | |
#define | sip_proxy_authenticate(sip) |
Access a sip_proxy_authenticate_t from sip_t. | |
#define | SIP_PROXY_AUTHENTICATE_INIT() |
Initializer for structure sip_proxy_authenticate_t. | |
#define | SIPTAG_PROXY_AUTHENTICATE(x) |
Tag list item for pointer to a Proxy-Authenticate header structure. | |
#define | SIPTAG_PROXY_AUTHENTICATE_REF(x) |
Tag list item for reference to a a Proxy-Authenticate header pointer. | |
#define | SIPTAG_PROXY_AUTHENTICATE_STR(s) |
Tag list item for string with Proxy-Authenticate header value. | |
#define | SIPTAG_PROXY_AUTHENTICATE_STR_REF(x) |
Tag list item for reference to a a Proxy-Authenticate header string. | |
Enumerator | |
sip_proxy_authenticate_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_proxy_authenticate_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Proxy-Authenticate header. | |
SOFIAPUBFUN int | sip_proxy_authenticate_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Proxy-Authenticate header. | |
sip_proxy_authenticate_t * | sip_proxy_authenticate_init (sip_proxy_authenticate_t x[1]) |
Initialize a structure sip_proxy_authenticate_t. | |
int | sip_is_proxy_authenticate (sip_header_t const *header) |
Test if header object is instance of sip_proxy_authenticate_t. | |
sip_proxy_authenticate_t * | sip_proxy_authenticate_dup (su_home_t *home, sip_proxy_authenticate_t const *hdr)) |
Duplicate (deep copy) sip_proxy_authenticate_t . | |
sip_proxy_authenticate_t * | sip_proxy_authenticate_copy (su_home_t *home, sip_proxy_authenticate_t const *hdr)) |
Copy a sip_proxy_authenticate_t header structure. | |
sip_proxy_authenticate_t * | sip_proxy_authenticate_make (su_home_t *home, char const *s)) |
Make a header structure sip_proxy_authenticate_t. | |
sip_proxy_authenticate_t * | sip_proxy_authenticate_format (su_home_t *home, char const *fmt,...))) |
Make a Proxy-Authenticate header from formatting result. | |
Variables | |
tag_typedef_t | siptag_proxy_authenticate |
Tag for Proxy-Authenticate header object. | |
tag_typedef_t | siptag_proxy_authenticate_str |
Tag for string with Proxy-Authenticate header value. | |
msg_hclass_t | sip_proxy_authenticate_class [] |
Header class for SIP Proxy-Authenticate header. |
#define SIP_PROXY_AUTHENTICATE_INIT | ( | ) |
Initializer for structure sip_proxy_authenticate_t.
A static sip_proxy_authenticate_t structure must be initialized. The SIP_PROXY_AUTHENTICATE_INIT() macro provides initialization value. For instance,
sip_proxy_authenticate_t sip_proxy_authenticate = SIP_PROXY_AUTHENTICATE_INIT;
#define SIPTAG_PROXY_AUTHENTICATE | ( | x | ) |
Tag list item for pointer to a Proxy-Authenticate header structure.
The SIPTAG_PROXY_AUTHENTICATE() macro is used to include a tag item with a pointer to a sip_proxy_authenticate_t object in a tag list.
x | pointer to a sip_proxy_authenticate_t header structure, or NULL. |
#define SIPTAG_PROXY_AUTHENTICATE_STR | ( | s | ) |
Tag list item for string with Proxy-Authenticate header value.
The SIPTAG_PROXY_AUTHENTICATE_STR() macro is used to include a tag item with a string containing value of a sip_proxy_authenticate_t header in a tag list.
s | pointer to a string containing sip_proxy_authenticate_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_PROXY_AUTHENTICATE_STR_REF().
sip_proxy_authenticate_hash |
@
Hash of Proxy-Authenticate header.
int sip_is_proxy_authenticate | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_proxy_authenticate_t.
The function sip_is_proxy_authenticate() returns true (nonzero) if the header class is an instance of Proxy-Authenticate header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
sip_proxy_authenticate_t * sip_proxy_authenticate_copy | ( | su_home_t * | home, | |
sip_proxy_authenticate_t const * | hdr | |||
) | [inline] |
Copy a sip_proxy_authenticate_t header structure.
The function sip_proxy_authenticate_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 header structure hdr.
home | memory home used to allocate new structure | |
hdr | pointer to the header structure to be copied |
proxy_authenticate = sip_proxy_authenticate_copy(home, sip->sip_proxy_authenticate);
sip_proxy_authenticate_t * sip_proxy_authenticate_dup | ( | su_home_t * | home, | |
sip_proxy_authenticate_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_proxy_authenticate_t
.
The function sip_proxy_authenticate_dup() duplicates 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.
home | memory home used to allocate new structure | |
hdr | header structure to be duplicated |
proxy_authenticate = sip_proxy_authenticate_dup(home, sip->sip_proxy_authenticate);
sip_proxy_authenticate_t * sip_proxy_authenticate_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Proxy-Authenticate header from formatting result.
The function sip_proxy_authenticate_format() makes a new Proxy-Authenticate header 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 uses the formatting result as the header value.
home | memory home used to allocate new header structure. | |
fmt | string used as a printf()-style format | |
... | argument list for format |
sip_proxy_authenticate_t* sip_proxy_authenticate_init | ( | sip_proxy_authenticate_t | x[1] | ) | [inline] |
Initialize a structure sip_proxy_authenticate_t.
An sip_proxy_authenticate_t structure can be initialized with the sip_proxy_authenticate_init() function/macro. For instance,
sip_proxy_authenticate_t sip_proxy_authenticate; sip_proxy_authenticate_init(&sip_proxy_authenticate);
sip_proxy_authenticate_t * sip_proxy_authenticate_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_proxy_authenticate_t.
The function sip_proxy_authenticate_make() makes a new sip_proxy_authenticate_t header structure. It allocates a new header structure, and decodes the string s as the value of the structure.
home | memory home used to allocate new header structure. | |
s | string to be decoded as value of the new header structure |
Header class for SIP Proxy-Authenticate header.
The header class sip_proxy_authenticate_class defines how a SIP Proxy-Authenticate header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_proxy_authenticate_t header structure.