win-cliauth 1.0.0

package/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) <2022>, <Pedro Lucas Magalhães de Oliveira>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,42 @@
+# win-cliauth
+
+win-cliauth is a CLI-based OTP (One-Time Password) authenticator management tool for Windows.
+
+## Installation
+
+You can install win-cliauth globally using npm:
+
+npm install -g win-cliauth
+
+## Usage
+
+win-cliauth provides a command-line interface for managing OTP (One-Time Password) authenticators. It supports the following commands:
+
+- `add <name> <secret-key>`: Adds an authenticator with the given name and secret key.
+- `add <name> <secret-key> --replace`: Adds an authenticator, replacing an existing one with the same name.
+- `remove <name>`: Removes the authenticator with the specified name.
+- `get <name>`: Retrieves the token from the authenticator with the specified name.
+- `get <name> --steam`: Retrieves the token from the Steam authenticator with the specified name.
+- `get <name> --clipboard`: Retrieves the token and adds it to the clipboard.
+- `list`: Lists all registered authenticators.
+- `list --showsecret`: Lists all registered authenticators, including the secret keys.
+
+To use win-cliauth, open a terminal or command prompt and run one of the commands listed above.
+
+For detailed information on the available commands and options, you can run:
+
+win-cliauth --help
+
+## Security
+
+- win-cliauth encrypts the secret keys using the `ConvertTo-SecureString` command in PowerShell before storing them on disk.
+- The secret keys are stored in an encrypted file in the user's data directory, protected by the user's operating system.
+- Please note that the encrypted file can only be read on the same Windows user account where it was created. It may not be readable on other user accounts or operating systems.
+
+## Contributing
+
+Contributions are welcome! If you find any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request on [GitHub](https://github.com/pedrolucasmag/win-cliauth).
+
+## License
+
+This project is licensed under the BSD-3-Clause License. See the LICENSE file for details.

package/dist/main.js

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+"use strict";
+/*
+Copyright (c) <2022>, <Pedro Lucas Magalhães de Oliveira>
+All rights reserved.
+
+This source code is licensed under the BSD-style license found in the
+LICENSE file in the root directory of this source tree.
+ */
+var _a, _b;
+Object.defineProperty(exports, "__esModule", { value: true });
+const commands_1 = require("./src/commands");
+const pshell_1 = require("./src/pshell");
+(_b = (_a = (0, pshell_1.decrypt)().stdout) === null || _a === void 0 ? void 0 : _a.on('data', (data) => {
+    const svcs = JSON.parse(data);
+    (0, commands_1.handleCommands)(svcs);
+})) !== null && _b !== void 0 ? _b : false;

package/dist/src/auth.js

@@ -0,0 +1,48 @@
+"use strict";
+/*
+Copyright (c) <2022>, <Pedro Lucas Magalhães de Oliveira>
+All rights reserved.
+
+This source code is licensed under the BSD-style license found in the
+LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listAuth = exports.removeAuth = exports.addAuth = exports.getAuth = void 0;
+const child_process_1 = require("child_process");
+const otplib_1 = require("otplib");
+const steam_totp_1 = require("steam-totp");
+const pshell_1 = require("./pshell");
+function getToken({ key, steam }) {
+    return steam ? (0, steam_totp_1.generateAuthCode)(key) : otplib_1.authenticator.generate(key);
+}
+function getAuth({ objAuth, svc, clipboard, steam }) {
+    const skey = objAuth[`${svc}`];
+    if (skey) {
+        const token = getToken({ key: skey, steam: steam });
+        if (clipboard)
+            (0, child_process_1.spawn)('clip').stdin.end(token);
+        return console.info(token);
+    }
+    return console.info(`${svc} not found.`);
+}
+exports.getAuth = getAuth;
+function addAuth({ objAuth, svc, sk, replace }) {
+    if (objAuth[`${svc}`] && !replace)
+        return console.info(`${svc} already exists, adds --replace to overwrite it.`);
+    objAuth[`${svc}`] = String(sk);
+    (0, pshell_1.encrypt)({ str: JSON.stringify(objAuth) });
+    return console.info(`${svc} added!`);
+}
+exports.addAuth = addAuth;
+function removeAuth({ objAuth, svc }) {
+    if (!objAuth[`${svc}`])
+        return console.info(`${svc} not found.`);
+    delete objAuth[`${svc}`];
+    (0, pshell_1.encrypt)({ str: JSON.stringify(objAuth) });
+    return console.info(`${svc} removed!`);
+}
+exports.removeAuth = removeAuth;
+function listAuth({ objAuth, showsecret }) {
+    return showsecret ? console.table(objAuth) : console.table(Object.keys(objAuth));
+}
+exports.listAuth = listAuth;

package/dist/src/commands.js

@@ -0,0 +1,52 @@
+"use strict";
+/*
+Copyright (c) <2022>, <Pedro Lucas Magalhães de Oliveira>
+All rights reserved.
+
+This source code is licensed under the BSD-style license found in the
+LICENSE file in the root directory of this source tree.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleCommands = void 0;
+const yargs_1 = __importDefault(require("yargs"));
+const helpers_1 = require("yargs/helpers");
+const auth_1 = require("./auth");
+function handleCommands(objAuth) {
+    return (0, yargs_1.default)((0, helpers_1.hideBin)(process.argv))
+        .scriptName("win-cliauth")
+        .command('add <name> <secret-key>', 'adds authenticator with given secret key.', (y) => y.options({
+        'replace': {
+            description: "forces replacement of existing service.",
+            require: false
+        },
+    }), (argv) => (0, auth_1.addAuth)({ objAuth, svc: argv.name, sk: argv.secretKey, replace: argv.replace }))
+        .command('remove <name>', 'removes the given <name> authenticator.', {}, (argv) => (0, auth_1.removeAuth)({ objAuth, svc: argv.name }))
+        .command('get <name>', 'gets the token from service <name> (for steam guard, add --steam)', (y) => y.options({
+        'steam': {
+            description: "gets token from steam authenticator.",
+            required: false
+        },
+        'clipboard': {
+            description: 'adds authenticator code to clipboard',
+            required: false
+        }
+    }), (argv) => {
+        (0, auth_1.getAuth)({ objAuth, svc: argv.name, clipboard: argv.clipboard, steam: argv.steam });
+    })
+        .command('list', 'Prints out the list of authenticators.', (y) => y.options({
+        'showsecret': {
+            description: "Prints out the list with secret keys",
+            require: false
+        },
+    }), (argv) => (0, auth_1.listAuth)({ objAuth, showsecret: argv.showsecret }))
+        .wrap(null)
+        .showHelpOnFail(true)
+        .demandCommand()
+        .recommendCommands()
+        .strict()
+        .parse();
+}
+exports.handleCommands = handleCommands;

package/dist/src/pshell.js

@@ -0,0 +1,39 @@
+"use strict";
+/*
+Copyright (c) <2022>, <Pedro Lucas Magalhães de Oliveira>
+All rights reserved.
+
+This source code is licensed under the BSD-style license found in the
+LICENSE file in the root directory of this source tree.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decrypt = exports.encrypt = void 0;
+const child_process_1 = require("child_process");
+function pshell({ cmd }) {
+    return (0, child_process_1.exec)(cmd, { shell: 'powershell.exe' });
+}
+function encrypt({ str }) {
+    return pshell({
+        cmd: `
+    $keyPath = "$($env:AppData)/win-cliauth/keys"
+    if (!(Test-Path "$keyPath")) { New-Item -Path $keyPath -Force } 
+    $secureString = ConvertTo-SecureString '${str}' -AsPlainText -Force
+    $encrypted = ConvertFrom-SecureString -SecureString $secureString
+    $encrypted > $keyPath
+  `
+    });
+}
+exports.encrypt = encrypt;
+function decrypt() {
+    return pshell({
+        cmd: `
+    $keyPath = "$($env:AppData)/win-cliauth/keys"
+    if (!(Test-Path "$keyPath")) { '{}' } 
+    else {
+      $secureString = Get-Content $keyPath | ConvertTo-SecureString
+      $decrypted = [System.Runtime.InteropServices.Marshal]::PtrToStringAuto([System.Runtime.InteropServices.Marshal]::SecureStringToBSTR($secureString))
+      $decrypted
+      }`
+    });
+}
+exports.decrypt = decrypt;

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "win-cliauth",
+  "version": "1.0.0",
+  "description": "win-cliauth is a CLI-based OTP (One-Time Password) authenticator management tool for Windows.",
+  "author": "Pedro Lucas Magalhães <pedrolucasmag@gmail.com>",
+  "license": "BSD-3-Clause",
+  "scripts": {
+    "build": "tsc",
+    "prepack": "tsc"
+  },
+  "bin": {
+    "win-cliauth": "./dist/main.js"
+  },
+  "repository": "github:pedrolucasmag/win-cliauth",
+  "files": [
+    "dist",
+    "LICENSE",
+    "!dist/keys"
+  ],
+  "devDependencies": {
+    "@types/node": "^18.11.10",
+    "@types/steam-totp": "^2.1.0",
+    "@types/yargs": "^17.0.10",
+    "@typescript-eslint/eslint-plugin": "^5.33.1",
+    "@typescript-eslint/parser": "^5.33.1",
+    "eslint": "^8.22.0"
+  },
+  "os": [
+    "win32"
+  ],
+  "dependencies": {
+    "otplib": "^12.0.1",
+    "steam-totp": "^2.1.2",
+    "yargs": "^17.5.1"
+  }
+}