| Copyright | © 2017 Herbert Valerio Riedel |
|---|---|
| License | GPL-2.0-or-later |
| Safe Haskell | Trustworthy |
| Language | Haskell2010 |
Network.DNS
Contents
Description
This module implements an API for accessing
the Domain Name Service (DNS)
resolver service via the standard libresolv system library
on Unix systems.
Synopsis
- queryA :: Name -> IO [(TTL, IPv4)]
- queryAAAA :: Name -> IO [(TTL, IPv6)]
- queryCNAME :: Name -> IO [(TTL, Name)]
- querySRV :: Name -> IO [(TTL, SRV Name)]
- queryTXT :: Name -> IO [(TTL, [CharStr])]
- query :: IsLabels n => Class -> n -> TypeSym -> IO (Msg n)
- data DnsException
- resIsReentrant :: Bool
- queryRaw :: Class -> Name -> Type -> IO ByteString
- sendRaw :: ByteString -> IO ByteString
- mkQueryRaw :: Class -> Name -> Type -> IO ByteString
- decodeMessage :: IsLabels n => ByteString -> Maybe (Msg n)
- encodeMessage :: IsLabels n => Msg n -> Maybe ByteString
- mkQueryMsg :: IsLabels n => Class -> n -> Type -> Msg n
- type Label = ByteString
- data Labels
- class IsLabels s where
- toLabels :: s -> Maybe Labels
- fromLabels :: Labels -> s
- newtype Name = Name ByteString
- caseFoldName :: Name -> Name
- newtype CharStr = CharStr ByteString
- data IPv4 = IPv4 !Word32
- data IPv6 = IPv6 !Word64 !Word64
- newtype TTL = TTL Int32
- newtype Class = Class Word16
- classIN :: Class
- newtype Type = Type Word16
- data TypeSym
- typeFromSym :: TypeSym -> Type
- typeToSym :: Type -> Maybe TypeSym
- data Msg l = Msg {}
- data MsgHeader = MsgHeader {}
- data MsgHeaderFlags = MsgHeaderFlags {}
- data QR
- data MsgQuestion l = MsgQuestion !l !Type !Class
- data MsgRR l = MsgRR {}
- data RData l
- = RDataA !IPv4
- | RDataAAAA !IPv6
- | RDataCNAME !l
- | RDataPTR !l
- | RDataHINFO !CharStr !CharStr
- | RDataNS !l
- | RDataMX !Word16 !l
- | RDataTXT ![CharStr]
- | RDataSPF ![CharStr]
- | RDataSOA !l !l !Word32 !Word32 !Word32 !Word32 !Word32
- | RDataSRV !(SRV l)
- | RDataAFSDB !Word16 !l
- | RDataNAPTR !Word16 !Word16 !CharStr !CharStr !CharStr !l
- | RDataURI !Word16 !Word16 !ByteString
- | RDataRRSIG !Word16 !Word8 !Word8 !Word32 !Word32 !Word32 !Word16 !l !ByteString
- | RDataDNSKEY !Word16 !Word8 !Word8 !ByteString
- | RDataDS !Word16 !Word8 !Word8 !ByteString
- | RDataNSEC !l !(Set Type)
- | RDataSSHFP !Word8 !Word8 !ByteString
- | RDataNSEC3PARAM !Word8 !Word8 !Word16 !CharStr
- | RDataNSEC3 !Word8 !Word8 !Word16 !CharStr !CharStr !(Set Type)
- | RDataCAA !Word8 !CharStr !ByteString
- | RDataOPT !ByteString
- | RData !Type !ByteString
- rdType :: RData l -> Either Type TypeSym
- data SRV l = SRV {}
High level API
queryA :: Name -> IO [(TTL, IPv4)] #
Query A record (see RFC 1035, section 3.4.1).
This query returns only exact matches (modulo foldCaseName).
E.g. in case of CNAME responses even if the
answer section would contain A records for the hostnames pointed
to by the CNAME. You can use query if you need more control.
>>>queryA (Name "www.google.com")[(TTL 72,IPv4 0xd83acde4)]
queryAAAA :: Name -> IO [(TTL, IPv6)] #
Query AAAA records (see RFC 3596).
This query returns only exact matches (modulo foldCaseName).
E.g. in case of CNAME responses even if the answer section would
contain A records for the hostnames pointed to by the
CNAME. You can use query if you need more control.
>>>queryAAAA (Name "www.google.com")[(TTL 299,IPv6 0x2a0014504001081e 0x2004)]
queryCNAME :: Name -> IO [(TTL, Name)] #
Query CNAME records (see RFC 1035, section 3.3.1).
>>>queryCNAME (Name "hackage.haskell.org")[(TTL 299,Name "j.global-ssl.fastly.net.")]
querySRV :: Name -> IO [(TTL, SRV Name)] #
Query SRV records (see RFC 2782).
>>>querySRV (Name "_imap._tcp.gmail.com")[(TTL 21599,SRV {srvPriority = 0, srvWeight = 0, srvPort = 0, srvTarget = Name "."})]
queryTXT :: Name -> IO [(TTL, [CharStr])] #
Query TXT records (see RFC 1035, section 3.3.14).
>>>queryTXT (Name "_mirrors.hackage.haskell.org")[(TTL 299,["0.urlbase=http://hackage.fpcomplete.com/", "1.urlbase=http://objects-us-west-1.dream.io/hackage-mirror/"])]
Mid-level API
query :: IsLabels n => Class -> n -> TypeSym -> IO (Msg n) #
Send a query via res_query(3) and decode its response into a Msg
Throws DnsException in case of encoding or decoding errors. May throw other IO exceptions in case of network errors.
Example
>>>query classIN (Name "_mirrors.hackage.haskell.org") TypeTXTJust (Msg{msgHeader = MsgHeader{mhId = 56694, mhFlags = MsgHeaderFlags{mhQR = IsResponse, mhOpcode = 0, mhAA = False, mhTC = False, mhRD = True, mhRA = True, mhZ = False, mhAD = False, mhCD = False, mhRCode = 0}, mhQDCount = 1, mhANCount = 1, mhNSCount = 0, mhARCount = 1}, msgQD = [MsgQuestion (Name "_mirrors.hackage.haskell.org.") (Type 16) (Class 1)], msgAN = [MsgRR{rrName = Name "_mirrors.hackage.haskell.org.", rrClass = Class 1, rrTTL = TTL 299, rrData = RDataTXT ["0.urlbase=http://hackage.fpcomplete.com/", "1.urlbase=http://objects-us-west-1.dream.io/hackage-mirror/"]}], msgNS = [], msgAR = [MsgRR{rrName = Name ".", rrClass = Class 512, rrTTL = TTL 32768, rrData = RDataOPT ""}] })
data DnsException #
Exception thrown in case of errors while encoding or decoding into a Msg.
Since: 0.1.1.0
Constructors
| DnsEncodeException | |
| DnsDecodeException |
Instances
| Show DnsException # | |
Defined in Network.DNS Methods showsPrec :: Int -> DnsException -> ShowS # show :: DnsException -> String # showList :: [DnsException] -> ShowS # | |
| Exception DnsException # | |
Defined in Network.DNS Methods toException :: DnsException -> SomeException # fromException :: SomeException -> Maybe DnsException # displayException :: DnsException -> String # | |
Low-level API
resIsReentrant :: Bool #
Whether the reentrant DNS resolver C API (e.g. res_nquery(3), res_nsend(3)) is being used.
If this this False, then as a fall-back
res_query(3)/res_send(3) are used, protected by a global mutex.
Since: 0.1.1.0
queryRaw :: Class -> Name -> Type -> IO ByteString #
Send a query via res_query(3), the return value is the raw binary response message.
You can use decodeMessage to decode the response message.
sendRaw :: ByteString -> IO ByteString #
Send a raw preformatted query via res_send(3).
mkQueryRaw :: Class -> Name -> Type -> IO ByteString #
Use res_mkquery(3) to construct a DNS query message.
decodeMessage :: IsLabels n => ByteString -> Maybe (Msg n) #
Decode a raw DNS message (query or response)
Returns Nothing on decoding failures.
encodeMessage :: IsLabels n => Msg n -> Maybe ByteString #
Construct a raw DNS message (query or response)
May return Nothing in input parameters are detected to be invalid.
mkQueryMsg :: IsLabels n => Class -> n -> Type -> Msg n #
Construct a DNS query Msg in the style of mkQueryRaw
Types
Basic types
Names/Labels
type Label = ByteString #
A DNS Label
Must be non-empty and at most 63 octets.
A domain-name as per RFC 1035, section 3.3 expressed as list of Labels.
See also Name
Types that represent domain-name as per RFC 1035, section 3.3 and can be converted to and from Labels.
<domain-name> as per RFC 1035, section 3.3.
A domain-name represented as a series of labels separated by dots.
See also Labels for list-based representation.
NOTE: The Labels type is able to properly represent domain
names whose components contain dots which the Name representation
cannot.
Constructors
| Name ByteString |
caseFoldName :: Name -> Name #
Normalise Name
This function case folds Names as described in
in RFC 4343, section 3
by subtracting 0x20 from all octets in the inclusive range
[0x61..0x7A] (i.e. mapping ['a'..'z'] to ['A'..'Z']).
This operation is idempotent.
Character strings
<character-string> as per RFC 1035, section 3.3.
A sequence of up to 255 octets
The limit of 255 octets is caused by the encoding which uses by a prefixed octet denoting the length.
Constructors
| CharStr ByteString |
IP addresses
An IPv4 address
The IP address is represented in network order, i.e. 127.0.0.1 is
represented as (IPv4 0x7f000001).
An IPv6 address
The IP address is represented in network order,
i.e. 2606:2800:220:1:248:1893:25c8:1946 is
represented as (IPv6 0x2606280002200001 0x248189325c81946).
RR TTL & Class
Cache time-to-live expressed in seconds
DNS CLASS code as per RFC 1035, section 3.2.4
The most commonly used value is classIN.
Message types
Raw DNS record type code
See also TypeSym
Symbolic DNS record type
Constructors
Instances
| Bounded TypeSym # | |
| Enum TypeSym # | |
| Eq TypeSym # | |
| Ord TypeSym # | |
| Read TypeSym # | |
| Show TypeSym # | |
Messages
Represents a DNS message as per RFC 1035
Constructors
| Msg | |
Instances
| Functor Msg # | |
| Foldable Msg # | |
Defined in Network.DNS.Message Methods fold :: Monoid m => Msg m -> m # foldMap :: Monoid m => (a -> m) -> Msg a -> m # foldr :: (a -> b -> b) -> b -> Msg a -> b # foldr' :: (a -> b -> b) -> b -> Msg a -> b # foldl :: (b -> a -> b) -> b -> Msg a -> b # foldl' :: (b -> a -> b) -> b -> Msg a -> b # foldr1 :: (a -> a -> a) -> Msg a -> a # foldl1 :: (a -> a -> a) -> Msg a -> a # elem :: Eq a => a -> Msg a -> Bool # maximum :: Ord a => Msg a -> a # | |
| Traversable Msg # | |
| Read l => Read (Msg l) # | |
| Show l => Show (Msg l) # | |
| Binary l => Binary (Msg l) # | |
DNS message header section as per RFC 1035, section 4.1.1
Constructors
| MsgHeader | |
data MsgHeaderFlags #
DNS message header flags as per RFC 1035, section 4.1.1
Constructors
| MsgHeaderFlags | |
Instances
| Read MsgHeaderFlags # | |
Defined in Network.DNS.Message Methods readsPrec :: Int -> ReadS MsgHeaderFlags # readList :: ReadS [MsgHeaderFlags] # | |
| Show MsgHeaderFlags # | |
Defined in Network.DNS.Message Methods showsPrec :: Int -> MsgHeaderFlags -> ShowS # show :: MsgHeaderFlags -> String # showList :: [MsgHeaderFlags] -> ShowS # | |
| Binary MsgHeaderFlags # | |
Defined in Network.DNS.Message Methods put :: MsgHeaderFlags -> Put # get :: Get MsgHeaderFlags # putList :: [MsgHeaderFlags] -> Put # | |
Encodes whether message is a query or a response
Since: 0.1.1.0
Constructors
| IsQuery | |
| IsResponse |
data MsgQuestion l #
DNS message header section as per RFC 1035, section 4.1.2
Constructors
| MsgQuestion !l !Type !Class |
Instances
DNS resource record section as per RFC 1035, section 4.1.3
Instances
| Functor MsgRR # | |
| Foldable MsgRR # | |
Defined in Network.DNS.Message Methods fold :: Monoid m => MsgRR m -> m # foldMap :: Monoid m => (a -> m) -> MsgRR a -> m # foldr :: (a -> b -> b) -> b -> MsgRR a -> b # foldr' :: (a -> b -> b) -> b -> MsgRR a -> b # foldl :: (b -> a -> b) -> b -> MsgRR a -> b # foldl' :: (b -> a -> b) -> b -> MsgRR a -> b # foldr1 :: (a -> a -> a) -> MsgRR a -> a # foldl1 :: (a -> a -> a) -> MsgRR a -> a # elem :: Eq a => a -> MsgRR a -> Bool # maximum :: Ord a => MsgRR a -> a # minimum :: Ord a => MsgRR a -> a # | |
| Traversable MsgRR # | |
| Eq l => Eq (MsgRR l) # | |
| Read l => Read (MsgRR l) # | |
| Show l => Show (MsgRR l) # | |
| Binary l => Binary (MsgRR l) # | |
Constructors
| RDataA !IPv4 | |
| RDataAAAA !IPv6 | |
| RDataCNAME !l | |
| RDataPTR !l | |
| RDataHINFO !CharStr !CharStr | |
| RDataNS !l | |
| RDataMX !Word16 !l | |
| RDataTXT ![CharStr] | |
| RDataSPF ![CharStr] | |
| RDataSOA !l !l !Word32 !Word32 !Word32 !Word32 !Word32 | |
| RDataSRV !(SRV l) | |
| RDataAFSDB !Word16 !l | |
| RDataNAPTR !Word16 !Word16 !CharStr !CharStr !CharStr !l | |
| RDataURI !Word16 !Word16 !ByteString | |
| RDataRRSIG !Word16 !Word8 !Word8 !Word32 !Word32 !Word32 !Word16 !l !ByteString | |
| RDataDNSKEY !Word16 !Word8 !Word8 !ByteString | |
| RDataDS !Word16 !Word8 !Word8 !ByteString | |
| RDataNSEC !l !(Set Type) | |
| RDataSSHFP !Word8 !Word8 !ByteString | |
| RDataNSEC3PARAM !Word8 !Word8 !Word16 !CharStr | |
| RDataNSEC3 !Word8 !Word8 !Word16 !CharStr !CharStr !(Set Type) | |
| RDataCAA !Word8 !CharStr !ByteString | |
| RDataOPT !ByteString | |
| RData !Type !ByteString | Unknown/undecoded resource record type |
Instances
| Functor RData # | |
| Foldable RData # | |
Defined in Network.DNS.Message Methods fold :: Monoid m => RData m -> m # foldMap :: Monoid m => (a -> m) -> RData a -> m # foldr :: (a -> b -> b) -> b -> RData a -> b # foldr' :: (a -> b -> b) -> b -> RData a -> b # foldl :: (b -> a -> b) -> b -> RData a -> b # foldl' :: (b -> a -> b) -> b -> RData a -> b # foldr1 :: (a -> a -> a) -> RData a -> a # foldl1 :: (a -> a -> a) -> RData a -> a # elem :: Eq a => a -> RData a -> Bool # maximum :: Ord a => RData a -> a # minimum :: Ord a => RData a -> a # | |
| Traversable RData # | |
| Eq l => Eq (RData l) # | |
| Read l => Read (RData l) # | |
| Show l => Show (RData l) # | |
SRV Record data as per RFC 2782
Constructors
| SRV | |
Instances
| Functor SRV # | |
| Foldable SRV # | |
Defined in Network.DNS.Message Methods fold :: Monoid m => SRV m -> m # foldMap :: Monoid m => (a -> m) -> SRV a -> m # foldr :: (a -> b -> b) -> b -> SRV a -> b # foldr' :: (a -> b -> b) -> b -> SRV a -> b # foldl :: (b -> a -> b) -> b -> SRV a -> b # foldl' :: (b -> a -> b) -> b -> SRV a -> b # foldr1 :: (a -> a -> a) -> SRV a -> a # foldl1 :: (a -> a -> a) -> SRV a -> a # elem :: Eq a => a -> SRV a -> Bool # maximum :: Ord a => SRV a -> a # | |
| Traversable SRV # | |
| Eq l => Eq (SRV l) # | |
| Read l => Read (SRV l) # | |
| Show l => Show (SRV l) # | |
| Binary l => Binary (SRV l) # | |