Copyright	(c) Viktor Dukhovni 2026
License	BSD-3-Clause
Maintainer	ietf-dane@dukhovni.org
Stability	unstable
Safe Haskell	None
Language	GHC2024

Net.DNSBase.NsecTypes

Contents

NSECNSEC3CSYNC Type Bitmap structure
Legacy type bitmap in NXT records

Description

The packed bitmap used to list which RR types are present at (or relevant to) the owner name. NsecTypes is the window-based encoding from RFC 4034 section 4.1.2, used by T_nsec, T_nsec3, and T_csync to carry an arbitrary set of RRTYPE codepoints in a compact form. NxtTypes is the legacy single-window encoding used by the obsolete NXT record, which restricts types to the first 128 codepoints.

NsecTypes is an instance of IsList with Item NsecTypes = RRTYPE, so construction is via fromList xs from GHC.IsList (or [A, AAAA, ...] under OverloadedLists, via the associated RRTYPE pattern synonyms) and enumeration is via toList. The input list is deduplicated and reordered into wire-form canonical order; an empty input produces the empty bitmap. hasRRtype is the efficient membership predicate used by DNSSEC validators.

Example

Expand

ghci> import qualified GHC.IsList as IL (fromList, toList)
ghci> tys = IL.fromList @NsecTypes [MX, A, AAAA, A]
ghci> tys
fromList @NsecTypes [1,15,28]
ghci> IL.toList tys
[1,15,28]
ghci> hasRRtype AAAA tys
True
ghci> hasRRtype NS tys
False

Synopsis

data NsecTypes
nsecTypesFromList :: [RRTYPE] -> NsecTypes
nsecTypesToList :: NsecTypes -> [RRTYPE]
getNsecTypes :: Int -> SGet NsecTypes
putNsecTypes :: NsecTypes -> SPut s RData
hasRRtype :: RRTYPE -> NsecTypes -> Bool
newtype NxtTypes = NxtTypes ShortByteString
data NxtRRtype
toNxtTypes :: NonEmpty RRTYPE -> NxtTypes
nxtTypesFromNE :: NonEmpty NxtRRtype -> NxtTypes
nxtTypesToNE :: NxtTypes -> NonEmpty NxtRRtype
getNxtTypes :: Int -> SGet NxtTypes
hasNxtRRtype :: RRTYPE -> NxtTypes -> Bool
module Net.DNSBase.NonEmpty

NSECNSEC3CSYNC Type Bitmap structure

data NsecTypes Source #

Abstract representation of a set of RRTYPE codepoints, stored as the window-based wire-format bitmap from RFC 4034 section 4.1.2. Used by T_nsec, T_nsec3, and T_csync to carry the set of types present at the owner name.

An NsecTypes may legitimately be empty -- this is the expected encoding for an NSEC3 empty-non-terminal. With NSEC, the type bitmap is expected to include at least the NSEC type itself; that invariant is not enforced by the type.

Construction and enumeration go through IsList:

fromList tys :: NsecTypes builds the bitmap from a list of RRTYPE values; duplicates are merged and the wire-form ordering is canonical regardless of input order. Under OverloadedLists the same input shape is just [A, AAAA, MX].
toList bm :: [RRTYPE] enumerates the contained types in ascending wire-form order.
(<>) unions two bitmaps; mempty is the empty bitmap.

For membership without enumerating the whole set, use hasRRtype, which goes directly to the relevant window, block and bit offset.

Instances

Instances details

Presentable NsecTypes Source #

Presentation form: contained types in canonical wire-form order, space-separated, with no leading separator. The empty bitmap renders as the empty string. When the bitmap follows another field in an RR's presentation form, compose with presentSp or presentLn to prefix the appropriate separator.

Instance details

Defined in Net.DNSBase.NsecTypes

Methods

present :: NsecTypes -> Builder -> Builder Source #

presentLazy :: NsecTypes -> ByteString -> ByteString Source #

Semigroup NsecTypes Source #

The (<>) operator unions the two bitmaps; duplicate types are merged.

Instance details

