serverless-kms-alias 2.0.3 → 2.1.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.1.0 - 2023-02-08
+
+- Add configuration to enable for explicit stages. Fix #3
+- Update npms
+
+## 2.0.4 - 2022-12-06
+
+- Update npms
+
 ## 2.0.3 - 2022-10-11
 
 - 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,26 @@ functions:
     handler: foo.handler
     kmsKeyArn: '${kms:arn:aws:kms:${aws:region}:${aws:accountId}:alias/aws/lambda}'
 ```
+
+### Example - Enable for specific stages
+
+```yaml
+service: foo
+provider:
+  name: aws
+  runtime: nodejs16.x
+
+plugins:
+  - serverless-kms-alias
+
+custom:
+  kmsAlias:
+    stages:
+      # list of stages for which the plugin should be enabled
+      - production
+
+functions:
+  foo:
+    handler: foo.handler
+    kmsKeyArn: '${kms:arn:aws:kms:${aws:region}:${aws:accountId}:alias/aws/lambda}'
+```

package/dist/index.js

@@ -1,13 +1,27 @@
 "use strict";
 const client_kms_1 = require("@aws-sdk/client-kms");
 class KmsAliasPlugin {
-    constructor(serverless) {
+    constructor(serverless, options) {
         this.configurationVariablesSources = {
             kms: {
                 async resolve({ address }) {
                     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?.stages?.length) {
+                        const stage = options?.stage || serverless.config?.stage || serverless.service?.provider?.stage;
+                        if (stage) {
+                            if (!serverless.service.custom.kmsAlias.stages.includes(stage)) {
+                                serverless.cli.log(`Info: KMS Alias plugin not enabled for stage`);
+                                return {
+                                    value: address,
+                                };
+                            }
+                        }
+                        else {
+                            serverless.cli.log(`Warn: Unable to determine stage for KMS alias`);
+                        }
+                    }
                     serverless.cli.log(`Info: Fetching KMS key for alias: ${address}`);
                     const client = new client_kms_1.KMSClient({
                         ...serverless.providers.aws.getCredentials(),
@@ -34,4 +48,4 @@ class KmsAliasPlugin {
     }
 }
 module.exports = KmsAliasPlugin;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLG9EQUFvRTtBQWtCcEUsTUFBTSxjQUFjO0lBR2xCLFlBQW1CLFVBQThCO1FBQy9DLElBQUksQ0FBQyw2QkFBNkIsR0FBRztZQUNuQyxHQUFHLEVBQUU7Z0JBQ0gsS0FBSyxDQUFDLE9BQU8sQ0FBQyxFQUFFLE9BQU8sRUFBaUI7b0JBQ3RDLElBQUksQ0FBQyxvREFBb0QsQ0FBQyxJQUFJLENBQUMsT0FBTyxDQUFDLEVBQUU7d0JBQ3ZFLE1BQU0sSUFBSSxLQUFLLENBQUMsa0RBQWtELENBQUMsQ0FBQztxQkFDckU7b0JBRUQsVUFBVSxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMscUNBQXFDLE9BQU8sRUFBRSxDQUFDLENBQUM7b0JBRW5FLE1BQU0sTUFBTSxHQUFHLElBQUksc0JBQVMsQ0FBQzt3QkFDM0IsR0FBRyxVQUFVLENBQUMsU0FBUyxDQUFDLEdBQUcsQ0FBQyxjQUFjLEVBQUU7d0JBQzVDLE1BQU0sRUFBRSxVQUFVLENBQUMsU0FBUyxDQUFDLEdBQUcsQ0FBQyxTQUFTLEVBQUU7cUJBQzdDLENBQUMsQ0FBQztvQkFDSCxNQUFNLE9BQU8sR0FBRyxJQUFJLCtCQUFrQixDQUFDO3dCQUNyQyxLQUFLLEVBQUUsT0FBTztxQkFDZixDQUFDLENBQUM7b0JBQ0gsTUFBTSxRQUFRLEdBQUcsTUFBTSxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFDO29CQUU1QyxNQUFNLFdBQVcsR0FBRyxRQUFRLENBQUMsV0FBVyxDQUFDO29CQUV6QyxJQUFJLENBQUMsV0FBVyxFQUFFO3dCQUNoQixNQUFNLElBQUksS0FBSyxDQUFDLDZDQUE2QyxPQUFPLEVBQUUsQ0FBQyxDQUFDO3FCQUN6RTtvQkFFRCxJQUFJLENBQUMsV0FBVyxDQUFDLEdBQUcsRUFBRTt3QkFDcEIsTUFBTSxJQUFJLEtBQUssQ0FBQywwQ0FBMEMsT0FBTyxFQUFFLENBQUMsQ0FBQztxQkFDdEU7b0JBRUQsVUFBVSxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsa0NBQWtDLE9BQU8sTUFBTSxXQUFXLENBQUMsR0FBRyxFQUFFLENBQUMsQ0FBQztvQkFFckYsT0FBTzt3QkFDTCxLQUFLLEVBQUUsV0FBVyxDQUFDLEdBQUc7cUJBQ3ZCLENBQUM7Z0JBQ0osQ0FBQzthQUNGO1NBQ0YsQ0FBQztJQUNKLENBQUM7Q0FDRjtBQUVELGlCQUFTLGNBQWMsQ0FBQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBLG9EQUFvRTtBQWtCcEUsTUFBTSxjQUFjO0lBR2xCLFlBQW1CLFVBQThCLEVBQUUsT0FBMEI7UUFDM0UsSUFBSSxDQUFDLDZCQUE2QixHQUFHO1lBQ25DLEdBQUcsRUFBRTtnQkFDSCxLQUFLLENBQUMsT0FBTyxDQUFDLEVBQUUsT0FBTyxFQUFpQjtvQkFDdEMsSUFBSSxDQUFDLG9EQUFvRCxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsRUFBRTt3QkFDdkUsTUFBTSxJQUFJLEtBQUssQ0FBQyxrREFBa0QsQ0FBQyxDQUFDO3FCQUNyRTtvQkFFRCxJQUFJLFVBQVUsQ0FBQyxPQUFPLEVBQUUsTUFBTSxFQUFFLFFBQVEsRUFBRSxNQUFNLEVBQUUsTUFBTSxFQUFFO3dCQUN4RCxNQUFNLEtBQUssR0FBRyxPQUFPLEVBQUUsS0FBSyxJQUFJLFVBQVUsQ0FBQyxNQUFNLEVBQUUsS0FBSyxJQUFJLFVBQVUsQ0FBQyxPQUFPLEVBQUUsUUFBUSxFQUFFLEtBQUssQ0FBQzt3QkFDaEcsSUFBSSxLQUFLLEVBQUU7NEJBQ1QsSUFBSSxDQUFDLFVBQVUsQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLFFBQVEsQ0FBQyxNQUFNLENBQUMsUUFBUSxDQUFDLEtBQUssQ0FBQyxFQUFFO2dDQUM5RCxVQUFVLENBQUMsR0FBRyxDQUFDLEdBQUcsQ0FBQyw4Q0FBOEMsQ0FBQyxDQUFDO2dDQUNuRSxPQUFPO29DQUNMLEtBQUssRUFBRSxPQUFPO2lDQUNmLENBQUM7NkJBQ0g7eUJBQ0Y7NkJBQU07NEJBQ0wsVUFBVSxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsK0NBQStDLENBQUMsQ0FBQzt5QkFDckU7cUJBQ0Y7b0JBRUQsVUFBVSxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMscUNBQXFDLE9BQU8sRUFBRSxDQUFDLENBQUM7b0JBRW5FLE1BQU0sTUFBTSxHQUFHLElBQUksc0JBQVMsQ0FBQzt3QkFDM0IsR0FBRyxVQUFVLENBQUMsU0FBUyxDQUFDLEdBQUcsQ0FBQyxjQUFjLEVBQUU7d0JBQzVDLE1BQU0sRUFBRSxVQUFVLENBQUMsU0FBUyxDQUFDLEdBQUcsQ0FBQyxTQUFTLEVBQUU7cUJBQzdDLENBQUMsQ0FBQztvQkFDSCxNQUFNLE9BQU8sR0FBRyxJQUFJLCtCQUFrQixDQUFDO3dCQUNyQyxLQUFLLEVBQUUsT0FBTztxQkFDZixDQUFDLENBQUM7b0JBQ0gsTUFBTSxRQUFRLEdBQUcsTUFBTSxNQUFNLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFDO29CQUU1QyxNQUFNLFdBQVcsR0FBRyxRQUFRLENBQUMsV0FBVyxDQUFDO29CQUV6QyxJQUFJLENBQUMsV0FBVyxFQUFFO3dCQUNoQixNQUFNLElBQUksS0FBSyxDQUFDLDZDQUE2QyxPQUFPLEVBQUUsQ0FBQyxDQUFDO3FCQUN6RTtvQkFFRCxJQUFJLENBQUMsV0FBVyxDQUFDLEdBQUcsRUFBRTt3QkFDcEIsTUFBTSxJQUFJLEtBQUssQ0FBQywwQ0FBMEMsT0FBTyxFQUFFLENBQUMsQ0FBQztxQkFDdEU7b0JBRUQsVUFBVSxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsa0NBQWtDLE9BQU8sTUFBTSxXQUFXLENBQUMsR0FBRyxFQUFFLENBQUMsQ0FBQztvQkFFckYsT0FBTzt3QkFDTCxLQUFLLEVBQUUsV0FBVyxDQUFDLEdBQUc7cUJBQ3ZCLENBQUM7Z0JBQ0osQ0FBQzthQUNGO1NBQ0YsQ0FBQztJQUNKLENBQUM7Q0FDRjtBQUVELGlCQUFTLGNBQWMsQ0FBQyJ9

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/ServerlessOptions.js

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

package/dist/types/index.js

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

package/package.json

@@ -1,34 +1,34 @@
 {
   "name": "serverless-kms-alias",
-  "version": "2.0.3",
+  "version": "2.1.0",
   "engines": {
     "node": ">= 14"
   },
   "dependencies": {
-    "@aws-sdk/client-kms": "^3.186.0"
+    "@aws-sdk/client-kms": "^3.266.1"
   },
   "devDependencies": {
-    "@types/lodash": "4.14.186",
-    "@types/serverless": "3.12.8",
-    "@typescript-eslint/eslint-plugin": "5.40.0",
-    "@typescript-eslint/parser": "5.40.0",
-    "eslint": "8.25.0",
+    "@types/lodash": "4.14.191",
+    "@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.3.6",
+    "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.0.1",
-    "eslint-plugin-security": "1.5.0",
-    "husky": "8.0.1",
-    "lint-staged": "13.0.3",
-    "markdownlint-cli": "0.32.2",
+    "eslint-plugin-promise": "6.1.1",
+    "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.7.1",
-    "prettier-plugin-packagejson": "2.3.0",
-    "typescript": "4.8.4"
+    "prettier": "2.8.4",
+    "prettier-plugin-packagejson": "2.4.2",
+    "typescript": "4.9.5"
   },
   "main": "dist/index.js",
   "license": "MIT",

package/src/index.ts

@@ -1,6 +1,6 @@
 import { DescribeKeyCommand, KMSClient } from '@aws-sdk/client-kms';
 
-import type { ServerlessInstance } from './types';
+import type { ServerlessInstance, ServerlessOptions } from './types';
 
 interface ResolveParams {
   address: string;
@@ -19,7 +19,7 @@ interface ServerlessVariableSource {
 class KmsAliasPlugin {
   public configurationVariablesSources: Record<string, ServerlessVariableSource>;
 
-  public constructor(serverless: ServerlessInstance) {
+  public constructor(serverless: ServerlessInstance, options: ServerlessOptions) {
     this.configurationVariablesSources = {
       kms: {
         async resolve({ address }: ResolveParams): Promise<ResolveResult> {
@@ -27,6 +27,20 @@ class KmsAliasPlugin {
             throw new Error(`Expected variable in the form of 'kms:alias/foo'`);
           }
 
+          if (serverless.service?.custom?.kmsAlias?.stages?.length) {
+            const stage = options?.stage || serverless.config?.stage || serverless.service?.provider?.stage;
+            if (stage) {
+              if (!serverless.service.custom.kmsAlias.stages.includes(stage)) {
+                serverless.cli.log(`Info: KMS Alias plugin not enabled for stage`);
+                return {
+                  value: address,
+                };
+              }
+            } else {
+              serverless.cli.log(`Warn: Unable to determine stage for KMS alias`);
+            }
+          }
+
           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 {
+  stages?: string[];
+}

package/src/types/ServerlessInstance.ts

@@ -1,12 +1,25 @@
 import type { AwsAuthInputConfig } from '@aws-sdk/middleware-signing/dist-types/configurations';
 
+import type { KmsAliasSettings } from './KmsAliasSettings';
+
 export interface ServerlessInstance {
+  config?: {
+    stage?: string;
+  };
   providers: {
     aws: {
       getCredentials(): AwsAuthInputConfig['credentials'];
       getRegion(): string;
     };
   };
+  service: {
+    provider: {
+      stage?: string;
+    };
+    custom: {
+      kmsAlias?: KmsAliasSettings;
+    };
+  };
   cli: {
     log(str: string, entity?: string): void;
   };

package/src/types/ServerlessOptions.ts

@@ -0,0 +1,3 @@
+export interface ServerlessOptions {
+  stage?: string;
+}

package/src/types/index.ts

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