Skip to content

[Security] Document enforce_key_usage_verification option for OIDC discovery #22217

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
javiereguiluz merged 1 commit into from
Apr 7, 2026
Merged

[Security] Document enforce_key_usage_verification option for OIDC discovery #22217

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions security/access_token.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -617,6 +617,63 @@ from the OpenID Connect Discovery), and configure the ``discovery`` option:
],
]);

By default, when using OpenID Connect Discovery, only keys explicitly designated
for signature verification (i.e. keys with ``"use": "sig"`` or ``"key_ops"``
containing ``"sign"`` or ``"verify"`` per `RFC 7517`_) are accepted. If your
identity provider serves keys without any usage designation (no ``use`` or
``key_ops`` field), you can disable this strict filtering by setting the
``enforce_key_usage_verification`` option to ``false``:

.. configuration-block::

.. code-block:: yaml

security:
firewalls:
main:
access_token:
token_handler:
oidc:
# ...
discovery:
base_uri: https://www.example.com/realms/demo/
cache:
id: cache.app
enforce_key_usage_verification: false

.. code-block:: php

return App::config([
'security' => [
'firewalls' => [
'main' => [
'access_token' => [
'token_handler' => [
'oidc' => [
// ...
'discovery' => [
'base_uri' => 'https://www.example.com/realms/demo/',
'cache' => [
'id' => 'cache.app',
],
'enforce_key_usage_verification' => false,
],
],
],
],
],
],
],
]);

When disabled, keys are still filtered: those explicitly marked for encryption
only (``"use": "enc"`` or ``"key_ops"`` containing only encryption operations)
are excluded. Keys without any usage designation are included.

.. versionadded:: 8.1

The ``enforce_key_usage_verification`` option was introduced in Symfony 8.1.

Following the `OpenID Connect Specification`_, the ``sub`` claim is used by
default as user identifier. To use another claim, specify it on the
configuration:
Expand Down Expand Up @@ -931,6 +988,7 @@ for :ref:`stateless firewalls <reference-security-stateless>`.
.. _`OpenID Connect (OIDC)`: https://en.wikipedia.org/wiki/OpenID#OpenID_Connect_(OIDC)
.. _`OpenID Connect Specification`: https://openid.net/specs/openid-connect-core-1_0.html
.. _`OpenID Connect Discovery`: https://openid.net/specs/openid-connect-discovery-1_0.html
.. _`RFC 7517`: https://datatracker.ietf.org/doc/html/rfc7517
.. _`RFC6750`: https://datatracker.ietf.org/doc/html/rfc6750
.. _`SAML2 (XML structures)`: https://docs.oasis-open.org/security/saml/Post2.0/sstc-saml-tech-overview-2.0.html
.. _`key operation flags`: https://www.iana.org/assignments/jose/jose.xhtml#web-key-operations
Loading