simpleEncryption

package module
v0.1.6 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 11, 2023 License: MIT Imports: 4 Imported by: 1

README

simple_encryption

English | 简体中文

Encrypt data table ID on server side

Usage

Comparison value string

var contrast string = "{\"extraItem\":2,\"key\":[\"jb10=m/zkvpds=1/\",\"/*-+0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz\"]}"
  • extraItem: Extra item add position, currently only supports 1 character
  • key[0]: Encryption key
  • key[1]: Character set used for encryption, characters not in the character set will be ignored

Initialize

  • Function: New
  • Parameter:
    • extraItem: Extra item add position, currently only supports 1 character
    • key: Encryption key
    • cryptKey: Character set used for encryption, characters not in the character set will be ignored
  • Return value:
    • se: SimpleEncryption object
    • err: Error message
  • Example:
se, err := New(extraItem, key, cryptKey)
if err != nil {
    println("encrypt error:", err)
    return
}

Initialize with Json string

  • Function: NewJson
  • Parameter:
    • contrast: Json string of key
  • Return value:
    • se: SimpleEncryption object
    • err: Error message
  • Example:
se, err := NewJson(contrast)
if err != nil {
    println("encrypt error:", err)
    return
}

encrypt

  • Function: encrypt
  • Parameter:
    • str: String to be encrypted
    • extra: Extra encryption item, currently only supports 1 character
  • Return value:
    • enStr: Encrypted string
    • err: Error message
  • Example:
var (
    extra   string = "1"
    str     string = "1z3a+bc f"
    enStr   string = ""
    err     error  = nil
)
se, err := New(contrast)
if err != nil {
    t.Error("encrypt error:", err)
    return
}
println("[extra]:  ", extra, "[str]:", str)
enStr, err = se.encrypt(str, extra)
if err != nil {
    println("encrypt error:", err)
    return
}
println("[encrypt]:         ", enStr)
  • Output:
[extra]:      1 [str]:      1z3a+bc f
[encrypt]:                  ec/xLjLJ 1

decrypt

  • Function: decrypt
  • Parameter:
    • str: String to be decrypted
  • Return value:
    • reStr: Decrypted string
    • reExtra: Extra encryption item
    • err: Error message
  • Example:
var (
    str     string = "ec/xLjLJ 1"
    reStr   string = ""
    reExtra string = ""
    err     error  = nil
)
se, err := New(contrast)
if err != nil {
    println("encrypt error:", err)
    return
}
println("[str]:               ", str)
reStr, reExtra, err = se.decrypt(str)
if err != nil {
    println("decrypt error:", err)
    return
}
println("[extra]:", reExtra, "[decrypt]:", reStr)
  • Output:
[str]:                ec/xLjLJ 1
[extra]: 1 [decrypt]: 1z3a+bc f

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type SecretKey added in v0.1.4

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

func New

func New(extraItem int, key string, cryptKey string) (*SecretKey, error)

==============================

初始化
extraItem: 额外信息的位置,从0开始
cryptKey: 密码本
key: 密钥
返回值1: SecretKey对象
返回值2: 错误信息

==============================

initialization
extraItem: extra information position, start from 0
key: key
cryptKey: password book
return value 1: SecretKey object
return value 2: error message

func NewJson

func NewJson(key string) (*SecretKey, error)

==============================

初始化(Json格式)
key: 密码本
	格式:
	{
		"extraItem": 1,
		"key": ["asfa908#@%.,?", "bcdeftuvwxyz0123456789"]
	}
返回值1: SecretKey对象
返回值2: 错误信息

==============================

initialization(Json format)
key: password book
format:
	{
		"extraItem": 1,
		"key": ["asfa908#@%.,?", "bcdeftuvwxyz0123456789"]
	}
return value 1: SecretKey object
return value 2: error message

func (*SecretKey) Decrypt added in v0.1.4

func (se *SecretKey) Decrypt(str string) (reStr string, extra string, err error)

==============================

解密
str: 需要解密的字符串
返回值1: 解密后的字符串
返回值2: 额外信息
返回值3: 错误信息

==============================

decrypt
str: string need to decrypt
return value 1: decrypted string
return value 2: extra information
return value 3: error message

func (*SecretKey) Encrypt added in v0.1.4

func (se *SecretKey) Encrypt(str string, extraStr string) (reStr string)

==============================

加密
extra: 额外信息,暂只支持一个字符
str: 需要加密的字符串
返回值1: 加密后的字符串
返回值2: 错误信息

==============================

encryption
extra: extra information, only support one character
str: string need to encrypt
return value 1: encrypted string
return value 2: error message

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL