Add default key configuration comment

Signed-off-by: Ryan Liang <[email protected]>
opensearch-project · Mar 28, 2023 · 367752b · 367752b
1 parent 6bd8d40
commit 367752b
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/main/java/org/opensearch/security/authtoken/jwt/JwtVendor.java b/src/main/java/org/opensearch/security/authtoken/jwt/JwtVendor.java
@@ -74,6 +74,12 @@ public JwtVendor(Settings settings, final LongSupplier timeProvider) {
         this.timeProvider = timeProvider;
     }
 
+    /*
+    * The default configuration of this web key should be:
+    *   KeyType: OCTET
+    *   PublicKeyUse: SIGN
+    *   Encryption Algorithm: HS512
+    * */
     static JsonWebKey createJwkFromSettings(Settings settings) throws Exception {
         String signingKey = settings.get("signing_key");