t.n.d._EDNSMessage(tputil.FancyEqMixin, object) : class documentation

Part of twisted.names.dns View Source View In Hierarchy

An EDNS message.

Designed for compatibility with Message but with a narrower public interface.

Most importantly, _EDNSMessage.fromStr will interpret and remove OPT records that are present in the additional records section.

The OPT records are used to populate certain EDNS specific attributes.

_EDNSMessage.toStr will add suitable OPT records to the additional section to represent the extended EDNS information.

See Alsohttps://tools.ietf.org/html/rfc6891
Instance Variable id See __init__
Instance Variable answer See __init__
Instance Variable opCode See __init__
Instance Variable auth See __init__
Instance Variable trunc See __init__
Instance Variable recDes See __init__
Instance Variable recAv See __init__
Instance Variable rCode See __init__
Instance Variable ednsVersion See __init__
Instance Variable dnssecOK See __init__
Instance Variable authenticData See __init__
Instance Variable checkingDisabled See __init__
Instance Variable maxSize See __init__
Instance Variable queries See __init__
Instance Variable answers See __init__
Instance Variable authority See __init__
Instance Variable additional See __init__
Method __init__ Construct a new _EDNSMessage
Method __repr__ Undocumented
Method toStr Encode to wire format by first converting to a standard dns.Message.
Method fromStr Decode from wire format, saving flags, values and records to this _EDNSMessage instance in place.
Instance Variable _messageFactory A constructor of Message instances. Called by _toMessage and _fromMessage.
Method _toMessage Convert to a standard dns.Message.
Class Method _fromMessage Construct and return a new L(_EDNSMessage} whose attributes and records are derived from the attributes and records of C{message} (a L{Message} instance)

Inherited from FancyEqMixin:

Method __eq__ Undocumented
Method __ne__ Undocumented
id =
See __init__
answer =
See __init__
opCode =
See __init__
auth =
See __init__
trunc =
See __init__
recDes =
See __init__
recAv =
See __init__
rCode =
See __init__
ednsVersion =
See __init__
dnssecOK =
See __init__
authenticData =
See __init__
checkingDisabled =
See __init__
maxSize =
See __init__
queries =
See __init__
answers =
See __init__
authority =
See __init__
additional =
See __init__
_messageFactory =
A constructor of Message instances. Called by _toMessage and _fromMessage.
def __init__(self, id=0, answer=False, opCode=OP_QUERY, auth=False, trunc=False, recDes=False, recAv=False, rCode=0, ednsVersion=0, dnssecOK=False, authenticData=False, checkingDisabled=False, maxSize=512, queries=None, answers=None, authority=None, additional=None): (source)
Construct a new L{_EDNSMessage}

@see U{RFC1035 section-4.1.1<https://tools.ietf.org/html/rfc1035#section-4.1.1>}
@see U{RFC2535 section-6.1<https://tools.ietf.org/html/rfc2535#section-6.1>}
@see U{RFC3225 section-3<https://tools.ietf.org/html/rfc3225#section-3>}
@see U{RFC6891 section-6.1.3<https://tools.ietf.org/html/rfc6891#section-6.1.3>}

@param id: A 16 bit identifier assigned by the program that generates
    any kind of query.  This identifier is copied the corresponding
    reply and can be used by the requester to match up replies to
    outstanding queries.
@type id: L{int}

@param answer: A one bit field that specifies whether this message is a
    query (0), or a response (1).
@type answer: L{bool}

@param opCode: A four bit field that specifies kind of query in this
    message.  This value is set by the originator of a query and copied
    into the response.
@type opCode: L{int}

@param auth: Authoritative Answer - this bit is valid in responses, and
    specifies that the responding name server is an authority for the
    domain name in question section.
@type auth: L{bool}

@param trunc: Truncation - specifies that this message was truncated due
    to length greater than that permitted on the transmission channel.
@type trunc: L{bool}

@param recDes: Recursion Desired - this bit may be set in a query and is
    copied into the response.  If set, it directs the name server to
    pursue the query recursively. Recursive query support is optional.
@type recDes: L{bool}

@param recAv: Recursion Available - this bit is set or cleared in a
    response, and denotes whether recursive query support is available
    in the name server.
@type recAv: L{bool}

@param rCode: Extended 12-bit RCODE. Derived from the 4 bits defined in
    U{RFC1035 4.1.1<https://tools.ietf.org/html/rfc1035#section-4.1.1>}
    and the upper 8bits defined in U{RFC6891
    6.1.3<https://tools.ietf.org/html/rfc6891#section-6.1.3>}.
@type rCode: L{int}

@param ednsVersion: Indicates the EDNS implementation level. Set to
    L{None} to prevent any EDNS attributes and options being added to
    the encoded byte string.
@type ednsVersion: L{int} or L{None}

@param dnssecOK: DNSSEC OK bit as defined by
    U{RFC3225 3<https://tools.ietf.org/html/rfc3225#section-3>}.
@type dnssecOK: C{bool}

@param authenticData: A flag indicating in a response that all the data
    included in the answer and authority portion of the response has
    been authenticated by the server according to the policies of that
    server.
    See U{RFC2535 section-6.1<https://tools.ietf.org/html/rfc2535#section-6.1>}.
@type authenticData: L{bool}

@param checkingDisabled: A flag indicating in a query that pending
    (non-authenticated) data is acceptable to the resolver sending the
    query.
    See U{RFC2535 section-6.1<https://tools.ietf.org/html/rfc2535#section-6.1>}.
@type authenticData: L{bool}

@param maxSize: The requestor's UDP payload size is the number of octets
    of the largest UDP payload that can be reassembled and delivered in
    the requestor's network stack.
@type maxSize: L{int}

@param queries: The L{list} of L{Query} associated with this message.
@type queries: L{list} of L{Query}

@param answers: The L{list} of answers associated with this message.
@type answers: L{list} of L{RRHeader}

@param authority: The L{list} of authority records associated with this
    message.
@type authority: L{list} of L{RRHeader}

@param additional: The L{list} of additional records associated with
    this message.
@type additional: L{list} of L{RRHeader}
def __repr__(self): (source)
Undocumented
def _toMessage(self): (source)
Convert to a standard dns.Message.

If ednsVersion is not None, an _OPTHeader instance containing all the EDNS specific attributes and options will be appended to the list of additional records.

ReturnsA dns.Message (type: dns.Message)
def toStr(self): (source)
Encode to wire format by first converting to a standard dns.Message.
ReturnsA bytes string.
@classmethod
def _fromMessage(cls, message): (source)
Construct and return a new L(_EDNSMessage} whose attributes and records
are derived from the attributes and records of C{message} (a L{Message}
instance)

If present, an I{OPT} record will be extracted from the C{additional}
section and its attributes and options will be used to set the EDNS
specific attributes C{extendedRCODE}, c{ednsVersion}, c{dnssecOK},
c{ednsOptions}.

The C{extendedRCODE} will be combined with C{message.rCode} and assigned
to C{self.rCode}.

@param message: The source L{Message}.
@type message: L{Message}

@return: A new L{_EDNSMessage}
@rtype: L{_EDNSMessage}
def fromStr(self, bytes): (source)
Decode from wire format, saving flags, values and records to this _EDNSMessage instance in place.
ParametersbytesThe full byte string to be decoded. (type: bytes)
API Documentation for Twisted, generated by pydoctor at 2014-05-12 18:27:00.