Merge pull request #1 from binance/v0.3.0

v0.3.0 release

.eslintrc.json

@@ -0,0 +1,15 @@
+{
+    "env": {
+        "browser": true,
+        "commonjs": true,
+        "es2021": true
+    },
+    "extends": "standard",
+    "overrides": [
+    ],
+    "parserOptions": {
+        "ecmaVersion": "latest"
+    },
+    "rules": {
+    }
+}

.gitignore

@@ -1,4 +1,3 @@
 node_modules
 .DS_Store
 dist/
-package-lock.json

CHANGELOG.md

@@ -1,9 +1,13 @@
 # CHANGELOG
 
+## v0.3.0
+- Restructured files
+- Added error message on not saved key
+
 ## v0.2.0
-- Fix the an error in Mac when reopen the windows
-- Allow to generate `2048` and `4096` bits keys
-- Better handling download Dialog.
+- Fixed an error in macOS for when the window is reopened
+- Allow only `2048` and `4096` bits keys generation
+- Improved the handling of download dialog.
 
 ## v0.1.1
 - First release

LICENSE.md

@@ -1,39 +1,21 @@
-CC0 1.0 Universal
-==================
-
-Statement of Purpose
----------------------
-
-The laws of most jurisdictions throughout the world automatically confer exclusive Copyright and Related Rights (defined below) upon the creator and subsequent owner(s) (each and all, an "owner") of an original work of authorship and/or a database (each, a "Work").
-
-Certain owners wish to permanently relinquish those rights to a Work for the purpose of contributing to a commons of creative, cultural and scientific works ("Commons") that the public can reliably and without fear of later claims of infringement build upon, modify, incorporate in other works, reuse and redistribute as freely as possible in any form whatsoever and for any purposes, including without limitation commercial purposes. These owners may contribute to the Commons to promote the ideal of a free culture and the further production of creative, cultural and scientific works, or to gain reputation or greater distribution for their Work in part through the use and efforts of others.
-
-For these and/or other purposes and motivations, and without any expectation of additional consideration or compensation, the person associating CC0 with a Work (the "Affirmer"), to the extent that he or she is an owner of Copyright and Related Rights in the Work, voluntarily elects to apply CC0 to the Work and publicly distribute the Work under its terms, with knowledge of his or her Copyright and Related Rights in the Work and the meaning and intended legal effect of CC0 on those rights.
-
-1. Copyright and Related Rights.
---------------------------------
-A Work made available under CC0 may be protected by copyright and related or neighboring rights ("Copyright and Related Rights"). Copyright and Related Rights include, but are not limited to, the following:
-
-i. the right to reproduce, adapt, distribute, perform, display, communicate, and translate a Work;
-ii. moral rights retained by the original author(s) and/or performer(s);
-iii. publicity and privacy rights pertaining to a person's image or likeness depicted in a Work;
-iv. rights protecting against unfair competition in regards to a Work, subject to the limitations in paragraph 4(a), below;
-v. rights protecting the extraction, dissemination, use and reuse of data in a Work;
-vi. database rights (such as those arising under Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, and under any national implementation thereof, including any amended or successor version of such directive); and
-vii. other similar, equivalent or corresponding rights throughout the world based on applicable law or treaty, and any national implementations thereof.
-
-2. Waiver.
------------
-To the greatest extent permitted by, but not in contravention of, applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and unconditionally waives, abandons, and surrenders all of Affirmer's Copyright and Related Rights and associated claims and causes of action, whether now known or unknown (including existing as well as future claims and causes of action), in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each member of the public at large and to the detriment of Affirmer's heirs and successors, fully intending that such Waiver shall not be subject to revocation, rescission, cancellation, termination, or any other legal or equitable action to disrupt the quiet enjoyment of the Work by the public as contemplated by Affirmer's express Statement of Purpose.
-
-3. Public License Fallback.
-----------------------------
-Should any part of the Waiver for any reason be judged legally invalid or ineffective under applicable law, then the Waiver shall be preserved to the maximum extent permitted taking into account Affirmer's express Statement of Purpose. In addition, to the extent the Waiver is so judged Affirmer hereby grants to each affected person a royalty-free, non transferable, non sublicensable, non exclusive, irrevocable and unconditional license to exercise Affirmer's Copyright and Related Rights in the Work (i) in all territories worldwide, (ii) for the maximum duration provided by applicable law or treaty (including future time extensions), (iii) in any current or future medium and for any number of copies, and (iv) for any purpose whatsoever, including without limitation commercial, advertising or promotional purposes (the "License"). The License shall be deemed effective as of the date CC0 was applied by Affirmer to the Work. Should any part of the License for any reason be judged legally invalid or ineffective under applicable law, such partial invalidity or ineffectiveness shall not invalidate the remainder of the License, and in such case Affirmer hereby affirms that he or she will not (i) exercise any of his or her remaining Copyright and Related Rights in the Work or (ii) assert any associated claims and causes of action with respect to the Work, in either case contrary to Affirmer's express Statement of Purpose.
-
-4. Limitations and Disclaimers.
---------------------------------
-
-a. No trademark or patent rights held by Affirmer are waived, abandoned, surrendered, licensed or otherwise affected by this document.
-b. Affirmer offers the Work as-is and makes no representations or warranties of any kind concerning the Work, express, implied, statutory or otherwise, including without limitation warranties of title, merchantability, fitness for a particular purpose, non infringement, or the absence of latent or other defects, accuracy, or the present or absence of errors, whether or not discoverable, all to the greatest extent permissible under applicable law.
-c. Affirmer disclaims responsibility for clearing rights of other persons that may apply to the Work or any use thereof, including without limitation any person's Copyright and Related Rights in the Work. Further, Affirmer disclaims responsibility for obtaining any necessary consents, permissions or other rights required for any use of the Work.
-d. Affirmer understands and acknowledges that Creative Commons is not a party to this document and has no duty or obligation with respect to this CC0 or use of the Work.
+MIT License
+
+Copyright (c) 2022 Binance
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,27 +1,57 @@
 # RSA Key Generator
 
