README
¶
kit/securestring
github.com/vormadev/vorma/kit/securestring
String-oriented encryption wrapper over kit/securebytes.
It serializes a value to encrypted bytes and returns base64 text, which is useful for cookies, headers, and JSON fields.
Import
import "github.com/vormadev/vorma/kit/securestring"
Quick Start
keys := getKeyset() // *keyset.Keyset
sealed, err := securestring.Serialize(keys, map[string]string{"uid": "u-1"})
if err != nil {
return err
}
payload, err := securestring.Parse[map[string]string](keys, sealed)
if err != nil {
return err
}
_ = payload
Relationship to securebytes
securebytesis the core crypto/serialization layer.securestringadds base64 encoding/decoding.
Inherited behavior from securebytes:
- key rotation support via ordered keysets
- ciphertext integrity checks
- gob serialization constraints (for example concrete type registration for interface payloads)
Size Limits
MaxBase64Sizeis the maximum accepted encoded input size forParse.- Empty input is rejected.
- Oversized base64 input is rejected before decode.
- Invalid base64 input returns an error.
MaxBase64Size is derived from securebytes.MaxSize using base64 expansion
math.
API Reference
const MaxBase64Sizetype SecureString stringfunc Serialize(ks *keyset.Keyset, rv securebytes.RawValue) (SecureString, error)func Parse[T any](ks *keyset.Keyset, ss SecureString) (T, error)
Documentation
¶
Overview ¶
This package assumes that the caller's use case is not sensitive to timing attacks. In other words, it assumes that, even if an attacker can figure out the current index of the secret key originally used to encrypt the data, that information would not be materially useful to them. This is a reasonable assumption for most use cases. This is a light base64 wrapper over the "securebytes" package.
Index ¶
Constants ¶
const MaxBase64Size = ((securebytes.MaxSize + 2) / 3) * 4
Variables ¶
This section is empty.
Functions ¶
Types ¶
type SecureString ¶
type SecureString string // Base64-encoded, encrypted value
func Serialize ¶
func Serialize(ks *keyset.Keyset, rv securebytes.RawValue) (SecureString, error)
Source Files