1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
from flask import g
from werkzeug.local import LocalProxy
from flask_dance.consumer import OAuth2ConsumerBlueprint
__maintainer__ = "David Baumgold <david@davidbaumgold.com>"
def make_github_blueprint(
client_id=None,
client_secret=None,
*,
scope=None,
redirect_url=None,
redirect_to=None,
login_url=None,
authorized_url=None,
session_class=None,
storage=None,
rule_kwargs=None,
):
"""
Make a blueprint for authenticating with GitHub using OAuth 2. This requires
a client ID and client secret from GitHub. You should either pass them to
this constructor, or make sure that your Flask application config defines
them, using the variables :envvar:`GITHUB_OAUTH_CLIENT_ID` and
:envvar:`GITHUB_OAUTH_CLIENT_SECRET`.
Args:
client_id (str): The client ID for your application on GitHub.
client_secret (str): The client secret for your application on GitHub
scope (str, optional): comma-separated list of scopes for the OAuth token
redirect_url (str): the URL to redirect to after the authentication
dance is complete
redirect_to (str): if ``redirect_url`` is not defined, the name of the
view to redirect to after the authentication dance is complete.
The actual URL will be determined by :func:`flask.url_for`
login_url (str, optional): the URL path for the ``login`` view.
Defaults to ``/github``
authorized_url (str, optional): the URL path for the ``authorized`` view.
Defaults to ``/github/authorized``.
session_class (class, optional): The class to use for creating a
Requests session. Defaults to
:class:`~flask_dance.consumer.requests.OAuth2Session`.
storage: A token storage class, or an instance of a token storage
class, to use for this blueprint. Defaults to
:class:`~flask_dance.consumer.storage.session.SessionStorage`.
rule_kwargs (dict, optional): Additional arguments that should be passed when adding
the login and authorized routes. Defaults to ``None``.
:rtype: :class:`~flask_dance.consumer.OAuth2ConsumerBlueprint`
:returns: A :doc:`blueprint <flask:blueprints>` to attach to your Flask app.
"""
github_bp = OAuth2ConsumerBlueprint(
"github",
__name__,
client_id=client_id,
client_secret=client_secret,
scope=scope,
base_url="https://api.github.com/",
authorization_url="https://github.com/login/oauth/authorize",
token_url="https://github.com/login/oauth/access_token",
redirect_url=redirect_url,
redirect_to=redirect_to,
login_url=login_url,
authorized_url=authorized_url,
session_class=session_class,
storage=storage,
rule_kwargs=rule_kwargs,
)
github_bp.from_config["client_id"] = "GITHUB_OAUTH_CLIENT_ID"
github_bp.from_config["client_secret"] = "GITHUB_OAUTH_CLIENT_SECRET"
@github_bp.before_app_request
def set_applocal_session():
g.flask_dance_github = github_bp.session
return github_bp
github = LocalProxy(lambda: g.flask_dance_github)
|
