Group PJSIP_AUTH_API

group PJSIP_AUTH_API

Structures and functions to perform authentication.

Defines

PJSIP_MD5STRLEN

Length of digest MD5 string.

PJSIP_SHA256STRLEN

Length of digest SHA256 string.

PJSIP_AUTH_SRV_IS_PROXY

Flag to specify that server is a proxy.

Typedefs

typedef pj_status_t (*pjsip_cred_cb)(pj_pool_t *pool, const pjsip_digest_challenge *chal, const pjsip_cred_info *cred, const pj_str_t *method, pjsip_digest_credential *auth)

Type of callback function to create authentication response. Application can specify this callback in cb field of the credential info (pjsip_cred_info) and specifying PJSIP_CRED_DATA_DIGEST_CALLBACK as data_type. When this function is called, most of the fields in the auth authentication response will have been filled by the framework. Application normally should just need to calculate the response digest of the authentication response.

Param pool

Pool to allocate memory from if application needs to.

Param chal

The authentication challenge sent by server in 401 or 401 response, in either Proxy-Authenticate or WWW-Authenticate header.

Param cred

The credential that has been selected by the framework to authenticate against the challenge.

Param auth

The authentication response which application needs to calculate the response digest.

Return

Application may return non-PJ_SUCCESS to abort the authentication process. When this happens, the framework will return failure to the original function that requested authentication.

typedef pj_status_t pjsip_auth_lookup_cred(pj_pool_t *pool, const pj_str_t *realm, const pj_str_t *acc_name, pjsip_cred_info *cred_info)

Type of function to lookup credential for the specified name.

Param pool

Pool to initialize the credential info.

Param realm

Realm to find the account.

Param acc_name

Account name to look for.

Param cred_info

The structure to put the credential when it’s found.

Return

The function MUST return PJ_SUCCESS when it found a correct credential for the specified account and realm. Otherwise it may return PJSIP_EAUTHACCNOTFOUND or PJSIP_EAUTHACCDISABLED.

typedef pj_status_t pjsip_auth_lookup_cred2(pj_pool_t *pool, const pjsip_auth_lookup_cred_param *param, pjsip_cred_info *cred_info)

Type of function to lookup credential for the specified name.

Param pool

Pool to initialize the credential info.

Param param

The input param for credential lookup.

Param cred_info

The structure to put the credential when it’s found.

Return

The function MUST return PJ_SUCCESS when it found a correct credential for the specified account and realm. Otherwise it may return PJSIP_EAUTHACCNOTFOUND or PJSIP_EAUTHACCDISABLED.

Enums

enum pjsip_cred_data_type

Type of data in the credential information in pjsip_cred_info.

Values:

enumerator PJSIP_CRED_DATA_PLAIN_PASSWD

Plain text password.

enumerator PJSIP_CRED_DATA_DIGEST

Hashed digest.

enumerator PJSIP_CRED_DATA_EXT_AKA

Extended AKA info is available

enum pjsip_auth_qop_type

Authentication’s quality of protection (qop) type.

Values:

enumerator PJSIP_AUTH_QOP_NONE

No quality of protection.

enumerator PJSIP_AUTH_QOP_AUTH

Authentication.

enumerator PJSIP_AUTH_QOP_AUTH_INT

Authentication with integrity protection.

enumerator PJSIP_AUTH_QOP_UNKNOWN

Unknown protection.

Functions

void pjsip_auth_clt_pref_dup(pj_pool_t *pool, pjsip_auth_clt_pref *dst, const pjsip_auth_clt_pref *src)

Duplicate a client authentication preference setting.

Parameters

  • pool – The memory pool.

  • dst – Destination client authentication preference.

  • src – Source client authentication preference.

void pjsip_cred_info_dup(pj_pool_t *pool, pjsip_cred_info *dst, const pjsip_cred_info *src)

Duplicate a credential info.

Parameters

  • pool – The memory pool.

  • dst – Destination credential.

  • src – Source credential.

int pjsip_cred_info_cmp(const pjsip_cred_info *cred1, const pjsip_cred_info *cred2)

Compare two credential infos.

Parameters

  • cred1 – The credential info to compare.

  • cred2 – The credential info to compare.

Returns

0 if both credentials are equal.

