Minor amendments.
Signed-off-by: Max Lambrecht <maxlambrecht@gmail.com>
This commit is contained in:
parent
f663e75a27
commit
f47e48f684
|
|
@ -3,6 +3,8 @@
|
||||||
<a href='https://travis-ci.org/spiffe/java-spiffe.svg?branch=master'><img src='https://travis-ci.org/spiffe/java-spiffe.svg?branch=master'></a>
|
<a href='https://travis-ci.org/spiffe/java-spiffe.svg?branch=master'><img src='https://travis-ci.org/spiffe/java-spiffe.svg?branch=master'></a>
|
||||||
[](https://coveralls.io/github/spiffe/java-spiffe?branch=master)
|
[](https://coveralls.io/github/spiffe/java-spiffe?branch=master)
|
||||||
|
|
||||||
|
**Supports Java 8+**
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
The JAVA-SPIFFE library provides functionality to interact with the Workload API to fetch X.509 and JWT SVIDs and Bundles,
|
The JAVA-SPIFFE library provides functionality to interact with the Workload API to fetch X.509 and JWT SVIDs and Bundles,
|
||||||
|
|
@ -12,17 +14,15 @@ asynchronously from the Workload API. The KeyStore handles the Certificate chain
|
||||||
in a TLS connection, and the TrustStore handles the trusted bundles (supporting federated bundles) and performs
|
in a TLS connection, and the TrustStore handles the trusted bundles (supporting federated bundles) and performs
|
||||||
peer's certificate and SPIFFE ID verification.
|
peer's certificate and SPIFFE ID verification.
|
||||||
|
|
||||||
This library is composed of three modules:
|
This library contains three modules:
|
||||||
|
|
||||||
[java-spiffe-core](java-spiffe-core/README.md): core functionality to interact with the Workload API, and to process and validate
|
[java-spiffe-core](java-spiffe-core/README.md): Core functionality to interact with the Workload API, and to process and validate
|
||||||
X.509 and JWT SVIDs and bundles.
|
X.509 and JWT SVIDs and bundles.
|
||||||
|
|
||||||
[java-spiffe-provider](java-spiffe-provider/README.md): Java Provider implementation.
|
[java-spiffe-provider](java-spiffe-provider/README.md): Java Provider implementation.
|
||||||
|
|
||||||
[java-spiffe-helper](java-spiffe-helper/README.md): Helper to store X.509 SVIDs and Bundles in Java Keystores in disk.
|
[java-spiffe-helper](java-spiffe-helper/README.md): Helper to store X.509 SVIDs and Bundles in Java Keystores in disk.
|
||||||
|
|
||||||
**Supports Java 8+**
|
|
||||||
|
|
||||||
### Build the JARs
|
### Build the JARs
|
||||||
|
|
||||||
On Linux or MacOS, run:
|
On Linux or MacOS, run:
|
||||||
|
|
|
||||||
|
|
@ -50,7 +50,7 @@ subprojects {
|
||||||
|
|
||||||
testCompileOnly group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: "${jupiterVersion}"
|
testCompileOnly group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: "${jupiterVersion}"
|
||||||
testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: "${jupiterVersion}"
|
testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: "${jupiterVersion}"
|
||||||
testCompile group: 'org.junit.jupiter', name: 'junit-jupiter-params', version: "${jupiterVersion}"
|
testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-params', version: "${jupiterVersion}"
|
||||||
|
|
||||||
testCompileOnly group: 'org.mockito', name: 'mockito-core', version: "${mockitoVersion}"
|
testCompileOnly group: 'org.mockito', name: 'mockito-core', version: "${mockitoVersion}"
|
||||||
testRuntimeOnly group: 'org.mockito', name: 'mockito-junit-jupiter', version: "${mockitoVersion}"
|
testRuntimeOnly group: 'org.mockito', name: 'mockito-junit-jupiter', version: "${mockitoVersion}"
|
||||||
|
|
|
||||||
|
|
@ -15,7 +15,7 @@ import java.util.stream.Collectors;
|
||||||
* @see <a href="https://github.com/spiffe/spiffe/blob/master/standards/SPIFFE-ID.md">https://github.com/spiffe/spiffe/blob/master/standards/SPIFFE-ID.md</a>
|
* @see <a href="https://github.com/spiffe/spiffe/blob/master/standards/SPIFFE-ID.md">https://github.com/spiffe/spiffe/blob/master/standards/SPIFFE-ID.md</a>
|
||||||
*/
|
*/
|
||||||
@Value
|
@Value
|
||||||
public final class SpiffeId {
|
public class SpiffeId {
|
||||||
|
|
||||||
public static final String SPIFFE_SCHEME = "spiffe";
|
public static final String SPIFFE_SCHEME = "spiffe";
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -9,7 +9,7 @@ public enum AddressScheme {
|
||||||
|
|
||||||
private final String name;
|
private final String name;
|
||||||
|
|
||||||
private AddressScheme(final String scheme) {
|
AddressScheme(final String scheme) {
|
||||||
this.name = scheme;
|
this.name = scheme;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -28,7 +28,7 @@ public interface WorkloadApiClient extends Closeable {
|
||||||
/**
|
/**
|
||||||
* Watches for X.509 context updates.
|
* Watches for X.509 context updates.
|
||||||
* <p>
|
* <p>
|
||||||
* A new Stream to the Workload API is opened for each call to this method, so that the client start getting
|
* A new Stream to the Workload API is opened for each call to this method, so that the client starts getting
|
||||||
* updates immediately after the Stream is ready and doesn't have to wait until the Workload API dispatches
|
* updates immediately after the Stream is ready and doesn't have to wait until the Workload API dispatches
|
||||||
* the next update based on the SVIDs TTL.
|
* the next update based on the SVIDs TTL.
|
||||||
*
|
*
|
||||||
|
|
@ -78,7 +78,7 @@ public interface WorkloadApiClient extends Closeable {
|
||||||
/**
|
/**
|
||||||
* Watches for JWT bundles updates.
|
* Watches for JWT bundles updates.
|
||||||
* <p>
|
* <p>
|
||||||
* A new Stream to the Workload API is opened for each call to this method, so that the client start getting
|
* A new Stream to the Workload API is opened for each call to this method, so that the client starts getting
|
||||||
* updates immediately after the Stream is ready and doesn't have to wait until the Workload API dispatches
|
* updates immediately after the Stream is ready and doesn't have to wait until the Workload API dispatches
|
||||||
* the next update based on the SVIDs TTL.
|
* the next update based on the SVIDs TTL.
|
||||||
*
|
*
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue