Xipher is a curated collection of cryptographic primitives designed for secure password-based asymmetric encryption. It enables secure data sharing between parties over insecure channels using password-derived public keys, combining modern cryptography with post-quantum security.
- 🔐 Asymmetric Encryption: Encrypt data with public keys derived from passwords
- 📦 Stream Processing: Built-in compression and streaming for memory efficiency
- 🛡️ Post-Quantum Security: Optional Kyber1024 algorithm support
- 🌐 Multi-Platform: CLI, Go library, Web Assembly, and web interface
- ⚡ Performance: Optimized for both small and large data encryption
- 🔧 Easy Integration: Simple APIs for developers
Homebrew (macOS):
brew install shibme/tap/xipherInstall Script (Linux/macOS):
# Latest version
curl -fsSL https://xipher.org/install/install.sh | sh
# Specific version
curl -fsSL https://xipher.org/install/install.sh | sh -s v1.17.0Install Script (Windows):
# PowerShell (latest version)
irm https://xipher.org/install/install.ps1 | iex
# PowerShell with specific version
$v="1.17.0"; irm https://xipher.org/install/install.ps1 | iexBinary Download: Download from releases page
Docker:
docker run --rm -v $PWD:/data -it shibme/xipher helpgo get -u xipher.org/xipher
package main
import (
"encoding/base32"
"fmt"
"xipher.org/xipher"
)
func main() {
// Create secret key from password
secretKey, err := xipher.NewSecretKeyForPassword([]byte("your-secure-password"))
if err != nil {
panic(err)
}
// Derive public key
publicKey, err := secretKey.PublicKey(false)
if err != nil {
panic(err)
}
// Encrypt data
plaintext := []byte("Hello, World!")
ciphertext, err := publicKey.Encrypt(plaintext, true)
if err != nil {
panic(err)
}
// Decrypt data
decrypted, err := secretKey.Decrypt(ciphertext)
if err != nil {
panic(err)
}
fmt.Printf("Original: %s\n", plaintext)
fmt.Printf("Decrypted: %s\n", decrypted)
}Experience Xipher directly in your browser at xipher.org
Workflow:
- Receiver opens Xipher web app → generates key pair (stored in browser)
- Receiver shares the public key URL with sender
- Sender opens encryption URL → inputs data → gets encrypted result
- Sender shares ciphertext with receiver
- Receiver decrypts using stored private key
sequenceDiagram
participant RX as Xipher<br>(Browser)
actor R as Receiver
actor S as Sender
participant SX as Xipher<br>(Browser)
R-->>+RX: Opens app
RX-->>RX: Generate keys
RX-->>-R: Public key URL
R->>+S: Share URL
S-->>+SX: Open URL & encrypt
SX-->>-S: Ciphertext
S->>-R: Send ciphertext
R-->>+RX: Decrypt
RX-->>-R: Plaintext
steps:
- name: Setup Xipher
uses: shibme/xipher@v1
with:
version: 1.17.0 # optionalname: Publish Xipher Web
on:
workflow_dispatch:
jobs:
pages:
uses: shibme/xipher/.github/workflows/pages.yaml@main<html>
<head>
<meta charset="utf-8"/>
<script src="https://xipher.org/wasm/wasm_exec.js"></script>
<script>
const go = new Go();
WebAssembly.instantiateStreaming(
fetch("https://xipher.org/wasm/xipher.wasm"),
go.importObject
).then((result) => {
go.run(result.instance);
});
</script>
</head>
<body>
<!-- Call methods starting with 'xipher', e.g., xipherNewSecretKey() -->
</body>
</html>- Key Derivation: Argon2id for secure password hashing
- Elliptic Curve: Curve25519 for key exchange
- Post-Quantum: CRYSTALS-Kyber via CIRCL
- Symmetric Encryption: XChaCha20-Poly1305
- Compression: Zlib for data compression
- API Reference: pkg.go.dev/xipher.org/xipher
- Web Interface: xipher.org
- Examples: See usage examples above
We welcome contributions! Please:
- Fork the repository
- Create a feature branch
- Make your changes
- Add tests if applicable
- Submit a pull request
For bugs and feature requests, please open an issue.
This project is experimental and should be used with caution in production environments. If you discover security vulnerabilities, please report them responsibly.
- Password strength directly affects security
- Post-quantum algorithms are still evolving
- Regular updates recommended for latest security patches
This project is licensed under the terms specified in the LICENSE file.
Special thanks to the projects and people that made Xipher possible:
- Retriever - Inspiration for web-based encryption concepts
- CIRCL by Cloudflare - Post-quantum cryptography support
- StreamSaver.js - Browser file saving capabilities
- age - Inspiration for Curve25519 and XChaCha20-Poly1305 usage
Made with ❤️ for secure communication