{"id": "plugin_hooks:plugin-hook-actor-from-request", "page": "plugin_hooks", "ref": "plugin-hook-actor-from-request", "title": "actor_from_request(datasette, request)", "content": "datasette  -  Datasette class \n                     \n                         You can use this to access plugin configuration options via  datasette.plugin_config(your_plugin_name) , or to execute SQL queries. \n                     \n                 \n                 \n                     request  -  Request object \n                     \n                         The current HTTP request. \n                     \n                 \n             \n             This is part of Datasette's  authentication and permissions system . The function should attempt to authenticate an actor (either a user or an API actor of some sort) based on information in the request. \n             If it cannot authenticate an actor, it should return  None . Otherwise it should return a dictionary representing that actor. \n             Here's an example that authenticates the actor based on an incoming API key: \n             from datasette import hookimpl\nimport secrets\n\nSECRET_KEY = \"this-is-a-secret\"\n\n\n@hookimpl\ndef actor_from_request(datasette, request):\n    authorization = (\n        request.headers.get(\"authorization\") or \"\"\n    )\n    expected = \"Bearer {}\".format(SECRET_KEY)\n\n    if secrets.compare_digest(authorization, expected):\n        return {\"id\": \"bot\"} \n             If you install this in your plugins directory you can test it like this: \n             curl -H 'Authorization: Bearer this-is-a-secret' http://localhost:8003/-/actor.json \n             Instead of returning a dictionary, this function can return an awaitable function which itself returns either  None  or a dictionary. This is useful for authentication functions that need to make a database query - for example: \n             from datasette import hookimpl\n\n\n@hookimpl\ndef actor_from_request(datasette, request):\n    async def inner():\n        token = request.args.get(\"_token\")\n        if not token:\n            return None\n        # Look up ?_token=xxx in sessions table\n        result = await datasette.get_database().execute(\n            \"select count(*) from sessions where token = ?\",\n            [token],\n        )\n        if result.first()[0]:\n            return {\"token\": token}\n        else:\n            return None\n\n    return inner \n             Examples:  datasette-auth-tokens ,  datasette-auth-passwords", "breadcrumbs": "[\"Plugin hooks\"]", "references": "[{\"href\": \"https://datasette.io/plugins/datasette-auth-tokens\", \"label\": \"datasette-auth-tokens\"}, {\"href\": \"https://datasette.io/plugins/datasette-auth-passwords\", \"label\": \"datasette-auth-passwords\"}]"}