Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Chatham/Vault.NET
.NET API client for vault
https://github.com/Chatham/Vault.NET
hashicorp hashicorp-vault secret-management vault vault-api vault-server
Last synced: 7 days ago
JSON representation
.NET API client for vault
- Host: GitHub
- URL: https://github.com/Chatham/Vault.NET
- Owner: Chatham
- License: mit
- Archived: true
- Created: 2016-12-27T18:35:39.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T18:38:30.000Z (almost 2 years ago)
- Last Synced: 2024-10-02T23:36:16.904Z (about 1 month ago)
- Topics: hashicorp, hashicorp-vault, secret-management, vault, vault-api, vault-server
- Language: C#
- Homepage: https://www.vaultproject.io/
- Size: 268 KB
- Stars: 84
- Watchers: 12
- Forks: 28
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Vault.NET [](https://ci.appveyor.com/project/chatham/vault-net/branch/master)
* Vault API: v0.9.1
* .NET Standard 1.3 (.NET: >= 4.6, .NET Core: >= 1.0.0)
* .NET 4.5
* Nuget: Vault [](https://www.nuget.org/packages/Vault/)
Vault.NET is an .NET API client for the interacting with [Vault](https://www.vaultproject.io/). This is a port of the go api client and provides generic methods for interacting with the paths in Vault.
## Example
```csharp
using Vault;
var vaultClient = new VaultClient();
vaultClient.Token = "XXXXXX";
```
### Generic Secret
```csharp
var data = new Dictionary
{
{"zip", "zap"}
};
await vaultClient.Secret.Write("secret/foo", data);
var secret = await vaultClient.Secret.Read>("secret/foo");
Console.WriteLine(secret.Data["zip"]);
// zap
```
### PKI
```csharp
using Vault.Models.Secret.Pki;
var testRole = new RolesRequest
{
AllowAnyDomain = true,
EnforceHostnames = false,
MaxTtl = "1h"
};
await vaultClient.Secret.Write("pki/roles/test", testRole);
var certRequest = new IssueRequest
{
CommonName = "Test Cert"
};
var cert = await vaultClient.Secret.Write("pki/issue/test", certRequest);
Console.WriteLine(secret.Data.Certificate);
// -----BEGIN CERTIFICATE-----
// MII...
```
### Username/Password Authentication
```csharp
using Vault.Models.Auth.UserPass;
await vaultClient.Sys.EnableAuth("userpass", "userpass", "Userpass Mount");
var usersRequest = new UsersRequest
{
Password = "password",
Policies = new List { "default" },
Ttl = "1h",
MaxTtl = "2h"
};
await vaultClient.Auth.Write("userpass/users/username", usersRequest);
var loginRequest = new LoginRequest
{
Password = "password"
};
var loginResponse = await vaultClient.Auth.Write("userpass/login/username", loginRequest);
// Set client token to authenticated token
vaultClient.Token = loginResponse.Auth.ClientToken;
// Proceed with authenticated requests
```
## Models
Many request/response objects are provided in this package to support different backends. This is in no way an exhaustive list of all the objects. Since the models are the things that are going to most likely change between versions of vault, it may make sense to make your own to service your needs. These may get split into a seperate Nuget package in the future.
## Testing
Since most of the operation of this library are just building requests and passing them to the vault API and the vault team provides an easy to use local development server, each test runs against its own vault server. This means that tests require the vault binary available to spin up the vault server instance. The test suite will first look for the environment variable `VAULT_BIN` and if not found will fall back to use the `vault` binary in the `$PATH`.
Downloads for vault can be found [here](https://www.vaultproject.io/downloads.html).
## Versioning
This library will follow the version of vault that it was developed against. Since most core operations of vault maintain backwards compatibility, this library can be used against many older and newer versions of vault. If features are added or bugs are fixed, a new point release will be created (ex. 0.6.4 -> 0.6.4.1). If there is some functionality that breaks on a newer version of vault, please submit a pull request.