sframe

README

SFrame

This project implements SFrame. It is meant to be a reference implementation only and is NOT meant for production use.

Documentation

Index

• type AesCtr128HmacSha256Tag32Encryptor
  • func (e AesCtr128HmacSha256Tag32Encryptor) Decrypt(key, nonce, aad, ciphertext []byte) ([]byte, error)
  • func (e AesCtr128HmacSha256Tag32Encryptor) Encrypt(key, nonce, aad, plaintext []byte) ([]byte, error)
  • func (e AesCtr128HmacSha256Tag32Encryptor) Nk() int
  • func (e AesCtr128HmacSha256Tag32Encryptor) Nn() int
  • func (e AesCtr128HmacSha256Tag32Encryptor) Nt() int
• type AesCtr128HmacSha256Tag32Suite
  • func (s AesCtr128HmacSha256Tag32Suite) AEAD() Encryptor
  • func (s AesCtr128HmacSha256Tag32Suite) Hash() func() hash.Hash
  • func (s AesCtr128HmacSha256Tag32Suite) ID() uint16
• type AesCtr128HmacSha256Tag64Encryptor
  • func (e AesCtr128HmacSha256Tag64Encryptor) Decrypt(key, nonce, aad, ciphertext []byte) ([]byte, error)
  • func (e AesCtr128HmacSha256Tag64Encryptor) Encrypt(key, nonce, aad, plaintext []byte) ([]byte, error)
  • func (e AesCtr128HmacSha256Tag64Encryptor) Nk() int
  • func (e AesCtr128HmacSha256Tag64Encryptor) Nn() int
  • func (e AesCtr128HmacSha256Tag64Encryptor) Nt() int
• type AesCtr128HmacSha256Tag64Suite
  • func (s AesCtr128HmacSha256Tag64Suite) AEAD() Encryptor
  • func (s AesCtr128HmacSha256Tag64Suite) Hash() func() hash.Hash
  • func (s AesCtr128HmacSha256Tag64Suite) ID() uint16
• type AesCtr128HmacSha256Tag80Encryptor
  • func (e AesCtr128HmacSha256Tag80Encryptor) Decrypt(key, nonce, aad, ciphertext []byte) ([]byte, error)
  • func (e AesCtr128HmacSha256Tag80Encryptor) Encrypt(key, nonce, aad, plaintext []byte) ([]byte, error)
  • func (e AesCtr128HmacSha256Tag80Encryptor) Nk() int
  • func (e AesCtr128HmacSha256Tag80Encryptor) Nn() int
  • func (e AesCtr128HmacSha256Tag80Encryptor) Nt() int
• type AesCtr128HmacSha256Tag80Suite
  • func (s AesCtr128HmacSha256Tag80Suite) AEAD() Encryptor
  • func (s AesCtr128HmacSha256Tag80Suite) Hash() func() hash.Hash
  • func (s AesCtr128HmacSha256Tag80Suite) ID() uint16
• type AesGcm128Sha256Tag128Encryptor
  • func (e AesGcm128Sha256Tag128Encryptor) Decrypt(key, nonce, aad, ciphertext []byte) ([]byte, error)
  • func (e AesGcm128Sha256Tag128Encryptor) Encrypt(key, nonce, aad, plaintext []byte) ([]byte, error)
  • func (e AesGcm128Sha256Tag128Encryptor) Nk() int
  • func (e AesGcm128Sha256Tag128Encryptor) Nn() int
  • func (e AesGcm128Sha256Tag128Encryptor) Nt() int
• type AesGcm128Sha256Tag128Suite
  • func (s AesGcm128Sha256Tag128Suite) AEAD() Encryptor
  • func (s AesGcm128Sha256Tag128Suite) Hash() func() hash.Hash
  • func (s AesGcm128Sha256Tag128Suite) ID() uint16
• type AesGcm256Sha256Tag128Encryptor
  • func (e AesGcm256Sha256Tag128Encryptor) Decrypt(key, nonce, aad, ciphertext []byte) ([]byte, error)
  • func (e AesGcm256Sha256Tag128Encryptor) Encrypt(key, nonce, aad, plaintext []byte) ([]byte, error)
  • func (e AesGcm256Sha256Tag128Encryptor) Nk() int
  • func (e AesGcm256Sha256Tag128Encryptor) Nn() int
  • func (e AesGcm256Sha256Tag128Encryptor) Nt() int
• type AesGcm256Sha512Tag128Suite
  • func (s AesGcm256Sha512Tag128Suite) AEAD() Encryptor
  • func (s AesGcm256Sha512Tag128Suite) Hash() func() hash.Hash
  • func (s AesGcm256Sha512Tag128Suite) ID() uint16
• type Ciphersuite
  • func NewCiphersuite(id uint16) (Ciphersuite, error)
