Typedefs |
typedef struct _LinphoneAuthInfo | LinphoneAuthInfo |
Functions |
LinphoneAuthInfo * | linphone_auth_info_new (const char *username, const char *userid, const char *passwd, const char *ha1, const char *realm, const char *domain) |
LinphoneAuthInfo * | linphone_auth_info_clone (const LinphoneAuthInfo *ai) |
const char * | linphone_auth_info_get_username (const LinphoneAuthInfo *i) |
const char * | linphone_auth_info_get_passwd (const LinphoneAuthInfo *i) |
const char * | linphone_auth_info_get_userid (const LinphoneAuthInfo *i) |
const char * | linphone_auth_info_get_realm (const LinphoneAuthInfo *i) |
const char * | linphone_auth_info_get_domain (const LinphoneAuthInfo *i) |
const char * | linphone_auth_info_get_ha1 (const LinphoneAuthInfo *i) |
void | linphone_auth_info_set_passwd (LinphoneAuthInfo *info, const char *passwd) |
void | linphone_auth_info_set_username (LinphoneAuthInfo *info, const char *username) |
void | linphone_auth_info_set_userid (LinphoneAuthInfo *info, const char *userid) |
void | linphone_auth_info_set_realm (LinphoneAuthInfo *info, const char *realm) |
void | linphone_auth_info_set_domain (LinphoneAuthInfo *info, const char *domain) |
void | linphone_auth_info_set_ha1 (LinphoneAuthInfo *info, const char *ha1) |
void | linphone_auth_info_destroy (LinphoneAuthInfo *obj) |
void | linphone_auth_info_write_config (LpConfig *config, LinphoneAuthInfo *obj, int pos) |
LinphoneAuthInfo * | linphone_auth_info_new_from_config_file (LpConfig *config, int pos) |
const LinphoneAuthInfo * | _linphone_core_find_auth_info (LinphoneCore *lc, const char *realm, const char *username, const char *domain, bool_t ignore_realm) |
const LinphoneAuthInfo * | linphone_core_find_auth_info (LinphoneCore *lc, const char *realm, const char *username, const char *domain) |
void | linphone_core_write_auth_info (LinphoneCore *lc, LinphoneAuthInfo *ai) |
LinphoneAuthInfo * | linphone_core_create_auth_info (LinphoneCore *lc, const char *username, const char *userid, const char *passwd, const char *ha1, const char *realm, const char *domain) |
void | linphone_core_add_auth_info (LinphoneCore *lc, const LinphoneAuthInfo *info) |
void | linphone_core_abort_authentication (LinphoneCore *lc, LinphoneAuthInfo *info) |
void | linphone_core_remove_auth_info (LinphoneCore *lc, const LinphoneAuthInfo *info) |
const bctbx_list_t * | linphone_core_get_auth_info_list (const LinphoneCore *lc) |
void | linphone_core_clear_all_auth_info (LinphoneCore *lc) |
Object holding authentication information.
- Note:
- The object's fields should not be accessed directly. Prefer using the accessor methods.
In most case, authentication information consists of a username and password. Sometimes, a userid is required by proxy, and realm can be useful to discriminate different SIP domains.
Once created and filled, a LinphoneAuthInfo must be added to the LinphoneCore in order to become known and used automatically when needed. Use linphone_core_add_auth_info() for that purpose.
The LinphoneCore object can take the initiative to request authentication information when needed to the application through the auth_info_requested callback of the LinphoneCoreVTable structure.
The application can respond to this information request later using linphone_core_add_auth_info(). This will unblock all pending authentication transactions and retry them with authentication headers.