dongle

package module
v1.1.1 Latest Latest
Warning

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

 Go to latest Published: Aug 31, 2025 License: MIT Imports: 3 Imported by: 0

README

dongle

Carbon Release Go Test Go Report Card codecov Carbon Doc Awesome License

English | 简体中文 | 日本語

Introduction

Dongle is a simple, semantic and developer-friendly golang crypto package with 100% unit test coverage，has been included by awesome-go

Repository

github.com/dromara/dongle

gitee.com/dromara/dongle

gitcode.com/dromara/dongle

Quick Start

Installation

go version >= 1.23

// Via github 
go get -u github.com/dromara/dongle
import "github.com/dromara/dongle"

// Via gitee
go get -u gitee.com/dromara/dongle
import "gitee.com/dromara/dongle"

// Via gitcode 
go get -u gitcode.com/dromara/dongle
import "gitcode.com/dromara/dongle"

Dongle was donated to the dromara organization, the repository URL has changed. If the previous repository used was golang-module/dongle, please replace the original repository with the new repository in go.mod, or execute the following command:

go mod edit -replace github.com/golang-module/dongle = github.com/dromara/dongle

Example Usage

Encode&Decode

import "github.com/dromara/dongle"

dongle.Encode.FromString("hello world").ByBase64().ToString()      // aGVsbG8gd29ybGQ=
dongle.Decode.FromString("aGVsbG8gd29ybGQ=").ByBase64().ToString() // hello world

Hash Algorithm

import "github.com/dromara/dongle"

dongle.Hash.FromString("hello world").ByMd5().ToHexString()    // 5eb63bbbe01eeed093cb22bb8f5acdc3
dongle.Hash.FromString("hello world").ByMd5().ToBase64String() // XrY7u+Ae7tCTyyK7j1rNww==

Hmac Algorithm

import "github.com/dromara/dongle"

dongle.Hash.FromString("hello world").WithKey([]byte("dongle")).ByMd5().ToHexString()    // 4790626a275f776956386e5a3ea7b726
dongle.Hash.FromString("hello world").WithKey([]byte("dongle")).ByMd5().ToBase64String() // R5Biaidfd2lWOG5aPqe3Jg==

Symmetric Encryption&Decryption

import (
	"github.com/dromara/dongle"
	"github.com/dromara/dongle/crypto/cipher"
)

// Create cipher
c := cipher.NewAesCipher(cipher.CBC)
// Set key (16 bytes)
c.SetKey([]byte("dongle1234567890")) 
// Set initialization vector (16 bytes)
c.SetIV([]byte("1234567890123456"))
// Set padding mode (optional, default is PKCS7)
c.SetPadding(cipher.PKCS7)

// Encrypt string plaintext, return hex string ciphertext
dongle.Encrypt.FromString("hello world").ByAes(c).ToHexString() // 48c6bc076e1da2946e1c0e59e9c91ae9
// Decrypt hex string ciphertext, return string plaintext
dongle.Decrypt.FromHexString("48c6bc076e1da2946e1c0e59e9c91ae9").ByAes(c).ToString() // hello world

// Encrypt string plaintext, return base64 encoded string ciphertext
dongle.Encrypt.FromString("hello world").ByAes(c).ToBase64String() // SMa8B24dopRuHA5Z6cka6Q==
// Decrypt base64 encoded string ciphertext, return string plaintext
dongle.Decrypt.FromBase64String("SMa8B24dopRuHA5Z6cka6Q==").ByAes(c).ToString() // hello world

Asymmetric Encryption&Decryption

import (
	"crypto"
	"github.com/dromara/dongle"
	"github.com/dromara/dongle/crypto/keypair"
)

// Create key pair
kp := keypair.NewRsaKeyPair()
// Set key format (optional, default is PKCS8)
kp.SetFormat(keypair.PKCS8)
// Set hash algorithm (optional, default is SHA256)
kp.SetHash(crypto.SHA256)   
// Set public key
kp.SetPublicKey([]byte("MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCqzZNa9VrcewyU6wDoV7Y9kAHqX1VK0B3Rb6GNmQe4zLEfce7cVTaLrc4VGTKl35tADG1cRHqtaG4S/WttpiGZBhxJy4MpOXb6eIPiVLsn2lL+rJo5XdbSr3gyjxEOQQ97ihtw4lDd5wMo4bIOuw1LtMezHC1outlM6x+/BB0BSQIDAQAB"))
// Set private key
kp.SetPrivateKey([]byte("MIICdQIBADANBgkqhkiG9w0BAQEFAASCAl8wggJbAgEAAoGBAKrNk1r1Wtx7DJTrAOhXtj2QAepfVUrQHdFvoY2ZB7jMsR9x7txVNoutzhUZMqXfm0AMbVxEeq1obhL9a22mIZkGHEnLgyk5dvp4g+JUuyfaUv6smjld1tKveDKPEQ5BD3uKG3DiUN3nAyjhsg67DUu0x7McLWi62UzrH78EHQFJAgMBAAECgYAeo3nHWzPNURVUsUMcan96U5bEYA2AugxfQVMNf2HvOGidZ2adh3udWrQY/MglERNcTd5gKriG2rDEH0liBecIrNKsBL4lV+qHEGRUcnDDdtUBdGInEU8lve5keDgmX+/huXSRJ+3tYA5u9j+32RquVczvIdtb5XnBLUl61k0osQJBAON5+eJjtw6xpn+pveU92BSHvaJYVyrLHwUjR07aNKb7GlGVM3MGf1FCa8WQUo9uUzYxGLtg5Qf3sqwOrwPd5UsCQQDAOF/zWqGuY3HfV/1wgiXiWp8rc+S8tanMj5M37QQbYW5YLjUmJImoklVahv3qlgLZdEN5ZSueM5jfoSFtNts7AkBKoRDvSiGbi4MBbTHkzLZgfewkH/FxE7S4nctePk553fXTgCyh9ya8BRuQdHnxnpNkOxVPHEnnpEcVFbgrf5gjAkB7KmRI4VTiEfRgINhTJAG0VU7SH/N7+4cufPzfA+7ywG5c8Fa79wOB0SoB1KeUjcSLo5Ssj2fwea1F9dAeU90LAkBJQFofveaDa3YlN4EQZOcCvJKmg7xwWuGxFVTZDVVEws7UCQbEOEEXZrNd9x0IF5kpPLR+rxuaRPgUNaDGIh5o"))

