feat(sdk)!: better control which classes we expose (#254)

* make `TDF` and `NanoTDF` package private. this entailed:
  * moving exceptions to the SDK
* getting rid of `nano` sub-package so that we don't have to make
everything in it public to access it from the main
namespace
* remove exceptions that should never occur during normal usage and that
a client would be powerless to fix
* add some docs to the exceptions
* update SDK example usage in README
* return `Manifest` from `sdk.createTdf`

Author: mkleene

README.md

@@ -15,33 +15,41 @@ This SDK is available from Maven central as:
 ## Quick Start Example
 
 ```java
+package io.opentdf.platform;
+
 import io.opentdf.platform.sdk.Config;
+import io.opentdf.platform.sdk.Reader;
 import io.opentdf.platform.sdk.SDK;
 import io.opentdf.platform.sdk.SDKBuilder;
-import io.opentdf.platform.sdk.abac.Policy;
+
+import java.io.IOException;
 import java.io.InputStream;
 import java.io.FileInputStream;
+import java.nio.channels.FileChannel;
+import java.nio.channels.SeekableByteChannel;
+import java.nio.file.Path;
+import java.nio.file.StandardOpenOption;
 
 public class Example {
-  public static void main(String[] args) {
-    SDK sdk =
-        new SDKBuilder
-            .clientSecret("myClient", "token")
-            .platformEndpoint("https://your.cluster/")
-            .build();
-    // Encrypt a file
-    try (InputStream in = new FileInputStream("input.plaintext")) {
-      Config c = Config.newTDFConfig(Config.withDataAttributes("attr1", "attr2"));
-      new TDF().createTDF(in, System.out, tdfConfig, sdk.getServices().kas());
-    }
-
-    // Decrypt a file
-    try (SeekableByteChannel in =
-          FileChannel.open("input.ciphertext", StandardOpenOption.READ)) {
-        TDF.Reader reader = new TDF().loadTDF(in, sdk.getServices().kas(), sdk.getServices().kasRegistry(), sdk.getPlatformUrl());
-        reader.readPayload(System.out);
+    public static void main(String[] args) throws IOException {
+        SDK sdk = new SDKBuilder()
+                    .clientSecret("myClient", "token")
+                    .platformEndpoint("https://your.cluster/")
+                    .build();
+
+        // Encrypt a file
+        try (InputStream in = new FileInputStream("input.plaintext")) {
+            Config.TDFConfig c = Config.newTDFConfig(Config.withDataAttributes("attr1", "attr2"));
+            sdk.createTDF(in, System.out, c);
+        }
+
+        // Decrypt a file
+        try (SeekableByteChannel in = FileChannel.open(Path.of("input.ciphertext"), StandardOpenOption.READ)) {
+            Reader reader = sdk.loadTDF(in, Config.newTDFReaderConfig());
+            reader.readPayload(System.out);
+        }
     }
-}}
+}
 ```
 
 ### Cryptography Library
@@ -50,7 +58,7 @@ This SDK uses the [Bouncy Castle Security library](https://www.bouncycastle.org/
 Note: When using this SDK, it may be necessary to register the Bouncy Castle Provider as follows:
 
 ```java
-    static{
+    static {
         Security.addProvider(new BouncyCastleProvider());
     }
 ```

cmdline/src/main/java/io/opentdf/platform/Command.java

@@ -10,7 +10,6 @@
 import io.opentdf.platform.sdk.Config.AssertionVerificationKeys;
 import io.opentdf.platform.sdk.SDK;
 import io.opentdf.platform.sdk.SDKBuilder;
-import io.opentdf.platform.sdk.TDF;
 import nl.altindag.ssl.SSLFactory;
 import org.apache.commons.codec.DecoderException;
 import picocli.CommandLine;
@@ -23,7 +22,6 @@
 import java.io.FileInputStream;
 import java.io.IOException;
 import java.io.PrintWriter;
-import java.net.URISyntaxException;
 import java.nio.ByteBuffer;
 import java.nio.channels.FileChannel;
 import java.nio.charset.StandardCharsets;
@@ -36,7 +34,6 @@
 import java.security.spec.InvalidKeySpecException;
 import java.security.spec.PKCS8EncodedKeySpec;
 import java.security.spec.X509EncodedKeySpec;
-import java.text.ParseException;
 import java.util.ArrayList;
 import java.util.Base64;
 import java.util.List;
@@ -165,7 +162,7 @@ void encrypt(
             @Option(names = { "--with-assertions" }, defaultValue = Option.NULL_VALUE) Optional<String> assertion,
             @Option(names = { "--with-target-mode" }, defaultValue = Option.NULL_VALUE) Optional<String> targetMode)
 
-            throws IOException, JOSEException, AutoConfigureException, InterruptedException, ExecutionException, DecoderException {
+            throws IOException, AutoConfigureException {
 
         var sdk = buildSDK();
         var kasInfos = kas.stream().map(k -> {
@@ -300,8 +297,7 @@ void decrypt(@Option(names = { "-f", "--file" }, required = true) Path tdfPath,
     @CommandLine.Command(name = "metadata")
     void readMetadata(@Option(names = { "-f", "--file" }, required = true) Path tdfPath,
     @Option(names = { "--kas-allowlist" }, defaultValue = Option.NULL_VALUE) Optional<String> kasAllowlistStr,
-            @Option(names = { "--ignore-kas-allowlist" }, defaultValue = Option.NULL_VALUE) Optional<Boolean> ignoreAllowlist) throws IOException,
-            TDF.FailedToCreateGMAC, JOSEException, NoSuchAlgorithmException, ParseException, DecoderException, InterruptedException, ExecutionException, URISyntaxException {
+            @Option(names = { "--ignore-kas-allowlist" }, defaultValue = Option.NULL_VALUE) Optional<Boolean> ignoreAllowlist) throws IOException {
         var sdk = buildSDK();
         var opts = new ArrayList<Consumer<Config.TDFReaderConfig>>();
         try (var in = FileChannel.open(tdfPath, StandardOpenOption.READ)) {

examples/src/main/java/io/opentdf/platform/App.java

@@ -12,7 +12,7 @@
 import java.util.Arrays;
 
 public class CreateAttribute {
-    public static void main(String[] args) throws ExecutionException, InterruptedException{
+    public static void main(String[] args) {
 
         String clientId = "opentdf";
         String clientSecret = "secret";

examples/src/main/java/io/opentdf/platform/CreateAttribute.java

@@ -8,7 +8,7 @@
 import java.util.concurrent.ExecutionException;
 
 public class CreateNamespace {
-    public static void main(String[] args) throws ExecutionException, InterruptedException{
+    public static void main(String[] args) {
 
         String clientId = "opentdf";
         String clientSecret = "secret";

examples/src/main/java/io/opentdf/platform/CreateNamespace.java

@@ -16,7 +16,7 @@
 
 
 public class CreateSubjectConditionSet {
-    public static void main(String[] args) throws ExecutionException, InterruptedException{
+    public static void main(String[] args) {
 
         String clientId = "opentdf";
         String clientSecret = "secret";

examples/src/main/java/io/opentdf/platform/CreateSubjectConditionSet.java

@@ -10,7 +10,7 @@
 import java.util.concurrent.ExecutionException;
 
 public class CreateSubjectMapping {
-    public static void main(String[] args) throws ExecutionException, InterruptedException{
+    public static void main(String[] args) {
 
         String clientId = "opentdf";
         String clientSecret = "secret";

examples/src/main/java/io/opentdf/platform/CreateSubjectMapping.java

@@ -1,22 +1,15 @@
 package io.opentdf.platform;
 
 import io.opentdf.platform.sdk.Config;
-import io.opentdf.platform.sdk.NanoTDF;
 import io.opentdf.platform.sdk.SDK;
 import io.opentdf.platform.sdk.SDKBuilder;
 
-import java.io.ByteArrayInputStream;
 import java.io.FileInputStream;
-import java.io.FileOutputStream;
 import java.io.IOException;
-import java.net.URISyntaxException;
 import java.nio.ByteBuffer;
-import java.nio.charset.StandardCharsets;
-import java.security.NoSuchAlgorithmException;
-import java.util.concurrent.ExecutionException;
 
 public class DecryptCollectionExample {
-    public static void main(String[] args) throws IOException, NanoTDF.NanoTDFMaxSizeLimit, NanoTDF.UnsupportedNanoTDFFeature, NanoTDF.InvalidNanoTDFConfig, NoSuchAlgorithmException, InterruptedException, ExecutionException, URISyntaxException {
+    public static void main(String[] args) throws IOException {
         String clientId = "opentdf-sdk";
         String clientSecret = "secret";
         String platformEndpoint = "localhost:8080";

examples/src/main/java/io/opentdf/platform/DecryptCollectionExample.java

@@ -11,7 +11,6 @@
 import java.security.InvalidAlgorithmParameterException;
 import java.security.InvalidKeyException;
 import java.security.NoSuchAlgorithmException;
-import java.text.ParseException;
 import java.util.concurrent.ExecutionException;
 
 import javax.crypto.BadPaddingException;
@@ -21,10 +20,7 @@
 import org.apache.commons.codec.DecoderException;
 
 public class DecryptExample {
-    public static void main(String[] args) throws IOException,
-            InvalidAlgorithmParameterException, NoSuchPaddingException, IllegalBlockSizeException,
-            BadPaddingException, InvalidKeyException, TDF.FailedToCreateGMAC,
-            JOSEException, ParseException, NoSuchAlgorithmException, DecoderException, org.apache.commons.cli.ParseException, InterruptedException, ExecutionException, URISyntaxException {
+    public static void main(String[] args) throws IOException, ParseException {
 
         // Create Options object
         Options options = new Options();

examples/src/main/java/io/opentdf/platform/DecryptExample.java

@@ -1,20 +1,16 @@
 package io.opentdf.platform;
 
 import io.opentdf.platform.sdk.Config;
-import io.opentdf.platform.sdk.NanoTDF;
 import io.opentdf.platform.sdk.SDK;
 import io.opentdf.platform.sdk.SDKBuilder;
 
-import java.io.ByteArrayInputStream;
-import java.io.FileNotFoundException;
 import java.io.FileOutputStream;
 import java.io.IOException;
 import java.nio.ByteBuffer;
 import java.nio.charset.StandardCharsets;
-import java.security.NoSuchAlgorithmException;
 
 public class EncryptCollectionExample {
-    public static void main(String[] args) throws IOException, NanoTDF.NanoTDFMaxSizeLimit, NanoTDF.UnsupportedNanoTDFFeature, NanoTDF.InvalidNanoTDFConfig, NoSuchAlgorithmException, InterruptedException {
+    public static void main(String[] args) throws IOException {
         String clientId = "opentdf-sdk";
         String clientSecret = "secret";
         String platformEndpoint = "localhost:8080";