s4pg

Documentation

Index

• func CombineShareFiles(inputPaths []string) error
• func CombineShares(rawShares []Share) ([]byte, error)
• func DecryptCiphertext(ct Ciphertext, password []byte) ([]byte, error)
• func EncodeCiphertext(ciphertext Ciphertext) ([]byte, error)
• func EncodePlaintext(plaintext Plaintext) ([]byte, error)
• func EncodeShare(share Share) ([]byte, error)
• func EncodeShares(shares []Share) ([][]byte, error)
• func ReadPassword(message string) (*memguard.Enclave, error)
• func SplitPlaintextFile(inputPath string, count int, threshold int) error
• func WritePlaintext(pt Plaintext, fdir string) error
• func WriteShares(shares []Share, fpath string) error
• type CipherType
• type Ciphertext
  • func DecodeCiphertext(raw []byte) (Ciphertext, error)
  • func EncryptCiphertext(raw []byte, password []byte) (Ciphertext, error)
• type KDFType
• type Plaintext
  • func DecodePlaintext(raw []byte) (Plaintext, error)
  • func ReadPlaintext(fpath string) (Plaintext, error)
• type Share
  • func DecodeShare(raw []byte) (Share, error)
  • func DecodeShares(rawShares [][]byte) ([]Share, error)
  • func ReadShares(fpaths []string) ([]Share, error)
  • func SplitShares(raw []byte, count int, threshold int) ([]Share, error)

Functions

func CombineShareFiles

func CombineShareFiles(inputPaths []string) error

func CombineShares

func CombineShares(rawShares []Share) ([]byte, error)

func DecryptCiphertext

func DecryptCiphertext(ct Ciphertext, password []byte) ([]byte, error)

func EncodeCiphertext

func EncodeCiphertext(ciphertext Ciphertext) ([]byte, error)

func EncodePlaintext

func EncodePlaintext(plaintext Plaintext) ([]byte, error)

func EncodeShare

func EncodeShare(share Share) ([]byte, error)

func EncodeShares

func EncodeShares(shares []Share) ([][]byte, error)

func ReadPassword

func ReadPassword(message string) (*memguard.Enclave, error)

func SplitPlaintextFile

func SplitPlaintextFile(inputPath string, count int, threshold int) error

func WritePlaintext

func WritePlaintext(pt Plaintext, fdir string) error

func WriteShares

func WriteShares(shares []Share, fpath string) error

Types

type CipherType

type CipherType uint8

const (
	CIPHER_CHACHA20_POLY1305 CipherType = iota
)

type Ciphertext

type Ciphertext struct {
	CipherType CipherType // Cipher type used to encrypt the content
	KDFType    KDFType    // Key derivation function type used to produce the key
	Content    []byte     // Copy of the content, encrypted using a password-derived key
	Salt       []byte     // Salt needed to derive a key from a user-inputted password
	Nonce      []byte     // Nonce needed for the AEAD cipher
}

func DecodeCiphertext

func DecodeCiphertext(raw []byte) (Ciphertext, error)

func EncryptCiphertext

func EncryptCiphertext(raw []byte, password []byte) (Ciphertext, error)

type KDFType

type KDFType uint8

const (
	KDF_PBKDF2_SHA256_I500000 KDFType = iota
)

type Plaintext

type Plaintext struct {
	Content  []byte // Copy of the raw content without any encryption applied
	Filename string // Original filename associated with the content
}

func DecodePlaintext

func DecodePlaintext(raw []byte) (Plaintext, error)

func ReadPlaintext

func ReadPlaintext(fpath string) (Plaintext, error)

type Share

type Share struct {
	CipherType CipherType // Cipher type used to encrypt the content
	Content    []byte     // Copy of the content, encrypted using a randomly generated secret
	KeyShare   []byte     // Actual share needed to regenerate the secret key
	Nonce      []byte     // Nonce needed for the AEAD cipher
}

func DecodeShare

func DecodeShare(raw []byte) (Share, error)

func DecodeShares

func DecodeShares(rawShares [][]byte) ([]Share, error)

func ReadShares

func ReadShares(fpaths []string) ([]Share, error)

func SplitShares

func SplitShares(raw []byte, count int, threshold int) ([]Share, error)