sip  1.13.16
Data Structures | Macros | Typedefs | Enumerator | Functions | Variables
Sip_identity

Data Structures

struct  sip_identity_s
 Structure for @Identity SIP header. More...
 

Macros

#define sip_identity(sip)
 Access a SIP Identity header structure sip_identity_t from sip_t.
 
#define SIP_IDENTITY_INIT()
 Initializer for structure sip_identity_t. More...
 
#define SIPTAG_IDENTITY(x)
 Tag list item for pointer to a Identity header structure sip_identity_t. More...
 
#define SIPTAG_IDENTITY_REF(x)
 Tag list item for reference to a Identity header pointer.
 
#define SIPTAG_IDENTITY_STR(s)
 Tag list item for string with Identity header value. More...
 
#define SIPTAG_IDENTITY_STR_REF(x)
 Tag list item for reference to a Identity header string.
 

Typedefs

typedef struct sip_identity_s sip_identity_t
 @ More...
 

Functions

issize_t sip_identity_d (su_home_t *, msg_header_t *, char *s, isize_t slen)
 Parse a SIP Identity header.
 
issize_t sip_identity_e (char b[], isize_t bsiz, msg_header_t const *h, int flags)
 Print a SIP Identity header.
 
sip_identity_tsip_identity_init (sip_identity_t x[1])
 Initialize a structure sip_identity_t. More...
 
int sip_is_identity (sip_header_t const *header)
 Test if header object is instance of sip_identity_t. More...
 
sip_identity_tsip_identity_dup (su_home_t *home, sip_identity_t const *hdr))
 Duplicate a list of Identity header header structures sip_identity_t. More...
 
sip_identity_tsip_identity_copy (su_home_t *home, sip_identity_t const *hdr))
 Copy a list of Identity header header structures sip_identity_t. More...
 
sip_identity_tsip_identity_make (su_home_t *home, char const *s))
 Make a Identity header structure sip_identity_t. More...
 
sip_identity_tsip_identity_format (su_home_t *home, char const *fmt,...)))
 Make a Identity header from formatting result. More...
 

Variables

msg_hclass_t sip_identity_class []
 Header class for Identity header. More...
 
tag_typedef_t siptag_identity
 Tag for Identity header object.
 
tag_typedef_t siptag_identity_str
 Tag for string with Identity header value.
 

Detailed Description

Macro Definition Documentation

◆ SIP_IDENTITY_INIT

#define SIP_IDENTITY_INIT ( )

Initializer for structure sip_identity_t.

A static sip_identity_t structure for Identity header must be initialized with the SIP_IDENTITY_INIT() macro. For instance,

#define SIP_IDENTITY_INIT()
Initializer for structure sip_identity_t.
Definition: sip_protos.h:2766
#define sip_identity(sip)
Access a SIP Identity header structure sip_identity_t from sip_t.
Definition: sip_protos.h:2749
Structure for @Identity SIP header.
Definition: sip.h:485

◆ SIPTAG_IDENTITY

#define SIPTAG_IDENTITY (   x)

Tag list item for pointer to a Identity header structure sip_identity_t.

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

Parameters
xpointer to a sip_identity_t structure, or NULL.

The corresponding tag taking reference parameter is SIPTAG_IDENTITY_REF().

◆ SIPTAG_IDENTITY_STR

#define SIPTAG_IDENTITY_STR (   s)

Tag list item for string with Identity header value.

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

Parameters
spointer to a string containing Identity header value, or NULL.

The string in SIPTAG_IDENTITY_STR() can be converted to a sip_identity_t header structure by giving the string s has second argument to function sip_identity_make().

The corresponding tag taking reference parameter is SIPTAG_IDENTITY_STR_REF().

Typedef Documentation

◆ sip_identity_t

@

The Identity header field specifies the "logical" recipient of the request. It is defined in @RFC8224 with semantics shown below, though for now it's parsed to a single 'value' field.

