twisted.cred.test.test_digestauth.DigestAuthTests

class documentation

class DigestAuthTests(TestCase): (source)

TestCase mixin class which defines a number of tests for DigestCredentialFactory. Because this mixin defines setUp, it must be inherited before TestCase.

Method	`formatResponse`	Format all given keyword arguments and their values suitably for use as the value of an HTTP header.
Method	`getDigestResponse`	Calculate the response for the given challenge
Method	`setUp`	Create a DigestCredentialFactory for testing
Method	`test_caseInsensitiveAlgorithm`	The case of the algorithm value in the response is ignored when checking the credentials.
Method	`test_checkHash`	`DigestCredentialFactory.decode` returns an `IUsernameDigestHash` provider which can verify a hash of the form 'username:realm:password'.
Method	`test_failsWithDifferentMethod`	`DigestCredentialFactory.decode` returns an `IUsernameHashedPassword` provider which rejects a correct password for the given user if the challenge response request is made using a different HTTP method than was used to request the initial challenge.
Method	`test_incompatibleCalcHA1Options`	`calcHA1` raises `TypeError` when any of the pszUsername, pszRealm, or pszPassword arguments are specified with the preHA1 keyword argument.
Method	`test_incompatibleClientIP`	`DigestCredentialFactory.decode` raises `LoginFailed` when the request comes from a client IP other than what is encoded in the opaque.
Method	`test_incompatibleNonce`	`DigestCredentialFactory.decode` raises `LoginFailed` when the given nonce from the response does not match the nonce encoded in the opaque.
Method	`test_invalidOpaque`	`DigestCredentialFactory.decode` raises `LoginFailed` when the opaque value does not contain all the required parts.
Method	`test_md5DefaultAlgorithm`	The algorithm defaults to MD5 if it is not supplied in the response.
Method	`test_MD5HashA1`	`calcHA1` accepts the `'md5'` algorithm and returns an MD5 hash of its parameters, excluding the nonce and cnonce.
Method	`test_MD5HashA2Auth`	`calcHA2` accepts the `'md5'` algorithm and returns an MD5 hash of its arguments, excluding the entity hash for QOP other than `'auth-int'`.
Method	`test_MD5HashA2AuthInt`	`calcHA2` accepts the `'md5'` algorithm and returns an MD5 hash of its arguments, including the entity hash for QOP of `'auth-int'`.
Method	`test_MD5HashResponse`	`calcResponse` accepts the `'md5'` algorithm and returns an MD5 hash of its parameters, excluding the nonce count, client nonce, and QoP value if the nonce count and client nonce are `None`
Method	`test_MD5HashResponseExtra`	`calcResponse` accepts the `'md5'` algorithm and returns an MD5 hash of its parameters, including the nonce count, client nonce, and QoP value if they are specified.
Method	`test_MD5SessHashA2Auth`	`calcHA2` accepts the `'md5-sess'` algorithm and QOP of `'auth'` and returns the same value as it does for the `'md5'` algorithm.
Method	`test_MD5SessHashA2AuthInt`	`calcHA2` accepts the `'md5-sess'` algorithm and QOP of `'auth-int'` and returns the same value as it does for the `'md5'` algorithm.
Method	`test_MD5SessionHashA1`	`calcHA1` accepts the `'md5-sess'` algorithm and returns an MD5 hash of its parameters, including the nonce and cnonce.
Method	`test_MD5SessionHashResponse`	`calcResponse` accepts the `'md5-sess'` algorithm and returns an MD5 hash of its parameters, excluding the nonce count, client nonce, and QoP value if the nonce count and client nonce are `None`
Method	`test_MD5SessionHashResponseExtra`	`calcResponse` accepts the `'md5-sess'` algorithm and returns an MD5 hash of its parameters, including the nonce count, client nonce, and QoP value if they are specified.
Method	`test_mismatchedOpaqueChecksum`	`DigestCredentialFactory.decode` raises `LoginFailed` when the opaque checksum fails verification.
Method	`test_multiResponse`	`DigestCredentialFactory.decode` handles multiple responses to a single challenge.
Method	`test_noNewlineOpaque`	`DigestCredentialFactory._generateOpaque` returns a value without newlines, regardless of the length of the nonce.
Method	`test_noNonce`	`DigestCredentialFactory.decode` raises `LoginFailed` if the response has no nonce.
Method	`test_noOpaque`	`DigestCredentialFactory.decode` raises `LoginFailed` if the response has no opaque.
Method	`test_noUsername`	`DigestCredentialFactory.decode` raises `LoginFailed` if the response has no username field or if the username field is empty.
Method	`test_oldNonce`	`DigestCredentialFactory.decode` raises `LoginFailed` when the given opaque is older than `DigestCredentialFactory.CHALLENGE_LIFETIME_SECS`
Method	`test_response`	`DigestCredentialFactory.decode` accepts a digest challenge response and parses it into an `IUsernameHashedPassword` provider.
Method	`test_responseWithCommaURI`	`DigestCredentialFactory.decode` accepts a digest challenge response which quotes the values of its fields and includes a `b","` in the URI field.
Method	`test_responseWithoutClientIP`	`DigestCredentialFactory.decode` accepts a digest challenge response even if the client address it is passed is `None`.
Method	`test_responseWithoutQuotes`	`DigestCredentialFactory.decode` accepts a digest challenge response which does not quote the values of its fields and parses it into an `IUsernameHashedPassword` provider in the same way it would a response which included quoted field values.
Method	`test_SHAHashA1`	`calcHA1` accepts the `'sha'` algorithm and returns a SHA hash of its parameters, excluding the nonce and cnonce.
Method	`test_SHAHashA2Auth`	`calcHA2` accepts the `'sha'` algorithm and returns a SHA hash of its arguments, excluding the entity hash for QOP other than `'auth-int'`.
Method	`test_SHAHashA2AuthInt`	`calcHA2` accepts the `'sha'` algorithm and returns a SHA hash of its arguments, including the entity hash for QOP of `'auth-int'`.
Method	`test_SHAHashResponse`	`calcResponse` accepts the `'sha'` algorithm and returns a SHA hash of its parameters, excluding the nonce count, client nonce, and QoP value if the nonce count and client nonce are `None`
Method	`test_SHAHashResponseExtra`	`calcResponse` accepts the `'sha'` algorithm and returns a SHA hash of its parameters, including the nonce count, client nonce, and QoP value if they are specified.
Instance Variable	`algorithm`	Undocumented
Instance Variable	`clientAddress`	Undocumented
Instance Variable	`cnonce`	Undocumented
Instance Variable	`credentialFactory`	Undocumented
Instance Variable	`method`	Undocumented
Instance Variable	`password`	Undocumented
Instance Variable	`qop`	Undocumented
Instance Variable	`realm`	Undocumented
Instance Variable	`uri`	Undocumented
Instance Variable	`username`	Undocumented

