Moved Jwts.* and Jwks.* Request builder static factory methods to their respective interfaces for more idiomatic lookup with Java 8+ interface static methods.

Author: lhazlewood

api/src/main/java/io/jsonwebtoken/Jwts.java

@@ -20,27 +20,16 @@
 import io.jsonwebtoken.lang.Classes;
 import io.jsonwebtoken.lang.Registry;
 import io.jsonwebtoken.security.AeadAlgorithm;
-import io.jsonwebtoken.security.AeadRequest;
-import io.jsonwebtoken.security.AeadResult;
-import io.jsonwebtoken.security.DecryptAeadRequest;
-import io.jsonwebtoken.security.DecryptionKeyRequest;
 import io.jsonwebtoken.security.KeyAlgorithm;
 import io.jsonwebtoken.security.KeyPairBuilderSupplier;
-import io.jsonwebtoken.security.KeyRequest;
 import io.jsonwebtoken.security.MacAlgorithm;
 import io.jsonwebtoken.security.Password;
-import io.jsonwebtoken.security.Request;
 import io.jsonwebtoken.security.SecretKeyAlgorithm;
 import io.jsonwebtoken.security.SecureDigestAlgorithm;
-import io.jsonwebtoken.security.SecureRequest;
 import io.jsonwebtoken.security.SignatureAlgorithm;
-import io.jsonwebtoken.security.VerifyDigestRequest;
-import io.jsonwebtoken.security.VerifySecureDigestRequest;
 import io.jsonwebtoken.security.X509Builder;
 
 import javax.crypto.SecretKey;
-import java.io.InputStream;
-import java.io.OutputStream;
 import java.security.Key;
 import java.security.PrivateKey;
 import java.security.PublicKey;
