New Ory Agent Security is now live! Claim your complimentary test drive. Get Started!

Skip to main content

v26.4.17

v26.4.17​

DynamoDB moves to a driver package, and external database drivers are supported​

Ory Polis now loads database drivers that are not built in. Set DB_ENGINE=custom and DB_DRIVER to the package name or path of a driver module, and pass the driver's own settings as a JSON object in DB_DRIVER_OPTIONS. A driver module exports { apiVersion, new } and implements the DatabaseDriver interface the @boxyhq/saml-jackson package exports; the API version is checked at startup. External drivers are not loaded in the FIPS 140-3 image.

Breaking change: DB_ENGINE=dynamodb is gone​

The DynamoDB driver is no longer part of Ory Polis. It is the @boxyhq/polis-driver-dynamodb package, in the drivers/dynamodb directory of the Ory Polis repository, and the @aws-sdk/* packages are no longer dependencies of @boxyhq/saml-jackson. A deployment on DynamoDB has to:

  • build an image on top of the Ory Polis image that installs @boxyhq/polis-driver-dynamodb under /opt/polis-drivers, or install the package next to the @boxyhq/saml-jackson library;
  • set DB_ENGINE=custom and DB_DRIVER=@boxyhq/polis-driver-dynamodb;
  • move DB_DYNAMODB_REGION, DB_DYNAMODB_RCUS and DB_DYNAMODB_WCUS, which are removed, to DB_DRIVER_OPTIONS, for example {"region":"eu-west-1","readCapacityUnits":5,"writeCapacityUnits":5}. Library users move db.dynamodb to db.driverOptions.

The driver reads and writes the same tables and items as before, so no data migration is needed. DB_URL, AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY keep their meaning.

MongoDB moves to a driver package​

The MongoDB driver is no longer part of Ory Polis. It is the @boxyhq/polis-driver-mongodb package, in the drivers/mongodb directory of the Ory Polis repository, loaded through DB_ENGINE=custom, and the mongodb and migrate-mongo packages are no longer dependencies of @boxyhq/saml-jackson.

Breaking change: DB_ENGINE=mongo is gone​

A deployment on MongoDB has to:

  • build an image on top of the Ory Polis image that installs @boxyhq/polis-driver-mongodb under /opt/polis-drivers, or install the package next to the @boxyhq/saml-jackson library;
  • set DB_ENGINE=custom and DB_DRIVER=@boxyhq/polis-driver-mongodb.

DB_URL keeps its meaning and the driver reads and writes the same collection and documents as before, so no data migration is needed. The Docker image's migration script does nothing for DB_ENGINE=custom: the driver creates its indexes at startup as it always did, and the one MongoDB migration, the 2023 namespace backfill, which the driver also runs at startup unless DB_MANUAL_MIGRATION=true, ships in the package for manual runs.

MongoDB is not available in the Ory Enterprise License FIPS 140-3 image, which loads no external drivers.

Redis moves to a driver package​

The Redis driver is no longer part of Ory Polis. It is the @boxyhq/polis-driver-redis package, in the drivers/redis directory of the Ory Polis repository, loaded through DB_ENGINE=custom, and the redis package is no longer a dependency of @boxyhq/saml-jackson.

Breaking change: DB_ENGINE=redis is gone​

A deployment on Redis has to:

  • build an image on top of the Ory Polis image that installs @boxyhq/polis-driver-redis under /opt/polis-drivers, or install the package next to the @boxyhq/saml-jackson library;
  • set DB_ENGINE=custom and DB_DRIVER=@boxyhq/polis-driver-redis.

DB_URL keeps its meaning and the driver reads and writes the same keys as before, so no data migration is needed.

Redis is not available in the Ory Enterprise License FIPS 140-3 image, which loads no external drivers. With MongoDB, Redis and DynamoDB all driver packages now, the FIPS image supports the SQL engines other than SQL Server, and PlanetScale.

Enterprise features no longer need a license key​

The Ory Polis Enterprise License images, polis-oel and polis-oel-fips, run identity federation, branding, products and OpenTelemetry logs without a license key. FIPS 140-3 mode needs no license key either, but it is active only in polis-oel-fips; polis-oel runs outside it. Polis no longer reads POLIS_LICENSE_KEY or BOXYHQ_LICENSE_KEY, and the Helm chart no longer has polis.licenseKey. Remove them from your configuration; leaving them set does nothing.

OpenTelemetry logs are now exported whenever an OTLP logs endpoint, or the general OTLP endpoint, is configured. Set OTEL_LOGS_EXPORTER=none to keep them off.

SAML logins return the asserted NameID as logoutNameId​

The ID token and the userinfo response of a SAML login now include logoutNameId, the NameID exactly as the identity provider asserted it. Pass it as nameId when you start a SAML single logout. Until now you passed id or upstream_sub, which is not the NameID when the identity provider sends an id attribute or the connection sets subjectSources, so the identity provider could leave the session open.

If your identity provider sends an attribute named logoutNameId and you run Ory Polis with FLATTEN_RAW_CLAIMS, that attribute no longer appears at the top level of the claims.

SCIM group names and Identity Federation entity IDs stay unique under concurrent requests​

A SCIM group's displayName is now unique within a directory. Concurrent POST requests for the same name create one group and answer the others with 409 and scimType: uniqueness. A PUT or PATCH that renames a group to a name another group in the directory already has now fails the same way and leaves the group unchanged. Before, such a rename succeeded and left two groups with the same name. One rare case remains: a failed rename that is held up for more than a minute while other groups take both of its names can leave two groups with one name. Ory Polis counts it as dsync.group.name_conflict.

An Identity Federation SAML app's entity ID is now unique across apps even when several apps are created at the same time. The check now also applies to apps created without type, which default to SAML.

A failed group PATCH no longer puts a removed member back into a group that was deleted while the request ran, or into another directory's group created under the same ID meanwhile.