@dsmrt/axiom-cli 0.0.3 → 0.0.4

package/lib/aws/credentials-provider.js

@@ -0,0 +1,74 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CachedCredentialProvider = exports.mfaCodeProvider = exports.roleAssumerCallable = exports.returnCredentialsFromAssumerole = void 0;
+const credential_providers_1 = require("@aws-sdk/credential-providers");
+const client_sts_1 = require("@aws-sdk/client-sts");
+const inquirer_1 = __importDefault(require("inquirer"));
+const cache_1 = __importDefault(require("../cache"));
+const CACHE_KEY_PREFIX = "axiom#aws-credentials";
+const cache = new cache_1.default();
+const returnCredentialsFromAssumerole = (creds) => {
+    return {
+        accessKeyId: `${creds.AccessKeyId}`,
+        secretAccessKey: `${creds.SecretAccessKey}`,
+        sessionToken: `${creds.SessionToken}`,
+    };
+};
+exports.returnCredentialsFromAssumerole = returnCredentialsFromAssumerole;
+const CachedCredentialViaProfileAndRegion = async (profile, region) => {
+    const cacheKeyName = `${CACHE_KEY_PREFIX}#${profile}`;
+    // check if there's a cache
+    const creds = cache.get(cacheKeyName);
+    // return the cache if there's something there
+    if (creds !== undefined) {
+        return async () => (0, exports.returnCredentialsFromAssumerole)(creds);
+    }
+    // else return
+    return (0, credential_providers_1.fromNodeProviderChain)({
+        profile,
+        roleAssumer: (0, exports.roleAssumerCallable)({
+            region: region ?? "us-east-1",
+            cacheKeyName: cacheKeyName,
+        }),
+        mfaCodeProvider: exports.mfaCodeProvider,
+    });
+};
+const roleAssumerCallable = (config) => {
+    return async (sourceCreds, params) => {
+        const command = new client_sts_1.AssumeRoleCommand(params);
+        const client = new client_sts_1.STSClient({
+            region: config.region,
+            credentials: sourceCreds,
+        });
+        const result = await client.send(command);
+        const creds = result.Credentials;
+        if (creds === undefined ||
+            creds?.AccessKeyId === undefined ||
+            creds?.SecretAccessKey === undefined ||
+            creds?.SessionToken === undefined) {
+            throw new Error("Unable to fetch credentials.");
+        }
+        // set cache
+        cache.set(config.cacheKeyName, creds, creds.Expiration);
+        return (0, exports.returnCredentialsFromAssumerole)(creds);
+    };
+};
+exports.roleAssumerCallable = roleAssumerCallable;
+const mfaCodeProvider = async (mfaSerial) => {
+    // return mfaSerial
+    const mfaCode = await inquirer_1.default.prompt({
+        name: "code",
+        message: `Enter MFA code for ${mfaSerial}: `,
+        type: "password",
+    });
+    return mfaCode.code;
+};
+exports.mfaCodeProvider = mfaCodeProvider;
+const CachedCredentialProvider = (config) => {
+    return CachedCredentialViaProfileAndRegion(config.profile, config.region);
+};
+exports.CachedCredentialProvider = CachedCredentialProvider;
+exports.default = CachedCredentialViaProfileAndRegion;

package/lib/bin/axiom.js

@@ -0,0 +1,26 @@
+#!/usr/bin/env node
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const yargs_1 = __importDefault(require("yargs"));
+const commands_1 = require("../commands");
+(0, yargs_1.default)(process.argv.slice(2))
+    .env("AXIOM")
+    .scriptName("axiom")
+    .option("config", {
+    alias: "c",
+    string: true,
+})
+    .command(new commands_1.Config())
+    .command(new commands_1.ParamsCommand())
+    .strict()
+    .usage(`
+Axiom - an AWS focused config cli
+
+USAGE:
+           $0 [options] <command>
+       `)
+    .demandCommand(1, "")
+    .alias("h", "help").argv;

package/lib/cache.d.ts

@@ -0,0 +1,11 @@
+export interface Item {
+    expires?: Date;
+    data: unknown;
+}
+export default class {
+    private cacheDir;
+    constructor(cacheDir?: string);
+    get<T = object>(name: string): T | undefined;
+    delete(name: string): void;
+    set(name: string, value: unknown, expires?: Date): void;
+}

