From 59b3dae32d97d0c115bf4132cd5ce75ba0ea7459 Mon Sep 17 00:00:00 2001 From: Alice Bowman Date: Wed, 4 Sep 2024 17:43:16 +0200 Subject: [PATCH] Redesign: documentation section --- config.toml | 2 +- content/en/_index.html | 2 +- content/en/docs/_index.html | 68 +- content/en/docs/manuals/_index.html | 18 - content/en/docs/pentest.md | 11 - content/en/docs/presentations/_index.html | 19 - content/en/docs/rosenpass-project/_index.html | 20 + content/en/docs/rosenpass-project/pentest.md | 12 + .../presentations/_index.html | 21 + .../presentations/easterhegg-2023.md | 0 .../presentations/formosa-2023.md | 0 .../presentations/hackmas-2024.md | 0 .../presentations/iav-2023.md | 0 .../presentations/mrmcd-2023.md | 0 .../presentations/rwpqc-2023.md | 0 .../presentations/yrcs-2023.md | 0 .../en/docs/rosenpass-project/whitepaper.md | 12 + content/en/docs/rosenpass-tool/_index.html | 62 + content/en/docs/rosenpass-tool/changelog.md | 1452 +++++++++++++++++ .../docs/{ => rosenpass-tool}/compilation.md | 1 + .../docs/rosenpass-tool/manuals/_index.html | 27 + .../manuals/rosenpass_manual_custom.md | 0 .../docs/{ => rosenpass-tool}/manuals/rp1.md | 0 .../{ => rosenpass-tool}/manuals/rp_manual.md | 0 .../{ => rosenpass-tool}/release_notes.md | 3 +- content/en/docs/rosenpass-tool/source_code.md | 12 + .../en/docs/{ => rosenpass-tool}/start.html | 7 +- content/en/docs/source_code.md | 11 - content/en/docs/whitepaper.md | 11 - layouts/docs/baseof.html | 4 +- layouts/docs/baseof.print.html | 2 +- static/css/rosenpass.css | 61 +- 32 files changed, 1701 insertions(+), 137 deletions(-) delete mode 100644 content/en/docs/manuals/_index.html delete mode 100644 content/en/docs/pentest.md delete mode 100644 content/en/docs/presentations/_index.html create mode 100644 content/en/docs/rosenpass-project/_index.html create mode 100644 content/en/docs/rosenpass-project/pentest.md create mode 100644 content/en/docs/rosenpass-project/presentations/_index.html rename content/en/docs/{ => rosenpass-project}/presentations/easterhegg-2023.md (100%) rename content/en/docs/{ => rosenpass-project}/presentations/formosa-2023.md (100%) rename content/en/docs/{ => rosenpass-project}/presentations/hackmas-2024.md (100%) rename content/en/docs/{ => rosenpass-project}/presentations/iav-2023.md (100%) rename content/en/docs/{ => rosenpass-project}/presentations/mrmcd-2023.md (100%) rename content/en/docs/{ => rosenpass-project}/presentations/rwpqc-2023.md (100%) rename content/en/docs/{ => rosenpass-project}/presentations/yrcs-2023.md (100%) create mode 100644 content/en/docs/rosenpass-project/whitepaper.md create mode 100644 content/en/docs/rosenpass-tool/_index.html create mode 100644 content/en/docs/rosenpass-tool/changelog.md rename content/en/docs/{ => rosenpass-tool}/compilation.md (94%) create mode 100644 content/en/docs/rosenpass-tool/manuals/_index.html rename content/en/docs/{ => rosenpass-tool}/manuals/rosenpass_manual_custom.md (100%) rename content/en/docs/{ => rosenpass-tool}/manuals/rp1.md (100%) rename content/en/docs/{ => rosenpass-tool}/manuals/rp_manual.md (100%) rename content/en/docs/{ => rosenpass-tool}/release_notes.md (97%) create mode 100644 content/en/docs/rosenpass-tool/source_code.md rename content/en/docs/{ => rosenpass-tool}/start.html (97%) delete mode 100644 content/en/docs/source_code.md delete mode 100644 content/en/docs/whitepaper.md diff --git a/config.toml b/config.toml index ccef051c..46ff4340 100644 --- a/config.toml +++ b/config.toml @@ -39,7 +39,7 @@ enableRobotsTXT = true name = "Quick Start" #pre = "" weight = 15 - url = "/docs/start" + url = "/docs/rosenpass-tool/start" [[menu.main]] name = "What is Rosenpass?" weight = 16 diff --git a/content/en/_index.html b/content/en/_index.html index 491dbbbe..04c33220 100644 --- a/content/en/_index.html +++ b/content/en/_index.html @@ -11,7 +11,7 @@ {{< blocks/cover title="Rosenpass" image_anchor="top" height="auto" color="white" >}}

Build post-quantum-secure VPNs with WireGuard!

- + Quick Start }}"> diff --git a/content/en/docs/_index.html b/content/en/docs/_index.html index 5741661b..978ab5dc 100644 --- a/content/en/docs/_index.html +++ b/content/en/docs/_index.html @@ -5,64 +5,24 @@ menu: main: weight: 30 -no_list: true +landing_page: true --- {{< blocks/lead color="primary" class="mb-5" >}} -

Documentation

+

Documentation

{{< /blocks/lead >}} - -

- Welcome to the documentation page for Rosenpass. This guide contains the manual pages, slides from various presentations, -as well as links to both our scientific whitepaper and the github repository for the Rosenpass source code. +{{< blocks/section color="white" class="pb-0 pt-2" >}} +

+ Welcome to the documentation page for Rosenpass! This guide contains everything you need to get started with Rosenpass as a software developer, a scientist, a potential collaborator, or as anyone looking to upgrade their security to be post-quantum secure.

+

The content found here can be broadly split into two categories: software and science. You will find links to installation and compilation guides, versioning information, and command-line manuals, as well as to our whitepaper describing the Rosenpass protocol, presentations looking to communicate the scientific + underpinnings of our project, and the results of a penetration test performed on our software.

-

What is Rosenpass?

-

- Rosenpass is a daemon, that, given a private key and a list of peers, performs a key exchange with each peer. - The resulting shared secrets are given to WireGuard using its PSK feature – WireGuard remains as secure as it was, Rosenpass adds - protection against quantum computers. Rosenpass can also write the shared secrets to files; this can be used to integrate Rosenpass - with tools other than WireGuard. -

