Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/schultz-is/go-threefish
An implementation of the Threefish block cipher entirely in go with no external dependencies.
https://github.com/schultz-is/go-threefish
block-cipher block-ciphers crypto cryptography threefish
Last synced: about 1 month ago
JSON representation
An implementation of the Threefish block cipher entirely in go with no external dependencies.
- Host: GitHub
- URL: https://github.com/schultz-is/go-threefish
- Owner: schultz-is
- License: isc
- Created: 2020-07-19T22:50:08.000Z (over 4 years ago)
- Default Branch: trunk
- Last Pushed: 2021-09-30T17:47:36.000Z (about 3 years ago)
- Last Synced: 2024-06-21T11:03:01.257Z (6 months ago)
- Topics: block-cipher, block-ciphers, crypto, cryptography, threefish
- Language: Go
- Homepage:
- Size: 45.9 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-threefish
[](https://pkg.go.dev/github.com/schultz-is/go-threefish)
[](https://goreportcard.com/report/github.com/schultz-is/go-threefish)
[](./LICENSE)
Threefish is a tweakable block cipher that was developed as part of the Skein
hash function as a submission to the NIST hash function competition. Threefish
supports block sizes of 256, 512, and 1024 bits.
The full Threefish specification is available in the footnotes[^1].
Test vectors were extracted from the latest reference implementation[^2].
Encryption and decryption loops have been unrolled to contain eight rounds in
each iteration. This allows rotation constants to be embedded in the code
without being repeated. This practice is described in detail in the paper[^1]
which also provides detailed performance information.
[^1]: http://www.skein-hash.info/sites/default/files/skein1.3.pdf
[^2]: http://www.skein-hash.info/sites/default/files/NIST_CD_102610.zip
## Installation
To install as a dependency in a go project:
```console
go get -U github.com/schultz-is/go-threefish
```
## Usage
The cipher implementations in this package fulfill the `crypto/cipher`
`cipher.Block` interface. Instances returned by this library can be used with
any block ciphers modes that support 256, 512, or 1024-bit block sizes.
```go
package main
import (
"crypto/cipher"
"crypto/rand"
"fmt"
"github.com/schultz-is/go-threefish"
)
func main() {
message := make([]byte, 128)
copy(message, []byte("secret message"))
// Assign a key. Generally this is derived from a known secret value. Often
// a passphrase is derived using a key derivation function such as PBKDF2.
key := make([]byte, 128)
_, err := rand.Read(key)
if err != nil {
panic(err)
}
// Assign a tweak value. This allows customization of the block cipher as in
// the UBI block chaining mode. Support for the tweak value is not available
// in the block ciphers modes supported by the standard library.
tweak := make([]byte, 16)
_, err = rand.Read(tweak)
if err != nil {
panic(err)
}
// Instantiate and initialize a block cipher.
block, err := threefish.New1024(key, tweak)
if err != nil {
panic(err)
}
// When using CBC mode, the IV needs to be unique but does not need to be
// secure. For this reason, it can be prepended to the ciphertext.
ciphertext := make([]byte, block.BlockSize()+len(message))
iv := ciphertext[:block.BlockSize()]
_, err = rand.Read(iv)
if err != nil {
panic(err)
}
mode := cipher.NewCBCEncrypter(block, iv)
mode.CryptBlocks(ciphertext[block.BlockSize():], message)
fmt.Printf("%x\n", ciphertext)
}
```
## Testing
Unit tests can be run and test coverage can be viewed via the provided Makefile.
```console
make test
make cover
```
## Benchmarking
Benchmarks can be run and CPU and memory profiles can be generated via the
provided Makefile.
```console
make benchmark
go tool pprof cpu.prof
go tool pprof mem.prof
```
## Performance
### 2020 Mac Mini M1
```console
name time/op speed
Threefish256/encrypt-8 85 ns 372 MB/s
Threefish256/decrypt-8 111 ns 287 MB/s
Threefish512/encrypt-8 234 ns 272 MB/s
Threefish512/decrypt-8 363 ns 175 MB/s
Threefish1024/encrypt-8 581 ns 220 MB/s
Threefish1024/decrypt-8 685 ns 186 MB/s
```
### 2019 MacBook Pro 2.3GHz Intel i9
```console
name time/op speed
Threefish256/encrypt-16 124 ns 259 MB/s
Threefish256/decrypt-16 156 ns 206 MB/s
Threefish512/encrypt-16 338 ns 189 MB/s
Threefish512/decrypt-16 310 ns 206 MB/s
Threefish1024/encrypt-16 804 ns 159 MB/s
Threefish1024/decrypt-16 778 ns 165 MB/s
```