README
- ::flagsCaaRecordData::flags
- ::tagCaaRecordData::tag
- ::valueCaaRecordData::value
- ::chainCnameResolution::chain
- ::chain_textsCnameResolution::chain_texts
- ::terminal_recordsCnameResolution::terminal_records
- ::is_absoluteDomainName::is_absolute
- ::labelsDomainName::labels
- ::resolveDomainName::resolve
- ::to_textDomainName::to_text
- ::wire_lengthDomainName::wire_length
T
FindingSeverity
- ::fieldsGenericRecordData::fields
- ::record_typeGenericRecordData::record_type
- ::octetsIpv4Address::octets
- ::to_textIpv4Address::to_text
- ::groupsIpv6Address::groups
- ::to_textIpv6Address::to_text
- ::exchangeMxRecordData::exchange
- ::preferenceMxRecordData::preference
- ::kindRecordChange::kind
- ::leftRecordChange::left
- ::rightRecordChange::right
T
RecordChangeKind
T
RecordData
- ::countRecordTypeCount::count
- ::record_typeRecordTypeCount::record_type
T
ReferenceCandidate
- ::expireSoaRecordData::expire
- ::minimumSoaRecordData::minimum
- ::primary_nameSoaRecordData::primary_name
- ::refreshSoaRecordData::refresh
- ::responsible_nameSoaRecordData::responsible_name
- ::retrySoaRecordData::retry
- ::serialSoaRecordData::serial
- ::end_columnSourceSpan::end_column
- ::end_lineSourceSpan::end_line
- ::pointSourceSpan::point
- ::rangeSourceSpan::range
- ::start_columnSourceSpan::start_column
- ::start_lineSourceSpan::start_line
- ::portSrvRecordData::port
- ::prioritySrvRecordData::priority
- ::targetSrvRecordData::target
- ::weightSrvRecordData::weight
- ::from_secondsTtl::from_seconds
- ::secondsTtl::seconds
- ::to_textTtl::to_text
- ::accepted_countZoneBatch::accepted_count
- ::itemsZoneBatch::items
- ::parse_failed_countZoneBatch::parse_failed_count
- ::rejected_countZoneBatch::rejected_count
- ::total_record_countZoneBatch::total_record_count
- ::initial_originZoneBatchInput::initial_origin
- ::initial_ttlZoneBatchInput::initial_ttl
- ::labelZoneBatchInput::label
- ::newZoneBatchInput::new
- ::textZoneBatchInput::text
- ::acceptedZoneBatchItem::accepted
- ::documentZoneBatchItem::document
- ::labelZoneBatchItem::label
- ::parse_errorZoneBatchItem::parse_error
- ::parsedZoneBatchItem::parsed
- ::statisticsZoneBatchItem::statistics
- ::validationZoneBatchItem::validation
- ::added_countZoneComparison::added_count
- ::changesZoneComparison::changes
- ::data_changed_countZoneComparison::data_changed_count
- ::identicalZoneComparison::identical
- ::removed_countZoneComparison::removed_count
- ::ttl_changed_countZoneComparison::ttl_changed_count
T
ZoneDirective
- ::default_ttlZoneDocument::default_ttl
- ::directive_countZoneDocument::directive_count
- ::originZoneDocument::origin
- ::recordsZoneDocument::records
- ::codeZoneError::code
- ::end_columnZoneError::end_column
- ::end_lineZoneError::end_line
- ::messageZoneError::message
- ::newZoneError::new
- ::spanZoneError::span
- ::start_columnZoneError::start_column
- ::start_lineZoneError::start_line
- ::codeZoneErrorCode::code
- ::codeZoneFinding::code
- ::messageZoneFinding::message
- ::ownerZoneFinding::owner
- ::severityZoneFinding::severity
- ::lookupZoneIndex::lookup
- ::owner_countZoneIndex::owner_count
- ::ownersZoneIndex::owners
- ::recordsZoneIndex::records
- ::records_for_ownerZoneIndex::records_for_owner
- ::records_for_typeZoneIndex::records_for_type
- ::resolve_cnameZoneIndex::resolve_cname
- ::newZonePolicy::new
- ::standardZonePolicy::standard
- ::dataZoneRecord::data
- ::ownerZoneRecord::owner
- ::record_classZoneRecord::record_class
- ::record_typeZoneRecord::record_type
- ::spanZoneRecord::span
- ::to_textZoneRecord::to_text
- ::ttlZoneRecord::ttl
- ::ttl_was_explicitZoneRecord::ttl_was_explicit
- ::countZoneRecordSet::count
- ::duplicate_countZoneRecordSet::duplicate_count
- ::duplicate_recordsZoneRecordSet::duplicate_records
- ::ownerZoneRecordSet::owner
- ::record_typeZoneRecordSet::record_type
- ::recordsZoneRecordSet::records
- ::unique_record_countZoneRecordSet::unique_record_count
- ::unique_recordsZoneRecordSet::unique_records
- ::duplicate_countZoneRecordSets::duplicate_count
- ::for_ownerZoneRecordSets::for_owner
- ::for_typeZoneRecordSets::for_type
- ::has_duplicatesZoneRecordSets::has_duplicates
- ::largest_set_sizeZoneRecordSets::largest_set_size
- ::lookupZoneRecordSets::lookup
- ::multi_record_set_countZoneRecordSets::multi_record_set_count
- ::record_countZoneRecordSets::record_count
- ::set_countZoneRecordSets::set_count
- ::setsZoneRecordSets::sets
- ::singleton_set_countZoneRecordSets::singleton_set_count
- ::unique_record_countZoneRecordSets::unique_record_count
- ::address_availableZoneReference::address_available
- ::disabledZoneReference::disabled
- ::healthyZoneReference::healthy
- ::internalZoneReference::internal
- ::kindZoneReference::kind
- ::requires_addressZoneReference::requires_address
- ::source_ownerZoneReference::source_owner
- ::targetZoneReference::target
- ::target_declaredZoneReference::target_declared
- ::addressless_target_countZoneReferenceAnalysis::addressless_target_count
- ::disabled_countZoneReferenceAnalysis::disabled_count
- ::external_countZoneReferenceAnalysis::external_count
- ::healthyZoneReferenceAnalysis::healthy
- ::internal_countZoneReferenceAnalysis::internal_count
- ::missing_target_countZoneReferenceAnalysis::missing_target_count
- ::referencesZoneReferenceAnalysis::references
T
ZoneReferenceKind
- ::documentZoneSelection::document
- ::excluded_countZoneSelection::excluded_count
- ::selected_countZoneSelection::selected_count
- ::token_textsZoneStatement::token_texts
- ::tokensZoneStatement::tokens
- ::apex_record_countZoneStatistics::apex_record_count
- ::average_ttl_secondsZoneStatistics::average_ttl_seconds
- ::count_for_typeZoneStatistics::count_for_type
- ::delegation_owner_countZoneStatistics::delegation_owner_count
- ::explicit_ttl_countZoneStatistics::explicit_ttl_count
- ::maximum_ttlZoneStatistics::maximum_ttl
- ::minimum_ttlZoneStatistics::minimum_ttl
- ::owner_countZoneStatistics::owner_count
- ::record_countZoneStatistics::record_count
- ::type_countsZoneStatistics::type_counts
- ::quotedZoneToken::quoted
- ::spanZoneToken::span
- ::textZoneToken::text
- ::changed_countZoneTtlRewrite::changed_count
- ::documentZoneTtlRewrite::document
- ::unchanged_countZoneTtlRewrite::unchanged_count
- ::acceptedZoneValidation::accepted
- ::error_countZoneValidation::error_count
- ::findingsZoneValidation::findings
- ::record_countZoneValidation::record_count
- ::warning_countZoneValidation::warning_count
V
analyze_zone_references
V
build_zone_record_sets
V
calculate_zone_statistics
V
clamp_zone_ttls
V
compare_zones
V
index_zone
V
lex_zone
V
parse_domain_name
V
parse_ipv4
V
parse_ipv6
V
parse_record_data
V
parse_record_data_statement
V
parse_ttl
V
parse_zone
V
parse_zone_directive
V
parse_zone_record
V
process_zone_batch
V
render_comparison_json
V
render_comparison_text
V
render_record_data
V
render_record_sets_json
V
render_record_sets_text
V
render_reference_analysis_json
V
render_reference_analysis_text
V
render_statistics_json
V
render_statistics_text
V
render_validation_json
V
render_validation_text
V
render_zone
V
resolve_zone_name
V
select_zone_records
V
validate_zone

