dotsec 4.0.0-alpha.4 → 4.0.0-alpha.41

package/CHANGELOG.md

@@ -0,0 +1,184 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# [4.0.0-alpha.41](https://github.com/jpwesselink/dotsec/compare/v4.0.0-alpha.35...v4.0.0-alpha.41) (2023-09-28)
+
+**Note:** Version bump only for package dotsec
+
+
+
+
+
+# [4.0.0-alpha.35](https://github.com/jpwesselink/dotsec/compare/v4.0.0-alpha.34...v4.0.0-alpha.35) (2023-08-17)
+
+**Note:** Version bump only for package dotsec
+
+
+
+
+
+# [4.0.0-alpha.34](https://github.com/jpwesselink/dotsec/compare/v4.0.0-alpha.33...v4.0.0-alpha.34) (2023-08-17)
+
+
+### Bug Fixes
+
+* **dotsec:** removed default background color value ([365d774](https://github.com/jpwesselink/dotsec/commit/365d77470a5b33509d2c65ab20853c65a758be80))
+
+
+
+
+
+# [4.0.0-alpha.33](https://github.com/jpwesselink/dotsec/compare/v4.0.0-alpha.32...v4.0.0-alpha.33) (2023-08-17)
+
+
+### Bug Fixes
+
+* **dotsec:** booleans are hard ([e6624f4](https://github.com/jpwesselink/dotsec/commit/e6624f4f8ea46a2af154fb08903a8e02087f9b8e))
+
+
+
+
+
+# [4.0.0-alpha.32](https://github.com/jpwesselink/dotsec/compare/v4.0.0-alpha.31...v4.0.0-alpha.32) (2023-08-17)
+
+
+### Features
+
+* **dotsec:** docs, output background color options ([2dd7d74](https://github.com/jpwesselink/dotsec/commit/2dd7d747ac3cf55165ebc410eaceb584d3978849))
+
+
+
+
+
+# [4.0.0-alpha.31](https://github.com/jpwesselink/dotsec/compare/v4.0.0-alpha.30...v4.0.0-alpha.31) (2023-08-17)
+
+
+### Features
+
+* **dotsec:** docs, output background color options ([328445e](https://github.com/jpwesselink/dotsec/commit/328445e7c067a532ab27b3f0667aabd060ba5109))
+
+
+
+
+
+# [4.0.0-alpha.30](https://github.com/jpwesselink/dotsec/compare/v4.0.0-alpha.29...v4.0.0-alpha.30) (2023-08-17)
+
+**Note:** Version bump only for package dotsec
+
+
+
+
+
+# [4.0.0-alpha.29](https://github.com/jpwesselink/dotsec/compare/v4.0.0-alpha.28...v4.0.0-alpha.29) (2023-08-17)
+
+**Note:** Version bump only for package dotsec
+
+
+
+
+
+# [4.0.0-alpha.28](https://github.com/jpwesselink/dotsec/compare/v4.0.0-alpha.27...v4.0.0-alpha.28) (2023-08-17)
+
+**Note:** Version bump only for package dotsec
+
+
+
+
+
+# [4.0.0-alpha.25](https://github.com/jpwesselink/dotsec/compare/v4.0.0-alpha.24...v4.0.0-alpha.25) (2023-08-16)
+
+**Note:** Version bump only for package dotsec
+
+
+
+
+
+# [4.0.0-alpha.24](https://github.com/jpwesselink/dotsec/compare/v4.0.0-alpha.23...v4.0.0-alpha.24) (2023-08-16)
+
+**Note:** Version bump only for package dotsec
+
+
+
+
+
+# [4.0.0-alpha.22](https://github.com/jpwesselink/dotsec/compare/v4.0.0-alpha.21...v4.0.0-alpha.22) (2023-06-26)
+
+**Note:** Version bump only for package dotsec
+
+
+
+
+
+# [4.0.0-alpha.20](https://github.com/jpwesselink/dotsec/compare/v4.0.0-alpha.19...v4.0.0-alpha.20) (2023-06-02)
+
+**Note:** Version bump only for package dotsec
+
+
+
+
+
+# [4.0.0-alpha.18](https://github.com/jpwesselink/dotsec/compare/v4.0.0-alpha.17...v4.0.0-alpha.18) (2023-05-24)
+
+**Note:** Version bump only for package dotsec
+
+
+
+
+
+# [4.0.0-alpha.16](https://github.com/jpwesselink/dotsec/compare/v4.0.0-alpha.15...v4.0.0-alpha.16) (2023-05-22)
+
+**Note:** Version bump only for package dotsec
+
+
+
+
+
+# [4.0.0-alpha.14](https://github.com/jpwesselink/dotsec/compare/v4.0.0-alpha.13...v4.0.0-alpha.14) (2023-05-22)
+
+
+### Features
+
+* test ([f6398b0](https://github.com/jpwesselink/dotsec/commit/f6398b0f6a5829be93640421aba28dd73e012df4))
+
+
+
+
+
+# [4.0.0-alpha.13](https://github.com/jpwesselink/dotsec/compare/v4.0.0-alpha.12...v4.0.0-alpha.13) (2023-05-22)
+
+
+### Features
+
+* test ([535c584](https://github.com/jpwesselink/dotsec/commit/535c5844c06fda4b8bdd6d359e080f42033ef3a4))
+
+
+
+
+
+# [4.0.0-alpha.12](https://github.com/jpwesselink/dotsec/compare/v4.0.0-alpha.11...v4.0.0-alpha.12) (2023-05-22)
+
+
+### Features
+
+* test ([0694639](https://github.com/jpwesselink/dotsec/commit/06946392e67b69f6bf7e29417a29784871f6c0fe))
+
+
+
+
+
+# [4.0.0-alpha.11](https://github.com/jpwesselink/dotsec/compare/v4.0.0-alpha.10...v4.0.0-alpha.11) (2023-05-22)
+
+
+### Features
+
+* test ([fd59d34](https://github.com/jpwesselink/dotsec/commit/fd59d34bc06d148557b3a97dfc5869b239b4f08c))
+
+
+
+
+
+# [4.0.0-alpha.10](https://github.com/jpwesselink/dotsec/compare/v2.0.0-alpha.1...v4.0.0-alpha.10) (2023-05-22)
+
+**Note:** Version bump only for package dotsec

package/README.md

@@ -1,45 +1,15 @@
 # dotsec
 
-> consider the contents of this file a work in progress, and not yet ready for consumption
-> For now see --help for more information
+The solution offers encryption and decryption of `.env` files to and from `.sec` files, the ability to run a command with the values of a `.env`/`.sec` file in its environment. The AWS plugin adds the ability to push selected `.env`/`.sec` entries to AWS Systems Manager Parameter Store and AWS Secrets Manager.
 
-## Installation
-
-With AWS support:
-
-```sh
-npm install --save dotsec @dotsec/plugin-aws
-npx dotsec --plugin @dotsec/plugin-aws aws init
-```
+Currently there are two methods of encryption supported:
 
-With PKE support:
+- [`@dotsec/plugin-pke`](./packages/plugin-pke/README.md) - Using Public Key Encryption
+- [`@dotsec/plugin-aws`](./packages/plugin-aws/README.md) - Using AWS Key Management Service (AWS KMS)
 
-```sh
-npm install --save dotsec @dotsec/plugin-pke
-npx dotsec --plugin @dotsec/plugin-pke pke init
-```
+## Why?
 
-## Usage
-
-```sh
-npx dotsec --help
-```
-
-<!-- 
-`dotsec` is a tool for managing environment variables in a secure way. Encrypted environment variables are stored in a `.sec` file, and decrypted to a `.env` file. The `.sec` file can be committed to your repository. The `.env` file should not be committed to your repository.
-
-Next to encrypting and decrypting environment variables, `dotsec` can also be used to run a command with the values of a `.env` file in its environment, or with the values of a `.sec` file in its environment.
-
-As of writing this, `dotsec` supports the following encryption providers:
-
-- [AWS Key Management Service (AWS KMS)](https://aws.amazon.com/kms/)
-- [Public-key cryptography](https://en.wikipedia.org/wiki/Public-key_cryptography)
-
-When using the AWS plugin, dotsec can also push selected `.env`/`.sec` entries to AWS Systems Manager Parameter Store, and/or AWS Secrets Manager.
-
-## Table of Contents
-
-- [Installation](#installation)
+Environment variables are a great way to configure your application. However, they shouldn't be committed to your repository. This is because they often contain sensitive information, like passwords, API keys, and other secrets. This is where `dotsec` comes in. It allows you to encrypt your environment variables, and store them in a `.sec` file, which can be committed to your repository.
 
 ## Features
 
@@ -67,8 +37,89 @@ When using the AWS plugin, dotsec can also push selected `.env`/`.sec` entries t
 
 - For initialisation enough credentials for creating a KMS key, and alias.
 - For usage enough credentials for using the KMS key to encrypt and/or decrypt.
-- An AWS KMS key with an alias. -->
-<!-- 
+- An AWS KMS key with an alias.
+
+## Installation
+
+```sh
+npm install --save-dev dotsec @dotsec/plugin-aws
+```
+
+Add the folowing to dotsec.config.ts:
+
+```ts
+import { DotsecPluginAws } from "@dotsec/plugin-aws";
+import { DotsecConfig } from "dotsec";
+
+export const dotsec: DotsecConfig<{ plugins: DotsecPluginAws }> = {
+  defaults: {
+    encryptionEngine: "aws",
+  },
+};
+```
+
+## Usage
+
+If you don't have a .env file, create one:
+
+```sh
+I_CAN_SEE="clearly now"
+SINGING="in the rain"
+I_BLESS_THE_RAINS="down in Africa"
+```
+
+### Execute a command and use the values of a .env file in its environment
+
+```sh
+npx dotsec run --with-env node -e "console.log(process.env.I_BLESS_THE_RAINS)"
+```
+
+### Encrypt a .env file to .sec
+
+```sh
+npx dotsec encrypt
+```
+
+### Execute a command and use the values of a .sec file in its environment
+
+```sh
+npx dotsec run --with-sec node -e "console.log(process.env.I_BLESS_THE_RAINS)"
+```
+
+### Decrypt a .sec file to .env
+
+```sh
+npx dotsec decrypt
+```
+
+### Push selected .env entries to AWS Systems Manager Parameter Store
+
+Edit the `dotsec.config.ts` file. Add the following to the `aws` object:
+
+```ts
+{
+    ...
+    variables: {
+        "I_BLESS_THE_RAINS": {
+            push: {
+                aws: {
+                    ssm: true
+                }
+            }
+        }
+    }
+}
+```
+
+Run the following command:
+
+```sh
+npx dotsec push
+```
+
+> You might want to set AWS_REGION before running the command. If you don't, the region will be set to `eu-west-1`.
+
+<!--
 ## Usage
 
 If you don't have an AWS KMS key with an alias, you can create one with the following command:
@@ -85,15 +136,15 @@ Take not of the `KeyMetadata.KeyId` value, and create an alias for it:
 aws kms create-alias --alias-name alias/dotsec --target-key-id <key-id>
 ```
 
-### Execute a command and use the values of a `.env` file in its environment
+### Execute a command and use the values of a .env file in its environment
 
-Create a `.env` file if you don't have one already, and add some values:
+Create a .env file if you don't have one already, and add some values:
 
 ```sh
-echo "MY_FANCY_ENV_VAR='yes yes yallzies'\nHEY_HO='Let\'s go'" > `.env`
+echo "MY_FANCY_ENV_VAR='yes yes yallzies'\nHEY_HO='Let\'s go'" > .env
 ```
 
-The following command will create an encrypted version of the ``.env`` file, and store it in a file called ``.sec``. It will also create a config file called `dotsec.config.ts` which contains the KMS key alias, and AWS region. (Note: you don't have to add the key alias and region to the config file, you can also pass them as options to the dotsec aws sub command. See `dotsec init aws --help` for more information.)
+The following command will create an encrypted version of the `.env` file, and store it in a file called `.sec`. It will also create a config file called `dotsec.config.ts` which contains the KMS key alias, and AWS region. (Note: you don't have to add the key alias and region to the config file, you can also pass them as options to the dotsec aws sub command. See `dotsec init aws --help` for more information.)
 
 ```sh
 npx dotsec init --aws-region eu-west-1 [--aws-key-alias alias/dotsec]
@@ -101,28 +152,28 @@ npx dotsec init --aws-region eu-west-1 [--aws-key-alias alias/dotsec]
 
 The following files will be created:
 
-- ``.sec`` - The encrypted version of the ``.env`` file.
+- `.sec` - The encrypted version of the `.env` file.
 - `dotsec.config.ts` - The config file containing the KMS key alias and AWS region.
 
 ### Add files to Git
 
-Add the ``.sec`` and `dotsec.config.ts` files to your repository, and commit these accordingly.
+Add the `.sec` and `dotsec.config.ts` files to your repository, and commit these accordingly.
 
-### Run a process with your `.env` file
+### Run a process with your .env file
 
 ```sh
-npx dotsec run --env `.env` command env
+npx dotsec run --env .env command env
 ```
 
-### Run a process with your `.sec` file
+### Run a process with your .sec file
 
 ```sh
-npx dotsec run --sec `.sec` command env
+npx dotsec run --sec .sec command env
 ```
 
 For more options see `dotsec run --help`.
 
-### Decrypt a `.sec` file to `.env`
+### Decrypt a .sec file to .env
 
 ```sh
 npx dotsec decrypt
@@ -130,7 +181,7 @@ npx dotsec decrypt
 
 For more options see `dotsec decrypt --help`.
 
-### Encrypt a `.env` file to `.sec`
+### Encrypt a .env file to .sec
 
 ```sh
 npx dotsec encrypt
@@ -138,7 +189,7 @@ npx dotsec encrypt
 
 For more options see `dotsec encrypt --help`.
 
-### Push selected `.env`/`.sec` entries to AWS Systems Manager Parameter Store
+### Push selected .env/.sec entries to AWS Systems Manager Parameter Store
 
 Take your favorite editor, and edit the `dotsec.config.ts` file. Add the following to the `aws` object:
 
@@ -162,7 +213,7 @@ Take your favorite editor, and edit the `dotsec.config.ts` file. Add the followi
 npx dotsec push --env --to-aws-ssm
 ```
 
-### Push selected `.env`/`.sec` entries to AWS Secrets Manager
+### Push selected .env/.sec entries to AWS Secrets Manager
 
 Take your favorite editor, and edit the `dotsec.config.ts` file. Add the following to the `aws` object:
 
@@ -185,12 +236,12 @@ Take your favorite editor, and edit the `dotsec.config.ts` file. Add the followi
 ```sh
 npx dotsec push --env --to-aws-secrets-manager
 ``` -->
-<!-- 
+
 ### FAQ
 
-#### Is it safe to commit a ``.sec`` and `dotsec.config.ts` file alongside your code?
+#### Is it safe to commit a `.sec` and `dotsec.config.ts` file alongside your code?
 
-Yes it is. But it is up to you to make sure that access to the KMS key is restricted to the people who need to decrypt and/or encrypt the ``.sec`` file.
+Yes it is. But it is up to you to make sure that access to the KMS key is restricted to the people who need to decrypt and/or encrypt the `.sec` file.
 
 #### Should I use this in production?
 
@@ -201,15 +252,15 @@ We do, however, since this package is relatively new, I don't think you should.
 - Write some tests already.
 - Add support in-code use like `dotsec.config()`
 - Add support for Node preload modules like `node -r dotsec/register index.js`
-- Add watcher for ``.env`` file changes and automatically encrypt
+- Add watcher for `.env` file changes and automatically encrypt
 - Write guide on postinstall for npm/yarn/pnpm
-- Add chunking for encoding larger files with assymetric keys. Current limit is 4kb.
+- ~~Add chunking for encoding larger files with assymetric keys. Current limit is 4kb.~~
 - Add support for other encryption SDKs like GCP KMS, Azure Key Vault, etc.
-- Split up dotsec package in multiple packages, one for each encryption SDK.
+- ~~Split up dotsec package in multiple packages, one for each encryption SDK.~~
 - Add support for pulling entries to GitHub actions secrets.
 
 ## Limitations
 
 - The only supported encryption SDK is the AWS Encryption SDK. For now.
-- Assymetric keys are supported, but the encrypted file size is limited to the payload size of the key. Until chunking is implemented, that is.
-- AWS Secrets Manager secrets which are marked for deletion **cannot** be updated until the deletion is complete. As of writing, the minimum deletion time is 7 days. This means that if you want to update a deleted AWS Secrets Manager secret, you have to wait at least 7 days before you can update it again. This is a limitation of AWS Secrets Manager, not dotsec -->
+- ~~Assymetric keys are supported, but the encrypted file size is limited to the payload size of the key. Until chunking is implemented, that is.~~
+- AWS Secrets Manager secrets which are marked for deletion **cannot** be updated until the deletion is complete. As of writing, the minimum deletion time is 7 days. This means that if you want to update a deleted AWS Secrets Manager secret, you have to wait at least 7 days before you can update it again. This is a limitation of AWS Secrets Manager, not dotsec

package/bin/dotsec.js

@@ -1,3 +1,3 @@
 #!/usr/bin/env node
 
-require('../dist/cli'); 
+require("../dist/cli");