- -

Who is Rosenpass for?

-

- Rosenpass is for everyone who wants secure encryption, particularly in a world where "store now, decrypt later" attacks are considered to be a present threat. If your data is being encrypted with methods that are not post-quantum secure, that data may - already be vulnerable to harvest attacks relying on future access to quantum computing. The goal of Rosenpass is to protect - everyone from that future, much as classical encryption methods protect everyone in a pre-quantum world. That said, there is - a skill-floor to using the currently available implementations of Rosenpass. Typically, developers with some experience of - manually configured VPNs will have the easiest time setting up the Rosenpass daemon, particularly those using specific versions - of Linux. Support for further systems is actively being researched, but is not currently imminent. -

-

Quick Start

-

- If you simply want to get Rosenpass up and running quickly, you are best served using the Quick Start Guide. - It contains everything you need to download, configure, and start a WireGuard connection using the Rosenpass key exchange. -

-

Which systems are supported by Rosenpass?

-

- Rosenpass currently provides packages and static binaries for several Linux distributions, as shown here: -

- - - - -

What planned features are on the way?

- - -

Current Version

-

  0.2.2

-

   Release Notes

- +

Quick Start

+

+ If you simply want to get the Rosenpass tool up and running quickly, you are best served using our Quick Start Guide. + It contains everything you need to download, configure, and start a WireGuard connection using the Rosenpass key exchange. +

+{{< /blocks/section >}} - {{< blocks/rss-button href="https://github.com/rosenpass/rosenpass/releases.atom" color="dark" text="Stay up to date with Rosenpass releases by subscribing to the GitHub Release Atom feed!" >}} \ No newline at end of file + \ No newline at end of file diff --git a/content/en/docs/manuals/_index.html b/content/en/docs/manuals/_index.html deleted file mode 100644 index a3095100..00000000 --- a/content/en/docs/manuals/_index.html +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "Manuals" -linkTitle: "Manuals" -type: docs -weight: 30 -menu: false -no_list: true ---- - -

This section contains conversions of .1 format manual pages into a html-readable format.

- -
-

Rosenpass Manual (1) (rp) EN

-

Manual page for using Rosenpass to build post-quantum-secure VPNs

- -
-

Rosenpass High-Level Interface (rp) EN

-

Manual page for configuring a high-level interface to Rosenpass.

\ No newline at end of file diff --git a/content/en/docs/pentest.md b/content/en/docs/pentest.md deleted file mode 100644 index d94a832e..00000000 --- a/content/en/docs/pentest.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: "Penetration Test 2024" -linkTitle: "Penetration Test Report" -weight: 6 -menu: false -type: docs -icon: fa-sharp fa-solid fa-file-pdf -pdf_filename: "../../report_ngir-rosenpass.pdf" ---- - -{{< blocks/pdfembed >}} \ No newline at end of file diff --git a/content/en/docs/presentations/_index.html b/content/en/docs/presentations/_index.html deleted file mode 100644 index 3ec8fbd1..00000000 --- a/content/en/docs/presentations/_index.html +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: "Conference Presentations" -linkTitle: "Conference Presentations" -type: docs -weight: 20 -menu: false -no_list: false ---- - -{{< blocks/lead color="primary" >}} -

Conference Presentations

-{{< /blocks/lead >}} - -{{< blocks/section color="light" class="pt-5 pb-5">}} -

-In this section you can find the slides of presentations we held. -For some talks, there are also videos recordings available. -

-{{< /blocks/section >}} \ No newline at end of file diff --git a/content/en/docs/rosenpass-project/_index.html b/content/en/docs/rosenpass-project/_index.html new file mode 100644 index 00000000..829a49ce --- /dev/null +++ b/content/en/docs/rosenpass-project/_index.html @@ -0,0 +1,20 @@ +--- +title: "The Rosenpass Project" +linkTitle: "The Rosenpass Project" +type: docs +weight: 20 +menu: false + +blerb: "Rosenpass is a project to produce free/libre, open source, and open science cryptographic tooling to aid the migration of the internet's + infrastructure towards post-quantum secure cryptography, e.g encryption and authentication. Currently, the project consists of the Rosenpass + protocol, itsimplementation in the Rosenpass tool, and a cryptographic analysis of its security using [ProVerif](https://bblanche.gitlabpages.inria.fr/proverif/). We focus our work towards better + integration of academic cryptography, the development of software, and its deployment in industry and infrastructure." +--- + +{{< blocks/lead color="primary" >}} +

The Rosenpass Project

+{{< /blocks/lead >}} + +{{< blocks/section color="light" class="pt-5 pb-0">}} +aasdfasdf +{{< /blocks/section >}} \ No newline at end of file diff --git a/content/en/docs/rosenpass-project/pentest.md b/content/en/docs/rosenpass-project/pentest.md new file mode 100644 index 00000000..f5512e1b --- /dev/null +++ b/content/en/docs/rosenpass-project/pentest.md @@ -0,0 +1,12 @@ +--- +title: "Penetration Test 2024" +linkTitle: "Penetration Test Report" +weight: 6 +menu: false +type: docs +icon: fa-sharp fa-solid fa-file-pdf +pdf_filename: "../../report_ngir-rosenpass.pdf" +blerb: "Radically Open Security's January 2024 report on their penetration test of the Rosenpass tool late in 2023. This document outlines several attacks, tests, and reviews of code and practice relating to the Rosenpass tool, and a summary of the findings." +--- + +{{< blocks/pdfembed >}} \ No newline at end of file diff --git a/content/en/docs/rosenpass-project/presentations/_index.html b/content/en/docs/rosenpass-project/presentations/_index.html new file mode 100644 index 00000000..f0711da0 --- /dev/null +++ b/content/en/docs/rosenpass-project/presentations/_index.html @@ -0,0 +1,21 @@ +--- +title: "Conference Presentations" +linkTitle: "Conference Presentations" +type: docs +weight: 20 +menu: false +no_list: false +presentation_list: true +blerb: "As part of our work, we give numerous talks and presentations aimed at communicating the science behind the Rosenpass tool, project and protocol, as well as cryptography more generally. This section contains the presentation slides for several of these talks and, where available, video recordings of them. Please be aware that some of these talks are not in English, but are clearly marked as such." +--- + +{{< blocks/lead color="primary" >}} +

