Collaboration diagram for Authorization Header:
![]() |
Its syntax is defined in [RFC2617, S19] as follows:
Authorization = "Authorization" HCOLON credentials credentials = ("Digest" LWS digest-response) / other-response digest-response = dig-resp *(COMMA dig-resp) dig-resp = username / realm / nonce / digest-uri / dresponse / algorithm / cnonce / opaque / message-qop / nonce-count / auth-param username = "username" EQUAL username-value username-value = quoted-string digest-uri = "uri" EQUAL LDQUOT digest-uri-value RDQUOT digest-uri-value = rquest-uri ; Equal to request-uri as specified by HTTP/1.1 message-qop = "qop" EQUAL qop-value cnonce = "cnonce" EQUAL cnonce-value cnonce-value = nonce-value nonce-count = "nc" EQUAL nc-value nc-value = 8LHEX dresponse = "response" EQUAL request-digest request-digest = LDQUOT 32LHEX RDQUOT auth-param = auth-param-name EQUAL ( token / quoted-string ) auth-param-name = token other-response = auth-scheme LWS auth-param *(COMMA auth-param) auth-scheme = token
Defines | |
#define | sip_authorization(sip) |
Access a sip_authorization_t from sip_t. | |
#define | SIP_AUTHORIZATION_INIT() |
Initializer for structure sip_authorization_t. | |
#define | SIPTAG_AUTHORIZATION(x) |
Tag list item for pointer to a Authorization header structure. | |
#define | SIPTAG_AUTHORIZATION_REF(x) |
Tag list item for reference to a a Authorization header pointer. | |
#define | SIPTAG_AUTHORIZATION_STR(s) |
Tag list item for string with Authorization header value. | |
#define | SIPTAG_AUTHORIZATION_STR_REF(x) |
Tag list item for reference to a a Authorization header string. | |
Enumerator | |
sip_authorization_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_authorization_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Authorization header. | |
SOFIAPUBFUN int | sip_authorization_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Authorization header. | |
sip_authorization_t * | sip_authorization_init (sip_authorization_t x[1]) |
Initialize a structure sip_authorization_t. | |
int | sip_is_authorization (sip_header_t const *header) |
Test if header object is instance of sip_authorization_t. | |
sip_authorization_t * | sip_authorization_dup (su_home_t *home, sip_authorization_t const *hdr)) |
Duplicate (deep copy) sip_authorization_t . | |
sip_authorization_t * | sip_authorization_copy (su_home_t *home, sip_authorization_t const *hdr)) |
Copy a sip_authorization_t header structure. | |
sip_authorization_t * | sip_authorization_make (su_home_t *home, char const *s)) |
Make a header structure sip_authorization_t. | |
sip_authorization_t * | sip_authorization_format (su_home_t *home, char const *fmt,...))) |
Make a Authorization header from formatting result. | |
Variables | |
tag_typedef_t | siptag_authorization |
Tag for Authorization header object. | |
tag_typedef_t | siptag_authorization_str |
Tag for string with Authorization header value. | |
msg_hclass_t | sip_authorization_class [] |
Header class for SIP Authorization header. |
#define SIP_AUTHORIZATION_INIT | ( | ) |
Initializer for structure sip_authorization_t.
A static sip_authorization_t structure must be initialized. The SIP_AUTHORIZATION_INIT() macro provides initialization value. For instance,
sip_authorization_t sip_authorization = SIP_AUTHORIZATION_INIT;
#define SIPTAG_AUTHORIZATION | ( | x | ) |
Tag list item for pointer to a Authorization header structure.
The SIPTAG_AUTHORIZATION() macro is used to include a tag item with a pointer to a sip_authorization_t object in a tag list.
x | pointer to a sip_authorization_t header structure, or NULL. |
#define SIPTAG_AUTHORIZATION_STR | ( | s | ) |
Tag list item for string with Authorization header value.
The SIPTAG_AUTHORIZATION_STR() macro is used to include a tag item with a string containing value of a sip_authorization_t header in a tag list.
s | pointer to a string containing sip_authorization_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_AUTHORIZATION_STR_REF().
sip_authorization_hash |
@
Hash of Authorization header.
sip_authorization_t * sip_authorization_copy | ( | su_home_t * | home, | |
sip_authorization_t const * | hdr | |||
) | [inline] |
Copy a sip_authorization_t header structure.
The function sip_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 header structure hdr.
home | memory home used to allocate new structure | |
hdr | pointer to the header structure to be copied |
authorization = sip_authorization_copy(home, sip->sip_authorization);
sip_authorization_t * sip_authorization_dup | ( | su_home_t * | home, | |
sip_authorization_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_authorization_t
.
The function sip_authorization_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 |
authorization = sip_authorization_dup(home, sip->sip_authorization);
sip_authorization_t * sip_authorization_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Authorization header from formatting result.
The function sip_authorization_format() makes a new Authorization 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_authorization_t* sip_authorization_init | ( | sip_authorization_t | x[1] | ) | [inline] |
Initialize a structure sip_authorization_t.
An sip_authorization_t structure can be initialized with the sip_authorization_init() function/macro. For instance,
sip_authorization_t sip_authorization; sip_authorization_init(&sip_authorization);
sip_authorization_t * sip_authorization_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_authorization_t.
The function sip_authorization_make() makes a new sip_authorization_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 |
int sip_is_authorization | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_authorization_t.
The function sip_is_authorization() returns true (nonzero) if the header class is an instance of Authorization header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
Header class for SIP Authorization header.
The header class sip_authorization_class defines how a SIP Authorization header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_authorization_t header structure.