Identity = "Identity" HCOLON signed-identity-digest SEMI
ident-info *( SEMI ident-info-params )
signed-identity-digest = 1*(base64-char / ".")
ident-info = "info" EQUAL ident-info-uri
ident-info-uri = LAQUOT absoluteURI RAQUOT
ident-info-params = ident-info-alg / ident-type /
ident-info-extension
ident-info-alg = "alg" EQUAL token
ident-type = "ppt" EQUAL token
ident-info-extension = generic-param
base64-char = ALPHA / DIGIT / "/" / "+"

The parsed Identity header is stored in sip_identity_t structure.

The structure sip_identity_t contains representation of @Identity header.

The sip_identity_t is defined as follows:

typedef struct {
sip_common_t id_common[1]; // Common fragment info
sip_identity_t *id_next; // Link to next Identity
char const *id_value; // Identity
char const *id_info; // Info param containing URL of the cert, with no '<','>'
char const *id_signed_identity_digest; // Digest
char const *id_info_alg; // Field containing alg of the cert
char const *id_info_ppt; // Field containing PASSporT Type
msg_param_t const *id_info_params; // Field containing extensions
struct sip_identity_s sip_identity_t
@
Definition: sip.h:219

Function Documentation

◆ sip_identity_copy()

sip_identity_t * sip_identity_copy ( su_home_t home,
sip_identity_t const *  hdr 
)
inline

Copy a list of Identity header header structures sip_identity_t.

The function sip_identity_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
homememory home used to allocate new structure
hdrpointer 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
identity = sip_identity_copy(home, sip->sip_identity);
sip_identity_t * sip_identity_copy(su_home_t *home, sip_identity_t const *hdr))
Copy a list of Identity header header structures sip_identity_t.
Definition: sip_protos.h:2896
Returns
A pointer to newly copied header structure, or NULL upon an error.

◆ sip_identity_dup()

sip_identity_t * sip_identity_dup ( su_home_t home,
sip_identity_t const *  hdr 
)
inline

Duplicate a list of Identity header header structures sip_identity_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
homememory home used to allocate new structure
hdrheader 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
identity = sip_identity_dup(home, sip->sip_identity);
sip_identity_t * sip_identity_dup(su_home_t *home, sip_identity_t const *hdr))
Duplicate a list of Identity header header structures sip_identity_t.
Definition: sip_protos.h:2853
Returns
A pointer to the newly duplicated sip_identity_t header structure, or NULL upon an error.

◆ sip_identity_format()

sip_identity_t * sip_identity_format ( su_home_t home,
char const *  fmt,
  ... 
)
inline

Make a Identity header from formatting result.

Make a new sip_identity_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_identity_t.

Parameters
homememory home used to allocate new header structure.
fmtstring used as a printf()-style format
...argument list for format
Returns
A pointer to newly makes header structure, or NULL upon an error.

◆ sip_identity_init()

sip_identity_t* sip_identity_init ( sip_identity_t  x[1])
inline

Initialize a structure sip_identity_t.

An sip_identity_t structure for Identity header can be initialized with the sip_identity_init() function/macro. For instance,

sip_identity_t * sip_identity_init(sip_identity_t x[1])
Initialize a structure sip_identity_t.
Definition: sip_protos.h:2784

◆ sip_identity_make()

sip_identity_t * sip_identity_make ( su_home_t home,
char const *  s 
)
inline

Make a Identity header structure sip_identity_t.

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

Parameters
homememory home used to allocate new header structure.
sstring to be decoded as value of the new header structure
Returns
A pointer to newly maked sip_identity_t header structure, or NULL upon an error.

◆ sip_is_identity()

int sip_is_identity ( sip_header_t const *  header)
inline

Test if header object is instance of sip_identity_t.

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

Parameters
headerpointer to the header structure to be tested
Return values
1(true) if the header is an instance of header identity
0(false) otherwise

Variable Documentation

◆ sip_identity_class

msg_hclass_t sip_identity_class[]
extern

Header class for Identity header.

The header class sip_identity_class defines how a SIP Identity header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_identity_t header structure.


Sofia-SIP 1.13.16 - Copyright (C) 2006 Nokia Corporation. All rights reserved. Licensed under the terms of the GNU Lesser General Public License.