Installation • Usage example • Benchmarks • Build Status • License
branca.go is branca token specification implementation for Golang 1.15+.
Features and benefits:
- Pure Go implementation;
- No third-party dependencies at all;
- 100% code coverage;
- Fuzz tests.
Installation
Make sure you have a working Go 1.16+ workspace (instructions), then:
go get pkg.re/essentialkaos/branca.v1
For update to latest stable release, do:
go get -u pkg.re/essentialkaos/branca.v1
Usage example
package main
import (
"fmt"
"pkg.re/essentialkaos/branca.v1"
)
func main() {
key := "abcd1234abcd1234abcd1234abcd1234"
brc, err := branca.NewBranca([]byte(key))
if err != nil {
fmt.Printf("Error: %v\n", err)
return
}
payload := "MySuperSecretData"
token, err := brc.EncodeToString([]byte(payload))
if err != nil {
fmt.Printf("Error: %v\n", err)
return
}
fmt.Printf("Token: %s\n", token)
}
Benchmarks
You can run benchmarks by yourself using make bench command.
BrancaSuite.BenchmarkBase62Decoding 1000000 1046 ns/op 384 B/op 6 allocs/op
BrancaSuite.BenchmarkBase62Encoding 1000000 1913 ns/op 512 B/op 6 allocs/op
BrancaSuite.BenchmarkBrancaDecoding 5000000 373 ns/op 48 B/op 2 allocs/op
BrancaSuite.BenchmarkBrancaDecodingFromString 1000000 1463 ns/op 432 B/op 8 allocs/op
BrancaSuite.BenchmarkBrancaEncoding 1000000 1677 ns/op 208 B/op 4 allocs/op
BrancaSuite.BenchmarkBrancaEncodingToString 500000 3977 ns/op 720 B/op 10 allocs/op
Build Status
| Branch | Status |
|---|---|
master |
 |
develop |
 |
