twisted.cred.test.test_digestauth.DigestAuthTests

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

Method	setUp	Create a DigestCredentialFactory for testing
Method	test_MD5HashA1	`calcHA1` accepts the `'md5'` algorithm and returns an MD5 hash of its parameters, excluding the nonce and cnonce.
Method	test_MD5SessionHashA1	`calcHA1` accepts the `'md5-sess'` algorithm and returns an MD5 hash of its parameters, including the nonce and cnonce.
Method	test_SHAHashA1	`calcHA1` accepts the `'sha'` algorithm and returns a SHA 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_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_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_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_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_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_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_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_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.
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	test_response	`DigestCredentialFactory.decode` accepts a digest challenge response and parses it into an `IUsernameHashedPassword` provider.
Method	test_responseWithoutQuotes	No summary
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_caseInsensitiveAlgorithm	The case of the algorithm value in the response is ignored when checking the credentials.
Method	test_md5DefaultAlgorithm	The algorithm defaults to MD5 if it is not supplied in the response.
Method	test_responseWithoutClientIP	`DigestCredentialFactory.decode` accepts a digest challenge response even if the client address it is passed is `None`.
Method	test_multiResponse	`DigestCredentialFactory.decode` handles multiple responses to a single challenge.
Method	test_failsWithDifferentMethod	No summary
Method	test_noUsername	`DigestCredentialFactory.decode` raises `LoginFailed` if the response has no username field or if the username field is empty.
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_checkHash	`DigestCredentialFactory.decode` returns an `IUsernameDigestHash` provider which can verify a hash of the form 'username:realm:password'.
Method	test_invalidOpaque	`DigestCredentialFactory.decode` raises `LoginFailed` when the opaque value does not contain all the required parts.
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_incompatibleClientIP	`DigestCredentialFactory.decode` raises `LoginFailed` when the request comes from a client IP other than what is encoded in the opaque.
Method	test_oldNonce	`DigestCredentialFactory.decode` raises `LoginFailed` when the given opaque is older than `DigestCredentialFactory.CHALLENGE_LIFETIME_SECS`
Method	test_mismatchedOpaqueChecksum	`DigestCredentialFactory.decode` raises `LoginFailed` when the opaque checksum fails verification.
Method	test_incompatibleCalcHA1Options	`calcHA1` raises `TypeError` when any of the pszUsername, pszRealm, or pszPassword arguments are specified with the preHA1 keyword argument.
Method	test_noNewlineOpaque	`DigestCredentialFactory._generateOpaque` returns a value without newlines, regardless of the length of the nonce.

Inherited from TestCase:

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	__init__	Construct an asynchronous test case for `methodName`.
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	__call__	Run the test. Should always do exactly the same thing as run().
Method	deferSetUp	Undocumented
Method	deferTestMethod	Undocumented
Method	deferTearDown	Undocumented
Method	deferRunCleanups	Run any scheduled cleanups and report errors (if any to the result object.
Method	addCleanup	Extend the base cleanup feature with support for cleanup functions which return Deferreds.
Method	getSuppress	Undocumented
Method	getTimeout	No summary
Method	_run	Run a single method, either a test method or fixture.
Method	_ebDeferSetUp	Undocumented
Method	_cbDeferTestMethod	Undocumented
Method	_ebDeferTestMethod	Undocumented
Method	_ebDeferTearDown	Undocumented
Method	_cbDeferRunCleanups	Undocumented
Method	_cleanUp	Undocumented
Method	_classCleanUp	Undocumented
Method	_makeReactorMethod	Create a method which wraps the reactor method `name`. The new method issues a deprecation warning and calls the original.
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	_undeprecateReactor	Restore the deprecated reactor methods. Undoes what `_deprecateReactor` did.
Method	_runCleanups	Run the cleanups added with `addCleanup` in order.
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	_wait	Take a Deferred that only ever callbacks. Block until it happens.

Inherited from SynchronousTestCase (via TestCase):

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	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.
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`.
Method	__eq__	No summary
Method	__ne__	Undocumented
Method	__hash__	Undocumented
Method	shortDescription	Undocumented
Method	getSkip	No summary
Method	getTodo	No summary
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	run	Run the test case, storing the results in `result`.
Method	patch	Monkey patch an object for the duration of the test.
Method	flushLoggedErrors	Remove stored errors received from the log.
Method	flushWarnings	Remove stored warnings from the list of captured warnings and return them.
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	mktemp	Create a new path name which can be used for a new file or directory.
Method	_getSuppress	No summary
Method	_getSkipReason	Return the reason to use for skipping a test method.
Method	_installObserver	Undocumented
Method	_removeObserver	Undocumented

Inherited from _Assertions (via TestCase, SynchronousTestCase):

Method	fail	Absolutely fail the test. Do not pass go, do not collect $200.
Method	assertFalse	Fail the test if `condition` evaluates to True.
Method	assertTrue	Fail the test if `condition` evaluates to False.
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	assertEqual	Fail the test if `first` and `second` are not equal.
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	assertIsNot	Fail the test if `first` is `second`. This is an obect-identity-equality test, not an object equality (i.e. `__eq__`) test.
Method	assertNotEqual	Fail the test if `first` == `second`.
Method	assertIn	Fail the test if `containee` is not found in `container`.
Method	assertNotIn	Fail the test if `containee` is found in `container`.
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	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	assertSubstring	Fail if `substring` does not exist within `astring`.
Method	assertNotSubstring	Fail if `astring` contains `substring`.
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	assertIsInstance	Fail if `instance` is not an instance of the given class or of one of the given classes.
Method	assertNotIsInstance	Fail if `instance` is an instance of the given class or of one of the given classes.
Method	successResultOf	Return the current success result of `deferred` or raise `self.failureException`.
Method	failureResultOf	Return the current failure result of `deferred` or raise `self.failureException`.
Method	assertNoResult	Assert that `deferred` does not have a result at this point.
Method	assertRegex	Fail the test if a `regexp` search of `text` fails.

def setUp(self):

Create a DigestCredentialFactory for testing

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

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

def test_MD5SessionHashA1(self):

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

def test_SHAHashA1(self):

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

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

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='md5', _hash=md5):

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

def test_MD5SessHashA2Auth(self):

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):

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_SHAHashA2Auth(self):

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):

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

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

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_MD5SessionHashResponse(self):

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_SHAHashResponse(self):

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_MD5HashResponseExtra(self, _algorithm='md5', _hash=md5):

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_MD5SessionHashResponseExtra(self):

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_SHAHashResponseExtra(self):

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.

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

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	The given fields formatted for use as an HTTP header value. (type: `bytes`)
Unknown Field: types	quotes	`bool`

def getDigestResponse(self, challenge, ncount):

Calculate the response for the given challenge

def test_response(self, quotes=True):

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

def test_responseWithoutQuotes(self):

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_responseWithCommaURI(self):

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

def test_caseInsensitiveAlgorithm(self):

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

def test_md5DefaultAlgorithm(self):

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

def test_responseWithoutClientIP(self):

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

def test_multiResponse(self):

DigestCredentialFactory.decode handles multiple responses to a single challenge.

def test_failsWithDifferentMethod(self):

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_noUsername(self):

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

def test_noNonce(self):

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

def test_noOpaque(self):

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

def test_checkHash(self):

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

def test_invalidOpaque(self):

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

def test_incompatibleNonce(self):

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

def test_incompatibleClientIP(self):

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

def test_oldNonce(self):

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

def test_mismatchedOpaqueChecksum(self):

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

def test_incompatibleCalcHA1Options(self):

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

def test_noNewlineOpaque(self):

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

API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.

twisted.cred.test.test_digestauth.DigestAuthTests(TestCase) class documentation

`twisted.cred.test.test_digestauth.DigestAuthTests(TestCase)` class documentation