generic

Documentation

Index

• Variables
• func AllZero(s []byte) bool
• func CSPRNG(n int64) ([]byte, error)
• func CSPRNGHex(n int64) (string, error)
• func Compare(x, y []byte) bool
• func CompareString(x, y string) bool
• func Delete(targetPath string, cycle int) error
• func FileWalkByName(startPath, name string) ([]string, error)
• func HWRng(n int64) ([]byte, error)
• func IsRepeatingSequence(key []byte) bool
• func Overwrite(targetPath string, data []byte, cycle int) error
• func Rand() io.Reader
• func ReadFileContent(path string) ([]byte, error)
• func StrCnct(str ...string) string
• func WriteAndFlush(file *os.File, rnd []byte) (n int, err error)
• type Base32
  • func (b *Base32) Decode(data string) ([]byte, error)
  • func (b *Base32) Encode(data []byte) string
  • func (b *Base32) GetName() string
• type Base64
  • func (b *Base64) Decode(data string) ([]byte, error)
  • func (b *Base64) Encode(data []byte) string
  • func (b *Base64) GetName() string
• type Custom
  • func (c *Custom) Decode(data string) ([]byte, error)
  • func (c *Custom) Encode(data []byte) string
  • func (c *Custom) GetName() string
• type Encoder
• type Hex
  • func (h *Hex) Decode(data string) ([]byte, error)
  • func (h *Hex) Encode(data []byte) string
  • func (h *Hex) GetName() string
• type ImportExport
• type PKCS
  • func (e *PKCS) Export() error
  • func (e *PKCS) Import() error
• type PKIX
  • func (e *PKIX) Export() error
  • func (e *PKIX) Import() error
• type PaddinglessBase32
  • func (b *PaddinglessBase32) Decode(data string) ([]byte, error)
  • func (b *PaddinglessBase32) Encode(data []byte) string
  • func (b *PaddinglessBase32) GetName() string
• type RawBase64
  • func (b *RawBase64) Decode(data string) ([]byte, error)
  • func (b *RawBase64) Encode(data []byte) string
  • func (b *RawBase64) GetName() string
• type RawURLBase64
  • func (b *RawURLBase64) Decode(data string) ([]byte, error)
  • func (b *RawURLBase64) Encode(data []byte) string
  • func (b *RawURLBase64) GetName() string
• type URLBase64
  • func (b *URLBase64) Decode(data string) ([]byte, error)
  • func (b *URLBase64) Encode(data []byte) string
  • func (b *URLBase64) GetName() string

Variables

var ErrCustomEncoderIsNil = errors.New("custom encoder is nil")

Functions

func AllZero

func AllZero(s []byte) bool

AllZero checks if all bytes in a slice are zero.

func CSPRNG

func CSPRNG(n int64) ([]byte, error)

CSPRNG is a cryptographically secure pseudo-random number generator for byte slices.

func CSPRNGHex

func CSPRNGHex(n int64) (string, error)

CSPRNGHex is a CSPRNG in hex format.

func Compare

func Compare(x, y []byte) bool

func CompareString

func CompareString(x, y string) bool

func Delete

func Delete(targetPath string, cycle int) error

Secure way to delete file.

func FileWalkByName

func FileWalkByName(startPath, name string) ([]string, error)

func HWRng

func HWRng(n int64) ([]byte, error)

HWRng is a hardware random number generator.

func IsRepeatingSequence

func IsRepeatingSequence(key []byte) bool

func Overwrite

func Overwrite(targetPath string, data []byte, cycle int) error

Secure way to overwrite file.

func Rand

func Rand() io.Reader

func ReadFileContent

func ReadFileContent(path string) ([]byte, error)

func StrCnct

func StrCnct(str ...string) string

StrCnct concatenates strings into one Example: StrCnct([]string{"a", "b", "c"}...) -> "abc".

func WriteAndFlush

func WriteAndFlush(file *os.File, rnd []byte) (n int, err error)

Types

type Base32

type Base32 struct{}

func (*Base32) Decode

func (b *Base32) Decode(data string) ([]byte, error)

func (*Base32) Encode

func (b *Base32) Encode(data []byte) string

func (*Base32) GetName

func (b *Base32) GetName() string

type Base64

type Base64 struct{}

StdEncoding is the standard base64 encoding, as defined in RFC 4648.