Conference Presentations

+{{< /blocks/lead >}} + +{{< blocks/section color="light" class="pt-5 pb-0">}} +

+In this section you can find the slides of presentations we held. +For some talks, there are also videos recordings available. +

+{{< /blocks/section >}} \ No newline at end of file diff --git a/content/en/docs/presentations/easterhegg-2023.md b/content/en/docs/rosenpass-project/presentations/easterhegg-2023.md similarity index 100% rename from content/en/docs/presentations/easterhegg-2023.md rename to content/en/docs/rosenpass-project/presentations/easterhegg-2023.md diff --git a/content/en/docs/presentations/formosa-2023.md b/content/en/docs/rosenpass-project/presentations/formosa-2023.md similarity index 100% rename from content/en/docs/presentations/formosa-2023.md rename to content/en/docs/rosenpass-project/presentations/formosa-2023.md diff --git a/content/en/docs/presentations/hackmas-2024.md b/content/en/docs/rosenpass-project/presentations/hackmas-2024.md similarity index 100% rename from content/en/docs/presentations/hackmas-2024.md rename to content/en/docs/rosenpass-project/presentations/hackmas-2024.md diff --git a/content/en/docs/presentations/iav-2023.md b/content/en/docs/rosenpass-project/presentations/iav-2023.md similarity index 100% rename from content/en/docs/presentations/iav-2023.md rename to content/en/docs/rosenpass-project/presentations/iav-2023.md diff --git a/content/en/docs/presentations/mrmcd-2023.md b/content/en/docs/rosenpass-project/presentations/mrmcd-2023.md similarity index 100% rename from content/en/docs/presentations/mrmcd-2023.md rename to content/en/docs/rosenpass-project/presentations/mrmcd-2023.md diff --git a/content/en/docs/presentations/rwpqc-2023.md b/content/en/docs/rosenpass-project/presentations/rwpqc-2023.md similarity index 100% rename from content/en/docs/presentations/rwpqc-2023.md rename to content/en/docs/rosenpass-project/presentations/rwpqc-2023.md diff --git a/content/en/docs/presentations/yrcs-2023.md b/content/en/docs/rosenpass-project/presentations/yrcs-2023.md similarity index 100% rename from content/en/docs/presentations/yrcs-2023.md rename to content/en/docs/rosenpass-project/presentations/yrcs-2023.md diff --git a/content/en/docs/rosenpass-project/whitepaper.md b/content/en/docs/rosenpass-project/whitepaper.md new file mode 100644 index 00000000..4316560f --- /dev/null +++ b/content/en/docs/rosenpass-project/whitepaper.md @@ -0,0 +1,12 @@ +--- +title: "Whitepaper" +linkTitle: "Whitepaper" +weight: 2 +menu: false +type: docs +icon: fa-sharp fa-solid fa-file-pdf +pdf_filename: "../../whitepaper.pdf" +blerb: "This document is a guide for engineers and researchers implementing the protocol. It is a scientific paper discussing the secruity properties of Rosenpass as a work-in-progress." +--- + +{{< blocks/pdfembed >}} \ No newline at end of file diff --git a/content/en/docs/rosenpass-tool/_index.html b/content/en/docs/rosenpass-tool/_index.html new file mode 100644 index 00000000..1a597716 --- /dev/null +++ b/content/en/docs/rosenpass-tool/_index.html @@ -0,0 +1,62 @@ +--- +title: "The Rosenpass Tool" +linkTitle: "The Rosenpass Tool" +type: docs +weight: 20 +menu: false + +blerb: "The Rosenpass tool is a daemon, written in Rust, that implements the Rosenpass protocol to create and exchange hybridised post-quantum and + classically secure keys between two peers. Using a hybrid security model allows us to preserve the reliability of battle-proven classical + cryptography whilst still providing the necessary upgrade to secure against decryption of data by quantum computers (i.e., protect against + “store-now decrypt-later attacks”). + + +The Rosenpass tool works best and most natively with [WireGuard](https://www.wireguard.com/), as it was first envisioned specifically to inject post-quantum secured keys +into WireGuard using its Pre-Shared Key parameter. However, as the Rosenpass tool can export its shared secrets to a file, it can be implemented +in other use cases. We were able to demonstrate its potential for integration with Transport Layer Security (TLS), in [this tutorial](/blog/tlsrosenpass_july) on using +[OpenSSL](https://openssl.org/) with Rosenpass." +--- + + + +{{< blocks/section color="light" class="pt-5 pb-0">}} + +

Which systems are supported by Rosenpass?

+

+ Rosenpass currently provides packages and static binaries for several Linux distributions, as shown below: +

+ +
+
+ +
+
+

0.2.2 Release Notes

+
    +
  • Fixes vulnerability to prevent output shared key (OSK) to be set or written again on a responder receiving the same InitConf message during a handshake.
    • +
  • This release has no impact for majority of users using Rosenpass with Wireguard
    • +
+
+
+ + + +

What planned features are on the way?

+
    +
  • Cunicu integration: Cunicu is a user-space daemon for managing WireGuard connections for small devices. We intend to integrate post-quantum security into that daemon via Rosenpass
    • +
  • Docker and micro-VM implementations: We are currently working on using micro-VMs to reduce the scope of system privileges Rosenpass needs to run
    • +
  • Hacspec integration: Hackspec is a rust-based language designed by Cryspen to enable the use of several formal verification tools that enable high-assurance cryptography
    • +
  • NetBird partnership: We are working with NetBird to produce a commercially-ready VPN service that is post-quantum secure
    • +
  • Golang implementation of Rosenpass: Our initial implementation of Rosenpass is written in Rust, but we are working on an alternative, compatible Golang-built implementation to increase diversity and reach new platforms. + It is called go-rosenpass.
    • +
+{{< /blocks/section >}} diff --git a/content/en/docs/rosenpass-tool/changelog.md b/content/en/docs/rosenpass-tool/changelog.md new file mode 100644 index 00000000..3c012f87 --- /dev/null +++ b/content/en/docs/rosenpass-tool/changelog.md @@ -0,0 +1,1452 @@ +--- +title: "" +linkTitle: "Changelog" +weight: 5 +menu: false +type: docs +draft: true +--- + +
+
• unreleased / untagged
+ +

