chore: add some comment

nervosnetwork · Aug 1, 2024 · f17cbfc · f17cbfc · github-actions · Aug 1, 2024
1 parent c894735
commit f17cbfc
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 0 deletions.
diff --git a/packages/neuron-wallet/src/services/log-encryption.ts b/packages/neuron-wallet/src/services/log-encryption.ts
@@ -11,6 +11,10 @@ export default class LogEncryption {
    */
   private readonly algorithm = DEFAULT_ALGORITHM
 
+  /**
+   * A PEM-formatted RSA public key
+   * @private
+   */
   private readonly adminPublicKey: string
 
   /**
@@ -77,6 +81,23 @@ export class LogDecryption {
   }
 }
 
+/**
+ * Parse a message into a JSON
+ *
+ * Input:
+ * ```
+ * [key1:value2] [key2:value2] remain content
+ * ```
+ * Output:
+ * ```json
+ * {
+ *   "key1": "value1",
+ *   "key2": "value2",
+ *   "content": "remain content"
+ *  }
+ * ```
+ * @param message
+ */
 function parseMessage(message: string) {
   const result: Record<string, string> = {}
   const regex = /\[([^\]:]+):([^\]]+)]/g

diff --git a/scripts/admin/decrypt-log/README.md b/scripts/admin/decrypt-log/README.md
@@ -4,6 +4,16 @@
 
 An environment variable `LOG_ENCRYPTION_PUBLIC_KEY` must be set to enable log encryption when releasing Neuron. If the variable is not set, a placeholder message will be left in the log file.
 
+To generate a keypair
+
+```sh
+# for ADMIN_PRIVATE_KEY
+openssl genrsa -out key.pem 2048
+
+# for LOG_ENCRYPTION_PUBLIC_KEY
+openssl rsa -in key.pem -outform PEM -pubout -out public.pem
+```
+
 ## Decryption
 
 An encrypted log looks the following block