safe

Documentation

Index

• Constants
• Variables
• func Decrypt(cipherString, key string) ([]byte, error)
• func Encrypt(originalBytes []byte, key string, o *EncryptOptions) (string, error)
• func SafeStringHookFunc() func(f reflect.Type, t reflect.Type, data interface{}) (interface{}, error)
• func WithFixAlgo(o *EncryptOptions)
• func WithoutFixAlgo(o *EncryptOptions)
• type BlockMode
  • func (g BlockMode) NewDecrypter(b cipher.Block, iv []byte) cipher.BlockMode
  • func (g BlockMode) NewEncrypter(b cipher.Block, iv []byte) cipher.BlockMode
• type EncryptOptions
  • func NewEncryptOptions(ofs ...WithOptionsFunc) *EncryptOptions
• type EncryptionAlgorithm
  • func (algo EncryptionAlgorithm) NewCipher(key []byte) (cipher.Block, error)
  • func (algo EncryptionAlgorithm) String() string
• type Hash
  • func NewHash(hashFunc func() hash.Hash, data []byte) Hash
  • func (h Hash) HexString(n int) string
• type PaddingMethod
  • func (p PaddingMethod) Padding(data []byte, blockSize int) ([]byte, int, error)
  • func (p PaddingMethod) UnPadding(data []byte, paddingLength int) ([]byte, error)
• type String
  • func NewEncryptedString(plain, secret string) *String
  • func (e *String) Equal(n String) bool
  • func (*String) GormDataType() string
  • func (e String) MarshalJSON() ([]byte, error)
  • func (e String) MarshalJSONPB(_ *jsonpb.Marshaler) ([]byte, error)
  • func (e *String) ProtoMessage()
  • func (e *String) Reset()
  • func (e *String) Scan(value any) error
  • func (e *String) SetSecret(secret string)
  • func (e *String) SetValue(value string) (err error)
  • func (e String) Size() int
  • func (e *String) String() string
  • func (e *String) UnmarshalJSON(bytes []byte) (err error)
  • func (e *String) UnmarshalJSONPB(_ *jsonpb.Unmarshaler, bytes []byte) error
  • func (e *String) UnmarshalYAML(value *yaml.Node) (err error)
  • func (e String) UnsafeString() (string, error)
  • func (e *String) UpdateSecret(secret string)
  • func (e String) Value() (driver.Value, error)
  • func (e *String) XXX_WellKnownType() string
• type WithOptionsFunc
  • func WithAlgorithm(algo EncryptionAlgorithm) WithOptionsFunc
  • func WithMode(mode BlockMode) WithOptionsFunc
  • func WithPadding(padding PaddingMethod) WithOptionsFunc

Constants

const (
	BlockModeCBC = 0x00
)

Variables

var SecretEnvName = "GLOBAL_ENCRYPT_KEY"

Functions

func Decrypt

func Decrypt(cipherString, key string) ([]byte, error)

func Encrypt

func Encrypt(originalBytes []byte, key string, o *EncryptOptions) (string, error)

func SafeStringHookFunc

func SafeStringHookFunc() func(f reflect.Type, t reflect.Type, data interface{}) (interface{}, error)

SafeStringHookFunc Implementation mapstructure.DecodeHookFunc

func WithFixAlgo

func WithFixAlgo(o *EncryptOptions)

func WithoutFixAlgo

func WithoutFixAlgo(o *EncryptOptions)

Types

type BlockMode

type BlockMode byte

func (BlockMode) NewDecrypter

func (g BlockMode) NewDecrypter(b cipher.Block, iv []byte) cipher.BlockMode

func (BlockMode) NewEncrypter

func (g BlockMode) NewEncrypter(b cipher.Block, iv []byte) cipher.BlockMode

type EncryptOptions

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

func NewEncryptOptions

func NewEncryptOptions(ofs ...WithOptionsFunc) *EncryptOptions

type EncryptionAlgorithm

type EncryptionAlgorithm byte

const (
	Algorithm3DES EncryptionAlgorithm = 0
	AlgorithmDES  EncryptionAlgorithm = 1
	AlgorithmAES  EncryptionAlgorithm = 2
	AlgorithmTEA  EncryptionAlgorithm = 3
)

func (EncryptionAlgorithm) NewCipher

func (algo EncryptionAlgorithm) NewCipher(key []byte) (cipher.Block, error)

func (EncryptionAlgorithm) String

func (algo EncryptionAlgorithm) String() string

type Hash

type Hash []byte

func NewHash

func NewHash(hashFunc func() hash.Hash, data []byte) Hash

func (Hash) HexString

func (h Hash) HexString(n int) string

type PaddingMethod

type PaddingMethod byte

const (
	PKCS5Padding PaddingMethod = 0x00
)

func (PaddingMethod) Padding

func (p PaddingMethod) Padding(data []byte, blockSize int) ([]byte, int, error)

func (PaddingMethod) UnPadding

func (p PaddingMethod) UnPadding(data []byte, paddingLength int) ([]byte, error)

type String

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

func NewEncryptedString

func NewEncryptedString(plain, secret string) *String

func (*String) Equal

func (e *String) Equal(n String) bool

func (*String) GormDataType

func (*String) GormDataType() string

func (String) MarshalJSON

func (e String) MarshalJSON() ([]byte, error)

func (String) MarshalJSONPB

func (e String) MarshalJSONPB(_ *jsonpb.Marshaler) ([]byte, error)

func (*String) ProtoMessage

func (e *String) ProtoMessage()

func (*String) Reset

func (e *String) Reset()

func (*String) Scan

func (e *String) Scan(value any) error

Scan implements the Scanner interface.

func (*String) SetSecret

func (e *String) SetSecret(secret string)

func (*String) SetValue

func (e *String) SetValue(value string) (err error)

func (String) Size

func (e String) Size() int

func (*String) String

func (e *String) String() string

func (*String) UnmarshalJSON

func (e *String) UnmarshalJSON(bytes []byte) (err error)

func (*String) UnmarshalJSONPB

func (e *String) UnmarshalJSONPB(_ *jsonpb.Unmarshaler, bytes []byte) error

func (*String) UnmarshalYAML

func (e *String) UnmarshalYAML(value *yaml.Node) (err error)

func (String) UnsafeString

func (e String) UnsafeString() (string, error)

func (*String) UpdateSecret

func (e *String) UpdateSecret(secret string)

func (String) Value

func (e String) Value() (driver.Value, error)

Value implements the driver Valuer interface.

func (*String) XXX_WellKnownType

func (e *String) XXX_WellKnownType() string

type WithOptionsFunc

type WithOptionsFunc func(o *EncryptOptions)

func WithAlgorithm

func WithAlgorithm(algo EncryptionAlgorithm) WithOptionsFunc

func WithMode

func WithMode(mode BlockMode) WithOptionsFunc

func WithPadding

func WithPadding(padding PaddingMethod) WithOptionsFunc