twisted.conch.test.test_userauth.SSHUserAuthServerTests(unittest.TestCase) class documentation

Part of twisted.conch.test.test_userauth (View In Hierarchy)

Tests for SSHUserAuthServer.

Method setUp Undocumented
Method tearDown Undocumented
Method test_noneAuthentication A client may request a list of authentication 'method name' values that may continue by using the "none" authentication 'method name'.
Method test_successfulPasswordAuthentication When provided with correct password authentication information, the server should respond by sending a MSG_USERAUTH_SUCCESS message with no other data.
Method test_failedPasswordAuthentication No summary
Method test_successfulPrivateKeyAuthentication Test that private key authentication completes successfully,
Method test_requestRaisesConchError ssh_USERAUTH_REQUEST should raise a ConchError if tryAuth returns None. Added to catch a bug noticed by pyflakes.
Method test_verifyValidPrivateKey Test that verifying a valid private key works.
Method test_failedPrivateKeyAuthenticationWithoutSignature Test that private key authentication fails when the public key is invalid.
Method test_failedPrivateKeyAuthenticationWithSignature Test that private key authentication fails when the public key is invalid.
Method test_unsupported_publickey Private key authentication fails when the public key type is unsupported or the public key is corrupt.
Method test_ignoreUnknownCredInterfaces No summary
Method test_removePasswordIfUnencrypted Test that the userauth service does not advertise password authentication if the password would be send in cleartext.
Method test_unencryptedConnectionWithoutPasswords If the SSHUserAuthServer is not advertising passwords, then an unencrypted connection should not cause any warnings or exceptions. This is a white box test.
Method test_loginTimeout Test that the login times out.
Method test_cancelLoginTimeout Test that stopping the service also stops the login timeout.
Method test_tooManyAttempts Test that the server disconnects if the client fails authentication too many times.
Method test_failIfUnknownService If the user requests a service that we don't support, the authentication should fail.
Method test_tryAuthEdgeCases tryAuth() has two edge cases that are difficult to reach.
Method _checkFailed Check that the authentication has failed.

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.Deferreds. 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):
Undocumented
def tearDown(self):
Undocumented
def _checkFailed(self, ignored):

Check that the authentication has failed.

def test_noneAuthentication(self):

A client may request a list of authentication 'method name' values that may continue by using the "none" authentication 'method name'.

See RFC 4252 Section 5.2.

def test_successfulPasswordAuthentication(self):

When provided with correct password authentication information, the server should respond by sending a MSG_USERAUTH_SUCCESS message with no other data.

See RFC 4252, Section 5.1.

def test_failedPasswordAuthentication(self):

When provided with invalid authentication details, the server should respond by sending a MSG_USERAUTH_FAILURE message which states whether the authentication was partially successful, and provides other, open options for authentication.

See RFC 4252, Section 5.1.

def test_successfulPrivateKeyAuthentication(self):

Test that private key authentication completes successfully,

def test_requestRaisesConchError(self):

ssh_USERAUTH_REQUEST should raise a ConchError if tryAuth returns None. Added to catch a bug noticed by pyflakes.

def test_verifyValidPrivateKey(self):

Test that verifying a valid private key works.

def test_failedPrivateKeyAuthenticationWithoutSignature(self):

Test that private key authentication fails when the public key is invalid.

def test_failedPrivateKeyAuthenticationWithSignature(self):

Test that private key authentication fails when the public key is invalid.

def test_unsupported_publickey(self):

Private key authentication fails when the public key type is unsupported or the public key is corrupt.

def test_ignoreUnknownCredInterfaces(self):

SSHUserAuthServer sets up SSHUserAuthServer.supportedAuthentications by checking the portal's credentials interfaces and mapping them to SSH authentication method strings. If the Portal advertises an interface that SSHUserAuthServer can't map, it should be ignored. This is a white box test.

def test_removePasswordIfUnencrypted(self):

Test that the userauth service does not advertise password authentication if the password would be send in cleartext.

def test_unencryptedConnectionWithoutPasswords(self):

If the SSHUserAuthServer is not advertising passwords, then an unencrypted connection should not cause any warnings or exceptions. This is a white box test.

def test_loginTimeout(self):

Test that the login times out.

def test_cancelLoginTimeout(self):

Test that stopping the service also stops the login timeout.

def test_tooManyAttempts(self):

Test that the server disconnects if the client fails authentication too many times.

def test_failIfUnknownService(self):

If the user requests a service that we don't support, the authentication should fail.

def test_tryAuthEdgeCases(self): 
tryAuth() has two edge cases that are difficult to reach.

1) an authentication method auth_* returns None instead of a Deferred.
2) an authentication type that is defined does not have a matching
   auth_* method.

Both these cases should return a Deferred which fails with a
ConchError.
API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.