github/datasette
1
0
Fork 0
mirror of https://github.com/simonw/datasette.git synced 2025-12-10 16:51:24 +01:00
Code Issues Projects Releases Packages Wiki Activity

ds_actor cookie documentation, closes #826

Browse source
This commit is contained in:
Simon Willison 2020-06-09 15:32:24 -07:00
commit b5f04f42ab
1 changed files with 18 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/authentication.rst
View file

@ -315,8 +315,8 @@ The currently authenticated actor is made available to plugins as ``request.acto
.. _PermissionsDebugView:
Permissions Debug
=================
The permissions debug tool
==========================
The debug tool at ``/-/permissions`` is only available to the :ref:`authenticated root user <authentication_root>` (or any actor granted the ``permissions-debug`` action according to a plugin).
@ -324,6 +324,22 @@ It shows the thirty most recent permission checks that have been carried out by
This is designed to help administrators and plugin authors understand exactly how permission checks are being carried out, in order to effectively configure Datasette's permission system.
.. _authentication_ds_actor:
The ds_actor cookie
===================
Datasette includes a default authentication plugin which looks for a signed ``ds_actor`` cookie containing a JSON actor dictionary. This is how the :ref:`root actor <authentication_root>` mechanism works.
Authentication plugins can set signed ``ds_actor`` cookies themselves like so:
.. code-block:: python
response = Response.redirect("/")
response.set_cookie("ds_actor", datasette.sign({"id": "cleopaws"}, "actor"))
return response
Note that you need to pass ``"actor"`` as the namespace to :ref:`datasette_sign`.
.. _permissions: