twisted.protocols.ident.IdentServer : API documentation

The Identification Protocol (a.k.a., "ident", a.k.a., "the Ident Protocol") provides a means to determine the identity of a user of a particular TCP connection. Given a TCP port number pair, it returns a character string which identifies the owner of that connection on the server's system.

Server authors should subclass this class and override the lookup method. The default implementation returns an UNKNOWN-ERROR response for every query.

Method	lineReceived	Override this for when each line is received.
Method	invalidQuery	Undocumented
Method	validQuery	Called when a valid query is received to look up and deliver the response.
Method	lookup	Lookup user information about the specified address pair.
Method	_cbLookup	Undocumented
Method	_ebLookup	Undocumented

Inherited from BaseProtocol (via LineOnlyReceiver, Protocol):

Method	makeConnection	Make a connection to a transport and a server.
Method	connectionMade	Called when a connection is made.

Inherited from BaseProtocol (via LineOnlyReceiver, Protocol):

Method	makeConnection	Make a connection to a transport and a server.
Method	connectionMade	Called when a connection is made.

Inherited from BaseProtocol (via LineOnlyReceiver, Protocol):

Method	makeConnection	Make a connection to a transport and a server.
Method	connectionMade	Called when a connection is made.

def lineReceived(self, line): (source)

overrides twisted.protocols.basic.LineOnlyReceiver.lineReceived

Override this for when each line is received.

Parameters line The line which was received with the delimiter removed. (type: bytes)

def invalidQuery(self): (source)

Undocumented

def validQuery(self, portOnServer, portOnClient): (source)

Called when a valid query is received to look up and deliver the response.

Parameters	portOnServer	The server port from the query.
	portOnClient	The client port from the query.

def _cbLookup(self, (sysName, userId), sport, cport): (source)

Undocumented

def _ebLookup(self, failure, sport, cport): (source)

Undocumented

def lookup(self, serverAddress, clientAddress): (source)

Lookup user information about the specified address pair.

Return value should be a two-tuple of system name and username. Acceptable values for the system name may be found online at:

   U{http://www.iana.org/assignments/operating-system-names}

This method may also raise any IdentError subclass (or IdentError itself) to indicate user information will not be provided for the given query.

A Deferred may also be returned.

Parameters	serverAddress	A two-tuple representing the server endpoint of the address being queried. The first element is a string holding a dotted-quad IP address. The second element is an integer representing the port.
	clientAddress	Like `serverAddress`, but represents the client endpoint of the address being queried.

twisted.protocols.ident.IdentServer(basic.LineOnlyReceiver) class documentation

`twisted.protocols.ident.IdentServer(basic.LineOnlyReceiver)` class documentation