ast_sip_authenticator Struct Reference

An interchangeable way of handling digest authentication for SIP. More...

#include <res_pjsip.h>


Data Fields

enum ast_sip_check_auth_result(* check_authentication )(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, pjsip_tx_data *tdata)
 Check that an incoming request passes authentication.
int(* requires_authentication )(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata)
 Check if a request requires authentication See ast_sip_requires_authentication for more details.


Detailed Description

An interchangeable way of handling digest authentication for SIP.

An authenticator is responsible for filling in the callbacks provided below. Each is called from a publicly available function in res_sip. The authenticator can use configuration or other local policy to determine whether authentication should take place and what credentials should be used when challenging and authenticating a request.

Definition at line 662 of file res_pjsip.h.


Field Documentation

enum ast_sip_check_auth_result(* check_authentication)(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, pjsip_tx_data *tdata)

Check that an incoming request passes authentication.

The tdata parameter is useful for adding information such as digest challenges.

Parameters:
endpoint The endpoint sending the incoming request
rdata The incoming request
tdata Tentative outgoing request.

Referenced by ast_sip_check_authentication().

int(* requires_authentication)(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata)

Check if a request requires authentication See ast_sip_requires_authentication for more details.

Referenced by ast_sip_requires_authentication().


The documentation for this struct was generated from the following file:

Generated on Thu Apr 16 06:35:33 2015 for Asterisk - The Open Source Telephony Project by  doxygen 1.5.6