twisted.conch.client.default module documentationtwisted.conch.client
View Source
Various classes and functions for implementing user-interaction in the command-line conch client.
You probably shouldn't use anything in this module directly, since it
assumes you are sitting at an interactive terminal. For example, to
programmatically interact with a known_hosts database, use twisted.conch.client.knownhosts.
| Function | verifyHostKey | Verify a host's key. |
| Function | isInKnownHosts | Checks to see if host is in the known_hosts file for the user. |
| Function | getHostKeyAlgorithms | Look in known_hosts for a key corresponding to host. This
can be used to change the order of supported key types in the KEXINIT
packet. |
| Class | SSHUserAuthClient | No class docstring; 2/2 class methods, 4/11 methods documented |
Verify a host's key.
This function is a gross vestige of some bad factoring in the client
internals. The actual implementation, and a better signature of this logic
is in KnownHostsFile.verifyHostKey.
This function is not deprecated yet because the callers have not yet been
rehabilitated, but they should eventually be changed to call that method
instead.
However, this function does perform two functions not implemented by KnownHostsFile.verifyHostKey.
It determines the path to the user's known_hosts file based on the options
(which should really be the options object's job), and it provides an
opener to ConsoleUI
which opens '/dev/tty' so that the user will be prompted on the tty of the
process even if the input and output of the process has been redirected.
This latter part is, somewhat obviously, not portable, but I don't know of
a portable equivalent that could be used.
| Parameters | host | Due to a bug in SSHClientTransport.verifyHostKey,
this is always the dotted-quad IP address of the host being connected to. (type: str) |
| transport | the client transport which is attempting to connect to the given host. (type: SSHClientTransport) | |
| fingerprint | the fingerprint of the given public key, in xx:xx:xx:... format. This is
ignored in favor of getting the fingerprint from the key itself. (type: str) | |
| pubKey | The public key of the server being connected to. (type: str) | |
| Returns | a Deferred
which fires with 1 if the key was successfully verified, or
fails if the key could not be successfully verified. Failure types may
include HostKeyChanged,
UserRejectedKey,
IOError
or KeyboardInterrupt. | |
Checks to see if host is in the known_hosts file for the user.
| Returns | 0 if it isn't, 1 if it is and is the same, 2 if it's changed. (type: int) | |
Look in known_hosts for a key corresponding to host. This
can be used to change the order of supported key types in the KEXINIT
packet.
| Parameters | host | the host to check in known_hosts (type: str) |
| options | options passed to client (type: twisted.conch.client.options.ConchOptions) | |
| Returns | list
of str
representing key types or None. | |