warpnet / django-nacl-fields Goto Github PK

A contributing section in the README would be nice. I made a short draft for you:

Contributing

Start a postgres Docker container for testing using:

docker run --rm -e POSTGRES_PASSWORD=postgres POSTGRES_DB=github_actions postgres

Then, you can run tests in another window using:

virtualenv env
source env/bin/activate
pip install '.[test]'
python manage.py test

Before you contribute, make sure you lint your code:

pip install '.[lint]'
flake8 --exclude .git,pycache,docs/conf.py,build,dist,env

After your code is done, feel free to open a PR.

Because of json parsing inside from_db_value method when loading data, you end up with the raw json string instead of the python object.

I wrote this as a fix, however there might be better ways.

class NaClJSONField(NaClFieldMixin, models.JSONField):
    def from_db_value(self, value, expression, connection, *args, **kwargs):
        if value is not None:
            value = bytes(value)
            if value != b'':
                value = self._crypto_box.decrypt(value)

            # JSONField does conversion from JSON to python object in this method.
            # so we need to extend the NaCl mixin
            value = force_text(value)
            if isinstance(expression, KeyTransform) and not isinstance(value, str):
                return value
            try:
                value = json.loads(value, cls=self.decoder)
            except json.JSONDecodeError:
                pass

            return super(NaClFieldMixin, self).to_python(value)

Hello,
How can I decrypt the information encrypted by this library manually ?
Thanks

Documentation generation on Read the Docs in broken. see: https://readthedocs.org/projects/django-nacl-fields/builds/12594899/.

Would it be possible for you to deploy a new release of the project to pypi? Those of us using Django 4 still has to install the project from git, which isn't ideal.

Thanks!

Action required on the Read the Docs integration due to a security update on the incoming webhook. The official blogpost Security update on incoming webhooks from integrations gives a full explanation about the required actions.

The currently used integration will be deprecated and support for it will be removed on January 31st, 2024.

The createkey commands requires an existing NACL_FIELDS_KEY before being able to create a new key.

Hi,

I noticed that there is a small incompatibility with Django 4 in the library. The deprecated function force_text needs to be replaced with force_str, as the function has been removed in Django 4. Other than that, the library seems to work fine with Django 4, so it should be simple to add official support to the library.

Let me know if you want me to create a PR.