Security

Encryption and Decryption

Configuration

asjard:
  ## Encryption and Decryption Related Configuration
  cipher:
    ## Default Encryption/Decryption Component Name
    default: default
    ## If you need encryption/decryption config files, you must load this configuration into environment variables, for example
    ## asjard_cipher_aesCBCPkcs5padding_base64Key=
    ## asjard_cipher_aesCBCPkcs5padding_base64Iv=
    ## key is the name of the custom encryption/decryption component,
    ## value is the configuration required by the encryption/decryption component
    aesCBCPkcs5padding:
      ## Key, length must be 16, 24, or 32
      base64Key: ""
      ## Initialization vector (IV), length must be 16
      ## If empty, take the first 16 characters of base64Key
      base64Iv: ""

Custom Encryption and Decryption

Implement the following methods

// Cipher interface that encryption/decryption must implement
type Cipher interface {
	// Encrypt method
	Encrypt(data string, opts *Options) (string, error)
	// Decrypt method
	Decrypt(data string, opts *Options) (string, error)
}

import "github.com/asjard/asjard/core/sercurity"

// Register cipher
func init() {
	security.AddCipher("XXXCipher", NewXXXCipher)
}

// Implement the above interface
func NewXXXCipher(name string) (Cipher, error) {
	// TODO
	return &XXXCipher{}, nil
}

Use

import "github.com/asjard/asjard/core/sercurity"

// Custom cipher encryption
security.Encrypt("plain text", security.WithCipherName("XXXCipher"))
// Custom cipher decryption
security.Decrypt("secret text", security.WithCipherName("XXXCipher")

Config Using Encryption/Decryption

// Get config and use XXXCipher to decrypt
config.GetString("xxx.encryptKey", config.WithCipher("XXXCipher"))
// Add config and use XXXCipher to encrypt
config.Set("xxx.encryptKey", "plain text", config.WithCipher("XXXCipher")