@peculiar/acme-data-dynamodb

@peculiar/acme-data-dynamodb

• About
• Installation
• Usage
• Data structure
  • Account
  • Order
  • Certificate
  • Authorization
  • challenge

About

DynamoDB data module forAutomatic Certificate Management Environment (ACME) implementing RFC 8555 framework.

Installation

npm install @peculiar/acme-data-dynamodb

Usage

import * as data from "@peculiar/acme-data-dynamodb";
import { container } from "tsyringe";

// Register services in dependency injection container
data.DependencyInjection.register(container, {
  accessKeyId: "AWS_ACCESS_KEY_ID",
  secretAccessKey: "AWS_ACCESS_KEY",
  region: "local",
  endpoint: "http://localhost:8000",
});

Data structure

Account

{
  id:                   { "S": String },
  index:                { "S": "acct#" },
  parentId:             { "S": String }, //KeyThumbprint
  createdAt:            { "S": String },
  termsOfServiceAgreed: { "BOOL": Boolean },
  key: {
      "M": {
        key_ops: { "L": [{ "S": String }] },
        ext: { "BOOL": Boolean },
        kty: { "S": String },
        alg: { "S": String },
        e:   { "S": String },
        n:   { "S": String }
        ...others
      }
  },
  contacts: { "L": [{ "S": String }] },
  status: { "S": String }
},

Order

{
  id:             { "S": String },
  index:          { "S": "order#HashIdentifier#Data" },
  parentId:       { "S": String }, //AccountId
  identifier:     { "S": String },
  expires:        { "S": String },
  authorizations: { "L": [{ "S": String }] },
  status:         { "S": String }
  certificate: { "M": {
                  thumbprint: { "S": String },
                  id: { "S": String },
                  rawData: { "S": String },
                  status: { "S": String }
                }
  },
},

Certificate

{
  id:       { "S": String }, //CertificateThumbprint
  index:    { "S": "cert#" },
  parentId: { "S": String }, //OrderId
},

Authorization

{
  id:         { "S": String },
  index:      { "S": "authz#HashIdentifier#Data" },
  parentId:   { "S": String }, //AccountId
  status:     { "S": String }
  expires:    { "S": String },
  orders:     { "L": [{ "S": String }] }, //OrderId[]
  identifier: { "M": {
                  type: { "S": String },
                  value: { "S": String }
              }
  },
}

Challenge

{
  id:        { "S": String },
  index:     { "S": "challenge#" },
  parentId:  { "S": String }, //AuthorizationId
  validated: { "S": String },
  errorId:   { "S": String },
  type:      { "S": String },
  status:    { "S": String },
  token:     { "S": String }
}

Changelog

1.8.4 (2024-04-16)

Reverts

• Revert "chore(data): Extend account, externalAccount interfaces" (3e7d3af)