Core Refactor 1

Author: scottf

.github/workflows/core-main.yml

@@ -12,7 +12,7 @@ jobs:
   build:
     strategy:
       matrix:
-        tc: [ 8, 17, 21, 25 ]
+        tc: [ 17, 21, 25 ]
     runs-on: ubuntu-latest
     defaults:
       run:
@@ -62,4 +62,4 @@ jobs:
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           parallel-finished: true
-          carryforward: "tc8"
+          carryforward: "tc17"

.github/workflows/core-pr.yml

@@ -11,7 +11,7 @@ jobs:
   build:
     strategy:
       matrix:
-        tc: [ 8, 17, 21, 25 ]
+        tc: [ 17, 21, 25 ]
     runs-on: ubuntu-latest
     defaults:
       run:
@@ -54,4 +54,4 @@ jobs:
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           parallel-finished: true
-          carryforward: "tc8"
+          carryforward: "tc17"

.github/workflows/core-release.yml

@@ -9,7 +9,7 @@ jobs:
   build:
     strategy:
       matrix:
-        tc: [ 8, 17, 21, 25 ]
+        tc: [ 17, 21, 25 ]
     runs-on: ubuntu-latest
     defaults:
       run:

core/build.gradle

@@ -15,10 +15,10 @@ group = 'io.nats.nkeys'
 
 def isRelease = System.getenv("BUILD_EVENT") == "release"
 def tc = System.getenv("TARGET_COMPATIBILITY")
-def targetJavaVersion = tc == null ? JavaVersion.VERSION_1_8 : JavaVersion.toVersion(tc)
+def targetJavaVersion = tc == null ? JavaVersion.VERSION_17 : JavaVersion.toVersion(tc)
 def targetId = targetJavaVersion.toString()
-def artifact = "core" + (targetJavaVersion == JavaVersion.VERSION_1_8 ? "" : "-jdk" + targetId)
-def bundleName = "io.nats.nkeys.core" + (targetJavaVersion == JavaVersion.VERSION_1_8 ? "" : ".jdk" + targetId)
+def artifact = "core-jdk" + targetId
+def bundleName = "io.nats.nkeys.core.jdk" + targetId
 
 System.out.println("target compatibility: Java " + targetJavaVersion)
 System.out.println("artifact id         : " + artifact)
