diff --git a/README.md b/README.md index c2a654b..ac4d1f0 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,27 @@ This repo provides a list of utility modules for common crypto operations. ### AES -* factory methods to construct an AES-GCM cipher with a 96-bit nonce from the input raw key bytes -* encrypt & decrypt methods, the output ciphertext is prefixed with the random nonce. + +- factory methods to construct an AES-GCM cipher with a 96-bit nonce from the input raw key bytes +- encrypt & decrypt methods, the output ciphertext is prefixed with the random nonce. ### DES -* factory methods to construct an DES or 3DES cipher from the raw key bytes or hex text -* encrypt & decrypt methods -* verify the constructed cipher against the check value + +- factory methods to construct an DES or 3DES cipher from the raw key bytes or hex text +- encrypt & decrypt methods +- verify the constructed cipher against the check value ### KEK Bundle -Helper class to construct a 3DES key encryption key from a list of components. + +Helper class to construct a 3DES key encryption key from a list of components. ### RSA + Common RSA operations for plugins to use. Targeting use-cases such as key extraction. +## Release + +Releases are triggered with tagging. A sample release cycle would follow the following steps: + +1. Bump the version in `VERSION.txt` file and push to master +2. Execute `git tag x.x.x` (same as the version in VERSION.txt) and `git push origin x.x.x` diff --git a/VERSION.txt b/VERSION.txt new file mode 100644 index 0000000..169f19b --- /dev/null +++ b/VERSION.txt @@ -0,0 +1 @@ +1.11.0 \ No newline at end of file