• type Encryptor
• type SFramer
  • func (f SFramer) Decrypt(metadata []byte, sframeCiphertext []byte) ([]byte, error)
  • func (f SFramer) Encrypt(ctr uint64, kid uint64, metadata []byte, plaintext []byte) ([]byte, error)
• type SFramerKey
  • func NewSFramerKey(kid uint64, baseKey []byte, s Ciphersuite) (SFramerKey, error)

Types

type AesCtr128HmacSha256Tag32Encryptor

type AesCtr128HmacSha256Tag32Encryptor struct {
}

https://sframe-wg.github.io/sframe/draft-ietf-sframe-enc.html#name-cipher-suites

func (AesCtr128HmacSha256Tag32Encryptor) Decrypt

func (e AesCtr128HmacSha256Tag32Encryptor) Decrypt(key, nonce, aad, ciphertext []byte) ([]byte, error)

func (AesCtr128HmacSha256Tag32Encryptor) Encrypt

func (e AesCtr128HmacSha256Tag32Encryptor) Encrypt(key, nonce, aad, plaintext []byte) ([]byte, error)

func (AesCtr128HmacSha256Tag32Encryptor) Nk

func (e AesCtr128HmacSha256Tag32Encryptor) Nk() int

func (AesCtr128HmacSha256Tag32Encryptor) Nn

func (e AesCtr128HmacSha256Tag32Encryptor) Nn() int

func (AesCtr128HmacSha256Tag32Encryptor) Nt

func (e AesCtr128HmacSha256Tag32Encryptor) Nt() int

type AesCtr128HmacSha256Tag32Suite

type AesCtr128HmacSha256Tag32Suite struct {
}

func (AesCtr128HmacSha256Tag32Suite) AEAD

func (s AesCtr128HmacSha256Tag32Suite) AEAD() Encryptor

func (AesCtr128HmacSha256Tag32Suite) Hash

func (s AesCtr128HmacSha256Tag32Suite) Hash() func() hash.Hash

func (AesCtr128HmacSha256Tag32Suite) ID

func (s AesCtr128HmacSha256Tag32Suite) ID() uint16

type AesCtr128HmacSha256Tag64Encryptor

type AesCtr128HmacSha256Tag64Encryptor struct {
}

https://sframe-wg.github.io/sframe/draft-ietf-sframe-enc.html#name-cipher-suites

func (AesCtr128HmacSha256Tag64Encryptor) Decrypt

func (e AesCtr128HmacSha256Tag64Encryptor) Decrypt(key, nonce, aad, ciphertext []byte) ([]byte, error)

func (AesCtr128HmacSha256Tag64Encryptor) Encrypt

func (e AesCtr128HmacSha256Tag64Encryptor) Encrypt(key, nonce, aad, plaintext []byte) ([]byte, error)

func (AesCtr128HmacSha256Tag64Encryptor) Nk

func (e AesCtr128HmacSha256Tag64Encryptor) Nk() int

func (AesCtr128HmacSha256Tag64Encryptor) Nn

func (e AesCtr128HmacSha256Tag64Encryptor) Nn() int

func (AesCtr128HmacSha256Tag64Encryptor) Nt

func (e AesCtr128HmacSha256Tag64Encryptor) Nt() int

type AesCtr128HmacSha256Tag64Suite

type AesCtr128HmacSha256Tag64Suite struct {
}

func (AesCtr128HmacSha256Tag64Suite) AEAD

func (s AesCtr128HmacSha256Tag64Suite) AEAD() Encryptor

func (AesCtr128HmacSha256Tag64Suite) Hash

func (s AesCtr128HmacSha256Tag64Suite) Hash() func() hash.Hash

func (AesCtr128HmacSha256Tag64Suite) ID

func (s AesCtr128HmacSha256Tag64Suite) ID() uint16

type AesCtr128HmacSha256Tag80Encryptor

type AesCtr128HmacSha256Tag80Encryptor struct {
}

https://sframe-wg.github.io/sframe/draft-ietf-sframe-enc.html#name-cipher-suites

func (AesCtr128HmacSha256Tag80Encryptor) Decrypt

func (e AesCtr128HmacSha256Tag80Encryptor) Decrypt(key, nonce, aad, ciphertext []byte) ([]byte, error)

func (AesCtr128HmacSha256Tag80Encryptor) Encrypt

func (e AesCtr128HmacSha256Tag80Encryptor) Encrypt(key, nonce, aad, plaintext []byte) ([]byte, error)

func (AesCtr128HmacSha256Tag80Encryptor) Nk

func (e AesCtr128HmacSha256Tag80Encryptor) Nk() int

func (AesCtr128HmacSha256Tag80Encryptor) Nn

func (e AesCtr128HmacSha256Tag80Encryptor) Nn() int

func (AesCtr128HmacSha256Tag80Encryptor) Nt

func (e AesCtr128HmacSha256Tag80Encryptor) Nt() int

