semvec/pypi-packages huggingface dataset:
collective.usernamelogger 1.4
Log user names when using cookie authentication in Zope/Plone.
License: BSD
Keywords: zope plone logging pas

Introduction
------------

This package provides logging of user names in `Zope`_'s access log files
when using cookie-based authentication as provided by PluggableAuthService_
and `plone.session`_.

  .. _`Zope`: http://www.zope.org/
  .. _`PluggableAuthService`: http://pypi.python.org/pypi/Products.PluggableAuthService/
  .. _`plone.session`: http://pypi.python.org/pypi/plone.session/


Installation
------------

The easiest way to use this package is when working with installations
based on `zc.buildout`_.  Here you can simply add the package to your "eggs"
and "zcml" options, run buildout and restart your `Zope`_/`Plone`_ instance.

  .. _`zc.buildout`: http://pypi.python.org/pypi/zc.buildout/
  .. _`Plone`: http://www.plone.org/

Alternatively you can use the following configuration file to extend your
existing buildout::

  [buildout]
  extends = buildout.cfg

  [instance]
  eggs += collective.usernamelogger
  zcml += collective.usernamelogger

After that you should see user names being logged in your access log file,
typically at `<site-root>/var/log/instance-Z2.log`.


Changelog
=========


1.4 (2016-02-25)
----------------

- Make session cookie name configurable via environment variable:
  Using the env variable USERNAMELOGGER_AC_COOKIE_NAME, the session cookie
  name can be set to a different value than the default of '__ac'.
  [lgraf]


1.3 (2015-06-12)
----------------

- Don't crash if we get a CookieError.
  [vincentfretin]

- Properly deal with doubly quoted __ac cookies (e.g. from PAS.CookieAuthHelper).
  [lgraf]

- skip binascii.Error
  [kroman0]

- Added getting real client ip
  [kroman0]


1.2 (2011-08-16)
----------------

- Added support for Plone 4.x session cookies.
  [buchi]

- Handle auth cookies that aren't hex encoded (used in PluggableAuthService
  < 1.5).
  [buchi]

- Add `z3c.autoinclude` entry point for automatic ZCML loading in Plone 3.3+.
  [witsch]


1.1 (2010-01-07)
----------------

- Unquote the cookie value before attempting to decode it.
  [vincentfretin]


1.0 (2009-08-08)
----------------

- Re-release unchanged 1.0a2 as final.
  [witsch]


1.0a2 (2009-07-24)
------------------

- Split session cookie from the right as the token can also contain spaces.
  [witsch]

- Handle session cookies first as they can contain a colon, thereby breaking
  the hexadecimal decode.
  [witsch]


1.0a1 (2009-07-23)
------------------

- Initial release
  [witsch]