Python agent release notes

End of support for language version 3.7.

Updated mysql-connector to the latest version.

Release of language version 3.12.

Added the reporting of active configuration and source of the settings.

Added support for agent.logger.stdout in the common configuration.

Enabled sys.monitoring INSTRUCTION-level events.

We no longer throw an exception when trying to log effective config to disk when agent log path is set to STDOUT.

Updated hardcoded key list to exclude SCHEMA.

When instrumenting a Django application with manual middleware installation, the agent did not automatically discover routes. (PYT-3085)

When running Assess in a Django application, the agent incorrectly marked the URL scheme as a source of untrusted data. (PYT-3082)

When a normal static resource is accessed in FastAPI, the agent reports PathTraversal. (PYT-3021)

When analyzing requests in Assess mode, the agent caused a memory leak. (PYT-3050)

Updated logging to use the latest standard for getting thread ID and improved logged message with non-JSON response from Contrast.

When using Genshi with the Contrast Runner, the agent caused an exception if % appeared in a template. (PYT-3005)

When lxml.etree.fromstring was called with a known safe parser, Assess incorrectly reported an XXE vulnerability. (PYT-3013)

Removed the deprecated attack timing feature from Protect.

Swap ApplicationProxies for function_wrappers.

Updated URL normalization of request data based on specification.

Created detailed help message for Agent Runner.

Added propagation policy for pathlib.

Configuration logged to disk after startup.

Logging of a failing runtime connection result.

Fix anyio pinned version for old FastAPI framework test. (PYT-3001)

When CacheControlsRule exceptions are present the agent still reports Anti-Caching Controls vulnerability. (PYT-2997)

Fixed warnings in unit test suite: "Directory not empty": Attempt #2. (PYT-2996)

Release of Contrast Runner, a new command-line interface for instrumenting Python applications.

Removed the deprecated_middleware module and all associated code.

Policy-based rewrites are now applied immediately after registering the rewriter in the runner.

String hooks are now applied early enough in environments where funchook is not enabled.

Bump ruamel-yaml dependency to latest version.

Added ssrf trigger policy for requests library.

Added a deprecation warning when using specific middleware classes.

Added support for the latest FastAPI (0.96.*).

Added the agent.python.enable_automatic_middleware configuration option to disable automatic middleware instrumentation.

Enabled error-free installation on M1/arm architecture.

Removed policy-based rewrites (including hidden configuration option) and added propagation policy for posixpath.

Bump typing-extensions dependency to latest version.

Implemented automatic instrumentation for middleware AIOHTTP, Bottle, Falcon (ASGI), Falcon (WSGI), FastAPI, Flask, Pyramid, Quart.

Removed JSON policy, contrast.agent.policy.loader and any associated unused code.

Removed trace logging.

Updated propagation policy for builtins module.

Added propagation policy for genericpath module.

Added/updated propagation policy for _codecs module.

Updated contrast.__init__ to directly use pkg_resources.

Removed Django-specific middleware (ASGI and WSGI), Falcon-specific middleware (ASGI and WSGI), and Pyramid-specific middleware.

Removed Protect response overwrite.

When Protect reports an attack coming from HTTP form data, the source is incorrectly listed as query string has been resolved. (PYT-2974)

Fixed the vulnpy pipeline. (PYT-2955)

Fixed quart auto-instrumentation for app.run(). (PYT-2929)

Fix to automatically instrument flask apps that are started with the dev server using app.run(). (PYT-2918)

Fixed AttributeError: BoundLogger object has no attribute trace. (PYT-2790)

Implemented a prompt-injection trigger policy for the OpenAI API.

Added the api.certificate.ignore_cert_errors configuration option for ignoring certification errors.

Added deprecation warning for Python 3.7 support.

Revisited the use of setuptools-scm for versioning.

Agent crashes when non-string is passed to _evaluate_body_json. (PYT-2930)

When telemetry is enabled and the connection fails, the agent blocks the main application thread. (PYT-2872)

Updated instrumentation to avoid errors in certain edge cases.

Removed trailing slashes from configured Contrast API URL.

When using the rewriter with an instrumented application that uses Pandas, an exception occurs. (PYT-2856)

When the ASGI scope contained a client value of None, the agent raised an exception during source tracking. (PYT-2853)

Updated PyPI deploy action.

