Java client information. (#346)

* Java client information. Signed-off-by: hayleycd <[email protected]> * Fixing linter issue. Signed-off-by: hayleycd <[email protected]> * Adding version info Signed-off-by: hayleycd <[email protected]> * Addressing linter comment Signed-off-by: hayleycd <[email protected]> * Addressing linter comment Signed-off-by: hayleycd <[email protected]> --------- Signed-off-by: hayleycd <[email protected]>
sigstore · Nov 19, 2024 · 5e694d5 · 5e694d5
1 parent d0c5d64
commit 5e694d5
Show file tree

Hide file tree

Showing 2 changed files with 109 additions and 1 deletion.
diff --git a/content/en/language_clients/java.md b/content/en/language_clients/java.md
@@ -0,0 +1,107 @@
+---
+type: docs
+category: Language Clients
+title: Java
+weight: 20
+---
+
+[`sigstore-java`](https://github.com/sigstore/sigstore-java#sigstore-java) is a java client for interacting with the Sigstore infrastructure.
+
+## Features
+
+- [Maven](https://github.com/sigstore/sigstore-java/tree/main/sigstore-maven-plugin) and [Gradle](https://github.com/sigstore/sigstore-java/tree/main/sigstore-gradle) signing plugins
+- Keyless signing and verifying
+- Java native signing and verifying [API](https://javadoc.io/doc/dev.sigstore/sigstore-java)
+
+## Installation
+
+Release information for the Java client is available [here](https://github.com/sigstore/sigstore-java/releases). We recommend using the latest version for your install.
+
+### Maven
+
+Requires Java 11
+
+```java
+      <plugin>
+        <groupId>dev.sigstore</groupId>
+        <artifactId>sigstore-maven-plugin</artifactId>
+        <version>1.0.0</version>
+        <executions>
+          <execution>
+            <id>sign</id>
+            <goals>
+              <goal>sign</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+```
+
+More information on the Maven build plugin is available in the [project repository](https://github.com/sigstore/sigstore-java/tree/main/sigstore-maven-plugin#sigstore-maven-plugin).
+
+### Gradle
+
+Requires Java 11 and Gradle 7.5.
+
+```java
+plugins {
+    id("dev.sigstore.sign") version "1.0.0"
+}
+```
+
+More information on the Gradle build plugin is available in the [project repository](https://github.com/sigstore/sigstore-java/tree/main/sigstore-gradle#sigstore-gradle).
+
+## API Usage Examples
+
+### Signing
+
+```java
+Path testArtifact = Paths.get("path/to/my/file.jar")
+
+// sign using the sigstore public instance
+var signer = KeylessSigner.builder().sigstorePublicDefaults().build();
+Bundle result = signer.signFile(testArtifact);
+
+// sigstore bundle format (serialized as <artifact>.sigstore.json)
+String bundleJson = result.toJson();
+```
+
+### Verifying
+
+#### Get artifact and bundle
+
+```java
+Path artifact = Paths.get("path/to/my-artifact");
+
+// import a json formatted sigstore bundle
+Path bundleFile = Paths.get("path/to/my-artifact.sigstore.json");
+Bundle bundle = Bundle.from(bundleFile, StandardCharsets.UTF_8);
+```
+
+#### Configure verification options
+
+```java
+// add certificate policy to verify the identity of the signer
+VerificationOptions options = VerificationOptions.builder().addCertificateMatchers(
+  CertificateMatcher.fulcio()
+    .subjectAlternativeName(StringMatcher.string("[email protected]"))
+    .issuer(StringMatcher.string("https://accounts.example.com"))
+    .build());
+```
+
+#### Do verification
+
+```java
+try {
+  // verify using the sigstore public instance
+  var verifier = new KeylessVerifier.builder().sigstorePublicDefaults().build();
+  verifier.verify(artifact, bundle, verificationOptions);
+  // verification passed!
+} catch (KeylessVerificationException e) {
+  // verification failed
+}
+```
+
+### Additional examples
+
+[Additional](https://github.com/sigstore/sigstore-java/tree/main/examples/hello-world#sigstore-examples) [examples](https://github.com/sigstore/sigstore-java/tree/main/examples/pgp#pgp-test-keys-for-examples) are available in the project repository.
diff --git a/content/en/language_clients/language_client_overview.md b/content/en/language_clients/language_client_overview.md
@@ -12,8 +12,9 @@ Language client summaries are available in the main Sigstore documentation, but
 | Language Client Summary                  | Project Repository                                             |
 | ---------------------------------------- | -------------------------------------------------------------- |
 | [Go](../go)                              | [sigstore-go](https://github.com/sigstore/sigstore-go)         |
-| Java (available soon)                    | [sigstore-java](https://github.com/sigstore/sigstore-java)     |
+| [Java](../java)                          | [sigstore-java](https://github.com/sigstore/sigstore-java)     |
 | [Javascript](../javascript)              | [sigstore-js](https://github.com/sigstore/sigstore-js)         |
 | [Python](../python)                      | [sigstore-python](https://github.com/sigstore/sigstore-python) |
 | Ruby (available soon)                    | [sigstore-ruby](https://github.com/sigstore/sigstore-ruby)     |
 | [Rust](../rust)                          | [sigstore-rs](https://github.com/sigstore/sigstore-rs)         |
+