C0ffeeCode/rvault
1
0
Fork 0
Code Issues 1 Pull requests Projects 1 Releases Packages Wiki Activity

Further doc work

Browse source
This commit is contained in:
someone 2024-06-02 22:29:10 +02:00 committed by C0ffeeCode
parent 3c1df01014
commit 12084372a8
Signed by: C0ffeeCode
SSH key fingerprint: SHA256:prvFOyBjButRypyXm7X8lbbCkly2Dq1PF7e/mrsPVjw
4 changed files with 10 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
chapters/02-Project-Goal.typ
View file

@ -1,2 +1,5 @@
= Project Goal
The aim of this project is to reimplement a subset of the functionality of the secret management tool "#link("https://github.com/hashicorp/vault")[HashiCorp Vault]", which is currently written in Go, in Rust.
Expected benefits of this are an increase in speed and reliability and a higher level of security.
As part of this, a HTTP-API for key-value based secret handling is implemented. Data is stored in a sqlite database.

6
chapters/05-API-Compliance-and-Testing.typ
View file

@ -2,11 +2,11 @@
= API-Compliance and Testing
One of the goals of this implementation is to provide compatability to the current version of the vault written in Go.
Therefore, a Go-client is used for testing.
Therefore, the #link("https://github.com/hashicorp/vault-client-go")[HashiCorp Go-client] is used for testing.
To ensure compatability, the #link("https://github.com/hashicorp/vault-client-go/blob/main/openapi.json")[OpenAPI specification] and the #link("https://developer.hashicorp.com/vault")[Vault documentation], both published by HashiCorp, are used as references. It provides information on input parameters, types and return values.
To ensure compatability, the #link("https://github.com/hashicorp/vault-client-go/blob/main/openapi.json")[OpenAPI specification] and the #link("https://developer.hashicorp.com/vault")[Vault documentation], both published by HashiCorp, are used as references. They provide information on input parameters, types and return values.
Implemented tests are:
Implemented test cases are:
- Write a secret
- Destroy specific versions of a secret
- Read a secret

6
documentation.typ
View file

@ -9,14 +9,14 @@
),
// Insert your abstract after the colon, wrapped in brackets.
// Example: `abstract: [This is my abstract...]`
// abstract: [lorem(55)],
abstract: [The goal of this project is to implement the HashiCorp Vault in Rust. During this project we have developed an architecture and started implementatino of some basic cases for key-value-storage. Further development is needed to pursue the goal of reaching compatability with the original version written in Go.],
// keywords: ("First keyword", "Second keyword", "etc."),
date: "2024-06-02",
)
#show link:underline
#include "./chapters/01-Project-Requirements.typ"
//#include "./chapters/01-Project-Requirements.typ"
#include "./chapters/02-Project-Goal.typ"
#include "./chapters/03-Planning-and-Timeline.typ"
//#include "./chapters/03-Planning-and-Timeline.typ"
#include "./chapters/04-Architecture.typ"
#include "./chapters/05-API-Compliance-and-Testing.typ"

2
rvault_description.txt
View file

@ -9,7 +9,7 @@ It should be compatible with the current version of the vault an its clients.
Therefore a vault client written in go is used to perform tests.
During this project only a small part will be implemented.
It will be further developed as an open-source project.
Achieved features include:
Implemented features include:
- Design of the architecture
- Implementation of dynamic routing to allow for exchangeable secret engines