Inherited from TestCase:

Method	`__call__`	Run the test. Should always do exactly the same thing as run().
Method	`__init__`	Construct an asynchronous test case for `methodName`.
Method	`addCleanup`	Extend the base cleanup feature with support for cleanup functions which return Deferreds.
Method	`assertFailure`	Fail if `deferred` does not errback with one of `expectedFailures`. Returns the original Deferred with callbacks added. You will need to return this Deferred from your test case.
Method	`deferRunCleanups`	Run any scheduled cleanups and report errors (if any) to the result. object.
Method	`deferSetUp`	Undocumented
Method	`deferTearDown`	Undocumented
Method	`deferTestMethod`	Undocumented
Method	`getSuppress`	Undocumented
Method	`getTimeout`	Returns the timeout value set on this test. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a `timeout` attribute, returns that. Returns `util.DEFAULT_TIMEOUT_DURATION`...
Instance Variable	`timeout`	A real number of seconds. If set, the test will raise an error if it takes longer than `timeout` seconds. If not set, util.DEFAULT_TIMEOUT_DURATION is used.
Method	`_cbDeferTestMethod`	Undocumented
Method	`_classCleanUp`	Undocumented
Method	`_cleanUp`	Undocumented
Method	`_deprecateReactor`	Deprecate `iterate`, `crash` and `stop` on `reactor`. That is, each method is wrapped in a function that issues a deprecation warning, then calls the original.
Method	`_ebDeferSetUp`	Undocumented
Method	`_ebDeferTearDown`	Undocumented
Method	`_ebDeferTestMethod`	Undocumented
Method	`_makeReactorMethod`	Create a method which wraps the reactor method `name`. The new method issues a deprecation warning and calls the original.
Method	`_run`	Run a single method, either a test method or fixture.
Method	`_runFixturesAndTest`	Really run `setUp`, the test method, and `tearDown`. Any of these may return `defer.Deferred`s. After they complete, do some reactor cleanup.
Method	`_undeprecateReactor`	Restore the deprecated reactor methods. Undoes what `_deprecateReactor` did.
Method	`_wait`	Take a Deferred that only ever callbacks. Block until it happens.
Instance Variable	`_passed`	Undocumented
Instance Variable	`_reactorMethods`	Undocumented
Instance Variable	`_timedOut`	Undocumented

