Network.DNS.Pattern

Patterns can be simple absolute domain names, where labels are replaceable with a single glob * or a globstar **. A single glob will match any label in its place, where globstar will greedily match as many labels as possible towards the left.

Admits the escape sequences from domain names. See DNS.

Note: Currently a globstar is only supported on the left-most label.

Examples of valid patterns are:

   *.foo.bar.
   **.foo.bar.
   foo.*.bar.
   foo.bar.*.

Pattern language

newtype DomainPattern

A domain pattern.

Constructors

DomainPattern

Fields

• getDomainPattern :: [LabelPattern]

Instances

Eq DomainPattern

Defined in Network.DNS.Pattern.Internal

Methods

(==) :: DomainPattern -> DomainPattern -> Bool

(/=) :: DomainPattern -> DomainPattern -> Bool

Ord DomainPattern

Defined in Network.DNS.Pattern.Internal

Methods

compare :: DomainPattern -> DomainPattern -> Ordering

(<) :: DomainPattern -> DomainPattern -> Bool

(<=) :: DomainPattern -> DomainPattern -> Bool

(>) :: DomainPattern -> DomainPattern -> Bool

(>=) :: DomainPattern -> DomainPattern -> Bool

max :: DomainPattern -> DomainPattern -> DomainPattern

min :: DomainPattern -> DomainPattern -> DomainPattern

data LabelPattern

A pattern for a singular label.

Constructors

DomLiteral DomainLabel

Represents an exact label that must be matched.

DomGlob

Represents a single asterisk glob matching any arbitrary domain at a given level.

DomGlobStar

Represents a double asterisk matching any arbitrary subdomain at a given level.

Instances

Eq LabelPattern

Defined in Network.DNS.Pattern.Internal

Methods

(==) :: LabelPattern -> LabelPattern -> Bool

(/=) :: LabelPattern -> LabelPattern -> Bool

Ord LabelPattern

Defined in Network.DNS.Pattern.Internal

Methods

compare :: LabelPattern -> LabelPattern -> Ordering

(<) :: LabelPattern -> LabelPattern -> Bool

(<=) :: LabelPattern -> LabelPattern -> Bool

(>) :: LabelPattern -> LabelPattern -> Bool

(>=) :: LabelPattern -> LabelPattern -> Bool

max :: LabelPattern -> LabelPattern -> LabelPattern

min :: LabelPattern -> LabelPattern -> LabelPattern

matchesPattern :: Domain -> DomainPattern -> Bool

Test whether a given domain matches a DomainPattern

patternWorksInside :: DomainPattern -> Domain -> Bool

Given a pattern and a DNS zone specified by a domain name, test whether or not the pattern is applicable beneath that zone.

  foo.*.bar.  applicable inside zone          quux.bar.
  foo.bar.    applicable inside zone          bar.
  bar.        applicable inside zone          bar.
  foo.bar.    not applicable inside zone      quux.

labelMatchesPattern :: DomainLabel -> LabelPattern -> Bool

Test whether a single label matches a label pattern

Parsing

parsePattern :: Text -> Either String DomainPattern

Parse a domain pattern. Convenience wrapper for 'patternP.

patternP :: Parser DomainPattern

Attoparsec Parser for domain patterns. See parsePattern for a convenince wrapper.

Pretty printing

pprPattern :: DomainPattern -> Text

Print domain pattern.

This function nearly roundtrips with parsePattern up to escape sequence equivalence.

parsePattern . pprPattern ~~~ id

pprPatternCF :: DomainPattern -> Text

Print domain pattern after into presentation format after case-folding according to RFC4343.

This function nearly roundtrips with parsePattern up to escape sequence equivalence and case folding.

parsePattern . pprPatternCF ~~~ id

pprLabelPattern :: LabelPattern -> Text

Print a singular domain label pattern into a presentation format.

pprLabelPatternCF :: LabelPattern -> Text

Print a singular domain label pattern into a presentation format after case-folding according to RFC4343.