Skip to content

Commit

Permalink
Merge pull request #65 from rosenpass/alice-mullana/documentation
Browse files Browse the repository at this point in the history
Alice mullana/documentation
  • Loading branch information
AliceOrunitia authored Jan 15, 2024
2 parents 2dff638 + 96bd705 commit da8d93d
Show file tree
Hide file tree
Showing 25 changed files with 363 additions and 297 deletions.
2 changes: 1 addition & 1 deletion content/en/blog/_index.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Blog
linkTitle: "Rosenpass Blog"
linkTitle: "Blog"
menu:
main:
weight: 50
Expand Down
33 changes: 17 additions & 16 deletions content/en/docs/_index.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Documentation"
linkTitle: "Rosenpass Documentation"
linkTitle: "Documentation"
type: docs
menu:
main:
Expand All @@ -9,40 +9,41 @@
---


<p>
Welcome to the documentation page for Rosenpass. This guide contains the manual pages, slides from various presentations,
<p class="indent">
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.
</p>

<h2>What is Rosenpass?</h3>
<p>
<h2>What is Rosenpass?</h2>
<p class="indent">
Rosenpass is a daemon, that, given a private key and a list of peers, performs a key exchange with each peer.
The resulting keys 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 keys to files; this can be used to integrate Rosenpass
with tools other than WireGuard.
with tools other than WireGuard. It can also be exported to an outfile.
</p>

<h2>Who is Rosenpass for?</h2>
<p>
Ultimately, Rosenpass is for everyone who wants secure encryption, particularly in a world where "store now, decrypt later"
attacks are already happening. If your data is being encrypted with methods that are not post-quantum secure, that data may
<p class="indent">
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 demon, particularly those using specific versions
of Linux. Support for further systems is on the agenda, but not currently imminent.
of Linux. Support for further systems is actively being researched, but is not currently imminent.
</p>
<h2>How to use this Guide</h2>
<p>
<p class="indent">
If you simply want to get Rosenpass up and running quickly, you are best served using the <a href="https://rosenpass.eu/docs/quick_start">Quick Start Guide</a>
It contains everything you need to download, configure, and start a WireGuard connection using the Rosenpass key exchange. Much of the rest of the guide
is aimed at both scientific explanation and technical guides to the implementation.
is aimed at both scientific explanation and technical guides to the implementation. It is also intended to host many of our conference presentations.
</p>
<h2>What systems currently support Rosenpass?</h2>
<p>
Rosenpass currently provides packages for arch linux, nix and cargo. Further packages and support are planned, with
development of a Golang implementation, to complement our current Rust build, expected to help that process.
<h2>Which systems currently support Rosenpass?</h2>
<p class="indent">
Rosenpass currently provides packages and static binaries for several Linux distributions, as shown below. Further packages and support are planned, with
development of a Golang implementation, to complement our current Rust build, expected to help with that process.
</p>
<img src="https://repology.org/badge/vertical-allrepos/rosenpass.svg" class="indent">


<h2>What planned features are on the way?</h2>
<ul>
Expand Down
16 changes: 13 additions & 3 deletions content/en/docs/manuals/_index.html
Original file line number Diff line number Diff line change
@@ -1,8 +1,18 @@
---
title: Manuals
title: "Manuals"
linkTitle: "Manuals"
type: docs
weight: 4
weight: 5
menu: false
no_list: false
---
---

<p class="indent"> This section contains conversions of .1 format manual pages into a html-readable format.</p>

<div class="presentation-list">
<a href="/docs/manuals/rp_manual/"><h3> Rosenpass Manual (1) <i class="fa-regular fa-language h6 text-muted"> EN </i> </h3></a>
<p>Manual page for using Rosenpass to build post-quantum-secure VPNs</p>

<div class="presentation-list">
<a href="/docs/manuals/rp1/"><h3> Rosenpass High-Level Interface <i class="fa-regular fa-language h6 text-muted"> EN </i> </h3></a>
<p>Manual page for configuring a high-level interface to Rosenpass.</p>
4 changes: 2 additions & 2 deletions content/en/docs/manuals/rosenpass_manual_custom.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
linkTitle: "Rosenpass Manual Custom"
weight: 60
linkTitle: ""
weight: 100
menu: false
type: docs
---
Expand Down
11 changes: 11 additions & 0 deletions content/en/docs/manuals/rp1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@

---
linkTitle: "High-Level Interfaces"
Title: ""
weight: 70
menu: false
type: docs
html_filename: rp1.html
---

{{< blocks/htmlembed >}}
1 change: 1 addition & 0 deletions content/en/docs/manuals/rp_manual.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@