pj_status_t pjsip_auth_clt_init(pjsip_auth_clt_sess *sess, pjsip_endpoint *endpt, pj_pool_t *pool, unsigned options)

Initialize client authentication session data structure, and set the session to use pool for its subsequent memory allocation. The argument options should be set to zero for this PJSIP version.

Parameters

  • sess – The client authentication session.

  • endpt – Endpoint where this session belongs.

  • pool – Pool to use.

  • options – Must be zero.

Returns

PJ_SUCCESS on success.

pj_status_t pjsip_auth_clt_deinit(pjsip_auth_clt_sess *sess)

Deinitialize client authentication session data structure.

Parameters

sess – The client authentication session.

Returns

PJ_SUCCESS on success.

pj_status_t pjsip_auth_clt_clone(pj_pool_t *pool, pjsip_auth_clt_sess *sess, const pjsip_auth_clt_sess *rhs)

Clone client initialization session.

Parameters

  • pool – Pool to use.

  • sess – Structure to put the duplicated session.

  • rhs – The client session to be cloned.

Returns

PJ_SUCCESS on success;

pj_status_t pjsip_auth_clt_set_credentials(pjsip_auth_clt_sess *sess, int cred_cnt, const pjsip_cred_info *c)

Set the credentials to be used during the session. This will duplicate the specified credentials using client authentication’s pool.

Parameters

  • sess – The client authentication session.

  • cred_cnt – Number of credentials.

  • c – Array of credentials.

Returns

PJ_SUCCESS on success.

pj_status_t pjsip_auth_clt_set_prefs(pjsip_auth_clt_sess *sess, const pjsip_auth_clt_pref *p)

Set the preference for the client authentication session.

Parameters

  • sess – The client authentication session.

  • p – Preference.

Returns

PJ_SUCCESS on success.

pj_status_t pjsip_auth_clt_get_prefs(pjsip_auth_clt_sess *sess, pjsip_auth_clt_pref *p)

Get the preference for the client authentication session.

Parameters

  • sess – The client authentication session.

  • p – Pointer to receive the preference.

Returns

PJ_SUCCESS on success.

pj_status_t pjsip_auth_clt_init_req(pjsip_auth_clt_sess *sess, pjsip_tx_data *tdata)

Initialize new request message with authorization headers. This function will put Authorization/Proxy-Authorization headers to the outgoing request message. If caching is enabled (PJSIP_AUTH_HEADER_CACHING) and the session has previously sent Authorization/Proxy-Authorization header with the same method, then the same Authorization/Proxy-Authorization header will be resent from the cache only if qop is not present. If the stack is configured to automatically generate next Authorization/Proxy-Authorization headers (PJSIP_AUTH_AUTO_SEND_NEXT flag), then new Authorization/Proxy- Authorization headers are calculated and generated when they are not present in the case or if authorization session has qop.

If both PJSIP_AUTH_HEADER_CACHING flag and PJSIP_AUTH_AUTO_SEND_NEXT flag are not set, this function will do nothing. The stack then will only send Authorization/Proxy-Authorization to respond 401/407 response.

Parameters

  • sess – The client authentication session.

  • tdata – The request message to be initialized.

Returns

PJ_SUCCESS if successfull.

pj_status_t pjsip_auth_clt_reinit_req(pjsip_auth_clt_sess *sess, const pjsip_rx_data *rdata, pjsip_tx_data *old_request, pjsip_tx_data **new_request)

Call this function when a transaction failed with 401 or 407 response. This function will reinitialize the original request message with the authentication challenge found in the response message, and add the new authorization header in the authorization cache.

Note that upon return the reference counter of the new transmit data will be set to 1.

Parameters

  • sess – The client authentication session.

  • rdata – The response message containing 401/407 status.

  • old_request – The original request message, which will be re- created with authorization info.

  • new_request – Pointer to receive new request message which will contain all required authorization headers.

Returns

PJ_SUCCESS if new request can be successfully created to respond all the authentication challenges.

pj_status_t pjsip_auth_srv_init(pj_pool_t *pool, pjsip_auth_srv *auth_srv, const pj_str_t *realm, pjsip_auth_lookup_cred *lookup, unsigned options)

Initialize server authorization session data structure to serve the specified realm and to use lookup_func function to look for the credential info.

