| commit | author | age | ||
| 8315ba | 1 | .. _index: |
| CM | 2 | |
| 25ac2e | 3 | *************************************************** |
| CM | 4 | :mod:`repoze.who` -- WSGI Authentication Middleware |
| 5 | *************************************************** | |
| 6 | ||
| 06c6d1 | 7 | :Author: Chris McDonough / Tres Seaver |
| 25ac2e | 8 | :Version: |version| |
| CM | 9 | |
| 10 | .. module:: repoze.who | |
| 11 | :synopsis: WSGI authentication middleware | |
| 12 | ||
| 13 | .. topic:: Overview | |
| 14 | ||
| 15 | :mod:`repoze.who` is an identification and authentication framework | |
| 3a943d | 16 | for arbitrary WSGI applications. It can be used as WSGI middleware, |
| TS | 17 | or as an API from within a WSGI application. |
| 25ac2e | 18 | |
| CM | 19 | :mod:`repoze.who` is inspired by Zope 2's Pluggable Authentication |
| 20 | Service (PAS) (but :mod:`repoze.who` is not dependent on Zope in any | |
| 21 | way; it is useful for any WSGI application). It provides no | |
| 22 | facility for authorization (ensuring whether a user can or cannot | |
| 23 | perform the operation implied by the request). This is considered | |
| 24 | to be the domain of the WSGI application. | |
| 25 | ||
| caa42f | 26 | It attempts to reuse implementations from ``paste.auth`` for some |
| 25ac2e | 27 | of its functionality. |
| CM | 28 | |
| 8315ba | 29 | Sections |
| CM | 30 | ======== |
| 25ac2e | 31 | |
| 8315ba | 32 | .. toctree:: |
| CM | 33 | :maxdepth: 2 |
| 25ac2e | 34 | |
| 8315ba | 35 | narr |
| 359fe8 | 36 | use_cases |
| d95e97 | 37 | middleware |
| TS | 38 | api |
| 39 | configuration | |
| 40 | plugins | |
| 25ac2e | 41 | |
| 8315ba | 42 | Change History |
| CM | 43 | ============== |
| 25ac2e | 44 | |
| 8315ba | 45 | .. toctree:: |
| CM | 46 | :maxdepth: 2 |
| 25ac2e | 47 | |
| 8315ba | 48 | changes |
| 25ac2e | 49 | |
| 8315ba | 50 | Support and Development |
| CM | 51 | ======================= |
| 25ac2e | 52 | |
| 8315ba | 53 | To report bugs, use the `Repoze bug tracker <http://bugs.repoze.org>`_. |
| 25ac2e | 54 | |
| 8315ba | 55 | If you've got questions that aren't answered by this documentation, |
| CM | 56 | contact the `Repoze-dev maillist |
| 57 | <http://lists.repoze.org/listinfo/repoze-dev>`_ or join the `#repoze | |
| 58 | IRC channel <irc://irc.freenode.net/#repoze>`_. | |
| 25ac2e | 59 | |
| 8315ba | 60 | Browse and check out tagged and trunk versions of :mod:`repoze.who` |
| 3869bf | 61 | via the `Repoze github repository |
| TM | 62 | <https://github.com/repoze/repoze.who/>`_. To check out the trunk |
| 63 | via git, use this command:: | |
| 25ac2e | 64 | |
| 3869bf | 65 | git clone https://github.com:repoze/repoze.who.git |
| TM | 66 | |
| 67 | Or, if you are logged in: | |
| 68 | ||
| 69 | git clone git@github.com:repoze/repoze.who.git | |
| 25ac2e | 70 | |
| 8315ba | 71 | To find out how to become a contributor to :mod:`repoze.who`, please |
| CM | 72 | see the `contributor's page <http://repoze.org/contributing.html>`_. |
| 37de44 | 73 | |
| 8315ba | 74 | Indices and tables |
| CM | 75 | ================== |
| 25ac2e | 76 | |
| 8315ba | 77 | * :ref:`genindex` |
| CM | 78 | * :ref:`modindex` |
| 79 | * :ref:`search` | |
| 25ac2e | 80 | |
