zegnat/mintoken

A minimal IndieAuth compatible token endpoint.

Maintainers

Details

github.com/Zegnat/php-mintoken

Source

Issues

Installs: 14

Dependents: 0

Suggesters: 0

Security: 0

Stars: 14

Watchers: 8

Forks: 4

Open Issues: 7

Type:project

2.0.0 2018-05-13 14:47 UTC

Requires (Dev)

0BSD f93b888c4c56dd5faa129b6c0ccae90b7b00132f

  • Martijn van der Ven <martijn.woop@vanderven.se>

This package is not auto-updated.

Last update: 2024-11-01 03:39:38 UTC

README

A minimal IndieAuth compatible Token Endpoint.

Several times I have been asked if there is a token endpoint available to be used together with Selfauth. A minimal solution that would just work for issuing access tokens that is self-hostable on a server with PHP.

I do not have a need for a token endpoint like this myself, thus developing one would go against my selfdogfooding principles. But because I have a general interest in the IndieAuth specification, here is an implementation anyway!

Setup

  1. Download the latest release from GitHub and extract the files.

  2. Create an SQLite database; these instructions assume the database is called tokens.db.

    You can do this from the command line:

    sqlite3 tokens.db < schema.sql

    If you prefer, create the SQLite database by your favourite means and use schema.sql to create the expected tables.

  3. Define trusted authorization endpoints in the settings table of the SQLite database. Mintoken will only check codes with these endpoints, and takes the me value they return as trusted without further verification.

    E.g. if we take the example setup for Selfauth, the endpoint https://example.com/auth/ should be whitelisted.

    From the command line:

    sqlite3 tokens.db 'INSERT INTO settings VALUES ("endpoint", "https://example.com/auth/");'

  4. Upload the SQLite database to a secure directory on your server. Make sure it is not publicly available to the web! This is very important for security reasons.

  5. Edit endpoint.php so line 5 defines the correct path to the SQLite database as the value for MINTOKEN_SQLITE_PATH.

    You should use the full path to tokens.db. For example, define('MINTOKEN_SQLITE_PATH', '../../tokens.db');

  6. Put endpoint.php anywhere on your server where it is available to the web. (This can be in the same folder as Selfauth, for simplicity.)

  7. Make the token endpoint discoverable. Either by defining a Link HTTP header, or adding the following to the <head> of the pages where you also link to your authorization_endpoint:

    <link rel="token_endpoint" href="https://example.com/auth/endpoint.php">

    (The href must point at your endpoint.php file.)

License

The BSD Zero Clause License (0BSD). Please see the LICENSE file for more information.