Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/go-compile/rome
The Elliptic and Edward Curve cryptography library built for multi-curve use. Unified crypto interface for ECDSA, EdDSA, ECIES and ECDH. NIST Curves, Brainpool, Ed25519, Ed448.
https://github.com/go-compile/rome
crypto cryptography ecdh ecdsa ecies ed25519 edwards-curve elliptic-curves encrypt multi-curve p521
Last synced: about 11 hours ago
JSON representation
The Elliptic and Edward Curve cryptography library built for multi-curve use. Unified crypto interface for ECDSA, EdDSA, ECIES and ECDH. NIST Curves, Brainpool, Ed25519, Ed448.
- Host: GitHub
- URL: https://github.com/go-compile/rome
- Owner: go-compile
- License: gpl-3.0
- Created: 2022-06-06T21:40:29.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-01-17T16:16:08.000Z (10 months ago)
- Last Synced: 2024-01-18T00:07:34.240Z (10 months ago)
- Topics: crypto, cryptography, ecdh, ecdsa, ecies, ed25519, edwards-curve, elliptic-curves, encrypt, multi-curve, p521
- Language: Go
- Homepage:
- Size: 227 KB
- Stars: 1
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rome
[](https://pkg.go.dev/github.com/go-compile/rome)
[](https://goreportcard.com/report/go-compile/rome)
The Elliptic and Edward Curve cryptography library built for multi-curve use. Unified crypto interface for ECDSA, EdDSA, ECIES and ECDH. A high level library which gives you the control: specify curve, KDFs or hash functions, ciphers etc. In addition, rome features RSA.
Go Version: `>= 18.0`
Test Coverage: `80.0%`
## Implemented Curves/Keys & Features
| Curve/Key | Type | Sign | Verify | Encrypt | DH |
| :---------------- | :------------: | :--: | :----: | :-----: | :-: |
| Nist P-521 | Elliptic Curve | ✔ | ✔ | ✔ | ✔ |
| Nist P-384 | Elliptic Curve | ✔ | ✔ | ✔ | ✔ |
| Nist P-256 | Elliptic Curve | ✔ | ✔ | ✔ | ✔ |
| Nist P-224 | Elliptic Curve | ✔ | ✔ | ✔ | ✔ |
| Brainpool P160r1 | Elliptic Curve | ✔ | ✔ | ✔ | ✔ |
| Brainpool P160t1 | Elliptic Curve | ✔ | ✔ | ✔ | ✔ |
| Brainpool P192r1 | Elliptic Curve | ✔ | ✔ | ✔ | ✔ |
| Brainpool P192t1 | Elliptic Curve | ✔ | ✔ | ✔ | ✔ |
| Brainpool P224r1 | Elliptic Curve | ✔ | ✔ | ✔ | ✔ |
| Brainpool P224t1 | Elliptic Curve | ✔ | ✔ | ✔ | ✔ |
| Brainpool P256r1 | Elliptic Curve | ✔ | ✔ | ✔ | ✔ |
| Brainpool P256t1 | Elliptic Curve | ✔ | ✔ | ✔ | ✔ |
| Brainpool P320r1 | Elliptic Curve | ✔ | ✔ | ✔ | ✔ |
| Brainpool P320t1 | Elliptic Curve | ✔ | ✔ | ✔ | ✔ |
| Brainpool P384r1 | Elliptic Curve | ✔ | ✔ | ✔ | ✔ |
| Brainpool P384t1 | Elliptic Curve | ✔ | ✔ | ✔ | ✔ |
| Brainpool P512r1 | Elliptic Curve | ✔ | ✔ | ✔ | ✔ |
| Brainpool P512t1 | Elliptic Curve | ✔ | ✔ | ✔ | ✔ |
| Ed25519 | Edwards Curve | ✔ | ✔ | n/a | n/a |
| Ed448 | Edwards Curve | ✔ | ✔ | n/a | n/a |
| x25519/Curve25519 | Elliptic Curve | ✖ | ✖ | ✖ | ✖ |
| x448 Goldilocks | Elliptic Curve | ✖ | ✖ | ✖ | ✖ |
| RSA | RSA | ✔ | ✔ | ✔ | ✖ |
## Features
- Generate key
- Export (Public, Private) PEM **and** ASN.1 DER bytes
- Import (Public, Private) PEM **and** ASN.1 DER bytes
- Sign (ASN.1 format)
- Verify
- Elliptic Curve Diffie Hellman (ECDH)
- Encrypt (ECIES: AES_GCM 128 & 256 bit)
- Decrypt
- Retrieve Points
- Convert Public Keys to SSH keys
## Ciphers
| Cipher | Authenticated |
| :---------------: | :-----------: |
| AES_GCM | ✔ |
| ChaCha20 | ✖ |
| ChaCha20_SHA256 | ✔ |
| ChaCha20_SHA512 | ✔ |
| ChaCha20_Poly1305 | ✔ |
| Salsa20 | ✖ |
## Curves & Keys
- nist P-521
- nist P-384
- nist P-256
- nist P-224
- Ed25519
- Ed448
- Brainpool P160t1
- Brainpool P192r1
- Brainpool P192t1
- Brainpool P224r1
- Brainpool P224t1
- Brainpool P256r1
- Brainpool P256t1
- Brainpool P320r1
- Brainpool P320t1
- Brainpool P384r1
- Brainpool P384t1
- Brainpool P512r1
- Brainpool P512t1
- RSA
## Todo
- secp256k1
- saltpack
- Encrypt private key option
## Encrypt (ECIES)
Rome supports ECIES for elliptic curves allowing you to encrypt to a public key. Encryption can be customised with cipher options: `AES_256_GCM` (more coming soon) and customise KDFs used for shared secret generation (ECDH). Supporting the hash.Hash interface you can use your favourite algorithm. It's even possible to use Argon2 as a KDF.
Encrypt example with `AES_256_GCM_SHA256`:
```go
package main
import (
"crypto/sha256"
"fmt"
"os"
"github.com/go-compile/rome"
"github.com/go-compile/rome/p256"
)
func main() {
// Generate a nist P256 Elliptic Curve
k, err := p256.Generate()
if err != nil {
panic(err)
}
pub := k.Public()
msg := []byte("Secret message.")
// encrypt message using AES256_GCM with SHA256 and a 98bit nonce
ciphertext, err := pub.Encrypt(msg, rome.CipherAES_GCM, sha256.New())
if err != nil {
panic(err)
}
fmt.Printf("%X\n", ciphertext)
}
```
## Install
```sh
go get -u github.com/go-compile/rome
```
## Examples
Full code [examples can be found ./examples/](./examples/)
```go
package main
import (
"fmt"
"github.com/go-compile/rome"
"github.com/go-compile/rome/p256"
)
func main() {
// Generate a nist P256 Elliptic Curve
k, err := p256.Generate()
if err != nil {
panic(err)
}
printKey("P256", k)
}
func printKey(name string, k rome.PrivateKey) {
// Format private key using PEM and ASN.1 DER bytes
private, err := k.Private()
if err != nil {
panic(err)
}
public, err := k.Public().Key()
if err != nil {
panic(err)
}
fmt.Printf("%s:\n Private:\n%s\n Public:\n%s\n",
name, string(private), string(public))
}
```
Output:
```
P256:
Private:
-----BEGIN EC PRIVATE KEY-----
MHcCAQEEIATPRwGmsr81mgiH1Tf+yntyUcj0m9Ta3UsaWrgPjZtKoAoGCCqGSM49
AwEHoUQDQgAENjGsmnjl4dXbRur5AfzlDxq6Bp0BQafwM7DJdhSv1yUNRF3+oDsw
mZ9MD9z6VjjBh8REN6e0SDIM/IJCZL84DA==
-----END EC PRIVATE KEY-----
Public:
-----BEGIN EC PUBLIC KEY-----
MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAENjGsmnjl4dXbRur5AfzlDxq6Bp0B
QafwM7DJdhSv1yUNRF3+oDswmZ9MD9z6VjjBh8REN6e0SDIM/IJCZL84DA==
-----END EC PUBLIC KEY-----
```