@@ -93,18 +82,6 @@ public static final class ENC {
         private static final String IMPL_CLASSNAME = "io.jsonwebtoken.impl.security.StandardEncryptionAlgorithms";
         private static final Registry<String, AeadAlgorithm> REGISTRY = Classes.newInstance(IMPL_CLASSNAME);
 
-        // @since 0.13.0
-        private static final Supplier<AeadRequest.Builder> REQUEST_BUILDER_SUPPLIER =
-                Classes.newInstance("io.jsonwebtoken.impl.security.DefaultAeadRequest$Builder$Supplier");
-
-        // @since 0.13.0
-        private static final Supplier<DecryptAeadRequest.Builder> DECRYPT_REQUEST_BUILDER_SUPPLIER =
-                Classes.newInstance("io.jsonwebtoken.impl.security.DefaultDecryptAeadRequest$Builder$Supplier");
-
-        // @since 0.13.0
-        private static final Supplier<AeadResult.Builder> RESULT_BUILDER_SUPPLIER =
-                Classes.newInstance("io.jsonwebtoken.impl.security.DefaultAeadResult$Builder$Supplier");
-
         /**
          * Returns all standard JWA <a href="https://www.rfc-editor.org/rfc/rfc7518.html#section-5">Cryptographic
          * Algorithms for Content Encryption</a> defined in the
@@ -162,42 +139,6 @@ private ENC() {
          * algorithm requires a 256-bit (32 byte) key.
          */
         public static final AeadAlgorithm A256GCM = get().forKey("A256GCM");
-
-        /**
-         * Returns a new builder to create {@link AeadRequest}s used for AEAD encryption via
-         * {@link AeadAlgorithm#encrypt(AeadRequest, AeadResult)}
-         *
-         * @return a new builder to create {@link AeadRequest}s used for AEAD encryption via
-         * {@link AeadAlgorithm#encrypt(AeadRequest, AeadResult)}
-         * @since 0.13.0
-         */
-        public static AeadRequest.Builder request() {
-            return REQUEST_BUILDER_SUPPLIER.get();
-        }
-
-        /**
-         * Returns a new builder to create {@link DecryptAeadRequest}s used for AEAD decryption via
-         * {@link AeadAlgorithm#decrypt(DecryptAeadRequest, OutputStream)}
-         *
-         * @return a new builder to create {@link DecryptAeadRequest}s used for AEAD decryption via
-         * {@link AeadAlgorithm#decrypt(DecryptAeadRequest, OutputStream)}
-         * @since 0.13.0
-         */
-        public static DecryptAeadRequest.Builder decryptRequest() {
-            return DECRYPT_REQUEST_BUILDER_SUPPLIER.get();
-        }
-
-        /**
-         * Returns a new builder to create {@link AeadResult}s used to store AEAD encryption results when calling
-         * {@link AeadAlgorithm#encrypt(AeadRequest, AeadResult)}
-         *
-         * @return a new builder to create {@link AeadResult}s used to store AEAD encryption results when calling
-         * {@link AeadAlgorithm#encrypt(AeadRequest, AeadResult)}
-         * @since 0.13.0
-         */
-        public static AeadResult.Builder result() {
-            return RESULT_BUILDER_SUPPLIER.get();
-        }
     }
 
     /**
@@ -221,14 +162,6 @@ public static final class SIG {
         private static final String IMPL_CLASSNAME = "io.jsonwebtoken.impl.security.StandardSecureDigestAlgorithms";
         private static final Registry<String, SecureDigestAlgorithm<?, ?>> REGISTRY = Classes.newInstance(IMPL_CLASSNAME);
 
-        // @since 0.13.0
-        private static final Supplier<SecureRequest.Builder<InputStream, ?>> REQUEST_BUILDER_SUPPLIER =
-                Classes.newInstance("io.jsonwebtoken.impl.security.DefaultSecureRequest$Builder$Supplier");
-
-        // @since 0.13.0
-        private static final Supplier<VerifySecureDigestRequest.Builder<?>> VERIFY_REQUEST_BUILDER_SUPPLIER =
-                Classes.newInstance("io.jsonwebtoken.impl.security.DefaultVerifySecureDigestRequest$Builder$Supplier");
-
         //prevent instantiation
         private SIG() {
         }
@@ -369,34 +302,6 @@ private SIG() {
          * classpath.</b></p>
          */
         public static final SignatureAlgorithm EdDSA = Jwts.get(REGISTRY, "EdDSA");
-
-        /**
-         * Returns a new builder to create {@link SecureRequest}s used to compute a mac or signature via
-         * {@link SecureDigestAlgorithm#digest(Request)}.
-         *
-         * @param <K> the type of key used by the algorithm to compute the mac or signature.
-         * @return a new builder to create {@link SecureRequest}s used to compute a mac or signature via
-         * {@link SecureDigestAlgorithm#digest(Request)}.
-         * @since 0.13.0
-         */
-        @SuppressWarnings("unchecked")
-        public static <K extends Key> SecureRequest.Builder<InputStream, K> request() {
-            return (SecureRequest.Builder<InputStream, K>) REQUEST_BUILDER_SUPPLIER.get();
-        }
-
-        /**
-         * Returns a new builder to create {@link VerifySecureDigestRequest}s used to verify a mac or signature via
-         * {@link SecureDigestAlgorithm#verify(VerifyDigestRequest)}.
-         *
-         * @param <K> the type of key used by the algorithm to verify the mac or signature.
-         * @return a new builder to create {@link VerifySecureDigestRequest}s used to verify a mac or signature via
-         * {@link SecureDigestAlgorithm#verify(VerifyDigestRequest)}.
-         * @since 0.13.0
-         */
-        @SuppressWarnings("unchecked")
-        public static <K extends Key> VerifySecureDigestRequest.Builder<K> verifyRequest() {
-            return (VerifySecureDigestRequest.Builder<K>) VERIFY_REQUEST_BUILDER_SUPPLIER.get();
-        }
     }
 
     /**
@@ -418,14 +323,6 @@ public static final class KEY {
         private static final String IMPL_CLASSNAME = "io.jsonwebtoken.impl.security.StandardKeyAlgorithms";
         private static final Registry<String, KeyAlgorithm<?, ?>> REGISTRY = Classes.newInstance(IMPL_CLASSNAME);
 
-        // @since 0.13.0
-        private static final Supplier<KeyRequest.Builder<?>> REQUEST_BUILDER_SUPPLIER =
-                Classes.newInstance("io.jsonwebtoken.impl.security.DefaultKeyRequest$Builder$Supplier");
-
-        // @since 0.13.0
-        private static final Supplier<DecryptionKeyRequest.Builder<?>> VERIFY_REQUEST_BUILDER_SUPPLIER =
-                Classes.newInstance("io.jsonwebtoken.impl.security.DefaultDecryptionKeyRequest$Builder$Supplier");
-
         /**
          * Returns all standard JWA standard <a href="https://www.rfc-editor.org/rfc/rfc7518.html#section-4">Cryptographic
          * Algorithms for Key Management</a>..
@@ -1029,34 +926,6 @@ public static final class KEY {
          */
         public static final KeyAlgorithm<PublicKey, PrivateKey> ECDH_ES_A256KW = Jwts.get(REGISTRY, "ECDH-ES+A256KW");
 