Moved agent initialization out of runner and back into middleware.

Add integration test for Assess dataflow using runner with uwsgi.

Bump typing-extensions dependency to the latest version.

Bump ruamel-yaml dependency to the latest version.

Bump isort dependency to the latest version.

Bump structlog dependency to latest version.

Moved all packages in contrast.extern to new contrast_vendor package.

Removed flask-specific middleware.

Automatic middleware hooks now set and log the detected framework.

Removed fastAPI-specific middleware.

Added policy for urllib.parse propagators and sanitizers.

When the ASGI scope contained a client value of None, the agent raised an exception. (PYT-2850)

When running in Protect mode, the agent incorrectly identified normal header values as attacks. (PYT-2834)

When processing an HTTP 1.1 chunked response, the agent prevents the entire response from being sent to the client. (PYT-2822)

When analyzing certain objects with custom __bool__ implementations, the agent raised an exception. (PYT-2757)

When performing Assess analysis, the agent occasionally failed to correctly determine if an unknown object was iterable. (PYT-2756)

When processing certain JSON request bodies, Contrast Protect did not correctly adjust input types before performing analysis. (PYT-2824)

When analyzing mysql-connector installations missing a C extension, Contrast Assess failed to instrument the entire library. (PYT-2820)

Fixed issue when using the agent in a Python 3.7 environment that does not have typing-extensions installed, the agent logger raises an exception. (PYT-2814)

Removed all bottle-specific logic from BottleMiddleware.

Updated RuntimeError in setup.py to include a workaround for aarch/arm systems.

Removed quart-specific middleware.

Added a lock for agent state initialization.

Added support for the latest FastAPI (0.93.*).

Changed the AgentLib log level.

Integrated the Protect Library.

Fixed AttributeError: Constant object had no elts attribute. (PYT-2740)

Fixed UnicodeDecodeError: utf-8 codec could not decode byte 0xff in position 0: invalid start byte. (PYT-2725)

Fixed TypeError: module, class, method, function, traceback, frame, or code object was expected, got partial. (PYT-2664)

Fixed SystemError: <built-in function in_scope> returned a result with an error set. (PYT-2659)

Fixed flaky pipeline step for server activity. No more flaky failures in flask-agent-direct-teamserver-response. (PYT-2651)

When trying to identify the current platform on startup, the agent raised an exception. (PYT-2777)

When instrumenting Bottle and Falcon applications, middlewares closer to the application than ContrastMiddleware were bypassed. (PYT-2727)

Upgraded externed wrapt from 1.14.1 to 1.15.0.

Upgraded agent-lib to 0.5.2

Added propagation policy for posixpath (os.path)

Bump pinned version of contrast-agent-lib to v0.4.0

Updated copywrite message

Removed the bypass option for messages

Updated flask-sqlalchemy to 3.0.*

Added support for Quart 0.18 / Werkzeug 2.2

When app server exits, Telemetry will send any messages in queue

Deprecated SR

Added support for Python 3.11

AttributeError: 'Settings' object has no attribute 'last_update_service'. (PYT-2563)

AttributeError: 'NoneType' object has no attribute 'disabled_assess_rules'. (PYT-2559)

AttributeError: 'NoneType' object has no attribute 'reportable_format'. (PYT-2552)

When the regex split result contains None, an exception occurs in the propagator. (PYT-2644)

When unicode-escape is used as encoding, LookupError occurs in path-traversal sink. (PYT-2553)

Bump contrast-agent-lib version to 0.5.2.

When too many assess regex propagation events occurred in a single request, the agent continued to propagate regardless of assess.max_propagation_events. (PYT-2676)

When evaluating the protect deserialization rule for pickled data, the agent easily found false positives. (PYT-2646)

When performing Django's safe_join on a PosixPath object, the agent raised a TypeError. (PYT-2592)

When the Contrast Service was too slow to start on server startup, the Agent failed to instrument the application. (PYT-2582)

When the agent failed to connect to the Contrast Service, it raised an AttributeError when handling the first request to the application. (PYT-2574)

When untrusted data was safely passed to subprocess functions using shell=False, the agent incorrectly reported a command injection vulnerability. (PYT-2557)

Added support for URL exclusions when communicating directly with Contrast.

Added configuration support for input exclusions directly from Contrast.

