Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stklcode/jvaultconnector
Java Vault Connector - Connect Hashicorp's Vault with your Java application.
https://github.com/stklcode/jvaultconnector
connector java secret vault
Last synced: about 2 months ago
JSON representation
Java Vault Connector - Connect Hashicorp's Vault with your Java application.
- Host: GitHub
- URL: https://github.com/stklcode/jvaultconnector
- Owner: stklcode
- License: apache-2.0
- Created: 2016-03-25T18:42:01.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2024-09-07T11:04:21.000Z (4 months ago)
- Last Synced: 2024-09-07T12:25:04.626Z (4 months ago)
- Topics: connector, java, secret, vault
- Language: Java
- Homepage: https://jvault.stklcode.de
- Size: 1.03 MB
- Stars: 8
- Watchers: 3
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Java Vault Connector
[](https://github.com/stklcode/jvaultconnector/actions/workflows/ci.yml)
[](https://sonarcloud.io/summary/new_code?id=de.stklcode.jvault%3Ajvault-connector)
[](https://github.com/stklcode/jvaultconnector/blob/main/LICENSE.txt)
[](https://central.sonatype.com/artifact/de.stklcode.jvault/jvault-connector)
Java Vault Connector is a connector library for [Vault](https://www.vaultproject.io) by [Hashicorp](https://www.hashicorp.com) written in Java. The connector allows simple usage of Vault's secret store in own applications.
## Features:
* HTTP(S) backend connector
* Ability to provide or enforce custom CA certificate
* Optional initialization from environment variables
* Authorization methods
* Token
* Username/Password
* AppRole (register and authenticate)
* AppID (register and authenticate) [_deprecated_]
* Tokens
* Creation and lookup of tokens and token roles
* TokenBuilder for speaking creation of complex configurations
* Secrets
* Read secrets
* Write secrets
* List secrets
* Delete secrets
* Renew/revoke leases
* Raw secret content or JSON decoding
* SQL secret handling
* KV v1 and v2 support
* Connector Factory with builder pattern
* Tested against Vault 1.2 to 1.18
## Maven Artifact
```xml
de.stklcode.jvault
jvault-connector
1.3.1
```
## Usage Examples
### Initialization
```java
// Instantiate using builder pattern style factory (TLS enabled by default)
VaultConnector vault = HTTPVaultConnector.builder()
.withHost("127.0.0.1")
.withPort(8200)
.withTLS()
.build();
// Instantiate with custom SSL context
VaultConnector vault = HTTPVaultConnector.builder("https://example.com:8200/v1/")
.withTrustedCA(Paths.get("/path/to/CA.pem"))
.build();
// Initialization from environment variables
VaultConnector vault = HTTPVaultConnector.builder()
.fromEnv()
.build();
```
### Authentication
```java
// Authenticate with token.
vault.authToken("01234567-89ab-cdef-0123-456789abcdef");
// Authenticate with username and password.
vault.authUserPass("username", "p4ssw0rd");
// Authenticate with AppRole (secret - 2nd argument - is optional).
vault.authAppRole("01234567-89ab-cdef-0123-456789abcdef", "fedcba98-7654-3210-fedc-ba9876543210");
```
### Secret read & write
```java
// Retrieve secret (prefix "secret/" assumed, use read() to read arbitrary paths)
String secret = vault.read("secret/some/key").get("value", String.class);
// Complex secret.
Map secretData = vault.read("secret/another/key").getData();
// Write simple secret.
vault.write("secret/new/key", "secret value");
// Write complex data.
Map map = ...;
vault.write("path/to/write", map);
// Delete secret.
vault.delete("path/to/delete");
```
### Token and role creation
```java
// Create token using TokenBuilder
Token token = Token.builder()
.withId("token id")
.withDisplayName("new test token")
.withPolicies("pol1", "pol2")
.build();
vault.createToken(token);
// Create AppRole credentials
vault.createAppRole("testrole", policyList);
AppRoleSecretResponse secret = vault.createAppRoleSecret("testrole");
```
## Links
[Project Page](https://jvault.stklcode.de)
[JavaDoc API](https://jvault.stklcode.de/apidocs/)
## License
The project is licensed under [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0).