https://github.com/cunicu/go-rosenpass

A port of Rosenpass post-quantum key-exchange protocol to Go.
https://github.com/cunicu/go-rosenpass

cryptography go golang post-quantum rosenpass vpn wireguard

Last synced: about 1 month ago
JSON representation

A port of Rosenpass post-quantum key-exchange protocol to Go.

• Host: GitHub
• URL: https://github.com/cunicu/go-rosenpass
• Owner: cunicu
• License: apache-2.0
• Created: 2023-05-19T21:09:32.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-29T08:00:29.000Z (8 months ago)
• Last Synced: 2024-05-02T06:17:22.184Z (8 months ago)
• Topics: cryptography, go, golang, post-quantum, rosenpass, vpn, wireguard
• Language: Go
• Homepage:
• Size: 223 KB
• Stars: 15
• Watchers: 5
• Forks: 1
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# go-rosenpass

[![Codecov branch](https://img.shields.io/codecov/c/github/cunicu/go-rosenpass/main?style=flat-square&token=xUGG2iEsuQ)](https://app.codecov.io/gh/cunicu/go-rosenpass/tree/main)

[![goreportcard](https://goreportcard.com/badge/github.com/cunicu/go-rosenpass?style=flat-square)](https://goreportcard.com/report/github.com/cunicu/go-rosenpass)

[![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square)](https://github.com/cunicu/go-rosenpass/blob/main/LICENSES/Apache-2.0.txt)

![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/cunicu/go-rosenpass?style=flat-square)

[![Go Reference](https://pkg.go.dev/badge/github.com/cunicu/go-rosenpass.svg)](https://pkg.go.dev/github.com/cunicu/go-rosenpass)

🚧 go-rosenpass has not been audited. Please use with care!

go-rosenpass is a port of [Rosenpass](https://github.com/rosenpass/rosenpass) to [Go](https://go.dev/).

The implementation aims to be compatible with the reference implementation in Rust for the:

- on-wire protocol

- handshake parameters

- command-line interface

## Installation

### Binary releases

_go-rosenpass_ distributes builds via [GitHub Releases](https://github.com/cunicu/go-rosenpass/releases).

You can download a pre-built binary from there.

### From source

```bash

go install cunicu.li/go-rosenpass/cmd@latest

```

## Example Setup

```bash

# Generate our own WireGuard key pair

WG_PRIVATE_KEY=$(wg genkey)

WG_PUBLIC_KEY=$(wg pubkey <<< ${WG_PRIVATE_KEY})

# Generate our own Rosenpass key pair

go-rosenpass gen-keys-intf wg0

# Show our details

echo "Your hostname: $(hostname)"

echo "Your WireGuard public key: ${WG_PUBLIC_KEY}"

# Query the peer details

read -p "Enter your peers hostname: " PEER

read -p "Enter your peers WireGuard public key: " WG_PUBLIC_KEY_PEER

# Exchange Rosenpass public key

scp /etc/wireguard/wg0/pqpk root@${PEER}:/etc/wireguard/wg0/${WG_PUBLIC_KEY//\//}.pqpk

# Generate wg-quick configuration

cat <> /etc/wireguard/wg0.conf

[Interface]

PrivateKey = ${WG_PRIVATE_KEY}

ListenPort = 51820

PostUp = go-rosenpass exchange-intf %i & echo $! > /run/go-rosenpass.%i.pid

PreDown = pkill -F /run/go-rosenpass.%i.pid || true

[Peer]

PublicKey = ${WG_PUBLIC_KEY_PEER}

Endpoint = ${PEER}:51820

EOF

# Bring connection up

wg-quick up wg0

```

## References

- 

- 

- 

## Contact

Please have a look at the contact page: [cunicu.li/docs/contact](https://cunicu.li/docs/contact).

## License

go-rosenpass is licensed under the [Apache 2.0](./LICENSE) license.

- SPDX-FileCopyrightText: 2023 Steffen Vogel 

- SPDX-License-Identifier: Apache-2.0