---
linkTitle: "Rosenpass Manual"
title: ""
weight: 60
menu: false
type: docs
Expand Down
14 changes: 7 additions & 7 deletions content/en/docs/presentations/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,28 @@
title: Conference Presentations
linkTitle: "Conference Presentations"
type: docs
weight: 3
weight: 4
menu: false
no_list: false
---

<div class="presentation-list">
<a href="/docs/presentations/mrmcd-2023/"><h3>(DE) MRMCD 2023 - Sichere Kryptografie trotz Quantencomputern: Projektupdate</h3></a>
<a href="/docs/presentations/mrmcd-2023/"><h3>MRMCD 2023 - Sichere Kryptografie trotz Quantencomputern: Projektupdate <i class="fa-regular fa-language h6 text-muted"> DE </i> </h3></a>
<p>A recap on, and overview of, Rosenpass’ progress since April presented to the MetaRehinMainChaosDays conference in Darmstadt.</p>


<a href="/docs/presentations/formosa-2023/"><h3>(EN) Formosa 2023 - Rosenpass</h3></a>
<a href="/docs/presentations/formosa-2023/"><h3>Formosa 2023 - Rosenpass <i class="fa-regular fa-language h6 text-muted"> EN </i> </h3></a>
<p>A recap on, and overview of, Rosenpass’ progress since April presented to the MetaRehinMainChaosDays conference in Darmstadt.</p>

<a href="/docs/presentations/iav-2023/"><h3>(DE) IAV 2023 - VPN & Struktur für Translationsforschung in der Kryptografie </h3></a>
<a href="/docs/presentations/iav-2023/"><h3>IAV 2023 - VPN & Struktur für Translationsforschung in der Kryptografie <i class="fa-regular fa-language h6 text-muted"> DE </i> </h3></a>
<p>An overview on quantum cryptography, Rosenpass’ cryptographic tools and structure.</p>

<a href="/docs/presentations/easterhegg-2023"><h3>(DE) Easterhegg 2023 - Ein VPN zum Schutz vor Quantencomputern</h3></a>
<a href="/docs/presentations/easterhegg-2023"><h3>Easterhegg 2023 - Ein VPN zum Schutz vor Quantencomputern <i class="fa-regular fa-language h6 text-muted"> DE </i> </h3></a>
<p>A deeper dive into post-quantum cryptography, Rosenpass’ approach to the issue, and a demonstration of Rosenpass’ solution and integration with WireGuard.</p>

<a href="/docs/presentations/rwpqc-2023/"><h3>(EN) RWPQC 2023 - Securing & Deploying Post-Quantum WireGuard</h3></a>
<a href="/docs/presentations/rwpqc-2023/"><h3>RWPQC 2023 - Securing & Deploying Post-Quantum WireGuard <i class="fa-regular fa-language h6 text-muted"> EN </i> </h3></a>
<p> A presentation on Rosenpass’ post-quantum WireGuard solutions, including key-encapsulation mechanisms, Noise, and Proverif</p>

<a href="/docs/presentations/yrcs-2023/"><h3>(EN) YRCS 2023 - Sichere Kryptografie trotz Quantencomputern: Projektupdate</h3></a>
<a href="/docs/presentations/yrcs-2023/"><h3>YRCS 2023 - Sichere Kryptografie trotz Quantencomputern: Projektupdate <i class="fa-regular fa-language h6 text-muted"> EN </i> </h3></a>
<p> A deeper look into Rosenpass’ deployment of post-quantum WireGuard, its KEMs, protocol design, and DoS resistance.</p>
</div>
6 changes: 3 additions & 3 deletions content/en/docs/presentations/easterhegg-2023.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: ""
linkTitle: "(DE) Easterhegg 2023"
linkTitle: "Easterhegg 2023"
description: ""
weight: 98
menu: false
Expand All @@ -10,8 +10,8 @@ toc:
pdf_filename: "2023-04-08-easterhegg/slides.pdf"
---

{{< blocks/lead >}}
# (DE) Easterhegg 2023 - Ein VPN zum Schutz vor Quantencomputern
{{< blocks/lead class="doc-title" >}}
# Easterhegg 2023 - Ein VPN zum Schutz vor Quantencomputern <i class="fa-regular fa-language h6 text-light"> DE </i>

A deeper dive into post-quantum cryptography, Rosenpass' approach to the issue, and a demonstration of Rosenpass' solution and integration with WireGuard.
{{< /blocks/lead >}}
Expand Down
11 changes: 8 additions & 3 deletions content/en/docs/presentations/formosa-2023.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "(EN) Formosa 2023 - Rosenpass"
linkTitle: "(EN) Formosa 2023"
description: "(English) A presentation on Rosenpass, cryptographic security, ongoing projects and its relationship to Formosa projects."
title: ""
linkTitle: "Formosa 2023"
description: ""
weight: 96
menu: false
type: docs
Expand All @@ -10,6 +10,11 @@ toc:
pdf_filename: "2023-07-10-FormosaRetreat/slides.pdf"
---

