xipher

Xipher

Xipher is a curated collection of cryptographic primitives put together to key/password based asymmetric encryption.

What does it do?

• 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.

Demo

CLI Installation

Download the latest binary from the releases page and add it to your path.

Homebrew

Xipher can be installed with brew using the following command on macOS

brew install shibme/tap/xipher

Install Script

Install Latest Version

With Shell (MacOs/Linux):

curl -fsSL https://dev.shib.me/xipher/install.sh | sh

With PowerShell (Windows):

irm https://dev.shib.me/xipher/install.ps1 | iex

Install Specific Version

With Shell (MacOs/Linux):

curl -fsSL https://dev.shib.me/xipher/install.sh | sh -s v0.9.2

With PowerShell (Windows):

$v="0.9.2"; irm https://dev.shib.me/xipher/install.ps1 | iex

Docker

You can also run Xipher without installing using Docker:

docker run --rm -v $PWD:/data -it shibme/xipher help

Using as a Go package

Install the package

go get -u dev.shib.me/xipher

Use it in your code

package main

import (
	"encoding/base32"
	"fmt"

	"dev.shib.me/xipher"
)

func main() {
	// Creating a new private key for password
	privKey, err := xipher.NewPrivateKeyForPassword([]byte("Paws0meKittyKuwan!"))
	if err != nil {
		panic(err)
	}

	// Deriving  public key from private key
	pubKey, err := privKey.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 private key
	plainText, err := privKey.Decrypt(cipherText)
	if err != nil {
		panic(err)
	}
	fmt.Println("Decrypted:", string(plainText))
}

Under the hood

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.

Disclaimer

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.