publish binary 0.9.0.1
[pdns-pipe-nmc.git] / NmcDom.hs
1 {-# LANGUAGE OverloadedStrings #-}
2
3 module NmcDom   ( NmcDom(..)
4                 , NmcRRSrv(..)
5                 , NmcRRI2p(..)
6                 , NmcRRTlsa(..)
7                 , NmcRRDs(..)
8                 , merge
9                 ) where
10
11 import Prelude hiding (length)
12 import Control.Applicative ((<$>), (<*>), liftA2, empty, pure)
13 import Data.Char
14 import Data.Text (Text, unpack)
15 import Data.List (union)
16 import Data.List.Split
17 import Data.Vector ((!), length)
18 import qualified Data.Vector as V (singleton)
19 import Data.Map (Map, unionWith, foldrWithKey)
20 import qualified Data.Map as M (singleton, empty, insert, insertWith)
21 import qualified Data.HashMap.Strict as H (lookup, foldrWithKey)
22 import Data.Aeson
23 import Data.Aeson.Types
24 import Data.Default.Class
25
26 -- Variant of Aeson's `.:?` that interprets a String as a
27 -- single-element list, so it is possible to have either
28 --      "ip":["1.2.3.4"]
29 -- or
30 --      "ip":"1.2.3.4"
31 -- with the same result.
32 (.:/) :: (FromJSON a) => Object -> Text -> Parser (Maybe a)
33 obj .:/ key = case H.lookup key obj of
34                Nothing -> pure Nothing
35                Just v  -> case v of
36                         String s -> parseJSON $ Array (V.singleton v)
37                         _        -> parseJSON v
38
39 data IntRRService = IntRRService { isvName       :: String
40                                  , isvProto      :: String
41                                  , isvPrio       :: Int
42                                  , isvWeight     :: Int
43                                  , isvPort       :: Int
44                                  , isvHost       :: String
45                                  } deriving (Show, Eq)
46
47 instance FromJSON IntRRService where
48         parseJSON (Array a) =
49                 if length a == 6 then IntRRService
50                         <$> parseJSON (a ! 0)
51                         <*> parseJSON (a ! 1)
52                         <*> parseJSON (a ! 2)
53                         <*> parseJSON (a ! 3)
54                         <*> parseJSON (a ! 4)
55                         <*> parseJSON (a ! 5)
56                 else empty
57         parseJSON _ = empty
58
59 makeMx :: Object -> Parser (Maybe [String])
60 makeMx o =
61   case H.lookup "service" o of
62     Nothing          -> pure Nothing
63     Just (Array a) -> do
64       isvl <- parseJSON (Array a)
65       return $ Just $ map mxStr $ filter mxMatch isvl
66         where
67           mxMatch isv = isvName isv  == "smtp"
68                      && isvProto isv == "tcp"
69                      && isvPort isv  == 25
70           mxStr isv = (show (isvPrio isv)) ++ "\t" ++ (isvHost isv)
71     Just _ -> empty
72
73 makeSubmap :: Object -> Parser (Maybe (Map String NmcDom))
74 makeSubmap o = takeTls o `fmerge` takeSrv o `fmerge` takeMap o
75   where fmerge = liftA2 merge
76
77 takeMap :: Object -> Parser (Maybe (Map String NmcDom))
78 takeMap o =
79   case H.lookup "map" o of
80     Nothing          -> pure Nothing
81     Just (Object mo) -> H.foldrWithKey addmapentry (pure (Just M.empty)) mo
82       where
83         addmapentry "" v acc = parseJSON v >>= inject acc ""
84         addmapentry k  v acc = nest (splitOn "." (unpack k)) v acc
85         nest []     v acc = empty -- does not happen as a result of splitOn
86         nest [""]   v acc = empty -- empty element of fqdn forbidden
87         nest [d]    v acc = parseJSON v >>= inject acc d
88         nest (d:ds) v acc =
89           nest ds v acc >>= (inject acc d) . (\r -> def { domSubmap = r })
90         inject acc d r = (fmap.fmap) (M.insertWith merge d r) acc
91     _ -> empty
92
93 takeSrv :: Object -> Parser (Maybe (Map String NmcDom))
94 takeSrv o =
95   case H.lookup "service" o of
96     Nothing          -> pure Nothing
97     Just (Array a) -> do
98       isvl <- parseJSON (Array a)
99       return $ foldr addSrv (Just M.empty) isvl
100         where
101           addSrv isv acc = subm `merge` acc
102             where
103               subm = Just (M.singleton ("_" ++ isvProto isv) sub2)
104               sub2 = def { domSubmap =
105                              Just (M.singleton ("_" ++ isvName isv) sub3) }
106               sub3 = def { domSrv = Just [ NmcRRSrv (isvPrio isv)
107                                                     (isvWeight isv)
108                                                     (isvPort isv)
109                                                     (isvHost isv) ] }
110     Just _ -> empty
111
112 -- takeTls is almost, but not quite, entirely unlike takeSrv
113 takeTls :: Object -> Parser (Maybe (Map String NmcDom))
114 takeTls o =
115   case H.lookup "tls" o of
116     Nothing         -> pure Nothing
117     Just (Object t) ->
118       (parseJSON (Object t) :: Parser (Map String (Map String [NmcRRTlsa])))
119         >>= tmap2dmap
120           where
121             tmap2dmap :: Map String (Map String [NmcRRTlsa])
122                       -> Parser (Maybe (Map String NmcDom))
123             tmap2dmap m1 = return $ foldrWithKey addprotoelem (Just M.empty) m1
124             addprotoelem k1 m2 acc = protoelem k1 m2 `merge` acc
125             protoelem k1 m2 = Just (M.singleton ("_" ++ k1) (pmap2dmap m2))
126             pmap2dmap m2 = foldrWithKey addportelem def m2
127             addportelem k2 v acc = portelem k2 v `merge` acc
128             portelem k2 v =
129               def { domSubmap = Just (M.singleton ("_" ++ k2)
130                                       def { domTlsa = Just v }) }
131     Just _ -> empty
132
133 class Mergeable a where
134         merge :: a -> a -> a -- bias towads second arg
135
136 instance (Ord k, Mergeable a) => Mergeable (Map k a) where
137         merge mx my = unionWith merge my mx
138
139 -- Alas, the following is not possible in Haskell :-(
140 -- instance Mergeable String where
141 --         merge _ b = b
142
143 instance Mergeable Value where
144         merge _ b = b
145
146 instance Mergeable a => Mergeable (Maybe a) where
147         merge (Just x) (Just y) = Just (merge x y)
148         merge Nothing  (Just y) = Just y
149         merge (Just x) Nothing  = Just x
150         merge Nothing  Nothing  = Nothing
151
152 instance Eq a => Mergeable [a] where
153         merge xs ys = union xs ys
154
155 data NmcRRSrv = NmcRRSrv
156                         { srvPrio       :: Int
157                         , srvWeight     :: Int
158                         , srvPort       :: Int
159                         , srvHost       :: String
160                         } deriving (Show, Eq)
161
162 instance Mergeable NmcRRSrv where
163         merge _ b = b
164
165 data NmcRRI2p = NmcRRI2p
166                         { i2pDestination :: Maybe String
167                         , i2pName        :: Maybe String
168                         , i2pB32         :: Maybe String
169                         } deriving (Show, Eq)
170
171 instance FromJSON NmcRRI2p where
172         parseJSON (Object o) = NmcRRI2p
173                 <$> o .:? "destination"
174                 <*> o .:? "name"
175                 <*> o .:? "b32"
176         parseJSON _ = empty
177
178 instance Mergeable NmcRRI2p where
179         merge _ b = b
180
181 data NmcRRTlsa = NmcRRTlsa
182                         { tlsMatchType  :: Int -- 0:exact 1:sha256 2:sha512
183                         , tlsMatchValue :: String
184                         , tlsIncSubdoms :: Bool -- enforce on subdoms?
185                         } deriving (Show, Eq)
186
187 instance FromJSON NmcRRTlsa where
188         parseJSON (Array a) =
189                 if length a == 3 then NmcRRTlsa
190                         <$> parseJSON (a ! 0)
191                         <*> parseJSON (a ! 1)
192                         <*> case (a ! 2) of
193                               Number 0 -> return False
194                               Number 1 -> return True
195                               _        -> empty
196                 else empty
197         parseJSON _ = empty
198
199 instance Mergeable NmcRRTlsa where
200         merge _ b = b
201
202 data NmcRRDs = NmcRRDs
203                         { dsKeyTag      :: Int
204                         , dsAlgo        :: Int
205                         , dsHashType    :: Int
206                         , dsHashValue   :: String
207                         } deriving (Show, Eq)
208
209 instance FromJSON NmcRRDs where
210         parseJSON (Array a) =
211                 if length a == 4 then NmcRRDs
212                         <$> parseJSON (a ! 0)
213                         <*> parseJSON (a ! 1)
214                         <*> parseJSON (a ! 2)
215                         <*> parseJSON (a ! 3)
216                 else empty
217         parseJSON _ = empty
218
219 instance Mergeable NmcRRDs where
220         merge _ b = b
221
222 data NmcDom = NmcDom    { domIp          :: Maybe [String]
223                         , domIp6         :: Maybe [String]
224                         , domTor         :: Maybe String
225                         , domI2p         :: Maybe NmcRRI2p
226                         , domFreenet     :: Maybe String
227                         , domAlias       :: Maybe String
228                         , domTranslate   :: Maybe String
229                         , domEmail       :: Maybe String
230                         , domLoc         :: Maybe String
231                         , domInfo        :: Maybe Value
232                         , domNs          :: Maybe [String]
233                         , domDelegate    :: Maybe String
234                         , domImport      :: Maybe [String]
235                         , domSubmap      :: Maybe (Map String NmcDom)
236                         , domFingerprint :: Maybe [String]
237                         , domDs          :: Maybe [NmcRRDs]
238                         , domMx          :: Maybe [String]    -- Synthetic
239                         , domSrv         :: Maybe [NmcRRSrv]  -- Synthetic
240                         , domTlsa        :: Maybe [NmcRRTlsa] -- Synthetic
241                         } deriving (Show, Eq)
242
243 instance Default NmcDom where
244   def = NmcDom Nothing Nothing Nothing Nothing Nothing Nothing Nothing
245                Nothing Nothing Nothing Nothing Nothing Nothing Nothing
246                Nothing Nothing Nothing Nothing Nothing
247
248 instance FromJSON NmcDom where
249         -- Wherever we expect a domain object, there may be a string
250         -- containing IPv4 address. Interpret it as such.
251         -- Question: shall we try to recognize IPv6 addresses too?
252         parseJSON (String s) =
253                  return $ if isIPv4 s'
254                             then def { domIp = Just [s'] }
255                             else def
256                           where
257                             s' = unpack s
258                             isIPv4 x = all isNibble $ splitOn "." x
259                             isNibble x =
260                               if all isDigit x then (read x :: Int) < 256
261                               else False
262         parseJSON (Object o) = NmcDom
263                 <$> o .:/ "ip"
264                 <*> o .:/ "ip6"
265                 <*> o .:? "tor"
266                 <*> o .:? "i2p"
267                 <*> o .:? "freenet"
268                 <*> o .:? "alias"
269                 <*> o .:? "translate"
270                 <*> o .:? "email"
271                 <*> o .:? "loc"
272                 <*> o .:? "info"
273                 <*> o .:/ "ns"
274                 <*> o .:? "delegate"
275                 <*> o .:/ "import"
276                 <*> makeSubmap o
277                 <*> o .:/ "fingerprint"
278                 <*> o .:? "ds"
279                 <*> makeMx o
280                 <*> return Nothing -- domSrv created in subdomains
281                 <*> return Nothing -- domTlsa created in subdomains
282         parseJSON _ = empty
283
284 instance Mergeable NmcDom where
285         merge sub dom = dom     { domIp =          mergelm domIp
286                                 , domIp6 =         mergelm domIp6
287                                 , domTor =         choose  domTor
288                                 , domI2p =         mergelm domI2p
289                                 , domFreenet =     choose  domFreenet
290                                 , domAlias =       choose  domAlias
291                                 , domTranslate =   choose  domTranslate
292                                 , domEmail =       choose  domEmail
293                                 , domLoc =         choose  domLoc
294                                 , domInfo =        mergelm domInfo
295                                 , domNs =          mergelm domNs
296                                 , domDelegate =    mergelm domDelegate
297                                 , domImport =      mergelm domImport
298                                 , domSubmap =      mergelm domSubmap
299                                 , domFingerprint = mergelm domFingerprint
300                                 , domDs =          mergelm domDs
301                                 , domMx =          mergelm domMx
302                                 , domSrv =         mergelm domSrv
303                                 , domTlsa =        mergelm domTlsa
304                                 }
305           where
306                 mergelm x = merge (x sub) (x dom)
307 -- Because it is not possible to define instance of merge for Strings,
308 -- we have to treat string elements separately, otherwise strings are
309 -- 'unioned' along with the rest of lists. Ugly, but alternatives are worse.
310                 choose field = case field dom of
311                         Nothing -> field sub
312                         Just x  -> Just x