Code formatting

Author: andreblanke

.idea/dictionaries/andreblanke.xml

@@ -94,7 +94,7 @@ First, make sure you add the BouncyCastle security provider:
 Security.addProvider(new BouncyCastleProvider());
 ```
 
-Then, create an instance of the push service, either `nl.martijndwars.webpush.PushService` for synchronous blocking HTTP calls, or `nl.martijndwars.webpush.PushAsyncService` for asynchronous non-blocking HTTP calls:
+Then, create an instance of the push service, either `nl.martijndwars.webpush.JdkHttpClientPushService` for synchronous blocking HTTP calls, or `nl.martijndwars.webpush.PushAsyncService` for asynchronous non-blocking HTTP calls:
 
 ```java
 PushService pushService = new PushService(...);

README.md

@@ -1,32 +1,35 @@
 package nl.martijndwars.webpush.cli;
 
+import java.security.Security;
+
 import com.beust.jcommander.JCommander;
 import com.beust.jcommander.ParameterException;
+
 import nl.martijndwars.webpush.cli.commands.GenerateKeyCommand;
 import nl.martijndwars.webpush.cli.commands.SendNotificationCommand;
 import nl.martijndwars.webpush.cli.handlers.GenerateKeyHandler;
 import nl.martijndwars.webpush.cli.handlers.SendNotificationHandler;
+
 import org.bouncycastle.jce.provider.BouncyCastleProvider;
 
