Summary

Add djblets.secrets, for AES crypto helpers and token generation.

Review Request #12369 — Created June 13, 2022 and submitted June 16, 2022, 1:58 p.m.

Information

Owner

chipx86

Repository

Djblets

Branch

release-3.x

Bugs

Depends On

Reviewers

Groups

djblets

People

Description

This introduces a new djblets.secrets module, which will be the home
of any future crypto/secrets-related work going forward.

This currently contains djblets.secrets.crypto, a collection of AES
encryption/decryption utilities that wrap the cryptography module.
This is a near-straight port of reviewboard.scmtools.crypto_utils,
with the exception that encrypt_password() has been renamed to
aes_encrypt_base64() and decrypt_password() has been renamed to
aes_decrypt_base64(). This is to help make it clear what form of
encryption and results are expected, and to allow room for other similar
utilities in the future.

cryptography is now a hard dependency of Djblets, rather than a soft
dependency, as Djblets-shipped code will be making use of this module in
the future.

Testing Done

Unit tests pass.

Commits

Summary	ID
Add djblets.secrets, for AES crypto helpers and token generation. This introduces a new `djblets.secrets` module, which will be the home of any future crypto/secrets-related work going forward. This currently contains `djblets.secrets.crypto`, a collection of AES encryption/decryption utilities that wrap the `cryptography` module. This is a near-straight port of `reviewboard.scmtools.crypto_utils`, with the exception that `encrypt_password()` has been renamed to `aes_encrypt_base64()` and `decrypt_password()` has been renamed to `aes_decrypt_base64()`. This is to help make it clear what form of encryption and results are expected, and to allow room for other similar utilities in the future. `cryptography` is now a hard dependency of Djblets, rather than a soft dependency, as Djblets-shipped code will be making use of this module in the future.	7557fa026d096cea9d10860121be9d07dbc137f5

Summary

Add djblets.secrets, for AES crypto helpers and token generation.

This introduces a new `djblets.secrets` module, which will be the home of any future crypto/secrets-related work going forward. This currently contains `djblets.secrets.crypto`, a collection of AES encryption/decryption utilities that wrap the `cryptography` module. This is a near-straight port of `reviewboard.scmtools.crypto_utils`, with the exception that `encrypt_password()` has been renamed to `aes_encrypt_base64()` and `decrypt_password()` has been renamed to `aes_decrypt_base64()`. This is to help make it clear what form of encryption and results are expected, and to allow room for other similar utilities in the future. `cryptography` is now a hard dependency of Djblets, rather than a soft dependency, as Djblets-shipped code will be making use of this module in the future.

7557fa026d096cea9d10860121be9d07dbc137f5

Issues

Description	From	Last Updated
Mind adding a module docstring to secrets/__init__.py and secrets/tests/__init__.py?	david	June 16, 2022, 1:51 p.m.
continuation line under-indented for visual indent Column: 38 Error code: E128	reviewbot	June 13, 2022, 7:01 p.m.

flake8 failed.

JSHint passed.

flake8

djblets/secrets/tests/test_crypto_utils.py (Diff revision 1)
The issue has been resolved. Show all issues
```
continuation line under-indented for visual indent

Column: 38
Error code: E128
```

Change Summary:

Fixed an alignment issue.

Commits:

	Summary	ID
	Add djblets.secrets, for AES crypto helpers and token generation. This introduces a new `djblets.secrets` module, which will be the home of any future crypto/secrets-related work going forward. This currently contains `djblets.secrets.crypto`, a collection of AES encryption/decryption utilities that wrap the `cryptography` module. This is a near-straight port of `reviewboard.scmtools.crypto_utils`, with the exception that `encrypt_password()` has been renamed to `aes_encrypt_base64()` and `decrypt_password()` has been renamed to `aes_decrypt_base64()`. This is to help make it clear what form of encryption and results are expected, and to allow room for other similar utilities in the future. `cryptography` is now a hard dependency of Djblets, rather than a soft dependency, as Djblets-shipped code will be making use of this module in the future.	51bc8cef8a71505d5c81c6e2ff5b8be2dea5aab5
	Add djblets.secrets, for AES crypto helpers and token generation. This introduces a new `djblets.secrets` module, which will be the home of any future crypto/secrets-related work going forward. This currently contains `djblets.secrets.crypto`, a collection of AES encryption/decryption utilities that wrap the `cryptography` module. This is a near-straight port of `reviewboard.scmtools.crypto_utils`, with the exception that `encrypt_password()` has been renamed to `aes_encrypt_base64()` and `decrypt_password()` has been renamed to `aes_decrypt_base64()`. This is to help make it clear what form of encryption and results are expected, and to allow room for other similar utilities in the future. `cryptography` is now a hard dependency of Djblets, rather than a soft dependency, as Djblets-shipped code will be making use of this module in the future.	be8fa78185e07949c2b8a45e83905988f6bb22f0

Diff:

Revision 2 (+784)

Show changes

	README.rst
	djblets/dependencies.py
	djblets/secrets/__init__.py
	djblets/secrets/crypto.py
	djblets/secrets/tests/__init__.py
	djblets/secrets/tests/test_crypto_utils.py
	docs/djblets/coderef/index.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:

Improve the organization of the new unit tests.

Commits:

	Summary	ID
	Add djblets.secrets, for AES crypto helpers and token generation. This introduces a new `djblets.secrets` module, which will be the home of any future crypto/secrets-related work going forward. This currently contains `djblets.secrets.crypto`, a collection of AES encryption/decryption utilities that wrap the `cryptography` module. This is a near-straight port of `reviewboard.scmtools.crypto_utils`, with the exception that `encrypt_password()` has been renamed to `aes_encrypt_base64()` and `decrypt_password()` has been renamed to `aes_decrypt_base64()`. This is to help make it clear what form of encryption and results are expected, and to allow room for other similar utilities in the future. `cryptography` is now a hard dependency of Djblets, rather than a soft dependency, as Djblets-shipped code will be making use of this module in the future.	be8fa78185e07949c2b8a45e83905988f6bb22f0
	Add djblets.secrets, for AES crypto helpers and token generation. This introduces a new `djblets.secrets` module, which will be the home of any future crypto/secrets-related work going forward. This currently contains `djblets.secrets.crypto`, a collection of AES encryption/decryption utilities that wrap the `cryptography` module. This is a near-straight port of `reviewboard.scmtools.crypto_utils`, with the exception that `encrypt_password()` has been renamed to `aes_encrypt_base64()` and `decrypt_password()` has been renamed to `aes_decrypt_base64()`. This is to help make it clear what form of encryption and results are expected, and to allow room for other similar utilities in the future. `cryptography` is now a hard dependency of Djblets, rather than a soft dependency, as Djblets-shipped code will be making use of this module in the future.	6279268285579aba9f4bde84d10e12c9f1c7701e

Diff:

Revision 3 (+824)

Show changes

	README.rst
	djblets/dependencies.py
	djblets/secrets/__init__.py
	djblets/secrets/crypto.py
	djblets/secrets/tests/__init__.py
	djblets/secrets/tests/test_crypto_utils.py
	docs/djblets/coderef/index.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

The issue has been resolved. Show all issues

Mind adding a module docstring to secrets/__init__.py and secrets/tests/__init__.py?

chipx86 June 16, 2022, 1:51 p.m.

Not sure what's best to put in the tests one. Let me know if there's wording you prefer.

Ship it!

```
Ship It!
```

Change Summary:

Added __init__.py module docstrings.

Commits:

	Summary	ID
	Add djblets.secrets, for AES crypto helpers and token generation. This introduces a new `djblets.secrets` module, which will be the home of any future crypto/secrets-related work going forward. This currently contains `djblets.secrets.crypto`, a collection of AES encryption/decryption utilities that wrap the `cryptography` module. This is a near-straight port of `reviewboard.scmtools.crypto_utils`, with the exception that `encrypt_password()` has been renamed to `aes_encrypt_base64()` and `decrypt_password()` has been renamed to `aes_decrypt_base64()`. This is to help make it clear what form of encryption and results are expected, and to allow room for other similar utilities in the future. `cryptography` is now a hard dependency of Djblets, rather than a soft dependency, as Djblets-shipped code will be making use of this module in the future.	6279268285579aba9f4bde84d10e12c9f1c7701e
	Add djblets.secrets, for AES crypto helpers and token generation. This introduces a new `djblets.secrets` module, which will be the home of any future crypto/secrets-related work going forward. This currently contains `djblets.secrets.crypto`, a collection of AES encryption/decryption utilities that wrap the `cryptography` module. This is a near-straight port of `reviewboard.scmtools.crypto_utils`, with the exception that `encrypt_password()` has been renamed to `aes_encrypt_base64()` and `decrypt_password()` has been renamed to `aes_decrypt_base64()`. This is to help make it clear what form of encryption and results are expected, and to allow room for other similar utilities in the future. `cryptography` is now a hard dependency of Djblets, rather than a soft dependency, as Djblets-shipped code will be making use of this module in the future.	7557fa026d096cea9d10860121be9d07dbc137f5

Diff:

Revision 4 (+844)

Show changes

	README.rst
	djblets/dependencies.py
	djblets/secrets/__init__.py
	djblets/secrets/crypto.py
	djblets/secrets/tests/__init__.py
	djblets/secrets/tests/test_crypto_utils.py
	docs/djblets/coderef/index.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-3.x (009c8e5)