Struct trust_dns::op::Message [−][src]
pub struct Message { /* fields omitted */ }
The basic request and response datastructure, used for all DNS protocols.
RFC 1035, DOMAIN NAMES - IMPLEMENTATION AND SPECIFICATION, November 1987
4.1. Format
All communications inside of the domain protocol are carried in a single
format called a message. The top level format of message is divided
into 5 sections (some of which are empty in certain cases) shown below:
+--------------------------+
| Header |
+--------------------------+
| Question / Zone | the question for the name server
+--------------------------+
| Answer / Prerequisite | RRs answering the question
+--------------------------+
| Authority / Update | RRs pointing toward an authority
+--------------------------+
| Additional | RRs holding additional information
+--------------------------+
The header section is always present. The header includes fields that
specify which of the remaining sections are present, and also specify
whether the message is a query or a response, a standard query or some
other opcode, etc.
The names of the sections after the header are derived from their use in
standard queries. The question section contains fields that describe a
question to a name server. These fields are a query type (QTYPE), a
query class (QCLASS), and a query domain name (QNAME). The last three
sections have the same format: a possibly empty list of concatenated
resource records (RRs). The answer section contains RRs that answer the
question; the authority section contains RRs that point toward an
authoritative name server; the additional records section contains RRs
which relate to the query, but are not strictly answers for the
question.
By default Message is a Query. Use the Message::as_update() to create and update, or Message::new_update()
Methods
impl Message
[src]
impl Message
pub fn new() -> Message
[src]
pub fn new() -> Message
Returns a new "empty" Message
pub fn error_msg(
id: u16,
op_code: OpCode,
response_code: ResponseCode
) -> Message
[src]
pub fn error_msg(
id: u16,
op_code: OpCode,
response_code: ResponseCode
) -> Message
Returns a Message constructed with error details to return to a client
Arguments
id
- message id should match the request message idop_code
- operation of the requestresponse_code
- the error code for the response
pub fn truncate(&self) -> Message
[src]
pub fn truncate(&self) -> Message
Truncates a Message, this blindly removes all response fields and sets trucation to true
pub fn set_id(&mut self, id: u16) -> &mut Message
[src]
pub fn set_id(&mut self, id: u16) -> &mut Message
see Header::set_id
pub fn set_message_type(&mut self, message_type: MessageType) -> &mut Message
[src]
pub fn set_message_type(&mut self, message_type: MessageType) -> &mut Message
see Header::set_message_type
pub fn set_op_code(&mut self, op_code: OpCode) -> &mut Message
[src]
pub fn set_op_code(&mut self, op_code: OpCode) -> &mut Message
see Header::set_op_code
see Header::set_authoritative
pub fn set_truncated(&mut self, truncated: bool) -> &mut Message
[src]
pub fn set_truncated(&mut self, truncated: bool) -> &mut Message
see Header::set_truncated
pub fn set_recursion_desired(&mut self, recursion_desired: bool) -> &mut Message
[src]
pub fn set_recursion_desired(&mut self, recursion_desired: bool) -> &mut Message
see Header::set_recursion_desired
pub fn set_recursion_available(
&mut self,
recursion_available: bool
) -> &mut Message
[src]
pub fn set_recursion_available(
&mut self,
recursion_available: bool
) -> &mut Message
see Header::set_recursion_available
pub fn set_authentic_data(&mut self, authentic_data: bool) -> &mut Message
[src]
pub fn set_authentic_data(&mut self, authentic_data: bool) -> &mut Message
see Header::set_authentic_data
pub fn set_checking_disabled(&mut self, checking_disabled: bool) -> &mut Message
[src]
pub fn set_checking_disabled(&mut self, checking_disabled: bool) -> &mut Message
see Header::set_checking_disabled
pub fn set_response_code(&mut self, response_code: ResponseCode) -> &mut Message
[src]
pub fn set_response_code(&mut self, response_code: ResponseCode) -> &mut Message
see Header::set_response_code
pub fn add_query(&mut self, query: Query) -> &mut Message
[src]
pub fn add_query(&mut self, query: Query) -> &mut Message
Add a query to the Message, either the query response from the server, or the request Query.
pub fn add_queries<Q, I>(&mut self, queries: Q) -> &mut Message where
I: Iterator<Item = Query>,
Q: IntoIterator<Item = Query, IntoIter = I>,
[src]
pub fn add_queries<Q, I>(&mut self, queries: Q) -> &mut Message where
I: Iterator<Item = Query>,
Q: IntoIterator<Item = Query, IntoIter = I>,
Adds an iterator over a set of Queries to be added to the message
pub fn add_answer(&mut self, record: Record) -> &mut Message
[src]
pub fn add_answer(&mut self, record: Record) -> &mut Message
Add an answer to the Message
pub fn add_answers<R, I>(&mut self, records: R) -> &mut Message where
I: Iterator<Item = Record>,
R: IntoIterator<Item = Record, IntoIter = I>,
[src]
pub fn add_answers<R, I>(&mut self, records: R) -> &mut Message where
I: Iterator<Item = Record>,
R: IntoIterator<Item = Record, IntoIter = I>,
Add all the records from the iterator to the answers section of the Message
pub fn insert_answers(&mut self, records: Vec<Record>)
[src]
pub fn insert_answers(&mut self, records: Vec<Record>)
Sets the answers to the specified set of Records.
Panics
Will panic if answer records are already associated to the message.
pub fn add_name_server(&mut self, record: Record) -> &mut Message
[src]
pub fn add_name_server(&mut self, record: Record) -> &mut Message
Add a name server record to the Message
pub fn add_name_servers<R, I>(&mut self, records: R) -> &mut Message where
I: Iterator<Item = Record>,
R: IntoIterator<Item = Record, IntoIter = I>,
[src]
pub fn add_name_servers<R, I>(&mut self, records: R) -> &mut Message where
I: Iterator<Item = Record>,
R: IntoIterator<Item = Record, IntoIter = I>,
Add all the records in the Iterator to the name server section of the message
pub fn insert_name_servers(&mut self, records: Vec<Record>)
[src]
pub fn insert_name_servers(&mut self, records: Vec<Record>)
Sets the name_servers to the specified set of Records.
Panics
Will panic if name_servers records are already associated to the message.
pub fn add_additional(&mut self, record: Record) -> &mut Message
[src]
pub fn add_additional(&mut self, record: Record) -> &mut Message
A an addtional Record to the message
pub fn insert_additionals(&mut self, records: Vec<Record>)
[src]
pub fn insert_additionals(&mut self, records: Vec<Record>)
Sets the additional to the specified set of Records.
Panics
Will panic if additional records are already associated to the message.
pub fn set_edns(&mut self, edns: Edns) -> &mut Message
[src]
pub fn set_edns(&mut self, edns: Edns) -> &mut Message
Add the EDNS section the the Message
pub fn add_sig0(&mut self, record: Record) -> &mut Message
[src]
pub fn add_sig0(&mut self, record: Record) -> &mut Message
Add a SIG0 record, i.e. sign this message
This must be don't only after all records have been associated. Generally this will be handled by the client and not need to be used directly
pub fn header(&self) -> &Header
[src]
pub fn header(&self) -> &Header
Gets the header of the Message
pub fn id(&self) -> u16
[src]
pub fn id(&self) -> u16
see Header::id()
pub fn message_type(&self) -> MessageType
[src]
pub fn message_type(&self) -> MessageType
see Header::message_type()
pub fn op_code(&self) -> OpCode
[src]
pub fn op_code(&self) -> OpCode
see Header::op_code()
see Header::authoritative()
pub fn truncated(&self) -> bool
[src]
pub fn truncated(&self) -> bool
see Header::truncated()
pub fn recursion_desired(&self) -> bool
[src]
pub fn recursion_desired(&self) -> bool
see Header::recursion_desired()
pub fn recursion_available(&self) -> bool
[src]
pub fn recursion_available(&self) -> bool
see Header::recursion_available()
pub fn authentic_data(&self) -> bool
[src]
pub fn authentic_data(&self) -> bool
see Header::authentic_data()
pub fn checking_disabled(&self) -> bool
[src]
pub fn checking_disabled(&self) -> bool
see Header::checking_disabled()
pub fn response_code(&self) -> ResponseCode
[src]
pub fn response_code(&self) -> ResponseCode
Return value
The ResponseCode
, if this is an EDNS message then this will join the section from the OPT
record to create the EDNS ResponseCode
pub fn queries(&self) -> &[Query]
[src]
pub fn queries(&self) -> &[Query]
Question Carries the query name and other query parameters.
pub fn answers(&self) -> &[Record]
[src]
pub fn answers(&self) -> &[Record]
Answer Carries RRs which directly answer the query.
pub fn take_answers(&mut self) -> Vec<Record>
[src]
pub fn take_answers(&mut self) -> Vec<Record>
Removes all the answers from the Message
pub fn name_servers(&self) -> &[Record]
[src]
pub fn name_servers(&self) -> &[Record]
Authority Carries RRs which describe other authoritative servers.
May optionally carry the SOA RR for the authoritative
data in the answer section.
pub fn take_name_servers(&mut self) -> Vec<Record>
[src]
pub fn take_name_servers(&mut self) -> Vec<Record>
Remove the name servers from the Message
pub fn additionals(&self) -> &[Record]
[src]
pub fn additionals(&self) -> &[Record]
Additional Carries RRs which may be helpful in using the RRs in the
other sections.
pub fn take_additionals(&mut self) -> Vec<Record>
[src]
pub fn take_additionals(&mut self) -> Vec<Record>
Remove the additional Records from the Message
pub fn edns(&self) -> Option<&Edns>
[src]
pub fn edns(&self) -> Option<&Edns>
RFC 6891, EDNS(0) Extensions, April 2013
6.1.1. Basic Elements
An OPT pseudo-RR (sometimes called a meta-RR) MAY be added to the
additional data section of a request.
The OPT RR has RR type 41.
If an OPT record is present in a received request, compliant
responders MUST include an OPT record in their respective responses.
An OPT record does not carry any DNS data. It is used only to
contain control information pertaining to the question-and-answer
sequence of a specific transaction. OPT RRs MUST NOT be cached,
forwarded, or stored in or loaded from master files.
The OPT RR MAY be placed anywhere within the additional data section.
When an OPT RR is included within any DNS message, it MUST be the
only OPT RR in that message. If a query message with more than one
OPT RR is received, a FORMERR (RCODE=1) MUST be returned. The
placement flexibility for the OPT RR does not override the need for
the TSIG or SIG(0) RRs to be the last in the additional section
whenever they are present.
Return value
Returns the EDNS record if it was found in the additional section.
pub fn edns_mut(&mut self) -> &mut Edns
[src]
pub fn edns_mut(&mut self) -> &mut Edns
If edns is_none, this will create a new default Edns.
pub fn max_payload(&self) -> u16
[src]
pub fn max_payload(&self) -> u16
Return value
the max payload value as it's defined in the EDNS section.
pub fn version(&self) -> u8
[src]
pub fn version(&self) -> u8
Return value
the version as defined in the EDNS record
pub fn sig0(&self) -> &[Record]
[src]
pub fn sig0(&self) -> &[Record]
RFC 2535, Domain Name System Security Extensions, March 1999
A DNS request may be optionally signed by including one or more SIGs
at the end of the query. Such SIGs are identified by having a "type
covered" field of zero. They sign the preceding DNS request message
including DNS header but not including the IP header or any request
SIGs at the end and before the request RR counts have been adjusted
for the inclusions of any request SIG(s).
Return value
The sig0, i.e. signed record, for verifying the sending and package integrity
pub fn read_queries(
decoder: &mut BinDecoder,
count: usize
) -> Result<Vec<Query>, ProtoError>
[src]
pub fn read_queries(
decoder: &mut BinDecoder,
count: usize
) -> Result<Vec<Query>, ProtoError>
Attempts to read the specified number of Query
s
pub fn read_records(
decoder: &mut BinDecoder,
count: usize,
is_additional: bool
) -> Result<(Vec<Record>, Option<Edns>, Vec<Record>), ProtoError>
[src]
pub fn read_records(
decoder: &mut BinDecoder,
count: usize,
is_additional: bool
) -> Result<(Vec<Record>, Option<Edns>, Vec<Record>), ProtoError>
Attempts to read the specified number of records
Returns
This returns a tuple of first standard Records, then a possibly associated Edns, and then finally any optionally associated SIG0 records.
pub fn from_vec(buffer: &[u8]) -> Result<Message, ProtoError>
[src]
pub fn from_vec(buffer: &[u8]) -> Result<Message, ProtoError>
Decodes a message from the buffer.
pub fn to_vec(&self) -> Result<Vec<u8>, ProtoError>
[src]
pub fn to_vec(&self) -> Result<Vec<u8>, ProtoError>
Encodes the Message into a buffer
pub fn finalize<MF>(
&mut self,
finalizer: &MF,
inception_time: u32
) -> Result<(), ProtoError> where
MF: MessageFinalizer,
[src]
pub fn finalize<MF>(
&mut self,
finalizer: &MF,
inception_time: u32
) -> Result<(), ProtoError> where
MF: MessageFinalizer,
Finalize the message prior to sending.
Subsequent to calling this, the Message should not change.
Methods from Deref<Target = Header>
pub fn id(&self) -> u16
[src]
pub fn id(&self) -> u16
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.
pub fn message_type(&self) -> MessageType
[src]
pub fn message_type(&self) -> MessageType
QR A one bit field that specifies whether this message is a
query (0), or a response (1).
pub fn op_code(&self) -> OpCode
[src]
pub fn op_code(&self) -> OpCode
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. The values are: <see super::op_code>
AA 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.
Note that the contents of the answer section may have
multiple owner names because of aliases. The AA bit
corresponds to the name which matches the query name, or
the first owner name in the answer section.
pub fn truncated(&self) -> bool
[src]
pub fn truncated(&self) -> bool
TC TrunCation - specifies that this message was truncated
due to length greater than that permitted on the
transmission channel.
pub fn recursion_desired(&self) -> bool
[src]
pub fn recursion_desired(&self) -> bool
RD Recursion Desired - this bit may be set in a query and
is copied into the response. If RD is set, it directs
the name server to pursue the query recursively.
Recursive query support is optional.
pub fn recursion_available(&self) -> bool
[src]
pub fn recursion_available(&self) -> bool
RA Recursion Available - this be is set or cleared in a
response, and denotes whether recursive query support is
available in the name server.
pub fn authentic_data(&self) -> bool
[src]
pub fn authentic_data(&self) -> bool
RFC 4035, DNSSEC Resource Records, March 2005
3.1.6. The AD and CD Bits in an Authoritative Response
The CD and AD bits are designed for use in communication between
security-aware resolvers and security-aware recursive name servers.
These bits are for the most part not relevant to query processing by
security-aware authoritative name servers.
A security-aware name server does not perform signature validation
for authoritative data during query processing, even when the CD bit
is clear. A security-aware name server SHOULD clear the CD bit when
composing an authoritative response.
A security-aware name server MUST NOT set the AD bit in a response
unless the name server considers all RRsets in the Answer and
Authority sections of the response to be authentic. A security-aware
name server's local policy MAY consider data from an authoritative
zone to be authentic without further validation. However, the name
server MUST NOT do so unless the name server obtained the
authoritative zone via secure means (such as a secure zone transfer
mechanism) and MUST NOT do so unless this behavior has been
configured explicitly.
A security-aware name server that supports recursion MUST follow the
rules for the CD and AD bits given in Section 3.2 when generating a
response that involves data obtained via recursion.
pub fn checking_disabled(&self) -> bool
[src]
pub fn checking_disabled(&self) -> bool
see is_authentic_data()
pub fn response_code(&self) -> u8
[src]
pub fn response_code(&self) -> u8
RCODE Response code - this 4 bit field is set as part of
responses. The values have the following
interpretation: <see super::response_code>
pub fn query_count(&self) -> u16
[src]
pub fn query_count(&self) -> u16
QDCOUNT an unsigned 16 bit integer specifying the number of
entries in the question section.
Return value
If this is a query, this will return the number of queries in the query section of the
pub fn answer_count(&self) -> u16
[src]
pub fn answer_count(&self) -> u16
ANCOUNT an unsigned 16 bit integer specifying the number of
resource records in the answer section.
Return value
For query responses this is the number of records in the answer section, should be 0 for requests, for updates this is the count of prerequisite records.
pub fn name_server_count(&self) -> u16
[src]
pub fn name_server_count(&self) -> u16
for queries this is the nameservers which are authorities for the SOA of the Record for updates this is the update record count
NSCOUNT an unsigned 16 bit integer specifying the number of name
server resource records in the authority records
section.
Return value
For query responses this is the number of authorities, or nameservers, in the name server section, for updates this is the number of update records being sent.
pub fn additional_count(&self) -> u16
[src]
pub fn additional_count(&self) -> u16
ARCOUNT an unsigned 16 bit integer specifying the number of
resource records in the additional records section.
Return value
This is the additional record section count, this section may include EDNS options.
Trait Implementations
impl BinEncodable for Message
[src]
impl BinEncodable for Message
fn emit(&self, encoder: &mut BinEncoder) -> Result<(), ProtoError>
[src]
fn emit(&self, encoder: &mut BinEncoder) -> Result<(), ProtoError>
Write the type to the stream
fn to_bytes(&self) -> Result<Vec<u8>, ProtoError>
[src]
fn to_bytes(&self) -> Result<Vec<u8>, ProtoError>
Returns the object in binary form
impl Clone for Message
[src]
impl Clone for Message
fn clone(&self) -> Message
[src]
fn clone(&self) -> Message
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Debug for Message
[src]
impl Debug for Message
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
[src]
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
Formats the value using the given formatter. Read more
impl From<DnsResponse> for Message
[src]
impl From<DnsResponse> for Message
fn from(response: DnsResponse) -> Message
[src]
fn from(response: DnsResponse) -> Message
Performs the conversion.
impl From<Message> for DnsResponse
[src]
impl From<Message> for DnsResponse
fn from(message: Message) -> DnsResponse
[src]
fn from(message: Message) -> DnsResponse
Performs the conversion.
impl Into<DnsRequest> for Message
[src]
impl Into<DnsRequest> for Message
fn into(self) -> DnsRequest
[src]
fn into(self) -> DnsRequest
Performs the conversion.
impl Default for Message
[src]
impl Default for Message
impl Deref for Message
[src]
impl Deref for Message
type Target = Header
The resulting type after dereferencing.
fn deref(&self) -> &<Message as Deref>::Target
[src]
fn deref(&self) -> &<Message as Deref>::Target
Dereferences the value.
impl PartialEq<Message> for Message
[src]
impl PartialEq<Message> for Message
fn eq(&self, other: &Message) -> bool
[src]
fn eq(&self, other: &Message) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Message) -> bool
[src]
fn ne(&self, other: &Message) -> bool
This method tests for !=
.
impl<'r> BinDecodable<'r> for Message
[src]
impl<'r> BinDecodable<'r> for Message
fn read(decoder: &mut BinDecoder<'r>) -> Result<Message, ProtoError>
[src]
fn read(decoder: &mut BinDecoder<'r>) -> Result<Message, ProtoError>
Read the type from the stream
fn from_bytes(bytes: &'r [u8]) -> Result<Self, ProtoError>
[src]
fn from_bytes(bytes: &'r [u8]) -> Result<Self, ProtoError>
Returns the object in binary form
impl UpdateMessage for Message
[src]
impl UpdateMessage for Message
to reduce errors in using the Message struct as an Update, this will do the call throughs to properly do that.
fn id(&self) -> u16
[src]
fn id(&self) -> u16
see Header::id
fn add_zone(&mut self, query: Query)
[src]
fn add_zone(&mut self, query: Query)
Adds the zone section, i.e. name.example.com would be example.com
fn add_pre_requisite(&mut self, record: Record)
[src]
fn add_pre_requisite(&mut self, record: Record)
Add the pre-requisite records Read more
fn add_pre_requisites<R, I>(&mut self, records: R) where
R: IntoIterator<Item = Record, IntoIter = I>,
I: Iterator<Item = Record>,
[src]
fn add_pre_requisites<R, I>(&mut self, records: R) where
R: IntoIterator<Item = Record, IntoIter = I>,
I: Iterator<Item = Record>,
Add all the Records from the Iterator to the pre-reqisites section
fn add_update(&mut self, record: Record)
[src]
fn add_update(&mut self, record: Record)
Add the Record to be updated
fn add_updates<R, I>(&mut self, records: R) where
R: IntoIterator<Item = Record, IntoIter = I>,
I: Iterator<Item = Record>,
[src]
fn add_updates<R, I>(&mut self, records: R) where
R: IntoIterator<Item = Record, IntoIter = I>,
I: Iterator<Item = Record>,
Add the Records from the Iterator to the updates section
fn add_additional(&mut self, record: Record)
[src]
fn add_additional(&mut self, record: Record)
Add Records to the additional Section of hte UpdateMessage
fn zones(&self) -> &[Query]
[src]
fn zones(&self) -> &[Query]
Returns the Zones to be updated, generally should only be one.
fn prerequisites(&self) -> &[Record]
[src]
fn prerequisites(&self) -> &[Record]
Returns the pre-requisites
fn updates(&self) -> &[Record]
[src]
fn updates(&self) -> &[Record]
Returns the records to be updated
fn additionals(&self) -> &[Record]
[src]
fn additionals(&self) -> &[Record]
Returns the additonal records
fn sig0(&self) -> &[Record]
[src]
fn sig0(&self) -> &[Record]
This is used to authenticate update messages. Read more