OIDCWarden

Soft fork from dani-garcia/vaultwarden. Goal is to provide an OIDC compatible solution with the ultimate goal of merging features back in Vaultwarden.

A master password is still required and not controlled by the SSO (depending on your point of view this might be a feature ;).

Bitwarden key connector is not supported and due to the license it's highly unlikely that it will ever be:

2.1 Commercial Module License. Subject to Your compliance with this Agreement, Bitwarden hereby grants to You a limited, non-exclusive, non-transferable, royalty-free license to use the Commercial Modules for the sole purposes of internal development and internal testing, and only in a non-production environment.

Acknowledgement

Project made possible with support from the sponsors and the TU Bergakademie Freiberg.
Would not be possible without the maintainers and contributors of the source project dani-garcia/vaultwarden.

Versions

Tagged version are based on Bitwarden web client releases, Ex: v2024.8.3-1 is the first release compatible with web client v2024.8.3.
See changelog for more details.

Differences with timshel/vaultwarden

This project was created in an effort to gain more support to maintain the PR adding OpenID Connect to Vaultwarden.

Main differences now:

• Renamed project / changed icons
• Abitility to release web-vault independantly of the bw_web_builds, the timshel/vaultwarden will stay in sync.

In the long term distribution will focus on a better OpenID flow (web-vault override distribution).

Testing

New release are tested using Playwright integration tests. Currenttly tested flow include:

• Login flow using Master password and/or SSO
• 2FA using email and TOTP
• Organization and collection creation
• Organization invitation using Master password and SSO
• Organization auto-invitation
• Role mapping

Goal will be to continue to increase the test coverage but I would recommand to always deploy a specific version and always backup/test before deploying a new release.

Configuration

See details in SSO.md.

Features

Role mapping

Allow to map roles from the Access token to users to grant access to VaultWarden admin console. Support two roles: admin or user.

This feature is controlled by the following conf:

• SSO_ROLES_ENABLED: control if the mapping is done, default is false
• SSO_ROLES_DEFAULT_TO_USER: do not block login in case of missing or invalid roles, default is true.
• SSO_ROLES_TOKEN_PATH=/resource_access/${SSO_CLIENT_ID}/roles: path to read roles in the Access token (used by organization membership role too).

Organization sync

Allow to synchronize Organization, Groups and User roles.

Organization invitation

The organization need to be manually created first. Will use the email associated with the Organization to send further notifications (admin side).

Invitation flow will look like this:

• Decode the JWT Access token and check if a list of organization is present (default path is /groups).
• Check if a matching Organization exists and if the user is not part of it.
• if mail are activated invite the user to the Organization
  • The user will need to click on the link in the mail he received
  • A notification is sent to the email associated with the Organization that a new user is ready to join
  • An admin will have to validate the user to finalize the user joining the org.
• Otherwise just add the user to the Organization
  • An admin will have to validate the user to confirm the user joining the org.

