Struct trust_dns_server::store::file::FileAuthority

pub struct FileAuthority(_);

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

Authorities 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 FileAuthority

pub fn new(
    origin: Name,
    records: BTreeMap<RrKey, RecordSet>,
    zone_type: ZoneType,
    allow_axfr: bool
) -> Result<Self, String>

Creates a new Authority.

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?
• allow_update - If true, then this zone accepts dynamic updates.
• is_dnssec_enabled - If true, then the zone will sign the zone with all registered keys, (see add_zone_signing_key())

Return value

The new Authority.

pub fn try_from_config(
    origin: Name,
    zone_type: ZoneType,
    allow_axfr: bool,
    root_dir: Option<&Path>,
    config: &FileConfig
) -> Result<Self, String>

Read the Authority for the origin from the specified configuration

pub fn unwrap(self) -> InMemoryAuthority

Unwrap the InMemoryAuthority

Methods from Deref<Target = InMemoryAuthority>

pub fn class(&self) -> DNSClass

The DNSClass of this zone

pub fn set_allow_axfr(&mut self, allow_axfr: bool)

This is supported on crate feature testing only.

Allow AXFR’s (zone transfers)

pub fn clear(&mut self)

Clears all records (including SOA, etc)

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

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 it’s existence in the authority.

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_update_auth_key_mut(
    &mut self,
    name: Name,
    key: KEY
) -> DnsSecResult<()>

This is supported on crate feature dnssec only.

Non-async method of add_update_auth_key when behind a mutable reference

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

This is supported 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<()>

This is supported on crate feature dnssec only.

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

Trait Implementations

impl Authority for FileAuthority

fn zone_type(&self) -> ZoneType

What type is this zone

fn is_axfr_allowed(&self) -> bool

Return true if AXFR is allowed

fn update<'life0, 'life1, 'async_trait>(
    &'life0 self,
    _update: &'life1 MessageRequest
) -> Pin<Box<dyn Future<Output = UpdateResult<bool>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Perform a dynamic update of a zone

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, 'async_trait>(
    &'life0 self,
    name: &'life1 LowerName,
    rtype: RecordType,
    lookup_options: LookupOptions
) -> Pin<Box<dyn Future<Output = Result<Self::Lookup, LookupError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

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

Arguments

• name - The Name, label, to lookup.
• rtype - The RecordType, to lookup. 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.
• is_secure - If the DO bit is set on the EDNS OPT record, then return RRSIGs as well.

Return value

None if there are no matching records, otherwise a Vec containing the found records.

fn search<'life0, 'life1, 'async_trait>(
    &'life0 self,
    request_info: RequestInfo<'life1>,
    lookup_options: LookupOptions
) -> Pin<Box<dyn Future<Output = Result<Self::Lookup, LookupError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

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

Arguments

• query - the query to perform the lookup with.
• is_secure - if true, then RRSIG records (if this is a secure zone) will be returned.

Return value

Returns a vectory containing the results of the query, it will be empty if not found. If is_secure is true, in the case of no records found then NSEC records will be returned.

fn ns<'life0, 'async_trait>(
    &'life0 self,
    lookup_options: LookupOptions
) -> Pin<Box<dyn Future<Output = Result<Self::Lookup, LookupError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Get the NS, NameServer, record for the zone

fn get_nsec_records<'life0, 'life1, 'async_trait>(
    &'life0 self,
    name: &'life1 LowerName,
    lookup_options: LookupOptions
) -> Pin<Box<dyn Future<Output = Result<Self::Lookup, LookupError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: '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
• is_secure - if true then it will return RRSIG records as well

fn soa<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<Self::Lookup, LookupError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns the SOA of the authority.

Note: This will only return the SOA, if this is fulfilling a request, a standard lookup should be used, see soa_secure(), which will optionally return RRSIGs.

fn soa_secure<'life0, 'async_trait>(
    &'life0 self,
    lookup_options: LookupOptions
) -> Pin<Box<dyn Future<Output = Result<Self::Lookup, LookupError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns the SOA record for the zone

type Lookup = <InMemoryAuthority as Authority>::Lookup

Result of a lookup

impl Deref for FileAuthority

type Target = InMemoryAuthority

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for FileAuthority

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

Mutably dereferences the value.

impl DnssecAuthority for FileAuthority

This is supported on crate feature dnssec only.

fn add_update_auth_key<'life0, 'async_trait>(
    &'life0 self,
    name: Name,
    key: KEY
) -> Pin<Box<dyn Future<Output = DnsSecResult<()>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Add a (Sig0) key that is authorized to perform updates against this authority

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

Add Signer

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

Sign the zone for DNSSEC