Current Series Release Notes

5.18.1-18

Deprecation Notes

  • The version_header argument to keystoneauth1.discover.get_version_data is deprecated. Supply service_type instead so keystoneauth can apply service-specific discovery behavior automatically. Explicit header values remain supported for compatibility during the deprecation period.

Bug Fixes

  • Key-manager endpoint discovery now automatically sends OpenStack-API-Version: key-manager 1.1 to obtain Barbican’s microversion range. Previously, its legacy discovery document omitted that range, preventing consumers such as openstacksdk from negotiating microversions. This does not change the microversion used for resource requests. Discovery caches distinguish documents requested with different version headers. Direct discovery callers can supply the new service_type argument to enable service-specific discovery behavior.

  • Fix Session.close() to retain ownership of an internally created requests.Session after closing its connection pool. If the session is reused, subsequent calls to close() and cleanup on deletion now release newly opened pooled connections. Externally supplied requests sessions remain untouched.

5.18.0

New Features

  • Add a Session.close() method to keystoneauth1.session.Session for deterministic release of the underlying requests.Session and its pooled keep-alive connections. The session is only closed if keystoneauth1 created it itself; a requests.Session supplied via the session constructor argument is left untouched, as its ownership belongs to the caller. close() is idempotent and non-fatal: the session remains usable after being closed, establishing new connections as needed, and no re-authentication is required. Errors from the socket layer (OSError) or from requests raised while tearing down idle pooled connections are caught and discarded rather than propagated to the caller.

Security Issues

  • TOTP get_cache_id() omitted the passcode, so two plugins for the same user with different passcodes could collide in an auth cache and return another caller’s cached token or auth state.

  • SAML2 ECP could follow ACS Location redirects and POST consumer mismatch faults to URLs from SAML/XML without verifying the target host. A compromised federation endpoint could send federation session cookies to another host or trigger requests to arbitrary URLs.

Bug Fixes

  • [bug 2167094] The TOTP auth plugin now includes the passcode in get_cache_id() elements so different passcodes for the same user no longer share a cache key.

  • [bug 2167316] The SAML2 ECP auth hook now checks outbound URLs against the federation endpoint host. Consumer mismatch SOAP faults are sent only when responseConsumerURL shares the original request netloc, and ACS 302/303 redirects are followed only when Location points to the same host.