certificate-recipient
v0.3.0
Published
Recipient of certificates delivered by Certificate Manager Service
Downloads
22
Maintainers
Readme
certificate-recipient
Stability: 1 - Experimental
Recipient of certificates delivered by Certificate Manager Service.
Contents
Installation
The intended usage of certificate-recipient
is as part of capability-cli certificate-manager config aws
functionality.
To install locally:
npm install certificate-recipient
Usage
This module is intended to be executed as an AWS Lambda function as part of capability-cli certificate-manager config aws
functionality that configures this module as well as grants the requisite permissions and creates required supporting infrastructure.
Tests
npm test
Documentation
Recipient.handle(message, context, callback)
message
: Object Message from Certificate Manager Service delivering a certificate.certificate
: String Certificate public key, including intermediate certificate chain, in PEM format.domain
: String Domain name for which the certificate is issued.key
: String Certificate private key in PEM format.
context
: Object AWS Lambda context.callback
: Function(error, resp) => {}
AWS Lambda callback.
Stores the certificate
and key
in configured S3 bucket. Each file is stored in the certificate
or key
folder in a file named with reverse domain
. For example, if the domain
is my.domain.example.com
and the S3 bucket is my-certs-bucket
, then certificate
content will be in s3:///my-certs-bucket/certificate/com.example.domain.my
and key
content will be in s3:///my-certs-bucket/key/com.example.domain.my
.
Errors
BadRequest
Inbound request message does not match schema.
ServiceUnavailable
The certificate recipient is unavailable, please try again soon.
Releases
Policy
We follow the semantic versioning policy (semver.org) with a caveat:
Given a version number MAJOR.MINOR.PATCH, increment the:
MAJOR version when you make incompatible API changes, MINOR version when you add functionality in a backwards-compatible manner, and PATCH version when you make backwards-compatible bug fixes.
caveat: Major version zero is a special case indicating development version that may make incompatible API changes without incrementing MAJOR version.