func (*Base64) Decode

func (b *Base64) Decode(data string) ([]byte, error)

func (*Base64) Encode

func (b *Base64) Encode(data []byte) string

func (*Base64) GetName

func (b *Base64) GetName() string

type Custom

type Custom struct {
	Encoder func([]byte) string
	Decoder func(string) ([]byte, error)
}

func (*Custom) Decode

func (c *Custom) Decode(data string) ([]byte, error)

func (*Custom) Encode

func (c *Custom) Encode(data []byte) string

func (*Custom) GetName

func (c *Custom) GetName() string

type Encoder

type Encoder interface {
	Encode([]byte) string
	Decode(string) ([]byte, error)
	GetName() string
}

type Hex

type Hex struct{}

func (*Hex) Decode

func (h *Hex) Decode(data string) ([]byte, error)

func (*Hex) Encode

func (h *Hex) Encode(data []byte) string

func (*Hex) GetName

func (h *Hex) GetName() string

type ImportExport

type ImportExport interface {
	Import() error
	Export() error
}

type PKCS

type PKCS struct {
	SecretKey  ed25519.PrivateKey
	ImportData string
	ExportData string
	Encoder    Encoder
}

func (*PKCS) Export

func (e *PKCS) Export() error

struct PKCS SecretKey (ed25519.PrivateKey) -> struct PKCS ExportData (string).

func (*PKCS) Import

func (e *PKCS) Import() error

struct PKCS ImportData (string) -> struct PKCS SecretKey (ed25519.PrivateKey).

type PKIX

type PKIX struct {
	PublicKey       ed25519.PublicKey
	ImportData      string
	ExportData      string
	ExportPublicKey crypto.PublicKey
	Encoder         Encoder
}

PKIX is a generic struct for import and export Ed25519 public key One way to import: 1. ImportData (string) -> PublicKey (ed25519.PublicKey) Two ways to export: 1. PublicKey (ed25519.PublicKey) -> ExportData (string) 2. ExportPublicKey (crypto.PublicKey) -> ExportData (string).

func (*PKIX) Export

func (e *PKIX) Export() error

Two ways to export: 1. struct PKIX PublicKey (ed25519.PublicKey) -> struct PKIX ExportData (string) 2. struct PKIX ExportPublicKey (crypto.PublicKey) -> struct PKIX ExportData (string).

func (*PKIX) Import

func (e *PKIX) Import() error

struct PKIX ImportData (string) -> struct PKIX PublicKey (ed25519.PublicKey).

type PaddinglessBase32

type PaddinglessBase32 struct{}

func (*PaddinglessBase32) Decode

func (b *PaddinglessBase32) Decode(data string) ([]byte, error)

func (*PaddinglessBase32) Encode

func (b *PaddinglessBase32) Encode(data []byte) string

func (*PaddinglessBase32) GetName

func (b *PaddinglessBase32) GetName() string

type RawBase64

type RawBase64 struct{}

nolint: lll RawStdEncoding is the standard raw, unpadded base64 encoding, as defined in RFC 4648 section 3.2. This is the same as StdEncoding but omits padding characters.

func (*RawBase64) Decode

func (b *RawBase64) Decode(data string) ([]byte, error)

func (*RawBase64) Encode

func (b *RawBase64) Encode(data []byte) string

func (*RawBase64) GetName

func (b *RawBase64) GetName() string

type RawURLBase64

type RawURLBase64 struct{}

nolint: lll RawURLEncoding is the unpadded alternate base64 encoding defined in RFC 4648. It is typically used in URLs and file names. This is the same as URLEncoding but omits padding characters.

func (*RawURLBase64) Decode

func (b *RawURLBase64) Decode(data string) ([]byte, error)

func (*RawURLBase64) Encode

func (b *RawURLBase64) Encode(data []byte) string

func (*RawURLBase64) GetName

func (b *RawURLBase64) GetName() string

type URLBase64

type URLBase64 struct{}

URLEncoding is the alternate base64 encoding defined in RFC 4648. It is typically used in URLs and file names.

func (*URLBase64) Decode

func (b *URLBase64) Decode(data string) ([]byte, error)

func (*URLBase64) Encode

func (b *URLBase64) Encode(data []byte) string

func (*URLBase64) GetName

func (b *URLBase64) GetName() string