Module pyxmpp.sasl.digest_md5

DIGEST-MD5 authentication mechanism for PyXMPP SASL implementation.

Normative reference:
  - `RFC 2831 <http://www.ietf.org/rfc/rfc2831.txt>`__

Imported modules:

logging, md5, re

Imported classes:

Challenge, ClientAuthenticator, Failure, Response, ServerAuthenticator, Success

Imported functions:

b2a_hex, from_utf8, to_utf8

Compute DIGEST-MD5 response value.

:Parameters:
    - `urp_hash`: MD5 sum of username:realm:password.
    - `nonce`: nonce value from a server challenge.
    - `cnonce`: cnonce value from the client response.
    - `nonce_count`: nonce count value.
    - `authzid`: authorization id.
    - `digest_uri`: digest-uri value.
:Types:
    - `urp_hash`: `str`
    - `nonce`: `str`
    - `nonce_count`: `int`
    - `authzid`: `str`
    - `digest_uri`: `str`

:return: the computed response value.
:returntype: `str`

Compute DIGEST-MD5 rspauth value.

:Parameters:
    - `urp_hash`: MD5 sum of username:realm:password.
    - `nonce`: nonce value from a server challenge.
    - `cnonce`: cnonce value from the client response.
    - `nonce_count`: nonce count value.
    - `authzid`: authorization id.
    - `digest_uri`: digest-uri value.
:Types:
    - `urp_hash`: `str`
    - `nonce`: `str`
    - `nonce_count`: `int`
    - `authzid`: `str`
    - `digest_uri`: `str`

:return: the computed rspauth value.
:returntype: `str`

H function of the DIGEST-MD5 algorithm (MD5 sum).

:Parameters:
    - `s`: a string.
:Types:
    - `s`: `str`

:return: MD5 sum of the string.
:returntype: `str`

KD function of the DIGEST-MD5 algorithm.

:Parameters:
    - `k`: a string.
    - `s`: a string.
:Types:
    - `k`: `str`
    - `s`: `str`

:return: MD5 sum of the strings joined with ':'.
:returntype: `str`

Compute MD5 sum of username:realm:password.

:Parameters:
    - `username`: a username.
    - `realm`: a realm.
    - `passwd`: a password.
:Types:
    - `username`: `str`
    - `realm`: `str`
    - `passwd`: `str`

:return: the MD5 sum of the parameters joined with ':'.
:returntype: `str`

Prepare a string for quoting for DIGEST-MD5 challenge or response.

Don't add the quotes, only escape '"' and "\" with backslashes.

:Parameters:
    - `s`: a raw string.
:Types:
    - `s`: `str`

:return: `s` with '"' and "\" escaped using "\".
:returntype: `str`

Unquote quoted value from DIGEST-MD5 challenge or response.

If `s` doesn't start or doesn't end with '"' then return it unchanged,
remove the quotes and escape backslashes otherwise.

:Parameters:
    - `s`: a quoted string.
:Types:
    - `s`: `str`

:return: the unquoted string.
:returntype: `str`