-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
0533b68
commit 7877127
Showing
2 changed files
with
21 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,37 @@ | ||
# java-sdk | ||
|
||
OpenTDF Java SDK | ||
This repository provides the OpenTDF Java SDK. | ||
It will be available from maven central as: | ||
|
||
### SDK Usage | ||
The SDK uses the [Bouncy Castle Security library](https://www.bouncycastle.org/). SDK users may need to register the Bouncy Castle Provider; e.g.: | ||
```xml | ||
<dependency> | ||
<groupId>io.opentdf/platform</groupId> | ||
<artifactId>sdk</artifactId> | ||
</dependency> | ||
``` | ||
|
||
|
||
|
||
## SDK Usage | ||
|
||
### Cryptography Library | ||
|
||
The SDK uses the [Bouncy Castle Security library](https://www.bouncycastle.org/). SDK users may need to register the Bouncy Castle Provider; e.g.: | ||
|
||
```java | ||
static{ | ||
Security.addProvider(new BouncyCastleProvider()); | ||
} | ||
``` | ||
|
||
### Logging | ||
|
||
We use [slf4j](https://www.slf4j.org/), without providing a backend. We use log4j2 in our tests. | ||
|
||
### SSL - Untrusted Certificates | ||
|
||
Use the SDKBuilder.withSSL... methods to build an SDKBuilder with: | ||
|
||
- An SSLFactory: ```sdkBuilder.sslFactory(mySSLFactory)``` | ||
- Directory containing trusted certificates: ```sdkBuilder.sslFactoryFromDirectory(myDirectoryWithCerts)``` | ||
- Java Keystore: ```sdkBuilder.sslFactoryFromKeyStore(keystorepath, keystorePassword)``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,7 +2,7 @@ | |
|
||
OpenTDF Java SDK | ||
|
||
## Sketch for API | ||
## Usage: | ||
|
||
maybe this is too fluent? | ||
|
||
|