src/IPv4Address.hs

   1 module IPv4Address
   2 ( ipv4address_from_octets,
   3   ipv4address_tests,
   4   IPv4Address(None),
   5   max_address,
   6   min_address,
   7   most_sig_bit_different,
   8   octet1,
   9   octet2,
  10   octet3,
  11   octet4
  12 ) where
  13
  14 import Test.HUnit
  15 import Test.QuickCheck
  16
  17 import Maskable
  18 import Maskbits
  19 import Octet
  20
  21 data IPv4Address = None | IPv4Address { octet1 :: Octet,
  22                                         octet2 :: Octet,
  23                                         octet3 :: Octet,
  24                                         octet4 :: Octet }
  25                  deriving (Eq)
  26
  27
  28 instance Show IPv4Address where
  29     show IPv4Address.None = "None"
  30     show addr = concat [(show oct1) ++ ".",
  31                         (show oct2) ++ ".",
  32                         (show oct3) ++ ".",
  33                         (show oct4)]
  34         where
  35           oct1 = (octet1 addr)
  36           oct2 = (octet2 addr)
  37           oct3 = (octet3 addr)
  38           oct4 = (octet4 addr)
  39
  40
  41 instance Arbitrary IPv4Address where
  42     arbitrary = do
  43       oct1 <- arbitrary :: Gen Octet
  44       oct2 <- arbitrary :: Gen Octet
  45       oct3 <- arbitrary :: Gen Octet
  46       oct4 <- arbitrary :: Gen Octet
  47       return (IPv4Address oct1 oct2 oct3 oct4)
  48
  49     coarbitrary _ = variant 0
  50
  51
  52
  53 instance Maskable IPv4Address where
  54     apply_mask _ Maskbits.None = IPv4Address.None
  55     apply_mask addr mask
  56         | mask == ThirtyTwo = ipv4address_from_octets oct1 oct2 oct3 oct4
  57         | mask == ThirtyOne = ipv4address_from_octets oct1 oct2 oct3 (apply_mask oct4 Seven)
  58         | mask == Thirty = ipv4address_from_octets oct1 oct2 oct3 (apply_mask oct4 Six)
  59         | mask == TwentyNine = ipv4address_from_octets oct1 oct2 oct3 (apply_mask oct4 Five)
  60         | mask == TwentyEight = ipv4address_from_octets oct1 oct2 oct3 (apply_mask oct4 Four)
  61         | mask == TwentySeven = ipv4address_from_octets oct1 oct2 oct3 (apply_mask oct4 Three)
  62         | mask == TwentySix = ipv4address_from_octets oct1 oct2 oct3 (apply_mask oct4 Two)
  63         | mask == TwentyFive = ipv4address_from_octets oct1 oct2 oct3 (apply_mask oct4 One)
  64         | mask == TwentyFour = ipv4address_from_octets oct1 oct2 oct3 (min_octet)
  65         | mask == TwentyThree = ipv4address_from_octets oct1 oct2 (apply_mask oct3 Seven) (min_octet)
  66         | mask == TwentyTwo = ipv4address_from_octets oct1 oct2 (apply_mask oct3 Six) (min_octet)
  67         | mask == TwentyOne = ipv4address_from_octets oct1 oct2 (apply_mask oct3 Five) (min_octet)
  68         | mask == Twenty = ipv4address_from_octets oct1 oct2 (apply_mask oct3 Four) (min_octet)
  69         | mask == Nineteen = ipv4address_from_octets oct1 oct2 (apply_mask oct3 Three) (min_octet)
  70         | mask == Eighteen = ipv4address_from_octets oct1 oct2 (apply_mask oct3 Two) (min_octet)
  71         | mask == Seventeen = ipv4address_from_octets oct1 oct2 (apply_mask oct3 One) (min_octet)
  72         | mask == Sixteen = ipv4address_from_octets oct1 oct2 (min_octet) (min_octet)
  73         | mask == Fifteen = ipv4address_from_octets oct1 (apply_mask oct2 Seven) (min_octet) (min_octet)
  74         | mask == Fourteen = ipv4address_from_octets oct1 (apply_mask oct2 Six) (min_octet) (min_octet)
  75         | mask == Thirteen = ipv4address_from_octets oct1 (apply_mask oct2 Five) (min_octet) (min_octet)
  76         | mask == Twelve = ipv4address_from_octets oct1 (apply_mask oct2 Four) (min_octet) (min_octet)
  77         | mask == Eleven = ipv4address_from_octets oct1 (apply_mask oct2 Three) (min_octet) (min_octet)
  78         | mask == Ten = ipv4address_from_octets oct1 (apply_mask oct2 Two) (min_octet) (min_octet)
  79         | mask == Nine = ipv4address_from_octets oct1 (apply_mask oct2 One) (min_octet) (min_octet)
  80         | mask == Eight = ipv4address_from_octets oct1 (min_octet) (min_octet) (min_octet)
  81         | mask == Seven = ipv4address_from_octets (apply_mask oct1 Seven) (min_octet) (min_octet) (min_octet)
  82         | mask == Six = ipv4address_from_octets (apply_mask oct1 Six) (min_octet) (min_octet) (min_octet)
  83         | mask == Five = ipv4address_from_octets (apply_mask oct1 Five) (min_octet) (min_octet) (min_octet)
  84         | mask == Four =  ipv4address_from_octets (apply_mask oct1 Four) (min_octet) (min_octet) (min_octet)
  85         | mask == Three = ipv4address_from_octets (apply_mask oct1 Three) (min_octet) (min_octet) (min_octet)
  86         | mask == Two = ipv4address_from_octets (apply_mask oct1 Two) (min_octet) (min_octet) (min_octet)
  87         | mask == One = ipv4address_from_octets (apply_mask oct1 One) (min_octet) (min_octet) (min_octet)
  88         | mask == Zero = ipv4address_from_octets (min_octet) (min_octet) (min_octet) (min_octet)
  89         | otherwise = IPv4Address.None
  90         where
  91           oct1 = (octet1 addr)
  92           oct2 = (octet2 addr)
  93           oct3 = (octet3 addr)
  94           oct4 = (octet4 addr)
  95
  96
  97 -- We don't export our constructor so this function is the only
  98 -- way to construct an address from octets. As a result, we can
  99 -- return IPv4Address.None in response to being passed one of more
 100 -- Octet.None octets.
 101 ipv4address_from_octets :: Octet -> Octet -> Octet -> Octet -> IPv4Address
 102 ipv4address_from_octets oct1 oct2 oct3 oct4
 103     | or [oct1 == Octet.None,
 104           oct2 == Octet.None,
 105           oct3 == Octet.None,
 106           oct4 == Octet.None] = IPv4Address.None
 107     | otherwise = IPv4Address oct1 oct2 oct3 oct4
 108
 109
 110 -- The minimum possible IPv4 address, 0.0.0.0.
 111 min_address :: IPv4Address
 112 min_address = IPv4Address min_octet min_octet min_octet min_octet
 113
 114
 115 -- The maximum possible IPv4 address, 255.255.255.255.
 116 max_address :: IPv4Address
 117 max_address = IPv4Address max_octet max_octet max_octet max_octet
 118
 119
 120 -- Given two addresses, find the number of the most significant bit
 121 -- where they differ. If the addresses are the same, return
 122 -- Maskbits.Zero.
 123 most_sig_bit_different :: IPv4Address -> IPv4Address -> Maskbits
 124 most_sig_bit_different addr1 addr2
 125   | addr1 == addr2 = Maskbits.Zero
 126   | m1  /= n1  = Maskbits.One
 127   | m2  /= n2  = Two
 128   | m3  /= n3  = Three
 129   | m4  /= n4  = Four
 130   | m5  /= n5  = Five
 131   | m6  /= n6  = Six
 132   | m7  /= n7  = Seven
 133   | m8  /= n8  = Eight
 134   | m9  /= n9  = Nine
 135   | m10 /= n10 = Ten
 136   | m11 /= n11 = Eleven
 137   | m12 /= n12 = Twelve
 138   | m13 /= n13 = Thirteen
 139   | m14 /= n14 = Fourteen
 140   | m15 /= n15 = Fifteen
 141   | m16 /= n16 = Sixteen
 142   | m17 /= n17 = Seventeen
 143   | m18 /= n18 = Eighteen
 144   | m19 /= n19 = Nineteen
 145   | m20 /= n20 = Twenty
 146   | m21 /= n21 = TwentyOne
 147   | m22 /= n22 = TwentyTwo
 148   | m23 /= n23 = TwentyThree
 149   | m24 /= n24 = TwentyFour
 150   | m25 /= n25 = TwentyFive
 151   | m26 /= n26 = TwentySix
 152   | m27 /= n27 = TwentySeven
 153   | m28 /= n28 = TwentyEight
 154   | m29 /= n29 = TwentyNine
 155   | m30 /= n30 = Thirty
 156   | m31 /= n31 = ThirtyOne
 157   | m32 /= n32 = ThirtyTwo
 158   | otherwise  = Maskbits.Zero
 159   where
 160     m1  = (b1 oct1a)
 161     m2  = (b2 oct1a)
 162     m3  = (b3 oct1a)
 163     m4  = (b4 oct1a)
 164     m5  = (b5 oct1a)
 165     m6  = (b6 oct1a)
 166     m7  = (b7 oct1a)
 167     m8  = (b8 oct1a)
 168     m9  = (b1 oct2a)
 169     m10 = (b2 oct2a)
 170     m11 = (b3 oct2a)
 171     m12 = (b4 oct2a)
 172     m13 = (b5 oct2a)
 173     m14 = (b6 oct2a)
 174     m15 = (b7 oct2a)
 175     m16 = (b8 oct2a)
 176     m17 = (b1 oct3a)
 177     m18 = (b2 oct3a)
 178     m19 = (b3 oct3a)
 179     m20 = (b4 oct3a)
 180     m21 = (b5 oct3a)
 181     m22 = (b6 oct3a)
 182     m23 = (b7 oct3a)
 183     m24 = (b8 oct3a)
 184     m25 = (b1 oct4a)
 185     m26 = (b2 oct4a)
 186     m27 = (b3 oct4a)
 187     m28 = (b4 oct4a)
 188     m29 = (b5 oct4a)
 189     m30 = (b6 oct4a)
 190     m31 = (b7 oct4a)
 191     m32 = (b8 oct4a)
 192     oct1a = (octet1 addr1)
 193     oct2a = (octet2 addr1)
 194     oct3a = (octet3 addr1)
 195     oct4a = (octet4 addr1)
 196     n1  = (b1 oct1b)
 197     n2  = (b2 oct1b)
 198     n3  = (b3 oct1b)
 199     n4  = (b4 oct1b)
 200     n5  = (b5 oct1b)
 201     n6  = (b6 oct1b)
 202     n7  = (b7 oct1b)
 203     n8  = (b8 oct1b)
 204     n9  = (b1 oct2b)
 205     n10 = (b2 oct2b)
 206     n11 = (b3 oct2b)
 207     n12 = (b4 oct2b)
 208     n13 = (b5 oct2b)
 209     n14 = (b6 oct2b)
 210     n15 = (b7 oct2b)
 211     n16 = (b8 oct2b)
 212     n17 = (b1 oct3b)
 213     n18 = (b2 oct3b)
 214     n19 = (b3 oct3b)
 215     n20 = (b4 oct3b)
 216     n21 = (b5 oct3b)
 217     n22 = (b6 oct3b)
 218     n23 = (b7 oct3b)
 219     n24 = (b8 oct3b)
 220     n25 = (b1 oct4b)
 221     n26 = (b2 oct4b)
 222     n27 = (b3 oct4b)
 223     n28 = (b4 oct4b)
 224     n29 = (b5 oct4b)
 225     n30 = (b6 oct4b)
 226     n31 = (b7 oct4b)
 227     n32 = (b8 oct4b)
 228     oct1b = (octet1 addr2)
 229     oct2b = (octet2 addr2)
 230     oct3b = (octet3 addr2)
 231     oct4b = (octet4 addr2)
 232
 233
 234
 235 -- HUnit Tests
 236 mk_testaddr :: Int -> Int -> Int -> Int -> IPv4Address
 237 mk_testaddr a b c d =
 238     IPv4Address oct1 oct2 oct3 oct4
 239     where
 240       oct1 = octet_from_int a
 241       oct2 = octet_from_int b
 242       oct3 = octet_from_int c
 243       oct4 = octet_from_int d
 244
 245
 246 test_most_sig_bit_different1 :: Test
 247 test_most_sig_bit_different1 =
 248     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))
 249
 250
 251 test_most_sig_bit_different2 :: Test
 252 test_most_sig_bit_different2 =
 253     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))
 254
 255
 256 ipv4address_tests :: [Test]
 257 ipv4address_tests = [ test_most_sig_bit_different1,
 258                       test_most_sig_bit_different2 ]