certificate-authority // @thefirstspine/certificate-authority

Self-signed certificate authority to automate & check secure layer for protected endpoints.

Philosophy

Here in TFS we strongly believe that services calls must be verified through private / public key pairs to ensure that the calls are from the good service: IPs are not sufficient for distributed service and DNS can be compromised.

Here's a model of what we engourage:

``
INCOMING REQUEST REQUEST GUARD PROTECTED RESOURCE
+---------------------------------+ +-----------------------+ +---------------------+
| | +-------> | | +--------> | |
| x-client-cert: dXAgdXAgZG93... | | Request validation | | Accessing protected |
| x-client-cert-encoding: base64 | | against a private key | | resources |
| | +-------> | | +--------> | |
+---------------------------------+ +-----------------------+ +---------------------+
INCOMING REQUEST REQUEST GUARD PROTECTED RESOURCE
`

Service documentation

$3

`bash
npm i @thefirstspine/certificate-authority
`

$3

As part of TFS Platform, the validation service will use environment variable.

| Environement key | Summary |
|-|-|
| PRIVATE_KEY | The pivate key to use to validate incoming requests |

$3

Global service to validate incoming requests. This service will use the environment variable PRIVATE_KEY to fetch the private key.

#### challenge

Challenge the certificate against the private key.

Synopsis: challenge(certificate: string): boolean

Params:

- certificate: string The decoded certificate provided by the request.

CLI documentation

Generates files to be validated in the services.

Example: npx @thefirstspine/certificate-authority -m=pair -k=private.key -c=public.cert

Options:

- -m Defines what's to be generated. "ask" or "pair". If not provided, a prompt will be displayed.
- -k The private key path. If not provided, a prompt will be displayed. If the file already exists, a confirmation will be asked.
- -c The public certificate path. If not provided, a prompt will be displayed. If the file already exists, a confirmation will be asked.

How to use

$3

`bash
npm run build
`

$3

`bash
npm run lint
`

$3

`bash
npm publish
``