-This simple tool can be used for generating RSA Keys.
+This simple tool can be used to generate an RSA PKCS#8 key pair (private and public key).
 
+There's two methods to run the tool, you can either download or build from source code.
 
-## Save
-TODO
+## Download
+Prebuild apps can be found in [Releases](https://github.com/binance/rsa-key-generator/releases).
 
-## Run from code
+To verify the package's integrity, download both the app and the checksum file to the same directory:
 
+```shell
+-rw-r--r--@  1 john  staff   156M 18 Nov 17:02 RSAKeyGenerator-0.3.0-universal.dmg
+-rw-r--r--@  1 john  staff   102B 18 Nov 19:01 RSAKeyGenerator-0.3.0-universal.dmg.CHECKSUM
+```
 
-## How to use
+Then run sha256 checksum:
 
-1. Open the app
+```shell
+sha256sum -c RSAKeyGenerator-0.3.0-universal.dmg.CHECKSUM
+```
 
-2. Choose the bits; Recommend to keep the default value (`2048`), then click the button `Generate Key Pair`
+If it passes the integrity check, it'll return `RSAKeyGenerator-0.3.0-universal.dmg: OK`
 
-3. Below on the left column is the `Private Key`, which should be saved in your local storage; It should never be shared with anyone. Click `Save` to save in security location.
+## Build from source code
 
-4. The right column is the `Public Key`. Click `Save` button to save into local storage. This key is shared with others to sign, which can be verified with your `Private Key`.
+Obtain the source code locally and go through the following steps: 
 
-## Contributing
-Contributions are welcome.
+```javascript
+
+// install package
+npm install
+
+// run locally
+npm run start
+
+// build packages locally into the "dist" folder.
+npm run dist
+
+```
+
+## Usage
+
+1. Open the app;
+
+2. Choose the bits size; Recommend to keep the default value (`2048`), then click the button `Generate Key Pair`;
+
+3. Below on the left column is the `Private Key`, which should be stored in a secure location on your local disk (by using the `Save` button) and must never be shared with anyone;
+
+4. The right column is the `Public Key`. Click `Save` button to save into local disk. This key can be shared with others to verify the `Private Key` signed data;
+
+## Contribution
+Contributions are welcome!
 If you've found a bug within this project, please open an issue to discuss what you would like to change.
 
 ## License
-MIT
+MIT

styles.css → assets/css/styles.css

@@ -1,11 +1,11 @@
 @font-face {
     font-family: 'SFProDisplay-Bold';
-    src: url('assets/fonts/SFProDisplay-Bold.ttf');
+    src: url('../fonts/SFProDisplay-Bold.ttf');
 }
 
 @font-face {
     font-family: 'SFProDisplay-Regular';
-    src: url('assets/fonts/SFProDisplay-Regular.ttf');
+    src: url('../fonts/SFProDisplay-Regular.ttf');
 }
 
 

index.html → assets/html/index.html

@@ -1,14 +1,13 @@
 <!DOCTYPE html>
 <html data-theme="light">
-
 <head>
   <meta charset="UTF-8">
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   <meta http-equiv="Content-Security-Policy"
     content="default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline'">
-  <link href="./daisyui.css" rel="stylesheet" type="text/css" />
-  <script src="./tailwind.js"></script>
-  <link href="./styles.css" rel="stylesheet">
+  <link href="../css/daisyui.css" rel="stylesheet" type="text/css" />
+  <script src="../js/tailwind.js"></script>
+  <link href="../css/styles.css" rel="stylesheet">
   <title>RSA Key Generator</title>
 </head>
 
@@ -56,7 +55,7 @@ <h2 class="text-2xl font-bold">Private Key</h2>
             disabled>SAVE</button>
         </div>
         <div>
-          <p id="private-key-text-area-tooltip" class="text-green-500">ㅤ</p>
+          <p id="private-key-text-area-tooltip">ㅤ</p>
         </div>
       </div>
       <div class="h-80 flex flex-col flex-grow gap-y-2">
@@ -73,13 +72,13 @@ <h2 class="text-2xl font-bold">Public Key</h2>
             disabled>SAVE</button>
         </div>
         <div>
-          <p id="public-key-text-area-tooltip" class="text-green-500">ㅤ</p>
+          <p id="public-key-text-area-tooltip">ㅤ</p>
         </div>
       </div>
     </div>
   </main>
   <!-- You can also require other files to run in this process -->
-  <script src="./renderer.js"></script>
+  <script src="../js/renderer.js"></script>
 </body>
 
 </html>

renderer.js → assets/js/renderer.js

@@ -8,12 +8,13 @@ function change_buttons_disabled_state(state) {
 
 function remove_label_text(label_id) {
     document.getElementById(label_id).innerText = "ㅤ"
+    document.getElementById(label_id).classList = []
 }
 
 // Actions
-const generate_keys = async () => {
+const generateKeys = async () => {
     bits = document.getElementById('select-bits').value
-    let { privateKey, publicKey } = await window.utils.generate_keys(parseInt(bits))
+    let { privateKey, publicKey } = await window.utils.generateKeys(parseInt(bits))
     document.getElementById('private-key-text-area').value = privateKey
     document.getElementById('public-key-text-area').value = publicKey
 
@@ -22,9 +23,9 @@ const generate_keys = async () => {
 
 }
 
-const generate_public_key = async () => {
+const generatePublicKey = async () => {
     privateKey = document.getElementById('private-key-text-area').value
-    let publicKey = await window.utils.generate_public_key(privateKey)
+    let publicKey = await window.utils.generatePublicKey(privateKey)
     document.getElementById('public-key-text-area').value = publicKey
 
     if (publicKey) {
@@ -34,51 +35,63 @@ const generate_public_key = async () => {
     }
 }
 
-const copy_key = async (input_key) => {
+const copyKey = async (input_key) => {
     let lower_input_key = input_key.toLowerCase()
     let data = document.getElementById(`${lower_input_key}-key-text-area`).value
-    await window.utils.copy_key(data)
+    await window.utils.copyKey(data)
 
-    // Display tooltip for 3s
+    // Display tooltip for 5s
     let label_id = `${lower_input_key}-key-text-area-tooltip`
+    document.getElementById(label_id).classList.add('text-green-500');
     document.getElementById(label_id).innerText = `${input_key} Key copied`
-    setTimeout(function () { remove_label_text(label_id) }, 3000);
+    setTimeout(function () { remove_label_text(label_id) }, 5000);
 }
 
-const save_key = async (input_key) => {
-    let lower_input_key = input_key.toLowerCase()
-    let key = document.getElementById(`${lower_input_key}-key-text-area`).value
-    await window.utils.save_key(`${input_key}_key`, key)
+const saveKey = async (input_key) => {
+    let lower_input_key = input_key.toLowerCase();
+    let key = document.getElementById(`${lower_input_key}-key-text-area`).value;
+    result = await window.utils.saveKey(`${input_key}_key`, key);
+
+    let label_id = `${lower_input_key}-key-text-area-tooltip`
+    // Display error tooltip for 5s
+    if (result) {
+        tip_color = 'text-red-500';
+    } else {
+        tip_color = 'text-green-500';
+        result = `${input_key} Key saved`;
+    }
+    document.getElementById(label_id).classList.add(tip_color);
+    document.getElementById(label_id).innerText = result;
+    setTimeout(function () { remove_label_text(label_id) }, 5000);
 }
 
 // Event listeners
 const generateKeysButton = document.getElementById('generate-keys-button')
 generateKeysButton.addEventListener('click', function () {
-    generate_keys()
+    generateKeys()
 })
 
 const privateKeyTextArea = document.getElementById('private-key-text-area')
 privateKeyTextArea.addEventListener('input', function () {
-    generate_public_key()
+    generatePublicKey()
 })
 
 const privateKeyCopyButton = document.getElementById('private-key-copy-button')
 privateKeyCopyButton.addEventListener('click', function () {
-    copy_key("Private")
+    copyKey("Private")
 })
 
 const publicKeyCopyButton = document.getElementById('public-key-copy-button')
 publicKeyCopyButton.addEventListener('click', function () {
-    copy_key("Public")
+    copyKey("Public")
 })
 
 const privateKeySaveButton = document.getElementById('private-key-save-button')
 privateKeySaveButton.addEventListener('click', function () {
-    save_key("Private")
+    saveKey("Private")
 })
 
 const publicKeySaveButton = document.getElementById('public-key-save-button')
 publicKeySaveButton.addEventListener('click', function () {
-    save_key("Public")
+    saveKey("Public")
 })
-

config/electron-builder.js

@@ -3,7 +3,6 @@ const { notarize } = require('@electron/notarize')
 
 const config = {
   appId: 'rsa-key-generator',
-  icon: 'resources/icon.png',
   productName: 'RSAKeyGenerator',
   mac: {
     target: {