Defined in Net.DNSBase.NsecTypes

Methods

(<>) :: NsecTypes -> NsecTypes -> NsecTypes #

sconcat :: NonEmpty NsecTypes -> NsecTypes #

stimes :: Integral b => b -> NsecTypes -> NsecTypes #

IsList NsecTypes Source #

Construction is via fromList (from any list of RRTYPEs, order and duplicates immaterial), and enumeration is via toList (yielding types in canonical wire-form order).

Instance details

Defined in Net.DNSBase.NsecTypes

Associated Types

type Item NsecTypes
Instance details Defined in Net.DNSBase.NsecTypes type Item NsecTypes = RRTYPE

Methods

fromList :: [Item NsecTypes] -> NsecTypes #

fromListN :: Int -> [Item NsecTypes] -> NsecTypes #

toList :: NsecTypes -> [Item NsecTypes] #

Show NsecTypes Source #

Instance details

Defined in Net.DNSBase.NsecTypes

Methods

showsPrec :: Int -> NsecTypes -> ShowS #

show :: NsecTypes -> String #

showList :: [NsecTypes] -> ShowS #

Eq NsecTypes Source #

Instance details

Defined in Net.DNSBase.NsecTypes

Methods

(==) :: NsecTypes -> NsecTypes -> Bool #

(/=) :: NsecTypes -> NsecTypes -> Bool #

Ord NsecTypes Source #

The Ord instance matches wire-form canonical order.

Instance details

Defined in Net.DNSBase.NsecTypes

Methods

compare :: NsecTypes -> NsecTypes -> Ordering #

(<) :: NsecTypes -> NsecTypes -> Bool #

(<=) :: NsecTypes -> NsecTypes -> Bool #

(>) :: NsecTypes -> NsecTypes -> Bool #

(>=) :: NsecTypes -> NsecTypes -> Bool #

max :: NsecTypes -> NsecTypes -> NsecTypes #

min :: NsecTypes -> NsecTypes -> NsecTypes #

type Item NsecTypes Source #

Instance details

Defined in Net.DNSBase.NsecTypes

type Item NsecTypes = RRTYPE

nsecTypesFromList :: [RRTYPE] -> NsecTypes Source #

Construct the per-window bitmaps from a list of types.

nsecTypesToList :: NsecTypes -> [RRTYPE] Source #

Convert NsecTypes bitmap to an RRTYPE list

getNsecTypes :: Int -> SGet NsecTypes Source #

putNsecTypes :: NsecTypes -> SPut s RData Source #

Output the bitmaps.

hasRRtype :: RRTYPE -> NsecTypes -> Bool Source #

Efficient NSEC/NSEC3 type bitmap membership predicate.

Legacy type bitmap in NXT records

newtype NxtTypes Source #

Constructors

NxtTypes ShortByteString

Instances

Instances details

Presentable NxtTypes Source #

Instance details

Defined in Net.DNSBase.NsecTypes

Methods

present :: NxtTypes -> Builder -> Builder Source #

presentLazy :: NxtTypes -> ByteString -> ByteString Source #

IsNonEmptyList NxtTypes Source #

Instance details

Defined in Net.DNSBase.NsecTypes

Associated Types

type Item1 NxtTypes
Instance details Defined in Net.DNSBase.NsecTypes type Item1 NxtTypes = NxtRRtype

Methods

toNonEmptyList :: NxtTypes -> NonEmpty (Item1 NxtTypes) Source #

fromNonEmptyList :: NonEmpty (Item1 NxtTypes) -> NxtTypes Source #

Semigroup NxtTypes Source #

Concatentation va (<>) operator merges the two bitmaps.

Instance details

Defined in Net.DNSBase.NsecTypes

Methods

(<>) :: NxtTypes -> NxtTypes -> NxtTypes #

sconcat :: NonEmpty NxtTypes -> NxtTypes #

stimes :: Integral b => b -> NxtTypes -> NxtTypes #

Show NxtTypes Source #

Instance details

Defined in Net.DNSBase.NsecTypes

Methods

