diff options
| author | Benny Prijono <bennylp@teluu.com> | 2007-06-20 04:14:07 +0000 |
|---|---|---|
| committer | Benny Prijono <bennylp@teluu.com> | 2007-06-20 04:14:07 +0000 |
| commit | bbee07a12eee6f6a55f60a4ce59cf8057b46e155 (patch) | |
| tree | 78111676daa4a3b90d2588171ab93f54b8f53c94 /pjsip | |
| parent | 568524345dffc7a17c633af1f084509e2713de7f (diff) | |
Updated doxygen documentation for SIP auth credential, added documentation for wildcard ('*') realm
git-svn-id: http://svn.pjsip.org/repos/pjproject/trunk@1376 74dad513-b988-da41-8d7b-12977e46ad98
Diffstat (limited to 'pjsip')
| -rw-r--r-- | pjsip/include/pjsip/sip_auth.h | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/pjsip/include/pjsip/sip_auth.h b/pjsip/include/pjsip/sip_auth.h index d14ae31b..372144ba 100644 --- a/pjsip/include/pjsip/sip_auth.h +++ b/pjsip/include/pjsip/sip_auth.h @@ -67,15 +67,21 @@ typedef enum pjsip_auth_qop_type * 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/asterisk character, + * i.e. realm = pj_str("*");. */ struct pjsip_cred_info { - pj_str_t realm; /**< Realm. */ - pj_str_t scheme; /**< Scheme. */ - pj_str_t username; /**< User name. */ - int data_type; /**< Type of data. */ + 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. */ + password or a hashed digest. */ }; /** |