cipher

README

pki

Helper to generate public/private keys, and encrypt/decrypt data by aes/rsa

Documentation

Overview

Package cipher is the legacy import path for core-owned cipher contracts.

New code should import the focused replacement package:

import "github.com/InsideGallery/core/pki/cryptor"

Compatibility: existing cipher contracts remain available for downstream consumers that still import pki. Do not add new cipher boundary helpers here; add them to pki/cryptor so call sites avoid a local name collision with crypto/cipher.

Index

• Variables
• type Cipher
• type Options
• type Result
  • func Decrypt(ctx context.Context, c Cipher, ciphertext []byte) (Result, error)
  • func Encrypt(ctx context.Context, c Cipher, plaintext []byte) (Result, error)

Variables

var ErrCipherNotSet = errors.New("cipher is not set")

ErrCipherNotSet reports a nil cipher dependency.

Types

type Cipher

type Cipher interface {
	Encrypt([]byte) ([]byte, error)
	Decrypt([]byte) ([]byte, error)

	Kind() string
	ToBinary() ([]byte, error)
	FromBinary([]byte) (Cipher, error)
}

type Options

type Options struct {
	Kind string
}

Options identifies the cipher behavior requested by a consumer.

type Result

type Result struct {
	Kind string
	Data []byte
}

Result is the core-owned result shape for cipher operations.

func Decrypt

func Decrypt(ctx context.Context, c Cipher, ciphertext []byte) (Result, error)

Decrypt decrypts ciphertext through a Cipher without exposing implementation-specific result types.

func Encrypt

func Encrypt(ctx context.Context, c Cipher, plaintext []byte) (Result, error)

Encrypt encrypts plaintext through a Cipher without exposing implementation-specific result types.