class documentation

class twisted.conch.telnet.AuthenticatingTelnetProtocol(StatefulTelnetProtocol): (source)

View In Hierarchy

A protocol which prompts for credentials and attempts to authenticate them.

Username and password prompts are given (the password is obscured). When the information is collected, it is passed to a portal and an avatar implementing ITelnetProtocol is requested. If an avatar is returned, it connected to this protocol's transport, and this protocol's transport is connected to it. Otherwise, the user is re-prompted for credentials.

Instance Variable state Undocumented
Instance Variable protocol Undocumented
Method __init__ Undocumented
Instance Variable portal Undocumented
Method connectionMade Called when a connection is made.
Method connectionLost Called when the connection is shut down.
Method telnet_User Undocumented
Instance Variable username Undocumented
Method telnet_Password Undocumented
Instance Variable logout Undocumented
Method _cbLogin Undocumented
Method _ebLogin Undocumented

Inherited from StatefulTelnetProtocol:

Class Variable delimiter Undocumented
Method lineReceived Override this for when each line is received.
Method telnet_Discard Undocumented

Inherited from LineReceiver (via StatefulTelnetProtocol):

Class Variable MAX_LENGTH The maximum length of a line to allow (If a sent line is longer than this, the connection is dropped). Default is 16384.
Instance Variable line_mode Undocumented
Method clearLineBuffer Clear buffered data.
Method dataReceived Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
Method setLineMode Sets the line-mode of this receiver.
Method setRawMode Sets the raw mode of this receiver. Further data received will be sent to rawDataReceived rather than lineReceived.
Method rawDataReceived Override this for when raw data is received.
Method sendLine Sends a line to the other end of the connection.
Method lineLengthExceeded Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.
Instance Variable _buffer Undocumented
Instance Variable _busyReceiving Undocumented

Inherited from Protocol (via StatefulTelnetProtocol, LineReceiver):

Class Variable factory Undocumented
Method logPrefix Return a prefix matching the class name, to identify log messages related to this protocol instance.

Inherited from BaseProtocol (via StatefulTelnetProtocol, LineReceiver, Protocol):

Instance Variable connected Undocumented
Instance Variable transport Undocumented
Method makeConnection Make a connection to a transport and a server.

Inherited from _PauseableMixin (via StatefulTelnetProtocol, LineReceiver):

Instance Variable paused Undocumented
Method pauseProducing Undocumented
Method resumeProducing Undocumented
Method stopProducing Undocumented

Inherited from TelnetProtocol (via StatefulTelnetProtocol):

Method unhandledCommand A command was received but not understood.
Method unhandledSubnegotiation A subnegotiation command was received but not understood.
Method enableLocal Enable the given option locally.
Method enableRemote Indicate whether the peer should be allowed to enable this option.
Method disableLocal Disable the given option locally.
Method disableRemote Indicate that the peer has disabled this option.
Class Variable _log Undocumented

Inherited from Protocol (via StatefulTelnetProtocol, TelnetProtocol):

Class Variable factory Undocumented
Method logPrefix Return a prefix matching the class name, to identify log messages related to this protocol instance.
Method dataReceived Called whenever data is received.

Inherited from BaseProtocol (via StatefulTelnetProtocol, TelnetProtocol, Protocol):

Instance Variable connected Undocumented
Instance Variable transport Undocumented
Method makeConnection Make a connection to a transport and a server.
protocol = (source)

Undocumented

def __init__(self, portal): (source)

Undocumented

portal = (source)

Undocumented

def connectionMade(self): (source)

Called when a connection is made.

This may be considered the initializer of the protocol, because it is called when the connection is completed. For clients, this is called once the connection to the server has been established; for servers, this is called after an accept() call stops blocking and a socket has been received. If you need to send any greeting or initial message, do it here.

def connectionLost(self, reason): (source)

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.

ParametersreasonUndocumented (type: twisted.python.failure.Failure)
def telnet_User(self, line): (source)

Undocumented

username = (source)

Undocumented

def telnet_Password(self, line): (source)

Undocumented

def _cbLogin(self, ial): (source)

Undocumented

logout = (source)

Undocumented

def _ebLogin(self, failure): (source)

Undocumented

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.