Log cookie data

Looking at dot-errorhandler's config file, the array found at CookieProvider::class allows you to configure the behaviour of this provider:

• enabled: enabled/disable this provider
• processor: an array configuring the data processor to be used by the CookieProvider:
  • class: data processor class implementing Dot\ErrorHandler\Extra\Processor\ProcessorInterface
  • replacementStrategy: whether to replace specific cookie values completely or partially
  • sensitiveParameters: an array of cookies names that may contain sensitive information so their value should be masked partially/completely

Configure provider

By default, CookieProvider is disabled. It can be enabled only by setting enabled to true.

If enabled is set to true, your log file will contain an additional field under the extra key, called cookie. If enabled is set to false, no additional field is added under the extra key.

Configure processor

From here, we assume that enabled is set to true.

If processor is missing/empty, the processor is ignored the provider will log the raw data available. If processor is specified, but class is missing/invalid, the processor is ignored and the provider will log the raw data available.

From here, we assume that processor.class is valid.

Replacement strategy

This value should be an instance of Dot\ErrorHandler\Extra\ReplacementStrategy.

If replacementStrategy is missing/invalid, the default replacementStrategy is used, which is ReplacementStrategy::Full. Else, the value used should be one of:

• ReplacementStrategy::Partial for half-string replacements (e.g.: "abcdef" becomes "abc***")
• ReplacementStrategy::Full for full-string replacements (e.g.: "abcdef" becomes "**")

Sensitive parameters

If sensitiveParameters is missing/empty, the processor is ignored the provider will log the raw data available. This is because without a set of sensitiveParameters, the processor is unable to determine which key needs to be processed or left untouched. When specifying the array of sensitiveParameters, there are two possibilities:

• use the constant ProcessorInterface::ALL, meaning alter all cookie values using the strategy specified by the replacementStrategy

'sensitiveParameters' => [
    Dot\ErrorHandler\Extra\Processor\ProcessorInterface::ALL,
],

• use exact strings to list the cookies for which the values should be altered using the strategy specified by the replacementStrategy

'sensitiveParameters' => [
    'rememberMe',
],

CookieProcessor uses EXACT cookie name lookups. In order to alter the value of a cookie, you need to specify the exact cookie name.

The config sensitiveParameters is case-insensitive.

Why should I use a processor

Consider the following request cookies:

[
    "sessionId" => "feb21b39f9c54e3a49af1f862acc8300",
    "language" => "en",
]

Without a CookieProcessor, the plain text session cookie identifier would end up saved in the log file:

..."extra":{"file":"/path/to/some/class.php","line":314,"cookie":{"sessionId":"feb21b39f9c54e3a49af1f862acc8300","language":"en"},...

But, with a properly configured CookieProcessor:

'processor' => [
    'class'               => CookieProcessor::class,
    'replacementStrategy' => ReplacementStrategy::Full,
    'sensitiveParameters' => [
        'sessionId',
    ],
],

the logged cookie data becomes:

..."extra":{"file":"/path/to/some/class.php","line":314,"cookie":{"sessionId":"********************************","language":"en"},...

Custom processor

If the existing processor does not offer enough features, you can create a custom processor. The custom processor must implement Dot\ErrorHandler\Extra\Processor\ProcessorInterface or extend Dot\ErrorHandler\Extra\Processor\AbstractProcessor, which already implements Dot\ErrorHandler\Extra\Processor\ProcessorInterface. Once the custom processor is ready, you need to configure CookieProvider to use it. For this, open dot-errorhandler's config file and - under CookieProvider::class - set processor.class to the class string of your custom processor:

CookieProvider::class  => [
    'enabled'   => false,
    'processor' => [
        'class'               => CustomCookieProcessor::class,
        'replacementStrategy' => ReplacementStrategy::Full,
        'sensitiveParameters' => [
            ProcessorInterface::ALL,
        ],
    ],
],

Using this, cookie data will be processed by CustomCookieProcessor and logged as provided by this new processor.