-import java.security.Security;
+public final class Cli {
 
-/**
- * Command-line interface
- */
-public class Cli {
     private static final String GENERATE_KEY = "generate-key";
     private static final String SEND_NOTIFICATION = "send-notification";
 
-    public static void main(String[] args) {
+    private Cli() {
+    }
+
+    public static void main(final String[] args) {
         Security.addProvider(new BouncyCastleProvider());
 
-        GenerateKeyCommand generateKeyCommand = new GenerateKeyCommand();
-        SendNotificationCommand sendNotificationCommand = new SendNotificationCommand();
+        final var generateKeyCommand = new GenerateKeyCommand();
+        final var sendNotificationCommand = new SendNotificationCommand();
 
-        JCommander jCommander = JCommander.newBuilder()
-                .addCommand(GENERATE_KEY, generateKeyCommand)
-                .addCommand(SEND_NOTIFICATION, sendNotificationCommand)
-                .build();
+        final var jCommander = JCommander.newBuilder()
+            .addCommand(GENERATE_KEY, generateKeyCommand)
+            .addCommand(SEND_NOTIFICATION, sendNotificationCommand)
+            .build();
 
         try {
             jCommander.parse(args);
@@ -39,10 +42,10 @@ public static void main(String[] args) {
             } else {
                 jCommander.usage();
             }
-        } catch (ParameterException e) {
-            e.usage();
-        } catch (Exception e) {
-            e.printStackTrace();
+        } catch (final ParameterException exception) {
+            exception.usage();
+        } catch (final Exception exception) {
+            exception.printStackTrace();
         }
     }
 }

webpush-cli/src/main/java/nl/martijndwars/webpush/cli/Cli.java

@@ -176,9 +176,9 @@ private static Encrypted encrypt(final byte[] payload, final ECPublicKey userPub
      * Generates the local (ephemeral) keys.
      */
     private static KeyPair generateLocalKeyPair() throws GeneralSecurityException {
-        final var parameterSpec = ECNamedCurveTable.getParameterSpec("prime256v1");
+        final var parameterSpec = ECNamedCurveTable.getParameterSpec(Utils.CURVE);
 
-        KeyPairGenerator keyPairGenerator = KeyPairGenerator.getInstance("ECDH", BouncyCastleProvider.PROVIDER_NAME);
+        final var keyPairGenerator = KeyPairGenerator.getInstance("ECDH", BouncyCastleProvider.PROVIDER_NAME);
         keyPairGenerator.initialize(parameterSpec);
         return keyPairGenerator.generateKeyPair();
     }

webpush/src/main/java/nl/martijndwars/webpush/AbstractPushService.java

@@ -1,24 +1,25 @@
 package nl.martijndwars.webpush;
 
-import org.bouncycastle.crypto.digests.SHA256Digest;
-import org.bouncycastle.crypto.generators.HKDFBytesGenerator;
-import org.bouncycastle.crypto.params.HKDFParameters;
-import org.bouncycastle.jce.interfaces.ECPrivateKey;
-import org.bouncycastle.jce.interfaces.ECPublicKey;
-
 import javax.crypto.*;
 import javax.crypto.spec.GCMParameterSpec;
 import javax.crypto.spec.SecretKeySpec;
 import java.nio.ByteBuffer;
 import java.security.*;
 import java.util.Arrays;
 import java.util.Base64;
-import java.util.HashMap;
 import java.util.Map;
 
+import org.bouncycastle.crypto.digests.SHA256Digest;
+import org.bouncycastle.crypto.generators.HKDFBytesGenerator;
+import org.bouncycastle.crypto.params.HKDFParameters;
+import org.bouncycastle.jce.interfaces.ECPrivateKey;
+import org.bouncycastle.jce.interfaces.ECPublicKey;
+
 import static java.nio.charset.StandardCharsets.UTF_8;
+
 import static javax.crypto.Cipher.DECRYPT_MODE;
 import static javax.crypto.Cipher.ENCRYPT_MODE;
+
 import static nl.martijndwars.webpush.Utils.*;
 
 // TODO: Support multiple records (not needed for Web Push)
@@ -32,7 +33,8 @@
  * [1] <a href="https://tools.ietf.org/html/draft-ietf-httpbis-encryption-encoding-01">...</a>
  * [2] <a href="https://tools.ietf.org/html/draft-ietf-httpbis-encryption-encoding-09">...</a>
  */
-public class HttpEce {
+public final class HttpEce {
+
     public static final int KEY_LENGTH = 16;
     public static final int SHA_256_LENGTH = 32;
     public static final int TAG_SIZE = 16;
@@ -43,11 +45,11 @@ public class HttpEce {
     private final Map<String, String> labels;
 
     public HttpEce() {
-        this(new HashMap<>(), new HashMap<>());
+        this(Map.of(), Map.of());
     }
 
-    public HttpEce(Map<String, KeyPair> keys, Map<String, String> labels) {
-        this.keys = keys;
+    public HttpEce(final Map<String, KeyPair> keys, final Map<String, String> labels) {
+        this.keys   = keys;
         this.labels = labels;
     }
 
@@ -57,15 +59,15 @@ public HttpEce(Map<String, KeyPair> keys, Map<String, String> labels) {
      * @param plaintext    Payload to encrypt.
      * @param salt       A random 16-byte buffer
      * @param privateKey A private key to encrypt this message with (Web Push: the local private key)
-     * @param keyid      An identifier for the local key. Only applies to AESGCM. For AES128GCM, the header contains the keyid.
+     * @param keyId      An identifier for the local key. Only applies to AESGCM. For AES128GCM, the header contains the keyId.
      * @param dh         An Elliptic curve Diffie-Hellman public privateKey on the P-256 curve (Web Push: the user's keys.p256dh)
      * @param authSecret An authentication secret (Web Push: the user's keys.auth)
      */
-    public byte[] encrypt(byte[] plaintext, byte[] salt, byte[] privateKey, String keyid, ECPublicKey dh,
+    public byte[] encrypt(byte[] plaintext, byte[] salt, byte[] privateKey, String keyId, ECPublicKey dh,
                           byte[] authSecret, Encoding version) throws GeneralSecurityException {
         log("encrypt", plaintext);
 
-        byte[][] keyAndNonce = deriveKeyAndNonce(salt, privateKey, keyid, dh, authSecret, version, ENCRYPT_MODE);
+        byte[][] keyAndNonce = deriveKeyAndNonce(salt, privateKey, keyId, dh, authSecret, version, ENCRYPT_MODE);
         byte[] key = keyAndNonce[0];
         byte[] nonce = keyAndNonce[1];
 
@@ -76,7 +78,7 @@ public byte[] encrypt(byte[] plaintext, byte[] salt, byte[] privateKey, String k
 
         // For AES128GCM suffix {0x02}, for AESGCM prefix {0x00, 0x00}.
         if (version == Encoding.AES_128_GCM) {
-            byte[] header = buildHeader(salt, keyid);
+            byte[] header = buildHeader(salt, keyId);
             log("header", header);
 
             byte[] padding = new byte[] { 2 };
@@ -127,10 +129,10 @@ public byte[][] parseHeader(byte[] payload) {
         byte[] body = Arrays.copyOfRange(payload, 21 + keyIdLength, payload.length);
 
         return new byte[][] {
-                salt,
-                recordSize,
-                keyId,
-                body
+            salt,
+            recordSize,
+            keyId,
+            body
         };
     }
 
@@ -353,18 +355,17 @@ private  byte[][] extractDH(String keyid, ECPublicKey publicKey) throws NoSuchAl
     /**
      * Get the public key for the given keyid.
      */
-    private ECPublicKey getPublicKey(String keyid) {
-        return (ECPublicKey) keys.get(keyid).getPublic();
+    private ECPublicKey getPublicKey(String keyId) {
+        return (ECPublicKey) keys.get(keyId).getPublic();
     }
 
     /**
      * Get the private key for the given keyid.
      */
-    private ECPrivateKey getPrivateKey(String keyid) {
-        return (ECPrivateKey) keys.get(keyid).getPrivate();
+    private ECPrivateKey getPrivateKey(String keyId) {
+        return (ECPrivateKey) keys.get(keyId).getPrivate();
     }
 
-
     /**
      * Encode the public key as a byte array and prepend its length in two bytes.
      */

webpush/src/main/java/nl/martijndwars/webpush/HttpEce.java

@@ -17,8 +17,8 @@
  * @param userPublicKey The client's public key
  * @param userAuth The client's auth
  * @param payload An arbitrary payload
- * @param urgency Push Message Urgency <a href="https://tools.ietf.org/html/rfc8030#section-5.3">Push Message Urgency</a>
- * @param topic Push Message Topic <a href="https://tools.ietf.org/html/rfc8030#section-5.4">Replacing Push Messages</a>
+ * @param urgency <a href="https://tools.ietf.org/html/rfc8030#section-5.3">Push Message Urgency</a>
+ * @param topic <a href="https://tools.ietf.org/html/rfc8030#section-5.4">Replacing Push Messages</a>
  * @param ttl Time in seconds that the push message is retained by the push service
  */
 public record Notification(URI endpoint, ECPublicKey userPublicKey, byte[] userAuth, byte[] payload, Urgency urgency,
@@ -41,7 +41,7 @@ public boolean hasTopic() {
     }
 
     /**
-     * Detect if the notification is for a GCM-based subscription
+     * Detects if this {@code Notification} is for a GCM-based subscription.
      */
     public boolean isGcm() {
         return endpoint().toString().startsWith("https://android.googleapis.com/gcm/send");

webpush/src/main/java/nl/martijndwars/webpush/Notification.java

@@ -1,5 +1,11 @@
 package nl.martijndwars.webpush;
 
+import java.math.BigInteger;
+import java.nio.ByteBuffer;
+import java.security.*;
+import java.security.spec.InvalidKeySpecException;
+import java.util.Base64;
+
 import org.bouncycastle.jce.ECNamedCurveTable;
 import org.bouncycastle.jce.interfaces.ECPrivateKey;
 import org.bouncycastle.jce.interfaces.ECPublicKey;
@@ -11,15 +17,9 @@
 import org.bouncycastle.math.ec.ECPoint;
 import org.bouncycastle.util.BigIntegers;
 
-import java.math.BigInteger;
-import java.nio.ByteBuffer;
-import java.security.*;
-import java.security.spec.InvalidKeySpecException;
-import java.util.Base64;
-
 import static org.bouncycastle.jce.provider.BouncyCastleProvider.PROVIDER_NAME;
 
-public class Utils {
+public final class Utils {
 
     public static final String CURVE = "prime256v1";