Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

SemVer public API

The public API of this library consists of all public or protected methods, properties and constants belonging to the src folder.

As far as possible, we try to adhere to Symfony guidelines when deciding whether a change is a breaking change or not.

3.5.0 - 2024-10-18

Compare with previous release

Added

Add AppSec settings to manage maximum size of the request body
- Add appsec_max_body_size_kb setting
- Add appsec_body_size_exceeded_action setting

3.4.0 - 2024-10-04

Compare with previous release

Added

Add AppSec requests support with getAppSecRemediation public method in LapiRemediation class
Add appsec_fallback_remediation configuration for Lapi remediation

Changed

Update crowdsec/common dependency to v2.3.0
Update crowdsec/capi-client dependency to v3.2.0
Update crowdsec/lapi-client dependency to v3.3.0

3.3.0 - 2023-12-14

Compare with previous release

Changed

Update crowdsec/common dependency to v2.2.0 (api_connect_timeout setting)
Update crowdsec/capi-client dependency to v3.1.0 (api_connect_timeout setting)
Update crowdsec/lapi-client dependency to v3.2.0 (api_connect_timeout setting)

3.2.0 - 2023-04-20

Compare with previous release

Changed

Store origin of decision in cache

Added

Store origin count of getIpRemediation in cache and provide a getOriginsCount helper method

Deprecated

Deprecate AbstractRemediation::getRemediationFromDecisions
Deprecate AbstractRemediation::sortDecisionsByRemediationPriority

3.1.1 - 2023-03-24

Compare with previous release

Fixed

Do not set logger in Memcached cache to avoid silent error

3.1.0 - 2023-03-24

Compare with previous release

Changed

Instantiate provided Redis and PhpFiles caches without cache tags by default
Do not cache CAPI decision with 0h duration
Set logger in cache adapter to log Symfony cache messages

Added

Add a boolean use_cache_tags setting for Redis and PhpFiles caches. Default to false.

3.0.0 - 2023-03-09

Compare with previous release

Changed

Breaking change: Update crowdsec/capi-client dependency to v3.0.0 (CAPI V3 endpoints)
Breaking change: Update crowdsec/lapi-client dependency to v3.0.0
Breaking change: Update crowdsec/common dependency to v2.0.0
Breaking change: Use custom error handler for Memcached::getItem method
Breaking change: Rename AbstractCache::updateItem method to upsertItem
Breaking change: The cacheTag string parameter of cache methods become a tags array
Change visibility of AbstractRemediation::parseDurationToSeconds method from private to protected

Added

Handle blocklist decisions when pulling CAPI decisions

2.1.0 - 2023-02-10

Compare with previous release

Added

Add public method getClient for LapiRemediation and CapiRemediation classes

2.0.0 - 2023-02-02

Compare with previous release

Changed

Breaking change: Update crowdsec/capi-client to a new major version 2.0.0
Breaking change: Update crowdsec/lapi-client to a new major version 2.0.0
Use crowdsec/common package as a dependency for code factoring

Removed

Breaking change: Remove CrowdSec\RemediationEngine\Logger\FileLog (replaced by CrowdSec\Common\Logger\FileLog)

1.0.1 - 2023-01-27

Compare with previous release

Added

Add public API declaration

1.0.0 - 2023-01-27

Compare with previous release

Changed

Change version to 1.0.0: first stable release

0.7.0 - 2023-01-13

Compare with previous release

Changed

Update crowdsec/capi-client dependency to v0.11.0

0.6.1 - 2023-01-12

Compare with previous release

Fixed

Fix some PHPDoc @throws tags

0.6.0 - 2023-01-12

Compare with previous release

Changed

For LAPI in live mode, we use and save retrieved IPv6 range scoped decisions as IP scoped decisions
Unexpected configuration keys are automatically removed by a new cleanConfigs method
Do not try to retrieve range scoped decisions in cache for IPv6 IP as it is not yet implemented
Update some logs
Update crowdsec/capi-client dependency to v0.10.0
Update crowdsec/lapi-client dependency to v0.4.0
Do not throw exception for unknown prefix in getCacheKey method

Added

Add public method getCacheStorage for remediations
Add public method unsetIpVariables for cache
Add public method clearGeolocationCache for geolocation

0.5.0 - 2023-01-05

Compare with previous release

Changed

Use message log instead of a context message field
Update crowdsec/capi-client dependency to v0.9.0
Update crowdsec/lapi-client dependency to v0.3.0

Added

Add cache warmup feature for LAPI

0.4.0 - 2022-12-30

Compare with previous release

Changed

Modify some log format and severity level

Added

Add symfony/cache conflicts for Redis not working versions
Add some relevant logs

0.3.1 - 2022-12-29

Compare with previous release

Changed

Update symfony/cache dependency to only exclude Redis not working versions

0.3.0 - 2022-12-29

Compare with previous release

Changed

Update crowdsec/capi-client dependency to v0.7.0
Update crowdsec/lapi-client dependency to v0.2.0
Fix symfony/cache dependency to 5.4.15 or 6.0.15 as 5.4.17 and 6.0.17 are buggy for Redis

0.2.0 - 2022-12-23

Compare with previous release

Added

Add geolocation feature to get remediation from Country scoped decisions (using MaxMind databases)

0.1.1 - 2022-12-16

Compare with previous release

Changed

Update crowdsec/capi-client dependency to v0.6.0
Add PHP 8.2 in supported versions

0.1.0 - 2022-12-09

Compare with previous release

Changed

Breaking change: Make methods AbstractRemediation::storeDecisions and AbstractRemediation::removeDecisions protected instead of public and modify return type (int to array)

Added

Add LAPI remediation feature

0.0.2 - 2022-12-08

Compare with previous release

Changed

Update crowdsec/capi-client dependency to allow older symfony/config (v4) version

0.0.1 - 2022-12-02

Added

Initial release