1eXosip2 authentication API(3)     libeXosip2     eXosip2 authentication API(3)
2
3
4

NAME

6       eXosip2 authentication API -
7
8   Functions
9       int eXosip_add_authentication_info (const char *username, const char
10           *userid, const char *passwd, const char *ha1, const char *realm)
11       int eXosip_clear_authentication_info (void)
12       int eXosip_default_action (eXosip_event_t *je)
13       void eXosip_automatic_refresh (void)
14       void eXosip_automatic_action (void)
15       int eXosip_insubscription_automatic (eXosip_event_t *evt)
16       int eXosip_generate_random (char *buf, int buf_size)
17

Function Documentation

19   int eXosip_add_authentication_info (const char * username, const char *
20       userid, const char * passwd, const char * ha1, const char * realm)
21       Add authentication credentials. These are used when an outgoing request
22       comes back with an authorization required response.
23
24       Parameters:
25           username username
26           userid login (usually equals the username)
27           passwd password
28           ha1 currently ignored
29           realm realm within which credentials apply, or NULL to apply
30           credentials to unrecognized realms
31
32   int eXosip_clear_authentication_info (void)
33       Clear all authentication credentials stored in eXosip.
34
35   int eXosip_default_action (eXosip_event_t * je)
36       Initiate some default actions:
37
38       Retry with credentials upon reception of 401/407. Retry with Contact
39       header upon reception of 3xx request.
40
41   void eXosip_automatic_refresh (void)
42       Refresh REGISTER and SUBSCRIBE before the expiration delay.
43
44   void eXosip_automatic_action (void)
45       Initiate some automatic actions:
46
47       Retry with credentials upon reception of 401/407. Refresh REGISTER and
48       SUBSCRIBE before the expiration delay. Retry with Contact header upon
49       reception of 3xx request.
50
51   int eXosip_insubscription_automatic (eXosip_event_t * evt)
52       Automatic internal handling of known package.
53
54       Parameters:
55           evt event related to an incoming subscription.
56
57   int eXosip_generate_random (char * buf, int buf_size)
58       Generate random string:
59
60       Parameters:
61           buf destination buffer for random string.
62           buf_size size of destination buffer
63
64Version 3.0.1                     30 Aug 2007    eXosip2 authentication API(3)
Impressum