package/lib/cache.js

@@ -0,0 +1,62 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const os_1 = __importDefault(require("os"));
+const fs_1 = __importDefault(require("fs"));
+const DEFAULT_DIRECTORY = `${os_1.default.homedir()}/.axiom/cache`;
+class default_1 {
+    cacheDir;
+    constructor(cacheDir = DEFAULT_DIRECTORY) {
+        this.cacheDir = cacheDir;
+    }
+    get(name) {
+        const file = `${this.cacheDir}/${name}`;
+        /**
+         * does this item exist?
+         */
+        if (!fs_1.default.existsSync(file)) {
+            return;
+        }
+        const buffer = fs_1.default.readFileSync(file);
+        /**
+         * fetch the item
+         */
+        const item = JSON.parse(buffer.toString());
+        /**
+         * Just return it
+         */
+        if (item.expires === undefined) {
+            return item.data;
+        }
+        item.expires = new Date(item.expires);
+        /**
+         * Exired?
+         * delete if so
+         */
+        if (item.expires < new Date()) {
+            this.delete(name);
+            return;
+        }
+        return item.data;
+    }
+    delete(name) {
+        fs_1.default.unlinkSync(`${this.cacheDir}/${name}`);
+    }
+    set(name, value, expires) {
+        if (!fs_1.default.existsSync(this.cacheDir)) {
+            fs_1.default.mkdirSync(this.cacheDir, {
+                recursive: true,
+                mode: 0o700,
+            });
+        }
+        fs_1.default.writeFileSync(`${this.cacheDir}/${name}`, JSON.stringify({
+            expires,
+            data: value,
+        }), {
+            mode: 0o600,
+        });
+    }
+}
+exports.default = default_1;

package/lib/commands/config.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Config = void 0;
+const axiom_config_1 = require("@dsmrt/axiom-config");
+class Config {
+    command = "config";
+    describe = "print the config";
+    handler = async (args) => {
+        console.log(await this.loadConfig(args));
+    };
+    loadConfig = async (args) => {
+        return (0, axiom_config_1.loadConfig)(args);
+    };
+}
+exports.Config = Config;

package/lib/commands/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./config"), exports);
+__exportStar(require("./params"), exports);

package/lib/commands/params/base.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParamsCommand = void 0;
+const _1 = require(".");
+class ParamsCommand {
+    command = "params";
+    describe = "Manage SSM parameters";
+    builder = (args) => {
+        args
+            .demandCommand()
+            .command(new _1.GetCommand())
+            .command(new _1.SetCommand())
+            .command(new _1.DeleteCommand());
+        return args;
+    };
+    handler = async () => {
+        // Is this needed?
+        console.log("👍");
+    };
+}
+exports.ParamsCommand = ParamsCommand;

package/lib/commands/params/delete.js

@@ -0,0 +1,63 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeleteCommand = void 0;
+const axiom_config_1 = require("@dsmrt/axiom-config");
+const inquirer_1 = __importDefault(require("inquirer"));
+const client_ssm_1 = require("@aws-sdk/client-ssm");
+const utils_1 = require("./utils");
+const credentials_provider_1 = require("../../aws/credentials-provider");
+const log = console.log;
+class DeleteCommand {
+    command = "delete <path>";
+    describe = "Delete SSM parameters";
+    client;
+    builder = (args) => {
+        const config = (0, axiom_config_1.loadConfig)();
+        args
+            .positional("path", {
+            type: "string",
+            describe: `Path to parameter. Supports absolute and relative paths.` +
+                `\nExample: "/root/myParam" or "service/secret" (which translates to, "${(0, utils_1.buildPath)(config, "service/secret")})`,
+            default: config.aws?.baseParameterPath,
+            demandOption: true,
+        })
+            .demandOption("path", "Path is required");
+        args.option("force", {
+            boolean: true,
+            default: false,
+            describe: "force delete parameter without prompt",
+            alias: "f",
+        });
+        return args;
+    };
+    handler = async (args) => {
+        const config = (0, axiom_config_1.loadConfig)({ env: args.env });
+        const path = (0, utils_1.buildPath)(args, args.path);
+        const client = new client_ssm_1.SSMClient({
+            region: config.aws?.region,
+            credentials: await (0, credentials_provider_1.CachedCredentialProvider)(config.aws),
+        });
+        if (path === args.aws.baseParameterPath) {
+            throw new Error(`Deleting the path (path: ${path}) that matches the base path (awsSsmParameterPath: ${args.awsSsmParameterPath}) is prohibited.`);
+        }
+        if (args.force !== true) {
+            const res = await inquirer_1.default.prompt({
+                type: "confirm",
+                name: "delete",
+                message: `Are you sure you want to delete '${path}'?`,
+            });
+            if (!res.delete) {
+                log("Doing nothing.");
+                return;
+            }
+        }
+        await client.send(new client_ssm_1.DeleteParameterCommand({
+            Name: path,
+        }));
+        log("👍");
+    };
+}
+exports.DeleteCommand = DeleteCommand;

