diff options
| author | Michael Merickel <michael@merickel.org> | 2013-03-19 16:03:24 -0700 |
|---|---|---|
| committer | Michael Merickel <michael@merickel.org> | 2013-03-19 16:17:24 -0700 |
| commit | 50e1a3b596b3c33c2254163e52eacfb1a519450c (patch) | |
| tree | efd940caf4abdbb0fc1ae038ab5a88322977b921 | |
| parent | 813eb45a18fb040bf211b5bf1b0164d5dbca678c (diff) | |
| download | pyramid-50e1a3b596b3c33c2254163e52eacfb1a519450c.tar.gz pyramid-50e1a3b596b3c33c2254163e52eacfb1a519450c.tar.bz2 pyramid-50e1a3b596b3c33c2254163e52eacfb1a519450c.zip | |
enhance the docstring on include_ip in auth tkt to explain compatability
| -rw-r--r-- | pyramid/authentication.py | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/pyramid/authentication.py b/pyramid/authentication.py index 43353f3e2..bc0286ed3 100644 --- a/pyramid/authentication.py +++ b/pyramid/authentication.py @@ -450,9 +450,11 @@ class AuthTktAuthenticationPolicy(CallbackAuthenticationPolicy): Default: ``False``. Make the requesting IP address part of the authentication data in the cookie. Optional. - For IPv6 this option is not recommended. It ties the authentication - ticket to that individual's IPv6 address. Depending on the network they - are on, the IPv6 address that a user is using may expire quickly. + For IPv6 this option is not recommended. The ``mod_auth_tkt`` + specification does not specify how to handle IPv6 addresses, so using + this option in combination with IPv6 addresses may cause an + incompatible cookie. It ties the authentication ticket to that + individual's IPv6 address. ``timeout`` |