dongle

English

简体中文
日本語

English

简体中文
日本語

Theme

XTEA ​

XTEA (eXtended Tiny Encryption Algorithm) is a symmetric encryption algorithm that uses a fixed-length 16-byte key for data encryption and decryption. dongle supports both standard and streaming XTEA encryption, providing multiple block modes, padding modes, and output formats.

Supported block modes:

  • CBC (Cipher Block Chaining): Cipher block chaining mode, requires setting key Key, initialization vector IV (8 bytes), and padding mode Padding
  • ECB (Electronic Codebook): Electronic codebook mode, requires setting key Key and padding mode Padding
  • CTR (Counter): Counter mode, requires setting key Key and initialization vector IV (8 bytes)
  • CFB (Cipher Feedback): Cipher feedback mode, requires setting key Key and initialization vector IV (8 bytes)
  • OFB (Output Feedback): Output feedback mode, requires setting key Key and initialization vector IV (8 bytes)

Note: The XTEA algorithm does not support GCM (Galois/Counter Mode). This is because GCM mode requires the cipher algorithm to have a 128-bit block size, while XTEA only has a 64-bit block size (8 bytes). This is a technical limitation of cryptographic standards, not an implementation issue.

Supported padding modes:

  • No: No padding, plaintext length must be a multiple of 8
  • Zero: Zero padding, pad with zero bytes to block boundary, if plaintext length is not a multiple of 8, pad with 0x00 bytes
  • PKCS7: PKCS#7 padding, the most commonly used padding method, pad with N bytes of value N, where N is the number of padding bytes
  • PKCS5: PKCS#5 padding, applicable to 8-byte block size, pad with N bytes of value N, where N is the number of padding bytes
  • AnsiX923: ANSI X.923 padding, pad all but the last byte with 0x00, the last byte indicates the number of padding bytes
  • ISO97971: ISO/IEC 9797-1 padding, first byte is 0x80, rest are padded with 0x00
  • ISO10126: ISO/IEC 10126 padding, pad all but the last byte with random bytes, the last byte indicates the number of padding bytes
  • ISO78164: ISO/IEC 7816-4 padding, first byte is 0x80, rest are padded with 0x00
  • Bit: Bit padding, add a 1-bit at the end of plaintext, then pad with 0-bits to block boundary

Import related modules:

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

CBC Mode ​

Create Cipher ​

go
c := cipher.NewXteaCipher(cipher.CBC)
// Set key (required, 16 bytes)
c.SetKey([]byte("1234567890123456"))
// Set initialization vector (8 bytes)
c.SetIV([]byte("12345678"))
// Set padding mode (optional, default PKCS7, CBC/ECB block modes require padding mode setting)
c.SetPadding(cipher.PKCS7)

Encrypt Data ​

Input data

go
// Input string
encrypter := dongle.Encrypt.FromString("hello world").ByXtea(c)
// Input byte slice
encrypter := dongle.Encrypt.FromBytes([]byte("hello world")).ByXtea(c)
// Input file stream
file, _ := os.Open("test.txt")
encrypter := dongle.Encrypt.FromFile(file).ByXtea(c)

// Check encryption error
if encrypter.Error != nil {
	fmt.Printf("Encryption error: %v\n", encrypter.Error)
	return
}

Output data

go
// Output Hex encoded string
encrypter.ToHexString() // a1b2c3d4e5f67890
// Output Hex encoded byte slice
encrypter.ToHexBytes()   // []byte("a1b2c3d4e5f67890")

// Output Base64 encoded string
encrypter.ToBase64String() // obLD1OX2eJA=
// Output Base64 encoded byte slice
encrypter.ToBase64Bytes()   // []byte("obLD1OX2eJA=")

// Output raw string without encoding
encrypter.ToRawString()
// Output raw byte slice without encoding
encrypter.ToRawBytes()

Decrypt Data ​

Input data

go
// Input Hex encoded string
decrypter := dongle.Decrypt.FromHexString(hexString).ByXtea(c)
// Input Hex encoded byte slice
decrypter := dongle.Decrypt.FromHexBytes(hexBytes).ByXtea(c)
// Input Hex encoded file stream
file, _ := os.Open("encrypted.hex")
decrypter := dongle.Decrypt.FromHexFile(file).ByXtea(c)

