Compare commits
No commits in common. "4f30756dc51a0a275c5d4684dcc77485d33d89a0" and "2de770aed0e2d9f683c2325e130804cb3c123cca" have entirely different histories.
4f30756dc5
...
2de770aed0
46
README.rst
46
README.rst
@ -6,13 +6,13 @@ Flask HTTP Digest Authentication
|
||||
Description
|
||||
===========
|
||||
|
||||
*Flask-DigestAuth* is an `HTTP Digest Authentication`_ implementation
|
||||
*Flask-Digest-Auth* is an `HTTP Digest Authentication`_ implementation
|
||||
for Flask_ applications. It authenticates the user for the protected
|
||||
views.
|
||||
|
||||
HTTP Digest Authentication is specified in `RFC 2617`_.
|
||||
|
||||
Refer to the full `Flask-DigestAuth readthedocs documentation`_.
|
||||
Refer to the full `Flask-Digest-Auth readthedocs documentation`_.
|
||||
|
||||
|
||||
Why HTTP Digest Authentication?
|
||||
@ -30,7 +30,7 @@ own challenge-response log in form, but then you are reinventing the
|
||||
wheels. If a pretty log in form is not critical to your project, HTTP
|
||||
Digest Authentication should be a good choice.
|
||||
|
||||
Flask-DigestAuth works with Flask-Login_. Log in protection can be
|
||||
Flask-Digest-Auth works with Flask-Login_. Log in protection can be
|
||||
separated with the authentication mechanism. You can create protected
|
||||
Flask modules without knowing the actual authentication mechanisms.
|
||||
|
||||
@ -38,18 +38,18 @@ Flask modules without knowing the actual authentication mechanisms.
|
||||
Installation
|
||||
============
|
||||
|
||||
You can install Flask-DigestAuth with ``pip``:
|
||||
You can install Flask-Digest-Auth with ``pip``:
|
||||
|
||||
::
|
||||
|
||||
pip install Flask-DigestAuth
|
||||
pip install Flask-Digest-Auth
|
||||
|
||||
You may also install the latest source from the
|
||||
`Flask-DigestAuth GitHub repository`_.
|
||||
`Flask-Digest-Auth GitHub repository`_.
|
||||
|
||||
::
|
||||
|
||||
pip install git+https://github.com/imacat/flask-digestauth.git
|
||||
pip install git+https://github.com/imacat/flask-digest-auth.git
|
||||
|
||||
|
||||
Setting the Password
|
||||
@ -70,14 +70,14 @@ you need to ask their password, to generate and store the new password
|
||||
hash.
|
||||
|
||||
|
||||
Flask-DigestAuth Alone
|
||||
======================
|
||||
Flask-Digest-Auth Alone
|
||||
=======================
|
||||
|
||||
Flask-DigestAuth can authenticate the users alone.
|
||||
Flask-Digest-Auth can authenticate the users alone.
|
||||
|
||||
|
||||
Simple Applications with Flask-DigestAuth Alone
|
||||
-----------------------------------------------
|
||||
Simple Applications with Flask-Digest-Auth Alone
|
||||
------------------------------------------------
|
||||
|
||||
In your ``my_app.py``:
|
||||
|
||||
@ -112,8 +112,8 @@ In your ``my_app.py``:
|
||||
return redirect(request.form.get("next"))
|
||||
|
||||
|
||||
Larger Applications with ``create_app()`` with Flask-DigestAuth Alone
|
||||
---------------------------------------------------------------------
|
||||
Larger Applications with ``create_app()`` with Flask-Digest-Auth Alone
|
||||
----------------------------------------------------------------------
|
||||
|
||||
In your ``my_app/__init__.py``:
|
||||
|
||||
@ -169,19 +169,19 @@ In your ``my_app/views.py``:
|
||||
Flask-Login Integration
|
||||
=======================
|
||||
|
||||
Flask-DigestAuth works with Flask-Login_. You can write a Flask
|
||||
Flask-Digest-Auth works with Flask-Login_. You can write a Flask
|
||||
module that requires log in, without specifying how to log in. The
|
||||
application can use either HTTP Digest Authentication, or the log in
|
||||
forms, as needed.
|
||||
|
||||
To use Flask-Login with Flask-DigestAuth,
|
||||
To use Flask-Login with Flask-Digest-Auth,
|
||||
``login_manager.init_app(app)`` must be called before
|
||||
``auth.init_app(app)``.
|
||||
|
||||
The currently logged-in user can be retrieved at
|
||||
``flask_login.current_user``, if any.
|
||||
|
||||
The views only depend on Flask-Login, but not the Flask-DigestAuth.
|
||||
The views only depend on Flask-Login, but not the Flask-Digest-Auth.
|
||||
You can change the actual authentication mechanism without changing
|
||||
the views.
|
||||
|
||||
@ -293,7 +293,7 @@ mechanism without changing the views.
|
||||
Session Integration
|
||||
===================
|
||||
|
||||
Flask-DigestAuth features session integration. The user log in
|
||||
Flask-Digest-Auth features session integration. The user log in
|
||||
is remembered in the session. The authentication information is not
|
||||
requested again. This is different to the practice of the HTTP Digest
|
||||
Authentication, but is convenient for the log in accounting.
|
||||
@ -315,14 +315,14 @@ logging the log in event, adding the log in counter, etc.
|
||||
Log Out
|
||||
=======
|
||||
|
||||
Flask-DigestAuth supports log out. The user will be prompted for the
|
||||
Flask-Digest-Auth supports log out. The user will be prompted for the
|
||||
new username and password.
|
||||
|
||||
|
||||
Test Client
|
||||
===========
|
||||
|
||||
Flask-DigestAuth comes with a test client that supports HTTP digest
|
||||
Flask-Digest-Auth comes with a test client that supports HTTP digest
|
||||
authentication.
|
||||
|
||||
|
||||
@ -389,7 +389,7 @@ A pytest Test
|
||||
Copyright
|
||||
=========
|
||||
|
||||
Copyright (c) 2022-2023 imacat.
|
||||
Copyright (c) 2022 imacat.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
@ -414,6 +414,6 @@ Authors
|
||||
.. _HTTP Digest Authentication: https://en.wikipedia.org/wiki/Digest_access_authentication
|
||||
.. _RFC 2617: https://www.rfc-editor.org/rfc/rfc2617
|
||||
.. _Flask: https://flask.palletsprojects.com
|
||||
.. _Flask-DigestAuth GitHub repository: https://github.com/imacat/flask-digestauth
|
||||
.. _Flask-DigestAuth readthedocs documentation: https://flask-digestauth.readthedocs.io
|
||||
.. _Flask-Digest-Auth GitHub repository: https://github.com/imacat/flask-digest-auth
|
||||
.. _Flask-Digest-Auth readthedocs documentation: https://flask-digest-auth.readthedocs.io
|
||||
.. _Flask-Login: https://flask-login.readthedocs.io
|
||||
|
||||
@ -10,10 +10,10 @@ sys.path.insert(0, os.path.abspath('../../src/'))
|
||||
# -- Project information -----------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
||||
|
||||
project = 'Flask-DigestAuth'
|
||||
copyright = '2022-2023, imacat'
|
||||
project = 'Flask-Digest-Auth'
|
||||
copyright = '2022, imacat'
|
||||
author = 'imacat'
|
||||
release = '0.4.0'
|
||||
release = '0.3.1'
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
||||
|
||||
@ -4,8 +4,8 @@ Examples
|
||||
|
||||
.. _example-alone-simple:
|
||||
|
||||
Simple Applications with Flask-DigestAuth Alone
|
||||
-----------------------------------------------
|
||||
Simple Applications with Flask-Digest-Auth Alone
|
||||
------------------------------------------------
|
||||
|
||||
In your ``my_app.py``:
|
||||
|
||||
@ -42,8 +42,8 @@ In your ``my_app.py``:
|
||||
|
||||
.. _example-alone-large:
|
||||
|
||||
Larger Applications with ``create_app()`` with Flask-DigestAuth Alone
|
||||
---------------------------------------------------------------------
|
||||
Larger Applications with ``create_app()`` with Flask-Digest-Auth Alone
|
||||
----------------------------------------------------------------------
|
||||
|
||||
In your ``my_app/__init__.py``:
|
||||
|
||||
|
||||
@ -1,12 +1,12 @@
|
||||
.. Flask-DigestAuth documentation master file, created by
|
||||
.. Flask-Digest-Auth documentation master file, created by
|
||||
sphinx-quickstart on Wed Dec 7 09:40:48 2022.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to Flask-DigestAuth's documentation!
|
||||
============================================
|
||||
Welcome to Flask-Digest-Auth's documentation!
|
||||
=============================================
|
||||
|
||||
*Flask-DigestAuth* is an `HTTP Digest Authentication`_ implementation
|
||||
*Flask-Digest-Auth* is an `HTTP Digest Authentication`_ implementation
|
||||
for Flask_ applications. It authenticates the user for the protected
|
||||
views.
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@ Introduction
|
||||
============
|
||||
|
||||
|
||||
*Flask-DigestAuth* is an `HTTP Digest Authentication`_ implementation
|
||||
*Flask-Digest-Auth* is an `HTTP Digest Authentication`_ implementation
|
||||
for Flask_ applications. It authenticates the user for the protected
|
||||
views.
|
||||
|
||||
@ -24,7 +24,7 @@ own challenge-response log in form, but then you are reinventing the
|
||||
wheels. If a pretty log in form is not critical to your project, HTTP
|
||||
Digest Authentication should be a good choice.
|
||||
|
||||
Flask-DigestAuth works with Flask-Login_. Log in protection can be
|
||||
Flask-Digest-Auth works with Flask-Login_. Log in protection can be
|
||||
separated with the authentication mechanism. You can create protected
|
||||
Flask modules without knowing the actual authentication mechanisms.
|
||||
|
||||
@ -32,18 +32,18 @@ Flask modules without knowing the actual authentication mechanisms.
|
||||
Installation
|
||||
------------
|
||||
|
||||
You can install Flask-DigestAuth with ``pip``:
|
||||
You can install Flask-Digest-Auth with ``pip``:
|
||||
|
||||
::
|
||||
|
||||
pip install Flask-DigestAuth
|
||||
pip install Flask-Digest-Auth
|
||||
|
||||
You may also install the latest source from the
|
||||
`Flask-DigestAuth GitHub repository`_.
|
||||
`Flask-Digest-Auth GitHub repository`_.
|
||||
|
||||
::
|
||||
|
||||
pip install git+https://github.com/imacat/flask-digestauth.git
|
||||
pip install git+https://github.com/imacat/flask-digest-auth.git
|
||||
|
||||
|
||||
Setting the Password
|
||||
@ -66,10 +66,10 @@ hash.
|
||||
See :func:`flask_digest_auth.algo.make_password_hash`.
|
||||
|
||||
|
||||
Flask-DigestAuth Alone
|
||||
----------------------
|
||||
Flask-Digest-Auth Alone
|
||||
-----------------------
|
||||
|
||||
Flask-DigestAuth can authenticate the users alone.
|
||||
Flask-Digest-Auth can authenticate the users alone.
|
||||
|
||||
See :ref:`example-alone-simple` and :ref:`example-alone-large`.
|
||||
|
||||
@ -77,12 +77,12 @@ See :ref:`example-alone-simple` and :ref:`example-alone-large`.
|
||||
Flask-Login Integration
|
||||
-----------------------
|
||||
|
||||
Flask-DigestAuth works with Flask-Login_. You can write a Flask
|
||||
Flask-Digest-Auth works with Flask-Login_. You can write a Flask
|
||||
module that requires log in, without specifying how to log in. The
|
||||
application can use either HTTP Digest Authentication, or the log in
|
||||
forms, as needed.
|
||||
|
||||
To use Flask-Login with Flask-DigestAuth,
|
||||
To use Flask-Login with Flask-Digest-Auth,
|
||||
``login_manager.init_app(app)`` must be called before
|
||||
``auth.init_app(app)``.
|
||||
|
||||
@ -92,7 +92,7 @@ The currently logged-in user can be retrieved at
|
||||
See :ref:`example-flask-login-simple` and
|
||||
:ref:`example-flask-login-large`.
|
||||
|
||||
The views only depend on Flask-Login, but not the Flask-DigestAuth.
|
||||
The views only depend on Flask-Login, but not the Flask-Digest-Auth.
|
||||
You can change the actual authentication mechanism without changing
|
||||
the views.
|
||||
|
||||
@ -100,7 +100,7 @@ the views.
|
||||
Session Integration
|
||||
-------------------
|
||||
|
||||
Flask-DigestAuth features session integration. The user log in
|
||||
Flask-Digest-Auth features session integration. The user log in
|
||||
is remembered in the session. The authentication information is not
|
||||
requested again. This is different to the practice of the HTTP Digest
|
||||
Authentication, but is convenient for the log in accounting.
|
||||
@ -124,7 +124,7 @@ See :meth:`flask_digest_auth.auth.DigestAuth.register_on_login`.
|
||||
Log Out
|
||||
-------
|
||||
|
||||
Flask-DigestAuth supports log out. The user will be prompted for the
|
||||
Flask-Digest-Auth supports log out. The user will be prompted for the
|
||||
new username and password.
|
||||
|
||||
See :meth:`flask_digest_auth.auth.DigestAuth.logout`.
|
||||
@ -133,7 +133,7 @@ See :meth:`flask_digest_auth.auth.DigestAuth.logout`.
|
||||
Test Client
|
||||
-----------
|
||||
|
||||
Flask-DigestAuth comes with a test client that supports HTTP digest
|
||||
Flask-Digest-Auth comes with a test client that supports HTTP digest
|
||||
authentication.
|
||||
|
||||
See :class:`flask_digest_auth.test.Client`.
|
||||
@ -145,4 +145,4 @@ Also see :ref:`example-unittest` and :ref:`example-pytest`.
|
||||
.. _RFC 2617: https://www.rfc-editor.org/rfc/rfc2617
|
||||
.. _Flask: https://flask.palletsprojects.com
|
||||
.. _Flask-Login: https://flask-login.readthedocs.io
|
||||
.. _Flask-DigestAuth GitHub repository: https://github.com/imacat/flask-digestauth
|
||||
.. _Flask-Digest-Auth GitHub repository: https://github.com/imacat/flask-digest-auth
|
||||
|
||||
10
setup.cfg
10
setup.cfg
@ -1,7 +1,7 @@
|
||||
# The Flask HTTP Digest Authentication Project.
|
||||
# Author: imacat@mail.imacat.idv.tw (imacat), 2022/11/23
|
||||
|
||||
# Copyright (c) 2022-2023 imacat.
|
||||
# Copyright (c) 2022 imacat.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
@ -16,16 +16,16 @@
|
||||
# limitations under the License.
|
||||
|
||||
[metadata]
|
||||
name = Flask-DigestAuth
|
||||
version = 0.4.0
|
||||
name = flask-digest-auth
|
||||
version = 0.3.1
|
||||
author = imacat
|
||||
author_email = imacat@mail.imacat.idv.tw
|
||||
description = The Flask HTTP Digest Authentication project.
|
||||
long_description = file: README.rst
|
||||
long_description_content_type = text/x-rst
|
||||
url = https://github.com/imacat/flask-digestauth
|
||||
url = https://github.com/imacat/flask-digest-auth
|
||||
project_urls =
|
||||
Bug Tracker = https://github.com/imacat/flask-digestauth/issues
|
||||
Bug Tracker = https://github.com/imacat/flask-digest-auth/issues
|
||||
classifiers =
|
||||
Programming Language :: Python :: 3
|
||||
License :: OSI Approved :: Apache Software License
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
# The Flask HTTP Digest Authentication Project.
|
||||
# Author: imacat@mail.imacat.idv.tw (imacat), 2022/10/22
|
||||
|
||||
# Copyright (c) 2022-2023 imacat.
|
||||
# Copyright (c) 2022 imacat.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
@ -27,8 +27,7 @@ import typing as t
|
||||
from functools import wraps
|
||||
from secrets import token_urlsafe, randbits
|
||||
|
||||
from flask import g, request, Response, session, abort, Flask, Request, \
|
||||
current_app
|
||||
from flask import g, request, Response, session, abort, Flask, Request
|
||||
from itsdangerous import URLSafeTimedSerializer, BadData
|
||||
from werkzeug.datastructures import Authorization
|
||||
|
||||
@ -60,6 +59,8 @@ class DigestAuth:
|
||||
= ["auth", "auth-int"]
|
||||
"""A list of supported quality of protection supported, either
|
||||
``qop``, ``auth-int``, both, or empty. Default is both."""
|
||||
self.app: t.Optional[Flask] = None
|
||||
"""The current Flask application."""
|
||||
self.__get_password_hash: BasePasswordHashGetter \
|
||||
= BasePasswordHashGetter()
|
||||
"""The callback to return the password hash."""
|
||||
@ -327,8 +328,7 @@ class DigestAuth:
|
||||
self.__on_login = OnLogInCallback()
|
||||
|
||||
def init_app(self, app: Flask) -> None:
|
||||
"""Initializes the Flask application. The DigestAuth instance will
|
||||
be stored in ``app.extensions["digest_auth"]``.
|
||||
"""Initializes the Flask application.
|
||||
|
||||
:Example:
|
||||
|
||||
@ -342,7 +342,8 @@ class DigestAuth:
|
||||
:param app: The Flask application.
|
||||
:return: None.
|
||||
"""
|
||||
app.extensions["digest_auth"] = self
|
||||
app.digest_auth = self
|
||||
self.app = app
|
||||
|
||||
if hasattr(app, "login_manager"):
|
||||
from flask_login import LoginManager, login_user
|
||||
@ -355,8 +356,8 @@ class DigestAuth:
|
||||
|
||||
:return: None.
|
||||
"""
|
||||
state: AuthState = getattr(request, "_digest_auth_state") \
|
||||
if hasattr(request, "_digest_auth_state") \
|
||||
state: AuthState = request.digest_auth_state \
|
||||
if hasattr(request, "digest_auth_state") \
|
||||
else AuthState()
|
||||
response: Response = Response()
|
||||
response.status = 401
|
||||
@ -372,7 +373,7 @@ class DigestAuth:
|
||||
:return: The authenticated user, or None if the
|
||||
authentication fails
|
||||
"""
|
||||
request._digest_auth_state = AuthState()
|
||||
request.digest_auth_state = AuthState()
|
||||
authorization: Authorization = req.authorization
|
||||
try:
|
||||
if authorization is None:
|
||||
@ -380,7 +381,7 @@ class DigestAuth:
|
||||
if authorization.type != "digest":
|
||||
raise UnauthorizedException(
|
||||
"Not an HTTP digest authorization")
|
||||
self.__authenticate(request._digest_auth_state)
|
||||
self.__authenticate(request.digest_auth_state)
|
||||
user = login_manager.user_callback(
|
||||
authorization.username)
|
||||
login_user(user)
|
||||
@ -411,7 +412,7 @@ class DigestAuth:
|
||||
if "user" in session:
|
||||
del session["user"]
|
||||
try:
|
||||
if hasattr(current_app, "login_manager"):
|
||||
if hasattr(self.app, "login_manager"):
|
||||
from flask_login import logout_user
|
||||
logout_user()
|
||||
except ModuleNotFoundError:
|
||||
|
||||
Loading…
Reference in New Issue
Block a user