dns-zone-toolkit

Validated DNS zone file parser and analysis toolkit for MoonBit

dns

zone-file

bind

parser

rfc1035

Download zip

Author

lmclmc1

Version

0.1.0

License

Apache-2.0

Repository

github.com/lmclmc1/moonbit-dns-zone

Last updated

2 months ago

Downloads

No dependencies

#lmclmc1/dns-zone-toolkit

MoonBit toolkit for parsing, validating, querying, comparing and rendering caller-provided DNS zone text.

Version 0.1.0 implements a documented BIND master-file style subset:

$ORIGIN, $TTL, owner inheritance and TTL inheritance;
A, AAAA, NS, CNAME, PTR, MX, TXT, SRV, CAA and SOA typed data;
generic preservation for other syntactically valid record types;
authoritative-zone policy checks and source-positioned diagnostics;
deterministic rendering, indexes, bounded CNAME traversal and comparison;
in-zone target reference audits for NS, CNAME, MX, SRV and SOA data;
owner/type record sets with exact duplicate evidence and JSON reports;
statistics, text/JSON evidence, bounded batches and controlled transforms.

import {
  "lmclmc1/dns-zone-toolkit" @zone,
}

let document = @zone.parse_zone(
  "$ORIGIN example.\n$TTL 1h\nwww A 192.0.2.1",
).unwrap()
println(@zone.render_zone(document))

The package accepts strings and performs no filesystem or network I/O. Version 0.1.0 does not implement $INCLUDE loading, DNS wire packets, DNS servers, recursive resolution, DNSSEC validation or IDN conversion.

See the repository README for complete examples, tested behavior and current boundaries. Licensed under Apache-2.0.

CaaRecordData

source