Inherited from SynchronousTestCase (via TestCase):

Method	`__eq__`	Override the comparison defined by the base TestCase which considers instances of the same class with the same _testMethodName to be equal. Since trial puts TestCase instances into a set, that definition of comparison makes it impossible to run the same test method twice...
Method	`__hash__`	Undocumented
Method	`callDeprecated`	Call a function that should have been deprecated at a specific version and in favor of a specific alternative, and assert that it was thusly deprecated.
Method	`flushLoggedErrors`	Remove stored errors received from the log.
Method	`flushWarnings`	Remove stored warnings from the list of captured warnings and return them.
Method	`getDeprecatedModuleAttribute`	Retrieve a module attribute which should have been deprecated, and assert that we saw the appropriate deprecation warning.
Method	`getSkip`	Return the skip reason set on this test, if any is set. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a `skip` attribute, returns that in a tuple (...
Method	`getTodo`	Return a `Todo` object if the test is marked todo. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a `todo` attribute, returns that. Returns ...
Method	`mktemp`	Create a new path name which can be used for a new file or directory.
Method	`patch`	Monkey patch an object for the duration of the test.
Method	`run`	Run the test case, storing the results in `result`.
Method	`runTest`	If no `methodName` argument is passed to the constructor, `run` will treat this method as the thing with the actual test inside.
Method	`shortDescription`	Undocumented
Instance Variable	`failureException`	An exception class, defaulting to `FailTest`. If the test method raises this exception, it will be reported as a failure, rather than an exception. All of the assertion methods raise this if the assertion fails.
Instance Variable	`skip`	`None` or a string explaining why this test is to be skipped. If defined, the test will not be run. Instead, it will be reported to the result object as 'skipped' (if the `TestResult` supports skipping).
Instance Variable	`suppress`	`None` or a list of tuples of `(args, kwargs)` to be passed to `warnings.filterwarnings`. Use these to suppress warnings raised in a test. Useful for testing deprecated code. See also `util.suppress`.
Instance Variable	`todo`	`None`, a string or a tuple of `(errors, reason)` where `errors` is either an exception class or an iterable of exception classes, and `reason` is a string. See `Todo` or `makeTodo` for more information.
Method	`_getSkipReason`	Return the reason to use for skipping a test method.
Method	`_getSuppress`	Returns any warning suppressions set for this test. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a `suppress` attribute, returns that. ...
Method	`_installObserver`	Undocumented
Method	`_removeObserver`	Undocumented
Method	`_runCleanups`	Synchronously run any cleanups which have been added.
Instance Variable	`_cleanups`	Undocumented
Instance Variable	`_observer`	Undocumented
Instance Variable	`_parents`	Undocumented
Instance Variable	`_testMethodName`	Undocumented
Instance Variable	`_warnings`	Undocumented

Inherited from _Assertions (via TestCase, SynchronousTestCase):

Method	`assertAlmostEqual`	Fail if the two objects are unequal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.
Method	`assertApproximates`	Fail if `first` - `second` > `tolerance`
Method	`assertEqual`	Fail the test if `first` and `second` are not equal.
Method	`assertFalse`	Fail the test if `condition` evaluates to True.
Method	`assertIn`	Fail the test if `containee` is not found in `container`.
Method	`assertIs`	Fail the test if `first` is not `second`. This is an obect-identity-equality test, not an object equality (i.e. `__eq__`) test.
Method	`assertIsInstance`	Fail if `instance` is not an instance of the given class or of one of the given classes.
Method	`assertIsNot`	Fail the test if `first` is `second`. This is an obect-identity-equality test, not an object equality (i.e. `__eq__`) test.
Method	`assertNoResult`	Assert that `deferred` does not have a result at this point.
Method	`assertNotAlmostEqual`	Fail if the two objects are equal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.
Method	`assertNotEqual`	Fail the test if `first` == `second`.
Method	`assertNotIn`	Fail the test if `containee` is found in `container`.
Method	`assertNotIsInstance`	Fail if `instance` is an instance of the given class or of one of the given classes.
Method	`assertNotSubstring`	Fail if `astring` contains `substring`.
Method	`assertRaises`	Fail the test unless calling the function `f` with the given `args` and `kwargs` raises `exception`. The failure will report the traceback and call stack of the unexpected exception.
Method	`assertSubstring`	Fail if `substring` does not exist within `astring`.
Method	`assertTrue`	Fail the test if `condition` evaluates to False.
Method	`assertWarns`	Fail if the given function doesn't generate the specified warning when called. It calls the function, checks the warning, and forwards the result of the function if everything is fine.
Method	`fail`	Absolutely fail the test. Do not pass go, do not collect $200.
Method	`failureResultOf`	Return the current failure result of `deferred` or raise `self.failureException`.
Method	`successResultOf`	Return the current success result of `deferred` or raise `self.failureException`.

def formatResponse(self, quotes=True, **kw): (source) ¶

Format all given keyword arguments and their values suitably for use as the value of an HTTP header.

Parameters
quotes	A flag indicating whether to quote the values of each field in the response.
**kw	Keywords and `bytes` values which will be treated as field name/value pairs to include in the result.
Returns
`bytes`	The given fields formatted for use as an HTTP header value.
Unknown Field: types
quotes	`bool`

def getDigestResponse(self, challenge, ncount): (source) ¶

Calculate the response for the given challenge

def setUp(self): (source) ¶

Create a DigestCredentialFactory for testing

def test_caseInsensitiveAlgorithm(self): (source) ¶

The case of the algorithm value in the response is ignored when checking the credentials.

def test_checkHash(self): (source) ¶

DigestCredentialFactory.decode returns an IUsernameDigestHash provider which can verify a hash of the form 'username:realm:password'.

def test_failsWithDifferentMethod(self): (source) ¶

DigestCredentialFactory.decode returns an IUsernameHashedPassword provider which rejects a correct password for the given user if the challenge response request is made using a different HTTP method than was used to request the initial challenge.

def test_incompatibleCalcHA1Options(self): (source) ¶

calcHA1 raises TypeError when any of the pszUsername, pszRealm, or pszPassword arguments are specified with the preHA1 keyword argument.

def test_incompatibleClientIP(self): (source) ¶

DigestCredentialFactory.decode raises LoginFailed when the request comes from a client IP other than what is encoded in the opaque.

def test_incompatibleNonce(self): (source) ¶

DigestCredentialFactory.decode raises LoginFailed when the given nonce from the response does not match the nonce encoded in the opaque.

def test_invalidOpaque(self): (source) ¶

DigestCredentialFactory.decode raises LoginFailed when the opaque value does not contain all the required parts.

def test_md5DefaultAlgorithm(self): (source) ¶

The algorithm defaults to MD5 if it is not supplied in the response.

def test_MD5HashA1(self, _algorithm=b'md5', _hash=md5): (source) ¶

calcHA1 accepts the 'md5' algorithm and returns an MD5 hash of its parameters, excluding the nonce and cnonce.

def test_MD5HashA2Auth(self, _algorithm=b'md5', _hash=md5): (source) ¶

calcHA2 accepts the 'md5' algorithm and returns an MD5 hash of its arguments, excluding the entity hash for QOP other than 'auth-int'.

def test_MD5HashA2AuthInt(self, _algorithm=b'md5', _hash=md5): (source) ¶

calcHA2 accepts the 'md5' algorithm and returns an MD5 hash of its arguments, including the entity hash for QOP of 'auth-int'.

def test_MD5HashResponse(self, _algorithm=b'md5', _hash=md5): (source) ¶

calcResponse accepts the 'md5' algorithm and returns an MD5 hash of its parameters, excluding the nonce count, client nonce, and QoP value if the nonce count and client nonce are None

def test_MD5HashResponseExtra(self, _algorithm=b'md5', _hash=md5): (source) ¶

calcResponse accepts the 'md5' algorithm and returns an MD5 hash of its parameters, including the nonce count, client nonce, and QoP value if they are specified.

def test_MD5SessHashA2Auth(self): (source) ¶

calcHA2 accepts the 'md5-sess' algorithm and QOP of 'auth' and returns the same value as it does for the 'md5' algorithm.

def test_MD5SessHashA2AuthInt(self): (source) ¶

calcHA2 accepts the 'md5-sess' algorithm and QOP of 'auth-int' and returns the same value as it does for the 'md5' algorithm.

def test_MD5SessionHashA1(self): (source) ¶

calcHA1 accepts the 'md5-sess' algorithm and returns an MD5 hash of its parameters, including the nonce and cnonce.

def test_MD5SessionHashResponse(self): (source) ¶

calcResponse accepts the 'md5-sess' algorithm and returns an MD5 hash of its parameters, excluding the nonce count, client nonce, and QoP value if the nonce count and client nonce are None

def test_MD5SessionHashResponseExtra(self): (source) ¶

calcResponse accepts the 'md5-sess' algorithm and returns an MD5 hash of its parameters, including the nonce count, client nonce, and QoP value if they are specified.

def test_mismatchedOpaqueChecksum(self): (source) ¶

DigestCredentialFactory.decode raises LoginFailed when the opaque checksum fails verification.

def test_multiResponse(self): (source) ¶

DigestCredentialFactory.decode handles multiple responses to a single challenge.

def test_noNewlineOpaque(self): (source) ¶

DigestCredentialFactory._generateOpaque returns a value without newlines, regardless of the length of the nonce.

def test_noNonce(self): (source) ¶

DigestCredentialFactory.decode raises LoginFailed if the response has no nonce.

def test_noOpaque(self): (source) ¶

DigestCredentialFactory.decode raises LoginFailed if the response has no opaque.

def test_noUsername(self): (source) ¶

DigestCredentialFactory.decode raises LoginFailed if the response has no username field or if the username field is empty.

def test_oldNonce(self): (source) ¶

DigestCredentialFactory.decode raises LoginFailed when the given opaque is older than DigestCredentialFactory.CHALLENGE_LIFETIME_SECS

def test_response(self, quotes=True): (source) ¶

DigestCredentialFactory.decode accepts a digest challenge response and parses it into an IUsernameHashedPassword provider.

def test_responseWithCommaURI(self): (source) ¶

DigestCredentialFactory.decode accepts a digest challenge response which quotes the values of its fields and includes a b"," in the URI field.

def test_responseWithoutClientIP(self): (source) ¶

DigestCredentialFactory.decode accepts a digest challenge response even if the client address it is passed is None.

def test_responseWithoutQuotes(self): (source) ¶

DigestCredentialFactory.decode accepts a digest challenge response which does not quote the values of its fields and parses it into an IUsernameHashedPassword provider in the same way it would a response which included quoted field values.

def test_SHAHashA1(self): (source) ¶

calcHA1 accepts the 'sha' algorithm and returns a SHA hash of its parameters, excluding the nonce and cnonce.

def test_SHAHashA2Auth(self): (source) ¶

calcHA2 accepts the 'sha' algorithm and returns a SHA hash of its arguments, excluding the entity hash for QOP other than 'auth-int'.

def test_SHAHashA2AuthInt(self): (source) ¶

calcHA2 accepts the 'sha' algorithm and returns a SHA hash of its arguments, including the entity hash for QOP of 'auth-int'.

def test_SHAHashResponse(self): (source) ¶

calcResponse accepts the 'sha' algorithm and returns a SHA hash of its parameters, excluding the nonce count, client nonce, and QoP value if the nonce count and client nonce are None

def test_SHAHashResponseExtra(self): (source) ¶

calcResponse accepts the 'sha' algorithm and returns a SHA hash of its parameters, including the nonce count, client nonce, and QoP value if they are specified.

algorithm = (source) ¶

Undocumented

clientAddress = (source) ¶

Undocumented

cnonce: bytes = (source) ¶

Undocumented

credentialFactory = (source) ¶

Undocumented

method: bytes = (source) ¶

Undocumented

password: bytes = (source) ¶

Undocumented