Integrated AgentLib Request End for contrast_c::check_cmd_injection_query

Upgraded externed typing extensions to latest version.

When ASGI websocket endpoints are used with the agent enabled, the app crashes. (PYT-2517)

When starting the Contrast Service without a path, the Agent defaults to STDOUT rather than the default file path. (PYT-2505)

Reduced frequency of server activity messages. (PYT-2484)

When attempting to rewrite the target of an append, the agent incorrectly passes self rather than the original Attribute. (PYT-2496)

Added support for FastAPI 0.85. (PYT-2456)

Implemented PII masking in the agent. (PYT-2462)

Added a CONTRAST__AGENT__PYTHON__REWRITE option that disables rewriting. (PYT-2485)

When running the agent, getting specifications in rewriter throws AttributeError. (PYT-2480)

When running the agent, rewriter cannot find specifications path. (PYT-2476)

Fixed issue for when an agent receives a websocket request and a KeyError was returned. (PYT-2470)

Fixed issue where an application instrumented with the agent in an environment without lxml installed crashed. (PYT-2464)

Falcon ASGI support is now available in Python agent 5.14.0.

Added support for Django 4.

When attempting to rewrite code for instrumentation, certain code patterns result in infinite loops, resulting in application crashes. (PYT-2444)

When agent.service.logger was configured to log to an unwritable path, the Contrast Service wrote DEBUG logs to stdout regardless of the configured log level.

When sampling settings are translated from Contrast, a String vs Enum mismatch causes them to be improperly applied. (PYT-2286)

When sqli protect rule isn't enabled, a NoneType error is logged (Telemetry-reported Error). (PYT-2311)

Telemetry exceptions - production issues from live customer environments will be reported to our servers to help remediate bugs.

Expanded FastAPI support to version 0.75.*.

When assess configuration specifies sampling.baseline, the agent incorrectly analyzes fewer baseline requests than expected. (PYT-2238)

When an assess-instrumented function throws any exception, the agent logs it at ERROR level even when recoverable. (PYT-2234)

Modified the agent to better support asynchronous functionality added by event.

Introduction of the Assess Sampling feature to facilitate performance tuning.

When a Django request's path is missing a required "/", the agent does not mark the route as observed. (PYT-2222)

When Django creates a redirect response to append a trailing "/" to the URL path, the agent incorrectly finds an unvalidated redirect (PYT-2218)

When the agent encounters an issue during assess dataflow tracking, an error level, rather than debug, log message is created, potentially filling log tools. (PYT-2196)

When processing a request without a context, a missing None check results in an AttributeError. (PYT-2168)

When Protect is disabled either locally or in Contrast, the agent disables it. (PYT-2186)

When a Django app serves a jinja template, the agent consumes the response (PYT-2166)

When an aiohttp application in Protect mode receives a ContrastServiceException, an error that crashed the app occurs (PYT-2167)

When an aiohttp, Fastapi, or Bottle app is onboarded, an incorrect framework name is reported (PYT-2171)

The Python agent now supports FastAPI 0.74.

Added web application framework support for AioHttp.

Support for asynchronous web application framework - AioHTTP.

When a protect-instrumented method receives non-UTF-8 encoded bytes, the agent fails to perform protect analysis. (PYT-2028)

When an application calls an instrumented method with a keyword-argument named "self", the agent throws an exception. (PYT-1998)

When handling many concurrent requests in Protect mode, the agent failed to perform path-traversal postfilter analysis. (PYT-1964)

Expanded web application framework support for Pyramid 2.

Telemetry is now enabled in the Python agent in order to gather valuable data about the agent’s functionality. The data is all anonymous, no personal information is collected.

We no longer report vulnerabilities when the value of url_scheme is used in a trigger.

The Python agent now supports the web framework FastAPI.

Expanded web server support for uWSGI.

Expanded web server support for gUnicorn.

Expanded web server support for Uvicorn.

Architectural improvements for propagation and associated extension hooks.

When the agent was installed in Python 2.7, the latest version of the protobuf dependency caused agent startup failure as it dropped support for older Python versions. (PYT-1757)

When a Bottle or Django app received a request with certain encoded chars in the path, the agent raised a UnicodeEncodeError. (PYT-1742)

Implemented event limit specifications to improve performance.

When the agent tried to detect the application framework, it always picked the default one. (PYT-1707)