{{< blocks/lead class="doc-title" >}}
# Formosa 2023 - Rosenpass <i class="fa-regular fa-language h6 text-light"> EN </i>

A presentation on Rosenpass, cryptographic security, ongoing projects and its relationship to Formosa projects.
{{< /blocks/lead >}}
{{< blocks/section color="white">}}
{{< /blocks/section >}}

Expand Down
12 changes: 9 additions & 3 deletions content/en/docs/presentations/iav-2023.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "(DE) IAV 2023 - VPN & Struktur für Translationsforschung in der Kryptografie "
linkTitle: "(DE) IAV 2023"
description: "(German) An overview on quantum cryptography, Rosenpass' cryptographic tools and structure."
title: ""
linkTitle: "IAV 2023"
description: ""
weight: 97
menu: false
type: docs
Expand All @@ -10,7 +10,13 @@ toc:
pdf_filename: "2023-07-04-IAV/slides.pdf"
---

{{< blocks/lead class="doc-title" >}}
# IAV 2023 - VPN & Struktur für Translationsforschung in der Kryptografie <i class="fa-regular fa-language h6 text-light"> DE </i>

An overview on quantum cryptography, Rosenpass' cryptographic tools and structure.
{{< /blocks/lead >}}
{{< blocks/section color="white">}}

{{< /blocks/section >}}

{{< blocks/pdfembed >}}
10 changes: 7 additions & 3 deletions content/en/docs/presentations/mrmcd-2023.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
---
title: "(DE) MRMCD 2023 - Sichere Kryptografie trotz Quantencomputern: Projektupdate"
linkTitle: "(DE) MRMCD 2023"
description: "(German) A recap on, and overview of, Rosenpass' progress since April presented to the MetaRehinMainChaosDays conference in Darmstadt."
title: ""
linkTitle: "MRMCD 2023"
description: ""
weight: 95
menu: false
type: docs
toc:
depth: 3
pdf_filename: "2023-09-03-MRMCD2023/slides.pdf"
---
{{< blocks/lead class="doc-title" >}}
# MRMCD 2023 - Sichere Kryptografie trotz Quantencomputern: Projektupdate <i class="fa-regular fa-language h6 text-light"> DE </i>

A recap on, and overview of, Rosenpass' progress since April presented to the MetaRehinMainChaosDays conference in Darmstadt.
{{< /blocks/lead >}}
{{< blocks/section color="white">}}
{{< /blocks/section >}}

Expand Down
10 changes: 7 additions & 3 deletions content/en/docs/presentations/rwpqc-2023.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
---
title: "(EN) RWPQC 2023 - Securing & Deploying Post-Quantum WireGuard"
linkTitle: "(EN) RWPQC 2023"
description: "(English) A presentation on Rosenpass' post-quantum WireGuard solutions, including key-encapsulation mechanisms, Noise, and Proverif"
title: ""
linkTitle: "RWPQC 2023"
description: ""
weight: 99
menu: false
type: docs
toc:
depth: 3
pdf_filename: "2023-03-26-rwpqc/slides.pdf"
---
{{< blocks/lead class="doc-title" >}}
# RWPQC 2023 - Securing & Deploying Post-Quantum WireGuard <i class="fa-regular fa-language h6 text-light"> EN </i>

A presentation on Rosenpass' post-quantum WireGuard solutions, including key-encapsulation mechanisms, Noise, and Proverif
{{< /blocks/lead >}}
{{< blocks/section color="white">}}
{{< /blocks/section >}}

Expand Down
10 changes: 7 additions & 3 deletions content/en/docs/presentations/yrcs-2023.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@
---
title: "(EN) YRCS 2023 - Sichere Kryptografie trotz Quantencomputern: Projektupdate"
linkTitle: "(EN) YRCS 2023"
description: "(English) A deeper look into Rosenpass' deployment of post-quantum WireGuard, its KEMs, protocol design, and DoS resistance."
title: ""
linkTitle: "YRCS 2023"
description: ""
weight: 100
menu: false
type: docs
toc:
depth: 3
pdf_filename: "2023-03-02-yrcs/slides.pdf"
---
{{< blocks/lead class="doc-title" >}}
# YRCS 2023 - Sichere Kryptografie trotz Quantencomputern: Projektupdate <i class="fa-regular fa-language h6 text-light"> EN </i>

A deeper look into Rosenpass' deployment of post-quantum WireGuard, its KEMs, protocol design, and DoS resistance.
{{< /blocks/lead >}}
{{< blocks/section color="white">}}
{{< /blocks/section >}}

Expand Down
Loading

0 comments on commit da8d93d

Please sign in to comment.