Filter
Top Products
542 Dialogic
®
Global Call API Library Reference — November 2007
Dialogic Corporation
IP_AUTHENTICATION — SIP digest authentication data
IP_AUTHENTICATION
SIP digest authentication data
typedef struct
{
unsigned short version;
char* realm;
char* identity;
char* username;
char* password;
} IP_AUTHENTICATION;
Description
The IP_AUTHENTICATION data structure is used when setting or removing SIP authentication
quadruplets.
Applications should use the INIT_IP_AUTHENTICATION( ) function to initialize the structure
with the correct version number and void pointers for each of the strings before setting the
appropriate values.
Field Descriptions
The fields of the IP_AUTHENTICATION data structure are described as follows:
version
The version number of the data structure. The correct value is set by the
INIT_IP_AUTHENTICATION( ) initialization function and should not be overridden.
realm
A null-terminated string that defines the protected domain. This string is case-insensitive and
must always be supplied.
identity
A null-terminated string that allows applications to optionally specify different username/
password pairs for different identities in the same realm. The identity is a URI and must
conform to URI syntax, including starting with the scheme (namely “sip:” or “sips:”). If only
one username and password applies to a given realm or if setting a default username and
password for a multi-identity realm, use an empty string ("") for this field. This field is case-
insensitive.
username
A null-terminated string providing the user’s name in the specified realm. This field is case-
sensitive. This field must always contain a non-empty string when the structure is associated
with an IPPARM_AUTHENTICATION_CONFIGURE parameter. This field is ignored when
the structure is associated with an IPPARM_AUTHENTICATION_REMOVE parameter.
password
A null-terminated string providing password associated with the user’s name in the specified
realm. This field is case-sensitive. This field is ignored when the structure is associated with an
IPPARM_AUTHENTICATION_REMOVE parameter.