-        /**
-         * Returns a new builder to create {@link KeyRequest}s used to get a JWE encryption key via
-         * {@link KeyAlgorithm#getEncryptionKey(KeyRequest)}.
-         *
-         * @param <K> the type of key used by the {@link KeyAlgorithm} to get a JWE encryption key.
-         * @return a new builder to create {@link KeyRequest}s used to get a JWE encryption key via
-         * {@link KeyAlgorithm#getEncryptionKey(KeyRequest)}.
-         * @since 0.13.0
-         */
-        @SuppressWarnings("unchecked")
-        public static <K extends Key> KeyRequest.Builder<K> request() {
-            return (KeyRequest.Builder<K>) REQUEST_BUILDER_SUPPLIER.get();
-        }
-
-        /**
-         * Returns a new builder to create {@link DecryptionKeyRequest}s used to get a JWE decryption key via
-         * {@link KeyAlgorithm#getDecryptionKey(DecryptionKeyRequest)}.
-         *
-         * @param <K> the type of key used by the {@link KeyAlgorithm} to get a JWE decryption key.
-         * @return a new builder to create {@link DecryptionKeyRequest}s used to get a JWE decryption key via
-         * {@link KeyAlgorithm#getDecryptionKey(DecryptionKeyRequest)}.
-         * @since 0.13.0
-         */
-        @SuppressWarnings("unchecked")
-        public static <K extends Key> DecryptionKeyRequest.Builder<K> decRequest() {
-            return (DecryptionKeyRequest.Builder<K>) VERIFY_REQUEST_BUILDER_SUPPLIER.get();
-        }
-
         //prevent instantiation
         private KEY() {
         }

api/src/main/java/io/jsonwebtoken/security/AeadRequest.java

@@ -33,7 +33,7 @@ public interface AeadRequest extends SecureRequest<InputStream, SecretKey>, Asso
      * Named parameters (setters) used to configure an {@link AeadRequest AeadRequest} instance.
      *
      * @param <M> the instance type returned for method chaining.
-     * @since 0.13.0
+     * @since JJWT_RELEASE_VERSION
      */
     interface Params<M extends Params<M>> extends SecureRequest.Params<InputStream, SecretKey, M> {
 
@@ -51,10 +51,23 @@ interface Params<M extends Params<M>> extends SecureRequest.Params<InputStream,
     }
 
     /**
-     * A builder for creating new immutable {@link AeadRequest} instances.
+     * A builder for creating new immutable {@link AeadRequest} instances used for AEAD encryption via
+     * {@link AeadAlgorithm#encrypt(AeadRequest, AeadResult)}.
      *
-     * @since 0.13.0
+     * @since JJWT_RELEASE_VERSION
      */
     interface Builder extends Params<Builder>, io.jsonwebtoken.lang.Builder<AeadRequest> {
     }
+
+    /**
+     * Returns a new {@link AeadRequest.Builder} for creating immutable {@link AeadRequest}s used for AEAD encryption
+     * via {@link AeadAlgorithm#encrypt(AeadRequest, AeadResult)}.
+     *
+     * @return a new {@link AeadRequest.Builder} for creating immutable {@link AeadRequest}s used for AEAD encryption
+     * via {@link AeadAlgorithm#encrypt(AeadRequest, AeadResult)}.
+     * @since JJWT_RELEASE_VERSION
+     */
+    static AeadRequest.Builder builder() {
+        return Suppliers.AEAD_REQUEST_BUILDER.get();
+    }
 }

api/src/main/java/io/jsonwebtoken/security/AeadResult.java

@@ -54,7 +54,7 @@ public interface AeadResult extends DigestSupplier, IvSupplier {
     /**
      * A builder for creating new {@link AeadResult} instances.
      *
-     * @since 0.13.0
+     * @since JJWT_RELEASE_VERSION
      */
     interface Builder extends io.jsonwebtoken.lang.Builder<AeadResult> {
 
@@ -69,4 +69,16 @@ interface Builder extends io.jsonwebtoken.lang.Builder<AeadResult> {
         Builder out(OutputStream out);
     }
 
+    /**
+     * Returns a new {@link AeadResult} with the specified {@link OutputStream} that will be used to write the
+     * resulting ciphertext during encryption or plaintext during decryption.
+     *
+     * @return a new {@link AeadResult} with the specified {@link OutputStream} that will be used to write the
+     * resulting ciphertext during encryption or plaintext during decryption.
+     * @since JJWT_RELEASE_VERSION
+     */
+    static AeadResult of(OutputStream out) {
+        return Suppliers.AEAD_RESULT_BUILDER.get().out(out).build();
+    }
+
 }

api/src/main/java/io/jsonwebtoken/security/DecryptAeadRequest.java

@@ -16,6 +16,7 @@
 package io.jsonwebtoken.security;
 
 import javax.crypto.SecretKey;
+import java.io.OutputStream;
 
 /**
  * A request to an {@link AeadAlgorithm} to decrypt ciphertext with integrity verification with a supplied
@@ -29,7 +30,7 @@ public interface DecryptAeadRequest extends AeadRequest, IvSupplier, DigestSuppl
     /**
      * Named parameters (setters) used to configure an {@link AeadRequest AeadRequest} instance.
      *
-     * @since 0.13.0
+     * @since JJWT_RELEASE_VERSION
      */
     interface Params<M extends Params<M>> extends AeadRequest.Params<M> {
 
@@ -50,11 +51,24 @@ interface Params<M extends Params<M>> extends AeadRequest.Params<M> {
     }
 
     /**
-     * A builder for creating new immutable {@link DecryptAeadRequest} instances.
+     * A builder for creating new immutable {@link DecryptAeadRequest}s used for AEAD decryption via
+     * {@link AeadAlgorithm#decrypt(DecryptAeadRequest, OutputStream)}.
      *
-     * @since 0.13.0
+     * @since JJWT_RELEASE_VERSION
      */
     interface Builder extends io.jsonwebtoken.lang.Builder<DecryptAeadRequest>, Params<Builder> {
     }
 
+    /**
+     * Returns a new {@link DecryptAeadRequest.Builder} for creating immutable {@link DecryptAeadRequest}s used for
+     * AEAD decryption via {@link AeadAlgorithm#decrypt(DecryptAeadRequest, OutputStream)}.
+     *
+     * @return a new {@link DecryptAeadRequest.Builder} for creating immutable {@link DecryptAeadRequest}s used for
+     * AEAD decryption via {@link AeadAlgorithm#decrypt(DecryptAeadRequest, OutputStream)}.
+     * @since JJWT_RELEASE_VERSION
+     */
+    static DecryptAeadRequest.Builder builder() {
+        return Suppliers.DECRYPT_AEAD_REQUEST_BUILDER.get();
+    }
+
 }

api/src/main/java/io/jsonwebtoken/security/DecryptionKeyRequest.java

@@ -47,18 +47,32 @@ public interface DecryptionKeyRequest<K extends Key> extends SecureRequest<byte[
      *
      * @param <K> the type of key used by the {@link KeyAlgorithm} to obtain the JWE Content Encryption Key (CEK).
      * @param <M> the instance type returned for method chaining.
-     * @since 0.13.0
+     * @since JJWT_RELEASE_VERSION
      */
     interface Params<K extends Key, M extends Params<K, M>> extends KeyRequest.Params<byte[], M>,
             SecureRequest.Params<byte[], K, M> {
     }
 
     /**
-     * A builder for creating new immutable {@link DecryptionKeyRequest} instances.
+     * A builder for creating new immutable {@link DecryptionKeyRequest} instances used to get a JWE
+     * decryption key via {@link KeyAlgorithm#getDecryptionKey(DecryptionKeyRequest)}.
      *
      * @param <K> the type of key used by the {@link KeyAlgorithm} to obtain the JWE Content Encryption Key (CEK).
-     * @since 0.13.0
+     * @since JJWT_RELEASE_VERSION
      */
     interface Builder<K extends Key> extends Params<K, Builder<K>>, io.jsonwebtoken.lang.Builder<DecryptionKeyRequest<K>> {
     }
+
+    /**
+     * Returns a new {@link DecryptionKeyRequest.Builder} for creating immutable {@link DecryptionKeyRequest}s used to
+     * get a JWE decryption key via {@link KeyAlgorithm#getDecryptionKey(DecryptionKeyRequest)}.
+     *
+     * @return a new {@link DecryptionKeyRequest.Builder} for creating immutable {@link DecryptionKeyRequest}s used to
+     * get a JWE decryption key via {@link KeyAlgorithm#getDecryptionKey(DecryptionKeyRequest)}.
+     * @since JJWT_RELEASE_VERSION
+     */
+    @SuppressWarnings("unchecked")
+    static <K extends Key> DecryptionKeyRequest.Builder<K> builder() {
+        return (DecryptionKeyRequest.Builder<K>) Suppliers.DECRYPTION_KEY_REQUEST_BUILDER.get();
+    }
 }

api/src/main/java/io/jsonwebtoken/security/HashAlgorithm.java

@@ -18,6 +18,7 @@
 import io.jsonwebtoken.Identifiable;
 
 import java.io.InputStream;
+import java.util.function.Consumer;
 
 /**
  * A {@link DigestAlgorithm} that computes and verifies digests without the use of a cryptographic key, such as for
@@ -42,4 +43,27 @@
  * @since 0.12.0
  */
 public interface HashAlgorithm extends DigestAlgorithm<Request<InputStream>, VerifyDigestRequest> {
+
+    default byte[] digest(Consumer<Request.Params<InputStream, ?>> c) {
+        Request.Builder<InputStream> b = Request.builder();
+        c.accept(b);
+        Request<InputStream> r = b.build();
+        return digest(r);
+    }
+
+    default byte[] digest(InputStream is) {
+        return digest(c -> c.payload(is));
+    }
+
+    default boolean verify(Consumer<VerifyDigestRequest.Params<?>> c) {
+        VerifyDigestRequest.Builder b = VerifyDigestRequest.builder();
+        c.accept(b);
+        VerifyDigestRequest r = b.build();
+        return verify(r);
+    }
+
+    default boolean verify(InputStream is, byte[] digest) {
+        return verify(c -> c.payload(is).digest(digest));
+    }
+
 }