showsPrec :: Int -> NxtTypes -> ShowS #

show :: NxtTypes -> String #

showList :: [NxtTypes] -> ShowS #

Eq NxtTypes Source #

Instance details

Defined in Net.DNSBase.NsecTypes

Methods

(==) :: NxtTypes -> NxtTypes -> Bool #

(/=) :: NxtTypes -> NxtTypes -> Bool #

Ord NxtTypes Source #

The Ord instance matches wire-form canonical order.

Instance details

Defined in Net.DNSBase.NsecTypes

Methods

compare :: NxtTypes -> NxtTypes -> Ordering #

(<) :: NxtTypes -> NxtTypes -> Bool #

(<=) :: NxtTypes -> NxtTypes -> Bool #

(>) :: NxtTypes -> NxtTypes -> Bool #

(>=) :: NxtTypes -> NxtTypes -> Bool #

max :: NxtTypes -> NxtTypes -> NxtTypes #

min :: NxtTypes -> NxtTypes -> NxtTypes #

type Item1 NxtTypes Source #

Instance details

Defined in Net.DNSBase.NsecTypes

type Item1 NxtTypes = NxtRRtype

data NxtRRtype Source #

An RRtype representable in an NXT RR bitmap.

Instances

Instances details

Presentable NxtRRtype Source #
Instance details Defined in Net.DNSBase.NsecTypes Methods present :: NxtRRtype -> Builder -> Builder Source # presentLazy :: NxtRRtype -> ByteString -> ByteString Source #
Bounded NxtRRtype Source #
Instance details Defined in Net.DNSBase.NsecTypes Methods minBound :: NxtRRtype # maxBound :: NxtRRtype #
Enum NxtRRtype Source #
Instance details Defined in Net.DNSBase.NsecTypes Methods succ :: NxtRRtype -> NxtRRtype # pred :: NxtRRtype -> NxtRRtype # toEnum :: Int -> NxtRRtype # fromEnum :: NxtRRtype -> Int # enumFrom :: NxtRRtype -> [NxtRRtype] # enumFromThen :: NxtRRtype -> NxtRRtype -> [NxtRRtype] # enumFromTo :: NxtRRtype -> NxtRRtype -> [NxtRRtype] # enumFromThenTo :: NxtRRtype -> NxtRRtype -> NxtRRtype -> [NxtRRtype] #
Show NxtRRtype Source #
Instance details Defined in Net.DNSBase.NsecTypes Methods showsPrec :: Int -> NxtRRtype -> ShowS # show :: NxtRRtype -> String # showList :: [NxtRRtype] -> ShowS #
Eq NxtRRtype Source #
Instance details Defined in Net.DNSBase.NsecTypes Methods (==) :: NxtRRtype -> NxtRRtype -> Bool # (/=) :: NxtRRtype -> NxtRRtype -> Bool #
Ord NxtRRtype Source #
Instance details Defined in Net.DNSBase.NsecTypes Methods compare :: NxtRRtype -> NxtRRtype -> Ordering # (<) :: NxtRRtype -> NxtRRtype -> Bool # (<=) :: NxtRRtype -> NxtRRtype -> Bool # (>) :: NxtRRtype -> NxtRRtype -> Bool # (>=) :: NxtRRtype -> NxtRRtype -> Bool # max :: NxtRRtype -> NxtRRtype -> NxtRRtype # min :: NxtRRtype -> NxtRRtype -> NxtRRtype #

toNxtTypes :: NonEmpty RRTYPE -> NxtTypes Source #

An error if any of input RRtypes are above 127.

nxtTypesFromNE :: NonEmpty NxtRRtype -> NxtTypes Source #

Construct the bitmap from a non-empty list of types.

nxtTypesToNE :: NxtTypes -> NonEmpty NxtRRtype Source #

Reconstruct RRTYPE list from bitmap.

getNxtTypes :: Int -> SGet NxtTypes Source #

hasNxtRRtype :: RRTYPE -> NxtTypes -> Bool Source #

Efficient NXT type bitmap membership predicate.

module Net.DNSBase.NonEmpty