Changeset 1376


Ignore:
Timestamp:
Jun 20, 2007 4:14:07 AM (12 years ago)
Author:
bennylp
Message:

Updated doxygen documentation for SIP auth credential, added documentation for wildcard ('*') realm

File:
1 edited

Legend:

Unmodified
Added
Removed
  • pjproject/trunk/pjsip/include/pjsip/sip_auth.h

    r974 r1376  
    6868 * A credential information is a static, persistent information that identifies 
    6969 * username and password required to authorize to a specific realm. 
     70 * 
     71 * Note that since PJSIP 0.7.0.1, it is possible to make a credential that is 
     72 * valid for any realms, by setting the realm to star/asterisk character, 
     73 * i.e. realm = pj_str("*");. 
    7074 */ 
    7175struct pjsip_cred_info 
    7276{ 
    73     pj_str_t    realm;          /**< Realm.         */ 
    74     pj_str_t    scheme;         /**< Scheme.        */ 
    75     pj_str_t    username;       /**< User name.     */ 
    76     int         data_type;      /**< Type of data.  */ 
     77    pj_str_t    realm;          /**< Realm. Use "*" to make a credential that 
     78                                     can be used to authenticate against any 
     79                                     challenges.                            */ 
     80    pj_str_t    scheme;         /**< Scheme (e.g. "digest").                */ 
     81    pj_str_t    username;       /**< User name.                             */ 
     82    int         data_type;      /**< Type of data (0 for plaintext passwd). */ 
    7783    pj_str_t    data;           /**< The data, which can be a plaintext  
    78                                      password or a hashed digest. */ 
     84                                     password or a hashed digest.          */ 
    7985}; 
    8086 
Note: See TracChangeset for help on using the changeset viewer.