siv

README

AES-GCM-SIV

Nonce misuse-resistant AEAD

• https://datatracker.ietf.org/doc/html/rfc8452
• https://eprint.iacr.org/2017/168.pdf
• https://eprint.iacr.org/2015/102.pdf

Installation

go get github.com/ericlagergren/siv@latest

Performance

TBD

Security

Disclosure

This project uses full disclosure. If you find a security bug in an implementation, please e-mail me or create a GitHub issue.

Disclaimer

You should only use cryptography libraries that have been reviewed by cryptographers or cryptography engineers. While I am a cryptography engineer, I'm not your cryptography engineer, and I have not had this project reviewed by any other cryptographers.

Documentation

Overview

Package siv implements AES-GCM-SIV per RFC 8452.

Index

• Constants
• func NewGCM(key []byte) (cipher.AEAD, error)

Constants

const (
	// NonceSize is the size in bytes of an AES-GCM-SIV nonce.
	NonceSize = 12
	// TagSize is the size in bytes of an AES-GCM-SIV
	// authentication tag.
	TagSize = 16
	// MaxPlaintextSize is the size in bytes of the largest
	// allowed plaintext.
	MaxPlaintextSize = 1 << 36
	// MaxAdditionalDataSize is the size in bytes of the largest
	// allowed additional authenticated data.
	MaxAdditionalDataSize = 1 << 36
)

Functions

func NewGCM

func NewGCM(key []byte) (cipher.AEAD, error)

NewGCM creates an instance of AES-GCM-SIV.

The key must be either 16 bytes for 128-bit AES-GCM-SIV or 32 bytes for 256-bit AES-GCM-SIV. All other lengths are an error.