Parameters

  • pool – Pool used to initialize the authentication server.

  • auth_srv – The authentication server structure.

  • realm – Realm to be served by the server.

  • lookup – Account lookup function.

  • options – Options, bitmask of:

    • PJSIP_AUTH_SRV_IS_PROXY: to specify that the server will authorize clients as a proxy server (instead of as UAS), which means that Proxy-Authenticate will be used instead of WWW-Authenticate.

Returns

PJ_SUCCESS on success.

pj_status_t pjsip_auth_srv_init2(pj_pool_t *pool, pjsip_auth_srv *auth_srv, const pjsip_auth_srv_init_param *param)

Initialize server authorization session data structure to serve the specified realm and to use lookup_func function to look for the credential info.

Parameters

  • pool – Pool used to initialize the authentication server.

  • auth_srv – The authentication server structure.

  • param – The initialization param.

Returns

PJ_SUCCESS on success.

pj_status_t pjsip_auth_srv_verify(pjsip_auth_srv *auth_srv, pjsip_rx_data *rdata, int *status_code)

Request the authorization server framework to verify the authorization information in the specified request in rdata.

Parameters

  • auth_srv – The server authentication structure.

  • rdata – Incoming request to be authenticated.

  • status_code – When not null, it will be filled with suitable status code to be sent to the client.

Returns

PJ_SUCCESS if request is successfully authenticated. Otherwise the function may return one of the following error codes:

  • PJSIP_EAUTHNOAUTH

  • PJSIP_EINVALIDAUTHSCHEME

  • PJSIP_EAUTHACCNOTFOUND

  • PJSIP_EAUTHACCDISABLED

  • PJSIP_EAUTHINVALIDREALM

  • PJSIP_EAUTHINVALIDDIGEST

pj_status_t pjsip_auth_srv_challenge(pjsip_auth_srv *auth_srv, const pj_str_t *qop, const pj_str_t *nonce, const pj_str_t *opaque, pj_bool_t stale, pjsip_tx_data *tdata)

Add authentication challenge headers to the outgoing response in tdata. Application may specify its customized nonce and opaque for the challenge, or can leave the value to NULL to make the function fills them in with random characters.

Parameters

  • auth_srv – The server authentication structure.

  • qop – Optional qop value.

  • nonce – Optional nonce value.

  • opaque – Optional opaque value.

  • stale – Stale indication.

  • tdata – The outgoing response message. The response must have 401 or 407 response code.

Returns

PJ_SUCCESS on success.

pj_status_t pjsip_auth_create_digest(pj_str_t *result, const pj_str_t *nonce, const pj_str_t *nc, const pj_str_t *cnonce, const pj_str_t *qop, const pj_str_t *uri, const pj_str_t *realm, const pjsip_cred_info *cred_info, const pj_str_t *method)

Helper function to create MD5 digest out of the specified parameters.

Parameters

  • result – String to store the response digest. This string must have been preallocated by caller with the buffer at least PJSIP_MD5STRLEN (32 bytes) in size.

  • nonce – Optional nonce.

  • nc – Nonce count.

  • cnonce – Optional cnonce.

  • qop – Optional qop.

  • uri – URI.

  • realm – Realm.

  • cred_info – Credential info.

  • method – SIP method.

Returns

PJ_SUCCESS on success.

pj_status_t pjsip_auth_create_digestSHA256(pj_str_t *result, const pj_str_t *nonce, const pj_str_t *nc, const pj_str_t *cnonce, const pj_str_t *qop, const pj_str_t *uri, const pj_str_t *realm, const pjsip_cred_info *cred_info, const pj_str_t *method)

Helper function to create SHA-256 digest out of the specified parameters.

Parameters

  • result – String to store the response digest. This string must have been preallocated by caller with the buffer at least PJSIP_SHA256STRLEN (64 bytes) in size.

  • nonce – Optional nonce.

  • nc – Nonce count.

  • cnonce – Optional cnonce.

  • qop – Optional qop.

  • uri – URI.

  • realm – Realm.

  • cred_info – Credential info.

  • method – SIP method.

Returns

PJ_SUCCESS on success.

struct pjsip_cred_info
#include <sip_auth.h>

This structure describes credential information. A credential information is a static, persistent information that identifies username and password required to authorize to a specific realm.

Note that since PJSIP 0.7.0.1, it is possible to make a credential that is valid for any realms, by setting the realm to star/wildcard character, i.e. realm = pj_str(“*”);.

