pax_global_header 0000666 0000000 0000000 00000000064 14001511033 0014476 g ustar 00root root 0000000 0000000 52 comment=4e1ee347deb67cdd37876ed2ca931e8ee33cdf35
java-hkp-client-0.2.0/ 0000775 0000000 0000000 00000000000 14001511033 0014452 5 ustar 00root root 0000000 0000000 java-hkp-client-0.2.0/.github/ 0000775 0000000 0000000 00000000000 14001511033 0016012 5 ustar 00root root 0000000 0000000 java-hkp-client-0.2.0/.github/workflows/ 0000775 0000000 0000000 00000000000 14001511033 0020047 5 ustar 00root root 0000000 0000000 java-hkp-client-0.2.0/.github/workflows/maven.yml 0000664 0000000 0000000 00000001324 14001511033 0021700 0 ustar 00root root 0000000 0000000 # This workflow will build a Java project with Maven
# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
name: Run Test Coverage
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up JDK 1.8
uses: actions/setup-java@v1
with:
java-version: 1.8
- name: Cache Maven packages
uses: actions/cache@v2
with:
path: ~/.m2
key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
restore-keys: ${{ runner.os }}-m2
- name: Build with Maven
run: mvn clean test
java-hkp-client-0.2.0/.gitignore 0000664 0000000 0000000 00000000026 14001511033 0016440 0 ustar 00root root 0000000 0000000 target/
.idea/
*.iml
java-hkp-client-0.2.0/CHANGELOG.md 0000664 0000000 0000000 00000000434 14001511033 0016264 0 ustar 00root root 0000000 0000000 # Change Log
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).
## 0.2.0 (01/19/2021)
- Upgrade internal dependency of HttpClient from 4.5.x to 5.0.3.
## 0.1.0 (01/18/2021)
- Initial release! java-hkp-client-0.2.0/LICENSE.txt 0000664 0000000 0000000 00000002114 14001511033 0016273 0 ustar 00root root 0000000 0000000 Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. java-hkp-client-0.2.0/README.md 0000664 0000000 0000000 00000006363 14001511033 0015741 0 ustar 00root root 0000000 0000000 # Java-HKP-Client Java OpenPGP HTTP Keyserver Protocol API Client
## What is it?
This library provides an easy to use client library for interacting with a OpenPGP HTTP Keyserver Protocol (HKP) server.
## How to use this library
This client library is released on Maven Central. Add a new dependency to your project's POM file:
```xml
org.sourcelabjava-hkp-client0.2.0
```
#### Example Code:
```java
/*
* Create a new configuration object.
*
* This configuration also allows you to define some optional details on your connection,
* such as using an outbound proxy (authenticated or not), SSL client settings, etc..
*/
final Configuration.Builder configuration = Configuration.newBuilder()
.withKeyServerHost("http://pool.sks-keyservers.net");
/*
* Create an instance of HKPClient, passing your configuration.
*/
final HkpClient client = new HkpClient(configuration);
/*
* Making requests by calling the public methods available on HkpClient.
*
* For example, search for a key by Email:
*/
final SearchIndexResponse result = client
.search(new SearchRequest("example@example.com"));
/*
* or retrieve a key by KeyId.
*/
final Optional result = client.get(new GetRequest("0x92E73960FC59970DFB12F0146D712A2D27F74CE9"));
/*
* See HkpClient for other available operations.
*/
```
Public methods available on HkpClient can be [found here](src/main/java/org/sourcelab/hkp/HkpClient.java#L62)
# Contributing
Found a bug? Think you've got an awesome feature you want to add? We welcome contributions!
## Submitting a Contribution
1. Search for an existing issue. If none exists, create a new issue so that other contributors can keep track of what you are trying to add/fix and offer suggestions (or let you know if there is already an effort in progress). Be sure to clearly state the problem you are trying to solve and an explanation of why you want to use the strategy you're proposing to solve it.
1. Fork this repository on GitHub and create a branch for your feature.
1. Clone your fork and branch to your local machine.
1. Commit changes to your branch.
1. Push your work up to GitHub.
1. Submit a pull request so that we can review your changes.
*Make sure that you rebase your branch off of master before opening a new pull request. We might also ask you to rebase it if master changes after you open your pull request.*
## Acceptance Criteria
We love contributions, but it's important that your pull request adhere to some of the standards we maintain in this repository.
- All tests must be passing!
- All code changes require tests!
- All code changes must be consistent with our checkstyle rules.
- Great inline comments.
# Other Notes
## Releasing
Steps for proper release:
- Update release version: `mvn versions:set -DnewVersion=X.Y.Z`
- Validate and then commit version: `mvn versions:commit`
- Update CHANGELOG and README files.
- Merge to master.
- Deploy to Maven Central: `mvn clean deploy -P release`
- Create release on Github project.
## Changelog
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).
[View Changelog](CHANGELOG.md)
java-hkp-client-0.2.0/build/ 0000775 0000000 0000000 00000000000 14001511033 0015551 5 ustar 00root root 0000000 0000000 java-hkp-client-0.2.0/build/checkstyle.xml 0000664 0000000 0000000 00000021611 14001511033 0020432 0 ustar 00root root 0000000 0000000
java-hkp-client-0.2.0/pom.xml 0000664 0000000 0000000 00000027560 14001511033 0016001 0 ustar 00root root 0000000 0000000
4.0.0org.sourcelabjava-hkp-client0.2.03.3.9Http KeyServer Protocol Client for JavaA client for talking to PGP Key Servers using HKP (Http KeyServer Protocol). Defined by RFC https://tools.ietf.org/html/draft-shaw-openpgp-hkp-00 https://github.com/SourceLabOrg/java-hkp-clientStephen Powisstephen.powis@gmail.comSourceLab.orghttps://www.sourcelab.org/MIT Licensehttp://www.opensource.org/licenses/mit-license.phpscm:git:git://github.com/sourcelaborg/java-hkp-client.gitscm:git:ssh://github.com:sourcelaborg/java-hkp-client.githttps://github.com/SourceLabOrg/java-hkp-client/tree/mainUTF-8885.0.3build/checkstyle.xml3.1.18.322.13.21.7.305.7.0falsetruefalseIntegrationTestorg.apache.httpcomponents.client5httpclient5${http-components.version}org.slf4jslf4j-api${slf4j.version}org.junit.jupiterjunit-jupiter${junit.version}testorg.apache.logging.log4jlog4j-api${log4j2.version}testorg.apache.logging.log4jlog4j-core${log4j2.version}testorg.apache.logging.log4jlog4j-slf4j-impl${log4j2.version}testorg.apache.maven.pluginsmaven-compiler-plugin3.8.01.81.8org.apache.maven.pluginsmaven-surefire-plugin2.22.2-Xmx256M${skipTests}alphabetical
${excludeTests}
org.apache.maven.pluginsmaven-checkstyle-plugin${checkstyle.plugin.version}checkstyle-validatevalidate${checkstyle.ruleset}utf-8truewarningtruefalse${skipCheckStyle}checkstylecheckcom.mycilalicense-maven-plugin3.0LICENSE.txt**/*.md**/*.bak**/*.yml**/*.yaml**/*.xmlbuild/**src/test/resources/**src/main/resources/**LICENSE.txtcompilecheckorg.sonatype.pluginsnexus-staging-maven-plugin1.6.8trueossrhhttps://oss.sonatype.org/trueorg.apache.maven.pluginsmaven-checkstyle-plugin${checkstyle.plugin.version}com.puppycrawl.toolscheckstyle${checkstyle.version}ossrhhttps://oss.sonatype.org/content/repositories/snapshotsreleaseorg.apache.maven.pluginsmaven-source-pluginattach-sourcesjarorg.apache.maven.pluginsmaven-javadoc-pluginattach-javadocsjar8org.apache.maven.pluginsmaven-gpg-plugin1.6sign-artifactsverifysignSourceLab.org
java-hkp-client-0.2.0/src/ 0000775 0000000 0000000 00000000000 14001511033 0015241 5 ustar 00root root 0000000 0000000 java-hkp-client-0.2.0/src/main/ 0000775 0000000 0000000 00000000000 14001511033 0016165 5 ustar 00root root 0000000 0000000 java-hkp-client-0.2.0/src/main/java/ 0000775 0000000 0000000 00000000000 14001511033 0017106 5 ustar 00root root 0000000 0000000 java-hkp-client-0.2.0/src/main/java/org/ 0000775 0000000 0000000 00000000000 14001511033 0017675 5 ustar 00root root 0000000 0000000 java-hkp-client-0.2.0/src/main/java/org/sourcelab/ 0000775 0000000 0000000 00000000000 14001511033 0021654 5 ustar 00root root 0000000 0000000 java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/ 0000775 0000000 0000000 00000000000 14001511033 0022436 5 ustar 00root root 0000000 0000000 java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/ConfigurationBuilder.java 0000664 0000000 0000000 00000014005 14001511033 0027417 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp;
import org.sourcelab.hkp.config.Configuration;
import org.sourcelab.hkp.config.ProxyConfiguration;
import java.util.Objects;
/**
* HKP Client Configuration Builder.
* Used to construct {@link Configuration} instances.
*/
public class ConfigurationBuilder {
// Optional Proxy Configuration
private String proxyHost = null;
private int proxyPort = 0;
private String proxyScheme = "HTTP";
// Optional Proxy Authentication.
private String proxyUsername = null;
private String proxyPassword = null;
// Defines the HKS Key Server Host.
private String keyServerHost = null;
// Optional setting to skip validating SSL certificate.
private boolean ignoreInvalidSslCertificates = false;
// Optional setting to define request timeout.
private int requestTimeoutSecs = 10;
/**
* Allow setting optional proxy configuration over HTTP.
*
* @param proxyHost Host for the proxy to use.
* @param proxyPort Post for the proxy to use.
* @return Configuration instance.
*/
public ConfigurationBuilder withProxyHttp(final String proxyHost, final int proxyPort) {
return withProxy(proxyHost, proxyPort, "HTTP");
}
/**
* Allow setting optional proxy configuration over HTTPS.
*
* @param proxyHost Host for the proxy to use.
* @param proxyPort Post for the proxy to use.
* @return Configuration instance.
*/
public ConfigurationBuilder withProxyHttps(final String proxyHost, final int proxyPort) {
return withProxy(proxyHost, proxyPort, "HTTPS");
}
/**
* Allow setting optional proxy configuration.
*
* @param proxyHost Host for the proxy to use.
* @param proxyPort Post for the proxy to use.
* @param proxyScheme Scheme to use, HTTP/HTTPS
* @return Builder instance.
*/
public ConfigurationBuilder withProxy(final String proxyHost, final int proxyPort, final String proxyScheme) {
this.proxyHost = Objects.requireNonNull(proxyHost);
this.proxyPort = proxyPort;
this.proxyScheme = Objects.requireNonNull(proxyScheme);
return this;
}
/**
* Allow setting credentials for a proxy that requires authentication.
*
* @param proxyUsername Username for proxy.
* @param proxyPassword Password for proxy.
* @return Builder instance.
*/
public ConfigurationBuilder useProxyAuthentication(final String proxyUsername, final String proxyPassword) {
this.proxyUsername = proxyUsername;
this.proxyPassword = proxyPassword;
return this;
}
/**
* Allows for configuring the HKS Key Server Address.
*
* @param host the key server host in format of "http://my.host:80" or "https://my.host".
* @return Builder instance.
*/
public ConfigurationBuilder withKeyServerHost(final String host) {
this.keyServerHost = Objects.requireNonNull(host);
return this;
}
/**
* Disable all validation of SSL Certificates.
* Disabling validations is insecure and highly discouraged!
*
* @return Builder instance.
*/
public ConfigurationBuilder withIgnoreInvalidSslCertificates() {
return withIgnoreInvalidSslCertificates(true);
}
/**
* Configuration validation of SSL Certificates. Disabling validations is insecure and highly discouraged!
*
* @param ignoreInvalidSslCertificates Pass a value of true to disable SSL certificate validation.
* Pass a value of false to enable SSL certificate validation.
* @return Builder instance.
*/
public ConfigurationBuilder withIgnoreInvalidSslCertificates(final boolean ignoreInvalidSslCertificates) {
this.ignoreInvalidSslCertificates = ignoreInvalidSslCertificates;
return this;
}
public ConfigurationBuilder withRequestTimeout(int seconds) {
this.requestTimeoutSecs = seconds;
return this;
}
/**
* Create {@link Configuration} instance using properties defined on the builder.
* @return Configuration instance.
*/
public Configuration build() {
// Create optional proxy config
final ProxyConfiguration proxyConfiguration;
if (proxyHost == null) {
// Creates an empty ProxyConfiguration object (not configured).
proxyConfiguration = new ProxyConfiguration();
} else {
// Creates a ProxyConfiguration instance with appropriate values.
proxyConfiguration = new ProxyConfiguration(
proxyHost,
proxyPort,
proxyScheme,
proxyUsername,
proxyPassword
);
}
// Create instance.
return new Configuration(
keyServerHost,
proxyConfiguration,
ignoreInvalidSslCertificates,
requestTimeoutSecs
);
}
}
java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/ConnectionFailedException.java 0000664 0000000 0000000 00000002734 14001511033 0030372 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp;
/**
* An error occurred while attempting to connect to remote server.
* Typically, the connection was refused remotely.
*/
public class ConnectionFailedException extends InvalidRequestException {
public ConnectionFailedException(final String message, final Throwable cause) {
super(message, cause);
}
}
java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/HkpClient.java 0000664 0000000 0000000 00000014747 14001511033 0025177 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sourcelab.hkp.config.Configuration;
import org.sourcelab.hkp.parser.GetResponseParser;
import org.sourcelab.hkp.parser.ResponseParser;
import org.sourcelab.hkp.parser.SearchIndexResponseParser;
import org.sourcelab.hkp.request.GetRequest;
import org.sourcelab.hkp.request.Request;
import org.sourcelab.hkp.request.SearchRequest;
import org.sourcelab.hkp.response.ErrorResponse;
import org.sourcelab.hkp.response.Result;
import org.sourcelab.hkp.response.get.PgpPublicKey;
import org.sourcelab.hkp.response.search.SearchIndexResponse;
import org.sourcelab.hkp.rest.HttpClient5RestClient;
import org.sourcelab.hkp.rest.RestClient;
import org.sourcelab.hkp.rest.RestResponse;
import java.io.IOException;
import java.util.Objects;
import java.util.Optional;
/**
* HKS Key Server Client.
*/
public class HkpClient implements AutoCloseable {
private static final Logger logger = LoggerFactory.getLogger(HkpClient.class);
/**
* Our API Configuration.
*/
private final Configuration configuration;
/**
* Underlying RestClient to use.
*/
private final RestClient restClient;
/**
* Internal State flag.
*/
private boolean isInitialized = false;
/**
* Default Constructor.
* @param configurationBuilder Configuration Builder instance.
*/
public HkpClient(final ConfigurationBuilder configurationBuilder) {
this(
configurationBuilder,
new HttpClient5RestClient()
);
}
/**
* Constructor for injecting a RestClient implementation.
* Typically only used in testing.
* @param configurationBuilder Configuration Builder instance.
* @param restClient RestClient implementation to use.
*/
public HkpClient(final ConfigurationBuilder configurationBuilder, final RestClient restClient) {
this(
Objects.requireNonNull(configurationBuilder).build(),
Objects.requireNonNull(restClient)
);
}
/**
* Package protected constructor for when you need to keep a reference to the actual
* configuration instance being used. Typically for test use cases only.
*
* @param configuration Configuration instance.
* @param restClient RestClient implementation to use.
*/
HkpClient(final Configuration configuration, final RestClient restClient) {
this.configuration = Objects.requireNonNull(configuration);
this.restClient = Objects.requireNonNull(restClient);
}
private Result submitRequest(final Request request, final ResponseParser responseParser) {
// Submit request
final RestResponse restResponse = getRestClient().submitRequest(request);
final int responseCode = restResponse.getHttpCode();
String responseStr = restResponse.getResponseStr();
logger.info("Response: {}", restResponse);
// If not a success response code
if (responseCode != 200) {
// Parse error response
final ErrorResponse error = new ErrorResponse(
responseStr,
restResponse.getHttpCode()
);
// Return error response.
return Result.newError(error);
}
// Attempt to parse and return a Success result.
try {
return Result.newSuccess(
responseParser.parseResponse(restResponse.getResponseStr())
);
} catch (final IOException exception) {
throw new ParserException(exception.getMessage(), exception);
}
}
/**
* Returns the API configuration instance.
*
* @return Configuration.
*/
Configuration getConfiguration() {
return configuration;
}
/**
* package protected for access in tests.
* @return Rest Client.
*/
RestClient getRestClient() {
// If we haven't initialized.
if (!isInitialized) {
// Call Init.
restClient.init(getConfiguration());
// Flip state flag
isInitialized = true;
}
// return our rest client.
return restClient;
}
/**
* Clean up instance, releasing any resources held internally.
*/
public void close() {
getRestClient().close();
}
/**
* Issue a Search Request.
* @param request Defines the search request parameters.
* @return Response value.
*/
public SearchIndexResponse search(final SearchRequest request) {
return submitRequest(request, new SearchIndexResponseParser())
.handleError((error) -> {
throw new InvalidRequestException(error.getMessage(), error.getCode());
});
}
/**
* Get a PublicKey.
* @param request Defines the Get Key Request.
* @return Optional of PgpPublicKey. Optional will be empty if no key found.
*/
public Optional get(final GetRequest request) {
return Optional.ofNullable(submitRequest(request, new GetResponseParser())
.handleError((error) -> {
// On 404
if (error.getCode() == 404) {
// Just return empty Optional.
return null;
}
throw new InvalidRequestException(error.getMessage(), error.getCode());
}));
}
} java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/InvalidRequestException.java 0000664 0000000 0000000 00000003451 14001511033 0030122 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp;
/**
* Represents when a request is invalid.
*/
public class InvalidRequestException extends RuntimeException {
private final int errorCode;
/**
* Constructor.
* @param message Error message returned by server.
* @param errorCode Error code returned by server.
*/
public InvalidRequestException(final String message, final int errorCode) {
super(message);
this.errorCode = errorCode;
}
public InvalidRequestException(final String message, final Throwable cause) {
super(message, cause);
this.errorCode = -1;
}
public int getErrorCode() {
return errorCode;
}
}
java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/ParserException.java 0000664 0000000 0000000 00000002721 14001511033 0026416 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp;
/**
* Thrown when a parser implementation has an error.
*/
public class ParserException extends RuntimeException {
public ParserException(final String message) {
super(message);
}
public ParserException(final String message, final Throwable cause) {
super(message, cause);
}
}
java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/config/ 0000775 0000000 0000000 00000000000 14001511033 0023703 5 ustar 00root root 0000000 0000000 java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/config/Configuration.java 0000664 0000000 0000000 00000007443 14001511033 0027365 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp.config;
import org.sourcelab.hkp.ConfigurationBuilder;
import java.util.Objects;
/**
* Defines API Client Configuration.
* Use {@link ConfigurationBuilder} to create instances of these.
*/
public class Configuration {
// Proxy Configuration
private final ProxyConfiguration proxyConfiguration;
// Defines upstream keyserver host.
private final String keyServerHost;
/**
* Optional setting to skip validating SSL certificate.
* There should be no real valid use case for this option other then use against
* development environments.
*/
private final boolean ignoreInvalidSslCertificates;
private final int requestTimeoutSecs;
private final String basePath = "/pks/lookup";
/**
* Creates a new ConfigurationBuilder instance.
* @return ConfigurationBuilder instance.
*/
public static ConfigurationBuilder newBuilder() {
return new ConfigurationBuilder();
}
/**
* Constructor.
* Note: Use {@link ConfigurationBuilder} to create instances instead of calling this constructor.
*
* @param proxyConfiguration Defines Proxy Configuration.
* @param keyServerHost Defines KeyServer Host.
* @param ignoreInvalidSslCertificates Should SSL certificates be validated.
* @param requestTimeoutSecs Defines how long (in seconds) before a request times out.
*/
public Configuration(
final String keyServerHost,
final ProxyConfiguration proxyConfiguration,
final boolean ignoreInvalidSslCertificates,
final int requestTimeoutSecs) {
this.proxyConfiguration = Objects.requireNonNull(proxyConfiguration);
this.keyServerHost = Objects.requireNonNull(keyServerHost);
this.ignoreInvalidSslCertificates = ignoreInvalidSslCertificates;
this.requestTimeoutSecs = requestTimeoutSecs;
}
public boolean hasProxyConfigured() {
return proxyConfiguration.isConfigured();
}
public ProxyConfiguration getProxyConfiguration() {
return proxyConfiguration;
}
public boolean isIgnoreInvalidSslCertificates() {
return ignoreInvalidSslCertificates;
}
public String getKeyServerHost() {
return keyServerHost;
}
public int getRequestTimeoutSecs() {
return requestTimeoutSecs;
}
public String getBasePath() {
return basePath;
}
@Override
public String toString() {
return "Configuration{"
+ "keyServerHost='" + keyServerHost + '\''
+ ", proxyConfiguration=" + proxyConfiguration
+ ", ignoreInvalidSslCertificates=" + ignoreInvalidSslCertificates
+ '}';
}
}
java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/config/ProxyConfiguration.java 0000664 0000000 0000000 00000006570 14001511033 0030427 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp.config;
/**
* Defines properties for connecting via a Proxy.
*/
public class ProxyConfiguration {
// Optional Proxy Configuration
private final String host;
private final int port;
private final String scheme;
// Optional Proxy Authentication.
private final String username;
private final String password;
/**
* Empty constructor.
* Calling this will populate an un-configured instance, meaning no proxy will be used
* to make connections to the server.
*/
public ProxyConfiguration() {
this(null, 0, null, null, null);
}
/**
* Constructor.
* @param host Hostname of the proxy to connect to.
* @param port Port of the proxy to connect to.
* @param scheme Scheme of the proxy, supported values are 'HTTP' or 'HTTPS'
* @param username Username for a proxy which requires authentication. Pass NULL if no authentication required.
* @param password Password for a proxy which requires authentication. Pass NULL if no authentication required.
*/
public ProxyConfiguration(final String host, final int port, final String scheme, final String username, final String password) {
this.host = host;
this.port = port;
this.scheme = scheme;
this.username = username;
this.password = password;
}
public boolean isConfigured() {
return getHost() != null;
}
public boolean isAuthenticationRequired() {
return getUsername() != null;
}
public String getHost() {
return host;
}
public int getPort() {
return port;
}
public String getScheme() {
return scheme;
}
public String getUsername() {
return username;
}
public String getPassword() {
return password;
}
@Override
public String toString() {
String authDisplay = "";
if (isAuthenticationRequired()) {
authDisplay =
", username='" + username + '\''
+ ", password='XXXXXXXXXX'";
}
return "ProxyConfiguration{"
+ "host='" + host + '\''
+ ", port=" + port
+ ", scheme='" + scheme + '\''
+ authDisplay
+ '}';
}
}
java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/parser/ 0000775 0000000 0000000 00000000000 14001511033 0023732 5 ustar 00root root 0000000 0000000 java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/parser/FieldParser.java 0000664 0000000 0000000 00000004364 14001511033 0027004 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp.parser;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
/**
* For parsing HKS Responses.
*/
public class FieldParser {
/**
* Parses a line from a HKS response, where the fields are separated by : characters.
* @param line The line to parse.
* @return List of all the field values.
* @throws IOException on parse error.
*/
public static List parseLine(final String line) throws IOException {
if (line == null) {
throw new IOException("Unable to parse null line!");
}
final List fields = new ArrayList<>();
int index = 0;
do {
final int nextSeparator = line.indexOf(":", index);
if (nextSeparator == -1) {
fields.add(line.substring(index));
index = -1;
} else {
fields.add(line.substring(index, nextSeparator));
index = nextSeparator + 1;
}
}
while (index > 0);
return Collections.unmodifiableList(fields);
}
}
java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/parser/GetResponseParser.java 0000664 0000000 0000000 00000002771 14001511033 0030217 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp.parser;
import org.sourcelab.hkp.response.get.PgpPublicKey;
import java.io.IOException;
/**
* Parses Get Key responses.
*/
public class GetResponseParser implements ResponseParser {
@Override
public PgpPublicKey parseResponse(final String responseStr) throws IOException {
return new PgpPublicKey(responseStr);
}
}
java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/parser/ResponseParser.java 0000664 0000000 0000000 00000003373 14001511033 0027556 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp.parser;
import java.io.IOException;
/**
* Interface Parsers for API responses implement.
* @param The object type returned from the parser implementation.
*/
@FunctionalInterface
public interface ResponseParser {
/**
* The response from the request is given in String representation. Implementation should
* parse into something more useful and return it!
*
* @param responseStr The response string from the request.
* @return Parsed response.
* @throws IOException on parse errors.
*/
T parseResponse(final String responseStr) throws IOException;
}
java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/parser/SearchIndexResponseParser.java 0000664 0000000 0000000 00000010057 14001511033 0031671 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp.parser;
import org.sourcelab.hkp.response.search.Entry;
import org.sourcelab.hkp.response.search.Pub;
import org.sourcelab.hkp.response.search.SearchIndexResponse;
import org.sourcelab.hkp.response.search.Uid;
import java.io.IOException;
import java.util.List;
/**
* Parses SearchIndex Responses.
*/
public class SearchIndexResponseParser implements ResponseParser {
@Override
public SearchIndexResponse parseResponse(final String responseStr) throws IOException {
// avoid NPE
if (responseStr == null) {
throw new IOException("NULL Response from server.");
}
final String[] lines = responseStr.split("\n");
if (lines.length < 1) {
throw new IOException("Invalid Format returned from server: " + responseStr);
}
// Parse header into builder
final SearchIndexResponse.Builder builder = parseHeader(lines[0]);
for (int index = 1; index < lines.length; index = index + 2) {
if (lines[index].trim().isEmpty() || lines[index].equals("\r")) {
break;
}
builder.withEntry(
new Entry(parsePub(lines[index]), parseUid(lines[index + 1]))
);
}
return builder.build();
}
private Uid parseUid(final String line) throws IOException {
final List fields = FieldParser.parseLine(line);
if (fields.size() != 5) {
throw new IOException("Unable to uid line: \"" + line + "\"");
}
// uid::::
return Uid.newBuilder()
.withUid(fields.get(1))
.withCreationDate(fields.get(2))
.withExpirationDate(fields.get(3))
.withFlags(fields.get(4))
.build();
}
private Pub parsePub(final String line) throws IOException {
final List fields = FieldParser.parseLine(line);
if (fields.size() != 7) {
throw new IOException("Unable to pub line: \"" + line + "\"");
}
// pub::::::
return Pub.newBuilder()
.withKeyId(fields.get(1))
.withAlgo(Integer.parseInt(fields.get(2)))
.withKeyLen(Integer.parseInt(fields.get(3)))
.withCreationDate(fields.get(4))
.withExpirationDate(fields.get(5))
.withFlags(fields.get(6))
.build();
}
private SearchIndexResponse.Builder parseHeader(final String line) throws IOException {
final List fields = FieldParser.parseLine(line);
if (fields.size() != 3) {
throw new IOException("Unable to header line: \"" + line + "\"");
}
return SearchIndexResponse.newBuilder()
.withVersion(Integer.parseInt(fields.get(1)))
.withCount(Integer.parseInt(fields.get(2)));
}
}
java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/parser/StringResponseParser.java 0000664 0000000 0000000 00000002724 14001511033 0030744 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp.parser;
/**
* Simple pass through parser.
*/
public class StringResponseParser implements ResponseParser {
@Override
public String parseResponse(final String responseStr) {
// avoid NPE
if (responseStr == null) {
return "";
}
return responseStr;
}
}
java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/request/ 0000775 0000000 0000000 00000000000 14001511033 0024126 5 ustar 00root root 0000000 0000000 java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/request/AbstractRequest.java 0000664 0000000 0000000 00000004150 14001511033 0030105 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp.request;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
/**
* Shared Abstract Request.
*/
public abstract class AbstractRequest implements Request {
private final Map params = new HashMap<>();
/**
* Add a parameter to the request.
* @param name Name of the parameter.
* @param value value of the parameter.
*/
void withParameter(final String name, final String value) {
Objects.requireNonNull(name, "Parameter name may not be null.");
if (value == null) {
params.remove(name);
} else {
params.put(name, value);
}
}
/**
* Get all request parameters associated with the request.
* @return Map of request parameters.
*/
@Override
public Map getRequestParameters() {
withParameter("options", "mr");
return Collections.unmodifiableMap(params);
}
}
java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/request/GetRequest.java 0000664 0000000 0000000 00000003522 14001511033 0027063 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp.request;
import java.util.Map;
/**
* Defines a Get Key request.
*/
public class GetRequest extends AbstractRequest implements Request {
/**
* Constructor.
* @param keyId Id of key to retrieve.
*/
public GetRequest(final String keyId) {
withKeyId(keyId);
}
/**
* Define the keyId.
* @param keyId Id of key to retrieve.
* @return GetRequest instance.
*/
public GetRequest withKeyId(final String keyId) {
withParameter("search" , keyId);
return this;
}
@Override
public Map getRequestParameters() {
withParameter("op", "get");
return super.getRequestParameters();
}
}
java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/request/Request.java 0000664 0000000 0000000 00000002714 14001511033 0026425 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp.request;
import java.util.Map;
/**
* Interface for all Requests to implement.
*/
public interface Request {
/**
* Key/Value pairs of request parameters to be sent as part of the request.
* @return Request parameter key/value pairs.
*/
Map getRequestParameters();
}
java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/request/SearchRequest.java 0000664 0000000 0000000 00000005271 14001511033 0027554 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp.request;
import java.util.Map;
/**
* Defines a Search Request.
*/
public class SearchRequest extends AbstractRequest implements Request {
/**
* Constructor.
* @param search Defines the value to search.
* If searching by KeyId pass the keyId prefixed with "0x"
*/
public SearchRequest(final String search) {
withSearch(search);
}
/**
* Define the search term.
* If searching by KeyId, prefix the value with "0x"
* @param search Defines the value to search.
* @return SearchRequest instance.
*/
public SearchRequest withSearch(final String search) {
withParameter("search", search);
return this;
}
/**
* Perform an exact match on the search.
* @param exactMatch True for exact match, false otherwise.
* @return SearchRequest instance.
*/
public SearchRequest withExactMatch(final boolean exactMatch) {
if (exactMatch) {
return withExactMatch();
}
return withOutExactMatch();
}
/**
* Enable exact matching.
* @return SearchRequest instance.
*/
public SearchRequest withExactMatch() {
return withExactMatch(true);
}
/**
* Disable exact matching.
* @return SearchRequest instance.
*/
public SearchRequest withOutExactMatch() {
return withExactMatch(false);
}
@Override
public Map getRequestParameters() {
withParameter("op", "index");
return super.getRequestParameters();
}
}
java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/response/ 0000775 0000000 0000000 00000000000 14001511033 0024274 5 ustar 00root root 0000000 0000000 java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/response/ErrorResponse.java 0000664 0000000 0000000 00000003337 14001511033 0027755 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp.response;
/**
* Represents an error response from the api.
*/
public class ErrorResponse {
private final String message;
private final int code;
public ErrorResponse(final String message, final int code) {
this.message = message;
this.code = code;
}
public String getMessage() {
return message;
}
public int getCode() {
return code;
}
@Override
public String toString() {
return "ErrorResponse{"
+ "message='" + message + '\''
+ ", code=" + code
+ '}';
}
}
java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/response/Result.java 0000664 0000000 0000000 00000021135 14001511033 0026417 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp.response;
import org.sourcelab.hkp.InvalidRequestException;
import java.util.NoSuchElementException;
import java.util.Objects;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.function.Supplier;
/**
* Represents either a successful response from the API, or an error response.
* @param The return type for successful responses.
*/
public class Result {
private final T value;
private final ErrorResponse errorResponse;
/**
* Private constructor. Use factory methods. {@link Result#newSuccess} {@link Result#newError}
* @param response Success result object.
* @param errorResponse error result.
*/
private Result(final T response, final ErrorResponse errorResponse) {
if (response != null && errorResponse != null) {
throw new IllegalArgumentException("You may not pass both parameters as non-null");
} else if (response == null && errorResponse == null) {
throw new IllegalArgumentException("You may not pass both parameters as null");
}
this.value = response;
this.errorResponse = errorResponse;
}
/**
* Factory method for when there is a successful response.
* @param response Response object.
* @param Type of the response object.
* @return new ResultOrError instance.
*/
public static Result newSuccess(final T response) {
return new Result<>(Objects.requireNonNull(response), null);
}
/**
* Factory method for when there is an error returned from the API.
* @param errorResponse ErrorResponse object.
* @param Type of the response object.
* @return new ResultOrError instance.
*/
public static Result newError(final ErrorResponse errorResponse) {
return new Result<>(null, Objects.requireNonNull(errorResponse));
}
/**
* If a response from the API is present, returns the value, otherwise throws
* {@code NoSuchElementException}.
*
* @return the non-{@code null} value described by this {@code Optional}
* @throws NoSuchElementException if no success response is present
* @see Result#isSuccess()
*/
public T get() {
if (!isSuccess()) {
throw new NoSuchElementException("Cannot access response as there was an error");
}
return value;
}
/**
* If an error response from the API is present, return the error response.
* Otherwise throws {@code NoSuchElementException}.
* @return ErrorResponse from API.
* @throws NoSuchElementException if no error response is present.
* @see Result#isError() ()
*/
public ErrorResponse getError() {
if (isSuccess()) {
throw new NoSuchElementException("Cannot access response as there was an error");
}
return errorResponse;
}
/**
* Return {@code true} if there is a successful result from the API present, otherwise {@code false}.
*
* @return {@code true} if there is a value present, otherwise {@code false}
*/
public boolean isSuccess() {
return value != null;
}
/**
* Return {@code true} if there is a failure result from the API present, otherwise {@code false}.
*
* @return {@code true} if there is a value present, otherwise {@code false}
*/
public boolean isError() {
return !isSuccess();
}
/**
* Returns the success value if present, otherwise returns the default value.
* @param defaultValue value to be returned if no success value is present.
* @return Success value if present, otherwise returns the default value.
*/
public T getOrDefault(final T defaultValue) {
if (isSuccess()) {
return get();
}
return defaultValue;
}
/**
* For handling response values.
*
* @param successConsumer called if there is a successful response.
* @param errorResponseConsumer called if there is an error response.
* @return On success, call and return value from success handler. On error, call and return value from error handler.
*/
public T handle(final Function successConsumer, final Function errorResponseConsumer) {
if (isSuccess()) {
return successConsumer.apply(value);
} else {
return errorResponseConsumer.apply(errorResponse);
}
}
/**
* For handling response values.
*
* @param errorResponseConsumer called if there is an error response.
* @return On success, return the success result, otherwise calls the error handler and returns
* the value it generates.
*/
public T handleError(final Function errorResponseConsumer) {
if (isSuccess()) {
return value;
} else {
return errorResponseConsumer.apply(errorResponse);
}
}
/**
* If a success value is present, invoke the specified consumer with the value,
* otherwise do nothing.
*
* @param consumer block to be executed if a value is present
* @throws NullPointerException if value is present and {@code consumer} is null
*/
public void ifSuccess(final Consumer consumer) {
if (isSuccess()) {
consumer.accept(value);
}
}
/**
* If an error value is present, invoke the specified consumer with the error value,
* otherwise do nothing.
*
* @param consumer block to be executed if a value is present
* @throws NullPointerException if value is present and {@code consumer} is null
*/
public void ifError(final Consumer consumer) {
if (isError()) {
consumer.accept(getError());
}
}
/**
* If a value is present, returns the value, otherwise throws an exception
* produced by the exception supplying function.
*
* A method reference to the exception constructor with an empty argument
* list can be used as the supplier. For example,
* {@code IllegalStateException::new}
*
* @param Type of the exception to be thrown
* @param exceptionSupplier the supplying function that produces an
* exception to be thrown
* @return the value, if present
* @throws X if no value is present
* @throws NullPointerException if no value is present and the exception
* supplying function is {@code null}
*/
public T orElseThrow(final Supplier exceptionSupplier) throws X {
if (value != null) {
return value;
} else {
throw exceptionSupplier.get();
}
}
/**
* If a value is present, returns the value, otherwise throws an exception
* produced by the exception supplying function.
*
* A method reference to the exception constructor with an empty argument
* list can be used as the supplier. For example {@code IllegalStateException::new}
*
* @param Type of the exception to be thrown
* @return the value, if present
* @throws X if no value is present
* @throws NullPointerException if no value is present and the exception
* supplying function is {@code null}
*/
public T orElseThrowInvalidRequestException() throws X {
return orElseThrow(() -> new InvalidRequestException(errorResponse.getMessage(), errorResponse.getCode()));
}
}
java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/response/get/ 0000775 0000000 0000000 00000000000 14001511033 0025053 5 ustar 00root root 0000000 0000000 java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/response/get/PgpPublicKey.java 0000664 0000000 0000000 00000003421 14001511033 0030254 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp.response.get;
import java.util.Objects;
/**
* Represents a Public Key Response Block.
*/
public class PgpPublicKey {
private final String publicKey;
/**
* Constructor.
* @param publicKey The public key block.
*/
public PgpPublicKey(final String publicKey) {
Objects.requireNonNull(publicKey, "PublicKey parameter may not be null.");
this.publicKey = publicKey;
}
public String getPublicKey() {
return publicKey;
}
@Override
public String toString() {
return "PgpPublicKey{"
+ "publicKey='" + publicKey + '\''
+ '}';
}
}
java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/response/search/ 0000775 0000000 0000000 00000000000 14001511033 0025541 5 ustar 00root root 0000000 0000000 java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/response/search/Entry.java 0000664 0000000 0000000 00000003517 14001511033 0027513 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp.response.search;
import java.util.Objects;
/**
* Defines an Entry in the Search Response.
*/
public class Entry {
private final Pub pub;
private final Uid uid;
/**
* Contructor.
* @param pub defines the pub row.
* @param uid defines the Uid row.
*/
public Entry(final Pub pub, final Uid uid) {
this.pub = Objects.requireNonNull(pub);
this.uid = Objects.requireNonNull(uid);
}
public Pub getPub() {
return pub;
}
public Uid getUid() {
return uid;
}
@Override
public String toString() {
return "Entry{"
+ "pub=" + pub
+ ", uid=" + uid
+ '}';
}
}
java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/response/search/Pub.java 0000664 0000000 0000000 00000014207 14001511033 0027136 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp.response.search;
import java.time.Instant;
import java.time.LocalDateTime;
import java.time.ZoneId;
import java.util.Objects;
/**
* Represents the Pub line of a response.
* pub:keyid:algo:keylen:creationdate:expirationdate:flags
*/
public class Pub {
private final String keyId;
private final int algo;
private final int keyLen;
private final LocalDateTime creationDate;
private final LocalDateTime expirationDate;
private final String flags;
/**
* Constructor. See Builder instance.
* @param keyId KeyId.
* @param algo Algorithm Id.
* @param keyLen Key length.
* @param creationDate Creation Date.
* @param expirationDate Expiration Date.
* @param flags Flags.
*/
public Pub(final String keyId, final int algo, final int keyLen, final LocalDateTime creationDate, final LocalDateTime expirationDate, final String flags) {
this.keyId = keyId;
this.algo = algo;
this.keyLen = keyLen;
this.creationDate = creationDate;
this.expirationDate = expirationDate;
this.flags = flags;
}
public String getKeyId() {
return keyId;
}
public int getAlgo() {
return algo;
}
public int getKeyLen() {
return keyLen;
}
public LocalDateTime getCreationDate() {
return creationDate;
}
public LocalDateTime getExpirationDate() {
return expirationDate;
}
public String getFlags() {
return flags;
}
/**
* Create new Builder instance.
* @return new Builder instance.
*/
public static Builder newBuilder() {
return new Builder();
}
@Override
public String toString() {
return "Pub{"
+ "keyId='" + keyId + '\''
+ ", algo=" + algo
+ ", keyLen=" + keyLen
+ ", creationDate='" + creationDate + '\''
+ ", expirationDate='" + expirationDate + '\''
+ ", flags='" + flags + '\''
+ '}';
}
/**
* Builder for Pub.
*
* pub:keyid:algo:keylen:creationdate:expirationdate:flags
*/
public static final class Builder {
private String keyId = "";
private int algo = 0;
private int keyLen = 0;
private LocalDateTime creationDate = null;
private LocalDateTime expirationDate = null;
private String flags = "";
private Builder() {
}
public Builder withKeyId(final String keyId) {
this.keyId = Objects.requireNonNull(keyId);
return this;
}
public Builder withAlgo(final int algo) {
this.algo = algo;
return this;
}
public Builder withKeyLen(final int keyLen) {
this.keyLen = keyLen;
return this;
}
/**
* Set the creation date value.
* @param creationDate Represents the creation date in seconds past Unix Epoch
* @return Builder instance.
*/
public Builder withCreationDate(final long creationDate) {
this.creationDate = LocalDateTime.ofInstant(
Instant.ofEpochSecond(creationDate), ZoneId.systemDefault()
);
return this;
}
/**
* Set the creation date value.
* @param creationDate Represents the creation date in seconds past Unix Epoch
* @return Builder instance.
*/
public Builder withCreationDate(final String creationDate) {
try {
return withCreationDate(Long.parseLong(creationDate));
} catch (final NumberFormatException exception) {
this.creationDate = null;
}
return this;
}
/**
* Set the expiration date value.
* @param expirationDate Represents the expiration date in seconds past Unix Epoch
* @return Builder instance.
*/
public Builder withExpirationDate(final long expirationDate) {
this.expirationDate = LocalDateTime.ofInstant(
Instant.ofEpochSecond(expirationDate), ZoneId.systemDefault()
);
return this;
}
/**
* Set the expiration date value.
* @param expirationDate Represents the expiration date in seconds past Unix Epoch
* @return Builder instance.
*/
public Builder withExpirationDate(final String expirationDate) {
try {
return withExpirationDate(Long.parseLong(expirationDate));
} catch (final NumberFormatException exception) {
this.expirationDate = null;
}
return this;
}
public Builder withFlags(final String flags) {
this.flags = flags;
return this;
}
/**
* Creates new Pub instance.
* @return new Pub instance.
*/
public Pub build() {
return new Pub(keyId, algo, keyLen, creationDate, expirationDate, flags);
}
}
}
java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/response/search/SearchIndexResponse.java 0000664 0000000 0000000 00000007731 14001511033 0032330 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp.response.search;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
/**
* Represents the response from an index search request.
*/
public class SearchIndexResponse {
private final int version;
private final int count;
private final List entries;
/**
* Constructor.
* @param version Version value.
* @param count How many records were returned.
* @param entries The records returned.
*/
public SearchIndexResponse(final int version, final int count, final List entries) {
Objects.requireNonNull(entries);
this.version = version;
this.count = count;
this.entries = Collections.unmodifiableList(new ArrayList<>(entries));
}
public int getVersion() {
return version;
}
public int getCount() {
return count;
}
public List getEntries() {
return entries;
}
/**
* New Builder instance.
* @return New Builder instance.
*/
public static Builder newBuilder() {
return new Builder();
}
@Override
public String toString() {
return "SearchIndexResponse{"
+ "version=" + version
+ ", count=" + count
+ ", entries=" + entries
+ '}';
}
/**
* Builder instance.
*/
public static final class Builder {
private int version;
private int count;
private final List entries = new ArrayList<>();
private Builder() {
}
public Builder withVersion(final int version) {
this.version = version;
return this;
}
public Builder withCount(final int count) {
this.count = count;
return this;
}
/**
* Add a list of entries to the builder.
* @param entries List of entries to append to builder.
* @return Builder instance.
*/
public Builder withEntries(final List entries) {
Objects.requireNonNull(entries, "Entries parameter may not be null.");
if (entries != null) {
this.entries.addAll(entries);
}
return this;
}
/**
* Adds an entry to the builder.
* @param entry Entry to append to builder.
* @return Builder instance.
*/
public Builder withEntry(final Entry entry) {
if (entry != null) {
this.entries.add(entry);
}
return this;
}
/**
* Create SearchIndexResponse instance from builder.
* @return new SearchIndexResponse instance.
*/
public SearchIndexResponse build() {
return new SearchIndexResponse(version, count, entries);
}
}
}
java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/response/search/Uid.java 0000664 0000000 0000000 00000013302 14001511033 0027124 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp.response.search;
import java.time.Instant;
import java.time.LocalDateTime;
import java.time.ZoneId;
import java.util.Objects;
/**
* Represents the UID row from an index search.
*
* uid:escaped uid string:creationdate:expirationdate:flags
*/
public class Uid {
private final String uid;
private final LocalDateTime creationDate;
private final LocalDateTime expirationDate;
private final String flags;
/**
* Constructor. See Buidler instance.
* @param uid UID Value.
* @param creationDate Creation Date.
* @param expirationDate Expiration date.
* @param flags Flags.
*/
public Uid(final String uid, final LocalDateTime creationDate, final LocalDateTime expirationDate, final String flags) {
this.uid = uid;
this.creationDate = creationDate;
this.expirationDate = expirationDate;
this.flags = flags;
}
public String getUid() {
return uid;
}
public LocalDateTime getCreationDate() {
return creationDate;
}
public LocalDateTime getExpirationDate() {
return expirationDate;
}
public String getFlags() {
return flags;
}
/**
* Creates a new Builder instance.
* @return new Builder instance.
*/
public static Builder newBuilder() {
return new Builder();
}
@Override
public String toString() {
return "Uid{"
+ "uid='" + uid + '\''
+ ", creationDate='" + creationDate + '\''
+ ", expirationDate='" + expirationDate + '\''
+ ", flags='" + flags + '\''
+ '}';
}
/**
* Builder for Uid object.
* uid:escaped uid string:creationdate:expirationdate:flags
*/
public static final class Builder {
private String uid = "";
private LocalDateTime creationDate = null;
private LocalDateTime expirationDate = null;
private String flags = "";
private Builder() {
}
/**
* Defines the Uid.
* @param uid uid value.
* @return Builder instance.
*/
public Builder withUid(final String uid) {
this.uid = Objects.requireNonNull(uid);
return this;
}
/**
* Set the creation date value.
* @param creationDate Represents the creation date in seconds past Unix Epoch
* @return Builder instance.
*/
public Builder withCreationDate(final long creationDate) {
this.creationDate = LocalDateTime.ofInstant(
Instant.ofEpochSecond(creationDate), ZoneId.systemDefault()
);
return this;
}
/**
* Set the creation date value.
* @param creationDate Represents the creation date in seconds past Unix Epoch
* @return Builder instance.
*/
public Builder withCreationDate(final String creationDate) {
try {
return withCreationDate(Long.parseLong(creationDate));
} catch (final NumberFormatException exception) {
this.creationDate = null;
}
return this;
}
/**
* Set the expiration date value.
* @param expirationDate Represents the expiration date in seconds past Unix Epoch
* @return Builder instance.
*/
public Builder withExpirationDate(final long expirationDate) {
this.expirationDate = LocalDateTime.ofInstant(
Instant.ofEpochSecond(expirationDate), ZoneId.systemDefault()
);
return this;
}
/**
* Set the expiration date value.
* @param expirationDate Represents the expiration date in seconds past Unix Epoch
* @return Builder instance.
*/
public Builder withExpirationDate(final String expirationDate) {
try {
return withExpirationDate(Long.parseLong(expirationDate));
} catch (final NumberFormatException exception) {
this.expirationDate = null;
}
return this;
}
/**
* Set the flags parameter.
* @param flags flags.
* @return Builder instance.
*/
public Builder withFlags(final String flags) {
this.flags = Objects.requireNonNull(flags);
return this;
}
/**
* Creates new Uid instance.
* @return Uid instance.
*/
public Uid build() {
return new Uid(uid, creationDate, expirationDate, flags);
}
}
}
java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/rest/ 0000775 0000000 0000000 00000000000 14001511033 0023413 5 ustar 00root root 0000000 0000000 java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/rest/HttpClient5RestClient.java 0000664 0000000 0000000 00000032677 14001511033 0030435 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp.rest;
import org.apache.hc.client5.http.ClientProtocolException;
import org.apache.hc.client5.http.auth.AuthCache;
import org.apache.hc.client5.http.auth.AuthScope;
import org.apache.hc.client5.http.auth.CredentialsStore;
import org.apache.hc.client5.http.auth.UsernamePasswordCredentials;
import org.apache.hc.client5.http.classic.methods.HttpGet;
import org.apache.hc.client5.http.config.RequestConfig;
import org.apache.hc.client5.http.impl.auth.BasicAuthCache;
import org.apache.hc.client5.http.impl.auth.BasicCredentialsProvider;
import org.apache.hc.client5.http.impl.auth.BasicScheme;
import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
import org.apache.hc.client5.http.impl.classic.HttpClientBuilder;
import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManagerBuilder;
import org.apache.hc.client5.http.io.HttpClientConnectionManager;
import org.apache.hc.client5.http.protocol.HttpClientContext;
import org.apache.hc.client5.http.ssl.DefaultHostnameVerifier;
import org.apache.hc.client5.http.ssl.NoopHostnameVerifier;
import org.apache.hc.client5.http.ssl.SSLConnectionSocketFactory;
import org.apache.hc.client5.http.ssl.SSLConnectionSocketFactoryBuilder;
import org.apache.hc.core5.http.ClassicHttpRequest;
import org.apache.hc.core5.http.HttpHost;
import org.apache.hc.core5.http.io.HttpClientResponseHandler;
import org.apache.hc.core5.http.ssl.TLS;
import org.apache.hc.core5.net.URIBuilder;
import org.apache.hc.core5.ssl.SSLContexts;
import org.apache.hc.core5.util.Timeout;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sourcelab.hkp.ConnectionFailedException;
import org.sourcelab.hkp.config.Configuration;
import org.sourcelab.hkp.request.Request;
import org.sourcelab.hkp.rest.handlers.RestResponseHandler;
import javax.net.ssl.HostnameVerifier;
import javax.net.ssl.KeyManager;
import javax.net.ssl.SSLContext;
import javax.net.ssl.SSLHandshakeException;
import javax.net.ssl.TrustManager;
import javax.net.ssl.TrustManagerFactory;
import java.io.IOException;
import java.net.SocketException;
import java.net.URISyntaxException;
import java.nio.charset.StandardCharsets;
import java.security.KeyManagementException;
import java.security.KeyStore;
import java.security.KeyStoreException;
import java.security.NoSuchAlgorithmException;
import java.security.SecureRandom;
import java.util.Map;
/**
* RestClient implementation using HTTPClient.
*/
public class HttpClient5RestClient implements RestClient {
private static final Logger logger = LoggerFactory.getLogger(HttpClient5RestClient.class);
/**
* Save a copy of the configuration.
*/
private Configuration configuration;
/**
* Our underlying Http Client.
*/
private CloseableHttpClient httpClient;
private HttpClientContext httpClientContext;
/**
* Constructor.
*/
public HttpClient5RestClient() {
}
/**
* Initialization method. This takes in the configuration and sets up the underlying
* http client appropriately.
* @param configuration The user defined configuration.
*/
@Override
public void init(final Configuration configuration) {
// Save reference to configuration
this.configuration = configuration;
// Create default SSLContext
final SSLContext sslcontext = SSLContexts.createDefault();
// Initialize ssl context with configured key and trust managers.
try {
sslcontext.init(new KeyManager[0], getTrustManagers(), new SecureRandom());
} catch (final KeyManagementException exception) {
throw new RuntimeException(exception.getMessage(), exception);
}
// Create hostname verifier instance.
final HostnameVerifier hostnameVerifier;
// Emit an warning letting everyone know we're using an insecure configuration.
if (configuration.isIgnoreInvalidSslCertificates()) {
logger.warn("Using insecure configuration, skipping server-side certificate validation checks.");
// If we're configured to ignore invalid certificates, use the Noop verifier.
hostnameVerifier = NoopHostnameVerifier.INSTANCE;
} else {
// Use default implementation
hostnameVerifier = new DefaultHostnameVerifier();
}
// Allow TLSv1_1 and TLSv1_2 protocols
final SSLConnectionSocketFactory sslsf = SSLConnectionSocketFactoryBuilder.create()
.setSslContext(sslcontext)
.setTlsVersions(TLS.V_1_1, TLS.V_1_2)
.setHostnameVerifier(hostnameVerifier)
.build();
final HttpClientConnectionManager cm = PoolingHttpClientConnectionManagerBuilder.create()
.setSSLSocketFactory(sslsf)
.build();
// Setup client builder
final HttpClientBuilder clientBuilder = HttpClientBuilder.create()
.setConnectionManager(cm);
// Define our RequestConfigBuilder
final RequestConfig.Builder requestConfigBuilder = RequestConfig.custom();
// Define our context
httpClientContext = HttpClientContext.create();
// Define our auth cache
final AuthCache authCache = new BasicAuthCache();
// If we have a configured proxy host
if (configuration.hasProxyConfigured()) {
// Define proxy host
final HttpHost proxyHost = new HttpHost(
configuration.getProxyConfiguration().getScheme(),
configuration.getProxyConfiguration().getHost(),
configuration.getProxyConfiguration().getPort()
);
// If we have proxy auth enabled
if (configuration.getProxyConfiguration().isAuthenticationRequired()) {
// Create credential provider
final CredentialsStore credsProvider = new BasicCredentialsProvider();
credsProvider.setCredentials(
new AuthScope(
configuration.getProxyConfiguration().getHost(),
configuration.getProxyConfiguration().getPort()
),
new UsernamePasswordCredentials(
configuration.getProxyConfiguration().getUsername(),
configuration.getProxyConfiguration().getPassword().toCharArray()
)
);
// Preemptive load context with authentication.
authCache.put(
new HttpHost(
configuration.getProxyConfiguration().getScheme(),
configuration.getProxyConfiguration().getHost(),
configuration.getProxyConfiguration().getPort()
),
new BasicScheme()
);
// Attach Credentials provider to client builder.
clientBuilder.setDefaultCredentialsProvider(credsProvider);
httpClientContext.setCredentialsProvider(credsProvider);
}
// Attach Proxy to request config builder
requestConfigBuilder
.setConnectionRequestTimeout(Timeout.ofSeconds(configuration.getRequestTimeoutSecs()))
.setConnectTimeout(Timeout.ofSeconds(configuration.getRequestTimeoutSecs()))
.setProxy(proxyHost);
// Configure context.
httpClientContext.setAuthCache(authCache);
}
// Attach default request config
clientBuilder.setDefaultRequestConfig(requestConfigBuilder.build());
// build http client
httpClient = clientBuilder.build();
}
/**
* Based on Client Configuration, construct TrustManager instances to use.
* @return Array of 0 or more TrustManager instances.
*/
private TrustManager[] getTrustManagers() {
try {
final TrustManagerFactory trustManagerFactory = TrustManagerFactory.getInstance(TrustManagerFactory.getDefaultAlgorithm());
// If client configuration is set to ignore invalid certificates
if (configuration.isIgnoreInvalidSslCertificates()) {
// Initialize ssl context with a TrustManager instance that just accepts everything blindly.
// HIGHLY INSECURE / NOT RECOMMENDED!
return new TrustManager[]{ new NoopTrustManager() };
// If client configuration has a trust store defined.
} else {
// use default TrustManager instances
trustManagerFactory.init((KeyStore) null);
return trustManagerFactory.getTrustManagers();
}
} catch (final KeyStoreException | NoSuchAlgorithmException exception) {
throw new RuntimeException(exception.getMessage(), exception);
}
}
@Override
public void close() {
if (httpClient != null) {
try {
httpClient.close();
} catch (final IOException exception) {
logger.error("Error closing: {}", exception.getMessage(), exception);
}
}
httpClient = null;
}
/**
* Make a request against the Server.
* @param request The request to submit.
* @return The response, in UTF-8 String format.
* @throws RestException if something goes wrong.
*/
@Override
public RestResponse submitRequest(final Request request) throws RestException {
try {
return submitRequest(request, new RestResponseHandler());
} catch (final IOException exception) {
throw new RestException(exception.getMessage(), exception);
}
}
/**
* For issuing an API Request.
* @param request The Request to perform.
* @param responseHandler How to parse the response.
* @param The return type.
* @return The parsed API response.
*/
private T submitRequest(final Request request, final HttpClientResponseHandler responseHandler) throws IOException {
final String url = constructApiUrl(request);
return submitRequest(url, request.getRequestParameters(), responseHandler);
}
/**
* Internal POST method.
* @param url Url to request.
* @param getParams GET parameters to include in the request
* @param responseHandler The response Handler to use to parse the response
* @param The type that ResponseHandler returns.
* @return Parsed response.
* @throws ConnectionFailedException if remote server does not accept connection.
*/
private T submitRequest(final String url, final Map getParams, final HttpClientResponseHandler responseHandler) {
try {
// Construct URI including our request parameters.
final URIBuilder uriBuilder = new URIBuilder(url)
.setCharset(StandardCharsets.UTF_8);
// Attach submitRequest params
for (final Map.Entry entry : getParams.entrySet()) {
uriBuilder.setParameter(entry.getKey(), entry.getValue());
}
// Build Get Request
final ClassicHttpRequest get = new HttpGet(uriBuilder.build());
// Debug logging
logger.info("Executing request {}", get.getRequestUri());
// Execute and return
return httpClient.execute(get, httpClientContext, responseHandler);
} catch (final ClientProtocolException | SocketException | URISyntaxException | SSLHandshakeException connectionException) {
// Signals that an error occurred while attempting to connect a
// socket to a remote address and port. Typically, the connection
// was refused remotely (e.g., no process is listening on the
// remote address/port).
throw new ConnectionFailedException(connectionException.getMessage(), connectionException);
} catch (final IOException exception) {
// Typically this is a parse error.
logger.error("Caught IOException: {}", exception.getMessage(), exception);
}
return null;
}
/**
* Internal helper method for generating URLs w/ the appropriate API host and API version.
* @param request Request we want to execute.
* @return Constructed URL for the end point.
*/
private String constructApiUrl(final Request request) {
return configuration.getKeyServerHost() + configuration.getBasePath();
}
}
java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/rest/NoopTrustManager.java 0000664 0000000 0000000 00000003372 14001511033 0027533 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp.rest;
import javax.net.ssl.X509TrustManager;
import java.security.cert.X509Certificate;
/**
* Implementation of TrustManager that blindly trusts all certificates with no validation or verification.
*/
class NoopTrustManager implements X509TrustManager {
@Override
public void checkClientTrusted(final X509Certificate[] x509Certificates, final String input) {
}
@Override
public void checkServerTrusted(final X509Certificate[] x509Certificates, final String input) {
}
@Override
public X509Certificate[] getAcceptedIssuers() {
return new X509Certificate[0];
}
}
java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/rest/RestClient.java 0000664 0000000 0000000 00000003673 14001511033 0026343 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp.rest;
import org.sourcelab.hkp.config.Configuration;
import org.sourcelab.hkp.request.Request;
/**
* Interface for making HTTP calls.
*/
public interface RestClient {
/**
* Initializes the RestClient implementation.
* Any setup or resource allocation should happen here.
* @param configuration Configuration.
*/
void init(final Configuration configuration);
/**
* Make a request against the server.
* @param request The request to submit.
* @return The response, in UTF-8 String format.
* @throws RestException When something goes wrong in an underlying implementation.
*/
RestResponse submitRequest(final Request request) throws RestException;
/**
* Called to release any internally held resources.
*/
void close();
}
java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/rest/RestException.java 0000664 0000000 0000000 00000002750 14001511033 0027056 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp.rest;
/**
* Exception when an underlying error occurs in a RestClient implementation.
*/
public class RestException extends RuntimeException {
public RestException(final String message) {
super(message);
}
public RestException(final String message, final Throwable cause) {
super(message, cause);
}
}
java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/rest/RestResponse.java 0000664 0000000 0000000 00000003672 14001511033 0026722 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp.rest;
/**
* Represents the response from the API.
*/
public class RestResponse {
private final String responseStr;
private final int httpCode;
/**
* Constructor.
* @param responseStr The http response body, in string format.
* @param httpCode The http status code from the response.
*/
public RestResponse(final String responseStr, final int httpCode) {
this.responseStr = responseStr;
this.httpCode = httpCode;
}
public String getResponseStr() {
return responseStr;
}
public int getHttpCode() {
return httpCode;
}
@Override
public String toString() {
return "RestResponse{"
+ "responseStr='" + responseStr + '\''
+ ", httpCode=" + httpCode
+ '}';
}
}
java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/rest/handlers/ 0000775 0000000 0000000 00000000000 14001511033 0025213 5 ustar 00root root 0000000 0000000 java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/rest/handlers/RestResponseHandler.java 0000664 0000000 0000000 00000005006 14001511033 0032011 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp.rest.handlers;
import org.apache.hc.core5.http.ClassicHttpResponse;
import org.apache.hc.core5.http.HttpEntity;
import org.apache.hc.core5.http.ParseException;
import org.apache.hc.core5.http.io.HttpClientResponseHandler;
import org.apache.hc.core5.http.io.entity.EntityUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sourcelab.hkp.rest.RestResponse;
import java.io.IOException;
/**
* Handles parsing a response to RestResponse object.
*/
public class RestResponseHandler implements HttpClientResponseHandler {
private static final Logger logger = LoggerFactory.getLogger(RestResponseHandler.class);
@Override
public RestResponse handleResponse(final ClassicHttpResponse response) {
final int statusCode = response.getCode();
try {
final HttpEntity entity = response.getEntity();
final String responseStr = entity != null ? EntityUtils.toString(entity) : null;
// Fully consume entity.
EntityUtils.consume(entity);
// Construct return object
return new RestResponse(responseStr, statusCode);
} catch (final IOException | ParseException exception) {
logger.error("Failed to read entity: {}", exception.getMessage(), exception);
throw new RuntimeException("Failed to read entity", exception);
}
}
}
java-hkp-client-0.2.0/src/main/java/org/sourcelab/hkp/rest/handlers/StringResponseHandler.java 0000664 0000000 0000000 00000004611 14001511033 0032343 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp.rest.handlers;
import org.apache.hc.core5.http.ClassicHttpResponse;
import org.apache.hc.core5.http.HttpEntity;
import org.apache.hc.core5.http.ParseException;
import org.apache.hc.core5.http.io.HttpClientResponseHandler;
import org.apache.hc.core5.http.io.entity.EntityUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.IOException;
/**
* Returns response as a string.
*/
public class StringResponseHandler implements HttpClientResponseHandler {
private static final Logger logger = LoggerFactory.getLogger(StringResponseHandler.class);
@Override
public String handleResponse(final ClassicHttpResponse response) throws IOException {
try {
final HttpEntity entity = response.getEntity();
final String responseStr;
responseStr = entity != null ? EntityUtils.toString(entity) : null;
// Fully consume entity.
EntityUtils.consume(entity);
// Construct return object
return responseStr;
} catch (final ParseException exception) {
logger.error("Failed to read entity: {}", exception.getMessage(), exception);
throw new RuntimeException("Failed to read entity", exception);
}
}
}
java-hkp-client-0.2.0/src/test/ 0000775 0000000 0000000 00000000000 14001511033 0016220 5 ustar 00root root 0000000 0000000 java-hkp-client-0.2.0/src/test/java/ 0000775 0000000 0000000 00000000000 14001511033 0017141 5 ustar 00root root 0000000 0000000 java-hkp-client-0.2.0/src/test/java/org/ 0000775 0000000 0000000 00000000000 14001511033 0017730 5 ustar 00root root 0000000 0000000 java-hkp-client-0.2.0/src/test/java/org/sourcelab/ 0000775 0000000 0000000 00000000000 14001511033 0021707 5 ustar 00root root 0000000 0000000 java-hkp-client-0.2.0/src/test/java/org/sourcelab/hkp/ 0000775 0000000 0000000 00000000000 14001511033 0022471 5 ustar 00root root 0000000 0000000 java-hkp-client-0.2.0/src/test/java/org/sourcelab/hkp/HkpClientTest.java 0000664 0000000 0000000 00000010162 14001511033 0026055 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Tag;
import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.sourcelab.hkp.config.Configuration;
import org.sourcelab.hkp.request.GetRequest;
import org.sourcelab.hkp.request.SearchRequest;
import org.sourcelab.hkp.response.get.PgpPublicKey;
import org.sourcelab.hkp.response.search.SearchIndexResponse;
import java.util.Optional;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertTrue;
@Tag("IntegrationTest")
class HkpClientTest {
private static final Logger logger = LoggerFactory.getLogger(HkpClientTest.class);
/**
* Instance under test.
*/
private static HkpClient client;
@BeforeAll
static void setup() {
client = new HkpClient(Configuration.newBuilder()
//.withKeyServerHost("http://pool.sks-keyservers.net")
.withKeyServerHost("https://hkps.pool.sks-keyservers.net")
.withIgnoreInvalidSslCertificates()
);
}
@AfterAll
static void cleanup() {
client.close();
}
@Test
void test() {
final SearchIndexResponse result = client.search(new SearchRequest("stephen.powis@gmail.com"));
logger.info("Result: {}", result);
assertNotNull(result);
assertEquals(3, result.getCount());
assertEquals(1, result.getVersion());
assertEquals(3, result.getEntries().size());
}
@Test
void searchByKey() {
final SearchIndexResponse result = client.search(new SearchRequest("0x92E73960FC59970DFB12F0146D712A2D27F74CE9"));
logger.info("Result: {}", result);
}
@Test
void getByKey() {
final Optional result = client.get(new GetRequest("0x92E73960FC59970DFB12F0146D712A2D27F74CE9"));
logger.info("Result: {}", result.get());
assertTrue(result.isPresent());
final PgpPublicKey key = result.get();
assertNotNull(key.getPublicKey());
}
@Test
void getByEmail() {
final Optional result = client.get(new GetRequest("stephen.powis@gmail.com"));
logger.info("Result: {}", result.get());
assertTrue(result.isPresent());
}
@Test
void getByKey_invalidKey_500Error() {
try {
client.get(new GetRequest("0xZEROC00l"));
} catch (final InvalidRequestException exception) {
logger.info("Result: {}", exception);
assertEquals(500, exception.getErrorCode());
assertNotNull(exception.getMessage());
}
}
@Test
void getByKey_invalidKey_404Error() {
final Optional result = client.get(new GetRequest("0x92E73960FC59970DFB12F0146D712A2D27F74CE4"));
assertFalse(result.isPresent());
}
} java-hkp-client-0.2.0/src/test/java/org/sourcelab/hkp/parser/ 0000775 0000000 0000000 00000000000 14001511033 0023765 5 ustar 00root root 0000000 0000000 java-hkp-client-0.2.0/src/test/java/org/sourcelab/hkp/parser/AbstractParserTest.java 0000664 0000000 0000000 00000004254 14001511033 0030415 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp.parser;
import org.junit.jupiter.api.Test;
import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Paths;
/**
* Abstract / Base Request Test Class.
*/
abstract public class AbstractParserTest {
/**
* Test Parsing response.
*/
@Test
public abstract void testParseResponse() throws Exception;
/**
* Utility method to help load mock responses from resources.
* @param fileName file name to load from resources
* @return The contents of the file, as a UTF-8 string.
* @throws IOException on error reading from resource file.
*/
protected String readFile(final String fileName) throws IOException, URISyntaxException {
final URI inputFile = getClass()
.getClassLoader()
.getResource("mockResponses/" + fileName)
.toURI();
return new String(Files.readAllBytes(Paths.get(inputFile)), StandardCharsets.UTF_8);
}
}
java-hkp-client-0.2.0/src/test/java/org/sourcelab/hkp/parser/FieldParserTest.java 0000664 0000000 0000000 00000006126 14001511033 0027675 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp.parser;
import org.junit.jupiter.api.Test;
import java.io.IOException;
import java.util.List;
import static org.junit.jupiter.api.Assertions.assertEquals;
class FieldParserTest {
@Test
void test_simple() throws IOException {
final String input = "pub:keyid:algo:keylen:creationdate:expirationdate:flags";
final List fields = FieldParser.parseLine(input);
// Verify
assertEquals(7, fields.size(), "invalid length");
assertEquals("pub", fields.get(0));
assertEquals("keyid", fields.get(1));
assertEquals("algo", fields.get(2));
assertEquals("keylen", fields.get(3));
assertEquals("creationdate", fields.get(4));
assertEquals("expirationdate", fields.get(5));
assertEquals("flags", fields.get(6));
}
@Test
void test_withBlanksInMiddle() throws IOException {
final String input = "pub:keyid:algo:keylen:::";
final List fields = FieldParser.parseLine(input);
// Verify
assertEquals(7, fields.size(), "invalid length");
assertEquals("pub", fields.get(0));
assertEquals("keyid", fields.get(1));
assertEquals("algo", fields.get(2));
assertEquals("keylen", fields.get(3));
assertEquals("", fields.get(4));
assertEquals("", fields.get(5));
assertEquals("", fields.get(6));
}
@Test
void test_withBlanksAtEnd() throws IOException {
final String input = "pub:keyid::::expirationdate:flags";
final List fields = FieldParser.parseLine(input);
// Verify
assertEquals(7, fields.size(), "invalid length");
assertEquals("pub", fields.get(0));
assertEquals("keyid", fields.get(1));
assertEquals("", fields.get(2));
assertEquals("", fields.get(3));
assertEquals("", fields.get(4));
assertEquals("expirationdate", fields.get(5));
assertEquals("flags", fields.get(6));
}
} java-hkp-client-0.2.0/src/test/java/org/sourcelab/hkp/parser/SearchIndexResponseParserTest.java 0000664 0000000 0000000 00000003627 14001511033 0032571 0 ustar 00root root 0000000 0000000 /**
* Copyright 2021 Stephen Powis https://github.com/sourcelaborg/java-hkp-client
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
* documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
* persons to whom the Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
* WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.sourcelab.hkp.parser;
import org.junit.jupiter.api.Test;
import org.sourcelab.hkp.response.search.SearchIndexResponse;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
class SearchIndexResponseParserTest extends AbstractParserTest {
@Test
@Override
public void testParseResponse() throws Exception {
final SearchIndexResponse result = new SearchIndexResponseParser()
.parseResponse(readFile("searchIndex.txt"));
// validate
assertNotNull(result);
// Validate Header
assertEquals(1, result.getVersion());
assertEquals(3, result.getCount());
// Validate entries
assertEquals(3, result.getEntries().size());
}
} java-hkp-client-0.2.0/src/test/resources/ 0000775 0000000 0000000 00000000000 14001511033 0020232 5 ustar 00root root 0000000 0000000 java-hkp-client-0.2.0/src/test/resources/log4j2.xml 0000664 0000000 0000000 00000000670 14001511033 0022060 0 ustar 00root root 0000000 0000000
java-hkp-client-0.2.0/src/test/resources/mockResponses/ 0000775 0000000 0000000 00000000000 14001511033 0023065 5 ustar 00root root 0000000 0000000 java-hkp-client-0.2.0/src/test/resources/mockResponses/searchIndex.txt 0000664 0000000 0000000 00000000613 14001511033 0026063 0 ustar 00root root 0000000 0000000 info:1:3
pub:92E73960FC59970DFB12F0146D712A2D27F74CE9:1:4096:1515212983:1641443383:
uid:SourceLab.org (SourceLab.org Key) :1515212983::
pub:AADC291B6541ADCA3F702527FD50A4D1D8D54DA6:1:4096:1510193131:1636423531:
uid:Key :1510193131::
pub:BD07DDB80A5FB180185FE1436E9BE863114AC1F2:1:4096:1502550853::
uid:Stevie :1502550853::