package/lib/commands/params/get.js

@@ -0,0 +1,45 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetCommand = void 0;
+const axiom_config_1 = require("@dsmrt/axiom-config");
+const axiom_aws_sdk_1 = require("@dsmrt/axiom-aws-sdk");
+const client_ssm_1 = require("@aws-sdk/client-ssm");
+const credentials_provider_1 = require("../../aws/credentials-provider");
+const options_1 = require("../../options");
+const utils_1 = require("./utils");
+const chalk_1 = __importDefault(require("chalk"));
+class GetCommand {
+    command = "get [path]";
+    describe = "Get all parameters under the base path";
+    builder = (args) => {
+        const config = (0, axiom_config_1.loadConfig)();
+        args.options({ ...(0, options_1.commonOptions)(), ...(0, options_1.awsOptions)() });
+        args.positional("path", {
+            type: "string",
+            describe: `OPTIONAL path to parameter. Supports absolute and relative paths.` +
+                `\nExample: "/root/myParam" or "service/secret" (which translates to, "${(0, utils_1.buildPath)(config, "service/secret")})`,
+            // default: config.awsSsmParameterPath,
+        });
+        return args;
+    };
+    handler = async (args) => {
+        const config = (0, axiom_config_1.loadConfig)({ env: args.env });
+        const collection = new axiom_aws_sdk_1.ParameterCollection(config.aws?.baseParameterPath, new client_ssm_1.SSMClient({
+            region: config.aws.region,
+            credentials: await (0, credentials_provider_1.CachedCredentialProvider)({
+                profile: config.aws.profile,
+                region: config.aws.region,
+                baseParameterPath: config.aws.baseParameterPath,
+                account: config.aws.account,
+            }),
+        }));
+        const params = await collection.get();
+        params.forEach((parameter) => {
+            console.log(chalk_1.default.gray(parameter.Name?.replace(/\/([^/]+)$/, "/" + chalk_1.default.bold.green("$1"))), chalk_1.default.bold.white(parameter.Value));
+        });
+    };
+}
+exports.GetCommand = GetCommand;

package/lib/commands/params/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./base"), exports);
+__exportStar(require("./get"), exports);
+__exportStar(require("./set"), exports);
+__exportStar(require("./delete"), exports);

package/lib/commands/params/set.js