type AesCtr128HmacSha256Tag80Suite

type AesCtr128HmacSha256Tag80Suite struct {
}

func (AesCtr128HmacSha256Tag80Suite) AEAD

func (s AesCtr128HmacSha256Tag80Suite) AEAD() Encryptor

func (AesCtr128HmacSha256Tag80Suite) Hash

func (s AesCtr128HmacSha256Tag80Suite) Hash() func() hash.Hash

func (AesCtr128HmacSha256Tag80Suite) ID

func (s AesCtr128HmacSha256Tag80Suite) ID() uint16

type AesGcm128Sha256Tag128Encryptor

type AesGcm128Sha256Tag128Encryptor struct {
}

https://sframe-wg.github.io/sframe/draft-ietf-sframe-enc.html#name-cipher-suites

func (AesGcm128Sha256Tag128Encryptor) Decrypt

func (e AesGcm128Sha256Tag128Encryptor) Decrypt(key, nonce, aad, ciphertext []byte) ([]byte, error)

func (AesGcm128Sha256Tag128Encryptor) Encrypt

func (e AesGcm128Sha256Tag128Encryptor) Encrypt(key, nonce, aad, plaintext []byte) ([]byte, error)

func (AesGcm128Sha256Tag128Encryptor) Nk

func (e AesGcm128Sha256Tag128Encryptor) Nk() int

func (AesGcm128Sha256Tag128Encryptor) Nn

func (e AesGcm128Sha256Tag128Encryptor) Nn() int

func (AesGcm128Sha256Tag128Encryptor) Nt

func (e AesGcm128Sha256Tag128Encryptor) Nt() int

type AesGcm128Sha256Tag128Suite

type AesGcm128Sha256Tag128Suite struct {
}

func (AesGcm128Sha256Tag128Suite) AEAD

func (s AesGcm128Sha256Tag128Suite) AEAD() Encryptor

func (AesGcm128Sha256Tag128Suite) Hash

func (s AesGcm128Sha256Tag128Suite) Hash() func() hash.Hash

func (AesGcm128Sha256Tag128Suite) ID

func (s AesGcm128Sha256Tag128Suite) ID() uint16

type AesGcm256Sha256Tag128Encryptor

type AesGcm256Sha256Tag128Encryptor struct {
}

https://sframe-wg.github.io/sframe/draft-ietf-sframe-enc.html#name-cipher-suites

func (AesGcm256Sha256Tag128Encryptor) Decrypt

func (e AesGcm256Sha256Tag128Encryptor) Decrypt(key, nonce, aad, ciphertext []byte) ([]byte, error)

func (AesGcm256Sha256Tag128Encryptor) Encrypt

func (e AesGcm256Sha256Tag128Encryptor) Encrypt(key, nonce, aad, plaintext []byte) ([]byte, error)

func (AesGcm256Sha256Tag128Encryptor) Nk

func (e AesGcm256Sha256Tag128Encryptor) Nk() int

func (AesGcm256Sha256Tag128Encryptor) Nn

func (e AesGcm256Sha256Tag128Encryptor) Nn() int

func (AesGcm256Sha256Tag128Encryptor) Nt

func (e AesGcm256Sha256Tag128Encryptor) Nt() int

type AesGcm256Sha512Tag128Suite

type AesGcm256Sha512Tag128Suite struct {
}

func (AesGcm256Sha512Tag128Suite) AEAD

func (s AesGcm256Sha512Tag128Suite) AEAD() Encryptor

func (AesGcm256Sha512Tag128Suite) Hash

func (s AesGcm256Sha512Tag128Suite) Hash() func() hash.Hash

func (AesGcm256Sha512Tag128Suite) ID

func (s AesGcm256Sha512Tag128Suite) ID() uint16

type Ciphersuite

type Ciphersuite interface {
	AEAD() Encryptor
	Hash() func() hash.Hash
	ID() uint16
}

func NewCiphersuite

func NewCiphersuite(id uint16) (Ciphersuite, error)

type Encryptor

type Encryptor interface {
	Encrypt(key, nonce, aad, plaintext []byte) ([]byte, error)
	Decrypt(key, nonce, aad, ciphertext []byte) ([]byte, error)
	Nk() int
	Nn() int
	Nt() int
}

type SFramer

type SFramer struct {
	// contains filtered or unexported fields
}

func (SFramer) Decrypt

func (f SFramer) Decrypt(metadata []byte, sframeCiphertext []byte) ([]byte, error)

func (SFramer) Encrypt

func (f SFramer) Encrypt(ctr uint64, kid uint64, metadata []byte, plaintext []byte) ([]byte, error)

type SFramerKey

type SFramerKey struct {
	// contains filtered or unexported fields
}

func NewSFramerKey

func NewSFramerKey(kid uint64, baseKey []byte, s Ciphersuite) (SFramerKey, error)