Changeset 95
- Timestamp:
- 07/14/07 17:56:46
- Files:
-
- AuthKit/branches/0.4/docs/manual.txt (modified) (11 diffs)
- AuthKit/branches/0.4/docs/pylons.txt (modified) (6 diffs)
Legend:
- Unmodified
- Added
- Removed
- Modified
- Copied
- Moved
AuthKit/branches/0.4/docs/manual.txt
r59 r95 5 5 6 6 :author: James Gardner 7 :date: 200 6-08-317 :date: 2007-07-12 8 8 9 9 .. note:: 10 10 11 This version of AuthKit is nothing like the old AuthKit 0.2 which used to be12 hosted in the Pylons SVN. This version is a generic framework, the old13 version was a specific implementation.11 This version of AuthKit (0.4) is nothing like the old AuthKit 0.2 12 which used to be hosted in the Pylons SVN. This version is a 13 generic framework, the old version was a specific implementation. 14 14 15 15 .. contents:: Table of Contents … … 110 110 111 111 authkit.enable = true 112 authkit. method = basic112 authkit.setup.method = basic 113 113 authkit.users = james:bananas 114 114 ben:apples … … 213 213 ``_`` characters and it also strips off the ``prefix`` defined when inilialising 214 214 the middleware. If you don't set ``prefix`` it defaults to ``authkit.``. This 215 means that options such as ``cookie_signout `` used by AuthKit can be written in216 the slightly more descriptive and clean form ``authkit.cookie.signout `` in the215 means that options such as ``cookie_signoutpath`` used by AuthKit can be written in 216 the slightly more descriptive and clean form ``authkit.cookie.signoutpath`` in the 217 217 config file. 218 218 … … 318 318 Use an OpenID passurl for authentication 319 319 320 As mentioned before you can specify this in your code as ``method="basic"`` or 321 in your config file as ``authkit.method = basic``. If you try to specify the 322 same option using both methods an error is raised, otherwise AuthKit tries to 323 use all the options from both sources. 320 As mentioned before you can specify this in your code as 321 ``method="basic"`` or in your config file as ``authkit.setup.method = 322 basic``. If you try to specify the same option using both methods an 323 error is raised, otherwise AuthKit tries to use all the options from 324 both sources. 324 325 325 326 Each of these options is described in detail in the following sections. … … 443 444 444 445 The example also specifies a ``cookie_secret`` which is a string used to help 445 make the encryption on the cookie more random and a ``cookie_signout ``446 make the encryption on the cookie more random and a ``cookie_signoutpath`` 446 447 parameter which is a special path which should automatically sign the user out 447 448 when visited but will still display the resulting page so that your application … … 518 519 environ['paste.auth_tkt.set_user'](username) 519 520 520 If you specify a ``cookie_signout `` path when you set up the authentication521 If you specify a ``cookie_signoutpath`` path when you set up the authentication 521 522 middleware the user will be signed out automatically when visiting that path 522 523 but you will still need to display a "signed out" path at that URL or the user … … 575 576 576 577 authkit.enable = true 577 authkit. method = passurl578 authkit.setup.method = passurl 578 579 authkit.cookie.secret = some secret phrase 579 580 … … 616 617 incidentally the same as for form authentication or forward authentication. 617 618 618 Remember that if you specify ``cookie_signout `` the cookie will be removed but if619 Remember that if you specify ``cookie_signoutpath`` the cookie will be removed but if 619 620 you do not handle the path in the application the user is likely to be shown a 620 621 "404 Not Found" page. See the documentation about the forward section for a … … 771 772 ``form_and_email`` method:: 772 773 773 authkit. method = form_and_email774 authkit.setup.method = form_and_email 774 775 775 776 Writing your own middleware can be slightly tricker than you might expect if … … 804 805 used from a different IP address and hence to try to improve security. 805 806 806 cookie_signout 807 cookie_signoutpath 807 808 808 809 A path which when visited will cause the cookie to be removed and the … … 839 840 # AuthKit Options 840 841 authkit.enable = true 841 authkit. method = forward842 authkit.setup.method = forward 842 843 authkit.cookie.secret = random string 843 844 authkit.cookie.name = test AuthKit/branches/0.4/docs/pylons.txt
r59 r95 3 3 4 4 :author: James Gardner 5 :date: 200 8-08-305 :date: 2007-07-12 6 6 7 7 .. contents:: Table of Contents … … 154 154 can install it with this command:: 155 155 156 easy_install -U "AuthKit==0. 3"156 easy_install -U "AuthKit==0.4" 157 157 158 158 .. note:: 159 159 160 Un itl AuthKit 0.3is released you will need to use::160 Until AuthKit 0.4 is released you will need to use:: 161 161 162 162 easy_install -U http://authkit.org/svn/AuthKit/trunk#egg=AuthKit-dev … … 179 179 180 180 import authkit.authenticate 181 app = authkit.authenticate.middleware(app, config_paste=app_conf) 181 app = authkit.authenticate.middleware(app, app_conf=app_conf, 182 global_conf=global_conf) 182 183 183 184 .. note:: … … 253 254 ... 254 255 authkit.enable = true 255 authkit. method = digest256 authkit.setup.method = digest 256 257 authkit.users.setup = user:pylons 257 258 … … 295 296 ... 296 297 authkit.enable = true 297 authkit. method = form298 authkit.setup.method = form 298 299 authkit.cookie.secret = a random string 299 authkit.cookie.signout = /hello/signout/300 authkit.cookie.signoutpath = /hello/signout/ 300 301 authkit.users.setup = user:pylons 301 302 another:password … … 325 326 .. note :: 326 327 327 The ``authkit.cookie.signout `` option should be the exact path you use328 The ``authkit.cookie.signoutpath`` option should be the exact path you use 328 329 for signing out. For example, if you choose ``/hello/signout/`` then 329 330 ``/hello/signout`` and ``/hello/signout/page`` won't sign the user out,
