Go to file
Kyle Mahan 6ddaba6114 convert README.md to README.rst for readthedocs 2015-12-16 17:48:47 +00:00
.gitignore Initial commit 2015-01-18 23:09:15 -08:00
CHANGELOG.md Replace next_url parameter with the more general and useful state 2015-12-13 19:50:54 -08:00
LICENSE Initial commit 2015-01-18 23:09:15 -08:00
README.md added authentication-only flow 2015-02-07 09:40:31 -08:00
README.rst convert README.md to README.rst for readthedocs 2015-12-16 17:48:47 +00:00
example.py added authentication-only flow 2015-02-07 09:40:31 -08:00
flask_micropub.py Replace next_url parameter with the more general and useful state 2015-12-13 19:50:54 -08:00
setup.py Replace next_url parameter with the more general and useful state 2015-12-13 19:50:54 -08:00

README.md

Flask-Micropub

A Flask extension to support IndieAuth and Micropub clients.

Authentication

Authentication uses the IndieAuth flow to confirm a user controls a particular URL, without requesting any sort of permissions or access token. Annotate an endpoint with @micropub.authenticated_handler and then call micropub.authenticate to initiate the login.

Authorization

Authorization uses the full Micropub flow to authenticate a user and then request an access token with which to make micropub requests. Annotate an endpoint with @micropub.authorized_handler and then call micropub.authorize to initiate the login.

CSRF

MicropubClient provides a simple mechanism to deter Cross-Site Request Forgery. Based on this Flask snippet, we generate a random string, pass it to the indieauth service via the state parameter, and then confirm we get the same random string back later.

This helps prevent malicious sites from sending users to your indieauth endpoint against their will.

Example

from flask import Flask, request, url_for
from flask.ext.micropub import MicropubClient

app = Flask(__name__)
micropub = MicropubClient(app)


@app.route('/login')
def login():
    return micropub.authorize(
        me, scope=request.args.get('scope'))


@app.route('/micropub-callback')
@micropub.authorized_handler
def micropub_callback(resp):
    print('success!', resp.me, resp.access_token, resp.next_url, resp.error)

See example.py for a more thorough example. Protocol details at https://indiewebcamp.com/IndieAuth and https://indiewebcamp.com/Micropub