update versions to 1.4.0, remove AppID examples
5
Home.md
5
Home.md
@ -1,6 +1,6 @@
|
|||||||
# Java Vault Connector
|
# Java Vault 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.
|
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.
|
||||||
|
|
||||||
@ -13,7 +13,6 @@ Java Vault Connector is a connector library for [Vault](https://www.vaultproject
|
|||||||
* Token
|
* Token
|
||||||
* Username/Password
|
* Username/Password
|
||||||
* AppRole (register and authenticate)
|
* AppRole (register and authenticate)
|
||||||
* AppID (register and authenticate) [_deprecated_]
|
|
||||||
* Tokens
|
* Tokens
|
||||||
* Creation and lookup of tokens and token roles
|
* Creation and lookup of tokens and token roles
|
||||||
* TokenBuilder for speaking creation of complex configurations
|
* TokenBuilder for speaking creation of complex configurations
|
||||||
@ -27,4 +26,4 @@ Java Vault Connector is a connector library for [Vault](https://www.vaultproject
|
|||||||
* SQL secret handling
|
* SQL secret handling
|
||||||
* KV v1 and v2 support
|
* KV v1 and v2 support
|
||||||
* Connector Factory with builder pattern
|
* Connector Factory with builder pattern
|
||||||
* Tested against Vault 1.11.2
|
* Tested against Vault 1.2 to 1.18
|
||||||
|
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
[](https://search.maven.org/#search%7Cga%7C1%7Cg%3A%22de.stklcode.jvault%22%20AND%20a%3A%22jvault-connector%22)
|
[](https://central.sonatype.com/artifact/de.stklcode.jvault/jvault-connector)
|
||||||
|
|
||||||
The connector is published at Maven Central and may be included into your project easily.
|
The connector is published at Maven Central and may be included into your project easily.
|
||||||
|
|
||||||
@ -12,16 +12,16 @@ The connector is published at Maven Central and may be included into your projec
|
|||||||
<dependency>
|
<dependency>
|
||||||
<groupId>de.stklcode.jvault</groupId>
|
<groupId>de.stklcode.jvault</groupId>
|
||||||
<artifactId>jvault-connector</artifactId>
|
<artifactId>jvault-connector</artifactId>
|
||||||
<version>1.1.1</version>
|
<version>1.4.0</version>
|
||||||
</dependency>
|
</dependency>
|
||||||
```
|
```
|
||||||
|
|
||||||
### Gradle Dependency
|
### Gradle Dependency
|
||||||
```groovy
|
```groovy
|
||||||
compile group: 'de.stklcode.jvault', name: 'jvault-connector', version: '1.1.1'
|
compile group: 'de.stklcode.jvault', name: 'jvault-connector', version: '1.4.0'
|
||||||
```
|
```
|
||||||
|
|
||||||
### SBT Dependency
|
### SBT Dependency
|
||||||
```
|
```
|
||||||
libraryDependencies += "de.stklcode.jvault" % "jvault-connector" % "1.1.1"
|
libraryDependencies += "de.stklcode.jvault" % "jvault-connector" % "1.4.0"
|
||||||
```
|
```
|
||||||
|
@ -8,15 +8,14 @@ The connector currently supports four authorization methods.
|
|||||||
* Token
|
* Token
|
||||||
* Username & Password
|
* Username & Password
|
||||||
* AppRole
|
* AppRole
|
||||||
* AppID [_deprecated_]
|
|
||||||
|
|
||||||
#### Token
|
#### Token
|
||||||
|
|
||||||
##### Authenticate
|
##### Authenticate
|
||||||
|
|
||||||
```java
|
```java
|
||||||
VaultConnector connector = ...;
|
VaultConnector connector = ...;
|
||||||
connector.authToken("01234567-89ab-cdef-0123-456789abcdef");
|
connector.authToken("01234567-89ab-cdef-0123-456789abcdef");
|
||||||
```
|
```
|
||||||
|
|
||||||
##### Create new Token
|
##### Create new Token
|
||||||
@ -30,48 +29,39 @@ The connector currently supports four authorization methods.
|
|||||||
AuthResponse createResponse = connector.createToken(token);
|
AuthResponse createResponse = connector.createToken(token);
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Username & Password
|
#### Username & Password
|
||||||
|
|
||||||
##### Authenticate
|
##### Authenticate
|
||||||
|
|
||||||
```java
|
```java
|
||||||
VaultConnector connector = ...;
|
VaultConnector connector = ...;
|
||||||
connector.authUserPass("username", "p4ssw0rd");
|
connector.authUserPass("username", "p4ssw0rd");
|
||||||
```
|
```
|
||||||
|
|
||||||
#### AppRole
|
#### AppRole
|
||||||
|
|
||||||
##### Authenticate
|
##### Authenticate
|
||||||
```java
|
```java
|
||||||
VaultConnector connector = ...;
|
VaultConnector connector = ...;
|
||||||
// connector.authAppId("role-id", "secret-id");
|
// connector.authAppId("role-id", "secret-id");
|
||||||
connector.authAppRole("01234567-89ab-cdef-0123-456789abcdef", "fedcba98-7654-3210-fedc-ba9876543210");
|
connector.authAppRole("01234567-89ab-cdef-0123-456789abcdef", "fedcba98-7654-3210-fedc-ba9876543210");
|
||||||
```
|
```
|
||||||
|
|
||||||
##### Manage roles and secrets
|
##### Manage roles and secrets
|
||||||
|
|
||||||
```java
|
```java
|
||||||
// Create new role using the builder. Supports all current role parameters.
|
// Create new role using the builder. Supports all current role parameters.
|
||||||
AppRole role = AppRole.builder("role-name").build();
|
AppRole role = AppRole.builder("role-name").build();
|
||||||
|
|
||||||
// Write the new role to Vault.
|
// Write the new role to Vault.
|
||||||
boolean created = connector.createAppRole(role);
|
boolean created = connector.createAppRole(role);
|
||||||
|
|
||||||
// Lookup the role by name.
|
// Lookup the role by name.
|
||||||
AppRoleResponse res = connector.lookupAppRole("role-name");
|
AppRoleResponse res = connector.lookupAppRole("role-name");
|
||||||
|
|
||||||
// Create a new secret with random ID.
|
// Create a new secret with random ID.
|
||||||
AppRoleSecretResponse secret = connector.createAppRoleSecret("role-name");
|
AppRoleSecretResponse secret = connector.createAppRoleSecret("role-name");
|
||||||
|
|
||||||
// Destroy the secret.
|
// Destroy the secret.
|
||||||
boolean destroyed = connector.destroyAppRoleSecret("role-name", secret.getSecret().getId());
|
boolean destroyed = connector.destroyAppRoleSecret("role-name", secret.getSecret().getId());
|
||||||
```
|
|
||||||
|
|
||||||
#### AppID
|
|
||||||
```java
|
|
||||||
VaultConnector connector = ...;
|
|
||||||
// connector.authAppId("app-id", "user-id");
|
|
||||||
connector.authAppId("01234567-89ab-cdef-0123-456789abcdef", "fedcba98-7654-3210-fedc-ba9876543210");
|
|
||||||
```
|
```
|
||||||
|
Reference in New Issue
Block a user