No class docstring
Method setUp Undocumented
Method tearDown Undocumented
Method test_size The keys.Key.size method returns the size of key object in bits.
Method test__guessStringType Test that the _guessStringType method guesses string types correctly.
Method test_public The keys.Key.public method returns a public key for both public and private keys.
Method test_isPublic The keys.Key.isPublic method returns True for public keys otherwise False.
Method test_fromOpenSSH Test that keys are correctly generated from OpenSSH strings.
Method test_fromOpenSSHErrors Tests for invalid key types.
Method test_fromOpenSSH_with_whitespace If key strings have trailing whitespace, it should be ignored.
Method test_fromNewerOpenSSH Newer versions of OpenSSH generate encrypted keys which have a longer IV than the older versions. These newer keys are also loaded.
Method test_fromOpenSSH_v1_format No summary
Method test_fromOpenSSH_windows_line_endings Test that keys are correctly generated from OpenSSH strings with Windows line endings.
Method test_fromLSHPublicUnsupportedType BadKeyError exception is raised when public key has an unknown type.
Method test_fromLSHPrivateUnsupportedType BadKeyError exception is raised when private key has an unknown type.
Method test_fromLSHRSA RSA public and private keys can be generated from a LSH strings.
Method test_fromLSHDSA DSA public and private key can be generated from LSHs.
Method test_fromAgentv3 Test that keys are correctly generated from Agent v3 strings.
Method test_fromStringErrors keys.Key.fromString should raise BadKeyError when the key is invalid.
Method test_fromFile Test that fromFile works correctly.
Method test_init Test that the PublicKey object is initialized correctly.
Method test_equal Test that Key objects are compared correctly.
Method test_notEqual Test that Key objects are not-compared correctly.
Method test_dataError The keys.Key.data method raises RuntimeError for bad keys.
Method test_fingerprintdefault Test that the fingerprint method returns fingerprint in L{FingerprintFormats.MD5-HEX} format by default.
Method test_fingerprint_md5_hex fingerprint method generates key fingerprint in L{FingerprintFormats.MD5-HEX} format if explicitly specified.
Method test_fingerprintsha256 fingerprint method generates key fingerprint in L{FingerprintFormats.SHA256-BASE64} format if explicitly specified.
Method test_fingerprintBadFormat A BadFingerPrintFormat error is raised when unsupported formats are requested.
Method test_type Test that the type method returns the correct type for an object.
Method test_fromBlobUnsupportedType A BadKeyError error is raised whey the blob has an unsupported key type.
Method test_fromBlobRSA A public RSA key is correctly generated from a public key blob.
Method test_fromBlobDSA A public DSA key is correctly generated from a public key blob.
Method test_fromBlobECDSA Key.fromString generates ECDSA keys from blobs.
Method test_fromPrivateBlobUnsupportedType BadKeyError is raised when loading a private blob with an unsupported type.
Method test_fromPrivateBlobRSA A private RSA key is correctly generated from a private key blob.
Method test_fromPrivateBlobDSA A private DSA key is correctly generated from a private key blob.
Method test_fromPrivateBlobECDSA A private EC key is correctly generated from a private key blob.
Method test_blobRSA Return the over-the-wire SSH format of the RSA public key.
Method test_blobDSA Return the over-the-wire SSH format of the DSA public key.
Method test_blobEC Return the over-the-wire SSH format of the EC public key.
Method test_blobNoKey RuntimeError is raised when the blob is requested for a Key which is not wrapping anything.
Method test_privateBlobRSA keys.Key.privateBlob returns the SSH protocol-level format of an RSA private key.
Method test_privateBlobDSA keys.Key.privateBlob returns the SSH protocol-level format of a DSA private key.
Method test_privateBlobEC keys.Key.privateBlob returns the SSH ptotocol-level format of EC private key.
Method test_privateBlobNoKeyObject Raises RuntimeError if the underlying key object does not exists.
Method test_toOpenSSHRSA keys.Key.toString serializes an RSA key in OpenSSH format.
Method test_toOpenSSHRSA_v1_format keys.Key.toString serializes an RSA key in OpenSSH's v1 format.
Method test_toOpenSSHDSA keys.Key.toString serializes a DSA key in OpenSSH format.
Method test_toOpenSSHDSA_v1_format keys.Key.toString serializes a DSA key in OpenSSH's v1 format.
Method test_toOpenSSHECDSA keys.Key.toString serializes an ECDSA key in OpenSSH format.
Method test_toOpenSSHECDSA_v1_format keys.Key.toString serializes an ECDSA key in OpenSSH's v1 format.
Method test_toLSHRSA keys.Key.toString serializes an RSA key in LSH format.
Method test_toLSHDSA keys.Key.toString serializes a DSA key in LSH format.
Method test_toAgentv3RSA keys.Key.toString serializes an RSA key in Agent v3 format.
Method test_toAgentv3DSA keys.Key.toString serializes a DSA key in Agent v3 format.
Method test_toStringErrors keys.Key.toString raises keys.BadKeyError when passed an invalid format type.
Method test_signAndVerifyRSA Signed data can be verified using RSA.
Method test_signAndVerifyDSA Signed data can be verified using DSA.
Method test_signAndVerifyEC Signed data can be verified using EC.
Method test_verifyRSA A known-good RSA signature verifies successfully.
Method test_verifyDSA A known-good DSA signature verifies successfully.
Method test_verifyDSANoPrefix Some commercial SSH servers send DSA keys as 2 20-byte numbers; they are still verified as valid keys.
Method test_reprPrivateRSA The repr of a keys.Key contains all of the RSA components for an RSA private key.
Method test_reprPublicRSA The repr of a keys.Key contains all of the RSA components for an RSA public key.
Method test_reprPublicECDSA The repr of a keys.Key contains all the OpenSSH format for an ECDSA public key.
Method test_reprPrivateECDSA The repr of a keys.Key contains all the OpenSSH format for an ECDSA private key.
Method _testPublicPrivateFromString Undocumented
Method _testPublicFromString Undocumented
Method _testPrivateFromString Undocumented

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

