twisted.conch.avatar.ConchUser : API documentation

_log = (source)

Undocumented

def __init__(self): (source)

overridden in twisted.conch.manhole_ssh.TerminalUser, twisted.conch.unix.UnixConchUser

Undocumented

channelLookup = (source)

Undocumented

(type: dict)

subsystemLookup = (source)

Undocumented

(type: dict)

@property
conn = (source)

from twisted.conch.interfaces.IConchUser

The SSHConnection object for this user.

@conn.setter
def conn(self, value): (source)

Undocumented

_conn = (source)

Undocumented

def lookupChannel(self, channelType, windowSize, maxPacket, data): (source)

from twisted.conch.interfaces.IConchUser

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	Undocumented (type: a subclass of `SSHChannel` or `None`)

def lookupSubsystem(self, subsystem, data): (source)

from twisted.conch.interfaces.IConchUser

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	Undocumented (type: `Protocol` or `None`)

def gotGlobalRequest(self, requestType, data): (source)

from twisted.conch.interfaces.IConchUser

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	Undocumented (type: boolean or `tuple`)

Method	__init__	Undocumented
Instance Variable	channelLookup	Undocumented
Instance Variable	subsystemLookup	Undocumented
Property	conn	The SSHConnection object for this user.
Method	conn.setter	Undocumented
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.
Class Variable	_log	Undocumented
Instance Variable	_conn	Undocumented