Default bucket salt

[feiming]

Fixes #1535 and #881

• Add documentation.
• Add tests.
• Add a changelog entry.
• Add your name in the contributors file.
• If you changed the HTTP API, update the API_VERSION constant and add an API changelog entry in the docs
• If you added a new configuration setting, update the kinto.tpl file with it.

[feiming]

please add hacktoberfest-accepted label to this PR

[Natim]

Thank you for you work on this !

[Natim]

Do you mind adding a line in the documentation next to userid_hmac_secret (see docs/configuration/settings.rst)
I wonder if to be consistent we should call the config default_bucket_hmac_secret rather than default_bucket_id_salt

[feiming]

@Natim I've renamed all default_bucket_ID_salt to default_bucket_hmac_secret

[Natim]

I would add a test to see that when the default_bucket_hmac secret is not defined it uses the user_hmac one and that when it is defined it doesn't.

[feiming]

I would add a test to see that when the default_bucket_hmac secret is not defined it uses the user_hmac one and that when it is defined it doesn't.

I'm not too sure how to test it. Does something like this work?

    def test_default_bucket_hmac_secret_define(self):
        settings = {"default_bucket_hmac_secret":"bucket_id_salt","userid_hmac_secret":"secret"}
        secret = settings.get("default_bucket_hmac_secret", settings["userid_hmac_secret"])

        self.assertEqual(secret,"bucket_id_salt")

    def test_default_bucket_hmac_secret_not_define_fallback_to_userid_hmac_secret(self):
        settings = {"userid_hmac_secret":"super_secret"}
        secret = settings.get("default_bucket_hmac_secret", settings["userid_hmac_secret"])

        self.assertEqual(secret,"super_secret")

or something like this

    def test_default_bucket_hmac_secret_define(self):
        settings = self.get_app_settings(
            {"default_bucket_hmac_secret": "bucket_id_salt", "userid_hmac_secret": "secret"}
        )
        secret = settings.get("default_bucket_hmac_secret", settings["userid_hmac_secret"])

        self.assertEqual(secret, "bucket_id_salt")

    def test_default_bucket_hmac_secret_not_define_fallback_to_userid_hmac_secret(self):
        settings = self.get_app_settings({"userid_hmac_secret": "secret"})
        if "default_bucket_hmac_secret" in settings:
            del settings["default_bucket_hmac_secret"]
        secret = settings.get("default_bucket_hmac_secret", settings["userid_hmac_secret"])

        self.assertEqual(secret, "secret")

[leplatrem]

Maybe you could test that hmac_digest() is called with a value or another?

[feiming]

I had to mock hmac_secret because the default hmac_secret is an empty string. I also had to delete default_bucket_hmac_secret to test if it's not defined.

I hope this satisfy the test case.

[feiming]

@Natim I've added the test

I would add a test to see that when the default_bucket_hmac secret is not defined it uses the user_hmac one and that when it is defined it doesn't.

@Natim I've added the test