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
#define SIP_SECURITY_CLIENT_INIT | ( | ) |
Initializer for structure sip_security_client_t.
A static sip_security_client_t structure for Security-Client header must be initialized with the SIP_SECURITY_CLIENT_INIT() macro. For instance,
#define SIPTAG_SECURITY_CLIENT | ( | x | ) |
Tag list item for pointer to a Security-Client header structure sip_security_client_t.
The SIPTAG_SECURITY_CLIENT() macro is used to include a tag item with a pointer to a sip_security_client_t structure in a tag list.
x | pointer to a sip_security_client_t 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 Security-Client header value, or NULL. |
The corresponding tag taking reference parameter is SIPTAG_SECURITY_CLIENT_STR_REF().
typedef struct sip_security_client_s sip_security_client_t |
The structure sip_security_client_t contains representation of SIP Security-Client header.
The sip_security_client_t is defined as follows:
typedef struct sip_security_agree_s { sip_common_t sa_common[1]; // Common fragment info sip_security_client_t *sa_next; // Link to next mechanism char const *sa_mec; // Security mechanism msg_param_t const *sa_params; // List of mechanism parameters char const *sa_q; // Value of q (preference) parameter char const *sa_d_alg; // Value of d-alg parameter char const *sa_d_qop; // Value of d-qop parameter char const *sa_d_ver; // Value of d-ver parameter } sip_security_client_t;
int sip_is_security_client | ( | sip_header_t const * | header | ) | [inline] |
Test if header object is instance of sip_security_client_t.
Check if the header class is an instance of Security-Client header object and return true (nonzero), otherwise return false (zero).
header | pointer to the header structure to be tested |
1 | (true) if the header is an instance of header security_client | |
0 | (false) otherwise |
sip_security_client_t * sip_security_client_copy | ( | su_home_t * | home, | |
sip_security_client_t const * | hdr | |||
) | [inline] |
Copy a list of Security-Client header header structures sip_security_client_t.
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 list of 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);
issize_t sip_security_client_d | ( | su_home_t * | , | |
msg_header_t * | , | |||
char * | s, | |||
isize_t | slen | |||
) |
Parse a SIP Security-Client header.
sip_security_client_t * sip_security_client_dup | ( | su_home_t * | home, | |
sip_security_client_t const * | hdr | |||
) | [inline] |
Duplicate a list of Security-Client header header structures sip_security_client_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.
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);
issize_t sip_security_client_e | ( | char | b[], | |
isize_t | bsiz, | |||
msg_header_t const * | h, | |||
int | flags | |||
) |
Print a SIP Security-Client header.
sip_security_client_t * sip_security_client_format | ( | su_home_t * | home, | |
char const * | fmt, | |||
... | ||||
) | [inline] |
Make a Security-Client header from formatting result.
Make a new sip_security_client_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_security_client_t.
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 for Security-Client header 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 Security-Client 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 |
msg_hclass_t sip_security_client_class[] |
Header class for 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.