X-Git-Url: http://gitweb.michael.orlitzky.com/?a=blobdiff_plain;f=hath.cabal;h=4d5b6b8306ad790a6ee521534c7b1129566d9cde;hb=02a793ab4325e5d04eb3ae3450aa33d01b4b4d1c;hp=12f811a229bf19ec18e891ab6a7994483bae2ceb;hpb=e1d16438b44ecd962565756a828c9ed8014cf894;p=hath.git diff --git a/hath.cabal b/hath.cabal index 12f811a..4d5b6b8 100644 --- a/hath.cabal +++ b/hath.cabal @@ -1,23 +1,121 @@ name: hath -version: 0.0.1 +version: 0.2.2 cabal-version: >= 1.8 author: Michael Orlitzky maintainer: Michael Orlitzky +category: Utils +license: GPL-3 +license-file: doc/LICENSE +build-type: Simple +extra-source-files: + doc/man1/hath.1 + test/shell/*.test + test/shell-net/*.test synopsis: Hath manipulates network blocks in CIDR notation. -build-type: Simple +description: + Hath is a Haskell program for working with network blocks in CIDR + notation. When dealing with blocks of network addresses, there are a + few things that one usually wants to do with them: + . + * Create a regular expression matching the CIDR block(s). This is + because grep will throw up if you feed it CIDR. + . + * Combine small blocks into larger ones. For example, if you have two + consecutive \/24s, they might combine into a larger \/23. + . + * View the result of block combination in a useful way. + . + * List them. + . + * Find their associated PTR records. + . + Hath has several modes to perform these functions: + . + [@Regexed@] + This computes a (Perl-compatible) regular expression matching + the input CIDR blocks. It's the default mode of operation. + . + [@Reduced@] + This combines small blocks into larger ones where possible, and + eliminates redundant blocks. The output should be equivalent to + the input, though. + . + [@Duped@] + Shows only the blocks that would be removed by reduce; that is, it + shows the ones that would get combined into larger blocks or are + simply redundant. + . + [@Diffed@] + Shows what would change if you used reduce. Uses diff-like + notation. + . + [@Listed@] + List the IP addresses contained within the given CIDRs. + . + [@Reversed@] + Perform reverse DNS (PTR) lookups on the IP addresses contained + within the given CIDRs. + . + /Examples/: + . + Compute a (Perl-compatible) regular expression matching + the input CIDR blocks. It's the default mode of operation. + . + @ + $ hath <<< \"10.0.0.0\/29 10.0.0.8\/29\" + ((10)\.(0)\.(0)\.(15|14|13|12|11|10|9|8|7|6|5|4|3|2|1|0)) + @ + . + Combine two \/24s into a \/23: + . + @ + $ hath reduced <<< \"10.0.0.0\/24 10.0.1.0\/24\" + 10.0.0.0/23 + @ + . + List the addresses in 192.168.0.240\/29: + . + @ + $ hath listed <<< 192.168.0.240\/29 + 192.168.0.240 + 192.168.0.241 + 192.168.0.242 + 192.168.0.243 + 192.168.0.244 + 192.168.0.245 + 192.168.0.246 + 192.168.0.247 + @ + . + Perform PTR lookups on all of 198.41.0.4\/30: + . + @ + $ hath reversed <<< 198.41.0.4\/30 + 198.41.0.4: a.root-servers.net. + 198.41.0.5: + 198.41.0.6: rs.internic.net. + 198.41.0.7: + @ + . + The DNS lookups are usually the bottleneck for this mode, but we can + perform them in parallel. Simply pass the number of threads to the + GHC runtime on the command line; for example, the following will + perform 25 lookups in parallel: + . + @ + $ hath reversed +RTS -N25 <<< 198.41.0.4\/24 + 198.41.0.4: a.root-servers.net. + 198.41.0.5: + 198.41.0.6: rs.internic.net. + ... + @ + . + The command-line syntax and complete set of options are documented in + the man page. executable hath - build-depends: - base == 4.*, - HUnit == 1.2.*, - QuickCheck == 2.6.*, - MissingH == 1.2.*, - split == 0.2.*, - test-framework == 0.8.*, - test-framework-hunit == 0.3.*, - test-framework-quickcheck2 == 0.3.* main-is: Main.hs @@ -25,6 +123,29 @@ executable hath hs-source-dirs: src/ + other-modules: + Bit + Cidr + CommandLine + DNS + ExitCodes + IPv4Address + Maskable + Maskbits + Octet + + build-depends: + base == 4.*, + bytestring >= 0.10, + cmdargs >= 0.10, + dns >= 1.2, + MissingH >= 1.2, + parallel-io >= 0.3, + split >= 0.2, + tasty >= 0.8, + tasty-hunit >= 0.8, + tasty-quickcheck >= 0.8.1 + ghc-options: -Wall -fwarn-hi-shadowing @@ -52,15 +173,19 @@ test-suite testsuite type: exitcode-stdio-1.0 hs-source-dirs: src test main-is: TestSuite.hs + build-depends: base == 4.*, - HUnit == 1.2.*, - QuickCheck == 2.6.*, - MissingH == 1.2.*, - split == 0.2.*, - test-framework == 0.8.*, - test-framework-hunit == 0.3.*, - test-framework-quickcheck2 == 0.3.* + bytestring >= 0.10, + cmdargs >= 0.10, + dns >= 1.2, + MissingH >= 1.2, + parallel-io >= 0.3, + split >= 0.2, + tasty >= 0.8, + tasty-hunit >= 0.8, + tasty-quickcheck >= 0.8.1 + -- It's not entirely clear to me why I have to reproduce all of this. ghc-options: @@ -80,6 +205,83 @@ test-suite testsuite -optc-march=native -O2 + +-- These won't work without shelltestrunner installed in your +-- $PATH. Maybe there is some way to tell Cabal that. +test-suite shelltests + type: exitcode-stdio-1.0 + hs-source-dirs: test + main-is: ShellTests.hs + + build-depends: + base == 4.*, + bytestring >= 0.10, + cmdargs >= 0.10, + dns >= 1.2, + MissingH >= 1.2, + parallel-io >= 0.3, + process >= 1.1, + split >= 0.2, + tasty >= 0.8, + tasty-hunit >= 0.8, + tasty-quickcheck >= 0.8.1 + + -- It's not entirely clear to me why I have to reproduce all of this. + ghc-options: + -Wall + -fwarn-hi-shadowing + -fwarn-missing-signatures + -fwarn-name-shadowing + -fwarn-orphans + -fwarn-type-defaults + -fwarn-tabs + -fwarn-incomplete-record-updates + -fwarn-monomorphism-restriction + -fwarn-unused-do-bind + -rtsopts + -threaded + -optc-O3 + -optc-march=native + -O2 + + +test-suite shelltests-net + type: exitcode-stdio-1.0 + hs-source-dirs: test + main-is: ShellTestsNet.hs + + build-depends: + base == 4.*, + bytestring >= 0.10, + cmdargs >= 0.10, + dns >= 1.2, + MissingH >= 1.2, + parallel-io >= 0.3, + process >= 1.1, + split >= 0.2, + tasty >= 0.8, + tasty-hunit >= 0.8, + tasty-quickcheck >= 0.8.1 + + -- It's not entirely clear to me why I have to reproduce all of this. + ghc-options: + -Wall + -fwarn-hi-shadowing + -fwarn-missing-signatures + -fwarn-name-shadowing + -fwarn-orphans + -fwarn-type-defaults + -fwarn-tabs + -fwarn-incomplete-record-updates + -fwarn-monomorphism-restriction + -fwarn-unused-do-bind + -rtsopts + -threaded + -optc-O3 + -optc-march=native + -O2 + + source-repository head type: git location: http://michael.orlitzky.com/git/hath.git