twisted.conch.telnet.AuthenticatingTelnetProtocol

class documentation

class AuthenticatingTelnetProtocol(StatefulTelnetProtocol): (source)

Constructor: AuthenticatingTelnetProtocol(portal)

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.

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

Inherited from StatefulTelnetProtocol:

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

Inherited from LineReceiver (via StatefulTelnetProtocol):

Method clearLineBuffer Clear buffered data.
Method dataReceived Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
Method lineLengthExceeded Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.
Method rawDataReceived Override this for when raw data is received.
Method sendLine Sends a line to the other end of the connection.
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.
Constant 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
Instance Variable _buffer Undocumented
Instance Variable _busyReceiving Undocumented

Inherited from TelnetProtocol (via StatefulTelnetProtocol, LineReceiver):

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

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

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

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

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

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

Method pauseProducing Undocumented
Method resumeProducing Undocumented
Method stopProducing Undocumented
Instance Variable paused Undocumented
def __init__(self, portal): (source)

Undocumented

def connectionLost(self, reason): (source)
from twisted.internet.interfaces.IProtocol
overrides twisted.conch.telnet.StatefulTelnetProtocol.connectionLost

Called when the connection is shut down.

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

Parameters
reason:twisted.python.failure.FailureUndocumented
def connectionMade(self): (source)
from twisted.internet.interfaces.IProtocol
overrides twisted.internet.protocol.BaseProtocol.connectionMade

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 telnet_Password(self, line): (source)

Undocumented

def telnet_User(self, line): (source)

Undocumented

logout = (source)

Undocumented

portal = (source)

Undocumented

protocol = (source)

Undocumented

state: str = (source)
overrides twisted.conch.telnet.StatefulTelnetProtocol.state

Undocumented

username = (source)

Undocumented

def _cbLogin(self, ial): (source)

Undocumented

def _ebLogin(self, failure): (source)

Undocumented