cattle_grid 0.3.1

Middleware for the Fediverse

cattle_grid

THIS README needs to be updated for cattle_grid 0.2.0

cattle_grid is meant to simplify handling authentication in server to server communication of the Fediverse. cattle_grid checks the HTTP signatures based on the headers. For this public keys are retrieved and cached.

For installation instructions see the documentation.

Running

After creating a configuration file, one can run cattle_grid via

poetry run uvicorn cattle_grid:create_app

Development

One can run the pytest tests via

poetry install
poetry run pytest

Development with Fediverse pasture

In your Funfedi.dev directory (see here for details), run

cd fediverse-pasture
docker compose --file pasture.yml up pasture_verify_actor

Now in the cattle grid directory, run

poetry run python -mcattle_grid.config --actor_id http://cattle_grid/actor

to create a cattle_grid.toml file. Then start the docker containers via

docker compose up

By opening http://localhost:2909/?actor_uri=jskitten@cattle_grid_demo, you should then be able to view the verify actor result. By refreshing the page and inspecting the log files, you can also check that the requests only ran once.

Creating an user

By running

docker compose run runner

one can start a shell in the docker environment. By then running in it

curl abel/admin/create -X POST -F username=name -F password=secret

one can create the user with handle @name@abel.

Running GUI tests with the pasture

Start mastodon accessible through your browser

cd fediverse-pasture
docker compose --file mastodon42.yml --profile nginx up

See Fun Fediverse Development for instructions.

Then you can open mastodon42web and lookup jskitten@cattle_grid_demo. When you send a message to this kitten, it should reply with a meow, e.g.