// Input Base64 encoded string
decrypter := dongle.Decrypt.FromBase64String(base64String).ByXtea(c)
// Input Base64 encoded byte slice
decrypter := dongle.Decrypt.FromBase64Bytes(base64Bytes).ByXtea(c)
// Input Base64 encoded file stream
file, _ := os.Open("encrypted.base64")
decrypter := dongle.Decrypt.FromBase64File(file).ByXtea(c)

// Input raw string without encoding
decrypter := dongle.Decrypt.FromRawString(rawString).ByXtea(c)
// Input raw byte slice without encoding
decrypter := dongle.Decrypt.FromRawBytes(rawBytes).ByXtea(c)
// Input raw file stream without encoding
file, _ := os.Open("encrypted.bin")
decrypter := dongle.Decrypt.FromRawFile(file).ByXtea(c)

// Check decryption error
if decrypter.Error != nil {
	fmt.Printf("Decryption error: %v\n", decrypter.Error)
	return
}

Output data

go
// Output decrypted string
decrypter.ToString() // hello world
// Output decrypted byte slice
decrypter.ToBytes()  // []byte("hello world")

ECB Mode ​

Create Cipher ​

go
c := cipher.NewXteaCipher(cipher.ECB)
// Set key (required, 16 bytes)
c.SetKey([]byte("1234567890123456"))
// Set padding mode (optional, default PKCS7, CBC/ECB block modes require padding mode setting)
c.SetPadding(cipher.PKCS7)

Encrypt Data ​

Input data

go
// Input string
encrypter := dongle.Encrypt.FromString("hello world").ByXtea(c)
// Input byte slice
encrypter := dongle.Encrypt.FromBytes([]byte("hello world")).ByXtea(c)
// Input file stream
file, _ := os.Open("test.txt")
encrypter := dongle.Encrypt.FromFile(file).ByXtea(c)

// Check encryption error
if encrypter.Error != nil {
	fmt.Printf("Encryption error: %v\n", encrypter.Error)
	return
}

Output data

go
// Output Hex encoded string
encrypter.ToHexString() // a1b2c3d4e5f67890
// Output Hex encoded byte slice
encrypter.ToHexBytes()   // []byte("a1b2c3d4e5f67890")

// Output Base64 encoded string
encrypter.ToBase64String() // obLD1OX2eJA=
// Output Base64 encoded byte slice
encrypter.ToBase64Bytes()   // []byte("obLD1OX2eJA=")

// Output raw string without encoding
encrypter.ToRawString()
// Output raw byte slice without encoding
encrypter.ToRawBytes()

Decrypt Data ​

Input data

go
// Input Hex encoded string
decrypter := dongle.Decrypt.FromHexString(hexString).ByXtea(c)
// Input Hex encoded byte slice
decrypter := dongle.Decrypt.FromHexBytes(hexBytes).ByXtea(c)
// Input Hex encoded file stream
file, _ := os.Open("encrypted.hex")
decrypter := dongle.Decrypt.FromHexFile(file).ByXtea(c)

// Input Base64 encoded string
decrypter := dongle.Decrypt.FromBase64String(base64String).ByXtea(c)
// Input Base64 encoded byte slice
decrypter := dongle.Decrypt.FromBase64Bytes(base64Bytes).ByXtea(c)
// Input Base64 encoded file stream
file, _ := os.Open("encrypted.base64")
decrypter := dongle.Decrypt.FromBase64File(file).ByXtea(c)

// Input raw string without encoding
decrypter := dongle.Decrypt.FromRawString(rawString).ByXtea(c)

// Input raw byte slice without encoding
decrypter := dongle.Decrypt.FromRawBytes(rawBytes).ByXtea(c)

// Input raw file stream without encoding
file, _ := os.Open("encrypted.bin")
decrypter := dongle.Decrypt.FromRawFile(file).ByXtea(c)

// Check decryption error
if decrypter.Error != nil {
	fmt.Printf("Decryption error: %v\n", decrypter.Error)
	return
}

Output data

go
// Output decrypted string
decrypter.ToString() // hello world
// Output decrypted byte slice
decrypter.ToBytes() // []byte("hello world")

CTR Mode ​

Create Cipher ​

go
c := cipher.NewXteaCipher(cipher.CTR)
// Set key (required, 16 bytes)
c.SetKey([]byte("1234567890123456"))
// Set initialization vector (8 bytes)
c.SetIV([]byte("12345678"))

Encrypt Data ​

Input data

go
// Input string
encrypter := dongle.Encrypt.FromString("hello world").ByXtea(c)
// Input byte slice
encrypter := dongle.Encrypt.FromBytes([]byte("hello world")).ByXtea(c)
// Input file stream
file, _ := os.Open("test.txt")
encrypter := dongle.Encrypt.FromFile(file).ByXtea(c)

// Check encryption error
if encrypter.Error != nil {
	fmt.Printf("Encryption error: %v\n", encrypter.Error)
	return
}

Output data

go
// Output Hex encoded string
encrypter.ToHexString() // a1b2c3d4e5f67890
// Output Hex encoded byte slice
encrypter.ToHexBytes()   // []byte("a1b2c3d4e5f67890")

// Output Base64 encoded string
encrypter.ToBase64String() // obLD1OX2eJA=
// Output Base64 encoded byte slice
encrypter.ToBase64Bytes()   // []byte("obLD1OX2eJA=")

// Output raw string without encoding
encrypter.ToRawString()
// Output raw byte slice without encoding
encrypter.ToRawBytes()

Decrypt Data ​

Input data

go
// Input Hex encoded string
decrypter := dongle.Decrypt.FromHexString(hexString).ByXtea(c)
// Input Hex encoded byte slice
decrypter := dongle.Decrypt.FromHexBytes(hexBytes).ByXtea(c)
// Input Hex encoded file stream
file, _ := os.Open("encrypted.hex")
decrypter := dongle.Decrypt.FromHexFile(file).ByXtea(c)

// Input Base64 encoded string
decrypter := dongle.Decrypt.FromBase64String(base64String).ByXtea(c)
// Input Base64 encoded byte slice
decrypter := dongle.Decrypt.FromBase64Bytes(base64Bytes).ByXtea(c)
// Input Base64 encoded file stream
file, _ := os.Open("encrypted.base64")
decrypter := dongle.Decrypt.FromBase64File(file).ByXtea(c)

// Input raw string without encoding
decrypter := dongle.Decrypt.FromRawString(rawString).ByXtea(c)
// Input raw byte slice without encoding
decrypter := dongle.Decrypt.FromRawBytes(rawBytes).ByXtea(c)
// Input raw file stream without encoding
file, _ := os.Open("encrypted.bin")
decrypter := dongle.Decrypt.FromRawFile(file).ByXtea(c)

// Check decryption error
if decrypter.Error != nil {
	fmt.Printf("Decryption error: %v\n", decrypter.Error)
	return
}

Output data

go
// Output string
decrypter.ToString() // hello world
// Output byte slice
decrypter.ToBytes()  // []byte("hello world")

CFB Mode ​

Create Cipher ​

go
c := cipher.NewXteaCipher(cipher.CFB)
// Set key (required, 16 bytes)
c.SetKey([]byte("1234567890123456"))
// Set initialization vector (8 bytes)
c.SetIV([]byte("12345678"))

Encrypt Data ​

Input data

go
// Input string
encrypter := dongle.Encrypt.FromString("hello world").ByXtea(c)
// Input byte slice
encrypter := dongle.Encrypt.FromBytes([]byte("hello world")).ByXtea(c)
// Input file stream
file, _ := os.Open("test.txt")
encrypter := dongle.Encrypt.FromFile(file).ByXtea(c)

// Check encryption error
if encrypter.Error != nil {
	fmt.Printf("Encryption error: %v\n", encrypter.Error)
	return
}

Output data

go
// Output Hex encoded string
encrypter.ToHexString() // a1b2c3d4e5f67890
// Output Hex encoded byte slice
encrypter.ToHexBytes()   // []byte("a1b2c3d4e5f67890")

// Output Base64 encoded string
encrypter.ToBase64String() // obLD1OX2eJA=
// Output Base64 encoded byte slice
encrypter.ToBase64Bytes()   // []byte("obLD1OX2eJA=")

// Output raw string without encoding
encrypter.ToRawString()
// Output raw byte slice without encoding
encrypter.ToRawBytes()

Decrypt Data ​

Input data

go
// Input Hex encoded string
decrypter := dongle.Decrypt.FromHexString(hexString).ByXtea(c)
// Input Hex encoded byte slice
decrypter := dongle.Decrypt.FromHexBytes(hexBytes).ByXtea(c)
// Input Hex encoded file stream
file, _ := os.Open("encrypted.hex")
decrypter := dongle.Decrypt.FromHexFile(file).ByXtea(c)