@@ -0,0 +1,76 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SetCommand = void 0;
+const axiom_config_1 = require("@dsmrt/axiom-config");
+const inquirer_1 = __importDefault(require("inquirer"));
+const client_ssm_1 = require("@aws-sdk/client-ssm");
+const credentials_provider_1 = require("../../aws/credentials-provider");
+const options_1 = require("../../options");
+const chalk_1 = __importDefault(require("chalk"));
+const utils_1 = require("./utils");
+class SetCommand {
+    command = "set <path> <value>";
+    describe = "Set all parameters under the base path";
+    builder = (args) => {
+        const config = (0, axiom_config_1.loadConfig)();
+        args.positional("path", {
+            type: "string",
+            describe: `Path to parameter. Supports absolute and relative paths.` +
+                `\nExample: "/root/myParam" or "service/secret" (which translates to, "${(0, utils_1.buildPath)(config, "service/secret")})`,
+        });
+        args.demandOption("path", "Path is required");
+        args.positional("value", {
+            type: "string",
+        });
+        args.demandOption("value", "Value is required");
+        args.option("force", {
+            boolean: true,
+            default: false,
+            describe: "force set parameter without prompt",
+            alias: "f",
+        });
+        args.option("secure", {
+            boolean: true,
+            default: true,
+            describe: "Save parameter as a secure string",
+        });
+        args.option("overwrite", {
+            boolean: true,
+            default: true,
+            describe: "Overwrite parameter if it already exists",
+        });
+        return args.options({
+            ...(0, options_1.commonOptions)(),
+            ...(0, options_1.awsOptions)(),
+        });
+    };
+    handler = async (args) => {
+        const config = (0, axiom_config_1.loadConfig)({ env: args.env });
+        if (args.force !== true) {
+            const res = await inquirer_1.default.prompt({
+                type: "confirm",
+                name: "setParam",
+                message: `Are you sure you want to set '${args.path}'?`,
+            });
+            if (!res.setParam) {
+                console.log("Doing nothing.");
+                return;
+            }
+        }
+        const client = new client_ssm_1.SSMClient({
+            region: config.aws.region,
+            credentials: await (0, credentials_provider_1.CachedCredentialProvider)(config.aws),
+        });
+        const params = await client.send(new client_ssm_1.PutParameterCommand({
+            Name: (0, utils_1.buildPath)(config, args.path),
+            Value: args.value,
+            Type: args.secure ? client_ssm_1.ParameterType.SECURE_STRING : client_ssm_1.ParameterType.STRING,
+            Overwrite: args.overwrite,
+        }));
+        console.log(chalk_1.default.green("Version: "), chalk_1.default.white.bold(params.Version));
+    };
+}
+exports.SetCommand = SetCommand;

package/lib/commands/params/utils.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildPath = void 0;
+const buildPath = (config, path) => {
+    if (path === undefined) {
+        return config.aws?.baseParameterPath;
+    }
+    // if it starts with a `/` use the absolute
+    if (/^\//.test(path)) {
+        return path;
+    }
+    // if it doens't, build off of the base path
+    return `${config.aws?.baseParameterPath.replace(/\/$/, "")}/${path}`;
+};
+exports.buildPath = buildPath;

package/lib/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./cache";
+export * from "./options";
+export * from "./commands";
+export * from "./bin/axiom";

package/lib/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./cache"), exports);
+__exportStar(require("./options"), exports);
+__exportStar(require("./commands"), exports);
+__exportStar(require("./bin/axiom"), exports);

package/lib/options.d.ts

@@ -0,0 +1,7 @@
+import { Options } from "yargs";
+export declare const commonOptions: () => {
+    [key: string]: Options;
+};
+export declare const awsOptions: () => {
+    [key: string]: Options;
+};

package/lib/options.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.awsOptions = exports.commonOptions = void 0;
+const commonOptions = () => {
+    return {
+        env: {
+            string: true,
+            desc: "Environment name like, prod, staging, dev, etc.",
+        },
+    };
+};
+exports.commonOptions = commonOptions;
+const awsOptions = () => {
+    return {
+        account: {
+            string: true,
+            desc: "AWS Account number like, 1243944546",
+        },
+        region: {
+            string: true,
+            desc: "AWS region like, us-east-1",
+        },
+        profile: {
+            string: true,
+            desc: "AWS configured profile",
+        },
+        baseParameterPath: {
+            string: true,
+            desc: "SSM parameter path base where configs like secrets and infrastucture managed items are set",
+        },
+    };
+};
+exports.awsOptions = awsOptions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dsmrt/axiom-cli",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "axiom cli for managing configs including secrets",
   "main": "lib/bin/axiom.js",
   "types": "lib/index.d.ts",
@@ -48,8 +48,8 @@
     "chalk": "^4.1.2",
     "inquirer": "^8.0.0",
     "yargs": "^17.7.2",
-    "@dsmrt/axiom-aws-sdk": "^0.0.3",
-    "@dsmrt/axiom-config": "^0.0.3"
+    "@dsmrt/axiom-config": "^0.0.4",
+    "@dsmrt/axiom-aws-sdk": "^0.0.4"
   },
   "scripts": {
     "lint": "eslint ./src/ --ext .ts",