xiphr

Xiphr

Xiphr is a curated collection of cryptographic primitives put together to perform password-based asymmetric encryption. It is written in Go and can be used as a library or a CLI tool.

Features

• Password based public key generation.
• Encrypt data with public key generated from a password.
• Encrypt data with password or a generated private key.
• Decrypt data with password or a a given private key (works on all combinations of encryption).
• Supports stream cipher along with stream compression thereby keeping a low memory footprint. Makes it handy for encrypting large files or data streams.

Under the hood

Xiphr uses the following cryptographic primitives and libraries to encrypt/decrypt and compress/decompress data:

• Argon2id for password hashing.
• Curve25519 for elliptic curve cryptography.
• XChaCha20-Poly1305 for encryption and decryption.
• Zlib for compression and decompression.

Install or Update

go get -u dev.shib.me/xiphr

Usage Example

package main

import (
	"encoding/base32"
	"fmt"

	"dev.shib.me/xiphr"
)

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

	// Deriving  public key from private key
	pubKey, err := privKey.PublicKey()
	if err != nil {
		panic(err)
	}
	fmt.Println("PublicKey:", base32.StdEncoding.WithPadding(base32.NoPadding).EncodeToString(pubKey.Bytes()))

	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))
}

The output of the above code looks something like this:

PublicKey: MS5JUG7ZVJLETJA7WE2XKFHRE4PP6LKYCTEF2FTNUJ5QEZJIGZPCAIABX7UMDM7DPZX6WNOXICBUBBPPKE
Encrypted: AQQCAAN75DA3HY36N7VTLV2AQNAIL32RBWA2GJY7JNFA7QNOBT4CFXFBZMKY36DGE6FBKPATB7EJTD5SCNXI6URGO4WERYXYHYTL4RCXLRMYBG4K4UDZ5HGE7APXUVZ4RNESUV3EWVDJBHUAT5F7U5BFNUMTXB72Q3AZBGZDN3KXBWLUX23Q
Decrypted: Hello World!

Basic CLI

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

You can also install with brew using the following command

brew install shibme/beta/xiphr

Alternatively try it out using docker

docker run --rm -v $(pwd):/data/ -it shibme/xiphr help