rosenpass

README

go-rosenpass

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

go-rosenpass is a port of Rosenpass to Go.

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. You can download a pre-built binary from there.

From source

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

Example Setup

# 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 <<EOF >> /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

• https://github.com/rosenpass/rosenpass
• https://rosenpass.eu/
• https://media.ccc.de/v/eh20-4-rosenpass-ein-vpn-zum-schutz-vor-quantencomputern

Contact

Please have a look at the contact page: cunicu.li/docs/contact.

License

go-rosenpass is licensed under the Apache 2.0 license.

• SPDX-FileCopyrightText: 2023 Steffen Vogel post@steffenvogel.de
• SPDX-License-Identifier: Apache-2.0

Documentation

Index

• Variables
• func GenerateKeyPair() (PublicKey, SecretKey, error)
• func GenerateRound2KeyPair() (PublicKey, SecretKey, error)
• func ParsePeerID(s string) (pid, error)
• type Config
• type Conn
• type Endpoint
• type Handler
• type HandshakeCompletedHandler
• type HandshakeExpiredHandler
• type Key
  • func GeneratePresharedKey() (Key, error)
• type KeyOutput
  • func ParseKeyOutput(str string) (o KeyOutput, err error)
  • func (o KeyOutput) String() string
• type KeyOutputReason
• type PeerConfig
  • func (p *PeerConfig) PID() PeerID
• type PeerID
  • func PeerIDFromPublicKey(spk spk) PeerID
• type PresharedKey
• type PublicKey
• type ReceiveFunc
• type SecretKey
• type Server
  • func NewServer(cfg Config) (*Server, error)
  • func NewUDPServer(cfg Config) (_ *Server, err error)
  • func (s *Server) AddPeer(pCfg PeerConfig) (PeerID, error)
  • func (s *Server) Close() error
  • func (s *Server) PID() PeerID
  • func (s *Server) RemovePeer(pid pid) error
  • func (s *Server) Run() error
• type SinglePortUDPConn
  • func NewSinglePortUDPConn(la []*net.UDPAddr) (*SinglePortUDPConn, error)
  • func (c *SinglePortUDPConn) Close() error
  • func (c *SinglePortUDPConn) LocalEndpoints() (eps []Endpoint, err error)
  • func (c *SinglePortUDPConn) Open() (recvFncs []ReceiveFunc, err error)
  • func (c *SinglePortUDPConn) Send(pl payload, spkt spk, ep Endpoint) error
• type UDPConn
  • func NewUDPConn(la []*net.UDPAddr) (*UDPConn, error)
  • func (c *UDPConn) Close() error
  • func (c *UDPConn) LocalEndpoints() (eps []Endpoint, err error)
  • func (s *UDPConn) Open() ([]ReceiveFunc, error)
  • func (c *UDPConn) Send(pl payload, spkt spk, ep Endpoint) error
• type UDPEndpoint
  • func NewUDPEndpoint(s string) (*UDPEndpoint, error)
  • func (ep UDPEndpoint) Equal(o Endpoint) bool
  • func (ep *UDPEndpoint) String() string

Variables

var (

	// From the WireGuard paper
	// Rekey every two minutes, discard the key if no rekey is achieved within three.
	RekeyAfterTimeResponder = 2 * time.Minute
	RekeyAfterTimeInitiator = RekeyAfterTimeResponder + 10*time.Second
	RejectAfterTime         = 3 * time.Minute

	// Seconds until the biscuit key is changed; we issue biscuits
	// using one biscuit key for one epoch and store the biscuit for
	// decryption for a second epoch.
	BiscuitEpoch = 5 * time.Minute

	// Retransmission constants
	// will retransmit for up to 2 minutes; starting with a delay of
	// 0.5 seconds and increasing the delay exponentially by a factor of
	// 2 up to 10 seconds. An additional jitter factor of ±0.5 seconds is added.
	RetransmitDelayGrowth = 2.0
	RetransmitDelayBegin  = 500 * time.Millisecond
	RetransmitDelayEnd    = 10 * time.Second
	RetransmitDelayJitter = 500 * time.Millisecond
)

Functions

func GenerateKeyPair

func GenerateKeyPair() (PublicKey, SecretKey, error)

GenerateKeyPair generates a new Classic McEliece key pair.

func GenerateRound2KeyPair

func GenerateRound2KeyPair() (PublicKey, SecretKey, error)

GenerateKeyPair generates a new Classic McEliece key pair in its old (round 2) format.

func ParsePeerID

func ParsePeerID(s string) (pid, error)

Types

type Config

type Config struct {
	ListenSinglePort bool
	ListenAddrs      []*net.UDPAddr

	PublicKey spk
	SecretKey ssk

	Peers    []PeerConfig
	Handlers []Handler

	Conn Conn

	Logger *slog.Logger
	// contains filtered or unexported fields
}

type Conn

type Conn interface {
	Close() error
	Open() ([]ReceiveFunc, error)
	Send(pl payload, spkm spk, cep Endpoint) error

	// A list of local endpoints at which the Conn can receive handshake messages
	LocalEndpoints() ([]Endpoint, error)
}

type Endpoint

type Endpoint interface {
	String() string
	Equal(Endpoint) bool
}

type Handler

type Handler any

Handler is on of the supported handlers declared below.

type HandshakeCompletedHandler

type HandshakeCompletedHandler interface {
	HandshakeCompleted(pid, key)
}

type HandshakeExpiredHandler

type HandshakeExpiredHandler interface {
	HandshakeExpired(pid)
}

type Key

type Key = key

func GeneratePresharedKey

func GeneratePresharedKey() (Key, error)

Generates a new pre-shared key.

type KeyOutput

type KeyOutput struct {
	Peer    PeerID
	KeyFile string
	Why     KeyOutputReason
}

Output format: output-key peer {} key-file {of:?} {why}.

func ParseKeyOutput

func ParseKeyOutput(str string) (o KeyOutput, err error)

func (KeyOutput) String

func (o KeyOutput) String() string

type KeyOutputReason

type KeyOutputReason string

const (
	KeyOutputReasonExchanged KeyOutputReason = "exchanged"
	KeyOutputReasonStale     KeyOutputReason = "stale"
)

type PeerConfig

type PeerConfig struct {
	PublicKey    spk // The peer’s public key
	PresharedKey key // The peer's pre-shared key

	Endpoint *net.UDPAddr // The peers's endpoint
}

func (*PeerConfig) PID

func (p *PeerConfig) PID() PeerID

type PeerID

type PeerID = pid

Some aliases for the public API.

func PeerIDFromPublicKey

func PeerIDFromPublicKey(spk spk) PeerID

type PresharedKey

type PresharedKey = key

type PublicKey

type PublicKey = spk

type ReceiveFunc

type ReceiveFunc func(spkm spk) (payload, Endpoint, error)

type SecretKey

type SecretKey = ssk

type Server

type Server struct {
	// contains filtered or unexported fields
}

func NewServer

func NewServer(cfg Config) (*Server, error)

func NewUDPServer

func NewUDPServer(cfg Config) (_ *Server, err error)

func (*Server) AddPeer

func (s *Server) AddPeer(pCfg PeerConfig) (PeerID, error)

func (*Server) Close

func (s *Server) Close() error

func (*Server) PID

func (s *Server) PID() PeerID

func (*Server) RemovePeer

func (s *Server) RemovePeer(pid pid) error

func (*Server) Run

func (s *Server) Run() error

type SinglePortUDPConn

type SinglePortUDPConn struct {
	// contains filtered or unexported fields
}

func NewSinglePortUDPConn

func NewSinglePortUDPConn(la []*net.UDPAddr) (*SinglePortUDPConn, error)

func (*SinglePortUDPConn) Close

func (c *SinglePortUDPConn) Close() error

func (*SinglePortUDPConn) LocalEndpoints

func (c *SinglePortUDPConn) LocalEndpoints() (eps []Endpoint, err error)

func (*SinglePortUDPConn) Open

func (c *SinglePortUDPConn) Open() (recvFncs []ReceiveFunc, err error)

func (*SinglePortUDPConn) Send

func (c *SinglePortUDPConn) Send(pl payload, spkt spk, ep Endpoint) error

type UDPConn

type UDPConn struct {
	// contains filtered or unexported fields
}

func NewUDPConn

func NewUDPConn(la []*net.UDPAddr) (*UDPConn, error)

func (*UDPConn) Close

func (c *UDPConn) Close() error

func (*UDPConn) LocalEndpoints

func (c *UDPConn) LocalEndpoints() (eps []Endpoint, err error)

func (*UDPConn) Open

func (s *UDPConn) Open() ([]ReceiveFunc, error)

func (*UDPConn) Send

func (c *UDPConn) Send(pl payload, spkt spk, ep Endpoint) error

type UDPEndpoint

type UDPEndpoint net.UDPAddr

func NewUDPEndpoint

func NewUDPEndpoint(s string) (*UDPEndpoint, error)

func (UDPEndpoint) Equal

func (ep UDPEndpoint) Equal(o Endpoint) bool

func (*UDPEndpoint) String

func (ep *UDPEndpoint) String() string