datasette-secrets 0.1a0__tar.gz

datasette_secrets-0.1a0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

datasette_secrets-0.1a0/PKG-INFO

@@ -0,0 +1,160 @@
+Metadata-Version: 2.1
+Name: datasette-secrets
+Version: 0.1a0
+Summary: Manage secrets such as API keys for use with other Datasette plugins
+Author: Datasette
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/datasette/datasette-secrets
+Project-URL: Changelog, https://github.com/datasette/datasette-secrets/releases
+Project-URL: Issues, https://github.com/datasette/datasette-secrets/issues
+Project-URL: CI, https://github.com/datasette/datasette-secrets/actions
+Classifier: Framework :: Datasette
+Classifier: License :: OSI Approved :: Apache Software License
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: datasette>=1.0a13
+Requires-Dist: cryptography
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-asyncio; extra == "test"
+
+# datasette-secrets
+
+[![PyPI](https://img.shields.io/pypi/v/datasette-secrets.svg)](https://pypi.org/project/datasette-secrets/)
+[![Changelog](https://img.shields.io/github/v/release/datasette/datasette-secrets?include_prereleases&label=changelog)](https://github.com/datasette/datasette-secrets/releases)
+[![Tests](https://github.com/datasette/datasette-secrets/actions/workflows/test.yml/badge.svg)](https://github.com/datasette/datasette-secrets/actions/workflows/test.yml)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/datasette/datasette-secrets/blob/main/LICENSE)
+
+Manage secrets such as API keys for use with other Datasette plugins
+
+This plugin requires a **Datasette 1.0 alpha** release.
+
+Datasette plugins sometimes need access to secrets, such as API keys used to integrate with tools hosted outside of Datasette - things like geocoders or hosted AI language models.
+
+This plugin provides ways to configure those secrets:
+
+- Secrets can be configured using environment variables, such as `DATASETTE_SECRETS_OPENAI_API_KEY`
+- Secrets can be stored, encrypted, in a SQLite database table which administrator users can then update through the Datasette web interface
+
+## Installation
+
+Install this plugin in the same environment as Datasette.
+```bash
+datasette install datasette-secrets
+```
+## Configuration
+
+First you will need to generate an encryption key for this plugin to use. Run this command:
+
+```bash
+datasette secrets generate-encryption-key
+```
+Store this secret somewhere secure. It will be used to both encrypt and decrypt secrets stored by this plugin - if you lose it you will not be able to recover your secrets.
+
+Configure the plugin with these these two plugin settings:
+
+```yaml
+plugins:
+  datasette-secrets:
+    encryption_key:
+      $env: DATASETTE_SECRETS_ENCRYPTION_KEY
+    database: name_of_database
+```
+The `encryption_key` setting should be set to the encryption key you generated earlier. You can store it in an environment variable if you prefer.
+
+`database` is the name of the database that the encrypted keys should be stored in. Omit this setting to use the internal database.
+
+### Using the internal database
+
+While the secrets stored in the `datasette_secrets` table are encrypted, we still recommend hiding that table from view.
+
+One way to do that is to keep the table in Datasette's internal database, which is invisible to all users, even users who are logged in.
+
+By default, the internal database is an in-memory database that is reset when Datasette restarts. This is no good for persistent secret storage!
+
+Instead, you should switch Datasette to using an on-disk internal database. You can do this by starting Datasette with the `--internal` option:
+```bash
+datasette data.db --internal internal.db
+```
+Your secrets will be stored in the `datasette_secrets` table in that database file.
+
+### Permissions
+
+Only users with the `manage-secrets` permission will have access to manage secrets through the Datasette web interface.
+
+You can grant that permission to the `root` user (or the user with an ID of your choice) by including this in your `datasette.yml` file:
+
+```yaml
+permissions:
+  manage-secrets:
+    id: root
+```
+Then start Datasette like this (with `--root` to get a URL to login as the root user):
+```bash
+datasette data.db --internal internal.db -c datasette.yml --root
+```
+Alternatively, use the `-s` option to set that setting without creating a configuration file:
+```bash
+datasette data.db --internal internal.db \
+  -s permissions.manage-secrets.id root \
+  --root
+```
+
+## Usage
+
+users with the `manage-secrets` permission will see a new "Manage secrets" link in the Datasette navigation menu. This interface can also be accessed at `/-/secrets`.
+
+## For plugin authors
+
+Plugins can depend on this plugin if they want to implement secrets.
+
+`datasette-secrets` to the `dependencies` list in `pyproject.toml`.
+
+Then declare the name and description of any secrets you need using the `register_secrets()` plugin hook:
+
+```python
+from datasette import hookimpl
+from datasette_secrets import Secret
+
+@hookimpl
+def register_secrets():
+    return [
+        Secret(
+            "OPENAI_API_KEY",
+            'An OpenAI API key. Get them from <a href="https://platform.openai.com/api-keys">here</a>.',
+        ),
+    ]
+```
+The hook can take an optional `datasette` argument. It can return a list or an `async def` function that, when awaited, returns a list.
+
+The list should consist of `Secret()` instances, each with a name and an optional description. The description can contain HTML.
+
+To obtain the current value of the secret, use the `await get_secret()` method:
+
+```python
+from datasette_secrets import get_secret
+
+secret = await get_secret(datasette, "OPENAI_API_KEY")
+```
+If the Datasette administrator set a `DATASETTE_SECRETS_OPENAI_API_KEY` environment variable, that will be returned.
+
+Otherwise the encrypted value in the database table will be decrypted and returned - or `None` if there is no configured secret.
+
+
+## Development
+
+To set up this plugin locally, first checkout the code. Then create a new virtual environment:
+```bash
+cd datasette-secrets
+python3 -m venv venv
+source venv/bin/activate
+```
+Now install the dependencies and test dependencies:
+```bash
+pip install -e '.[test]'
+```
+To run the tests:
+```bash
+pytest
+```

datasette_secrets-0.1a0/README.md

@@ -0,0 +1,139 @@
+# datasette-secrets
+
+[![PyPI](https://img.shields.io/pypi/v/datasette-secrets.svg)](https://pypi.org/project/datasette-secrets/)
+[![Changelog](https://img.shields.io/github/v/release/datasette/datasette-secrets?include_prereleases&label=changelog)](https://github.com/datasette/datasette-secrets/releases)
+[![Tests](https://github.com/datasette/datasette-secrets/actions/workflows/test.yml/badge.svg)](https://github.com/datasette/datasette-secrets/actions/workflows/test.yml)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/datasette/datasette-secrets/blob/main/LICENSE)
+
+Manage secrets such as API keys for use with other Datasette plugins
+
+This plugin requires a **Datasette 1.0 alpha** release.
+
+Datasette plugins sometimes need access to secrets, such as API keys used to integrate with tools hosted outside of Datasette - things like geocoders or hosted AI language models.
+
+This plugin provides ways to configure those secrets:
+
+- Secrets can be configured using environment variables, such as `DATASETTE_SECRETS_OPENAI_API_KEY`
+- Secrets can be stored, encrypted, in a SQLite database table which administrator users can then update through the Datasette web interface
+
+## Installation
+
+Install this plugin in the same environment as Datasette.
+```bash
+datasette install datasette-secrets
+```
+## Configuration
+
+First you will need to generate an encryption key for this plugin to use. Run this command:
+
+```bash
+datasette secrets generate-encryption-key
+```
+Store this secret somewhere secure. It will be used to both encrypt and decrypt secrets stored by this plugin - if you lose it you will not be able to recover your secrets.
+
+Configure the plugin with these these two plugin settings:
+
+```yaml
+plugins:
+  datasette-secrets:
+    encryption_key:
+      $env: DATASETTE_SECRETS_ENCRYPTION_KEY
+    database: name_of_database
+```
+The `encryption_key` setting should be set to the encryption key you generated earlier. You can store it in an environment variable if you prefer.
+
+`database` is the name of the database that the encrypted keys should be stored in. Omit this setting to use the internal database.
+
+### Using the internal database
+
+While the secrets stored in the `datasette_secrets` table are encrypted, we still recommend hiding that table from view.
+
+One way to do that is to keep the table in Datasette's internal database, which is invisible to all users, even users who are logged in.
+
+By default, the internal database is an in-memory database that is reset when Datasette restarts. This is no good for persistent secret storage!
+
+Instead, you should switch Datasette to using an on-disk internal database. You can do this by starting Datasette with the `--internal` option:
+```bash
+datasette data.db --internal internal.db
+```
+Your secrets will be stored in the `datasette_secrets` table in that database file.
+
+### Permissions
+
+Only users with the `manage-secrets` permission will have access to manage secrets through the Datasette web interface.
+
+You can grant that permission to the `root` user (or the user with an ID of your choice) by including this in your `datasette.yml` file:
+
+```yaml
+permissions:
+  manage-secrets:
+    id: root
+```
+Then start Datasette like this (with `--root` to get a URL to login as the root user):
+```bash
+datasette data.db --internal internal.db -c datasette.yml --root
+```
+Alternatively, use the `-s` option to set that setting without creating a configuration file:
+```bash
+datasette data.db --internal internal.db \
+  -s permissions.manage-secrets.id root \
+  --root
+```
+
+## Usage
+
+users with the `manage-secrets` permission will see a new "Manage secrets" link in the Datasette navigation menu. This interface can also be accessed at `/-/secrets`.
+
+## For plugin authors
+
+Plugins can depend on this plugin if they want to implement secrets.
+
+`datasette-secrets` to the `dependencies` list in `pyproject.toml`.
+
+Then declare the name and description of any secrets you need using the `register_secrets()` plugin hook:
+
+```python
+from datasette import hookimpl
+from datasette_secrets import Secret
+
+@hookimpl
+def register_secrets():
+    return [
+        Secret(
+            "OPENAI_API_KEY",
+            'An OpenAI API key. Get them from <a href="https://platform.openai.com/api-keys">here</a>.',
+        ),
+    ]
+```
+The hook can take an optional `datasette` argument. It can return a list or an `async def` function that, when awaited, returns a list.
+
+The list should consist of `Secret()` instances, each with a name and an optional description. The description can contain HTML.
+
+To obtain the current value of the secret, use the `await get_secret()` method:
+
+```python
+from datasette_secrets import get_secret
+
+secret = await get_secret(datasette, "OPENAI_API_KEY")
+```
+If the Datasette administrator set a `DATASETTE_SECRETS_OPENAI_API_KEY` environment variable, that will be returned.
+
+Otherwise the encrypted value in the database table will be decrypted and returned - or `None` if there is no configured secret.
+
+
+## Development
+
+To set up this plugin locally, first checkout the code. Then create a new virtual environment:
+```bash
+cd datasette-secrets
+python3 -m venv venv
+source venv/bin/activate
+```
+Now install the dependencies and test dependencies:
+```bash
+pip install -e '.[test]'
+```
+To run the tests:
+```bash
+pytest
+```

datasette_secrets-0.1a0/datasette_secrets/__init__.py

@@ -0,0 +1,322 @@
+import click
+from cryptography.fernet import Fernet
+import dataclasses
+from datasette import hookimpl, Forbidden, Permission, Response
+from datasette.plugins import pm
+from datasette.utils import await_me_maybe
+import os
+from typing import Optional
+from . import hookspecs
+
+MAX_NOTE_LENGTH = 100
+
+pm.add_hookspecs(hookspecs)
+
+
+async def get_secret(datasette, secret_name):
+    secrets_by_name = {secret.name: secret for secret in await get_secrets(datasette)}
+    if secret_name not in secrets_by_name:
+        return None
+    # Is it an environment secret?
+    env_var = "DATASETTE_SECRETS_{}".format(secret_name)
+    if os.environ.get(env_var):
+        return os.environ[env_var]
+    # Now look it up in the database
+    config = get_config(datasette)
+    db = get_database(datasette)
+    encrypted = (
+        await db.execute(
+            "select encrypted from datasette_secrets where name = ? order by version desc limit 1",
+            (secret_name,),
+        )
+    ).first()
+    if not encrypted:
+        return None
+    key = Fernet(config["encryption_key"].encode("utf-8"))
+    decrypted = key.decrypt(encrypted["encrypted"])
+    return decrypted.decode("utf-8")
+
+
+@dataclasses.dataclass
+class Secret:
+    name: str
+    description_html: Optional[str] = None
+
+
+SCHEMA = """
+create table if not exists datasette_secrets (
+    id integer primary key,
+    name text not null,
+    note text,
+    version integer not null default 1,
+    encrypted blob,
+    encryption_key_name text not null,
+    redacted text,
+    created_at text,
+    created_by text,
+    updated_at text,
+    updated_by text,
+    deleted_at text,
+    deleted_by text,
+    last_used_at text,
+    last_used_by text
+);
+"""
+
+
+def get_database(datasette):
+    plugin_config = datasette.plugin_config("datasette-secrets") or {}
+    database = plugin_config.get("database") or "_internal"
+    if database == "_internal":
+        return datasette.get_internal_database()
+    return datasette.get_database(database)
+
+
+def get_config(datasette):
+    plugin_config = datasette.plugin_config("datasette-secrets") or {}
+    encryption_key = plugin_config.get("encryption-key")
+    database = plugin_config.get("database") or "_internal"
+    if not encryption_key:
+        return None
+    return {
+        "database": database,
+        "encryption_key": encryption_key,
+    }
+
+
+@hookimpl
+def register_permissions(datasette):
+    return [
+        Permission(
+            name="manage-secrets",
+            abbr=None,
+            description="Manage Datasette secrets",
+            takes_database=False,
+            takes_resource=False,
+            default=False,
+        )
+    ]
+
+
+async def get_secrets(datasette):
+    secrets = []
+    for result in pm.hook.register_secrets(datasette=datasette):
+        result = await await_me_maybe(result)
+        secrets.extend(result)
+    # if not secrets:
+    secrets.append(Secret("EXAMPLE_SECRET", "An example secret"))
+
+    return secrets
+
+
+@hookimpl
+def register_secrets():
+    return [
+        Secret(
+            "OPENAI_API_KEY",
+            'An OpenAI API key. Get them from <a href="https://platform.openai.com/api-keys">here</a>.',
+        ),
+    ]
+
+
+@hookimpl
+def register_commands(cli):
+    @cli.group()
+    def secrets():
+        "Commands for managing datasette-secrets"
+
+    @secrets.command()
+    def generate_encryption_key():
+        "Generate a new encryption key for encrypting and decrypting secrets"
+        key = Fernet.generate_key()
+        click.echo(key.decode("utf-8"))
+
+
+@hookimpl
+def startup(datasette):
+    plugin_config = get_config(datasette)
+    if not plugin_config:
+        return
+    db = get_database(datasette)
+
+    async def create_table():
+        await db.execute_write(SCHEMA)
+
+    return create_table
+
+
+async def secrets_index(datasette, request):
+    if not await datasette.permission_allowed(request.actor, "manage-secrets"):
+        raise Forbidden("Permission denied")
+    all_secrets = await get_secrets(datasette)
+
+    environment_secrets = []
+    for secret in all_secrets:
+        if os.environ.get("DATASETTE_SECRETS_{}".format(secret.name)):
+            environment_secrets.append(secret)
+    environment_secrets_names = {secret.name for secret in environment_secrets}
+
+    db = get_database(datasette)
+    existing_secrets_result = await db.execute(
+        """
+        select name, max(version) as version, updated_at, updated_by, note
+        from datasette_secrets
+        where name not in ({})
+        group by name
+        """.format(
+            ", ".join("?" for _ in environment_secrets_names)
+        ),
+        list(environment_secrets_names),
+    )
+    existing_secrets = {row["name"]: dict(row) for row in existing_secrets_result.rows}
+    unset_secrets = [
+        secret
+        for secret in all_secrets
+        if secret.name not in existing_secrets
+        and secret.name not in environment_secrets_names
+    ]
+    return Response.html(
+        await datasette.render_template(
+            "secrets_index.html",
+            {
+                "existing_secrets": existing_secrets.values(),
+                "unset_secrets": unset_secrets,
+                "environment_secrets": environment_secrets,
+            },
+            request=request,
+        )
+    )
+
+
+async def secrets_update(datasette, request):
+    if not await datasette.permission_allowed(request.actor, "manage-secrets"):
+        raise Forbidden("Permission denied")
+    plugin_config = get_config(datasette)
+    if not plugin_config:
+        return Response.html("datasette-secrets has not been configured", status=400)
+
+    secret_name = request.url_vars["secret_name"]
+
+    # Try and find a secret matching this name
+    secret_details = None
+    secrets = await get_secrets(datasette)
+    for s in secrets:
+        if s.name == secret_name:
+            secret_details = s
+            break
+
+    db = get_database(datasette)
+
+    current_secret = (
+        await db.execute(
+            """
+        select * from datasette_secrets
+        where name = ?
+        order by version desc limit 1
+        """,
+            (secret_name,),
+        )
+    ).first()
+
+    if request.method == "POST":
+        data = await request.post_vars()
+        secret = (data.get("secret") or "").strip()
+        note = data.get("note") or ""
+        if len(note) > MAX_NOTE_LENGTH:
+            datasette.add_message(request, "Note is too long", datasette.ERROR)
+            return Response.redirect(request.path)
+
+        # Secret is required if adding
+        if not secret:
+            if current_secret:
+                # Update the note
+                await db.execute_write(
+                    """
+                    update datasette_secrets
+                    set note = ?,
+                        updated_at = datetime('now'),
+                        updated_by = ?
+                    where id = ?
+                    """,
+                    (note, request.actor.get("id"), current_secret["id"]),
+                )
+                if note and note != current_secret["note"]:
+                    datasette.add_message(
+                        request, "Note updated: {}".format(secret_name)
+                    )
+                return Response.redirect(datasette.urls.path("/-/secrets"))
+            else:
+                datasette.add_message(request, "Secret is required", datasette.ERROR)
+                return Response.redirect(request.path)
+
+        encryption_key = plugin_config["encryption_key"]
+        key = Fernet(encryption_key.encode("utf-8"))
+        encrypted = key.encrypt(secret.encode("utf-8"))
+        encryption_key_name = "default"
+        actor_id = request.actor.get("id")
+        await db.execute_write(
+            """
+            insert into datasette_secrets (
+                name, version, note, encrypted, encryption_key_name,
+                created_at, created_by, updated_at, updated_by
+            ) values (
+                ?,
+                coalesce((select max(version) + 1 from datasette_secrets where name = ?), 1),
+                ?,
+                ?,
+                ?,
+                -- created_at, created_by
+                datetime('now'), ?,
+                -- updated_at, updated_by
+                datetime('now'), ?
+            )
+            """,
+            (
+                secret_name,
+                secret_name,
+                note,
+                encrypted,
+                encryption_key_name,
+                actor_id,
+                actor_id,
+            ),
+        )
+        datasette.add_message(request, "Secret {} updated".format(secret_name))
+        return Response.redirect(datasette.urls.path("/-/secrets"))
+
+    return Response.html(
+        await datasette.render_template(
+            "secrets_update.html",
+            {
+                "secret_name": secret_name,
+                "secret_details": secret_details,
+                "current_secret": current_secret,
+                "max_note_length": MAX_NOTE_LENGTH,
+            },
+            request=request,
+        )
+    )
+
+
+@hookimpl
+def register_routes():
+    return [
+        (r"^/-/secrets$", secrets_index),
+        (r"^/-/secrets/(?P<secret_name>[^/]+)$", secrets_update),
+    ]
+
+
+@hookimpl
+def menu_links(datasette, actor):
+    config = get_config(datasette)
+    if not config:
+        return
+
+    async def inner():
+        if not await datasette.permission_allowed(actor, "manage-secrets"):
+            return
+        return [
+            {"href": datasette.urls.path("/-/secrets"), "label": "Manage secrets"},
+        ]
+
+    return inner

datasette_secrets-0.1a0/datasette_secrets/hookspecs.py

@@ -0,0 +1,8 @@
+from pluggy import HookspecMarker
+
+hookspec = HookspecMarker("datasette")
+
+
+@hookspec
+def register_secrets(datasette):
+    "Return a list of Secret instances, or an awaitable function returning that list"

datasette_secrets-0.1a0/datasette_secrets/templates/secrets_index.html

@@ -0,0 +1,43 @@
+{% extends "base.html" %}
+
+{% block title %}Manage secrets{% endblock %}
+
+{% block content %}
+<h1>Manage secrets</h1>
+
+{% if existing_secrets %}
+<table>
+  <tr><th>Secret</th><th>Note</th><th>Version</th><th>Last updated</th><th>Updated by</th></tr>
+  {% for secret in existing_secrets %}
+    <tr>
+      <td><strong><a href="{{ urls.path("/-/secrets/") }}{{ secret.name }}">{{ secret.name }}</a></strong></td>
+      <td>{{ secret.note }}</td>
+      <td>{{ secret.version }}</td>
+      <td>{{ secret.updated_at or "" }}</td>
+      <td>{{ secret.updated_by or "" }}</td>
+    </tr>
+  {% endfor %}
+</table>
+{% endif %}
+
+{% if unset_secrets %}
+<p style="margin-top: 2em">The following secret{% if unset_secrets|length == 1 %} has{% else %}s have{% endif %} not been set:</p>
+<ul>
+  {% for secret in unset_secrets %}
+    <li><strong><a href="{{ urls.path("/-/secrets/") }}{{ secret.name }}">{{ secret.name }}</a></strong>
+    {% if secret.description_html %} - {{ secret.description_html|safe }}{% endif %}</li>
+  {% endfor %}
+</ul>
+{% endif %}
+
+{% if environment_secrets %}
+<p style="margin-top: 2em">The following secret{% if environment_secrets|length == 1 %} is{% else %}s are{% endif %} set using environment variables:</p>
+<ul>
+  {% for secret in environment_secrets %}
+    <li><strong>{{ secret.name }}</a></strong>- {{ secret.description_html|safe }}<br>
+      <span style="font-size: 0.8 em">Set by <code>DATASETTE_SECRETS_{{ secret.name }}</code></span></li>
+  {% endfor %}
+</ul>
+{% endif %}
+
+{% endblock %}

datasette_secrets-0.1a0/datasette_secrets/templates/secrets_update.html

@@ -0,0 +1,43 @@
+{% extends "base.html" %}
+
+{% block title %}{% if current_secret %}Update{% else %}Add{% endif %} secret: {{ secret_name }}{% endblock %}
+
+{% block crumbs %}
+<p class="crumbs"><a href="{{ urls.path("/") }}">home</a> / <a href="{{ urls.path("/-/secrets") }}">secrets</a></p>
+{% endblock %}
+
+{% block content %}
+<h1>{% if current_secret %}Update{% else %}Add{% endif %} secret: {{ secret_name }}</h1>
+
+{% if secret_details and secret_details.description_html %}
+  <p>{{ secret_details.description_html|safe }}</p>
+{% endif %}
+
+{% if error %}
+  <p class="message-error">{{ error }}</p>
+{% endif %}
+
+<form action="{{ request.path }}" method="post">
+  <p>
+    <label for="secret">Secret:</label>
+  </p>
+  <p>
+    <textarea name="secret" style="width: 80%; height: 5em" id="secret"{% if not current_secret %} required{% endif %}
+      placeholder="{% if current_secret %}Leave this blank to leave the stored secret unchanged{% else %}Enter the secret here{% endif %}"
+    ></textarea>
+  </p>
+  <p>
+    <label for="note">Note (optional):</label>
+  </p>
+  <p>
+    <input type="text" name="note" id="note" maxlength="{{ max_note_length}}"
+      placeholder="{% if current_secret %}Add a note to the secret{% else %}Optional note{% endif %}"
+      value="{% if current_secret %}{{ current_secret.note }}{% endif %}"
+  </p>
+  <p>
+    <input type="submit" value="Add secret">
+    <input type="hidden" name="csrftoken" value="{{ csrftoken() }}">
+  </p>
+</form>
+
+{% endblock %}

datasette_secrets-0.1a0/datasette_secrets.egg-info/PKG-INFO

@@ -0,0 +1,160 @@
+Metadata-Version: 2.1
+Name: datasette-secrets
+Version: 0.1a0
+Summary: Manage secrets such as API keys for use with other Datasette plugins
+Author: Datasette
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/datasette/datasette-secrets
+Project-URL: Changelog, https://github.com/datasette/datasette-secrets/releases
+Project-URL: Issues, https://github.com/datasette/datasette-secrets/issues
+Project-URL: CI, https://github.com/datasette/datasette-secrets/actions
+Classifier: Framework :: Datasette
+Classifier: License :: OSI Approved :: Apache Software License
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: datasette>=1.0a13
+Requires-Dist: cryptography
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-asyncio; extra == "test"
+
+# datasette-secrets
+
+[![PyPI](https://img.shields.io/pypi/v/datasette-secrets.svg)](https://pypi.org/project/datasette-secrets/)
+[![Changelog](https://img.shields.io/github/v/release/datasette/datasette-secrets?include_prereleases&label=changelog)](https://github.com/datasette/datasette-secrets/releases)
+[![Tests](https://github.com/datasette/datasette-secrets/actions/workflows/test.yml/badge.svg)](https://github.com/datasette/datasette-secrets/actions/workflows/test.yml)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/datasette/datasette-secrets/blob/main/LICENSE)
+
+Manage secrets such as API keys for use with other Datasette plugins
+
+This plugin requires a **Datasette 1.0 alpha** release.
+
+Datasette plugins sometimes need access to secrets, such as API keys used to integrate with tools hosted outside of Datasette - things like geocoders or hosted AI language models.
+
+This plugin provides ways to configure those secrets:
+
+- Secrets can be configured using environment variables, such as `DATASETTE_SECRETS_OPENAI_API_KEY`
+- Secrets can be stored, encrypted, in a SQLite database table which administrator users can then update through the Datasette web interface
+
+## Installation
+
+Install this plugin in the same environment as Datasette.
+```bash
+datasette install datasette-secrets
+```
+## Configuration
+
+First you will need to generate an encryption key for this plugin to use. Run this command:
+
+```bash
+datasette secrets generate-encryption-key
+```
+Store this secret somewhere secure. It will be used to both encrypt and decrypt secrets stored by this plugin - if you lose it you will not be able to recover your secrets.
+
+Configure the plugin with these these two plugin settings:
+
+```yaml
+plugins:
+  datasette-secrets:
+    encryption_key:
+      $env: DATASETTE_SECRETS_ENCRYPTION_KEY
+    database: name_of_database
+```
+The `encryption_key` setting should be set to the encryption key you generated earlier. You can store it in an environment variable if you prefer.
+
+`database` is the name of the database that the encrypted keys should be stored in. Omit this setting to use the internal database.
+
+### Using the internal database
+
+While the secrets stored in the `datasette_secrets` table are encrypted, we still recommend hiding that table from view.
+
+One way to do that is to keep the table in Datasette's internal database, which is invisible to all users, even users who are logged in.
+
+By default, the internal database is an in-memory database that is reset when Datasette restarts. This is no good for persistent secret storage!
+
+Instead, you should switch Datasette to using an on-disk internal database. You can do this by starting Datasette with the `--internal` option:
+```bash
+datasette data.db --internal internal.db
+```
+Your secrets will be stored in the `datasette_secrets` table in that database file.
+
+### Permissions
+
+Only users with the `manage-secrets` permission will have access to manage secrets through the Datasette web interface.
+
+You can grant that permission to the `root` user (or the user with an ID of your choice) by including this in your `datasette.yml` file:
+
+```yaml
+permissions:
+  manage-secrets:
+    id: root
+```
+Then start Datasette like this (with `--root` to get a URL to login as the root user):
+```bash
+datasette data.db --internal internal.db -c datasette.yml --root
+```
+Alternatively, use the `-s` option to set that setting without creating a configuration file:
+```bash
+datasette data.db --internal internal.db \
+  -s permissions.manage-secrets.id root \
+  --root
+```
+
+## Usage
+
+users with the `manage-secrets` permission will see a new "Manage secrets" link in the Datasette navigation menu. This interface can also be accessed at `/-/secrets`.
+
+## For plugin authors
+
+Plugins can depend on this plugin if they want to implement secrets.
+
+`datasette-secrets` to the `dependencies` list in `pyproject.toml`.
+
+Then declare the name and description of any secrets you need using the `register_secrets()` plugin hook:
+
+```python
+from datasette import hookimpl
+from datasette_secrets import Secret
+
+@hookimpl
+def register_secrets():
+    return [
+        Secret(
+            "OPENAI_API_KEY",
+            'An OpenAI API key. Get them from <a href="https://platform.openai.com/api-keys">here</a>.',
+        ),
+    ]
+```
+The hook can take an optional `datasette` argument. It can return a list or an `async def` function that, when awaited, returns a list.
+
+The list should consist of `Secret()` instances, each with a name and an optional description. The description can contain HTML.
+
+To obtain the current value of the secret, use the `await get_secret()` method:
+
+```python
+from datasette_secrets import get_secret
+
+secret = await get_secret(datasette, "OPENAI_API_KEY")
+```
+If the Datasette administrator set a `DATASETTE_SECRETS_OPENAI_API_KEY` environment variable, that will be returned.
+
+Otherwise the encrypted value in the database table will be decrypted and returned - or `None` if there is no configured secret.
+
+
+## Development
+
+To set up this plugin locally, first checkout the code. Then create a new virtual environment:
+```bash
+cd datasette-secrets
+python3 -m venv venv
+source venv/bin/activate
+```
+Now install the dependencies and test dependencies:
+```bash
+pip install -e '.[test]'
+```
+To run the tests:
+```bash
+pytest
+```

datasette_secrets-0.1a0/datasette_secrets.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE
+README.md
+pyproject.toml
+datasette_secrets/__init__.py
+datasette_secrets/hookspecs.py
+datasette_secrets.egg-info/PKG-INFO
+datasette_secrets.egg-info/SOURCES.txt
+datasette_secrets.egg-info/dependency_links.txt
+datasette_secrets.egg-info/entry_points.txt
+datasette_secrets.egg-info/requires.txt
+datasette_secrets.egg-info/top_level.txt
+datasette_secrets/templates/secrets_index.html
+datasette_secrets/templates/secrets_update.html
+tests/test_secrets.py

datasette_secrets-0.1a0/datasette_secrets.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

datasette_secrets-0.1a0/datasette_secrets.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[datasette]
+secrets = datasette_secrets

datasette_secrets-0.1a0/datasette_secrets.egg-info/requires.txt

@@ -0,0 +1,6 @@
+datasette>=1.0a13
+cryptography
+
+[test]
+pytest
+pytest-asyncio

datasette_secrets-0.1a0/datasette_secrets.egg-info/top_level.txt

@@ -0,0 +1 @@
+datasette_secrets

datasette_secrets-0.1a0/pyproject.toml

@@ -0,0 +1,34 @@
+[project]
+name = "datasette-secrets"
+version = "0.1a0"
+description = "Manage secrets such as API keys for use with other Datasette plugins"
+readme = "README.md"
+authors = [{name = "Datasette"}]
+license = {text = "Apache-2.0"}
+classifiers=[
+    "Framework :: Datasette",
+    "License :: OSI Approved :: Apache Software License"
+]
+requires-python = ">=3.8"
+dependencies = [
+    "datasette>=1.0a13",
+    "cryptography"
+]
+
+[project.urls]
+Homepage = "https://github.com/datasette/datasette-secrets"
+Changelog = "https://github.com/datasette/datasette-secrets/releases"
+Issues = "https://github.com/datasette/datasette-secrets/issues"
+CI = "https://github.com/datasette/datasette-secrets/actions"
+
+[project.entry-points.datasette]
+secrets = "datasette_secrets"
+
+[project.optional-dependencies]
+test = ["pytest", "pytest-asyncio"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "strict"
+
+[tool.setuptools.package-data]
+datasette_secrets = ["templates/*"]

datasette_secrets-0.1a0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

datasette_secrets-0.1a0/tests/test_secrets.py

@@ -0,0 +1,166 @@
+from click.testing import CliRunner
+from cryptography.fernet import Fernet
+from datasette.app import Datasette
+from datasette.cli import cli
+from datasette_secrets import get_secret
+import pytest
+from unittest.mock import ANY
+
+TEST_ENCRYPTION_KEY = "-LujHtwFWGaBpznrV1zduoZBmCnMOW7J0H5hmeXgAVo="
+
+
+def test_generate_command():
+    runner = CliRunner()
+    result = runner.invoke(cli, ["secrets", "generate-encryption-key"])
+    assert result.exit_code == 0
+    key = result.output.strip()
+    key_bytes = key.encode("utf-8")
+    # This will throw an exception if key is invalid:
+    key = Fernet(key_bytes)
+    message = b"Secret message"
+    assert key.decrypt(key.encrypt(message)) == message
+
+
+@pytest.fixture
+def ds():
+    return Datasette(
+        config={
+            "plugins": {
+                "datasette-secrets": {
+                    "database": "_internal",
+                    "encryption-key": TEST_ENCRYPTION_KEY,
+                }
+            },
+            "permissions": {"manage-secrets": {"id": "admin"}},
+        }
+    )
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "path,verb,data",
+    (
+        ("/-/secrets", "GET", None),
+        ("/-/secrets/EXAMPLE_SECRET", "GET", None),
+    ),
+)
+@pytest.mark.parametrize("user", (None, "admin", "other"))
+async def test_permissions(ds, path, verb, data, user):
+    method = ds.client.get if verb == "GET" else ds.client.post
+    kwargs = {}
+    if user:
+        kwargs["cookies"] = {
+            "ds_actor": ds.client.actor_cookie({"id": user}),
+        }
+    if data:
+        kwargs["data"] = data
+    response = await method(path, **kwargs)
+    if user == "admin":
+        assert response.status_code != 403
+        # And check they have the menu item too
+        assert '<a href="/-/secrets">Manage secrets</a>' in response.text
+    else:
+        assert response.status_code == 403
+        assert '<a href="/-/secrets">Manage secrets</a>' not in response.text
+
+
+@pytest.mark.asyncio
+async def test_set_secret(ds):
+    cookies = {"ds_actor": ds.client.actor_cookie({"id": "admin"})}
+    get_response = await ds.client.get("/-/secrets/EXAMPLE_SECRET", cookies=cookies)
+    csrftoken = get_response.cookies["ds_csrftoken"]
+    cookies["ds_csrftoken"] = csrftoken
+    post_response = await ds.client.post(
+        "/-/secrets/EXAMPLE_SECRET",
+        cookies=cookies,
+        data={"secret": "new-secret-value", "note": "new-note", "csrftoken": csrftoken},
+    )
+    assert post_response.status_code == 302
+    assert post_response.headers["Location"] == "/-/secrets"
+    internal_db = ds.get_internal_database()
+    secrets = await internal_db.execute("select * from datasette_secrets")
+    rows = [dict(r) for r in secrets.rows]
+    assert rows == [
+        {
+            "id": 1,
+            "name": "EXAMPLE_SECRET",
+            "note": "new-note",
+            "version": 1,
+            "encrypted": ANY,
+            "encryption_key_name": "default",
+            "redacted": None,
+            "created_at": ANY,
+            "created_by": "admin",
+            "updated_at": ANY,
+            "updated_by": "admin",
+            "deleted_at": None,
+            "deleted_by": None,
+            "last_used_at": None,
+            "last_used_by": None,
+        }
+    ]
+    # Decrypt the secret
+    key = Fernet(TEST_ENCRYPTION_KEY.encode("utf-8"))
+    encrypted = rows[0]["encrypted"]
+    decrypted = key.decrypt(encrypted)
+    assert decrypted == b"new-secret-value"
+
+    # Now let's edit it
+    post_response2 = await ds.client.post(
+        "/-/secrets/EXAMPLE_SECRET",
+        cookies=cookies,
+        data={"secret": "updated-secret-value", "note": "", "csrftoken": csrftoken},
+    )
+    assert post_response2.status_code == 302
+    assert post_response2.headers["Location"] == "/-/secrets"
+    secrets2 = await internal_db.execute("select * from datasette_secrets")
+    rows2 = [dict(r) for r in secrets2.rows]
+    assert len(rows2) == 2
+    # Should be version 1 and version 2
+    versions = {row["version"] for row in rows2}
+    assert versions == {1, 2}
+    # Version 2 should be the latest
+    latest = [row for row in rows2 if row["version"] == 2][0]
+    assert latest == {
+        "id": 2,
+        "name": "EXAMPLE_SECRET",
+        "note": "",
+        "version": 2,
+        "encrypted": ANY,
+        "encryption_key_name": "default",
+        "redacted": None,
+        "created_at": ANY,
+        "created_by": "admin",
+        "updated_at": ANY,
+        "updated_by": "admin",
+        "deleted_at": None,
+        "deleted_by": None,
+        "last_used_at": None,
+        "last_used_by": None,
+    }
+
+
+@pytest.mark.asyncio
+async def test_get_secret(ds, monkeypatch):
+    # First set it manually
+    cookies = {"ds_actor": ds.client.actor_cookie({"id": "admin"})}
+    get_response = await ds.client.get("/-/secrets/EXAMPLE_SECRET", cookies=cookies)
+    csrftoken = get_response.cookies["ds_csrftoken"]
+    cookies["ds_csrftoken"] = csrftoken
+    post_response = await ds.client.post(
+        "/-/secrets/EXAMPLE_SECRET",
+        cookies=cookies,
+        data={
+            "secret": "manually-set-secret",
+            "note": "new-note",
+            "csrftoken": csrftoken,
+        },
+    )
+    assert post_response.status_code == 302
+
+    assert await get_secret(ds, "EXAMPLE_SECRET") == "manually-set-secret"
+
+    # Now over-ride with an environment variable
+    monkeypatch.setenv("DATASETTE_SECRETS_EXAMPLE_SECRET", "from env")
+
+    assert await get_secret(ds, "EXAMPLE_SECRET") == "from env"