Fast and memory-efficient streaming hash functions. Performs direct hashing of strings, raw bytes, and files potentially larger than memory, as well as hashing in-memory objects through R’s serialization mechanism, without requiring allocation of the serialized object.

Implementations include the SHA-256 and SHA-3 cryptographic hash functions, SHAKE256 extendable-output function (XOF), and ‘SipHash’ pseudo-random function.

The SHA-3 Secure Hash Standard was published by the National Institute of Standards and Technology (NIST) in 2015 at doi:10.6028/NIST.FIPS.202. The SHA-256 Secure Hash Standard was published by NIST in 2002 at https://csrc.nist.gov/publications/fips/fips180-2/fips180-2.pdf. The SipHash family of pseudo-random functions by Jean-Philippe Aumasson and Daniel J. Bernstein was published in 2012 at https://ia.cr/2012/351.^{[1]}

The SHA-256 and SHA-3 implementations are based on those by the ‘Mbed TLS’ Trusted Firmware Project at https://www.trustedfirmware.org/projects/mbed-tls. The SipHash implementation is based on that of Daniele Nicolodi, David Rheinsberg and Tom Gundersen at https://github.com/c-util/c-siphash, which is in turn based on the reference implementation by Jean-Philippe Aumasson and Daniel J. Bernstein released to the public domain at https://github.com/veorq/SipHash.

Install the latest version from CRAN:

`install.packages("secretbase")`

Or the development version from R-universe:

`install.packages("secretbase", repos = "https://shikokuchuo.r-universe.dev")`

- For the SHA-3 cryptographic hash algorithm, specify ‘bits’ as
`224`

,`256`

,`384`

or`512`

- For the SHAKE256 extendable-output function (XOF), specify any other bit length

```
sha3("secret base")
#> [1] "a721d57570e7ce366adee2fccbe9770723c6e3622549c31c7cab9dbb4a795520"
sha3("secret base", convert = FALSE)
#> [1] a7 21 d5 75 70 e7 ce 36 6a de e2 fc cb e9 77 07 23 c6 e3 62 25 49 c3 1c 7c
#> [26] ab 9d bb 4a 79 55 20
sha3("秘密の基地の中", bits = 512)
#> [1] "e30cdc73f6575c40d55b5edc8eb4f97940f5ca491640b41612e02a05f3e59dd9c6c33f601d8d7a8e2ca0504b8c22f7bc69fa8f10d7c01aab392781ff4ae1e610"
```

- Character strings and raw vectors (without attributes) are hashed ‘as is’
- Other objects are hashed using memory-efficient ‘streaming’ serialization, without allocation of the serialized object
- Portable as always uses R serialization version 3 big-endian representation, skipping headers (which contain R version and native encoding information)

```
sha3(data.frame(a = 1, b = 2), bits = 160)
#> [1] "bc5a411f87ef083296c60d6557f189b62ff9e7e6"
sha3(NULL)
#> [1] "b3e37e4c5def1bfb2841b79ef8503b83d1fed46836b5b913d7c16de92966dcee"
```

- Specify ‘convert’ as
`NA`

(and ‘bits’ as`32`

for a single integer value) - May be supplied as deterministic random seeds for R’s pseudo random number generators (RNGs)

```
sha3("秘密の基地の中", bits = 384, convert = NA)
#> [1] 1421990570 338241144 1760362273 -1213241427 1313032644 -1154474231
#> [7] 1041052480 697347630 -1488396834 -917712316 1835427495 2044829552
sha3("秘密の基地の中", bits = 32, convert = NA)
#> [1] 2000208511
```

For use in parallel computing, this is a valid method for reducing to a negligible probability that RNGs in each process may overlap. This may be especially suitable when first-best alternatives such as using recursive streams are too expensive or unable to preserve reproducibility. ^{[2]}

[1] Jean-Philippe Aumasson and Daniel J. Bernstein (2012), *“SipHash: a fast short-input PRF”*, Paper 2012/351, Cryptology ePrint Archive, https://ia.cr/2012/351.

[2] Pierre L’Ecuyer, David Munger, Boris Oreshkin and Richard Simard (2017), *“Random numbers for parallel computers: Requirements and methods, with emphasis on GPUs”*, Mathematics and Computers in Simulation, Vol. 135, May 2017, pp. 3-17 doi:10.1016/j.matcom.2016.05.00.

Links:

◈ secretbase R package: https://shikokuchuo.net/secretbase/

Mbed TLS website: https://www.trustedfirmware.org/projects/mbed-tls

SipHash streaming implementation: https://github.com/c-util/c-siphash

SipHash reference implementation: https://github.com/veorq/SipHash

–

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.