// Encrypt string plaintext by public key, return hex string ciphertext
dongle.Encrypt.FromString("hello world").ByRsa(kp).ToHexString() // 7fae94fd1a8b880d8d5454dd8df30c40...
// Decrypt hex string ciphertext by private key, return string plaintext
dongle.Encrypt.FromHexString("7fae94fd1a8b880d8d5454dd8df30c40...").ByRsa(kp).ToString() // hello world

// Encrypt string plaintext by public key, return base64 encoded string ciphertext
dongle.Encrypt.FromString("hello world").ByRsa(kp).ToBase64String() // f66U/RqLiA2NVFTdjfMMQA==...
// Decrypt base64 encoded string ciphertext by private key, return string plaintext
dongle.Encrypt.FromBase64String("f66U/RqLiA2NVFTdjfMMQA==...").ByRsa(kp).ToString() // hello world

For more usage examples, please refer to official document.

Contributors

Thanks to all the following who contributed to dongle:

Sponsors

Dongle is a non-commercial open source project. If you want to support dongle, you can buy a cup of coffee for developer.

Thanks

Dongle had been being developed with GoLand under the free JetBrains Open Source license, I would like to express my thanks here.

JetBrains

License

Dongle is licensed under the MIT License, see the LICENSE file for details.

Documentation

Overview

Package dongle is a simple, semantic and developer-friendly golang crypto package.

Index

Constants

View Source 
const Version = "1.1.1"

Variables

View Source 
var (
	// Encode defines an Encoder instance.
	Encode = coding.NewEncoder()
	// Decode defines a Decoder instance.
	Decode = coding.NewDecoder()

	// Hash defines a Hasher instance.
	Hash = hash.NewHasher()

	// Encrypt defines an Encrypter instance.
	Encrypt = crypto.NewEncrypter()
	// Decrypt defines a Decrypter instance.
	Decrypt = crypto.NewDecrypter()

	// Sign defines a Signer instance.
	Sign = crypto.NewSigner()
	// Verify defines a Verifier instance.
	Verify = crypto.NewVerifier()
)

Functions

This section is empty.

Types

This section is empty.

Source Files

  • dongle.go

Directories

Path Synopsis
base100
Package base100 implements base100 encoding and decoding with streaming support.
 Package base100 implements base100 encoding and decoding with streaming support.
base32
Package base32 implements base32 encoding and decoding with streaming support.
 Package base32 implements base32 encoding and decoding with streaming support.
base45
Package base45 implements base45 encoding and decoding with streaming support.
 Package base45 implements base45 encoding and decoding with streaming support.
base58
Package base58 implements base58 encoding and decoding with streaming support.
 Package base58 implements base58 encoding and decoding with streaming support.
base62
Package base62 implements base62 encoding and decoding with streaming support.
 Package base62 implements base62 encoding and decoding with streaming support.
base64
Package base64 implements base64 encoding and decoding with streaming support.
 Package base64 implements base64 encoding and decoding with streaming support.
base85
Package base85 implements base85 encoding and decoding with streaming support.
 Package base85 implements base85 encoding and decoding with streaming support.
base91
Package base91 implements base91 encoding and decoding with streaming support.
 Package base91 implements base91 encoding and decoding with streaming support.
hex
Package hex implements hex encoding and decoding with streaming support.
 Package hex implements hex encoding and decoding with streaming support.
morse
Package morse implements morse encoding and decoding with streaming support.
 Package morse implements morse encoding and decoding with streaming support.
3des
Package triple_des implements Triple DES encryption and decryption with streaming support.
 Package triple_des implements Triple DES encryption and decryption with streaming support.
aes
Package aes implements AES encryption and decryption with streaming support.
 Package aes implements AES encryption and decryption with streaming support.
blowfish
Package blowfish implements Blowfish encryption and decryption with streaming support.
 Package blowfish implements Blowfish encryption and decryption with streaming support.
cipher
des
Package des implements DES encryption and decryption with streaming support.
 Package des implements DES encryption and decryption with streaming support.
ed25519
keypair
Package keypair provides ED25519 key pair management functionality.
 Package keypair provides ED25519 key pair management functionality.
rc4
Package rc4 implements RC4 encryption and decryption with streaming support
 Package rc4 implements RC4 encryption and decryption with streaming support
rsa
tea
Package tea implements TEA encryption and decryption with streaming support.
 Package tea implements TEA encryption and decryption with streaming support.
md2
Package md2 implements the MD2 hash algorithm as defined in RFC 1319.
 Package md2 implements the MD2 hash algorithm as defined in RFC 1319.
sm3
Package sm3 implements the SM3 hash algorithm as defined in GB/T 32918.1-2016.
 Package sm3 implements the SM3 hash algorithm as defined in GB/T 32918.1-2016.
Package mock provides mock implementations for testing file operations and I/O interfaces.
 Package mock provides mock implementations for testing file operations and I/O interfaces.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.