The keys.Key.size method returns the size of key object in bits.

def test__guessStringType(self):

Test that the _guessStringType method guesses string types correctly.

def test_public(self):

The keys.Key.public method returns a public key for both public and private keys.

def test_isPublic(self):

The keys.Key.isPublic method returns True for public keys otherwise False.

def _testPublicPrivateFromString(self, public, private, type, data):
Undocumented
def _testPublicFromString(self, public, type, data):
Undocumented
def _testPrivateFromString(self, private, type, data):
Undocumented
def test_fromOpenSSH(self):

Test that keys are correctly generated from OpenSSH strings.

def test_fromOpenSSHErrors(self):

Tests for invalid key types.

def test_fromOpenSSH_with_whitespace(self):

If key strings have trailing whitespace, it should be ignored.

def test_fromNewerOpenSSH(self):

Newer versions of OpenSSH generate encrypted keys which have a longer IV than the older versions. These newer keys are also loaded.

def test_fromOpenSSH_v1_format(self):

OpenSSH 6.5 introduced a newer "openssh-key-v1" private key format (made the default in OpenSSH 7.8). Loading keys in this format produces identical results to loading the same keys in the old PEM-based format.

def test_fromOpenSSH_windows_line_endings(self):

Test that keys are correctly generated from OpenSSH strings with Windows line endings.

def test_fromLSHPublicUnsupportedType(self):

BadKeyError exception is raised when public key has an unknown type.

def test_fromLSHPrivateUnsupportedType(self):

BadKeyError exception is raised when private key has an unknown type.

def test_fromLSHRSA(self):

RSA public and private keys can be generated from a LSH strings.

def test_fromLSHDSA(self):

DSA public and private key can be generated from LSHs.

def test_fromAgentv3(self):

Test that keys are correctly generated from Agent v3 strings.

def test_fromStringErrors(self):

keys.Key.fromString should raise BadKeyError when the key is invalid.

def test_fromFile(self):

Test that fromFile works correctly.

def test_init(self):

Test that the PublicKey object is initialized correctly.

def test_equal(self):

Test that Key objects are compared correctly.

def test_notEqual(self):

Test that Key objects are not-compared correctly.

def test_dataError(self):

The keys.Key.data method raises RuntimeError for bad keys.

