+cabal-version: 3.4
name: hath
-version: 0.0.5
-cabal-version: >= 1.8
+version: 0.5.4
author: Michael Orlitzky
maintainer: Michael Orlitzky <michael@orlitzky.com>
+homepage: http://michael.orlitzky.com/code/hath.xhtml
category: Utils
-license: GPL-3
+license: AGPL-3.0-only
license-file: doc/LICENSE
build-type: Simple
extra-source-files:
doc/man1/hath.1
+ test/shell/*.test
synopsis:
Hath manipulates network blocks in CIDR notation.
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.
- .
+
+ * __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.
+
/Examples/:
- .
- Combine two \/24s into a \/23:
- .
+
+ Compute a (Perl-compatible) regular expression matching
+ the input CIDR blocks. It's the default mode of operation.
+
@
- $ hath reduced <<< \"10.0.0.0\/24 10.0.1.0\/24\"
- 10.0.0.0/23
+ $ echo \"10.0.0.0\/29 10.0.0.8\/29\" | hath
+ ((10)\.(0)\.(0)\.(15|14|13|12|11|10|9|8|7|6|5|4|3|2|1|0))
@
- .
- Create a perl-compatible regex to be fed to grep:
- .
+
+ Combine two \/24s into a \/23:
+
@
- $ grep -P `hath regexed -i cidrs.txt` mail.log
+ $ echo \"10.0.0.0\/24 10.0.1.0\/24\" | hath reduced
+ 10.0.0.0/23
@
- .
+
List the addresses in 192.168.0.240\/29:
- .
+
@
- $ hath listed <<< \"192.168.0.240\/29\"
+ $ echo 192.168.0.240\/29 | hath listed
192.168.0.240
192.168.0.241
192.168.0.242
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.
- ...
- @
-executable hath
- build-depends:
- base >= 4.6 && < 4.7,
- bytestring == 0.10.*,
- dns == 1.*,
- HUnit == 1.2.*,
- QuickCheck == 2.6.*,
- MissingH == 1.2.*,
- parallel-io == 0.3.*,
- split == 0.2.*,
- test-framework == 0.8.*,
- test-framework-hunit == 0.3.*,
- test-framework-quickcheck2 == 0.3.*
+ The command-line syntax and complete set of options are documented in
+ the man page.
+
+executable hath
main-is:
Main.hs
Bit
Cidr
CommandLine
- DNS
ExitCodes
IPv4Address
Maskable
Maskbits
Octet
+ Paths_hath
- 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
-
- ghc-prof-options:
- -prof
- -auto-all
- -caf-all
+ build-depends:
+ base >= 4.15,
+ cmdargs >= 0.10,
+ split >= 0.2,
+ tasty >= 0.8,
+ tasty-hunit >= 0.8,
+ tasty-quickcheck >= 0.8.1
test-suite testsuite
type: exitcode-stdio-1.0
hs-source-dirs: src test
main-is: TestSuite.hs
+
+ other-modules:
+ Bit
+ Cidr
+ IPv4Address
+ Maskable
+ Maskbits
+ Octet
+
build-depends:
- base >= 4.6 && < 4.7,
- bytestring == 0.10.*,
- dns == 1.*,
- HUnit == 1.2.*,
- QuickCheck == 2.6.*,
- MissingH == 1.2.*,
- parallel-io == 0.3.*,
- split == 0.2.*,
- test-framework == 0.8.*,
- test-framework-hunit == 0.3.*,
- test-framework-quickcheck2 == 0.3.*
-
- -- 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
+ base >= 4.15,
+ split >= 0.2,
+ tasty >= 0.8,
+ tasty-hunit >= 0.8,
+ tasty-quickcheck >= 0.8.1
+
+
+-- 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.15,
+ process >= 1.1
+
source-repository head
type: git
- location: http://michael.orlitzky.com/git/hath.git
+ location: http://gitweb.michael.orlitzky.com/hath.git
branch: master