src/IPv4Address.hs

   1 module IPv4Address
   2 ( ipv4address_from_octets,
   3   ipv4address_tests,
   4   IPv4Address(None),
   5   max_octet1,
   6   max_octet2,
   7   max_octet3,
   8   max_octet4,
   9   min_octet1,
  10   min_octet2,
  11   min_octet3,
  12   min_octet4,
  13   most_sig_bit_different,
  14   octet1,
  15   octet2,
  16   octet3,
  17   octet4
  18 ) where
  19
  20 import Test.HUnit
  21 import Test.QuickCheck
  22
  23 import qualified Bit as B
  24 import Maskbits
  25 import Octet
  26
  27 data IPv4Address = None | IPv4Address { octet1 :: Octet,
  28                                         octet2 :: Octet,
  29                                         octet3 :: Octet,
  30                                         octet4 :: Octet }
  31                  deriving (Eq)
  32
  33
  34 instance Show IPv4Address where
  35     show IPv4Address.None = "None"
  36     show addr = concat [(show oct1) ++ ".",
  37                         (show oct2) ++ ".",
  38                         (show oct3) ++ ".",
  39                         (show oct4)]
  40         where
  41           oct1 = (octet1 addr)
  42           oct2 = (octet2 addr)
  43           oct3 = (octet3 addr)
  44           oct4 = (octet4 addr)
  45
  46
  47 instance Arbitrary IPv4Address where
  48     arbitrary = do
  49       oct1 <- arbitrary :: Gen Octet
  50       oct2 <- arbitrary :: Gen Octet
  51       oct3 <- arbitrary :: Gen Octet
  52       oct4 <- arbitrary :: Gen Octet
  53       return (IPv4Address oct1 oct2 oct3 oct4)
  54
  55     coarbitrary _ = variant 0
  56
  57
  58
  59 -- We don't export our constructor so this function is the only
  60 -- way to construct an address from octets. As a result, we can
  61 -- return IPv4Address.None in response to being passed one of more
  62 -- Octet.None octets.
  63 ipv4address_from_octets :: Octet -> Octet -> Octet -> Octet -> IPv4Address
  64 ipv4address_from_octets oct1 oct2 oct3 oct4
  65     | or [oct1 == Octet.None,
  66           oct2 == Octet.None,
  67           oct3 == Octet.None,
  68           oct4 == Octet.None] = IPv4Address.None
  69     | otherwise = IPv4Address oct1 oct2 oct3 oct4
  70
  71
  72 min_address :: IPv4Address -> Maskbits -> IPv4Address
  73 min_address IPv4Address.None _ = IPv4Address.None
  74 min_address _ Maskbits.None = IPv4Address.None
  75 min_address addr mask
  76     | mask == ThirtyTwo = IPv4Address oct1 oct2 oct3 oct4
  77     | mask == ThirtyOne = IPv4Address oct1 oct2 oct3 (Octet a25 a26 a27 a28 a29 a30 a31 B.Zero)
  78     | mask == Thirty = IPv4Address oct1 oct2 oct3 (Octet a25 a26 a27 a28 a29 a30 B.Zero B.Zero)
  79     | mask == TwentyNine = IPv4Address oct1 oct2 oct3 (Octet a25 a26 a27 a28 a29 B.Zero B.Zero B.Zero)
  80     | mask == TwentyEight = IPv4Address oct1 oct2 oct3 (Octet a25 a26 a27 a28 B.Zero B.Zero B.Zero B.Zero)
  81     | mask == TwentySeven = IPv4Address oct1 oct2 oct3 (Octet a25 a26 a27 B.Zero B.Zero B.Zero B.Zero B.Zero)
  82     | mask == TwentySix = IPv4Address oct1 oct2 oct3 (Octet a25 a26 B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero)
  83     | mask == TwentyFive = IPv4Address oct1 oct2 oct3 (Octet a25 B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero)
  84     | mask == TwentyFour = IPv4Address oct1 oct2 oct3 (min_octet)
  85     | mask == TwentyThree = IPv4Address oct1 oct2 (Octet a17 a18 a19 a20 a21 a22 a23 B.Zero) (min_octet)
  86     | mask == TwentyTwo = IPv4Address oct1 oct2 (Octet a17 a18 a19 a20 a21 a22 B.Zero B.Zero) (min_octet)
  87     | mask == TwentyOne = IPv4Address oct1 oct2 (Octet a17 a18 a19 a20 a21 B.Zero B.Zero B.Zero) (min_octet)
  88     | mask == Twenty = IPv4Address oct1 oct2 (Octet a17 a18 a19 a20 B.Zero B.Zero B.Zero B.Zero) (min_octet)
  89     | mask == Nineteen = IPv4Address oct1 oct2 (Octet a17 a18 a19 B.Zero B.Zero B.Zero B.Zero B.Zero) (min_octet)
  90     | mask == Eighteen = IPv4Address oct1 oct2 (Octet a17 a18 B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero) (min_octet)
  91     | mask == Seventeen = IPv4Address oct1 oct2 (Octet a17 B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero) (min_octet)
  92     | mask == Sixteen = IPv4Address oct1 oct2 (min_octet) (min_octet)
  93     | mask == Fifteen = IPv4Address oct1 (Octet a9 a10 a11 a12 a13 a14 a15 B.Zero) (min_octet) (min_octet)
  94     | mask == Fourteen = IPv4Address oct1 (Octet a9 a10 a11 a12 a13 a14 B.Zero B.Zero) (min_octet) (min_octet)
  95     | mask == Thirteen = IPv4Address oct1 (Octet a9 a10 a11 a12 a13 B.Zero B.Zero B.Zero) (min_octet) (min_octet)
  96     | mask == Twelve = IPv4Address oct1 (Octet a9 a10 a11 a12 B.Zero B.Zero B.Zero B.Zero) (min_octet) (min_octet)
  97     | mask == Eleven = IPv4Address oct1 (Octet a9 a10 a11 B.Zero B.Zero B.Zero B.Zero B.Zero) (min_octet) (min_octet)
  98     | mask == Ten = IPv4Address oct1 (Octet a9 a10 B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero) (min_octet) (min_octet)
  99     | mask == Nine = IPv4Address oct1 (Octet a9 B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero) (min_octet) (min_octet)
 100     | mask == Eight = IPv4Address oct1 (min_octet) (min_octet) (min_octet)
 101     | mask == Seven = IPv4Address (Octet a1 a2 a3 a4 a5 a6 a7 B.Zero) (min_octet) (min_octet) (min_octet)
 102     | mask == Six = IPv4Address (Octet a1 a2 a3 a4 a5 a6 B.Zero B.Zero) (min_octet) (min_octet) (min_octet)
 103     | mask == Five = IPv4Address (Octet a1 a2 a3 a4 a5 B.Zero B.Zero B.Zero) (min_octet) (min_octet) (min_octet)
 104     | mask == Four = IPv4Address (Octet a1 a2 a3 a4 B.Zero B.Zero B.Zero B.Zero) (min_octet) (min_octet) (min_octet)
 105     | mask == Three = IPv4Address (Octet a1 a2 a3 B.Zero B.Zero B.Zero B.Zero B.Zero) (min_octet) (min_octet) (min_octet)
 106     | mask == Two = IPv4Address (Octet a1 a2 B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero) (min_octet) (min_octet) (min_octet)
 107     | mask == One = IPv4Address (Octet a1 B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero) (min_octet) (min_octet) (min_octet)
 108     | mask == Zero = IPv4Address (min_octet) (min_octet) (min_octet) (min_octet)
 109     | otherwise = addr
 110     where
 111       a1  = (b1 oct1)
 112       a2  = (b2 oct1)
 113       a3  = (b3 oct1)
 114       a4  = (b4 oct1)
 115       a5  = (b5 oct1)
 116       a6  = (b6 oct1)
 117       a7  = (b7 oct1)
 118       a9  = (b1 oct2)
 119       a10 = (b2 oct2)
 120       a11 = (b3 oct2)
 121       a12 = (b4 oct2)
 122       a13 = (b5 oct2)
 123       a14 = (b6 oct2)
 124       a15 = (b7 oct2)
 125       a17 = (b1 oct3)
 126       a18 = (b2 oct3)
 127       a19 = (b3 oct3)
 128       a20 = (b4 oct3)
 129       a21 = (b5 oct3)
 130       a22 = (b6 oct3)
 131       a23 = (b7 oct3)
 132       a25 = (b1 oct4)
 133       a26 = (b2 oct4)
 134       a27 = (b3 oct4)
 135       a28 = (b4 oct4)
 136       a29 = (b5 oct4)
 137       a30 = (b6 oct4)
 138       a31 = (b7 oct4)
 139       oct1 = (octet1 addr)
 140       oct2 = (octet2 addr)
 141       oct3 = (octet3 addr)
 142       oct4 = (octet4 addr)
 143
 144
 145
 146 max_address :: IPv4Address -> Maskbits -> IPv4Address
 147 max_address IPv4Address.None _ = IPv4Address.None
 148 max_address _ Maskbits.None = IPv4Address.None
 149 max_address addr mask
 150     | mask == ThirtyTwo = IPv4Address oct1 oct2 oct3 oct4
 151     | mask == ThirtyOne = IPv4Address oct1 oct2 oct3 (Octet a25 a26 a27 a28 a29 a30 a31 B.One)
 152     | mask == Thirty = IPv4Address oct1 oct2 oct3 (Octet a25 a26 a27 a28 a29 a30 B.One B.One)
 153     | mask == TwentyNine = IPv4Address oct1 oct2 oct3 (Octet a25 a26 a27 a28 a29 B.One B.One B.One)
 154     | mask == TwentyEight = IPv4Address oct1 oct2 oct3 (Octet a25 a26 a27 a28 B.One B.One B.One B.One)
 155     | mask == TwentySeven = IPv4Address oct1 oct2 oct3 (Octet a25 a26 a27 B.One B.One B.One B.One B.One)
 156     | mask == TwentySix = IPv4Address oct1 oct2 oct3 (Octet a25 a26 B.One B.One B.One B.One B.One B.One)
 157     | mask == TwentyFive = IPv4Address oct1 oct2 oct3 (Octet a25 B.One B.One B.One B.One B.One B.One B.One)
 158     | mask == TwentyFour = IPv4Address oct1 oct2 oct3 (max_octet)
 159     | mask == TwentyThree = IPv4Address oct1 oct2 (Octet a17 a18 a19 a20 a21 a22 a23 B.One) (max_octet)
 160     | mask == TwentyTwo = IPv4Address oct1 oct2 (Octet a17 a18 a19 a20 a21 a22 B.One B.One) (max_octet)
 161     | mask == TwentyOne = IPv4Address oct1 oct2 (Octet a17 a18 a19 a20 a21 B.One B.One B.One) (max_octet)
 162     | mask == Twenty = IPv4Address oct1 oct2 (Octet a17 a18 a19 a20 B.One B.One B.One B.One) (max_octet)
 163     | mask == Nineteen = IPv4Address oct1 oct2 (Octet a17 a18 a19 B.One B.One B.One B.One B.One) (max_octet)
 164     | mask == Eighteen = IPv4Address oct1 oct2 (Octet a17 a18 B.One B.One B.One B.One B.One B.One) (max_octet)
 165     | mask == Seventeen = IPv4Address oct1 oct2 (Octet a17 B.One B.One B.One B.One B.One B.One B.One) (max_octet)
 166     | mask == Sixteen = IPv4Address oct1 oct2 (max_octet) (max_octet)
 167     | mask == Fifteen = IPv4Address oct1 (Octet a9 a10 a11 a12 a13 a14 a15 B.One) (max_octet) (max_octet)
 168     | mask == Fourteen = IPv4Address oct1 (Octet a9 a10 a11 a12 a13 a14 B.One B.One) (max_octet) (max_octet)
 169     | mask == Thirteen = IPv4Address oct1 (Octet a9 a10 a11 a12 a13 B.One B.One B.One) (max_octet) (max_octet)
 170     | mask == Twelve = IPv4Address oct1 (Octet a9 a10 a11 a12 B.One B.One B.One B.One) (max_octet) (max_octet)
 171     | mask == Eleven = IPv4Address oct1 (Octet a9 a10 a11 B.One B.One B.One B.One B.One) (max_octet) (max_octet)
 172     | mask == Ten = IPv4Address oct1 (Octet a9 a10 B.One B.One B.One B.One B.One B.One) (max_octet) (max_octet)
 173     | mask == Nine = IPv4Address oct1 (Octet a9 B.One B.One B.One B.One B.One B.One B.One) (max_octet) (max_octet)
 174     | mask == Eight = IPv4Address oct1 (max_octet) (max_octet) (max_octet)
 175     | mask == Seven = IPv4Address (Octet a1 a2 a3 a4 a5 a6 a7 B.One) (max_octet) (max_octet) (max_octet)
 176     | mask == Six = IPv4Address (Octet a1 a2 a3 a4 a5 a6 B.One B.One) (max_octet) (max_octet) (max_octet)
 177     | mask == Five = IPv4Address (Octet a1 a2 a3 a4 a5 B.One B.One B.One) (max_octet) (max_octet) (max_octet)
 178     | mask == Four = IPv4Address (Octet a1 a2 a3 a4 B.One B.One B.One B.One) (max_octet) (max_octet) (max_octet)
 179     | mask == Three = IPv4Address (Octet a1 a2 a3 B.One B.One B.One B.One B.One) (max_octet) (max_octet) (max_octet)
 180     | mask == Two = IPv4Address (Octet a1 a2 B.One B.One B.One B.One B.One B.One) (max_octet) (max_octet) (max_octet)
 181     | mask == One = IPv4Address (Octet a1 B.One B.One B.One B.One B.One B.One B.One) (max_octet) (max_octet) (max_octet)
 182     | mask == Zero = IPv4Address (max_octet) (max_octet) (max_octet) (max_octet)
 183     | otherwise = addr
 184     where
 185       a1  = (b1 oct1)
 186       a2  = (b2 oct1)
 187       a3  = (b3 oct1)
 188       a4  = (b4 oct1)
 189       a5  = (b5 oct1)
 190       a6  = (b6 oct1)
 191       a7  = (b7 oct1)
 192       a9  = (b1 oct2)
 193       a10 = (b2 oct2)
 194       a11 = (b3 oct2)
 195       a12 = (b4 oct2)
 196       a13 = (b5 oct2)
 197       a14 = (b6 oct2)
 198       a15 = (b7 oct2)
 199       a17 = (b1 oct3)
 200       a18 = (b2 oct3)
 201       a19 = (b3 oct3)
 202       a20 = (b4 oct3)
 203       a21 = (b5 oct3)
 204       a22 = (b6 oct3)
 205       a23 = (b7 oct3)
 206       a25 = (b1 oct4)
 207       a26 = (b2 oct4)
 208       a27 = (b3 oct4)
 209       a28 = (b4 oct4)
 210       a29 = (b5 oct4)
 211       a30 = (b6 oct4)
 212       a31 = (b7 oct4)
 213       oct1 = (octet1 addr)
 214       oct2 = (octet2 addr)
 215       oct3 = (octet3 addr)
 216       oct4 = (octet4 addr)
 217
 218
 219
 220 min_octet1 :: IPv4Address -> Maskbits -> Octet
 221 min_octet1 addr mask = octet1 (min_address addr mask)
 222
 223 min_octet2 :: IPv4Address -> Maskbits -> Octet
 224 min_octet2 addr mask = octet2 (min_address addr mask)
 225
 226 min_octet3 :: IPv4Address -> Maskbits -> Octet
 227 min_octet3 addr mask = octet3 (min_address addr mask)
 228
 229 min_octet4 :: IPv4Address -> Maskbits -> Octet
 230 min_octet4 addr mask = octet4 (min_address addr mask)
 231
 232 max_octet1 :: IPv4Address -> Maskbits -> Octet
 233 max_octet1 addr mask = octet1 (max_address addr mask)
 234
 235 max_octet2 :: IPv4Address -> Maskbits -> Octet
 236 max_octet2 addr mask = octet2 (max_address addr mask)
 237
 238 max_octet3 :: IPv4Address -> Maskbits -> Octet
 239 max_octet3 addr mask = octet3 (max_address addr mask)
 240
 241 max_octet4 :: IPv4Address -> Maskbits -> Octet
 242 max_octet4 addr mask = octet4 (max_address addr mask)
 243
 244
 245 -- Given two addresses, find the number of the most significant bit
 246 -- where they differ. If the addresses are the same, return
 247 -- Maskbits.Zero.
 248 most_sig_bit_different :: IPv4Address -> IPv4Address -> Maskbits
 249 most_sig_bit_different addr1 addr2
 250   | addr1 == addr2 = Maskbits.Zero
 251   | m1  /= n1  = Maskbits.One
 252   | m2  /= n2  = Two
 253   | m3  /= n3  = Three
 254   | m4  /= n4  = Four
 255   | m5  /= n5  = Five
 256   | m6  /= n6  = Six
 257   | m7  /= n7  = Seven
 258   | m8  /= n8  = Eight
 259   | m9  /= n9  = Nine
 260   | m10 /= n10 = Ten
 261   | m11 /= n11 = Eleven
 262   | m12 /= n12 = Twelve
 263   | m13 /= n13 = Thirteen
 264   | m14 /= n14 = Fourteen
 265   | m15 /= n15 = Fifteen
 266   | m16 /= n16 = Sixteen
 267   | m17 /= n17 = Seventeen
 268   | m18 /= n18 = Eighteen
 269   | m19 /= n19 = Nineteen
 270   | m20 /= n20 = Twenty
 271   | m21 /= n21 = TwentyOne
 272   | m22 /= n22 = TwentyTwo
 273   | m23 /= n23 = TwentyThree
 274   | m24 /= n24 = TwentyFour
 275   | m25 /= n25 = TwentyFive
 276   | m26 /= n26 = TwentySix
 277   | m27 /= n27 = TwentySeven
 278   | m28 /= n28 = TwentyEight
 279   | m29 /= n29 = TwentyNine
 280   | m30 /= n30 = Thirty
 281   | m31 /= n31 = ThirtyOne
 282   | m32 /= n32 = ThirtyTwo
 283   | otherwise  = Maskbits.Zero
 284   where
 285     m1  = (b1 oct1a)
 286     m2  = (b2 oct1a)
 287     m3  = (b3 oct1a)
 288     m4  = (b4 oct1a)
 289     m5  = (b5 oct1a)
 290     m6  = (b6 oct1a)
 291     m7  = (b7 oct1a)
 292     m8  = (b8 oct1a)
 293     m9  = (b1 oct2a)
 294     m10 = (b2 oct2a)
 295     m11 = (b3 oct2a)
 296     m12 = (b4 oct2a)
 297     m13 = (b5 oct2a)
 298     m14 = (b6 oct2a)
 299     m15 = (b7 oct2a)
 300     m16 = (b8 oct2a)
 301     m17 = (b1 oct3a)
 302     m18 = (b2 oct3a)
 303     m19 = (b3 oct3a)
 304     m20 = (b4 oct3a)
 305     m21 = (b5 oct3a)
 306     m22 = (b6 oct3a)
 307     m23 = (b7 oct3a)
 308     m24 = (b8 oct3a)
 309     m25 = (b1 oct4a)
 310     m26 = (b2 oct4a)
 311     m27 = (b3 oct4a)
 312     m28 = (b4 oct4a)
 313     m29 = (b5 oct4a)
 314     m30 = (b6 oct4a)
 315     m31 = (b7 oct4a)
 316     m32 = (b8 oct4a)
 317     oct1a = (octet1 addr1)
 318     oct2a = (octet2 addr1)
 319     oct3a = (octet3 addr1)
 320     oct4a = (octet4 addr1)
 321     n1  = (b1 oct1b)
 322     n2  = (b2 oct1b)
 323     n3  = (b3 oct1b)
 324     n4  = (b4 oct1b)
 325     n5  = (b5 oct1b)
 326     n6  = (b6 oct1b)
 327     n7  = (b7 oct1b)
 328     n8  = (b8 oct1b)
 329     n9  = (b1 oct2b)
 330     n10 = (b2 oct2b)
 331     n11 = (b3 oct2b)
 332     n12 = (b4 oct2b)
 333     n13 = (b5 oct2b)
 334     n14 = (b6 oct2b)
 335     n15 = (b7 oct2b)
 336     n16 = (b8 oct2b)
 337     n17 = (b1 oct3b)
 338     n18 = (b2 oct3b)
 339     n19 = (b3 oct3b)
 340     n20 = (b4 oct3b)
 341     n21 = (b5 oct3b)
 342     n22 = (b6 oct3b)
 343     n23 = (b7 oct3b)
 344     n24 = (b8 oct3b)
 345     n25 = (b1 oct4b)
 346     n26 = (b2 oct4b)
 347     n27 = (b3 oct4b)
 348     n28 = (b4 oct4b)
 349     n29 = (b5 oct4b)
 350     n30 = (b6 oct4b)
 351     n31 = (b7 oct4b)
 352     n32 = (b8 oct4b)
 353     oct1b = (octet1 addr2)
 354     oct2b = (octet2 addr2)
 355     oct3b = (octet3 addr2)
 356     oct4b = (octet4 addr2)
 357
 358
 359
 360 -- HUnit Tests
 361 mk_testaddr :: Int -> Int -> Int -> Int -> IPv4Address
 362 mk_testaddr a b c d =
 363     IPv4Address oct1 oct2 oct3 oct4
 364     where
 365       oct1 = octet_from_int a
 366       oct2 = octet_from_int b
 367       oct3 = octet_from_int c
 368       oct4 = octet_from_int d
 369
 370
 371 test_most_sig_bit_different1 :: Test
 372 test_most_sig_bit_different1 =
 373     TestCase $ assertEqual "10.1.1.0 and 10.1.0.0 differ in bit 24" TwentyFour (most_sig_bit_different (mk_testaddr 10 1 1 0) (mk_testaddr 10 1 0 0))
 374
 375
 376 test_most_sig_bit_different2 :: Test
 377 test_most_sig_bit_different2 =
 378     TestCase $ assertEqual "10.1.2.0 and 10.1.1.0 differ in bit 23" TwentyThree (most_sig_bit_different (mk_testaddr 10 1 2 0) (mk_testaddr 10 1 1 0))
 379
 380
 381 ipv4address_tests :: [Test]
 382 ipv4address_tests = [ test_most_sig_bit_different1,
 383                       test_most_sig_bit_different2 ]