diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..2c63c08 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,2 @@ +{ +} diff --git a/Gemfile.lock b/Gemfile.lock index 52a0fcd..4d7ed40 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,7 @@ PATH remote: . specs: - haiti-hash (1.5.0) + haiti-hash (2.0.0) docopt (~> 0.6) paint (~> 2.2) diff --git a/README.md b/README.md index 9ed4136..c515ca0 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ A CLI tool (and library) to identify hash types (hash type identifier). ## Features -- 519+ hash types detected +- 632+ hash types detected - Modern algorithms supported (SHA3, Keccak, Blake2, etc.) - Hashcat and John the Ripper references - CLI tool & library diff --git a/docker-compose.yml b/docker-compose.yml index ddd4cec..bd2b75d 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -2,7 +2,7 @@ version: '3' services: haiti: - image: noraj/haiti:1.5.0 + image: noraj/haiti:2.0.0 user: noraj container_name: haiti read_only: false @@ -10,4 +10,4 @@ services: context: . dockerfile: Dockerfile args: - HAITI_VERSION: 1.5.0 + HAITI_VERSION: 2.0.0 diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index f1466c7..29bf0ba 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -1,5 +1,7 @@ ## [unreleased] +## [2.0.0] + - **Breaking changes**: - **Drop** Ruby 2.5 support, [EOL since 05/04/2021](https://www.ruby-lang.org/en/downloads/branches/) and not supported by Rubocop since [1.29.0](https://github.com/rubocop/rubocop/releases/tag/v1.29.0) - **Drop** Ruby 2.6 support, [EOL since 12/04/2021](https://www.ruby-lang.org/en/downloads/branches/) and not supported by Rubocop since [1.51.0](https://github.com/rubocop/rubocop/releases/tag/v1.51.0) diff --git a/docs/README.md b/docs/README.md index 017b191..2adfc3b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -16,7 +16,7 @@ A CLI tool (and library) to identify hash types (hash type identifier). ## Features -- 519+ hash types detected +- 632+ hash types detected - Modern algorithms supported (SHA3, Keccak, Blake2, etc.) - Hashcat and John the Ripper references - CLI tool & library diff --git a/docs/_coverpage.md b/docs/_coverpage.md index 5a3565a..566243d 100644 --- a/docs/_coverpage.md +++ b/docs/_coverpage.md @@ -4,7 +4,7 @@ > _**HA**sh **I**den**T**if**I**er_ -- 519+ hash types detected +- 632+ hash types detected - Modern algorithms supported (SHA3, Keccak, Blake2, etc.) - Hashcat and John the Ripper references - CLI tool & library diff --git a/docs/pages/install.md b/docs/pages/install.md index 6945443..de12b2b 100644 --- a/docs/pages/install.md +++ b/docs/pages/install.md @@ -78,7 +78,7 @@ $ git clone https://github.com/noraj/haiti.git $ cd haiti $ docker-compose build # alternatively without docker compose -$ docker build -f Dockerfile -t haiti:1.5.0 --build-arg HAITI_VERSION=1.5.0 . +$ docker build -f Dockerfile -t haiti:2.0.0 --build-arg HAITI_VERSION=2.0.0 . ``` Usage examples: @@ -98,7 +98,7 @@ host: `docker.io` $ docker pull noraj/haiti # specific tag -$ docker pull noraj/haiti:1.5.0 +$ docker pull noraj/haiti:2.0.0 ``` Usage examples: @@ -120,7 +120,7 @@ host: `ghcr.io` $ docker pull ghcr.io/noraj/haiti # specific tag -$ docker pull ghcr.io/noraj/haiti:1.5.0 +$ docker pull ghcr.io/noraj/haiti:2.0.0 ``` Usage examples: @@ -142,7 +142,7 @@ host: `registry-intl.eu-central-1.aliyuncs.com` $ docker pull registry-intl.eu-central-1.aliyuncs.com/noraj/haiti # specific tag -$ docker pull registry-intl.eu-central-1.aliyuncs.com/noraj/haiti:1.5.0 +$ docker pull registry-intl.eu-central-1.aliyuncs.com/noraj/haiti:2.0.0 ``` Usage examples: @@ -162,7 +162,7 @@ host: `quay.io` $ docker pull quay.io/noraj/haiti # specific tag -$ docker pull quay.io/noraj/haiti:1.5.0 +$ docker pull quay.io/noraj/haiti:2.0.0 ``` Usage examples: diff --git a/docs/pages/publishing.md b/docs/pages/publishing.md index d9fd971..eaa181f 100644 --- a/docs/pages/publishing.md +++ b/docs/pages/publishing.md @@ -1,5 +1,14 @@ # Publishing +Edit the new version number in: + +- `lib/haiti/version.rb` +- `man/haiti.ronn` +- `docker-compose.yml` +- `docs/pages/install.md` +- `docs/pages/publishing.md` +- search for others + Be sure all **tests** pass! ``` @@ -40,7 +49,7 @@ $ bundle exec rake create_manpage Create an **annotated git tag**: ``` -$ git tag -a v1.5.0 +$ git tag -a v2.0.0 ``` Push the changes including the tags: @@ -60,7 +69,7 @@ $ bundle exec rake build Push the new gem release on **RubyGems** See https://guides.rubygems.org/publishing/. ``` -$ gem push haiti-hash-1.5.0.gem +$ gem push haiti-hash-2.0.0.gem ``` ## Docker container registries @@ -70,7 +79,7 @@ $ gem push haiti-hash-1.5.0.gem ### **Docker Hub** ``` -$ export HAITI_VERSION=1.5.0 +$ export HAITI_VERSION=2.0.0 $ docker build -f Dockerfile -t noraj/haiti:$HAITI_VERSION --build-arg HAITI_VERSION=$HAITI_VERSION . $ docker build -f Dockerfile -t noraj/haiti:latest --build-arg HAITI_VERSION=$HAITI_VERSION . @@ -86,7 +95,7 @@ $ docker push docker.io/noraj/haiti:latest GHCR = Github Container Registry ``` -$ export HAITI_VERSION=1.5.0 +$ export HAITI_VERSION=2.0.0 $ docker build -f Dockerfile -t ghcr.io/noraj/haiti:$HAITI_VERSION --build-arg HAITI_VERSION=$HAITI_VERSION . $ docker build -f Dockerfile -t ghcr.io/noraj/haiti:latest --build-arg HAITI_VERSION=$HAITI_VERSION . @@ -103,7 +112,7 @@ $ docker push ghcr.io/noraj/haiti:latest ACR = Alibaba Cloud Container Registry ``` -$ export HAITI_VERSION=1.5.0 +$ export HAITI_VERSION=2.0.0 $ docker build -f Dockerfile -t registry-intl.eu-central-1.aliyuncs.com/noraj/haiti:$HAITI_VERSION --build-arg HAITI_VERSION=$HAITI_VERSION . $ docker build -f Dockerfile -t registry-intl.eu-central-1.aliyuncs.com/noraj/haiti:latest --build-arg HAITI_VERSION=$HAITI_VERSION . @@ -117,7 +126,7 @@ $ docker push registry-intl.eu-central-1.aliyuncs.com/noraj/haiti:latest ### **Quay.io** ``` -$ export HAITI_VERSION=1.5.0 +$ export HAITI_VERSION=2.0.0 $ docker build -f Dockerfile -t quay.io/noraj/haiti:$HAITI_VERSION --build-arg HAITI_VERSION=$HAITI_VERSION . $ docker build -f Dockerfile -t quay.io/noraj/haiti:latest --build-arg HAITI_VERSION=$HAITI_VERSION . diff --git a/docs/pages/usage.md b/docs/pages/usage.md index b45e60f..f34de47 100644 --- a/docs/pages/usage.md +++ b/docs/pages/usage.md @@ -4,7 +4,7 @@ ``` $ haiti -h -HAITI (HAsh IdenTifIer) v1.5.0 +HAITI (HAsh IdenTifIer) v2.0.0 Usage: haiti [options] list diff --git a/docs/why.md b/docs/why.md index 5842d5f..3793b53 100644 --- a/docs/why.md +++ b/docs/why.md @@ -25,7 +25,7 @@ for now. Tool | Maintained | Color | Ref. | Library | Lang | :hash: | :1234: ---------------------|------------|-------|------|---------|------|---------------|--- -[haiti][0] | ✅ (2019-now) | ✅ | ✅ | ✅ | 💎 | ✅ | 519+ +[haiti][0] | ✅ (2019-now) | ✅ | ✅ | ✅ | 💎 | ✅ | 632+ [hashID][1] | ❌ (2013-2015) | ❌ | ✅ | ❌ | 🐍 | ⭕️ | 275 [hash-identifier][2] | ❌ (2011-2011) | ❌ | ❌ | ❌ | 🐍 | ❌ | ~126 [Dagon][3] | ❌ (2017-2018) | ⭕️ | ❌ | ❌ | 🐍 | ⭕️ | ~48 diff --git a/docs/yard/HashIdentifier.html b/docs/yard/HashIdentifier.html index d469474..260e192 100644 --- a/docs/yard/HashIdentifier.html +++ b/docs/yard/HashIdentifier.html @@ -6,7 +6,7 @@ Class: HashIdentifier - — Documentation by YARD 0.9.28 + — Documentation by YARD 0.9.34 @@ -232,6 +232,52 @@

  • + .list ⇒ Array<String> + + + + + + + + + + + + + +

    List names of all hash types available.

    +
     + +
    • + + +
  • + + + .object_list ⇒ Array<Chf> + + + + + + + + + + + + + +

    List all hash types available as object.

    +
     + +
    • + + +
  • + + .samples(input) ⇒ Array<String> @@ -502,7 +548,138 @@

    Class Method Details

    -

    +

    + + .list ⇒ Array<String> + + + + + +

    +
    +

    List names of all hash types available

    + + +
    +
    +
    + +
    +

    Examples:

    + + + 
    HashIdentifier.list