// Input Base64 encoded string
decrypter := dongle.Decrypt.FromBase64String(base64String).ByXtea(c)
// Input Base64 encoded byte slice
decrypter := dongle.Decrypt.FromBase64Bytes(base64Bytes).ByXtea(c)
// Input Base64 encoded file stream
file, _ := os.Open("encrypted.base64")
decrypter := dongle.Decrypt.FromBase64File(file).ByXtea(c)

// Input raw string without encoding
decrypter := dongle.Decrypt.FromRawString(rawString).ByXtea(c)
// Input raw byte slice without encoding
decrypter := dongle.Decrypt.FromRawBytes(rawBytes).ByXtea(c)
// Input raw file stream without encoding
file, _ := os.Open("encrypted.bin")
decrypter := dongle.Decrypt.FromRawFile(file).ByXtea(c)

// Check decryption error
if decrypter.Error != nil {
	fmt.Printf("Decryption error: %v\n", decrypter.Error)
	return
}

Output data

go
// Output string
decrypter.ToString() // hello world
// Output byte slice
decrypter.ToBytes() // []byte("hello world")

OFB Mode ​

Create Cipher ​

go
c := cipher.NewXteaCipher(cipher.OFB)
// Set key (required, 16 bytes)
c.SetKey([]byte("1234567890123456"))
// Set initialization vector (8 bytes)
c.SetIV([]byte("12345678"))

Encrypt Data ​

Input data

go
// Input string
encrypter := dongle.Encrypt.FromString("hello world").ByXtea(c)
// Input byte slice
encrypter := dongle.Encrypt.FromBytes([]byte("hello world")).ByXtea(c)
// Input file stream
file, _ := os.Open("test.txt")
encrypter := dongle.Encrypt.FromFile(file).ByXtea(c)

// Check encryption error
if encrypter.Error != nil {
	fmt.Printf("Encryption error: %v\n", encrypter.Error)
	return
}

Output data

go
// Output Hex encoded string
encrypter.ToHexString() // a1b2c3d4e5f67890
// Output Hex encoded byte slice
encrypter.ToHexBytes()   // []byte("a1b2c3d4e5f67890")

// Output Base64 encoded string
encrypter.ToBase64String() // obLD1OX2eJA=
// Output Base64 encoded byte slice
encrypter.ToBase64Bytes()   // []byte("obLD1OX2eJA=")

// Output raw string without encoding
encrypter.ToRawString()
// Output raw byte slice without encoding
encrypter.ToRawBytes()

Decrypt Data ​

Input data

go
// Input Hex encoded string
decrypter := dongle.Decrypt.FromHexString(hexString).ByXtea(c)
// Input Hex encoded byte slice
decrypter := dongle.Decrypt.FromHexBytes(hexBytes).ByXtea(c)
// Input Hex encoded file stream
file, _ := os.Open("encrypted.hex")
decrypter := dongle.Decrypt.FromHexFile(file).ByXtea(c)

// Input Base64 encoded string
decrypter := dongle.Decrypt.FromBase64String(base64String).ByXtea(c)
// Input Base64 encoded byte slice
decrypter := dongle.Decrypt.FromBase64Bytes(base64Bytes).ByXtea(c)
// Input Base64 encoded file stream
file, _ := os.Open("encrypted.base64")
decrypter := dongle.Decrypt.FromBase64File(file).ByXtea(c)

// Input raw string without encoding
decrypter := dongle.Decrypt.FromRawString(rawString).ByXtea(c)
// Input raw byte slice without encoding
decrypter := dongle.Decrypt.FromRawBytes(rawBytes).ByXtea(c)
// Input raw file stream without encoding
file, _ := os.Open("encrypted.bin")
decrypter := dongle.Decrypt.FromRawFile(file).ByXtea(c)

// Check decryption error
if decrypter.Error != nil {
	fmt.Printf("Decryption error: %v\n", decrypter.Error)
	return
}

Output data

go
// Output string
decrypter.ToString() // hello world
// Output byte slice
decrypter.ToBytes() // []byte("hello world")

Released under the MIT License, unauthorized reproduction is prohibited in any form

Copyright © 2020-2025 dongle team