Authentication-Info Header
[SIP Headers]

Collaboration diagram for Authentication-Info Header:


Detailed Description

The Authentication-Info header contains either a next-nonce used by next request and/or authentication from server used in mutual authentication.

The syntax of Authentication-Info header is defined in RFC 2617 and [S20.6] as follows:

   Authentication-Info  = "Authentication-Info" HCOLON ainfo
                           *(COMMA ainfo)
   ainfo                =  nextnonce / message-qop
                            / response-auth / cnonce
                            / nonce-count
   nextnonce            =  "nextnonce" EQUAL nonce-value
   response-auth        =  "rspauth" EQUAL response-digest
   response-digest      =  LDQUOT *LHEX RDQUOT


Data Structures

struct  sip_authentication_info_s
 Structure for Authentication-Info header. More...

Defines

#define sip_authentication_info(sip)
 Access a sip_authentication_info_t from sip_t.
#define SIP_AUTHENTICATION_INFO_INIT()
 Initializer for structure sip_authentication_info_t.
#define SIPTAG_AUTHENTICATION_INFO(x)
 Tag list item for pointer to a Authentication-Info header structure.
#define SIPTAG_AUTHENTICATION_INFO_REF(x)
 Tag list item for reference to a a Authentication-Info header pointer.
#define SIPTAG_AUTHENTICATION_INFO_STR(s)
 Tag list item for string with Authentication-Info header value.
#define SIPTAG_AUTHENTICATION_INFO_STR_REF(x)
 Tag list item for reference to a a Authentication-Info header string.

Enumerator

 sip_authentication_info_hash
 @

Hash of Authentication-Info header.


Functions

SOFIAPUBFUN int sip_authentication_info_d (su_home_t *, msg_header_t *, char *s, int slen)
 Parse a Authentication-Info header.
SOFIAPUBFUN int sip_authentication_info_e (char b[], int bsiz, msg_header_t const *h, int flags)
 Print a Authentication-Info header.
sip_authentication_info_tsip_authentication_info_init (sip_authentication_info_t x[1])
 Initialize a structure sip_authentication_info_t.
int sip_is_authentication_info (sip_header_t const *header)
 Test if header object is instance of sip_authentication_info_t.
sip_authentication_info_tsip_authentication_info_dup (su_home_t *home, sip_authentication_info_t const *hdr))
 Duplicate (deep copy) sip_authentication_info_t.
sip_authentication_info_tsip_authentication_info_copy (su_home_t *home, sip_authentication_info_t const *hdr))
 Copy a sip_authentication_info_t header structure.
sip_authentication_info_tsip_authentication_info_make (su_home_t *home, char const *s))
 Make a header structure sip_authentication_info_t.
sip_authentication_info_tsip_authentication_info_format (su_home_t *home, char const *fmt,...)))
 Make a Authentication-Info header from formatting result.

Variables

tag_typedef_t siptag_authentication_info
 Tag for Authentication-Info header object.
tag_typedef_t siptag_authentication_info_str
 Tag for string with Authentication-Info header value.
msg_hclass_t sip_authentication_info_class []
 Header class for SIP Authentication-Info header.


Define Documentation

 
#define SIP_AUTHENTICATION_INFO_INIT (  ) 

Initializer for structure sip_authentication_info_t.

A static sip_authentication_info_t structure must be initialized. The SIP_AUTHENTICATION_INFO_INIT() macro provides initialization value. For instance,

#define SIPTAG_AUTHENTICATION_INFO (  ) 

Tag list item for pointer to a Authentication-Info header structure.

The SIPTAG_AUTHENTICATION_INFO() macro is used to include a tag item with a pointer to a sip_authentication_info_t object in a tag list.

Parameters:
x pointer to a sip_authentication_info_t header structure, or NULL.
The corresponding tag taking reference parameter is SIPTAG_AUTHENTICATION_INFO_REF().

#define SIPTAG_AUTHENTICATION_INFO_STR (  ) 

Tag list item for string with Authentication-Info header value.

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

Parameters:
s pointer to a string containing sip_authentication_info_t value, or NULL.
The string in SIPTAG_AUTHENTICATION_INFO_STR() can be converted to a sip_authentication_info_t header structure by giving the string s has second argument to function sip_authentication_info_make().

The corresponding tag taking reference parameter is SIPTAG_AUTHENTICATION_INFO_STR_REF().


Enumerator Documentation

sip_authentication_info_hash

@

Hash of Authentication-Info header.


Function Documentation

sip_authentication_info_t * sip_authentication_info_copy ( su_home_t home,
sip_authentication_info_t const *  hdr 
) [inline]

Copy a sip_authentication_info_t header structure.

The function sip_authentication_info_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.

Parameters:
home memory home used to allocate new structure
hdr pointer 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
   authentication_info = sip_authentication_info_copy(home, sip->sip_authentication_info);
Returns:
The function sip_authentication_info_copy() returns a pointer to newly copied header structure, or NULL upon an error.

sip_authentication_info_t * sip_authentication_info_dup ( su_home_t home,
sip_authentication_info_t const *  hdr 
) [inline]

Duplicate (deep copy) sip_authentication_info_t.

The function sip_authentication_info_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.

Parameters:
home memory home used to allocate new structure
hdr header 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
   authentication_info = sip_authentication_info_dup(home, sip->sip_authentication_info);
Returns:
The function sip_authentication_info_dup() returns a pointer to the newly duplicated sip_authentication_info_t header structure, or NULL upon an error.

sip_authentication_info_t * sip_authentication_info_format ( su_home_t home,
char const *  fmt,
  ... 
) [inline]

Make a Authentication-Info header from formatting result.

The function sip_authentication_info_format() makes a new Authentication-Info 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.

Parameters:
home memory home used to allocate new header structure.
fmt string used as a printf()-style format
... argument list for format
Note:
This function is usually implemented as a macro calling msg_header_format().
Returns:
The function sip_authentication_info_format() returns a pointer to newly makes header structure, or NULL upon an error.

sip_authentication_info_t* sip_authentication_info_init ( sip_authentication_info_t  x[1]  )  [inline]

Initialize a structure sip_authentication_info_t.

An sip_authentication_info_t structure can be initialized with the sip_authentication_info_init() function/macro. For instance,

sip_authentication_info_t * sip_authentication_info_make ( su_home_t home,
char const *  s 
) [inline]

Make a header structure sip_authentication_info_t.

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

Parameters:
home memory home used to allocate new header structure.
s string to be decoded as value of the new header structure
Note:
This function is usually implemented as a macro calling sip_header_make().
Returns:
The function sip_authentication_info_make() returns a pointer to newly maked sip_authentication_info_t header structure, or NULL upon an error.

int sip_is_authentication_info ( sip_header_t const *  header  )  [inline]

Test if header object is instance of sip_authentication_info_t.

The function sip_is_authentication_info() returns true (nonzero) if the header class is an instance of Authentication-Info header object and false (zero) otherwise.

Parameters:
header pointer to the header structure to be tested
Returns:
The function sip_is_authentication_info() returns true (nonzero) if the header object is an instance of header authentication_info and false (zero) otherwise.


Variable Documentation

msg_hclass_t sip_authentication_info_class[]

Header class for SIP Authentication-Info header.

The header class sip_authentication_info_class defines how a SIP Authentication-Info header is parsed and printed. It also contains methods used by SIP parser and other functions to manipulate the sip_authentication_info_t header structure.


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