Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`conch`.`scripts`.`ckeygen``

module documentation
(source)

Implementation module for the `ckeygen` command.

Class | `GeneralOptions` | Undocumented
Function | `changePassPhrase` | Undocumented
Function | `displayPublicKey` | Undocumented
Function | `enumrepresentation` | Undocumented
Function | `generateDSAkey` | Undocumented
Function | `generateECDSAkey` | Undocumented
Function | `generateEd25519key` | Undocumented
Function | `generateRSAkey` | Undocumented
Function | `handleError` | Undocumented
Function | `printFingerprint` | Undocumented
Function | `run` | Undocumented
Variable | `supportedKeyTypes` | Undocumented
Function | `_defaultPrivateKeySubtype` | Return a reasonable default private key subtype for a given key type.
Function | `_inputSaveFile` | Ask the user where to save the key.
Function | `_keyGenerator` | Undocumented
Function | `_saveKey` | Persist a SSH key on local filesystem.

def changePassPhrase(options): (source)

Undocumented

def displayPublicKey(options): (source)

Undocumented

def enumrepresentation(options): (source)

Undocumented

@_keyGenerator('dsa')
def generateDSAkey(options): (source)

Undocumented

@_keyGenerator('ecdsa')
def generateECDSAkey(options): (source)

Undocumented

@_keyGenerator('ed25519')
def generateEd25519key(options): (source)

Undocumented

@_keyGenerator('rsa')
def generateRSAkey(options): (source)

Undocumented

def handleError(): (source)

Undocumented

def printFingerprint(options): (source)

Undocumented

def run(): (source)

Undocumented

supportedKeyTypes = (source)

Undocumented

def _defaultPrivateKeySubtype(keyType): (source)

Return a reasonable default private key subtype for a given key type.

Parameters
keyType:`str` | A key type, as returned by `twisted.conch.ssh.keys.Key.type`.
Returns
`str` | A private OpenSSH key subtype (`'PEM'` or `'v1'`).

def _inputSaveFile(prompt): (source)

Ask the user where to save the key.

This needs to be a separate function so the unit test can patch it.

Parameters
prompt:`str` | Undocumented
Returns
`str` | Undocumented

def _keyGenerator(keyType): (source)

Undocumented

def _saveKey(key, options): (source)

Persist a SSH key on local filesystem.

Parameters
key:`keys.Key` implementation. | Key which is persisted on local filesystem.
options:`dict` |