When this directive is used, authentication information is obtained from an :mod:`paste.auth.auth_tkt` cookie value, assumed to be set by a custom login form.
secretis a string that will be used to sign the data stored by the cookie. It is required and has no default.
callbackis a Python dotted name to a function passed the string representing the userid stored in the cookie and the request as positional arguments. The callback is expected to return None if the user represented by the string doesn't exist or a sequence of group identifiers (possibly empty) if the user does exist. If
callbackis None, the userid will be assumed to exist with no groups. It defaults to
cookie_nameis the name used for the cookie that contains the user information. It defaults to
secureis a boolean value. If it's set to "true", the cookie will only be sent back by the browser over a secure (HTTPS) connection. It defaults to "false".
include_ipis a boolean value. If it's set to true, the requesting IP address is made part of the authentication data in the cookie; if the IP encoded in the cookie differs from the IP of the requesting user agent, the cookie is considered invalid. It defaults to "false".
timeoutis an integer value. It represents the maximum age in seconds which the auth_tkt ticket will be considered valid. If
timeoutis specified, and
reissue_timeis also specified,
reissue_timemust be a smaller value than
timeout. It defaults to
None, meaning that the ticket will be considered valid forever.
reissue_timeis an integer value. If
reissue_timeis specified, when we encounter a cookie that is older than the reissue time (in seconds), but younger that the
timeout, a new cookie will be issued. It defaults to
None, meaning that authentication cookies are never reissued. A value of
0means reissue a cookie in the response to every request that requires authentication.
max_ageis the maximum age of the auth_tkt cookie, in seconds. This differs from
timeoutrepresents the lifetime of the ticket contained in the cookie, while this value represents the lifetime of the cookie itself. When this value is set, the cookie's
Expiressettings will be set, allowing the auth_tkt cookie to last between browser sessions. It is typically nonsensical to set this to a value that is lower than
reissue_time, although it is not explicitly prevented. It defaults to
None, meaning (on all major browser platforms) that auth_tkt cookies will last for the lifetime of the user's browser session.
- A boolean value. If it's set to "true", a cookie with a "wild" domain
value will only be sent back by the browser during
remember. It defaults to "true".
You may create an instance of the
pass it to the :class:`pyramid.config.Configurator`
constructor as the
authentication_policy argument during initial