Forward declaration for credential.

Public Members

pj_str_t realm

Realm. Use “*” to make a credential that can be used to authenticate against any challenges.

pj_str_t scheme

Scheme (e.g. “digest”).

pj_str_t username

User name.

int data_type

Type of data (0 for plaintext passwd).

pj_str_t data

The data, which can be a plaintext password or a hashed digest.

pj_str_t k

Permanent subscriber key.

pj_str_t op

Operator variant key.

pj_str_t amf

Authentication Management Field

pjsip_cred_cb cb

Callback to create AKA digest.

struct pjsip_cred_info::[anonymous]::[anonymous] aka

Digest AKA credential information. Note that when AKA credential is being used, the data field of this pjsip_cred_info is not used, but it still must be initialized to an empty string. Please see Digest AKAv1 and AKAv2 Authentication API for more information.

union pjsip_cred_info::[anonymous] ext

Extended data

struct pjsip_cached_auth_hdr
#include <sip_auth.h>

This structure describes cached value of previously sent Authorization or Proxy-Authorization header. The authentication framework keeps a list of this structure and will resend the same header to the same server as long as the method, uri, and nonce stays the same.

Public Functions

PJ_DECL_LIST_MEMBER(struct pjsip_cached_auth_hdr)

Standard list member

Public Members

pjsip_method method

To quickly see the method.

pjsip_authorization_hdr *hdr

The cached header.

struct pjsip_cached_auth
#include <sip_auth.h>

This structure describes authentication information for the specified realm. Each instance of this structure describes authentication “session” between this endpoint and remote server. This “session” information is usefull to keep information that persists for more than one challenge, such as nonce-count and cnonce value.

Other than that, this structure also keeps the last authorization headers that have been sent in the cache list.

Public Functions

PJ_DECL_LIST_MEMBER(struct pjsip_cached_auth)

Standard list member

Public Members

pj_pool_t *pool

Pool for cached auth

pj_str_t realm

Realm.

pj_bool_t is_proxy

Server type (401/407)

pjsip_auth_qop_type qop_value

qop required by server.

unsigned stale_cnt

Number of stale retry.

pjsip_www_authenticate_hdr *last_chal

Last challenge seen.

struct pjsip_auth_clt_pref
#include <sip_auth.h>

This structure describes client authentication session preference. The preference can be set by calling pjsip_auth_clt_set_prefs().

Public Members

pj_bool_t initial_auth

If this flag is set, the authentication client framework will send an empty Authorization header in each initial request. Default is no.

pj_str_t algorithm

Specify the algorithm to use when empty Authorization header is to be sent for each initial request (see above)

struct pjsip_auth_clt_sess
#include <sip_auth.h>

This structure describes client authentication sessions. It keeps all the information needed to authorize the client against all downstream servers.

Public Members

pj_pool_t *pool

Pool to use.

pjsip_endpoint *endpt

Endpoint where this belongs.

pjsip_auth_clt_pref pref

Preference/options.

unsigned cred_cnt

Number of credentials.

pjsip_cred_info *cred_info

Array of credential information

pjsip_cached_auth cached_auth

Cached authorization info.

struct pjsip_auth_lookup_cred_param
#include <sip_auth.h>

This structure describes input param for credential lookup.

Public Members

pj_str_t realm

Realm to find the account.

pj_str_t acc_name

Account name to look for.

pjsip_rx_data *rdata

Incoming request to be authenticated.

struct pjsip_auth_srv
#include <sip_auth.h>

This structure describes server authentication information.

Public Members

pj_str_t realm

Realm to serve.

pj_bool_t is_proxy

Will issue 407 instead of 401

pjsip_auth_lookup_cred *lookup

Lookup function.

pjsip_auth_lookup_cred2 *lookup2

Lookup function with additional info in its input param.

struct pjsip_auth_srv_init_param
#include <sip_auth.h>

This structure describes initialization settings of server authorization session.

Public Members

const pj_str_t *realm

Realm to be served by the server.

pjsip_auth_lookup_cred2 *lookup2

Account lookup function.

unsigned options

Options, bitmask of:

  • PJSIP_AUTH_SRV_IS_PROXY: to specify that the server will authorize clients as a proxy server (instead of as UAS), which means that Proxy-Authenticate will be used instead of WWW-Authenticate.