Struct FileZoneHandler 

pub struct FileZoneHandler { /* private fields */ }

FileZoneHandler is responsible for storing the resource records for a particular zone.

Zone handlers default to DNSClass IN. The ZoneType specifies if this should be treated as the start of authority for the zone, is a Secondary, or a cached zone.

Implementations

impl FileZoneHandler

pub async fn new(in_memory: InMemoryZoneHandler) -> Self

Creates a new ZoneHandler.

Arguments

• origin - The zone Name being created, this should match that of the RecordType::SOA record.
• records - The map of the initial set of records in the zone.
• zone_type - The type of zone, i.e. is this authoritative?
• axfr_policy - A policy for determining if AXFR is allowed.
• nx_proof_kind - The kind of non-existence proof to be used by the server.

Return value

The new ZoneHandler.

pub fn try_from_config( origin: Name, zone_type: ZoneType, axfr_policy: AxfrPolicy, root_dir: Option<&Path>, config: &FileConfig, nx_proof_kind: Option<NxProofKind>, ) -> Result<Self, String>

Read the ZoneHandler for the origin from the specified configuration

Methods from Deref<Target = InMemoryZoneHandler>

pub fn class(&self) -> DNSClass

The DNSClass of this zone

pub fn set_axfr_policy(&mut self, policy: AxfrPolicy)

Available on crate features testing only.

Set the AXFR policy for testing purposes

pub fn clear(&mut self)

Clears all records (including SOA, etc)

pub async fn secure_keys(&self) -> impl Deref<Target = [DnssecSigner]> + '_

Available on crate features __dnssec and testing only.

Retrieve the Signer, which contains the private keys, for this zone

pub async fn records( &self, ) -> impl Deref<Target = BTreeMap<RrKey, Arc<RecordSet>>> + '_

Get all the records

pub async fn records_mut( &self, ) -> impl DerefMut<Target = BTreeMap<RrKey, Arc<RecordSet>>> + '_

Get a mutable reference to the records

pub fn records_get_mut(&mut self) -> &mut BTreeMap<RrKey, Arc<RecordSet>>

Get a mutable reference to the records

pub async fn minimum_ttl(&self) -> u32

Returns the minimum ttl (as used in the SOA record)

pub async fn serial(&self) -> u32

get the current serial number for the zone.

pub async fn upsert(&self, record: Record, serial: u32) -> bool

Inserts or updates a Record depending on its existence in the zone.

Guarantees that SOA, CNAME only has one record, will implicitly update if they already exist.

Arguments

• record - The Record to be inserted or updated.
• serial - Current serial number to be recorded against updates.

Return value

true if the value was inserted, false otherwise

pub fn upsert_mut(&mut self, record: Record, serial: u32) -> bool

Non-async version of upsert when behind a mutable reference.

pub fn add_zone_signing_key_mut( &mut self, signer: DnssecSigner, ) -> DnsSecResult<()>

Available on crate feature __dnssec only.

Non-async method of add_zone_signing_key when behind a mutable reference

pub fn secure_zone_mut(&mut self) -> DnsSecResult<()>

Available on crate feature __dnssec only.

(Re)generates the nsec records, increments the serial number and signs the zone

Trait Implementations

impl Deref for FileZoneHandler

type Target = InMemoryZoneHandler

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for FileZoneHandler

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl DnssecZoneHandler for FileZoneHandler

fn add_zone_signing_key<'life0, 'async_trait>( &'life0 self, signer: DnssecSigner, ) -> Pin<Box<dyn Future<Output = DnsSecResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Add Signer

fn secure_zone<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = DnsSecResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sign the zone for DNSSEC

impl ZoneHandler for FileZoneHandler

fn zone_type(&self) -> ZoneType

What type is this zone

fn axfr_policy(&self) -> AxfrPolicy

Return the policy for determining if AXFR requests are allowed

fn origin(&self) -> &LowerName

Get the origin of this zone, i.e. example.com is the origin for www.example.com

fn lookup<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, name: &'life1 LowerName, rtype: RecordType, request_info: Option<&'life2 RequestInfo<'life3>>, lookup_options: LookupOptions, ) -> Pin<Box<dyn Future<Output = LookupControlFlow<AuthLookup>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Looks up all Resource Records matching the given Name and RecordType.

Arguments

• name - The name to look up.
• rtype - The RecordType to look up. RecordType::ANY will return all records matching name. RecordType::AXFR will return all record types except RecordType::SOA due to the requirements that on zone transfers the RecordType::SOA must both precede and follow all other records.
• lookup_options - Query-related lookup options (e.g., DNSSEC DO bit, supported hash algorithms, etc.)

Return value

A LookupControlFlow containing the lookup that should be returned to the client.

fn search<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 Request, lookup_options: LookupOptions, ) -> Pin<Box<dyn Future<Output = (LookupControlFlow<AuthLookup>, Option<TSigResponseContext>)> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Using the specified query, perform a lookup against this zone.

Arguments

• request - the query to perform the lookup with.
• lookup_options - Query-related lookup options (e.g., DNSSEC DO bit, supported hash algorithms, etc.)

Return value

A LookupControlFlow containing the lookup that should be returned to the client.

fn nsec_records<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 LowerName, lookup_options: LookupOptions, ) -> Pin<Box<dyn Future<Output = LookupControlFlow<AuthLookup>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Return the NSEC records based on the given name

Arguments

• name - given this name (i.e. the lookup name), return the NSEC record that is less than this
• lookup_options - Query-related lookup options (e.g., DNSSEC DO bit, supported hash algorithms, etc.)

fn zone_transfer<'life0, 'life1, 'async_trait>( &'life0 self, request: &'life1 Request, lookup_options: LookupOptions, now: u64, ) -> Pin<Box<dyn Future<Output = Option<(Result<ZoneTransfer, LookupError>, Option<TSigResponseContext>)>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Returns all records in the zone.

fn nsec3_records<'life0, 'life1, 'async_trait>( &'life0 self, info: Nsec3QueryInfo<'life1>, lookup_options: LookupOptions, ) -> Pin<Box<dyn Future<Output = LookupControlFlow<AuthLookup>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Available on crate feature __dnssec only.

Return the NSEC3 records based on the information available for a query.

fn nx_proof_kind(&self) -> Option<&NxProofKind>

Available on crate feature __dnssec only.

Returns the kind of non-existence proof used for this zone.

fn metrics_label(&self) -> &'static str

Available on crate feature metrics only.

Returns the zone handler metrics label.

fn can_validate_dnssec(&self) -> bool

Whether the zone handler can perform DNSSEC validation

fn update<'life0, 'life1, 'async_trait>( &'life0 self, _update: &'life1 Request, _now: u64, ) -> Pin<Box<dyn Future<Output = (Result<bool, ResponseCode>, Option<TSigResponseContext>)> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Perform a dynamic update of a zone

fn consult<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _name: &'life1 LowerName, _rtype: RecordType, _request_info: Option<&'life2 RequestInfo<'life3>>, _lookup_options: LookupOptions, last_result: LookupControlFlow<AuthLookup>, ) -> Pin<Box<dyn Future<Output = (LookupControlFlow<AuthLookup>, Option<TSigResponseContext>)> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Consulting lookup for all Resource Records matching the given Name and RecordType. This will be called in a chained zone handler configuration after a zone handler in the chain has returned a lookup with a LookupControlFlow::Continue action. Every other zone handler in the chain will be called via this consult method, until one either returns a LookupControlFlow::Break action, or all zone handlers have been consulted. The zone handler that generated the primary lookup (the one returned via ‘lookup’) will not be consulted.