Filter
Top Products
Dialogic
®
Global Call IP Technology Guide — November 2007 421
Dialogic Corporation
set IP authentication information — gc_SetAuthenticationInfo( )
gc_SetAuthenticationInfo( )
set IP authentication information
Description
The gc_SetAuthenticationInfo( ) function is used to configure or remove authentication
information on an IPT virtual board. This is the only Global Call function that can be used to set
this information; the generic Global Call functions gc_SetConfigData( ) and gc_SetUserInfo( )
functions cannot be used for this IP-specific configuration operation.
This function should be called before using any Global Call function that sends a SIP request
which may provoke a 401/407 response. A 401/407 response to any SIP request that was sent
before authentication is configured causes the request to be terminated (with the reason code
IPEC_SIPReasonStatus401Unauthorized or IPEC_SIPReasonStatus407ProxyAuthenticationRequired
),
and Global Call will not attempt to re-send the request.
To add a new authentication quadruplet of {realm, identity, username, password} to the Global Call
database, or to update an existing quadruplet, the application inserts a parameter element of the
following type into the infoparmblkp parameter block:
IPSET_CONFIG
IPPARM_AUTHENTICATION_CONFIGURE
• value = IP_AUTHENTICATION data structure specifying the quadruplet to create/update
If the realm and identity strings in the IP_AUTHENTICATION structure are unique, the library
creates a new authentication quadruplet in the database. If both the realm and identity strings match
Name: int gc_SetAuthenticationInfo(target_type, target_id, infoparmblkp)
Inputs: int target_type
• type of target object (virtual board)
long target_id
• target object ID
GC_PARM_BLKP
infoparmblkp
• pointer to GC_PARM_BLK with user information
Returns: 0 if successful
<0 if failure
Includes: gclib.h
gcerr.h
Mode: synchronous
Parameter Description
target_type specifies the type of target object; must be set to GCTGT_CCLIB_NETIF.
target_id specifies the virtual board ID that the authentication information applies to
infoparmblklp points to a GC_PARM_BLK structure that contains the authentication
information. The parm block contains one or more parameters that use the
IPSET_CONFIG set ID and IPPARM_AUTHENTICATION_CONFIGURE
or IPPARM_AUTHENTICATION_REMOVE as the parameter ID.