Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spiffe/java-spiffe
Java library for SPIFFE support
https://github.com/spiffe/java-spiffe
Last synced: 2 days ago
JSON representation
Java library for SPIFFE support
- Host: GitHub
- URL: https://github.com/spiffe/java-spiffe
- Owner: spiffe
- License: apache-2.0
- Created: 2018-05-23T17:10:04.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-12-10T22:04:07.000Z (11 days ago)
- Last Synced: 2024-12-10T23:18:25.564Z (11 days ago)
- Language: Java
- Homepage:
- Size: 937 KB
- Stars: 34
- Watchers: 14
- Forks: 22
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-spiffe-spire - java spiffe
README
# Java SPIFFE Library
[](https://github.com/spiffe/java-spiffe/actions/workflows/build.yml?query=branch%3Amain)
[](https://coveralls.io/github/spiffe/java-spiffe?branch=main)
## Overview
The JAVA-SPIFFE library provides functionality to interact with the Workload API to fetch X.509 and JWT SVIDs and Bundles,
and a Java Security Provider implementation to be plugged into the Java Security architecture. This is essentially
an X.509-SVID based KeyStore and TrustStore implementation that handles the certificates in memory and receives the updates
asynchronously from the Workload API. The KeyStore handles the Certificate chain and Private Key to prove identity
in a TLS connection, and the TrustStore handles the trusted bundles (supporting federated bundles) and performs
peer's certificate and SPIFFE ID verification.
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
X.509 and JWT SVIDs and bundles.
* [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.
**Supports Java 8+**
Download
--------
The JARs can be downloaded from [Maven Central](https://search.maven.org/search?q=g:io.spiffe%20AND%20v:0.8.11).
The dependencies can be added to `pom.xml`
To import the `java-spiffe-provider` component:
```xml
io.spiffe
java-spiffe-provider
0.8.11
```
The `java-spiffe-provider` component imports the `java-spiffe-core` component.
To just import the `java-spiffe-core` component:
```xml
io.spiffe
java-spiffe-core
0.8.11
```
Using Gradle:
Import `java-spiffe-provider`:
```gradle
implementation group: 'io.spiffe', name: 'java-spiffe-provider', version: '0.8.11'
```
Import `java-spiffe-core`:
```gradle
implementation group: 'io.spiffe', name: 'java-spiffe-core', version: '0.8.11'
```
### MacOS Support
#### x86 Architecture
In case run on a osx-x86 architecture, add to your `pom.xml`:
```xml
io.spiffe
grpc-netty-macos
0.8.11
runtime
```
Using Gradle:
```gradle
runtimeOnly group: 'io.spiffe', name: 'grpc-netty-macos', version: '0.8.11'
```
#### Aarch64 (M1) Architecture
If you are running the aarch64 architecture (M1 CPUs), add to your `pom.xml`:
```xml
io.spiffe
grpc-netty-macos-aarch64
0.8.11
runtime
```
Using Gradle:
```gradle
runtimeOnly group: 'io.spiffe', name: 'grpc-netty-macos-aarch64', version: '0.8.11'
```
*Caveat: not all OpenJDK distributions are aarch64 native, make sure your JDK is also running
natively*
## Java SPIFFE Helper
The `java-spiffe-helper` module manages X.509 SVIDs and Bundles in Java Keystores.
### Docker Image
Pull the `java-spiffe-helper` image from `ghcr.io/spiffe/java-spiffe-helper:0.8.11`.
For more details, see [java-spiffe-helper/README.md](java-spiffe-helper/README.md).
## Build the JARs
On Linux or MacOS, run:
```
$ ./gradlew assemble
BUILD SUCCESSFUL
```
All `jar` files are placed in `build/libs` folder.
#### Jars that include all dependencies
For the module [java-spiffe-provider](java-spiffe-provider), a fat jar is generated with the classifier `-all-[os-classifier]`.
For the module [java-spiffe-helper](java-spiffe-helper), a fat jar is generated with the classifier `[os-classifier]`.
Based on the OS where the build is run, the `[os-classifier]` will be:
* `-linux-x86_64` for Linux
* `-osx-x86_64` for MacOS with x86_64 architecture
* `-osx-aarch64` for MacOS with aarch64 architecture (M1)