Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/meehow/securebytes
⚡️ Take any Go data type, serialize it to JSON or GOB and encrypt it with AES. Works 2.5x faster than securecookie and generates 40% smaller cookies.
https://github.com/meehow/securebytes
aes authenticated-encryption cookie encryption securecookie serialization
Last synced: about 2 months ago
JSON representation
⚡️ Take any Go data type, serialize it to JSON or GOB and encrypt it with AES. Works 2.5x faster than securecookie and generates 40% smaller cookies.
- Host: GitHub
- URL: https://github.com/meehow/securebytes
- Owner: meehow
- License: lgpl-3.0
- Created: 2019-01-30T10:44:18.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-04-18T19:54:41.000Z (over 4 years ago)
- Last Synced: 2024-06-19T14:51:52.584Z (7 months ago)
- Topics: aes, authenticated-encryption, cookie, encryption, securecookie, serialization
- Language: Go
- Homepage:
- Size: 23.4 KB
- Stars: 12
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Secure Bytes [](http://godoc.org/github.com/meehow/securebytes) [](https://goreportcard.com/report/github.com/meehow/securebytes#SecureBytes)
Secure Bytes takes any Go data type, serializes it to DER-ASN.1, JSON or GOB and encrypts it with AES-192-GCM.
The goal of this library is to generate smaller cookies than
[securecookie](https://github.com/gorilla/securecookie) does.
It's achieved by using [Authenticated Encryption](https://en.wikipedia.org/wiki/Authenticated_encryption)
instead of HMAC and optionally DER-ASN.1 instead of GOB or JSON.
## Installation
```
go get -u github.com/meehow/securebytes
```
## Usage
First, create Secure Bytes instance and set encryption key.
Suggested key length is at least 50 characters.
You can choose one of build-in serializers: GOBSerializer, JSONSerializer
or ASN1Serializer. Usually ASN1Serializer gives the smallest output, but it's
not compatible with some data types (for example uint).
```go
var sb = securebytes.New(
[]byte("choo}ng-o9quoh6oodurabishoh9haeWee~neeyaRoqu6Chue1"),
securebytes.ASN1Serializer{})
```
Write a cookie:
```go
type Session struct {
UserID int
Name string
}
func SetCookieHandler(w http.ResponseWriter, r *http.Request) {
session := Session{
UserID: 1234567890,
Name: "meehow",
}
b64, err := sb.EncodeToBase64(session)
if err != nil {
fmt.Fprintf(w, "Encryption error: %v", err)
return
}
cookie := &http.Cookie{
Name: "cookie-name",
Value: b64,
Path: "/",
HttpOnly: true,
}
http.SetCookie(w, cookie)
}
```
Read a cookie:
```go
func ReadCookieHandler(w http.ResponseWriter, r *http.Request) {
var session Session
cookie, err := r.Cookie("cookie-name")
if err != nil {
fmt.Fprintf(w, "Cookie not found: %v", err)
return
}
if err = sb.DecryptBase64(cookie.Value, &session); err != nil {
fmt.Fprintf(w, "Decryption error: %v", err)
return
}
fmt.Fprintf(w, "Your session cookie: %#v", session)
}
```
You can also check [example](examples/cookie.go) to see full code of http server.
If you need plain `[]byte` output, you can use `Encrypt` and `Decrypt` functions instead.
You can find more information in the [documentation](https://godoc.org/github.com/meehow/securebytes#SecureBytes).
## Benchmark
SecureBytes works **2.5 times faster** than SecureCookie and generates **40% smaller** cookies.
```
goos: linux
goarch: amd64
pkg: github.com/meehow/securebytes
BenchmarkSecureBytesJSON-4 300000 3810 ns/op
BenchmarkSecureBytesGOB-4 300000 5476 ns/op
BenchmarkSecureCookieJSON-4 200000 9959 ns/op
BenchmarkSecureCookieGOB-4 100000 11807 ns/op
PASS
ok github.com/meehow/securebytes 6.303s
```