pub struct CaaRecordData {
  flags_value : Int
  tag_value : String
  value_value : String
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

CaaRecordData::flags

source

fn CaaRecordData::flags(self : CaaRecordData) -> Int

CaaRecordData::tag

source

fn CaaRecordData::tag(self : CaaRecordData) -> String

CaaRecordData::value

source

fn CaaRecordData::value(self : CaaRecordData) -> String

CnameResolution

source

pub struct CnameResolution {
  chain_values : Array[DomainName]
  terminal_record_values : Array[ZoneRecord]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

CnameResolution::chain

source

fn CnameResolution::chain(self : CnameResolution) -> Array[DomainName]

CnameResolution::chain_texts

source

fn CnameResolution::chain_texts(self : CnameResolution) -> Array[String]

CnameResolution::terminal_records

source

fn CnameResolution::terminal_records(self : CnameResolution) -> Array[ZoneRecord]

DomainName

source

pub struct DomainName {
  label_values : Array[String]
  absolute_value : Bool
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

DomainName::is_absolute

source

fn DomainName::is_absolute(self : DomainName) -> Bool

DomainName::labels

source

fn DomainName::labels(self : DomainName) -> Array[String]

DomainName::resolve

source

fn DomainName::resolve(self : DomainName, origin : DomainName) -> Result[DomainName, ZoneError]

DomainName::to_text

source

fn DomainName::to_text(self : DomainName) -> String

DomainName::wire_length

source

fn DomainName::wire_length(self : DomainName) -> Int

FindingSeverity

source

pub(all) enum FindingSeverity {
  FindingInfo
  FindingWarning
  FindingError
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

GenericRecordData

source

pub struct GenericRecordData {
  record_type_value : String
  field_values : Array[String]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

GenericRecordData::fields

source

fn GenericRecordData::fields(self : GenericRecordData) -> Array[String]

GenericRecordData::record_type

source

fn GenericRecordData::record_type(self : GenericRecordData) -> String

Ipv4Address

source

pub struct Ipv4Address {
  octet_values : Array[Int]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Ipv4Address::octets

source

fn Ipv4Address::octets(self : Ipv4Address) -> Array[Int]

Ipv4Address::to_text

source

fn Ipv4Address::to_text(self : Ipv4Address) -> String

Ipv6Address

source

pub struct Ipv6Address {
  group_values : Array[Int]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Ipv6Address::groups

source

fn Ipv6Address::groups(self : Ipv6Address) -> Array[Int]

Ipv6Address::to_text

source

fn Ipv6Address::to_text(self : Ipv6Address) -> String

MxRecordData

source

pub struct MxRecordData {
  preference_value : Int
  exchange_value : DomainName
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

MxRecordData::exchange

source

fn MxRecordData::exchange(self : MxRecordData) -> DomainName

MxRecordData::preference

source

fn MxRecordData::preference(self : MxRecordData) -> Int

RecordChange

source

pub struct RecordChange {
  kind_value : RecordChangeKind
  left_value : ZoneRecord?
  right_value : ZoneRecord?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

RecordChange::kind

source

fn RecordChange::kind(self : RecordChange) -> RecordChangeKind

RecordChange::left

source

fn RecordChange::left(self : RecordChange) -> ZoneRecord?

RecordChange::right

source

fn RecordChange::right(self : RecordChange) -> ZoneRecord?

RecordChangeKind

source

pub(all) enum RecordChangeKind {
  RecordAdded
  RecordRemoved
  RecordTtlChanged
  RecordDataChanged
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

RecordData

source

pub(all) enum RecordData {
  AData(Ipv4Address)
  AaaaData(Ipv6Address)
  NsData(DomainName)
  CnameData(DomainName)
  PtrData(DomainName)
  MxData(MxRecordData)
  TxtData(Array[String])
  SrvData(SrvRecordData)
  CaaData(CaaRecordData)
  SoaData(SoaRecordData)
  GenericData(GenericRecordData)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

RecordTypeCount

source

pub struct RecordTypeCount {
  type_value : String
  count_value : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

RecordTypeCount::count

source

fn RecordTypeCount::count(self : RecordTypeCount) -> Int

RecordTypeCount::record_type

source

fn RecordTypeCount::record_type(self : RecordTypeCount) -> String

ReferenceCandidate

source

type ReferenceCandidate derive(Eq, @moonbitlang/core/debug.Debug
Debug)

SoaRecordData

source

pub struct SoaRecordData {
  primary_name_value : DomainName
  responsible_name_value : DomainName
  serial_value : UInt64
  refresh_value : Ttl
  retry_value : Ttl
  expire_value : Ttl
  minimum_value : Ttl
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

SoaRecordData::expire

source

fn SoaRecordData::expire(self : SoaRecordData) -> Ttl

SoaRecordData::minimum

source

fn SoaRecordData::minimum(self : SoaRecordData) -> Ttl

SoaRecordData::primary_name

source

fn SoaRecordData::primary_name(self : SoaRecordData) -> DomainName

SoaRecordData::refresh

source

fn SoaRecordData::refresh(self : SoaRecordData) -> Ttl

SoaRecordData::responsible_name

source

fn SoaRecordData::responsible_name(self : SoaRecordData) -> DomainName

SoaRecordData::retry

source

fn SoaRecordData::retry(self : SoaRecordData) -> Ttl

SoaRecordData::serial

source

fn SoaRecordData::serial(self : SoaRecordData) -> UInt64

SourceSpan

source

pub(all) struct SourceSpan {
  start_line_value : Int
  start_column_value : Int
  end_line_value : Int
  end_column_value : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

SourceSpan::end_column

source

fn SourceSpan::end_column(self : SourceSpan) -> Int

SourceSpan::end_line

source

fn SourceSpan::end_line(self : SourceSpan) -> Int

SourceSpan::point

source

fn SourceSpan::point(line : Int, column : Int) -> SourceSpan

SourceSpan::range

source

fn SourceSpan::range(start_line : Int, start_column : Int, end_line : Int, end_column : Int) -> SourceSpan

SourceSpan::start_column

source

fn SourceSpan::start_column(self : SourceSpan) -> Int

SourceSpan::start_line

source

fn SourceSpan::start_line(self : SourceSpan) -> Int

SrvRecordData

source

pub struct SrvRecordData {
  priority_value : Int
  weight_value : Int
  port_value : Int
  target_value : DomainName
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

SrvRecordData::port

source

fn SrvRecordData::port(self : SrvRecordData) -> Int

SrvRecordData::priority

source

fn SrvRecordData::priority(self : SrvRecordData) -> Int

SrvRecordData::target

source

fn SrvRecordData::target(self : SrvRecordData) -> DomainName

SrvRecordData::weight

source

fn SrvRecordData::weight(self : SrvRecordData) -> Int

Ttl

source

pub(all) struct Ttl {
  seconds_value : UInt64
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Ttl::from_seconds

source

fn Ttl::from_seconds(seconds : UInt64) -> Result[Ttl, ZoneError]

Ttl::seconds

source

fn Ttl::seconds(self : Ttl) -> UInt64

Ttl::to_text

source

fn Ttl::to_text(self : Ttl) -> String

ZoneBatch

source

pub struct ZoneBatch {
  item_values : Array[ZoneBatchItem]
  accepted_count_value : Int
  rejected_count_value : Int
  parse_failed_count_value : Int
  total_record_count_value : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ZoneBatch::accepted_count

source

fn ZoneBatch::accepted_count(self : ZoneBatch) -> Int

ZoneBatch::items

source

fn ZoneBatch::items(self : ZoneBatch) -> Array[ZoneBatchItem]

ZoneBatch::parse_failed_count

source

fn ZoneBatch::parse_failed_count(self : ZoneBatch) -> Int

ZoneBatch::rejected_count

source

fn ZoneBatch::rejected_count(self : ZoneBatch) -> Int

ZoneBatch::total_record_count

source

fn ZoneBatch::total_record_count(self : ZoneBatch) -> Int

ZoneBatchInput

source

pub struct ZoneBatchInput {
  label_value : String
  text_value : String
  initial_origin_value : DomainName?
  initial_ttl_value : Ttl?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ZoneBatchInput::initial_origin

source

fn ZoneBatchInput::initial_origin(self : ZoneBatchInput) -> DomainName?

ZoneBatchInput::initial_ttl

source

fn ZoneBatchInput::initial_ttl(self : ZoneBatchInput) -> Ttl?

ZoneBatchInput::label

source

fn ZoneBatchInput::label(self : ZoneBatchInput) -> String

ZoneBatchInput::new

source

fn ZoneBatchInput::new(label : String, text : String, initial_origin? : DomainName?, initial_ttl? : Ttl?) -> Result[ZoneBatchInput, ZoneError]

ZoneBatchInput::text

source

fn ZoneBatchInput::text(self : ZoneBatchInput) -> String

ZoneBatchItem

source

pub struct ZoneBatchItem {
  label_value : String
  document_value : ZoneDocument?
  validation_value : ZoneValidation?
  statistics_value : ZoneStatistics?
  parse_error_value : ZoneError?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ZoneBatchItem::accepted

source

fn ZoneBatchItem::accepted(self : ZoneBatchItem) -> Bool

ZoneBatchItem::document

source

fn ZoneBatchItem::document(self : ZoneBatchItem) -> ZoneDocument?

ZoneBatchItem::label

source

fn ZoneBatchItem::label(self : ZoneBatchItem) -> String

ZoneBatchItem::parse_error

source

fn ZoneBatchItem::parse_error(self : ZoneBatchItem) -> ZoneError?

ZoneBatchItem::parsed

source

fn ZoneBatchItem::parsed(self : ZoneBatchItem) -> Bool

ZoneBatchItem::statistics

source

fn ZoneBatchItem::statistics(self : ZoneBatchItem) -> ZoneStatistics?

ZoneBatchItem::validation

source

fn ZoneBatchItem::validation(self : ZoneBatchItem) -> ZoneValidation?

ZoneComparison

source

pub struct ZoneComparison {
  change_values : Array[RecordChange]
  added_count_value : Int
  removed_count_value : Int
  ttl_changed_count_value : Int
  data_changed_count_value : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ZoneComparison::added_count

source

fn ZoneComparison::added_count(self : ZoneComparison) -> Int

ZoneComparison::changes

source

fn ZoneComparison::changes(self : ZoneComparison) -> Array[RecordChange]

ZoneComparison::data_changed_count

source

fn ZoneComparison::data_changed_count(self : ZoneComparison) -> Int

ZoneComparison::identical

source

fn ZoneComparison::identical(self : ZoneComparison) -> Bool

ZoneComparison::removed_count

source

fn ZoneComparison::removed_count(self : ZoneComparison) -> Int

ZoneComparison::ttl_changed_count

source

fn ZoneComparison::ttl_changed_count(self : ZoneComparison) -> Int

ZoneDirective

source

pub(all) enum ZoneDirective {
  OriginDirective(DomainName)
  DefaultTtlDirective(Ttl)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ZoneDocument

source

pub struct ZoneDocument {
  record_values : Array[ZoneRecord]
  origin_value : DomainName?
  default_ttl_value : Ttl?
  directive_count_value : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ZoneDocument::default_ttl

source

fn ZoneDocument::default_ttl(self : ZoneDocument) -> Ttl?

ZoneDocument::directive_count

source

fn ZoneDocument::directive_count(self : ZoneDocument) -> Int

ZoneDocument::origin

source

fn ZoneDocument::origin(self : ZoneDocument) -> DomainName?

ZoneDocument::records

source

fn ZoneDocument::records(self : ZoneDocument) -> Array[ZoneRecord]

ZoneError

source

pub struct ZoneError {
  code_value : String
  message_value : String
  span_value : SourceSpan
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ZoneError::code

source

fn ZoneError::code(self : ZoneError) -> String

ZoneError::end_column

source

fn ZoneError::end_column(self : ZoneError) -> Int

ZoneError::end_line

source

fn ZoneError::end_line(self : ZoneError) -> Int

ZoneError::message

source

fn ZoneError::message(self : ZoneError) -> String

ZoneError::new

source

fn ZoneError::new(code : ZoneErrorCode, message : String, span : SourceSpan) -> ZoneError

ZoneError::span

source

fn ZoneError::span(self : ZoneError) -> SourceSpan

ZoneError::start_column

source

fn ZoneError::start_column(self : ZoneError) -> Int

ZoneError::start_line

source

fn ZoneError::start_line(self : ZoneError) -> Int

ZoneErrorCode

source

pub(all) enum ZoneErrorCode {
  InvalidCharacter
  UnterminatedQuote
  UnterminatedEscape
  UnbalancedParenthesis
  TokenLimitExceeded
  InvalidDomainName
  InvalidDomainLabel
  DomainNameTooLong
  RelativeNameWithoutOrigin
  InvalidTtl
  TtlOverflow
  InvalidDirective
  UnsupportedDirective
  MissingRecordField
  InvalidRecordClass
  InvalidRecordType
  InvalidRecordData
  NumericFieldOutOfRange
  DuplicateSingletonRecord
  ConflictingCname
  MissingSoa
  MissingApexNs
  IntegrityViolation
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ZoneErrorCode::code

source

fn ZoneErrorCode::code(self : ZoneErrorCode) -> String

ZoneFinding

source

pub struct ZoneFinding {
  code_value : String
  severity_value : FindingSeverity
  message_value : String
  owner_value : DomainName?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ZoneFinding::code

source

fn ZoneFinding::code(self : ZoneFinding) -> String

ZoneFinding::message

source

fn ZoneFinding::message(self : ZoneFinding) -> String

ZoneFinding::owner

source

fn ZoneFinding::owner(self : ZoneFinding) -> DomainName?

ZoneFinding::severity

source

fn ZoneFinding::severity(self : ZoneFinding) -> FindingSeverity

ZoneIndex

source

pub struct ZoneIndex {
  record_values : Array[ZoneRecord]
  owner_values : Array[DomainName]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ZoneIndex::lookup

source

fn ZoneIndex::lookup(self : ZoneIndex, owner : DomainName, record_type : String) -> Array[ZoneRecord]

ZoneIndex::owner_count

source

fn ZoneIndex::owner_count(self : ZoneIndex) -> Int

ZoneIndex::owners

source

fn ZoneIndex::owners(self : ZoneIndex) -> Array[DomainName]

ZoneIndex::records

source

fn ZoneIndex::records(self : ZoneIndex) -> Array[ZoneRecord]

ZoneIndex::records_for_owner

source

fn ZoneIndex::records_for_owner(self : ZoneIndex, owner : DomainName) -> Array[ZoneRecord]

ZoneIndex::records_for_type

source

fn ZoneIndex::records_for_type(self : ZoneIndex, record_type : String) -> Array[ZoneRecord]

ZoneIndex::resolve_cname

source

fn ZoneIndex::resolve_cname(self : ZoneIndex, start : DomainName, max_hops? : Int) -> Result[CnameResolution, ZoneError]

ZonePolicy

source

pub struct ZonePolicy {
  require_soa_value : Bool
  require_apex_ns_value : Bool
  enforce_cname_exclusive_value : Bool
  max_records_value : Int?
  max_ttl_value : Ttl?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ZonePolicy::new

source

fn ZonePolicy::new(require_soa? : Bool, require_apex_ns? : Bool, enforce_cname_exclusive? : Bool, max_records? : Int?, max_ttl? : Ttl?) -> Result[ZonePolicy, ZoneError]

ZonePolicy::standard

source

fn ZonePolicy::standard() -> ZonePolicy

ZoneRecord

source

pub struct ZoneRecord {
  owner_value : DomainName
  ttl_value : Ttl
  class_value : String
  type_value : String
  data_value : RecordData
  explicit_ttl_value : Bool
  span_value : SourceSpan
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ZoneRecord::data

source

fn ZoneRecord::data(self : ZoneRecord) -> RecordData

ZoneRecord::owner

source

fn ZoneRecord::owner(self : ZoneRecord) -> DomainName

ZoneRecord::record_class

source

fn ZoneRecord::record_class(self : ZoneRecord) -> String

ZoneRecord::record_type

source

fn ZoneRecord::record_type(self : ZoneRecord) -> String

ZoneRecord::span

source

fn ZoneRecord::span(self : ZoneRecord) -> SourceSpan

ZoneRecord::to_text

source

fn ZoneRecord::to_text(self : ZoneRecord) -> String

ZoneRecord::ttl

source

fn ZoneRecord::ttl(self : ZoneRecord) -> Ttl

ZoneRecord::ttl_was_explicit

source

fn ZoneRecord::ttl_was_explicit(self : ZoneRecord) -> Bool

ZoneRecordSet

source

pub struct ZoneRecordSet {
  owner_value : DomainName
  type_value : String
  record_values : Array[ZoneRecord]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ZoneRecordSet::count

source

fn ZoneRecordSet::count(self : ZoneRecordSet) -> Int

ZoneRecordSet::duplicate_count

source

fn ZoneRecordSet::duplicate_count(self : ZoneRecordSet) -> Int

ZoneRecordSet::duplicate_records

source

fn ZoneRecordSet::duplicate_records(self : ZoneRecordSet) -> Array[ZoneRecord]

ZoneRecordSet::owner

source

fn ZoneRecordSet::owner(self : ZoneRecordSet) -> DomainName

ZoneRecordSet::record_type

source

fn ZoneRecordSet::record_type(self : ZoneRecordSet) -> String

ZoneRecordSet::records

source

fn ZoneRecordSet::records(self : ZoneRecordSet) -> Array[ZoneRecord]

ZoneRecordSet::unique_record_count

source

fn ZoneRecordSet::unique_record_count(self : ZoneRecordSet) -> Int

ZoneRecordSet::unique_records

source

fn ZoneRecordSet::unique_records(self : ZoneRecordSet) -> Array[ZoneRecord]

ZoneRecordSets

source

pub struct ZoneRecordSets {
  set_values : Array[ZoneRecordSet]
  record_count_value : Int
  duplicate_count_value : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ZoneRecordSets::duplicate_count

source

fn ZoneRecordSets::duplicate_count(self : ZoneRecordSets) -> Int

ZoneRecordSets::for_owner

source

fn ZoneRecordSets::for_owner(self : ZoneRecordSets, owner : DomainName) -> Array[ZoneRecordSet]

ZoneRecordSets::for_type

source

fn ZoneRecordSets::for_type(self : ZoneRecordSets, record_type : String) -> Array[ZoneRecordSet]

ZoneRecordSets::has_duplicates

source

fn ZoneRecordSets::has_duplicates(self : ZoneRecordSets) -> Bool

ZoneRecordSets::largest_set_size

source

fn ZoneRecordSets::largest_set_size(self : ZoneRecordSets) -> Int

ZoneRecordSets::lookup

source

fn ZoneRecordSets::lookup(self : ZoneRecordSets, owner : DomainName, record_type : String) -> ZoneRecordSet?

ZoneRecordSets::multi_record_set_count

source

fn ZoneRecordSets::multi_record_set_count(self : ZoneRecordSets) -> Int

ZoneRecordSets::record_count

source

fn ZoneRecordSets::record_count(self : ZoneRecordSets) -> Int

ZoneRecordSets::set_count

source

fn ZoneRecordSets::set_count(self : ZoneRecordSets) -> Int

ZoneRecordSets::sets

source

fn ZoneRecordSets::sets(self : ZoneRecordSets) -> Array[ZoneRecordSet]

ZoneRecordSets::singleton_set_count

source

fn ZoneRecordSets::singleton_set_count(self : ZoneRecordSets) -> Int

ZoneRecordSets::unique_record_count

source

fn ZoneRecordSets::unique_record_count(self : ZoneRecordSets) -> Int

ZoneReference

source

pub struct ZoneReference {
  source_owner_value : DomainName
  kind_value : ZoneReferenceKind
  target_value : DomainName
  internal_value : Bool
  target_declared_value : Bool
  address_available_value : Bool
  requires_address_value : Bool
  disabled_value : Bool
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ZoneReference::address_available

source

fn ZoneReference::address_available(self : ZoneReference) -> Bool

ZoneReference::disabled

source

fn ZoneReference::disabled(self : ZoneReference) -> Bool

ZoneReference::healthy

source

fn ZoneReference::healthy(self : ZoneReference) -> Bool

ZoneReference::internal

source

fn ZoneReference::internal(self : ZoneReference) -> Bool

ZoneReference::kind

source

fn ZoneReference::kind(self : ZoneReference) -> ZoneReferenceKind

ZoneReference::requires_address

source

fn ZoneReference::requires_address(self : ZoneReference) -> Bool

ZoneReference::source_owner

source

fn ZoneReference::source_owner(self : ZoneReference) -> DomainName

ZoneReference::target

source

fn ZoneReference::target(self : ZoneReference) -> DomainName

ZoneReference::target_declared

source

fn ZoneReference::target_declared(self : ZoneReference) -> Bool

ZoneReferenceAnalysis

source

pub struct ZoneReferenceAnalysis {
  reference_values : Array[ZoneReference]
  internal_count_value : Int
  external_count_value : Int
  missing_target_count_value : Int
  addressless_target_count_value : Int
  disabled_count_value : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ZoneReferenceAnalysis::addressless_target_count

source

fn ZoneReferenceAnalysis::addressless_target_count(self : ZoneReferenceAnalysis) -> Int

ZoneReferenceAnalysis::disabled_count

source

fn ZoneReferenceAnalysis::disabled_count(self : ZoneReferenceAnalysis) -> Int

ZoneReferenceAnalysis::external_count

source

fn ZoneReferenceAnalysis::external_count(self : ZoneReferenceAnalysis) -> Int

ZoneReferenceAnalysis::healthy

source

fn ZoneReferenceAnalysis::healthy(self : ZoneReferenceAnalysis) -> Bool

ZoneReferenceAnalysis::internal_count

source

fn ZoneReferenceAnalysis::internal_count(self : ZoneReferenceAnalysis) -> Int

ZoneReferenceAnalysis::missing_target_count

source

fn ZoneReferenceAnalysis::missing_target_count(self : ZoneReferenceAnalysis) -> Int

ZoneReferenceAnalysis::references

source

fn ZoneReferenceAnalysis::references(self : ZoneReferenceAnalysis) -> Array[ZoneReference]

ZoneReferenceKind

source

pub(all) enum ZoneReferenceKind {
  NameServerReference
  CanonicalNameReference
  MailExchangeReference
  ServiceTargetReference
  SoaPrimaryReference
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ZoneSelection

source

pub struct ZoneSelection {
  document_value : ZoneDocument
  selected_count_value : Int
  excluded_count_value : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ZoneSelection::document

source

fn ZoneSelection::document(self : ZoneSelection) -> ZoneDocument

ZoneSelection::excluded_count

source

fn ZoneSelection::excluded_count(self : ZoneSelection) -> Int

ZoneSelection::selected_count

source

fn ZoneSelection::selected_count(self : ZoneSelection) -> Int

ZoneStatement

source

pub struct ZoneStatement {
  token_values : Array[ZoneToken]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ZoneStatement::token_texts

source

fn ZoneStatement::token_texts(self : ZoneStatement) -> Array[String]

ZoneStatement::tokens

source

fn ZoneStatement::tokens(self : ZoneStatement) -> Array[ZoneToken]

ZoneStatistics

source

pub struct ZoneStatistics {
  record_count_value : Int
  owner_count_value : Int
  type_count_values : Array[RecordTypeCount]
  minimum_ttl_value : Ttl?
  maximum_ttl_value : Ttl?
  average_ttl_seconds_value : UInt64?
  apex_record_count_value : Int
  delegation_owner_count_value : Int
  explicit_ttl_count_value : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ZoneStatistics::apex_record_count

source

fn ZoneStatistics::apex_record_count(self : ZoneStatistics) -> Int

ZoneStatistics::average_ttl_seconds

source

fn ZoneStatistics::average_ttl_seconds(self : ZoneStatistics) -> UInt64?

ZoneStatistics::count_for_type

source

fn ZoneStatistics::count_for_type(self : ZoneStatistics, record_type : String) -> Int

ZoneStatistics::delegation_owner_count

source

fn ZoneStatistics::delegation_owner_count(self : ZoneStatistics) -> Int

ZoneStatistics::explicit_ttl_count

source

fn ZoneStatistics::explicit_ttl_count(self : ZoneStatistics) -> Int

ZoneStatistics::maximum_ttl

source

fn ZoneStatistics::maximum_ttl(self : ZoneStatistics) -> Ttl?

ZoneStatistics::minimum_ttl

source

fn ZoneStatistics::minimum_ttl(self : ZoneStatistics) -> Ttl?

ZoneStatistics::owner_count

source

fn ZoneStatistics::owner_count(self : ZoneStatistics) -> Int

ZoneStatistics::record_count

source

fn ZoneStatistics::record_count(self : ZoneStatistics) -> Int

ZoneStatistics::type_counts

source

fn ZoneStatistics::type_counts(self : ZoneStatistics) -> Array[RecordTypeCount]

ZoneToken

source

pub struct ZoneToken {
  text_value : String
  quoted_value : Bool
  span_value : SourceSpan
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ZoneToken::quoted

source

fn ZoneToken::quoted(self : ZoneToken) -> Bool

ZoneToken::span

source

fn ZoneToken::span(self : ZoneToken) -> SourceSpan

ZoneToken::text

source

fn ZoneToken::text(self : ZoneToken) -> String

ZoneTtlRewrite

source

pub struct ZoneTtlRewrite {
  document_value : ZoneDocument
  changed_count_value : Int
  unchanged_count_value : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ZoneTtlRewrite::changed_count

source

fn ZoneTtlRewrite::changed_count(self : ZoneTtlRewrite) -> Int

ZoneTtlRewrite::document

source

fn ZoneTtlRewrite::document(self : ZoneTtlRewrite) -> ZoneDocument

ZoneTtlRewrite::unchanged_count

source

fn ZoneTtlRewrite::unchanged_count(self : ZoneTtlRewrite) -> Int

ZoneValidation

source

pub struct ZoneValidation {
  finding_values : Array[ZoneFinding]
  record_count_value : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

ZoneValidation::accepted

source

fn ZoneValidation::accepted(self : ZoneValidation) -> Bool

ZoneValidation::error_count

source

fn ZoneValidation::error_count(self : ZoneValidation) -> Int

ZoneValidation::findings

source

fn ZoneValidation::findings(self : ZoneValidation) -> Array[ZoneFinding]

ZoneValidation::record_count

source

fn ZoneValidation::record_count(self : ZoneValidation) -> Int

ZoneValidation::warning_count

source

fn ZoneValidation::warning_count(self : ZoneValidation) -> Int

analyze_zone_references

source

fn analyze_zone_references(zone : ZoneDocument, max_references? : Int) -> Result[ZoneReferenceAnalysis, ZoneError]

Analyze domain-name references without treating external targets as errors.

build_zone_record_sets

source

fn build_zone_record_sets(zone : ZoneDocument, max_sets? : Int) -> Result[ZoneRecordSets, ZoneError]

Group records by owner and type and count exact duplicate evidence.

calculate_zone_statistics

source

fn calculate_zone_statistics(zone : ZoneDocument) -> ZoneStatistics

Calculate deterministic aggregate evidence for a parsed zone.

clamp_zone_ttls

source

fn clamp_zone_ttls(zone : ZoneDocument, minimum? : Ttl?, maximum? : Ttl?) -> Result[ZoneTtlRewrite, ZoneError]

Clamp record TTLs while preserving owner, class, type and record data.

compare_zones

source

fn compare_zones(left : ZoneDocument, right : ZoneDocument, max_changes? : Int) -> Result[ZoneComparison, ZoneError]

index_zone

source

fn index_zone(zone : ZoneDocument) -> ZoneIndex

lex_zone

source

fn lex_zone(text : String, max_tokens? : Int, max_token_bytes? : Int) -> Result[Array[ZoneStatement], ZoneError]

Tokenize BIND-style zone text while preserving logical statements.

parse_domain_name

source

fn parse_domain_name(text : String) -> Result[DomainName, ZoneError]

Parse an ASCII DNS presentation name without resolving a relative origin.

parse_ipv4

source

fn parse_ipv4(text : String) -> Result[Ipv4Address, ZoneError]

parse_ipv6

source

fn parse_ipv6(text : String) -> Result[Ipv6Address, ZoneError]

parse_record_data

source

fn parse_record_data(record_type : ZoneToken, fields : Array[ZoneToken], origin : DomainName) -> Result[RecordData, ZoneError]

parse_record_data_statement

source

fn parse_record_data_statement(statement : ZoneStatement, origin : DomainName) -> Result[RecordData, ZoneError]

parse_ttl

source

fn parse_ttl(text : String) -> Result[Ttl, ZoneError]

Parse a BIND-style TTL such as 3600, 2h30m or 1w2d.

parse_zone

source

fn parse_zone(text : String, initial_origin? : DomainName?, initial_ttl? : Ttl?, max_tokens? : Int, max_token_bytes? : Int) -> Result[ZoneDocument, ZoneError]

Parse a complete caller-provided zone text into resolved records.

parse_zone_directive

source

fn parse_zone_directive(statement : ZoneStatement, current_origin? : DomainName?) -> Result[ZoneDirective, ZoneError]

parse_zone_record

source

fn parse_zone_record(statement : ZoneStatement, origin : DomainName, inherited_owner? : DomainName?, inherited_ttl? : Ttl?) -> Result[ZoneRecord, ZoneError]

process_zone_batch

source

fn process_zone_batch(inputs : Array[ZoneBatchInput], policy : ZonePolicy, max_items? : Int, max_total_text_units? : Int, max_tokens_per_item? : Int, max_token_bytes? : Int) -> Result[ZoneBatch, ZoneError]

Parse and validate independent in-memory zone texts without fail-fast loss.

render_comparison_json

source

fn render_comparison_json(comparison : ZoneComparison) -> String

render_comparison_text

source

fn render_comparison_text(comparison : ZoneComparison) -> String

render_record_data

source

fn render_record_data(data : RecordData) -> String

render_record_sets_json

source

fn render_record_sets_json(sets : ZoneRecordSets) -> String

render_record_sets_text

source

fn render_record_sets_text(sets : ZoneRecordSets) -> String

render_reference_analysis_json

source

fn render_reference_analysis_json(analysis : ZoneReferenceAnalysis) -> String

render_reference_analysis_text

source

fn render_reference_analysis_text(analysis : ZoneReferenceAnalysis) -> String

render_statistics_json

source

fn render_statistics_json(statistics : ZoneStatistics) -> String

render_statistics_text

source

fn render_statistics_text(statistics : ZoneStatistics) -> String

render_validation_json

source

fn render_validation_json(validation : ZoneValidation) -> String

render_validation_text

source

fn render_validation_text(validation : ZoneValidation) -> String

render_zone

source

fn render_zone(zone : ZoneDocument) -> String

resolve_zone_name

source

fn resolve_zone_name(text : String, origin : DomainName) -> Result[DomainName, ZoneError]

select_zone_records

source

fn select_zone_records(zone : ZoneDocument, owner_subtree? : DomainName?, record_types? : Array[String]) -> Result[ZoneSelection, ZoneError]

Select records by an optional absolute owner subtree and type allow-list.

validate_zone

source

fn validate_zone(zone : ZoneDocument, policy : ZonePolicy) -> Result[ZoneValidation, ZoneError]

Install

Download zip

Validated DNS zone file parser and analysis toolkit for MoonBit

dnszone-filebindparserrfc1035

lmclmc1

Apache-2.0

github.com/lmclmc1/moonbit-dns-zone

Updated 2 months ago

31 downloads

Site source Report issue Modules Skills CLI Build queue Statistics

dns-zone-toolkit

#lmclmc1/dns-zone-toolkit

#CaaRecordData

#CaaRecordData::flags

#CaaRecordData::tag

#CaaRecordData::value

#CnameResolution

#CnameResolution::chain

#CnameResolution::chain_texts

#CnameResolution::terminal_records

#DomainName

#DomainName::is_absolute

#DomainName::labels

#DomainName::resolve

#DomainName::to_text

#DomainName::wire_length

#FindingSeverity

#GenericRecordData

#GenericRecordData::fields

#GenericRecordData::record_type

#Ipv4Address

#Ipv4Address::octets

#Ipv4Address::to_text

#Ipv6Address

#Ipv6Address::groups

#Ipv6Address::to_text

#MxRecordData

#MxRecordData::exchange

#MxRecordData::preference

#RecordChange

#RecordChange::kind

#RecordChange::left

#RecordChange::right

#RecordChangeKind

#RecordData

#RecordTypeCount

#RecordTypeCount::count

#RecordTypeCount::record_type

#ReferenceCandidate

#SoaRecordData

#SoaRecordData::expire

#SoaRecordData::minimum

#SoaRecordData::primary_name

#SoaRecordData::refresh

#SoaRecordData::responsible_name

#SoaRecordData::retry

#SoaRecordData::serial

#SourceSpan

#SourceSpan::end_column

#SourceSpan::end_line

#SourceSpan::point

#SourceSpan::range

#SourceSpan::start_column

#SourceSpan::start_line

#SrvRecordData

#SrvRecordData::port

#SrvRecordData::priority

#SrvRecordData::target

#SrvRecordData::weight

#Ttl

#Ttl::from_seconds

#Ttl::seconds

#Ttl::to_text

#ZoneBatch

#ZoneBatch::accepted_count

#ZoneBatch::items

#ZoneBatch::parse_failed_count

#ZoneBatch::rejected_count

#ZoneBatch::total_record_count

#ZoneBatchInput

#ZoneBatchInput::initial_origin

#ZoneBatchInput::initial_ttl

#ZoneBatchInput::label

#ZoneBatchInput::new

#ZoneBatchInput::text

#ZoneBatchItem

#ZoneBatchItem::accepted

#ZoneBatchItem::document

#ZoneBatchItem::label

#ZoneBatchItem::parse_error

CaaRecordData

CaaRecordData::flags

CaaRecordData::tag

CaaRecordData::value

CnameResolution

CnameResolution::chain

CnameResolution::chain_texts

CnameResolution::terminal_records

DomainName

DomainName::is_absolute

DomainName::labels

DomainName::resolve

DomainName::to_text

DomainName::wire_length

FindingSeverity

GenericRecordData

GenericRecordData::fields

GenericRecordData::record_type

Ipv4Address

Ipv4Address::octets

Ipv4Address::to_text

Ipv6Address

Ipv6Address::groups

Ipv6Address::to_text

MxRecordData

MxRecordData::exchange

MxRecordData::preference

RecordChange

RecordChange::kind

RecordChange::left

RecordChange::right

RecordChangeKind

RecordData

RecordTypeCount

RecordTypeCount::count

RecordTypeCount::record_type

ReferenceCandidate

SoaRecordData

SoaRecordData::expire

SoaRecordData::minimum

SoaRecordData::primary_name

SoaRecordData::refresh

SoaRecordData::responsible_name

SoaRecordData::retry

SoaRecordData::serial

SourceSpan

SourceSpan::end_column

SourceSpan::end_line

SourceSpan::point

SourceSpan::range

SourceSpan::start_column

SourceSpan::start_line

SrvRecordData

SrvRecordData::port

SrvRecordData::priority

SrvRecordData::target

SrvRecordData::weight

Ttl

Ttl::from_seconds

Ttl::seconds

Ttl::to_text

ZoneBatch

ZoneBatch::accepted_count

ZoneBatch::items

ZoneBatch::parse_failed_count

ZoneBatch::rejected_count

ZoneBatch::total_record_count

ZoneBatchInput

ZoneBatchInput::initial_origin

ZoneBatchInput::initial_ttl

ZoneBatchInput::label

ZoneBatchInput::new

ZoneBatchInput::text

ZoneBatchItem

ZoneBatchItem::accepted

ZoneBatchItem::document

ZoneBatchItem::label

ZoneBatchItem::parse_error

ZoneBatchItem::parsed

ZoneBatchItem::statistics