dns-zone-toolkit
Validated DNS zone file parser and analysis toolkit for MoonBit
dns
zone-file
bind
parser
rfc1035
moon add lmclmc1/dns-zone-toolkit@0.1.0
Download zipAuthor
Version
0.1.0
License
Apache-2.0
Repository
Last updated
6 days ago
Downloads
4
README#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
#CnameResolution
pub struct CnameResolution {
chain_values : Array[DomainName]
terminal_record_values : Array[ZoneRecord]
} derive(Eq, Debug)#CnameResolution::chain_texts
#CnameResolution::terminal_records
#DomainName
#DomainName::resolve
#FindingSeverity
#GenericRecordData
#GenericRecordData::fields
#GenericRecordData::record_type
#Ipv4Address
#Ipv6Address
#MxRecordData
#RecordChange
pub struct RecordChange {
kind_value : RecordChangeKind
left_value : ZoneRecord?
right_value : ZoneRecord?
} derive(Eq, Debug)#RecordChangeKind
#RecordData
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, Debug)#RecordTypeCount
#RecordTypeCount::record_type
#SoaRecordData
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, Debug)#SoaRecordData::primary_name
#SoaRecordData::responsible_name
#SourceSpan
#SourceSpan::range
fn SourceSpan::range(start_line : Int, start_column : Int, end_line : Int, end_column : Int) -> SourceSpan#SrvRecordData
pub struct SrvRecordData {
priority_value : Int
weight_value : Int
port_value : Int
target_value : DomainName
} derive(Eq, Debug)#Ttl
#ZoneBatch
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, Debug)#ZoneBatchInput
pub struct ZoneBatchInput {
label_value : String
text_value : String
initial_origin_value : DomainName?
initial_ttl_value : Ttl?
} derive(Eq, Debug)#ZoneBatchInput::initial_origin
#ZoneBatchInput::new
fn ZoneBatchInput::new(label : String, text : String, initial_origin? : DomainName?, initial_ttl? : Ttl?) -> Result[ZoneBatchInput, ZoneError]#ZoneBatchItem
pub struct ZoneBatchItem {
label_value : String
document_value : ZoneDocument?
validation_value : ZoneValidation?
statistics_value : ZoneStatistics?
parse_error_value : ZoneError?
} derive(Eq, Debug)#ZoneBatchItem::statistics
#ZoneBatchItem::validation
#ZoneComparison
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, Debug)#ZoneComparison::changes
#ZoneComparison::data_changed_count
#ZoneComparison::ttl_changed_count
#ZoneDirective
pub(all) enum ZoneDirective {
OriginDirective(DomainName)
DefaultTtlDirective(Ttl)
} derive(Eq, Debug)#ZoneDocument
pub struct ZoneDocument {
record_values : Array[ZoneRecord]
origin_value : DomainName?
default_ttl_value : Ttl?
directive_count_value : Int
} derive(Eq, Debug)#ZoneError
pub struct ZoneError {
code_value : String
message_value : String
span_value : SourceSpan
} derive(Eq, Debug)#ZoneError::new
#ZoneErrorCode
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, Debug)#ZoneFinding
pub struct ZoneFinding {
code_value : String
severity_value : FindingSeverity
message_value : String
owner_value : DomainName?
} derive(Eq, Debug)#ZoneIndex
pub struct ZoneIndex {
record_values : Array[ZoneRecord]
owner_values : Array[DomainName]
} derive(Eq, Debug)#ZoneIndex::lookup
fn ZoneIndex::lookup(self : ZoneIndex, owner : DomainName, record_type : String) -> Array[ZoneRecord]#ZoneIndex::records_for_owner
#ZoneIndex::records_for_type
#ZoneIndex::resolve_cname
fn ZoneIndex::resolve_cname(self : ZoneIndex, start : DomainName, max_hops? : Int) -> Result[CnameResolution, ZoneError]#ZonePolicy
#ZonePolicy::new
fn ZonePolicy::new(require_soa? : Bool, require_apex_ns? : Bool, enforce_cname_exclusive? : Bool, max_records? : Int?, max_ttl? : Ttl?) -> Result[ZonePolicy, ZoneError]#ZoneRecord
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, Debug)#ZoneRecordSet
pub struct ZoneRecordSet {
owner_value : DomainName
type_value : String
record_values : Array[ZoneRecord]
} derive(Eq, Debug)#ZoneRecordSet::duplicate_records
#ZoneRecordSet::unique_record_count
#ZoneRecordSet::unique_records
#ZoneRecordSets
pub struct ZoneRecordSets {
set_values : Array[ZoneRecordSet]
record_count_value : Int
duplicate_count_value : Int
} derive(Eq, Debug)#ZoneRecordSets::duplicate_count
#ZoneRecordSets::for_owner
#ZoneRecordSets::for_type
#ZoneRecordSets::has_duplicates
#ZoneRecordSets::largest_set_size
#ZoneRecordSets::lookup
fn ZoneRecordSets::lookup(self : ZoneRecordSets, owner : DomainName, record_type : String) -> ZoneRecordSet?#ZoneRecordSets::multi_record_set_count
#ZoneRecordSets::singleton_set_count
#ZoneRecordSets::unique_record_count
#ZoneReference
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, Debug)#ZoneReference::address_available
#ZoneReference::requires_address
#ZoneReference::source_owner
#ZoneReference::target_declared
#ZoneReferenceAnalysis
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, Debug)#ZoneReferenceAnalysis::addressless_target_count
#ZoneReferenceAnalysis::disabled_count
#ZoneReferenceAnalysis::external_count
#ZoneReferenceAnalysis::healthy
#ZoneReferenceAnalysis::internal_count
#ZoneReferenceAnalysis::missing_target_count
#ZoneReferenceAnalysis::references
#ZoneReferenceKind
#ZoneSelection
pub struct ZoneSelection {
document_value : ZoneDocument
selected_count_value : Int
excluded_count_value : Int
} derive(Eq, Debug)#ZoneStatement
#ZoneStatement::token_texts
#ZoneStatistics
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, Debug)#ZoneStatistics::apex_record_count
#ZoneStatistics::average_ttl_seconds
#ZoneStatistics::count_for_type
#ZoneStatistics::delegation_owner_count
#ZoneStatistics::explicit_ttl_count
#ZoneStatistics::type_counts
#ZoneToken
pub struct ZoneToken {
text_value : String
quoted_value : Bool
span_value : SourceSpan
} derive(Eq, Debug)#ZoneTtlRewrite
pub struct ZoneTtlRewrite {
document_value : ZoneDocument
changed_count_value : Int
unchanged_count_value : Int
} derive(Eq, Debug)#ZoneTtlRewrite::unchanged_count
#ZoneValidation
pub struct ZoneValidation {
finding_values : Array[ZoneFinding]
record_count_value : Int
} derive(Eq, Debug)#ZoneValidation::findings
#analyze_zone_references
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
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
Calculate deterministic aggregate evidence for a parsed zone.
#clamp_zone_ttls
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
fn compare_zones(left : ZoneDocument, right : ZoneDocument, max_changes? : Int) -> Result[ZoneComparison, ZoneError]#lex_zone
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
Parse an ASCII DNS presentation name without resolving a relative origin.
#parse_record_data
fn parse_record_data(record_type : ZoneToken, fields : Array[ZoneToken], origin : DomainName) -> Result[RecordData, ZoneError]#parse_record_data_statement
fn parse_record_data_statement(statement : ZoneStatement, origin : DomainName) -> Result[RecordData, ZoneError]#parse_ttl
Parse a BIND-style TTL such as 3600, 2h30m or 1w2d.
#parse_zone
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
fn parse_zone_directive(statement : ZoneStatement, current_origin? : DomainName?) -> Result[ZoneDirective, ZoneError]#parse_zone_record
fn parse_zone_record(statement : ZoneStatement, origin : DomainName, inherited_owner? : DomainName?, inherited_ttl? : Ttl?) -> Result[ZoneRecord, ZoneError]#process_zone_batch
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_reference_analysis_json
#render_reference_analysis_text
#resolve_zone_name
#select_zone_records
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
Validated DNS zone file parser and analysis toolkit for MoonBit
dnszone-filebindparserrfc1035
0.1.0
Apache-2.0
Updated 6 days ago
4 downloads