def test_fingerprintdefault(self):
Test that the fingerprint method returns fingerprint in
L{FingerprintFormats.MD5-HEX} format by default.
def test_fingerprint_md5_hex(self):
fingerprint method generates key fingerprint in
L{FingerprintFormats.MD5-HEX} format if explicitly specified.
def test_fingerprintsha256(self):
fingerprint method generates key fingerprint in
L{FingerprintFormats.SHA256-BASE64} format if explicitly specified.
def test_fingerprintBadFormat(self):

A BadFingerPrintFormat error is raised when unsupported formats are requested.

def test_type(self):

Test that the type method returns the correct type for an object.

def test_fromBlobUnsupportedType(self):

A BadKeyError error is raised whey the blob has an unsupported key type.

def test_fromBlobRSA(self):

A public RSA key is correctly generated from a public key blob.

def test_fromBlobDSA(self):

A public DSA key is correctly generated from a public key blob.

def test_fromBlobECDSA(self):

Key.fromString generates ECDSA keys from blobs.

def test_fromPrivateBlobUnsupportedType(self):

BadKeyError is raised when loading a private blob with an unsupported type.

def test_fromPrivateBlobRSA(self):

A private RSA key is correctly generated from a private key blob.

def test_fromPrivateBlobDSA(self):

A private DSA key is correctly generated from a private key blob.

def test_fromPrivateBlobECDSA(self):

A private EC key is correctly generated from a private key blob.

def test_blobRSA(self):

Return the over-the-wire SSH format of the RSA public key.

def test_blobDSA(self):

Return the over-the-wire SSH format of the DSA public key.

def test_blobEC(self):

Return the over-the-wire SSH format of the EC public key.

def test_blobNoKey(self):

RuntimeError is raised when the blob is requested for a Key which is not wrapping anything.

def test_privateBlobRSA(self):

keys.Key.privateBlob returns the SSH protocol-level format of an RSA private key.

def test_privateBlobDSA(self):

keys.Key.privateBlob returns the SSH protocol-level format of a DSA private key.

def test_privateBlobEC(self):

keys.Key.privateBlob returns the SSH ptotocol-level format of EC private key.

def test_privateBlobNoKeyObject(self):

Raises RuntimeError if the underlying key object does not exists.

def test_toOpenSSHRSA(self):

keys.Key.toString serializes an RSA key in OpenSSH format.

def test_toOpenSSHRSA_v1_format(self):

keys.Key.toString serializes an RSA key in OpenSSH's v1 format.

def test_toOpenSSHDSA(self):

keys.Key.toString serializes a DSA key in OpenSSH format.

def test_toOpenSSHDSA_v1_format(self):

keys.Key.toString serializes a DSA key in OpenSSH's v1 format.

def test_toOpenSSHECDSA(self):

keys.Key.toString serializes an ECDSA key in OpenSSH format.

def test_toOpenSSHECDSA_v1_format(self):

keys.Key.toString serializes an ECDSA key in OpenSSH's v1 format.

def test_toLSHRSA(self):

keys.Key.toString serializes an RSA key in LSH format.

def test_toLSHDSA(self):

keys.Key.toString serializes a DSA key in LSH format.

def test_toAgentv3RSA(self):

keys.Key.toString serializes an RSA key in Agent v3 format.

def test_toAgentv3DSA(self):

keys.Key.toString serializes a DSA key in Agent v3 format.

def test_toStringErrors(self):

keys.Key.toString raises keys.BadKeyError when passed an invalid format type.

def test_signAndVerifyRSA(self):

Signed data can be verified using RSA.

def test_signAndVerifyDSA(self):

Signed data can be verified using DSA.

def test_signAndVerifyEC(self):

Signed data can be verified using EC.

def test_verifyRSA(self):

A known-good RSA signature verifies successfully.

def test_verifyDSA(self):

A known-good DSA signature verifies successfully.

def test_verifyDSANoPrefix(self):

Some commercial SSH servers send DSA keys as 2 20-byte numbers; they are still verified as valid keys.

def test_reprPrivateRSA(self):

The repr of a keys.Key contains all of the RSA components for an RSA private key.

def test_reprPublicRSA(self):

The repr of a keys.Key contains all of the RSA components for an RSA public key.

def test_reprPublicECDSA(self):

The repr of a keys.Key contains all the OpenSSH format for an ECDSA public key.

def test_reprPrivateECDSA(self):

The repr of a keys.Key contains all the OpenSSH format for an ECDSA private key.

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