+# => ["CRC-16", "CRC-16-CCITT", "FCS-16", "Adler-32", "CRC-32B", "FCS-32", ...]
    + +
    + +

    Returns:

    +
      + +
    • + + + (Array<String>) + + + + — +

      a list of hash types name

      +
      + +
      • + +
    + +
    + + + + +
    + 
    +
+
+59
+60
+61
    +     		+ 
    # File 'lib/haiti.rb', line 59
+
+def list
+  (PROTOTYPES.flat_map { |d| d['modes'].map { |m| m['name'] } }).sort { |a, b| a.downcase <=> b.downcase }.uniq
+end
    +
    +
    + +
    +

    + + .object_list ⇒ Array<Chf> + + + + + +

    +
    +

    List all hash types available as object

    + + +
    +
    +
    + +

    Returns:

    +
      + +
    • + + + (Array<Chf>) + + + + — +

      a list of hash types object

      +
      + +
      • + +
    + +
    + + + + +
    + 
    +
+
+65
+66
+67
+68
+69
+70
+71
    +     		+ 
    # File 'lib/haiti.rb', line 65
+
+def object_list
+  (PROTOTYPES.flat_map do |d|
+     d['modes'].map do |m|
+       Chf.new(m)
+     end
+   end).sort { |a, b| a.name.downcase <=> b.name.downcase }.uniq
+end
    +
    +
    + +
    +

    .samples(input) ⇒ Array<String> @@ -611,9 +788,9 @@

    diff --git a/docs/yard/HashIdentifier/Chf.html b/docs/yard/HashIdentifier/Chf.html index cd80602..4441c52 100644 --- a/docs/yard/HashIdentifier/Chf.html +++ b/docs/yard/HashIdentifier/Chf.html @@ -6,7 +6,7 @@ Class: HashIdentifier::Chf - — Documentation by YARD 0.9.28 + — Documentation by YARD 0.9.34 @@ -656,9 +656,9 @@

    diff --git a/docs/yard/Version.html b/docs/yard/Version.html index 0a56253..b1d4a4c 100644 --- a/docs/yard/Version.html +++ b/docs/yard/Version.html @@ -6,7 +6,7 @@ Module: Version - — Documentation by YARD 0.9.28 + — Documentation by YARD 0.9.34 @@ -100,7 +100,7 @@

    VERSION =
    - 
    '1.5.0'
    + 
    '2.0.0'
    @@ -116,9 +116,9 @@

    diff --git a/docs/yard/_index.html b/docs/yard/_index.html index a84afbc..f04fb36 100644 --- a/docs/yard/_index.html +++ b/docs/yard/_index.html @@ -4,7 +4,7 @@ - Documentation by YARD 0.9.28 + Documentation by YARD 0.9.34 @@ -52,7 +52,7 @@
    -

    Documentation by YARD 0.9.28

    +

    Documentation by YARD 0.9.34

    Alphabetic Index

    @@ -128,9 +128,9 @@

    Namespace Listing A-Z

    diff --git a/docs/yard/file.LICENSE.html b/docs/yard/file.LICENSE.html index e9e6811..49981f9 100644 --- a/docs/yard/file.LICENSE.html +++ b/docs/yard/file.LICENSE.html @@ -6,7 +6,7 @@ File: LICENSE - — Documentation by YARD 0.9.28 + — Documentation by YARD 0.9.34 @@ -60,9 +60,9 @@
    The MIT License (MIT)

    Copyright (c) 2020-2022 Alexandre ZANNI (independent)
    Copyright (c) 2019-2020 Alexandre ZANNI at Orange Cyberdefense

    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    THE SOFTWARE.
    diff --git a/docs/yard/file.README.html b/docs/yard/file.README.html index b764e94..4db645c 100644 --- a/docs/yard/file.README.html +++ b/docs/yard/file.README.html @@ -6,7 +6,7 @@ File: README - — Documentation by YARD 0.9.28 + — Documentation by YARD 0.9.34 @@ -76,7 +76,7 @@

    What is it?

    Features

      -
    • 519+ hash types detected
      • +
    • 632+ hash types detected
    • Modern algorithms supported (SHA3, Keccak, Blake2, etc.)
    • Hashcat and John the Ripper references
    • CLI tool & library
      • @@ -99,9 +99,9 @@

      Author

      diff --git a/docs/yard/frames.html b/docs/yard/frames.html index a65e936..4f918f5 100644 --- a/docs/yard/frames.html +++ b/docs/yard/frames.html @@ -2,7 +2,7 @@ - Documentation by YARD 0.9.28 + Documentation by YARD 0.9.34