twisted.conch.interfaces.IConchUser(Interface) interface documentationtwisted.conch.interfaces
(View In Hierarchy)
Known implementations: twisted.conch.avatar.ConchUser
A user who has been authenticated to Cred through Conch. This is the interface between the SSH connection and the user.
| Attribute | conn | The SSHConnection object for this user. |
| Method | lookupChannel | The other side requested a channel of some sort. |
| Method | lookupSubsystem | The other side requested a subsystem. |
| Method | gotGlobalRequest | A global request was sent from the other side. |
The other side requested a channel of some sort.
channelType is the type of channel being requested, as an
ssh connection protocol channel type. data is any other packet
data (often nothing).
We return a subclass of SSHChannel.
If the channel type is unknown, we return None.
For other failures, we raise an exception. If a ConchError is
raised, the .value will be the message, and the
.data will be the error code.
| Parameters | channelType | The requested channel type (type: bytes) |
| windowSize | The initial size of the remote window (type: int) | |
| maxPacket | The largest packet we should send (type: int) | |
| data | Additional request data (type: bytes) | |
| Returns | (type: a subclass of SSHChannel
or None) | |
The other side requested a subsystem.
We return a Protocol
implementing the requested subsystem. If the subsystem is not available, we
return None.
| Parameters | subsystem | The name of the subsystem being requested (type: bytes) |
| data | Additional request data (often nothing) (type: bytes) | |
| Returns | (type: Protocol
or None) | |
A global request was sent from the other side.
We return a true value on success or a false value on failure. If we indicate success by returning a tuple, its second item will be sent to the other side as additional response data.
| Parameters | requestType | The type of the request (type: bytes) |
| data | Additional request data (type: bytes) | |
| Returns | (type: boolean or tuple) | |