Serverless Kms Grants

homepage icon https://github.com/deep-security/serverless-kms-grants
Follow @deep-security

Tracked

NPM Downloads Last Month
78
Issues
0
Stars
1
Forks
0
Watchers
1
Watch Star Fork Issue Download License NPM Build Status Coverage Status Contributors

Repo README Contents:

Serverless KMS Grants Plugin

serverless npm version

A plugin for the Serverless Framework which creates AWS KMS grants for a Lambda function permission to use a KMS key. The plugin creates an AWS KMS grant as part of the serverless deploy function, and revokes it as part of the serverless remove function. You can also run it from the command line.

Table of Contents

Install

  1. Add serverless-kms-grants plugin to your package.json: npm install --save-dev serverless-kms-grants

  2. Add the serverless-kms-grants plugin to the serverless.yml file:

    plugins:
        - serverless-kms-grants
    
  3. To verify that the plugin was added successfully, run serverless in your command line. The plugin should show up under the “Plugins” section as ServerlessKmsGrants.

Usage

Configure the AWS KMS key id and lambdaArn for the plugin in serverless.yml:

custom:
    kmsGrants:
        kmsKeyId: <KMS Key Identifier>
        lambdaRoleArn: <Lambda Arn>

For example:

custom:
    kmsGrants:
        kmsKeyId: "alias/myKey"
        lambdaRoleArn: "arn:aws:iam::000123456789:role/myservice-mystage-us-east-1-lambdaRole"

Run Locally

The plugin can be used locally via the command line to create or revoke an AWS KMS Grant (using the specification in serverless.yml above)

serverless createKmsGrant
serverless revokeKmsGrant

You can specify the stage by adding --stage <stage> to the end as follows:

serverless createKmsGrant --stage myStage
serverless revokeKmsGrant --stage myStage

Support

This is an Open Source community project. Project contributors may be able to help, depending on their time and availability. Please be specific about what you’re trying to do, your system, and steps to reproduce the problem.

For bug reports or feature requests, please open an issue. You are welcome to contribute.

Official support from Trend Micro is not available. Individual contributors may be Trend Micro employees, but are not official support.

Contribute

We accept contributions from the community. To submit changes:

  1. Fork this repository.
  2. Create a new feature branch.
  3. Make your changes.
  4. Submit a pull request with an explanation of your changes or additions.

We will review and work with you to release the code.