zapISipAuthentication Interface Reference
[ZAP SIP UA layer]

import "zapISipAuthentication.idl";

List of all members.

---

Detailed Description

SIP authentication API compliant to RFC3261 section 22/RFC2617.

Implemented by component '@mozilla.org/zap/sipauth;1'

Public Member Functions
boolean	addAuthorizationHeaders (in zapISipCredentialsProvider credentials, in zapISipResponse response, in zapISipRequest request, in unsigned long authFlags)
	Add authorization headers to 'request' for all WWW-Authenticate and Proxy-Authenticate challenges in 'response' for which 'credentials' has appropriate credentials.
Public Attributes
authFlags flag constants for addAuthorizationHeaders
const unsigned long	ASTERISK_STALE_NONCE_HACK = 0x0001
	Some servers (most notably some common versions of Asterisk) forget to set the nonce=stale parameter when rejecting a request with a stale nonce.

---

Member Function Documentation

boolean zapISipAuthentication::addAuthorizationHeaders (  in zapISipCredentialsProvider  credentials, in zapISipResponse  response, in zapISipRequest  request, in unsigned long  authFlags )

Add authorization headers to 'request' for all WWW-Authenticate and Proxy-Authenticate challenges in 'response' for which 'credentials' has appropriate credentials. Returns 'true' if new authorization headers have been added

---

Member Data Documentation

const unsigned long zapISipAuthentication::ASTERISK_STALE_NONCE_HACK = 0x0001

Some servers (most notably some common versions of Asterisk) forget to set the nonce=stale parameter when rejecting a request with a stale nonce. When ASTERISK_STALE_NONCE_HACK is set, addAuthorizationHeaders() will compare the nonces of request and response, and when they don't match, set the hasRejectedCredentials parameter to getCredentialsForRealm() to false.

---

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

• /home/alex/devel/zap/mozilla/zap/sip/idl/zapISipAuthentication.idl

---