Collaboration diagram for Security-Client Header:
![]() |
security-client = "Security-Client" HCOLON sec-mechanism *(COMMA sec-mechanism) security-server = "Security-Server" HCOLON sec-mechanism *(COMMA sec-mechanism) security-verify = "Security-Verify" HCOLON sec-mechanism *(COMMA sec-mechanism) sec-mechanism = mechanism-name *(SEMI mech-parameters) mechanism-name = ( "digest" / "tls" / "ipsec-ike" / "ipsec-man" / token ) mech-parameters = ( preference / digest-algorithm / digest-qop / digest-verify / extension ) preference = "q" EQUAL qvalue qvalue = ( "0" [ "." 0*3DIGIT ] ) / ( "1" [ "." 0*3("0") ] ) digest-algorithm = "d-alg" EQUAL token digest-qop = "d-qop" EQUAL token digest-verify = "d-ver" EQUAL LDQUOT 32LHEX RDQUOT extension = generic-param
Data Structures | |
struct | sip_security_agree_s |
Structure for Security-Client, Security-Server, and Security-Verify headers. More... | |
Defines | |
#define | sip_security_client(sip) |
Access a sip_security_client_t from sip_t. | |
#define | SIP_SECURITY_CLIENT_INIT() |
Initializer for structure sip_security_client_t. | |
#define | SIPTAG_SECURITY_CLIENT(x) |
Tag list item for pointer to a Security-Client header structure. | |
#define | SIPTAG_SECURITY_CLIENT_REF(x) |
Tag list item for reference to a a Security-Client header pointer. | |
#define | SIPTAG_SECURITY_CLIENT_STR(s) |
Tag list item for string with Security-Client header value. | |
#define | SIPTAG_SECURITY_CLIENT_STR_REF(x) |
Tag list item for reference to a a Security-Client header string. | |
Enumerator | |
sip_security_client_hash | |
@ | |
Functions | |
SOFIAPUBFUN int | sip_security_client_d (su_home_t *, msg_header_t *, char *s, int slen) |
Parse a Security-Client header. | |
SOFIAPUBFUN int | sip_security_client_e (char b[], int bsiz, msg_header_t const *h, int flags) |
Print a Security-Client header. | |
sip_security_client_t * | sip_security_client_init (sip_security_client_t x[1]) |
Initialize a structure sip_security_client_t. | |
int | sip_is_security_client (sip_header_t const *header) |
Test if header object is instance of sip_security_client_t. | |
sip_security_client_t * | sip_security_client_dup (su_home_t *home, sip_security_client_t const *hdr)) |
Duplicate (deep copy) sip_security_client_t . | |
sip_security_client_t * | sip_security_client_copy (su_home_t *home, sip_security_client_t const *hdr)) |
Copy a sip_security_client_t header structure. | |
sip_security_client_t * | sip_security_client_make (su_home_t *home, char const *s)) |
Make a header structure sip_security_client_t. | |
sip_security_client_t * | sip_security_client_format (su_home_t *home, char const *fmt,...))) |
Make a Security-Client header from formatting result. | |
Variables | |
tag_typedef_t | siptag_security_client |
Tag for Security-Client header object. | |
tag_typedef_t | siptag_security_client_str |
Tag for string with Security-Client header value. | |
msg_hclass_t | sip_security_client_class [] |
Header class for SIP Security-Client header. |
#define SIP_SECURITY_CLIENT_INIT | ( | ) |
Initializer for structure sip_security_client_t.
A static sip_security_client_t structure must be initialized. The SIP_SECURITY_CLIENT_INIT() macro provides initialization value. For instance,
#define SIPTAG_SECURITY_CLIENT | ( | x | ) |
Tag list item for pointer to a Security-Client header structure.
The SIPTAG_SECURITY_CLIENT() macro is used to include a tag item with a pointer to a sip_security_client_t object in a tag list.
x | pointer to a sip_security_client_t header structure, or NULL. |
#define SIPTAG_SECURITY_CLIENT_STR | ( | s | ) |
Tag list item for string with Security-Client header value.
The SIPTAG_SECURITY_CLIENT_STR() macro is used to include a tag item with a string containing value of a sip_security_client_t header in a tag list.
s | pointer to a string containing sip_security_client_t value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_SECURITY_CLIENT_STR_REF().
sip_security_client_hash |
@
Hash of Security-Client header.
int sip_is_security_client | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_security_client_t.
The function sip_is_security_client() returns true (nonzero) if the header class is an instance of Security-Client header object and false (zero) otherwise.
header | pointer to the header structure to be tested |
sip_security_client_t * sip_security_client_copy | ( | su_home_t * | home, | |
sip_security_client_t const * | hdr | |||
) | [inline] |
Copy a sip_security_client_t header structure.
The function sip_security_client_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 |
security_client = sip_security_client_copy(home, sip->sip_security_client);
sip_security_client_t * sip_security_client_dup | ( | su_home_t * | home, | |
sip_security_client_t const * | hdr | |||
) | [inline] |
Duplicate (deep copy) sip_security_client_t
.
The function sip_security_client_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 |
security_client = sip_security_client_dup(home, sip->sip_security_client);
sip_security_client_t * sip_security_client_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Security-Client header from formatting result.
The function sip_security_client_format() makes a new Security-Client 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_security_client_t* sip_security_client_init | ( | sip_security_client_t | x[1] | ) | [inline] |
Initialize a structure sip_security_client_t.
An sip_security_client_t structure can be initialized with the sip_security_client_init() function/macro. For instance,
sip_security_client_t * sip_security_client_make | ( | su_home_t * | home, | |
char const * | s | |||
) | [inline] |
Make a header structure sip_security_client_t.
The function sip_security_client_make() makes a new sip_security_client_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 Security-Client header.
The header class sip_security_client_class defines how a SIP Security-Client header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_security_client_t header structure.