# datasette-auth-tokens
[](https://pypi.org/project/datasette-auth-tokens/)
[](https://github.com/simonw/datasette-auth-tokens/releases)
[](https://github.com/simonw/datasette-auth-tokens/actions?query=workflow%3ATest)
[](https://github.com/simonw/datasette-auth-tokens/blob/main/LICENSE)
Datasette plugin for authenticating access using API tokens
## Installation
Install this plugin in the same environment as Datasette.
$ pip install datasette-auth-tokens
## Hard-coded tokens
Read about Datasette's [authentication and permissions system](https://datasette.readthedocs.io/en/latest/authentication.html).
This plugin lets you configure secret API tokens which can be used to make authenticated requests to Datasette.
First, create a random API token. A useful recipe for doing that is the following:
$ python -c 'import secrets; print(secrets.token_hex(32))'
5f9a486dd807de632200b17508c75002bb66ca6fde1993db1de6cbd446362589
Decide on the actor that this token should represent, for example:
```json
{
"bot_id": "my-bot"
}
```
You can then use `"allow"` blocks to provide that token with permission to access specific actions. To enable access to a configured writable SQL query you could use this in your `metadata.json`:
```json
{
"plugins": {
"datasette-auth-tokens": {
"tokens": [
{
"token": {
"$env": "BOT_TOKEN"
},
"actor": {
"bot_id": "my-bot"
}
}
]
}
},
"databases": {
":memory:": {
"queries": {
"show_version": {
"sql": "select sqlite_version()",
"allow": {
"bot_id": "my-bot"
}
}
}
}
}
}
```
This uses Datasette's [secret configuration values mechanism](https://datasette.readthedocs.io/en/stable/plugins.html#secret-configuration-values) to allow the secret token to be passed as an environment variable.
Run Datasette like this:
BOT_TOKEN="this-is-the-secret-token" \
datasette -m metadata.json
You can now run authenticated API queries like this:
$ curl -H 'Authorization: Bearer this-is-the-secret-token' \
'http://127.0.0.1:8001/:memory:/show_version.json?_shape=array'
[{"sqlite_version()": "3.31.1"}]
Additionally you can allow passing the token as a query string parameter, although that's disabled by default given the security implications of URLs with secret tokens included. This may be useful to easily allow embedding data between different services.
Simply enable it using the `param` config value:
```json
{
"plugins": {
"datasette-auth-tokens": {
"tokens": [
{
"token": {
"$env": "BOT_TOKEN"
},
"actor": {
"bot_id": "my-bot"
},
}
],
"param": "_auth_token"
}
},
"databases": {
":memory:": {
"queries": {
"show_version": {
"sql": "select sqlite_version()",
"allow": {
"bot_id": "my-bot"
}
}
}
}
}
}
```
You can now run authenticated API queries like this:
$ curl http://127.0.0.1:8001/:memory:/show_version.json?_shape=array&_auth_token=this-is-the-secret-token
[{"sqlite_version()": "3.31.1"}]
## Tokens from your database
As an alternative (or in addition) to the hard-coded list of tokens you can store tokens in a database table and configure the plugin to access them using a SQL query.
Your query needs to take a `:token_id` parameter and return at least two columns: one called `token_secret` and one called `actor_*` - usually `actor_id`. Further `actor_` prefixed columns can be returned to provide more details for the authenticated actor.
Here's a simple example of a configuration query:
```sql
select actor_id, actor_name, token_secret from tokens where token_id = :token_id
```
This can run against a table like this one:
| token_id | token_secret | actor_id | actor_name |
| -------- | ------------ | -------- | ---------- |
| 1 | bd3c94f51fcd | 78 | Cleopaws |
| 2 | 86681b4d6f66 | 32 | Pancakes |
The tokens are formed as the token ID, then a hyphen, then the token secret. For example:
- `1-bd3c94f51fcd`
- `2-86681b4d6f66`
The SQL query will be executed with the portion before the hyphen as the `:token_id` parameter.
The `token_secret` value returned by the query will be compared to the portion of the token after the hyphen to check if the token is valid.
Columns with a prefix of `actor_` will be used to populate the actor dictionary. In the above example, a token of `2-86681b4d6f66` will become an actor dictionary of `{"id": 32, "name": "Pancakes"}`.
To configure this, use a `"query"` block in your plugin configuration like this:
```json
{
"plugins": {
"datasette-auth-tokens": {
"query": {
"sql": "select actor_id, actor_name, token_secret from tokens where token_id = :token_id",
"database": "tokens"
}
}
},
"databases": {
"tokens": {
"allow": {}
}
}
}
```
The `"sql"` key here contains the SQL query. The `"database"` key has the name of the attached database file that the query should be executed against - in this case it would execute against `tokens.db`.
### Securing your tokens
Anyone with access to your Datasette instance can use it to read the `token_secret` column in your tokens table. This probably isn't what you want!
To avoid this, you should lock down access to that table. The configuration example above shows how to do this using an `"allow": {}` block. Consult Datasette's [Permissions documentation](https://datasette.readthedocs.io/en/stable/authentication.html#permissions) for more information about how to lock down this kind of access.
Raw data
{
"_id": null,
"home_page": "https://github.com/simonw/datasette-auth-tokens",
"name": "datasette-auth-tokens",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Simon Willison",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/37/e8/9232738f0a0e825be9dec92244b1fb48ec897b04dbd599237cf1e3239319/datasette-auth-tokens-0.3.tar.gz",
"platform": "",
"description": "# datasette-auth-tokens\n\n[](https://pypi.org/project/datasette-auth-tokens/)\n[](https://github.com/simonw/datasette-auth-tokens/releases)\n[](https://github.com/simonw/datasette-auth-tokens/actions?query=workflow%3ATest)\n[](https://github.com/simonw/datasette-auth-tokens/blob/main/LICENSE)\n\nDatasette plugin for authenticating access using API tokens\n\n## Installation\n\nInstall this plugin in the same environment as Datasette.\n\n $ pip install datasette-auth-tokens\n\n## Hard-coded tokens\n\nRead about Datasette's [authentication and permissions system](https://datasette.readthedocs.io/en/latest/authentication.html).\n\nThis plugin lets you configure secret API tokens which can be used to make authenticated requests to Datasette.\n\nFirst, create a random API token. A useful recipe for doing that is the following:\n\n $ python -c 'import secrets; print(secrets.token_hex(32))'\n 5f9a486dd807de632200b17508c75002bb66ca6fde1993db1de6cbd446362589\n\nDecide on the actor that this token should represent, for example:\n\n```json\n{\n \"bot_id\": \"my-bot\"\n}\n```\n\nYou can then use `\"allow\"` blocks to provide that token with permission to access specific actions. To enable access to a configured writable SQL query you could use this in your `metadata.json`:\n\n```json\n{\n \"plugins\": {\n \"datasette-auth-tokens\": {\n \"tokens\": [\n {\n \"token\": {\n \"$env\": \"BOT_TOKEN\"\n },\n \"actor\": {\n \"bot_id\": \"my-bot\"\n }\n }\n ]\n }\n },\n \"databases\": {\n \":memory:\": {\n \"queries\": {\n \"show_version\": {\n \"sql\": \"select sqlite_version()\",\n \"allow\": {\n \"bot_id\": \"my-bot\"\n }\n }\n }\n }\n }\n}\n```\nThis uses Datasette's [secret configuration values mechanism](https://datasette.readthedocs.io/en/stable/plugins.html#secret-configuration-values) to allow the secret token to be passed as an environment variable.\n\nRun Datasette like this:\n\n BOT_TOKEN=\"this-is-the-secret-token\" \\\n datasette -m metadata.json\n\nYou can now run authenticated API queries like this:\n\n $ curl -H 'Authorization: Bearer this-is-the-secret-token' \\\n 'http://127.0.0.1:8001/:memory:/show_version.json?_shape=array'\n [{\"sqlite_version()\": \"3.31.1\"}]\n\nAdditionally you can allow passing the token as a query string parameter, although that's disabled by default given the security implications of URLs with secret tokens included. This may be useful to easily allow embedding data between different services.\n\nSimply enable it using the `param` config value:\n\n```json\n{\n \"plugins\": {\n \"datasette-auth-tokens\": {\n \"tokens\": [\n {\n \"token\": {\n \"$env\": \"BOT_TOKEN\"\n },\n \"actor\": {\n \"bot_id\": \"my-bot\"\n },\n }\n ],\n \"param\": \"_auth_token\"\n }\n },\n \"databases\": {\n \":memory:\": {\n \"queries\": {\n \"show_version\": {\n \"sql\": \"select sqlite_version()\",\n \"allow\": {\n \"bot_id\": \"my-bot\"\n }\n }\n }\n }\n }\n}\n```\n\nYou can now run authenticated API queries like this:\n\n $ curl http://127.0.0.1:8001/:memory:/show_version.json?_shape=array&_auth_token=this-is-the-secret-token\n [{\"sqlite_version()\": \"3.31.1\"}]\n\n## Tokens from your database\n\nAs an alternative (or in addition) to the hard-coded list of tokens you can store tokens in a database table and configure the plugin to access them using a SQL query.\n\nYour query needs to take a `:token_id` parameter and return at least two columns: one called `token_secret` and one called `actor_*` - usually `actor_id`. Further `actor_` prefixed columns can be returned to provide more details for the authenticated actor.\n\nHere's a simple example of a configuration query:\n\n```sql\nselect actor_id, actor_name, token_secret from tokens where token_id = :token_id\n```\n\nThis can run against a table like this one:\n\n| token_id | token_secret | actor_id | actor_name |\n| -------- | ------------ | -------- | ---------- |\n| 1 | bd3c94f51fcd | 78 | Cleopaws |\n| 2 | 86681b4d6f66 | 32 | Pancakes |\n\nThe tokens are formed as the token ID, then a hyphen, then the token secret. For example:\n\n- `1-bd3c94f51fcd`\n- `2-86681b4d6f66`\n\nThe SQL query will be executed with the portion before the hyphen as the `:token_id` parameter.\n\nThe `token_secret` value returned by the query will be compared to the portion of the token after the hyphen to check if the token is valid.\n\nColumns with a prefix of `actor_` will be used to populate the actor dictionary. In the above example, a token of `2-86681b4d6f66` will become an actor dictionary of `{\"id\": 32, \"name\": \"Pancakes\"}`.\n\nTo configure this, use a `\"query\"` block in your plugin configuration like this:\n\n```json\n{\n \"plugins\": {\n \"datasette-auth-tokens\": {\n \"query\": {\n \"sql\": \"select actor_id, actor_name, token_secret from tokens where token_id = :token_id\",\n \"database\": \"tokens\"\n }\n }\n },\n \"databases\": {\n \"tokens\": {\n \"allow\": {}\n }\n }\n}\n```\nThe `\"sql\"` key here contains the SQL query. The `\"database\"` key has the name of the attached database file that the query should be executed against - in this case it would execute against `tokens.db`.\n\n### Securing your tokens\n\nAnyone with access to your Datasette instance can use it to read the `token_secret` column in your tokens table. This probably isn't what you want!\n\nTo avoid this, you should lock down access to that table. The configuration example above shows how to do this using an `\"allow\": {}` block. Consult Datasette's [Permissions documentation](https://datasette.readthedocs.io/en/stable/authentication.html#permissions) for more information about how to lock down this kind of access.\n\n\n",
"bugtrack_url": null,
"license": "Apache License, Version 2.0",
"summary": "Datasette plugin for authenticating access using API tokens",
"version": "0.3",
"project_urls": {
"CI": "https://github.com/simonw/datasette-auth-tokens/actions",
"Changelog": "https://github.com/simonw/datasette-auth-tokens/releases",
"Homepage": "https://github.com/simonw/datasette-auth-tokens",
"Issues": "https://github.com/simonw/datasette-auth-tokens/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b5207da7b8970560a98a7b604cddeb4ec834681f5778de5f8ec893d71b991a8a",
"md5": "0830043168b610337f51dcb0a02fe902",
"sha256": "6318fa366e3c7d98f0e1f09f1918fab45b51d46087585642aa369627a612bd42"
},
"downloads": -1,
"filename": "datasette_auth_tokens-0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0830043168b610337f51dcb0a02fe902",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8752,
"upload_time": "2021-10-15T00:58:49",
"upload_time_iso_8601": "2021-10-15T00:58:49.076881Z",
"url": "https://files.pythonhosted.org/packages/b5/20/7da7b8970560a98a7b604cddeb4ec834681f5778de5f8ec893d71b991a8a/datasette_auth_tokens-0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "37e89232738f0a0e825be9dec92244b1fb48ec897b04dbd599237cf1e3239319",
"md5": "87944b4542f9d72b856da1cd1f9c270e",
"sha256": "526ce6f150e729e51c6df283238c58885a437eeb90d80a12357d4a454ba6f36e"
},
"downloads": -1,
"filename": "datasette-auth-tokens-0.3.tar.gz",
"has_sig": false,
"md5_digest": "87944b4542f9d72b856da1cd1f9c270e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8254,
"upload_time": "2021-10-15T00:58:50",
"upload_time_iso_8601": "2021-10-15T00:58:50.885052Z",
"url": "https://files.pythonhosted.org/packages/37/e8/9232738f0a0e825be9dec92244b1fb48ec897b04dbd599237cf1e3239319/datasette-auth-tokens-0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-10-15 00:58:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "simonw",
"github_project": "datasette-auth-tokens",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "datasette-auth-tokens"
}
JSON
