serverless-kms-alias 2.0.4 → 2.2.0

package/.devcontainer/devcontainer.json

@@ -0,0 +1,16 @@
+{
+  "name": "serverless-kms-alias",
+  "features": {
+    "ghcr.io/devcontainers/features/node:1": {
+      "version": "lts"
+    }
+  },
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "EditorConfig.EditorConfig"
+      ]
+    }
+  },
+  "postCreateCommand": "npm install"
+}

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## 2.2.0 - 2023-02-08
+
+- Replace enable/disable by stage with `enabled`
+
+## 2.1.0 - 2023-02-08
+
+- Add configuration to enable for explicit stages. Fix #3
+- Update npms
+
 ## 2.0.4 - 2022-12-06
 
 - Update npms

package/README.md

@@ -18,7 +18,7 @@ service: foo
 provider:
   name: aws
   kmsKeyArn: '${kms:alias/aws/lambda}'
-  runtime: nodejs14.x
+  runtime: nodejs16.x
 
 plugins:
   - serverless-kms-alias
@@ -34,7 +34,7 @@ functions:
 service: foo
 provider:
   name: aws
-  runtime: nodejs14.x
+  runtime: nodejs16.x
 
 plugins:
   - serverless-kms-alias
@@ -44,3 +44,24 @@ functions:
     handler: foo.handler
     kmsKeyArn: '${kms:arn:aws:kms:${aws:region}:${aws:accountId}:alias/aws/lambda}'
 ```
+
+### Example - Disable the plugin
+
+```yaml
+service: foo
+provider:
+  name: aws
+  runtime: nodejs16.x
+
+plugins:
+  - serverless-kms-alias
+
+custom:
+  kmsAlias:
+    enabled: false
+
+functions:
+  foo:
+    handler: foo.handler
+    kmsKeyArn: '${kms:arn:aws:kms:${aws:region}:${aws:accountId}:alias/aws/lambda}'
+```

package/dist/index.js

@@ -8,6 +8,22 @@ class KmsAliasPlugin {
                     if (!/^(alias\/[a-zA-Z]|arn:aws:kms:[\w-]*:[\d]*:alias)/i.test(address)) {
                         throw new Error(`Expected variable in the form of 'kms:alias/foo'`);
                     }
+                    if (serverless.service?.custom?.kmsAlias?.enabled != null) {
+                        try {
+                            const isEnabled = serverless.service.custom.kmsAlias.enabled ? Boolean(JSON.parse(`${serverless.service.custom.kmsAlias.enabled}`.toLowerCase())) : false;
+                            if (!isEnabled) {
+                                serverless.cli.log(`Info: KMS Alias plugin not enabled`);
+                                return {
+                                    value: address,
+                                };
+                            }
+                        }
+                        catch (ex) {
+                            throw new Error(`Unable to get enabled configuration for kms alias.`, {
+                                cause: ex,
+                            });
+                        }
+                    }
                     serverless.cli.log(`Info: Fetching KMS key for alias: ${address}`);
                     const client = new client_kms_1.KMSClient({
                         ...serverless.providers.aws.getCredentials(),
@@ -34,4 +50,4 @@ class KmsAliasPlugin {
     }
 }
 module.exports = KmsAliasPlugin;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLG9EQUFvRTtBQWtCcEUsTUFBTSxjQUFjO0lBR2xCLFlBQW1CLFVBQThCO1FBQy9DLElBQUksQ0FBQyw2QkFBNkIsR0FBRztZQUNuQyxHQUFHLEVBQUU7Z0JBQ0gsS0FBSyxDQUFDLE9BQU8sQ0FBQyxFQUFFLE9BQU8sRUFBaUI7b0JBQ3RDLElBQUksQ0FBQyxvREFBb0QsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLEVBQUU7d0JBQ3ZFLE1BQU0sSUFBSSxLQUFLLENBQUMsa0RBQWtELENBQUMsQ0FBQztxQkFDckU7b0JBRUQsVUFBVSxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMscUNBQXFDLE9BQU8sRUFBRSxDQUFDLENBQUM7b0JBRW5FLE1BQU0sTUFBTSxHQUFHLElBQUksc0JBQVMsQ0FBQzt3QkFDM0IsR0FBRyxVQUFVLENBQUMsU0FBUyxDQUFDLEdBQUcsQ0FBQyxjQUFjLEVBQUU7d0JBQzVDLE1BQU0sRUFBRSxVQUFVLENBQUMsU0FBUyxDQUFDLEdBQUcsQ0FBQyxTQUFTLEVBQUU7cUJBQzdDLENBQUMsQ0FBQztvQkFDSCxNQUFNLE9BQU8sR0FBRyxJQUFJLCtCQUFrQixDQUFDO3dCQUNyQyxLQUFLLEVBQUUsT0FBTztxQkFDZixDQUFDLENBQUM7b0JBQ0gsTUFBTSxRQUFRLEdBQUcsTUFBTSxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFDO29CQUU1QyxNQUFNLFdBQVcsR0FBRyxRQUFRLENBQUMsV0FBVyxDQUFDO29CQUV6QyxJQUFJLENBQUMsV0FBVyxFQUFFO3dCQUNoQixNQUFNLElBQUksS0FBSyxDQUFDLDZDQUE2QyxPQUFPLEVBQUUsQ0FBQyxDQUFDO3FCQUN6RTtvQkFFRCxJQUFJLENBQUMsV0FBVyxDQUFDLEdBQUcsRUFBRTt3QkFDcEIsTUFBTSxJQUFJLEtBQUssQ0FBQywwQ0FBMEMsT0FBTyxFQUFFLENBQUMsQ0FBQztxQkFDdEU7b0JBRUQsVUFBVSxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsa0NBQWtDLE9BQU8sTUFBTSxXQUFXLENBQUMsR0FBRyxFQUFFLENBQUMsQ0FBQztvQkFFckYsT0FBTzt3QkFDTCxLQUFLLEVBQUUsV0FBVyxDQUFDLEdBQUc7cUJBQ3ZCLENBQUM7Z0JBQ0osQ0FBQzthQUNGO1NBQ0YsQ0FBQztJQUNKLENBQUM7Q0FDRjtBQUVELGlCQUFTLGNBQWMsQ0FBQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLG9EQUFvRTtBQWtCcEUsTUFBTSxjQUFjO0lBR2xCLFlBQW1CLFVBQThCO1FBQy9DLElBQUksQ0FBQyw2QkFBNkIsR0FBRztZQUNuQyxHQUFHLEVBQUU7Z0JBQ0gsS0FBSyxDQUFDLE9BQU8sQ0FBQyxFQUFFLE9BQU8sRUFBaUI7b0JBQ3RDLElBQUksQ0FBQyxvREFBb0QsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLEVBQUU7d0JBQ3ZFLE1BQU0sSUFBSSxLQUFLLENBQUMsa0RBQWtELENBQUMsQ0FBQztxQkFDckU7b0JBRUQsSUFBSSxVQUFVLENBQUMsT0FBTyxFQUFFLE1BQU0sRUFBRSxRQUFRLEVBQUUsT0FBTyxJQUFJLElBQUksRUFBRTt3QkFDekQsSUFBSTs0QkFDRixNQUFNLFNBQVMsR0FBRyxVQUFVLENBQUMsT0FBTyxDQUFDLE1BQU0sQ0FBQyxRQUFRLENBQUMsT0FBTyxDQUFDLENBQUMsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxHQUFHLFVBQVUsQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLFFBQVEsQ0FBQyxPQUFPLEVBQUUsQ0FBQyxXQUFXLEVBQUUsQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLEtBQUssQ0FBQzs0QkFDMUosSUFBSSxDQUFDLFNBQVMsRUFBRTtnQ0FDZCxVQUFVLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyxvQ0FBb0MsQ0FBQyxDQUFDO2dDQUN6RCxPQUFPO29DQUNMLEtBQUssRUFBRSxPQUFPO2lDQUNmLENBQUM7NkJBQ0g7eUJBQ0Y7d0JBQUMsT0FBTyxFQUFFLEVBQUU7NEJBQ1gsTUFBTSxJQUFJLEtBQUssQ0FBQyxvREFBb0QsRUFBRTtnQ0FDcEUsS0FBSyxFQUFFLEVBQUU7NkJBQ1YsQ0FBQyxDQUFDO3lCQUNKO3FCQUNGO29CQUVELFVBQVUsQ0FBQyxHQUFHLENBQUMsR0FBRyxDQUFDLHFDQUFxQyxPQUFPLEVBQUUsQ0FBQyxDQUFDO29CQUVuRSxNQUFNLE1BQU0sR0FBRyxJQUFJLHNCQUFTLENBQUM7d0JBQzNCLEdBQUcsVUFBVSxDQUFDLFNBQVMsQ0FBQyxHQUFHLENBQUMsY0FBYyxFQUFFO3dCQUM1QyxNQUFNLEVBQUUsVUFBVSxDQUFDLFNBQVMsQ0FBQyxHQUFHLENBQUMsU0FBUyxFQUFFO3FCQUM3QyxDQUFDLENBQUM7b0JBQ0gsTUFBTSxPQUFPLEdBQUcsSUFBSSwrQkFBa0IsQ0FBQzt3QkFDckMsS0FBSyxFQUFFLE9BQU87cUJBQ2YsQ0FBQyxDQUFDO29CQUNILE1BQU0sUUFBUSxHQUFHLE1BQU0sTUFBTSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQztvQkFFNUMsTUFBTSxXQUFXLEdBQUcsUUFBUSxDQUFDLFdBQVcsQ0FBQztvQkFFekMsSUFBSSxDQUFDLFdBQVcsRUFBRTt3QkFDaEIsTUFBTSxJQUFJLEtBQUssQ0FBQyw2Q0FBNkMsT0FBTyxFQUFFLENBQUMsQ0FBQztxQkFDekU7b0JBRUQsSUFBSSxDQUFDLFdBQVcsQ0FBQyxHQUFHLEVBQUU7d0JBQ3BCLE1BQU0sSUFBSSxLQUFLLENBQUMsMENBQTBDLE9BQU8sRUFBRSxDQUFDLENBQUM7cUJBQ3RFO29CQUVELFVBQVUsQ0FBQyxHQUFHLENBQUMsR0FBRyxDQUFDLGtDQUFrQyxPQUFPLE1BQU0sV0FBVyxDQUFDLEdBQUcsRUFBRSxDQUFDLENBQUM7b0JBRXJGLE9BQU87d0JBQ0wsS0FBSyxFQUFFLFdBQVcsQ0FBQyxHQUFHO3FCQUN2QixDQUFDO2dCQUNKLENBQUM7YUFDRjtTQUNGLENBQUM7SUFDSixDQUFDO0NBQ0Y7QUFFRCxpQkFBUyxjQUFjLENBQUMifQ==

package/dist/types/KmsAliasSettings.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiS21zQWxpYXNTZXR0aW5ncy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy90eXBlcy9LbXNBbGlhc1NldHRpbmdzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiIifQ==

package/dist/types/index.js

@@ -14,5 +14,6 @@ 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("./KmsAliasSettings"), exports);
 __exportStar(require("./ServerlessInstance"), exports);
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdHlwZXMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLHVEQUFxQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvdHlwZXMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7OztBQUFBLHFEQUFtQztBQUNuQyx1REFBcUMifQ==

package/package.json

@@ -1,34 +1,34 @@
 {
   "name": "serverless-kms-alias",
-  "version": "2.0.4",
+  "version": "2.2.0",
   "engines": {
     "node": ">= 14"
   },
   "dependencies": {
-    "@aws-sdk/client-kms": "^3.224.0"
+    "@aws-sdk/client-kms": "^3.266.1"
   },
   "devDependencies": {
     "@types/lodash": "4.14.191",
-    "@types/serverless": "3.12.9",
-    "@typescript-eslint/eslint-plugin": "5.45.1",
-    "@typescript-eslint/parser": "5.45.1",
-    "eslint": "8.29.0",
+    "@types/serverless": "3.12.10",
+    "@typescript-eslint/eslint-plugin": "5.51.0",
+    "@typescript-eslint/parser": "5.51.0",
+    "eslint": "8.33.0",
     "eslint-config-airbnb-base": "15.0.0",
     "eslint-config-airbnb-typescript": "17.0.0",
-    "eslint-config-prettier": "8.5.0",
-    "eslint-plugin-import": "2.26.0",
-    "eslint-plugin-jsdoc": "39.6.4",
+    "eslint-config-prettier": "8.6.0",
+    "eslint-plugin-import": "2.27.5",
+    "eslint-plugin-jsdoc": "39.8.0",
     "eslint-plugin-prettier": "4.2.1",
     "eslint-plugin-promise": "6.1.1",
-    "eslint-plugin-security": "1.5.0",
-    "husky": "8.0.2",
-    "lint-staged": "13.1.0",
-    "markdownlint-cli": "0.32.2",
+    "eslint-plugin-security": "1.7.1",
+    "husky": "8.0.3",
+    "lint-staged": "13.1.1",
+    "markdownlint-cli": "0.33.0",
     "npm-run-all": "4.1.5",
     "pinst": "3.0.0",
-    "prettier": "2.8.0",
-    "prettier-plugin-packagejson": "2.3.0",
-    "typescript": "4.9.3"
+    "prettier": "2.8.4",
+    "prettier-plugin-packagejson": "2.4.2",
+    "typescript": "4.9.5"
   },
   "main": "dist/index.js",
   "license": "MIT",

package/src/index.ts

@@ -27,6 +27,22 @@ class KmsAliasPlugin {
             throw new Error(`Expected variable in the form of 'kms:alias/foo'`);
           }
 
+          if (serverless.service?.custom?.kmsAlias?.enabled != null) {
+            try {
+              const isEnabled = serverless.service.custom.kmsAlias.enabled ? Boolean(JSON.parse(`${serverless.service.custom.kmsAlias.enabled}`.toLowerCase())) : false;
+              if (!isEnabled) {
+                serverless.cli.log(`Info: KMS Alias plugin not enabled`);
+                return {
+                  value: address,
+                };
+              }
+            } catch (ex) {
+              throw new Error(`Unable to get enabled configuration for kms alias.`, {
+                cause: ex,
+              });
+            }
+          }
+
           serverless.cli.log(`Info: Fetching KMS key for alias: ${address}`);
 
           const client = new KMSClient({

package/src/types/KmsAliasSettings.ts

@@ -0,0 +1,3 @@
+export interface KmsAliasSettings {
+  enabled?: string;
+}

package/src/types/ServerlessInstance.ts

@@ -1,5 +1,7 @@
 import type { AwsAuthInputConfig } from '@aws-sdk/middleware-signing/dist-types/configurations';
 
+import type { KmsAliasSettings } from './KmsAliasSettings';
+
 export interface ServerlessInstance {
   providers: {
     aws: {
@@ -7,6 +9,11 @@ export interface ServerlessInstance {
       getRegion(): string;
     };
   };
+  service: {
+    custom: {
+      kmsAlias?: KmsAliasSettings;
+    };
+  };
   cli: {
     log(str: string, entity?: string): void;
   };

package/src/types/index.ts

@@ -1 +1,2 @@
+export * from './KmsAliasSettings';
 export * from './ServerlessInstance';