Xipher is a curated collection of cryptographic primitives put together to perform key/password based asymmetric encryption.
- Allows sharing of data securely between two parties over an insecure channel using asymmetric encryption.
- The sender encrypts the data using a public key (received from a receiver) derived from a password and shares the encrypted data with the receiver.
- The receiver decrypts the data using the same password.
- Encrypts data with the public key generated based on a password.
- Supports stream cipher along with stream compression, resulting in lower memory footprint.
- Supports post-quantum cryptography using the Kyber algorithm.
Download the latest binary from the releases page and add it to your path.
Xipher can be installed with brew using the following command on macOS
brew install shibme/tap/xipherWith Shell (MacOs/Linux):
curl -fsSL https://dev.shib.me/xipher/install.sh | shWith PowerShell (Windows):
irm https://dev.shib.me/xipher/install.ps1 | iexWith Shell (MacOs/Linux):
curl -fsSL https://dev.shib.me/xipher/install.sh | sh -s v1.1.0With PowerShell (Windows):
$v="1.1.0"; irm https://dev.shib.me/xipher/install.ps1 | iexYou can also run Xipher without installing using Docker:
docker run --rm -v $PWD:/data -it shibme/xipher help- An interoperable web interface implemented using web assembly is available here.
- The source code for the web implementation is available at shibina3/xenigma.
Install the package
go get -u dev.shib.me/xipherUse it in your code
package main
import (
"encoding/base32"
"fmt"
"dev.shib.me/xipher"
)
func main() {
// Creating a new secret key for password
scrtKey, err := xipher.NewSecretKeyForPassword([]byte("Paws0meKittyKuwan!"))
if err != nil {
panic(err)
}
// Deriving public key from secret key
pubKey, err := scrtKey.PublicKey(false)
if err != nil {
panic(err)
}
publicKeyBytes, err := pubKey.Bytes()
if err != nil {
panic(err)
}
fmt.Println("PublicKey:", base32.StdEncoding.WithPadding(base32.NoPadding).EncodeToString(publicKeyBytes))
platinText := []byte("Hello World!")
// Encrypting plain text with public key
cipherText, err := pubKey.Encrypt(platinText, true)
if err != nil {
panic(err)
}
fmt.Println("Encrypted:", base32.StdEncoding.WithPadding(base32.NoPadding).EncodeToString(cipherText))
// Decrypting cipher text with secret key
plainText, err := scrtKey.Decrypt(cipherText)
if err != nil {
panic(err)
}
fmt.Println("Decrypted:", string(plainText))
}To use xipher as a web assembly (wasm) module in a browser app, follow the example below.
<html>
<head>
<meta charset="utf-8"/>
<script src="https://dev.shib.me/xipher/wasm/wasm_exec.js"></script>
<script>
const go = new Go();
WebAssembly.instantiateStreaming(fetch("https://dev.shib.me/xipher/wasm/xipher.wasm"), go.importObject).then((result) => {
go.run(result.instance);
});
</script>
</head>
<body>
Call wasm methods that begin with xipher. For example: xipherNewSecretKey()
</body>
</html>Xipher uses the following algorithms and libraries to achieve its functionality:
- Argon2id for password hashing.
- Curve25519 for elliptic curve cryptography.
- CRYSTALS-Kyber using CIRCL library for post-quantum cryptography.
- XChaCha20-Poly1305 for symmetric encryption.
- Zlib for compression.
The following sequence diagram illustrates the workflow of Xipher in encrypting data using a password based public key.
sequenceDiagram
participant RX as Xipher
actor Receiver
actor Sender
participant SX as Xipher
Receiver-->>+RX: Derive public (inputs password)
RX-->>-Receiver: Returns Public Key
Receiver->>Sender: Shares Public Key
Sender-->>+SX: Encrypt data with public key
SX-->>-Sender: Returns ciphertext encrypted with Public Key
Sender->>Receiver: Sends the encrypted ciphertext to the Receiver
Receiver-->>+RX: Decrypt data (inputs ciphertext and password)
RX-->>-Receiver: Returns decrypted data
This tool/library is provided without any warranties, and there is no guarantee of its stability. Due to the experimental nature of some of its components, it is anticipated that modifications to the code, repository, and API will be made in the future. Caution is advised before incorporating this into a production application. Please report any identified security issues promptly. Your cooperation in notifying us of such concerns is highly appreciated.