# Blot

**Blot** is a command-line interface (CLI) to compute hashes similar to tools
like `shasum` but using a variation of [Ben Laurie's
objecthash](https://github.com/benlaurie/objecthash) combined with
[Multihash](https://github.com/multiformats/multihash).

[![Build Status](https://www.travis-ci.org/arnau/blot.svg?branch=master)](https://www.travis-ci.org/arnau/blot)

Licensed under MIT (See [LICENSE](./LICENSE)).

## Features

Objecthash:

* [x] Tagged types: bool, dict, float, integer, list, null, raw, set, unicode.
* [x] Redacted values with `**REDACTED**`.
* [x] Common JSON (only when compiled with the `common_json` feature flag).

Multihash:

* Hashing algorithms:
  * [x] sha1
  * [x] sha2
  * [x] sha3
  * blake2
    * [x] Maximum length (blake2b-512, blake2s-256)
    * [ ] Partial length.

Custom:

* [x] Redacted values with `0x77`.
* [x] Timestamp tagged type. Note that detection is very rough and it will not
  guarantee a valid time.


## Usage

Compact output:

```
$ blot -a sha2-256 '["foo", "bar"]'
```

<pre style="background-color: #000; font-family: monospace; color: #fff">
<span style="background-color: #ff0087">12</span><span style="background-color: #00afff">20</span><span style="color: #ffd75f">32ae896c413cfdc79eec68be9139c86ded8b279238467c216cf2bec4d5f1e4a2</span>
</pre>

Verbose output:

```
$ blot -a blake2b-512 --verbose '"foo"'
```

<pre style="background-color: #000; font-family: monospace; color: #fff">
<span style="background-color: #ff0087">Codec: </span> 0xb240 (blake2b-512)
<span style="background-color: #00afff">Length:</span> 0x40
<span style="background-color: #ffd75f">Digest:</span> 0x20fb5053ecefc742b73665625613de5ea09917988fac07d2977ece1c9bebb1aa0e5dfe8e3f2ae7b30ac3b97fac511a4745d71f5d4dbb211d69d06b34fb031e60
</pre>

Sequences as sets instead of lists:

```
blot --sequence=set -a sha3-256 '["7716209dec0a5fc4b58a6d2a89c248c8ac845fc2a42ec440ec72f5f1554d3b9507689d", "bar"]'`
1620e689a806ca38fb367f300a83022aa9f1c1ad74fd6f50038f3cb5d253e7cb17c6
```

## See also

* [blot library](blot-lib)