Performance improvements from refactoring and other optimizations.

When a framework test was executed in an environment in which the agent was installed, then load ordering between the test code and agent code causes an inability to track some objects. (PYT-1574)

Remove specific support of the Pylons framework given its merger with the Pyramid framework.

Expand support of the Flask framework to include the new 2.X major version.

When a vulnerability payload is too large, TeamServer cannot process the finding and rejects it. (PYT-1488)

Added support for built-in sanitization and validation in the Falcon 2.X and Pyramid Web Application Frameworks to improve vulnerability detection when Assess is enabled.

The agent now reports all dependencies used by the application, even those without Python files.

The agent now supports TRACE level logging to assist with diagnostic investigations.

The agent has been refactored to provide performance improvement during vulnerability detection and reporting when Assess is enabled.

The agent now supports MarkupSafe 2.0 as used for cross-site scripting (XSS) vulnerability protection when observing data flow when Assess is enabled.

When customer uploads large file to instrumented falcon route, agent performs too much analysis, causing request to fail to complete. (PYT-1476)

The Python agent now supports the web framework Bottle.

Incremental changes were made to reduce memory usage when Assess is enabled.

Added Assess support through pathlib.Path objects.

Pycassa library is no longer supported by the agent.

Added additional Assess support for Command Injection vulnerabilities in os and subprocess modules.

Added additional Assess support for marshal and shelve modules.

Added additional Assess support for Path Traversal vulnerabilities in os, pathlib, and shutil modules.

Added os.path.basename as sanitizer for Path Traversal.

When propagating through string methods with the KEEP action, Assess fails internally on length - 1 return values. (PYT-1466)

When running Assess on some alpine docker containers, the agent fails to instrument string methods, preventing application startup. (PYT-1450)

The agent now propagates through str multiplication.

The PyramidMiddleware is now a WSGI-based middleware.

User input that is later encoded as Base64 will now have proper dataflow context.

When attempting to instrument strings in Assess, not enough memory is allocated in some environments. (PYT-1350)

Refactored the patch manager for better instrumentation.

The agent will now fully shutdown if told to do so by the service.

Improved agent startup time and memory usage when Assess is enabled.

The agent now reports its effective instrumentation mode to the service.

Upgraded bundled service in the agent to the latest version.

When casting an object with a __str__ method to a non-str, the agent would lose propagation through the cast propagator. (PYT-1312)

When trying to instrument an application using SQLAlchemy, an error would be thrown if MySQLdb had no attribute called Cursor. (PYT-1332)

When trying to retrieve properties for an object, exceptions could be thrown if the agent attempted retrieval in an unsafe manner. (PYT-1333)

Refactored the agent's approach for handling objects with attached properties.

Updated Django support to prevent over tagging of path values within a request.

Upgraded service version bundled within the agent.

Updated dataflow action to prevent potentially unsafe propagation of tags.

When reporting a vulnerability while using legacy Django middleware, the agent would not run its final tasks if a trigger raises an error. (PYT-1257)

When trying to track dataflow through an action on a bytes object, the agent could fail. (PYT-1281)

When trying to format to lowercase hex, the format propagator would fail. We fixed this edge case. (PYT-1227)

Support for Python 2.7 will be deprecated in 2021.

Added support for the Assess ReDoS rule.

Reduced the calls to retrieving Python loaded modules to improve performance.

Improved representation of dataflow with events containing keyword arguments.

The agent failed to process GET requests when handing user input from requests containing non-UTF-8 strings. Updated string handling to account for this. (PYT-1242)

When users uploaded files in a Flask application, the amount of resultant dataflow events in internal web framework code caused significant performance degradation. Given the lack of risk fo exploitation with this method, we expanded ignored methods for Flask, preventing these events and subsequent degradation. (PYT-1247)

Added support for Python 3.9.

Agent does not unpack method arguments when passing them into Assess rules.

Agent now ignores .so files from loaded modules when patching.

Added route coverage support for DjangoRestFramework routers.

Added capability of deadzoning methods to improve accuracy.

Assess stacktraces can now be configured with assess.stacktraces.

Corrected possible string tracker age off KeyError on key deletion.

Service and agent were using different environment variable to set the config.path. Updated CONTRAST_CONFIG_PATH value parsing to look for a file and not a directory with the YAML file. (SUP-2257, PYT-1161)