@@ -27,7 +27,7 @@ System.out.println("bundle name         : " + bundleName)
 version = isRelease ? jarVersion : jarVersion + "-SNAPSHOT" // version is the variable the gradle uses.
 
 java {
-    sourceCompatibility = JavaVersion.VERSION_1_8
+    sourceCompatibility = JavaVersion.VERSION_17
     targetCompatibility = targetJavaVersion
     withSourcesJar()
     withJavadocJar()

core/src/main/java/io/nats/nkey/NKey.java

@@ -19,6 +19,9 @@
 import static io.nats.nkey.NKeyConstants.ED25519_SEED_SIZE;
 import static io.nats.nkey.NKeyInternalUtils.*;
 
+/**
+ * The NKey class
+ */
 public class NKey {
 
     private final NKeyProvider provider;
@@ -35,9 +38,16 @@ public class NKey {
 
     private final NKeyType type;
 
-    public NKey(NKeyProvider provider, NKeyType t, char[] publicKey, char[] privateKey) {
+    /**
+     * Construct an NKey
+     * @param provider the NKeyProvider
+     * @param type the NKeyType
+     * @param publicKey the public key characters
+     * @param privateKey the private key characters
+     */
+    public NKey(NKeyProvider provider, NKeyType type, char[] publicKey, char[] privateKey) {
         this.provider = provider;
-        this.type = t;
+        this.type = type;
         this.privateKeyAsSeed = privateKey;
         this.publicKey = publicKey;
     }
@@ -63,7 +73,8 @@ public void clear() {
     }
 
     /**
-     * @return the string encoded seed for this NKey
+     * Get the string encoded seed for this NKey
+     * @return the seed characters
      */
     public char[] getSeed() {
         NKeyDecodedSeed decoded = getDecodedSeed();
@@ -76,27 +87,46 @@ public char[] getSeed() {
         }
     }
 
-    private void ensurePair() {
+    /**
+     * Ensures that the NKey is a pair, not public only
+     * @throws IllegalStateException if the NKey is a public only key
+     */
+    public void ensurePair() {
         if (isPublicOnly()) {
             throw new IllegalStateException("Public-only NKey");
         }
     }
 
+    /**
+     * Get the decoded seed
+     * @return the decoded seed
+     * @throws IllegalStateException if the NKey is a public only key
+     */
     public NKeyDecodedSeed getDecodedSeed() {
         ensurePair();
         return decodeSeed(privateKeyAsSeed);
     }
 
+    /**
+     * Does this NKey represent both the public and private key
+     * @return true if is a pair
+     */
     public boolean isPair() {
         return privateKeyAsSeed != null;
     }
 
+    /**
+     * Does this NKey represent only the public key half,
+     * meaning does not have the private key half
+     * @return true if is public only
+     */
     public boolean isPublicOnly() {
         return privateKeyAsSeed == null;
     }
 
     /**
-     * @return the encoded public key for this NKey
+     * Get the encoded public key for this NKey
+     * @return the encoded characters
      */
     public char[] getPublicKey() {
         if (publicKey != null) {
@@ -106,23 +136,26 @@ public char[] getPublicKey() {
     }
 
     /**
-     * @return the encoded private key for this NKey
+     * Get the encoded private key for this NKey
+     * @return the encoded characters
      */
     public char[] getPrivateKey() {
         NKeyDecodedSeed decoded = getDecodedSeed();
         return encode(NKeyType.PRIVATE, decoded.bytes);
     }
 
     /**
-     * @return A Java security keypair that represents this NKey in Java security form.
+     * Get the Java security keypair that represents this NKey in Java security form.
+     * @return the KeyPair
      */
     public KeyPair getKeyPair() {
         ensurePair();
         return provider.getKeyPair(this);
     }
 
     /**
-     * @return the Type of this NKey
+     * Get the NKeyType of this NKey
+     * @return the NKeyType
      */
     public NKeyType getType() {
         return type;

core/src/main/java/io/nats/nkey/NKeyConstants.java

@@ -13,36 +13,73 @@
 
 package io.nats.nkey;
 
+/**
+ * Constants use in the NKey project
+ */
 public interface NKeyConstants {
+    /**
+     * name of system property used for NKeyProvider class
+     */
     String NKEY_PROVIDER_CLASS_SYSTEM_PROPERTY = "nkey.provider.class";
+
+    /**
+     * name of environment variable used for NKeyProvider class
+     */
     String NKEY_PROVIDER_CLASS_ENVIRONMENT_VAR = "NKEY_PROVIDER_CLASS";
 
-    // PrefixByteSeed is the prefix byte used for encoded NATS Seeds
+    /**
+     * PREFIX_BYTE_SEED is the prefix byte used for encoded NATS Seeds
+     */
     int PREFIX_BYTE_SEED = 18 << 3; // Base32-encodes to 'S...'
 
-    // PrefixBytePrivate is the prefix byte used for encoded NATS Private keys
+    /**
+     * PREFIX_BYTE_PRIVATE is the prefix byte used for encoded NATS Private keys
+     */
     int PREFIX_BYTE_PRIVATE = 15 << 3; // Base32-encodes to 'P...'
 
-    // PrefixByteServer is the prefix byte used for encoded NATS Servers
+    /**
+     * PREFIX_BYTE_SERVER is the prefix byte used for encoded NATS Servers
+     */
     int PREFIX_BYTE_SERVER = 13 << 3; // Base32-encodes to 'N...'
 
-    // PrefixByteCluster is the prefix byte used for encoded NATS Clusters
+    /**
+     * PREFIX_BYTE_CLUSTER is the prefix byte used for encoded NATS Clusters
+     */
     int PREFIX_BYTE_CLUSTER = 2 << 3; // Base32-encodes to 'C...'
 
-    // PrefixByteAccount is the prefix byte used for encoded NATS Accounts
+    /**
+     * PREFIX_BYTE_ACCOUNT is the prefix byte used for encoded NATS Accounts
+     */
     int PREFIX_BYTE_ACCOUNT = 0; // Base32-encodes to 'A...'
 
-    // PrefixByteUser is the prefix byte used for encoded NATS Users
+    /**
+     * PREFIX_BYTE_USER is the prefix byte used for encoded NATS Users
+     */
     int PREFIX_BYTE_USER = 20 << 3; // Base32-encodes to 'U...'
 
-    // PrefixByteOperator is the prefix byte used for encoded NATS Operators
+    /**
+     * PREFIX_BYTE_OPERATOR is the prefix byte used for encoded NATS Operators
+     */
     int PREFIX_BYTE_OPERATOR = 14 << 3; // Base32-encodes to 'O...'
 
+    /**
+     * Number of bytes in the public key
+     */
     int ED25519_PUBLIC_KEYSIZE = 32;
+
+    /**
+     * Number of bytes in the private key
+     */
     int ED25519_PRIVATE_KEYSIZE = 64;
+
+    /**
+     * Number of bytes in the seed
+     */
     int ED25519_SEED_SIZE = 32;
 
-    // XModem CRC based on the go version of NKeys
+    /**
+     * XModem CRC based on the go version of NKeys
+     */
     int[] CRC_16_TABLE = { 0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50a5, 0x60c6, 0x70e7, 0x8108,
         0x9129, 0xa14a, 0xb16b, 0xc18c, 0xd1ad, 0xe1ce, 0xf1ef, 0x1231, 0x0210, 0x3273, 0x2252, 0x52b5, 0x4294,
         0x72f7, 0x62d6, 0x9339, 0x8318, 0xb37b, 0xa35a, 0xd3bd, 0xc39c, 0xf3ff, 0xe3de, 0x2462, 0x3443, 0x0420,

core/src/main/java/io/nats/nkey/NKeyDecodedSeed.java

@@ -13,10 +13,26 @@
 
 package io.nats.nkey;
 
+/**
+ * A decoded version of the NKey seed
+ * Used for internal and NKeyProvider implementations, not really intended to be public
+ */
 public class NKeyDecodedSeed {
+    /**
+     * The prefix
+     */
     public final int prefix;
+
+    /**
+     * The bytes
+     */
     public final byte[] bytes;
 
+    /**
+     * Construct an NKeyDecodedSeed
+     * @param prefix the prefix
+     * @param bytes the bytes
+     */
     public NKeyDecodedSeed(int prefix, byte[] bytes) {
         this.prefix = prefix;
         this.bytes = bytes;

core/src/main/java/io/nats/nkey/NKeyInternalUtils.java

@@ -23,7 +23,7 @@
 
 import static io.nats.nkey.NKeyConstants.*;
 
-public abstract class NKeyInternalUtils {
+abstract class NKeyInternalUtils {
     private NKeyInternalUtils() {} /* ensures cannot be constructed */
 
     private static final String BASE32_CHARS = "ABCDEFGHIJKLMNOPQRSTUVWXYZ234567";