+ +

+
+
+ +
+
- d81733a
Changelog workflow
+
+ +
+
- 1555d08
Drop obsolete RTX_BUFFER_SIZE and usize_max
+
+ +
+
- abdbf8f
Cleanup, document and add tests
+
+ +
+
- 77760d7
Use mio::Token based polling
+
+ +
+
- 53e5601
Close API connections after error
+
+ +
+
- 594f894
AddPskBroker endpoint
+
+ +
+
- 24eebe2
AddListenSocket endpoint
+
+ +
+
- 1d2fa7d
API Feature – Add server keys via API
+
+ +
+
- edf1e77
SupplyKeypair endpoint
+
+ +
+
- 065b0fc
Add enable_wg_broker feature using MioBrokerClient
+
+ +
+
- 1853e0a
Add test case and check fd value
+
+ +
+
- 245d4d1
Add tests for util file.rs
+
+ +
+
- 6d47169
Set CLOEXEC flag on claimed fds and mask them
+
+ +
+
- 4bcd38a
Infrastructure for the Rosenpass API
+
+ +
+
- 730a039
A variety of utilities in preparation for implementing the API
+
+ +
+
- ea071f5
Convenience functions and traits to automatically handle ErrorKind::{Interrupt, WouldBlock}
+
+ +
+
- 3063d3e
Convenience traits to get the ErrorKind of an io error for match clauses
+
+ +
+
- 1bf0eed
Convenience function to just call a function
+
+ +
+
- 99ac3c0
Experimental support for encryption using libcrux
+
+ +
+
- d0a6e99
Regression CI based on misc/generate_configs.py
+
+ +
+
- 7a4f700
Improved memfd-secret allocation (#347)
+
+ +
+
- c1abfbf
Add wireguard-broker interface in AppServer (#303)
+
+ +
+
- 2bac991
Merge from dev/broker-architecture, fixes, test
+
+ +
+
- 4bb3153
Change base64 to base64ct crate (#295)
+
+ +
+
- cc7e8dc
Implement rp tool in Rust (#235)
+
+ +
+
- ca972e8
Remove libsodium
+
+ +
+
- 2fa0a2a
Use core::hint::black_box in rosenpass_constant_time::xor
+
+ +
+
- b620368
Migrate away from sodium blake2b towards the rust crypto implementation
+
+ +
+
- e0f75ab
Use xchacha implementation from rust crypto instead of sodium
+
+ +
+
- 0789c60
Use chacha implementation from rust crypto instead of sodium
+
+ +
+
- 85c4470
Migrate to memsec
+
+ +
+
- b2a64ed
Add INITIATOR_TEST and RESPONDER_TEST macros
+
+ +
+
- 91da0df
Identity hiding in two stage process
+
+ +
+
- 4a170b1
Add inital identity hiding code to proverif
+
+ +
+
- eb76179
Add format_rustcode.sh script
+
+ +
+
- 3a0ebd2
Add fuzzing for libsodium allocator
+
+ +
+
- d45e24e
Move lenses into library
+
+ +
+
- 101c9bf
Add an internal library for guaranteed results
+
+ +
+
- 5448cdc
Use the rand crate for random values instead of sodium
+
+ +
+
- 77cd8a9
Move prftree into ciphers crate
+
+ +
+
- 70fa9bd
Wrap sodium_malloc as a custom allocator
+
+ +
+
- 85a6180
Use the zeroize crate for zeroization
+
+ +
+
- d539be3
Rosenpass-to for nicely handling destination parameters
+
+ +
+
- a49254a
Add initial set of fuzzing targets
+
+
+
+ +

+ +

+
+
+ +
+
- c81d484
Tests failing on mac
+
+ +
+
- 9bbf943
Be polite and kill child processes in api integration tests
+
+ +
+
- c1704b1
Wrong response size set
+
+ +
+
- 0fe2d98
Remove ineffectual broker integration test
+
+ +
+
- ab805da
Libc & rustix are making problems in CI for unknown reasons
+
+ +
+
- 258efe4
PSK broker integration did not work
+
+ +
+
- 8808ed5
Quiet log level should be warn
+
+ +
+
- 1ab457e
Print stack trace to errors propagated to main function
+
+ +
+
- c9c266f
Flush stdout after printing key update notification
+
+ +
+
- 37f7b3e
Consistently use feature flag `experiment_libcrux`
+
+ +
+
- 40377dc
Fix shared_secret length in Kyber encaps fuzz test
+
+ +
+
- 07146d9
Update handle_msg.rs fuzz test and handshake.rs bench to use PublicBox
+
+ +
+
- 0e059af
Fix duplicate key issue (#329)
+
+ +
+
- 0e8945d
.ci/gen-workflow-files.nu script
+
+ +
+
- cd23e9a
Failing tests
+
+ +
+
- 13a853f
Fix crate vulnerabilities
+
+ +
+
- 639541a
Grammatical typo in cli.rs
+
+ +
+
- 62aa9b4
Second round of clippy lints
+
+ +
+
- 26cb4a5
Apply clippy lints
+
+ +
+
- 1c14be3
Make benches work again
+
+ +
+
- 9824db4
Migrate away from lazy_static in favor of thread_local
+
+ +
+
- e3b7248
Make sure all tests are run during CI runs
+
+ +
+
- 7c83e24
Fix Rust code in markdown files
+
+ +
+
- 61ef5b9
Add deprecated keygen command
+
+ +
+
- 9819148
Remove OSFONTDIR var from whitepaper build
+
+ +
+
- 1eefb5f
Guaranteed results typo
+
+ +
+
- 284ebb2
Enabled fuzzing
+
+ +
+
- 40861cc
Nix flake failing due to rosenpass-to
+
+ +
+
- 46156fc
Setup cargo fmt to check the entire workspace
+
+
+
+ +

+ +

+
+
+ +
+
- 81487b1
Get rid of comment and unessary truncation of buffer
+
+ +
+
- 8ea253f
Use memoffset crate instead of unstable offset_of feature
+
+ +
+
- a996b08
Replace lenses library with the zerocopy crate
+
+
+
+ +

+ +

+
+
+ +
+
- 3cd6077
Added gitcliff and modified template
+
+ +
+
- 1f7196e
Add documentation for testing
+
+ +
+
- de60e5f
Run prettier over CONTRIBUTING.md
+
+ +
+
- b50ddda
Pointed to website documentation in readme
+
+ +
+
- 7282fba
Migrated cooking recipe from wiki
+
+ +
+
- 29917fd
Fix keygen/gen-keys misspell
+
+ +
+
- c9cef05
Add bibliography to the manual page
+
+
+
+ +

+ +

+
+
+ +
+
- fd8f2e4
Apply rustfmt
+
+
+
+ +

+ +

+
+
+ +
+
- d913e19
Add tests for controlflow
+
+ +
+
- 9f78531
Cleanup fd.rs tests
+
+ +
+
- 8496571
Modify existing tests to cover load/store for PublicBox as well
+
+
+
+ +

+ +

+
+
+ +
+
- e809e22
Fixed typo on doc-upload
+
+ +
+
- 4c20efc
Fix(API): Tests failing on mac
+
+ +
+
- 2238919
Fd/time: add tests, docs, cleanups
+
+ +
+
- 624d8d2
API: Close connections after errors & use mio::Token based polling
+
+ +
+
- a831e01
Utilities to check for unix domain stream sockets
+
+ +
+
- 3caff91
Fallback for empty api section in config
+
+ +
+
- 7a31b57
Infrastructure to use endpoints with fd. passing
+
+ +
+
- d5a8c85
Specifying a keypair should be opt. at startup
+
+ +
+
- 48f7ff9
Deal with CryptoServer being uninit.
+
+ +
+
- 5f6c36e
Decouple AppServer from CryptoServer::timebase
+
+ +
+
- 7b3b761
API should have access to AppServer
+
+ +
+
- 15002a7
Experimental PSK Broker Support
+
+ +
+
- 08653c3
Clippy
+
+ +
+
- 520c8c6
Feature naming scheme fully applied
+
+ +
+
- fd0f35b
Gen-key subcommand should show canonical paths
+
+ +
+
- 6fc45ca
Prettier
+
+ +
+
- c359b87
Convert broker interface setup to use mio's UnixStream where possible
+
+ +
+
- 355b481
Make MiobrokerClient import conditional
+
+ +
+
- 274d245
Unify enable_wg_broker and enable_broker_api features
+
+ +
+
- 7b6a9ee
Test full workspace with codecov
+
+ +
+
- 4554dc4
Drop codecov token
+
+ +
+
- 465c6be
Switch to codecov action v4 branch
+
+ +
+
- 9fd3df6
Fix typos and add various comments
+
+ +
+
- 138e6b6
To crate documentation indendation (purely cosmetic)
+
+ +
+
- 2dde0a2
Refactor integration_tests (purely cosmetic)
+
+ +
+
- 3cc3b60
Move CliCommand::run -> CliArgs::run; do not mutate the configuration
+
+ +
+
- 8d3c879
Reorganize memfd secret policy
+
+ +
+
- 648a94e
Clippy fixes on wireguard-broker
+
+ +
+
- 54ac5ee
Warnings & clippy hints
+
+ +
+
- 40c5bbd
Ensure that rustAnalyzer is installed in dev environment
+
+ +
+
- a4b8fc2
Move memcmp test API doc to test memcmp test module
+
+ +
+
- deafc1c
Style adjustments – Cargo.toml
+
+ +
+
- 6bbe85a
Remove unnecessary imports
+
+ +
+
- e70c5b3
Ignore vscode directory
+
+ +
+
- f6320c3
Fixup regression test
+
+ +
+
- cc5877d
Use my new name
+
+ +
+
- cc22165
Ensure punctuation is consistent in doc comments
+
+ +
+
- 100d7b6
Simplify some dereferencing incantations in PublicBox
+
+ +
+
- 7c54a37
Add generate_configs.py script
+
+ +
+
- 5f8b00d
Rollback symbolic models to original state
+
+ +
+
- 70c5ec2
Remove libsodium references in nix flake, ci (#334)
+
+ +
+
- 06969c4
Add write permissions in dependent-issues workflow
+
+ +
+
- a8ed0e8
Update codecov configuration file
+
+ +
+
- ad6405f
Add codecov configuration file
+
+ +
+
- 761d573
Changes from #160- Invoke the mandoc linter (#296)
+
+ +
+
- 21e693a
Add codecov (llvm-cov) coverage (#297)
+
+ +
+
- be91b30
Load WireGuard SK into secret memory (#293)
+
+ +
+
- 3e734e0
Replace Into<> with From<> trait
+
+ +
+
- c9e2967
Remove useless conversion
+
+ +
+
- bc6bff4
Remove redundant Ok()
+
+ +
+
- de90505
Remove needless borrow
+
+ +
+
- 4e83446
Remove needless borrow
+
+ +
+
- a581f7d
Replace if let with is_ok() call
+
+ +
+
- bd6a6e5
Remove needless borrow for nonce array
+
+ +
+
- e0496c1
Use copy instead of clone trait
+
+ +
+
- f4116f2
Remove redundant mutability
+
+ +
+
- 8099bc4
Remove redundant cast
+
+ +
+
- 39d174c
Suppress clippy warnings for neutral element
+
+ +
+
- 76d5093
Apply .ci/gen-workflow-files.nu script
+
+ +
+
- ffd81b6
Update flake.lock
+
+ +
+
- d1d218a
Add dedicated nixpkgs input to flake
+
+ +
+
- 199ecb8
Add configuration
+
+ +
+
- baa35af
Exclude rosenpass-fuzzing
+
+ +
+
- b2de384
Add secure memcmp_le function
+
+ +
+
- c69fd88
Enable cargo bench again
+
+ +
+
- 4d482aa
Cargo fmt & fix
+
+ +
+
- 13df700
Drop overlay due to upstream fix
+
+ +
+
- 4f4e8e1
Drop deprecated std::env::home_dir()
+
+ +
+
- 478fadb
Enable aarch64-linux builds again
+
+ +
+
- 7c1ada4
Add link to manual
+
+ +
+
- 9690085
Cargo fmt
+
+ +
+
- e42f90b
Add helper to turn typenums into const values
+
+ +
+
- 30cb0e9
Remove references to libsodium from secret-memory
+
+ +
+
- 972e82b
Move kems out of rosenpass crate
+
+ +
+
- 838f700
Upgrade dependencies
+
+ +
+
- 0f89ab7
Shorten fuzzing runtime to make sure the CI finishes quickly
+
+ +
+
- cf132bc
Move rest of coloring.rs into secret-memory crate
+
+ +
+
- 7bda010
Move Public and debug_crypto_array into secret-memory crate
+
+ +
+
- cc8c13e
Remove lprf.rs (dead code)
+
+ +
+
- 09aa0e0
Move hashing functions into sodium/ciphers crate
+
+ +
+
- 86300ca
Use naming scheme without rosenpass- for crates
+
+ +
+
- 3ddf736
Move xchacha20 implementation out of rosenpass::sodium
+
+ +
+
- c64e721
Move chacha20 implementation out of rosenpass::sodium
+
+ +
+
- 4c51ead
Move libsodium's helper function into their own namespace
+
+ +
+
- c5c3452
Move libsodium's memzero, randombytes fns into rosenpass-sodium
+
+ +
+
- 6553141
Move libsodium's increment into rosenpass-sodium crate
+
+ +
+
- a3de526
Move libsodium's compare into rosenpass-sodium crate
+
+ +
+
- 5da0e41
Move memcmp into rosenpass-sodium crate
+
+ +
+
- 99634d9
Move sodium init integration into rosenpass-sodium crate
+
+ +
+
- e505421
Move file utils into coloring or the util crate
+
+ +
+
- 3db9755
Move functional utils into utils library
+
+ +
+
- 556dbd2
Move time utils into util crate
+
+ +
+
- 6cd42eb
Move max_usize into util crate
+
+ +
+
- a220c11
Move xor_into, copying and base64 utils into own crates
+
+
+
+ + +
+
• 0.2.1 2023-11-18  -  0b4b127
+

+ +

+
+
+ +
+
- 0b4b127
Release rosenpass version 0.2.1
+
+
+
+ + +
+
• 0.2.1-rc.3 2023-11-18  -  44264a7
+

+ +

+
+
+ +
+
- 44264a7
Release rosenpass version 0.2.1-rc.3
+
+
+
+ + +
+
• rosenpass-v0.2.1-rc.2 2023-11-18  -  9597e48
+

+ +

+
+
+ +
+
- 9597e48
Release rosenpass version 0.2.1-rc.2
+
+
+
+ + +
+
• rosenpass-v0.2.1-rc.1 2023-11-18  -  3901e66
+

+ +

+
+
+ +
+
- 3901e66
Release rosenpass version 0.2.1-rc.1
+
+
+
+ +

+ +

+
+
+ +
+
- 2774678
Doctest should pass buffers of correct length to handle_msg
+
+ +
+
- 447a4f7
Restore benchmarks to working order
+
+
+
+ +

+ +

+
+
+ +
+
- f48a923
Remove redundant references
+
+
+
+ +

+ +

+
+
+ +
+
- 0051cbd
Add unit test for xor_into
+
+ +
+
- 1e37f89
Clarify the assumptions about the server
+
+
+
+ +

+ +

+
+
+ +
+
- f323839
Fix wrong comment
+
+ +
+
- b7a7684
Ensure 8MiB of stack size for key generation
+
+
+
+ +

+ +

+
+
+ +
+
- 932bde3
Update
+
+ +
+
- 1356323
Rustfmt
+
+ +
+
- e5e04c6
Replace `is_ok()` by `if let`
+
+ +
+
- 6e15c38
Remove redundant stack increase
+
+ +
+
- 04eb86a
Move wg exit status check to thread
+
+ +
+
- bf850e3
Handle the exit status of wg process
+
+ +
+
- dd39936
Reap spawned wireguard child
+
+ +
+
- b50820e
Default `WireGuard::extra_params` to empty `Vec`
+
+ +
+
- 1135cd7
Remove `unsafe` from `store_secret`
+
+ +
+
- 51f04f7
Remove `unsafe` from `store_secret`
+
+ +
+
- d0a8429
Move `StaticKEM::keygen` out of `unsafe`
+
+ +
+
- d6a7ebe
Allow false positive with redundancies
+
+ +
+
- 2123367
Fix clippy warnings in `build.rs`
+
+
+
+ + +
+
• 0.2.0 2023-09-05  -  b997238
+

+ +

+
+
+ +
+
- b997238
Release rosenpass version 0.2.0
+
+
+
+ + +
+
• 0.2.0-rc.1 2023-08-29  -  d915e63
+

+ +

+
+
+ +
+
- 62fab06
Restart host discovery on connection loss
+
+ +
+
- b4d74d6
Upload man pages to website
+
+
+
+ +

+ +

+
+
+ +
+
- 7e6985f
Revert spell correction zeroized -> zeroed
+
+ +
+
- b958eac
Typos in Rust code, readme and man pages
+
+ +
+
- 397a776
Race condition due to concurrent handshake
+
+ +
+
- 19fe736
Git directory detection should not print an error if we are not in a git repo
+
+ +
+
- b29720b
Formatting
+
+ +
+
- 78e32a6
Show cargo fmt errors
+
+ +
+
- 5f78857
Show warnings from git directory detection
+
+ +
+
- 69f6267
Reintroduce ability to actually supply wireguard with keys
+
+ +
+
- 7aa48b9
Escape uses of angle brackets and pointy brackets in documentation
+
+ +
+
- 229224d
Restore QC/doc CI job to operation
+
+ +
+
- e12cd18
Disable broken CI jobs
+
+ +
+
- 9469b62
Host-path discovery
+
+ +
+
- f8bea94
Always send messages to a peer using the socket they contacted us with
+
+ +
+
- f3c343c
Handle the various possible dual-stack configurations reliably
+
+ +
+
- 4279869
Adjust the rp(1) script to support the new rosenpass(1) command line parameters
+
+
+
+ +

+ +

+
+
+ +
+
- 0456ded
Add a manual page for `rp(1)`
+
+
+
+ +

+ +

+
+
+ +
+
- 6025623
Update outdated dependencies
+
+ +
+
- 5a67b47
Perform a `shellcheck`
+
+ +
+
- 66e696f
Update
+
+ +
+
- 8ff9b53
Include a static compiled manual page
+
+ +
+
- 067a839
Defaults to dual-stack
+
+ +
+
- 38835fb
Add mirrors
+
+ +
+
- 0d2ca37
Update
+
+ +
+
- 097fd03
Upgrade crate dependencies
+
+ +
+
- 3856d77
Move slides into their own repo
+
+ +
+
- 7154af5
Indicate that the listen parameter can be given multiple times in the help
+
+ +
+
- e03fed4
Cleanup unneccesary debug output
+
+
+
+ + +
+
• 0.1.2-rc.4 2023-04-13  -  94d57f2
+

+ +

+
+
+ +
+
- 94d57f2
Release rosenpass version 0.1.2-rc.4
+
+
+
+ +

+ +

+
+
+ +
+
- 25a7a07
Reorder RWPQC slides
+
+ +
+
- a723951
CrossFyre 2023 Submission abstract
+
+ +
+
- 34d0bab
Add RWPQC 23 slides
+
+ +
+
- 2aeb906
Add YRCS talk slides
+
+ +
+
- 5afa6c1
Add licensing infos
+
+
+
+ +

+ +

+
+
+ +
+
- a011cc1
Rollback adding an article to state, acknowledgement and replay
+
+ +
+
- 8eea528
Remove warning about this being a research project
+
+
+
+ +

+ +

+
+
+ +
+
- 279b3c4
Add rosenpass.1 manual page
+
+
+
+ +

+ +

+
+
+ +
+
- a624051
Consistently use the term `Key Encapsulation Mechanism`
+
+ +
+
- ecc1b75
Delete outdated illustrations
+
+
+
+ + +
+
• 0.1.1 2023-02-25  -  97f5d75
+

+ +

+
+
+ +
+
- 97f5d75
Release rosenpass version 0.1.1
+
+
+
+ + +
+
• 0.1.1-rc.7 2023-02-25  -  aa15872
+

+ +

+
+
+ +
+
- aa15872
Release rosenpass version 0.1.1-rc.7
+
+ +
+
- 1d10e7f
Release rosenpass version 0.1.1-rc.6
+
+
+
+ + +
+
• 0.1.1-rc.5 2023-02-25  -  f4c351c
+

+ +

+
+
+ +
+
- f4c351c
Release rosenpass version 0.1.1-rc.5
+
+
+
+ + +
+
• 0.1.1-rc.4 2023-02-25  -  4b4902c
+

+ +

+
+
+ +
+
- 4b4902c
Release rosenpass version 0.1.1-rc.4
+
+ +
+
- 9b3f467
Release rosenpass version 0.1.1-rc.3
+
+
+
+ + +
+
• 0.1.1-rc.3 2023-02-24  -  8313a61
+

+ +

+
+
+ +
+
- 8313a61
Release rosenpass version 0.1.1-rc.3
+
+
+
+ + +
+
• 0.1.1-rc.2 2023-02-24  -  d50c3fc
+

+ +

+
+
+ +
+
- d50c3fc
Release rosenpass version 0.1.1-rc.2
+
+
+
+ +

+ +

+
+
+ +
+
- aaf79be
Give thanks to NLNet
+
+ +
+
- 22c2387
`rp` now detects rosenpass binary in nix builds
+
+
+
+ +

+ +

+
+
+ +
+
- 55e4fc7
Support for absolute paths in rp
+
+
+
+ + +
+
• 0.1.1-rc.1 2023-02-24  -  e34610a
+

+ +

+
+
+ +
+
- e34610a
Release rosenpass version 0.1.1-rc.1
+
+
+
+ +

+ +

+
+
+ +
+
- 83d5f37
Proofreading of whitepaper
+
+
+
+ + +
diff --git a/content/en/docs/compilation.md b/content/en/docs/rosenpass-tool/compilation.md similarity index 94% rename from content/en/docs/compilation.md rename to content/en/docs/rosenpass-tool/compilation.md index 007afdfc..66936f3b 100644 --- a/content/en/docs/compilation.md +++ b/content/en/docs/rosenpass-tool/compilation.md @@ -4,6 +4,7 @@ linkTitle: "Compilation and Installation" weight: 4 menu: false type: docs +blerb: "A guide on how to compile the Rosenpass tool yourself, including installation via the binary files. This is useful if you want to use the Rosenpass tool on systems we do not currently provide packages for." --- Below is a guide on how to compile Rosenpass yourself, including via the binary files. This can be used to compile Rosenpass for systems not yet fully supported, such as Debian, and provides a more customised experience. diff --git a/content/en/docs/rosenpass-tool/manuals/_index.html b/content/en/docs/rosenpass-tool/manuals/_index.html new file mode 100644 index 00000000..3024222d --- /dev/null +++ b/content/en/docs/rosenpass-tool/manuals/_index.html @@ -0,0 +1,27 @@ +--- +title: "Manuals" +linkTitle: "Manuals" +type: docs +weight: 60 +menu: false +no_list: true +blerb: "The Rosenpass Tool's Command Line Interface guides converted for viewing in a web browser." +--- + +{{< blocks/lead >}} +

Rosenpass Manuals

+{{< /blocks/lead >}} +{{< blocks/section color="light">}} +

+ This section contains conversions of .1 format manual pages into a html-readable format. +

+ +
+

Rosenpass Manual (1) (rp) EN

+

Manual page for using Rosenpass to build post-quantum-secure VPNs

+ +
+

Rosenpass High-Level Interface (rp) EN

+

Manual page for configuring a high-level interface to Rosenpass.

+ +{{< /blocks/section >}} diff --git a/content/en/docs/manuals/rosenpass_manual_custom.md b/content/en/docs/rosenpass-tool/manuals/rosenpass_manual_custom.md similarity index 100% rename from content/en/docs/manuals/rosenpass_manual_custom.md rename to content/en/docs/rosenpass-tool/manuals/rosenpass_manual_custom.md diff --git a/content/en/docs/manuals/rp1.md b/content/en/docs/rosenpass-tool/manuals/rp1.md similarity index 100% rename from content/en/docs/manuals/rp1.md rename to content/en/docs/rosenpass-tool/manuals/rp1.md diff --git a/content/en/docs/manuals/rp_manual.md b/content/en/docs/rosenpass-tool/manuals/rp_manual.md similarity index 100% rename from content/en/docs/manuals/rp_manual.md rename to content/en/docs/rosenpass-tool/manuals/rp_manual.md diff --git a/content/en/docs/release_notes.md b/content/en/docs/rosenpass-tool/release_notes.md similarity index 97% rename from content/en/docs/release_notes.md rename to content/en/docs/rosenpass-tool/release_notes.md index ce67f892..3d9356fd 100644 --- a/content/en/docs/release_notes.md +++ b/content/en/docs/rosenpass-tool/release_notes.md @@ -1,10 +1,11 @@ --- title: "Release Notes" linkTitle: "Release Notes" -weight: 5 +weight: 2 menu: false type: docs rss: "https://github.com/rosenpass/rosenpass/releases.atom" +blerb: "A summary of the major changes and fixes across full Rosenpass tool releases." --- diff --git a/content/en/docs/rosenpass-tool/source_code.md b/content/en/docs/rosenpass-tool/source_code.md new file mode 100644 index 00000000..53b5d4eb --- /dev/null +++ b/content/en/docs/rosenpass-tool/source_code.md @@ -0,0 +1,12 @@ +--- +title: "Source Code" +linkTitle: "Source Code" +weight: 50 +menu: false +type: docs +icon: fab fa-github +manualLink: "https://github.com/rosenpass/rosenpass" +manualLinkTarget: "_blank" +external: true +blerb: "A link to the Rosenpass tool's source code in its GitHub repository. Much of the Rosenpass tool's development is monitored there, and we are responsive to issues, feature requests, and other topics raised directly in the repository." +--- \ No newline at end of file diff --git a/content/en/docs/start.html b/content/en/docs/rosenpass-tool/start.html similarity index 97% rename from content/en/docs/start.html rename to content/en/docs/rosenpass-tool/start.html index 6a585258..12abe67f 100644 --- a/content/en/docs/start.html +++ b/content/en/docs/rosenpass-tool/start.html @@ -2,8 +2,9 @@ title = "Quick Start" linkTitle = "Quick Start" subtitle = "Build post-quantum-secure VPNs with WireGuard!" -weight = 10 +weight = 1 hideLead = true +blerb = "A quick start guide on downloading, configuring, and booting the Rosenpass tool for use with a WireGuard connection." +++ @@ -153,10 +154,6 @@

Just to be sure: Verify the magic!

-

We provide in-depth ressources in our Documentation section.

- -

Go to Documentation

-

If you have further questions, please feel free to get in touch. We maintain a public Rosenpass Matrix chatroom, as well as several inboxes, for public inquiries, development questions, and general interest. Feature requests can also be opened at our GitHub pages

diff --git a/content/en/docs/source_code.md b/content/en/docs/source_code.md deleted file mode 100644 index 080b0263..00000000 --- a/content/en/docs/source_code.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: "Source Code" -linkTitle: "Source Code" -weight: 1 -menu: false -type: docs -icon: fab fa-github -manualLink: "https://github.com/rosenpass/rosenpass" -manualLinkTarget: "_blank" -external: true ---- \ No newline at end of file diff --git a/content/en/docs/whitepaper.md b/content/en/docs/whitepaper.md deleted file mode 100644 index f63b368c..00000000 --- a/content/en/docs/whitepaper.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: "Whitepaper" -linkTitle: "Whitepaper" -weight: 2 -menu: false -type: docs -icon: fa-sharp fa-solid fa-file-pdf -pdf_filename: "../../whitepaper.pdf" ---- - -{{< blocks/pdfembed >}} \ No newline at end of file diff --git a/layouts/docs/baseof.html b/layouts/docs/baseof.html index 3627e114..cea615e6 100644 --- a/layouts/docs/baseof.html +++ b/layouts/docs/baseof.html @@ -18,12 +18,12 @@ {{ partial "toc.html" . }} {{ partial "taxonomy_terms_clouds.html" . }} -
+
{{ partial "version-banner.html" . }} {{ block "main" . }}{{ end }}
-
+
{{ partial "footer.html" . }} diff --git a/layouts/docs/baseof.print.html b/layouts/docs/baseof.print.html index 41e0659b..1128ef8a 100644 --- a/layouts/docs/baseof.print.html +++ b/layouts/docs/baseof.print.html @@ -10,7 +10,7 @@
-
+
{{ block "main" . }}{{ end }}
diff --git a/static/css/rosenpass.css b/static/css/rosenpass.css index 91594ae4..17e149a1 100644 --- a/static/css/rosenpass.css +++ b/static/css/rosenpass.css @@ -273,8 +273,63 @@ div.click-to-copy{ border: 2px inset; } -/* Docs */ +/* DOCS */ +.ul-2 { /* Opens the sidebar menu to at least one nested dir level*/ + display: block !important; +} + +/* list production outside of preesentations */ +main.docs-main { + margin-left: auto; + margin-right: auto; +} + +aside.d-none { + display: none !important; +} + +.doc-list-section { + max-width: fit-content; +} + +.doc-list-section div p { + font-size: smaller; +} + +.doc-list-section .doc-list-section-title { + padding: 0; +} + +div.doc-list-section-title p { + font-size: medium; +} + +.doc-list-section div { + padding: 0 1rem 0 1rem; +} + +.doc-list-row { + flex-direction: column; + padding-left: 5vw; + padding-right: 5vw; +} + +@media (min-width: 1400px){ + .doc-list-row { + flex-direction: row; + } + + .doc-list-section:nth-child(odd) { + margin-right: 1rem; + } + + .doc-list-section:nth-child(even) { + margin-left: 1rem; + } +} + +/* Presenation list production */ .presentation-list h3 { margin-left: 1rem; margin-bottom: 0; @@ -290,6 +345,7 @@ div.click-to-copy{ .presentation-card-title { /* max-width: 75%; */ } +/* PDF styling */ .pdf-load-fail{ background-color: #00000040; @@ -832,7 +888,8 @@ font-weight: inherit; } .td-block-padding, -.td-default main section { +.td-default main section, +.td-main div main section { padding-top: 3rem; padding-bottom: 3rem; }