From 352f6d3c7f5a378384a35a6cd5a5735c147011bd Mon Sep 17 00:00:00 2001 From: Paul Schaub Date: Wed, 6 Apr 2022 14:11:20 +0200 Subject: [PATCH] Add vks-java/README --- vks-java/README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 vks-java/README.md diff --git a/vks-java/README.md b/vks-java/README.md new file mode 100644 index 0000000..f499bdb --- /dev/null +++ b/vks-java/README.md @@ -0,0 +1,28 @@ + + +# VKS-Java + +[![javadoc](https://javadoc.io/badge2/org.pgpainless/vks-java/javadoc.svg)](https://javadoc.io/doc/org.pgpainless/vks-java) +[![Maven Central](https://badgen.net/maven/v/maven-central/org.pgpainless/vks-java)](https://search.maven.org/artifact/org.pgpainless/vks-java) + +Client Side API for Communicating with Verifying Key Servers. + +```java +VKS vks = new VKSImpl("https://keys.openpgp.org/"); + +// Key Discovery via Email, key-id or fingerprint +InputStream bobsKey = vks.get().byEmail("bob@pgpainless.org"); + +// Upload Key to the VKS +InputStream myKey = ... +Upload.Response uploadResponse = vks.upload().cert(myKey); + +// Request email verification of user-ids +RequestVerify.Response verifyResponse = vks.requestVerification() + .forEmailAddress("bob@pgpainless.org") + .execute(uploadResponse.getToken()); +```