[19.0][IMP] [IMP] auth_api_key: generate API keys automatically

Author: yankinmax

auth_api_key/README.rst

@@ -70,6 +70,10 @@ The api key menu is available into Settings > Technical in debug mode.
 By default, when you create an API key, the key is saved into the
 database.
 
+You can either enter the key manually or use the Generate button next to
+the key field. The key field is masked by default, and the password
+widget provides a button to reveal the value when needed.
+
 If you want to manage them via serve environment settings use
 auth_api_key_server_env.
 

auth_api_key/models/auth_api_key.py

@@ -1,6 +1,8 @@
 # Copyright 2018 ACSONE SA/NV
 # License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
 
+import secrets
+
 from odoo import api, fields, models, tools
 from odoo.exceptions import AccessError, ValidationError
 from odoo.tools import consteq
@@ -12,7 +14,6 @@ class AuthApiKey(models.Model):
 
     name = fields.Char(required=True)
     key = fields.Char(
-        required=True,
         help="""The API key. Enter a dummy value in this field if it is
         obtained from the server environment configuration.""",
     )
@@ -31,6 +32,28 @@ class AuthApiKey(models.Model):
 
     _name_uniq = models.Constraint("unique(name)", "Api Key name must be unique.")
 
+    @api.model
+    def _generate_random_key_value(self):
+        """Return a random API key value.
+
+        The token is generated by the Odoo server instance so XML data and the
+        UI button can create a secret without storing any default value in the
+        module sources.
+        """
+        return secrets.token_urlsafe(32)
+
+    def generate_random_key(self, api_key_ids=None):
+        """Generate a key for records that do not have one yet.
+
+        :param list api_key_ids: optional record IDs, mainly used by XML data
+            function calls where the method is invoked on the model.
+        :return: True when the operation completed.
+        """
+        api_keys = self.browse(api_key_ids) if api_key_ids else self
+        for api_key in api_keys.filtered(lambda record: not record.key):
+            api_key.key = api_key._generate_random_key_value()
+        return True
+
     @api.model
     def _retrieve_api_key(self, key):
         return self.browse(self._retrieve_api_key_id(key))

auth_api_key/readme/CONFIGURE.md

@@ -2,5 +2,9 @@ The api key menu is available into Settings \> Technical in debug mode.
 By default, when you create an API key, the key is saved into the
 database.
 
+You can either enter the key manually or use the Generate button next to
+the key field. The key field is masked by default, and the password widget
+provides a button to reveal the value when needed.
+
 If you want to manage them via serve environment settings use
 auth_api_key_server_env.

auth_api_key/static/description/index.html

@@ -416,6 +416,9 @@ <h2><a class="toc-backref" href="#toc-entry-1">Configuration</a></h2>
 <p>The api key menu is available into Settings &gt; Technical in debug mode.
 By default, when you create an API key, the key is saved into the
 database.</p>
+<p>You can either enter the key manually or use the Generate button next to
+the key field. The key field is masked by default, and the password
+widget provides a button to reveal the value when needed.</p>
 <p>If you want to manage them via serve environment settings use
 auth_api_key_server_env.</p>
 </div>

auth_api_key/tests/test_auth_api_key.py

@@ -25,6 +25,34 @@ def setUpClass(cls, *args, **kwargs):
             {"name": "good", "user_id": cls.demo_user.id, "key": "api_key"}
         )
 
+    def test_00_generate_random_key_sets_empty_key(self):
+        """Test random key generation fills an empty API key."""
+        api_key = self.AuthApiKey.create(
+            {"name": "generated", "user_id": self.demo_user.id}
+        )
+        api_key.generate_random_key()
+        self.assertTrue(api_key.key)
+        self.assertEqual(
+            self.AuthApiKey._retrieve_uid_from_api_key(api_key.key),
+            self.demo_user.id,
+        )
+
+    def test_01_generate_random_key_keeps_existing_key(self):
+        """Test random key generation does not overwrite an existing key."""
+        api_key = self.AuthApiKey.create(
+            {"name": "existing", "user_id": self.demo_user.id, "key": "existing_key"}
+        )
+        api_key.generate_random_key()
+        self.assertEqual(api_key.key, "existing_key")
+
+    def test_02_generate_random_key_accepts_xml_style_ids(self):
+        """Test random key generation accepts the XML function-call argument."""
+        api_key = self.AuthApiKey.create(
+            {"name": "xml-style", "user_id": self.demo_user.id}
+        )
+        self.AuthApiKey.generate_random_key([api_key.id])
+        self.assertTrue(api_key.key)
+
     def test_lookup_key_from_db(self):
         demo_user = self.demo_user
         self.assertEqual(

auth_api_key/views/auth_api_key.xml

@@ -21,7 +21,18 @@
                     </h1>
                     <group name="config" colspan="4" col="4">
                         <field name="user_id" colspan="4" />
-                        <field name="key" colspan="4" password="True" />
+                        <label for="key" />
+                        <div class="o_row" colspan="3">
+                            <!-- The password widget masks the key and provides a reveal button. -->
+                            <field name="key" widget="password" />
+                            <button
+                                name="generate_random_key"
+                                string="Generate"
+                                type="object"
+                                class="btn-secondary"
+                                invisible="key"
+                            />
+                        </div>
                     </group>
                 </sheet>
             </form>