Searchable=True field sometimes works, most of the time does not.

[jsandovalcardona]

I have the following code:

class ApiKey(models.Model):
    tenant = models.ForeignKey(Tenant, null=False, on_delete=models.CASCADE)
    key = secured_fields.EncryptedCharField(
        max_length=constants.CHARFIELD_SIZE_128, unique=True, editable=False, searchable=True
    )

    def save(self, *args, **kwargs):
        if not self.key:
            self.key = secrets.token_urlsafe(64)
        super().save(*args, **kwargs)

And the following code:

    api_key = request.headers.get("x-api-key")
    print("api_key", api_key)
    print(ApiKey.objects.first().key == api_key)  # This returns True
    provider_api_key = ApiKey.objects.get(key=api_key)  # This fails, most of the time, with self.model.DoesNotExist. But, sometimes it works!!

Am I doing something wrong? I set the field to searchable. I was thinking with that would be enough to filter and get by it. But, it's not working for me. Why does it works sometimes?

[dtleal]

@jsandovalcardona Interesting, I'm commenting to see the solution.

[earthpyy]

Hello all, I'll try to reproduce the case and will keep you updates. Thanks!

[dejafait]

@earthpyy May I ask, did you eventually find time to reproduce?

My team is considering using this django-secured-fields library to store, search and guarantee unicity of a sensitive personal ID for 10M users but this single unresolved issue is making us very hesitant.

Unfortunately the main library django-fernet-encrypted-fields does not support search nor unicity because it does not implement the second column hashed_field, only the main column encrypted_field.

[michaelroethlisberger-findependent]

secrets.token_urlsafe(64) can but does not have to contain underscores.
The get does not work for strings that contain a underscore. At least I found that out with encrypted email fields that I used.

So that explains the while it only fails sometimes, but it would be nice if the search would function for stuff with underscores...