defmodule Cider do @moduledoc """ Parsing and matching of CIDRs with ips. """ if :erlang.system_info(:wordsize) < 8, do: raise("Cider: 32-bit Architecture not supported.") @default_mask [ ipv4: 32, ipv6: 128 ] @typedoc "A cidr made out of {`ip`, `subnet_mask`}." @type t :: {integer, integer} | Range.t() @typedoc "A tuple with each octet of the ip." @type ip :: {integer, integer, integer, integer} | {integer, integer, integer, integer, integer, integer, integer, integer} @typedoc ~S"An IP represented as integer" @type raw_ip :: integer @doc ~S""" Parses a CIDR in list representation. The first 4 items are the octets of the ip. The last item is the bit mask. ## Examples ```elixir iex> Cider.parse 192, 168, 0, 0, 24 {3232235520, 4294967040} ``` """ @spec parse(integer, integer, integer, integer, integer | nil) :: t def parse(a, b, c, d, bit_mask \\ nil) do parse({a, b, c, d}, bit_mask) end @doc ~S""" Parses a CIDR in string representation. ## Examples ```elixir iex> Cider.parse "192.168.0.0/24" {3232235520, 4294967040} ``` ```elixir iex> Cider.parse "192.168.0.1-24" 3232235521..3232235544 ``` """ @spec parse(String.t()) :: t def parse(cidr) do if String.contains?(cidr, "-") do [ip, range] = String.split(cidr, "-") range = String.to_integer(range) case ip |> String.to_charlist() |> :inet.parse_address() do {:ok, ip = {a, b, c, _}} -> ip!(ip)..ip!({a, b, c, range}) {:ok, ip = {a, b, c, d, e, f, g, _}} -> ip!(ip)..ip!({a, b, c, d, e, f, g, range}) end else [ip | mask] = String.split(cidr, "/") {:ok, ip_tuple} = ip |> String.to_charlist() |> :inet.parse_address() mask = if mask == [], do: nil, else: mask |> List.first() |> String.to_integer() parse(ip_tuple, mask) end end @doc ~S""" Creates a CIDR based on an ip and bit_mask. The ip is represented by an octet tuple. ## Examples ```elixir iex> Cider.parse {192, 168, 0, 0}, 24 {3232235520, 4294967040} iex> Cider.parse {0, 0, 0, 0, 0, 65535, 49320, 10754}, 128 {281473913989634, 340282366920938463463374607431768211455} ``` """ @spec parse(ip, integer | nil) :: t def parse(ip, bit_mask) do {ip, format} = ip_to_int(ip) subnet_mask = create_mask(bit_mask || @default_mask[format], format) {:erlang.band(ip, subnet_mask), subnet_mask} end @doc ~S""" Checks whether a given `ip` falls within a `cidr` range. ## Example ```elixir iex> Cider.contains?({192, 168, 0, 1}, Cider.parse({192, 168, 0, 0}, 24)) true iex> Cider.contains?(3232235520, Cider.parse({192, 168, 0, 0}, 24)) true iex> Cider.contains?({192, 168, 254, 1}, Cider.parse({192, 168, 0, 0}, 24)) false ``` """ @spec contains?(ip | raw_ip, t) :: boolean def contains?(ip, {cidr, subnet_mask}) when is_integer(ip) do ip |> :erlang.band(subnet_mask) |> :erlang.bxor(cidr) == 0 end def contains?(ip, range = _.._) when is_integer(ip), do: ip in range def contains?(ip, match), do: ip |> ip!() |> contains?(match) @doc ~S""" Returns the raw numeric IP. ## Examples ```elixir iex> Cider.ip!("192.168.1.1") 3_232_235_777 iex> Cider.ip!({192, 168, 1, 1}) 3_232_235_777 ``` """ @spec ip!(binary | tuple) :: raw_ip | no_return def ip!(ip) when is_binary(ip) do {:ok, ip} = ip |> String.to_charlist() |> :inet.parse_address() ip |> ip_to_int() |> elem(0) end def ip!(ip) do ip |> ip_to_int() |> elem(0) end @spec ip_to_int(ip) :: {raw_ip, :ipv4 | :ipv6} defp ip_to_int({a, b, c, d, e, f, g, h}) do { h |> :erlang.bor(:erlang.bsl(g, 16)) |> :erlang.bor(:erlang.bsl(f, 32)) |> :erlang.bor(:erlang.bsl(e, 48)) |> :erlang.bor(:erlang.bsl(d, 64)) |> :erlang.bor(:erlang.bsl(c, 80)) |> :erlang.bor(:erlang.bsl(b, 96)) |> :erlang.bor(:erlang.bsl(a, 112)), :ipv6 } end defp ip_to_int({a, b, c, d}) do { d |> :erlang.bor(:erlang.bsl(c, 8)) |> :erlang.bor(:erlang.bsl(b, 16)) |> :erlang.bor(:erlang.bsl(a, 24)), :ipv4 } end @spec create_mask(integer, :ipv4 | :ipv6) :: integer defp create_mask(bit_mask, :ipv4) do shift = 32 - bit_mask # 0xffffffff (32 bits) 4_294_967_295 |> :erlang.bsr(shift) |> :erlang.bsl(shift) end defp create_mask(bit_mask, :ipv6) do shift = 128 - bit_mask # 0xf..f (128 bits) 340_282_366_920_938_463_463_374_607_431_768_211_455 |> :erlang.bsr(shift) |> :erlang.bsl(shift) end ### Convenience ### @doc ~S""" Convert a tuple or numeric IP to string. ## Examples ```elixir iex> Cider.to_string({192, 168, 1, 1}) "192.168.1.1" iex> Cider.to_string(3_232_235_777) "192.168.1.1" iex> Cider.to_string({0, 0, 0, 0, 0, 65535, 49320, 10754}) "0:0:0:0:0:FFFF:C0A8:2A02" iex> Cider.to_string(281_473_913_989_634) "0:0:0:0:0:FFFF:C0A8:2A02" ``` """ @spec to_string(tuple | integer) :: String.t() def to_string({a, b, c, d}), do: "#{a}.#{b}.#{c}.#{d}" def to_string({ip, mask}) do Cider.to_string(ip) <> "/" <> mask_to_string(mask) end def to_string(ip) when is_tuple(ip) do ip |> Tuple.to_list() |> Enum.map(&Integer.to_string(&1, 16)) |> Enum.join(":") end def to_string(ip) when is_integer(ip) do if ip <= 4_294_967_295 do 1..4 |> Enum.reduce({ip, []}, &ip_reduce_ipv4/2) |> elem(1) |> Enum.join(".") else 1..8 |> Enum.reduce({ip, []}, &ip_reduce_ipv6/2) |> elem(1) |> Enum.join(":") end end def to_string(whitelist) when is_list(whitelist) do whitelist |> Enum.map(&Cider.to_string/1) |> Enum.join(", ") end def to_string(a..b) do part = b |> Cider.to_string() |> String.split(~r/(:|\.)/) |> List.last() Cider.to_string(a) <> "-#{part}" end defp ip_reduce_ipv4(_, {ip, acc}) do { :erlang.bsr(ip, 8), [:erlang.band(ip, 255) | acc] } end defp ip_reduce_ipv6(_, {ip, acc}) do { :erlang.bsr(ip, 16), [Integer.to_string(:erlang.band(ip, 65_535), 16) | acc] } end ### Whitelisting ### @doc ~S""" Generate an IP whitelist. See: `whitelist/1`. ## Example ```elixir iex> Cider.whitelist!("192.168.0.1-3, 192.168.1.0/32") [{3232235776, 4294967295}, 3232235521..3232235523] iex> Cider.whitelist!("flurp") ** (RuntimeError) Failed to whitelist. (invalid_whitelist_cidr) ``` """ @spec whitelist!(String.t() | [String.t() | t]) :: [t] def whitelist!(whitelist) do case whitelist(whitelist) do {:ok, wl} -> wl {:error, reason} -> raise "Failed to whitelist. (#{reason})" end end @doc ~S""" Generate an IP whitelist. ## Examples ```elixir iex> Cider.whitelist("192.168.0.1-3, 192.168.1.0/32") {:ok, [{3232235776, 4294967295}, 3232235521..3232235523]} ``` """ @spec whitelist(String.t() | [String.t() | t]) :: {:ok, [t]} | {:error, atom} def whitelist(whitelist) when is_binary(whitelist) do whitelist |> String.split(~r/(,| )\ */, trim: true) |> do_whitelist() end def whitelist(ips) when is_list(ips), do: do_whitelist(ips) def whitelist(_), do: {:error, :invalid_whitelist} @spec do_whitelist([String.t() | t]) :: {:ok, [t]} | {:error, atom} defp do_whitelist(ips, acc \\ []) defp do_whitelist([], acc), do: {:ok, acc} defp do_whitelist([ip = {_, _} | ips], acc), do: do_whitelist(ips, [ip | acc]) defp do_whitelist([ip = _.._ | ips], acc), do: do_whitelist(ips, [ip | acc]) defp do_whitelist([ip | ips], acc) do do_whitelist(ips, [parse(ip) | acc]) rescue _ -> {:error, :invalid_whitelist_cidr} end @doc ~S""" Check whether a given IP is whitelisted. An empty whitelist will always return `false`. ## Examples ```elixir iex> Cider.whitelisted?("192.168.0.2", "192.168.0.1-3, 192.168.1.0/24") true iex> Cider.whitelisted?("192.168.1.2", "192.168.0.1-3, 192.168.1.0/24") true iex> Cider.whitelisted?("192.168.2.2", "192.168.0.1-3, 192.168.1.0/24") false ``` """ @spec whitelisted?(String.t() | ip | raw_ip, String.t() | [t]) :: boolean def whitelisted?(ip, whitelist) when is_binary(whitelist) do case whitelist(whitelist) do {:ok, wl} -> whitelisted?(ip, wl) _ -> false end end def whitelisted?(ip, whitelist) when is_integer(ip), do: Enum.find_value(whitelist, false, &Cider.contains?(ip, &1)) def whitelisted?(ip, whitelist), do: ip |> ip! |> whitelisted?(whitelist) @doc ~S""" Add a CIDR or range to a IP whitelist. ## Example ```elixir iex> wl = Cider.whitelist([], "192.168.0.0-23") iex> Cider.to_string(wl) "192.168.0.0-23" iex> wl = Cider.whitelist(wl, "192.168.0.24-31") iex> Cider.to_string(wl) "192.168.0.0/27" ``` """ @spec whitelist(binary | [t], binary | t) :: [t] def whitelist(whitelist, cidr) def whitelist(wl, cidr) when is_binary(cidr), do: whitelist(wl, parse(cidr)) def whitelist(wl, cidr) when is_binary(wl), do: whitelist(whitelist!(wl), cidr) def whitelist(wl, cidr), do: optimize!([cidr | wl]) @doc ~S""" Remove a CIDR or range from a IP whitelist. ## Example ```elixir iex> wl = Cider.whitelist("192.168.0.0/24", "8.8.8.4-8") iex> Cider.to_string(wl) "192.168.0.0/24, 8.8.8.4-8" iex> wl = Cider.blacklist(wl, "192.168.0.5-32") iex> Cider.to_string(wl) "192.168.0.128/25, 192.168.0.64/26, 192.168.0.32/27, 8.8.8.4-8, 192.168.0.0-4" ``` """ @spec blacklist(binary | [t], binary | t) :: [t] def blacklist(whitelist, cidr) def blacklist(whitelist, cidr) when is_binary(cidr), do: blacklist(whitelist, parse(cidr)) def blacklist(whitelist, cidr) when is_binary(whitelist), do: blacklist(optimize!(whitelist), cidr) def blacklist(whitelist, cidr) do whitelist |> Enum.flat_map(&remove(&1, cidr)) |> optimize! end @spec remove(t, t) :: [t] defp remove(same, same), do: [] # range - range # credo:disable-for-next-line Credo.Check.Refactor.CyclomaticComplexity defp remove(white = a..b, black = x..y) do cond do Range.disjoint?(white, black) -> [white] a >= x and b <= y -> [] a >= x and b > y -> [fix_range((y + 1)..b)] a < x and b > y -> [fix_range(a..(x - 1)), fix_range((y + 1)..b)] a < x and b < y -> [fix_range(a..(x - 1))] end end # CIDR - CIDR defp remove(white = {a, b}, black = {x, y}) do mask = min(b, y) cond do :erlang.band(a, mask) != :erlang.band(x, mask) -> [white] b >= y -> [] b < y -> cider_sub(white, black) end end # range - CIDR defp remove(white = _.._, black = {_, _}), do: remove(white, cidr_to_range(black)) # CIDR - range defp remove(cidr, range = a..b) do case range_to_cider(range) do black = {_, _} -> cider_sub(cidr, black) _ -> diff_bits = trunc(Float.ceil(:math.log2(b - a))) mask = 0xFFFFFFFF |> :erlang.bsl(diff_bits) |> :erlang.band(0xFFFFFFFF) black = {:erlang.band(a, mask), mask} cider_sub(cidr, black) ++ remove(cidr_to_range(black), range) end end defp cider_sub({a, b}, {x, y}) do diff_mask = :erlang.bxor(b, y) diff_inv = x |> :erlang.bxor(diff_mask) |> :erlang.band(diff_mask) branch_inv = a |> :erlang.band(b) |> :erlang.bor(diff_inv) mask_tree(a, branch_inv, y, b) end defp mask_tree(original, ip, from, to, acc \\ []) defp mask_tree(_original, _ip, from, to, acc) when from == to, do: acc defp mask_tree(original, ip, from, to, acc) do new = from |> :erlang.bsl(1) |> :erlang.band(0xFFFFFFFF) inverse = :erlang.band(original, new) + :erlang.band(ip, :erlang.bxor(from, new)) mask_tree(original, ip, new, to, [{inverse, from} | acc]) end defp fix_range(a..a), do: {a, 4_294_967_295} defp fix_range(r), do: r @doc ~S""" Optimize a Cider whitelist by merging overlapping CIDR. See: `optimize/1`. ## Example ```elixir iex> optimized = Cider.optimize!("192.168.0.1-5, 192.168.0.10-20, 192.168.1.1/16, 192.168.0.6-9, 192.168.0.1/24") iex> Cider.to_string(optimized) "192.168.0.0/16" ``` """ @spec optimize!(String.t() | list) :: [t] def optimize!(whitelist) do case optimize(whitelist) do {:ok, wl} -> wl {:error, reason} -> raise "Failed to optimize whitelist. (#{reason})" end end @doc ~S""" Optimize a Cider whitelist by merging overlapping CIDR. ## Examples ```elixir iex> {:ok, optimized} = Cider.optimize("192.168.0.1-5, 192.168.0.10-20, 192.168.1.1/16, 192.168.0.6-9, 192.168.0.1/24") iex> Cider.to_string(optimized) "192.168.0.0/16" ``` ```elixir iex> {:ok, optimized} = Cider.optimize("192.168.0.1-5, 192.168.0.10-20, 192.168.0.6-9") iex> Cider.to_string(optimized) "192.168.0.1-20" ``` ```elixir iex> {:ok, optimized} = Cider.optimize("192.168.0.1-5, 192.168.0.10-20, 192.168.0.6-9, 192.168.0.0/31, 192.168.1.0/31") iex> Cider.to_string(optimized) "192.168.0.0-20, 192.168.1.0/31" ``` """ @spec optimize(String.t() | list) :: {:ok, [t]} | {:error, :invalid_whitelist | :invalid_whitelist_cidr} def optimize(whitelist) when is_binary(whitelist) do with {:ok, wl} <- whitelist(whitelist), do: optimize(wl) end def optimize(whitelist) do whitelist = whitelist |> Enum.sort_by(&is_tuple/1) |> Enum.reverse() case merge_overlapping(whitelist, []) do {:overlap, ips} -> optimize(ips) {:no_overlap, ips} -> {:ok, ips |> Enum.map(&range_to_cider/1) |> Enum.sort(&sort_cidr/2)} end end @spec sort_cidr(t, t) :: boolean defp sort_cidr({x, a}, {y, b}), do: a < b or (a == b and x < y) defp sort_cidr({x, a}, b = y.._), do: sort(cidr_count(a), Enum.count(b), x, y) defp sort_cidr(a = x.._, {y, b}), do: sort(Enum.count(a), cidr_count(b), x, y) defp sort_cidr(a = x.._, b = y.._), do: sort(Enum.count(a), Enum.count(b), x, y) @spec sort(integer, integer, integer, integer) :: boolean defp sort(count_a, count_b, x, y), do: count_a > count_b or (count_a == count_b and x < y) @spec cidr_count(integer) :: integer defp cidr_count(mask) when mask > 0xFFFFFFFF, do: :erlang.bxor(mask, 0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF) defp cidr_count(mask), do: :erlang.bxor(mask, 0xFFFFFFFF) @spec merge_overlapping([t], [t]) :: {:overlap, [t]} | {:no_overlap, [t]} defp merge_overlapping([], acc), do: {:no_overlap, acc} defp merge_overlapping([ip | ips], acc) do case merge_overlap(ip, ips, []) do {:overlap, overlap} -> {:overlap, overlap ++ acc} {:no_overlap, ips} -> merge_overlapping(ips, [ip | acc]) end end @spec merge_overlap(t, [t], [t]) :: {:overlap, [t]} | {:no_overlap, [t]} defp merge_overlap(_, [], acc), do: {:no_overlap, acc} defp merge_overlap(ip, [potential | ips], acc) do case overlap?(ip, potential) do :no_overlap -> merge_overlap(ip, ips, [potential | acc]) {:overlap, new} -> {:overlap, ips ++ [new | acc]} end end @spec overlap?(t, t) :: {:overlap, t} | :no_overlap defp overlap?(a..b, c..d) do cond do a + 1 < c and b + 1 < c -> :no_overlap c + 1 < a and d + 1 < a -> :no_overlap :overlap -> {:overlap, min(a, c)..max(b, d)} end end defp overlap?(cidr = {_, _}, c..d) do cond do Enum.all?(c..d, &Cider.contains?(&1, cidr)) -> {:overlap, cidr} range = cidr_to_range(cidr) -> overlap?(range, c..d) :no_overlap -> :no_overlap end end defp overlap?(c..d, {a, b}), do: overlap?({a, b}, c..d) defp overlap?({a, b}, {c, d}) do cond do b <= d and Cider.contains?(c, {a, b}) -> {:overlap, {a, b}} d <= b and Cider.contains?(a, {c, d}) -> {:overlap, {c, d}} :no_overlap -> :no_overlap end end @spec mask_to_string(integer) :: String.t() Enum.each(0..32, fn shift -> defp mask_to_string(unquote(0xFFFFFFFF |> :erlang.bsr(shift) |> :erlang.bsl(shift))), do: unquote(to_string(32 - shift)) end) Enum.each(0..127, fn shift -> defp mask_to_string( unquote(0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF |> :erlang.bsr(shift) |> :erlang.bsl(shift)) ), do: unquote(to_string(128 - shift)) end) @spec cidr_to_range(t) :: t | nil defp cidr_to_range({ip, mask}) when mask > 0xFFFFFF00 do ip..(ip + :erlang.bxor(0xFFFFFFFF, mask)) end defp cidr_to_range(_), do: nil @spec range_to_cider(t) :: t defp range_to_cider(a..b) do mask = Integer.to_string(b - a, 2) if mask =~ ~r/^1{1,8}+$/ do {a, create_mask(32 - String.length(mask), :ipv4)} else a..b end end defp range_to_cider(a), do: a end