One of the bonus of invitation is that if an organization defines a specific password policy then it will apply to new user when they set their new master password. If a user is part of two organizations then it will order them using the role of the user (Owner, Admin, User or Manager for now manager is last :() and return the password policy of the first one.

This feature is controlled with the following configuration:

• SSO_SCOPES: Optional scope override if additionnal scopes are needed, default is "email profile"
• SSO_ORGANIZATIONS_ENABLED: control if the mapping is done, default is false
• SSO_ORGANIZATIONS_TOKEN_PATH: path to read organization and groups in the Access token, default is /groups

Organization revocation

If a user is removed from the provider group, the membership will be revoked. User will lose access but no admin intervention will be needed to grant access back.
The state of the membership is kept (invited, confirmed, accepted) and will be restored if the user is once again added to the group/organization.

This feature is controlled with the following configuration:

• SSO_ORGANIZATIONS_REVOCATION: control if user revocation are made (default false).

Organization member role

Custom roles can be sent to set the organization member role. Only on role can be defined for all organization. If not present the user will be assigned the User membership.

Possible values include:

• OrgNoSync: Disable all organization sync for this user.
• OrgOwner: map to the Owner role, adding/removing this role has some requirements (is 2FA activated ? is-it the last Owner of the org ?).
• OrgAdmin: map to the Admin role.
• OrgManager: map to the custom role with with the ability to manage all collections.
• OrgUser: default, User can be granted access to all on no collections.

If no role is provided it will default to User on invitation and no change will be made for existing member role.

This feature is controlled with the following conf:

• SSO_ROLES_TOKEN_PATH=/resource_access/${SSO_CLIENT_ID}/roles: path to read roles in the Access token (The feature is active even if SSO_ROLES_ENABLED is disabled).
• SSO_ORGANIZATIONS_ALL_COLLECTIONS: are User granted access to all collections, default is true (will apply only when the user membership role change).

Organization groups

The groups will need to be created first. Then if present in the token user can be added/removed.

This feature is controlled with the following conf:

• ORG_GROUPS_ENABLED: Need to be activated.

Organization and Group mapping

There is multiple ways to match a given provider group value to an organization or a group.
Organizations (only when modifying it) and groups allow to set an ExternalId to help with this association.

Depending on the format of the provider value different logic will be used:

• simple toto:
  • Will match an Organization with a matching name or ExternalId
  • Will match a Group with a matching ExternalId.
• path style: /org/group or org/group will match using only the names of the organization and group.

Only the path style allows to match a group using its name. A simple value can match multiple Organization/Group, this will generate an error and disable sync. When matching a group then the user will be considered part of the parent Organization even if it's not listed in the provider groups.

Deprecations

• SSO_ORGANIZATIONS_INVITE: Will be removed with the next release. replaced with SSO_ORGANIZATIONS_ENABLED.
• SSO_ORGANIZATIONS_ID_MAPPING Will be removed with the next release. For now if present is still used, only Organization and User role mapping is done.
• SSO_ORGANIZATIONS_GROUPS_ENABLED: Will be removed with next release. Allow to keep group mapping deactivated (still dependant on ORG_GROUPS_ENABLED). False initially to force opt-in to the feature.

Docker

Change the docker files to package both front-end from Timshel/oidc_web_vault.
By default it will use the release which only make the sso button visible.

If you want to use the version with the additional features mentionned, default redirection to /sso and fix organization invitation. You need to pass an env variable: -e SSO_FRONTEND='override' (cf start.sh).

Docker images available at:

• Docker hub hub.docker.com/r/timshel/oidcwarden
• Github container registry ghcr.io/timshel/oidcwarden

Front-end version

By default front-end version is fixed to prevent regression (check CHANGELOG.md).
When building the docker image it can be overrided by passing the OIDC_WEB_RELEASE arg.
Ex to build with latest: --build-arg OIDC_WEB_RELEASE="https://github.com/Timshel/oidc_web_vault/releases/latest/download"

To test VaultWarden with Keycloak

Readme

DB Migration

ATM The migrations add two tables sso_nonce, sso_users and a column invited_by_email to users_organizations.

Revert to default VW

Reverting to the default VW DB state can easily be done manually (Make a backup :) :

>BEGIN;
BEGIN
>DELETE FROM __diesel_schema_migrations WHERE version in ('20230910133000', '20230914133000', '20240214170000', '20240226170000', '20240306170000', '20240313170000', '20250514120000');
>DROP TABLE sso_nonce;
>DROP TABLE sso_users;
>ALTER TABLE users_organizations DROP COLUMN invited_by_email;
>DROP INDEX organizations_external_id; -- only sqlite
>ALTER TABLE organizations DROP COLUMN external_id;
> COMMIT / ROLLBACK;

Configuration

Zitadel

To use the role mapping feature you will need to define a custom mapping to return a simple list of role. More details in Zitadel documentation; the cutomization will look something like this:

function flatRoles(ctx, api) {
  if (ctx.v1.user.grants == undefined || ctx.v1.user.grants.count == 0) {
    return;
  }

  let grants = [];
  ctx.v1.user.grants.grants.forEach(claim => {
    claim.roles.forEach(role => {
        grants.push(role)
    })
  })

  api.v1.claims.setClaim('my:zitadel:grants', grants)
}