Added additional debug logging on request start and finish.

Improved library analysis support to include parsing SOURCES.txt.

Updated timing of logging of the environment of an application.

Added logging of configuration values on any logger change.

Fixed propagation scope leak for generators.

Agent crashed in a scenario where free() could be called twice because of patching by Gevent.. (PYT-1164)

The agent now reports enhanced library usage on startup and at the end of each request. After a request is received by the agent, we report new files loaded for an installed package.

The agent will not report unsupported distribution types for packages.

Updated the heartbeat thread to no longer accidentally propagate and cause an error.

Added configurable Django Rest Framework (DRF) response-rendering deadzone to fix timeout errors in DRF applications.

Improved NoSQL Injection support for Assess and Protect.

NoSQLi now handles MongoDB ObjectID types.

Added html.escape as a sanitizer in Assess.

Added WARN level logging if the configuration required to connect to the Contrast Service is missing.

Added INFO level configuration state logging, including ENV and YAML values.

Added YAML validation and, if invalid syntax is detected, WARN level logging indicating such.

Added INFO level application identification logging

Removed strict compiler flags from extension build.

Reduced latency in Django Rest Framework's response handling.

Investigated excessive DB_WRITE propagation.

Inability to patch held references to older versions of modules prevents instrumentation of referenced, rather than directly invoked, methods, such as in Werkzeug version 0.16.0.

Added support for Assess rules:

Removed HTTP request methods as a dataflow source.

Added support for Assess configurations assess.enable_scan_response and assess.rules.disabled_rules.

Failed to repatch module due to __dict__ changing size while iterating over it. (PYT-1085)

Unable to instrument applications on OSX using locally built Python versions due to maxprot setting. (PYT-1025)

Hardcoded analysis rules were accidentally disabled. (PYT-1027)

When the agent was disabled, attempting to start without the Contrast service, resulted in application crash in Flask applications. (PYT-1012)

Instrument compile as part of the Unsafe Code Execution rule.

Decouple ServiceClient from SettingsState

Use normalized_response_headers in DTM instead of response_headers.

Refactored XSS postfilter logic for checking allowed content type.

Updated MongoDB update_methods to account for all arguments.

Replaced FlowMap Technology Analysis.

Verifed that SR handles empty observed route url.

Merge all rules apply_rule into one implementation.

Do not report handled exceptions in INFO/ERROR logs

Upgraded Python agent to use SR 2.11.x.

Fix and update regex used for protect XXE rule (PYT-94)

Fix error in DB write propagator. (PYT-971)

Agent fails to identify itself with new SR instance after the original SR instance goes down. (PYT-715)

List pip and pkg_resources as dependencies and/or include as external modules. (PYT-974)

Do not report observed route if signature is missing/empty. (PYT-970)

Added route coverage support for Django 3.0.

Added Falcon 2.0 support.

Improved accuracy of library file usage.

Improved propagation through regular expressions in Assess.

The team made significant internal cleanup to Request representation

Fixed a bug where regex propagation was throwing an exception under certain conditions.

Fixed a bug related to agent handling of very short JSON keys and values.

Updated protobuf dependency requirement in response to incompatibility issues with older versions.

Fixed an issue where the agent raised an internal exception for applications using certain features of pyasn1.

Fixed a bug where Django applications were unable to properly parse the Content-Type header if a charset was explicitly provided.

Improved error handling around stack trace construction.

Falcon 2.0 is supported and is in beta

Upgraded Contrast Service to 2.8.1

Added support for Django Rest Framework

Added copyright to all agent files

Removed the agent's external dependency on the wrapt package

Improved INFO level logging for easier tracking of applications with multiple processes

When running the agent with protobuf-3.6.1 sometimes the application crashed, which has now been resolved with a newer protobuf version.

Added initial support for Stored XSS rule in Assess for django framework.

Added Unvalidated Redirect support for Assess for pyramid and webob objects.

Made updates to reduce number of false positives from Reflected XSS rule in Assess.

Removed the agent’s external dependency on the six package.

When running the agent under Python 2.7 on Ubuntu 16.10 some instrumentation failed to apply, which has now been resolved.

When applications used str.format in certain edge cases, the agent lost dataflow propagation, which has now been resolved.