Revised the documentation.
This commit is contained in:
		| @@ -1,23 +1,23 @@ | ||||
| flask\_digest\_auth package | ||||
| =========================== | ||||
|  | ||||
| The ``DigestAuth`` class | ||||
| ************************ | ||||
| The ``DigestAuth`` Class | ||||
| ------------------------ | ||||
| .. autoclass:: flask_digest_auth.DigestAuth | ||||
|     :members: | ||||
|     :undoc-members: | ||||
|     :show-inheritance: | ||||
|  | ||||
| The ``make_password_hash`` Function | ||||
| *********************************** | ||||
| ----------------------------------- | ||||
| .. autofunction:: flask_digest_auth.make_password_hash | ||||
|  | ||||
| The ``calc_response`` Function | ||||
| ****************************** | ||||
| ------------------------------ | ||||
| .. autofunction:: flask_digest_auth.calc_response | ||||
|  | ||||
| The ``Client`` Test Class | ||||
| ************************* | ||||
| ------------------------- | ||||
| .. autoclass:: flask_digest_auth.Client | ||||
|     :members: | ||||
|     :undoc-members: | ||||
|   | ||||
| @@ -6,6 +6,12 @@ | ||||
| Welcome to Flask-Digest-Auth's documentation! | ||||
| ============================================= | ||||
|  | ||||
| *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`_. | ||||
|  | ||||
| .. toctree:: | ||||
|    :maxdepth: 2 | ||||
|    :caption: Contents: | ||||
| @@ -22,3 +28,7 @@ Indices and tables | ||||
| * :ref:`genindex` | ||||
| * :ref:`modindex` | ||||
| * :ref:`search` | ||||
|  | ||||
| .. _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 | ||||
|   | ||||
| @@ -12,11 +12,11 @@ HTTP Digest Authentication is specified in `RFC 2617`_. | ||||
| Why HTTP Digest Authentication? | ||||
| ------------------------------- | ||||
|  | ||||
| HTTP Digest Authentication has the advantage that it does not send the | ||||
| actual password to the server, which greatly enhances the security. | ||||
| It uses the challenge-response authentication scheme.  The client | ||||
| returns the response calculated from the challenge and the password, | ||||
| but not the original password. | ||||
| *HTTP Digest Authentication* has the advantage that it does not send | ||||
| the actual password to the server, which greatly enhances the | ||||
| security.  It uses the challenge-response authentication scheme.  The | ||||
| client returns the response calculated from the challenge and the | ||||
| password, but not the original password. | ||||
|  | ||||
| Log in forms has the advantage of freedom, in the senses of both the | ||||
| visual design and the actual implementation.  You may implement your | ||||
| @@ -43,7 +43,7 @@ You may also install the latest source from the | ||||
|  | ||||
| :: | ||||
|  | ||||
|     pip install git+https://github.com/imacat/flask-digest-auth | ||||
|     pip install git+https://github.com/imacat/flask-digest-auth.git | ||||
|  | ||||
|  | ||||
| Setting the Password | ||||
|   | ||||
		Reference in New Issue
	
	Block a user