OpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub
Ruby agile-developmentangularbcfboardsbug-trackerganttgantt-chartifcissue-trackerjira-alternativekanbanopenprojectproduct-managementproject-managementproject-planningroadmaprubyscrumtimelineworkflows
Allow to synchronize groups via OpenID Connect
Jan Sandbrink8596c8a5b5e5
diff --git a/modules/openid_connect/app/models/openid_connect/group_link.rb b/modules/openid_connect/app/models/openid_connect/group_link.rbnew file mode 100644index 00000000000..5acd3220792--- /dev/null+++ b/modules/openid_connect/app/models/openid_connect/group_link.rb@@ -0,0 +1,38 @@+# frozen_string_literal: true++#-- copyright+# OpenProject is an open source project management software.+# Copyright (C) the OpenProject GmbH+#+# This program is free software; you can redistribute it and/or+# modify it under the terms of the GNU General Public License version 3.+#+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:+# Copyright (C) 2006-2013 Jean-Philippe Lang+# Copyright (C) 2010-2013 the ChiliProject Team+#+# This program is free software; you can redistribute it and/or+# modify it under the terms of the GNU General Public License+# as published by the Free Software Foundation; either version 2+# of the License, or (at your option) any later version.+#+# This program is distributed in the hope that it will be useful,+# but WITHOUT ANY WARRANTY; without even the implied warranty of+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the+# GNU General Public License for more details.+#+# You should have received a copy of the GNU General Public License+# along with this program; if not, write to the Free Software+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.+#+# See COPYRIGHT and LICENSE files for more details.+#++++module OpenIDConnect+ class GroupLink < ::ApplicationRecord+ self.table_name = "oidc_group_links"++ belongs_to :group+ belongs_to :auth_provider+ end+enddiff --git a/modules/openid_connect/app/models/openid_connect/group_membership.rb b/modules/openid_connect/app/models/openid_connect/group_membership.rbnew file mode 100644index 00000000000..e3686f38731--- /dev/null+++ b/modules/openid_connect/app/models/openid_connect/group_membership.rb@@ -0,0 +1,40 @@+# frozen_string_literal: true++#-- copyright+# OpenProject is an open source project management software.+# Copyright (C) the OpenProject GmbH+#+# This program is free software; you can redistribute it and/or+# modify it under the terms of the GNU General Public License version 3.+#+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:+# Copyright (C) 2006-2013 Jean-Philippe Lang+# Copyright (C) 2010-2013 the ChiliProject Team+#+# This program is free software; you can redistribute it and/or+# modify it under the terms of the GNU General Public License+# as published by the Free Software Foundation; either version 2+# of the License, or (at your option) any later version.+#+# This program is distributed in the hope that it will be useful,+# but WITHOUT ANY WARRANTY; without even the implied warranty of+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the+# GNU General Public License for more details.+#+# You should have received a copy of the GNU General Public License+# along with this program; if not, write to the Free Software+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.+#+# See COPYRIGHT and LICENSE files for more details.+#++++module OpenIDConnect+ class GroupMembership < ::ApplicationRecord+ self.table_name = "oidc_group_memberships"++ belongs_to :auth_provider+ belongs_to :group_user++ delegate :group, :user, to: :group_user+ end+enddiff --git a/modules/openid_connect/app/models/openid_connect/provider.rb b/modules/openid_connect/app/models/openid_connect/provider.rbindex 0ab643a9c91..1d567d35431 100644--- a/modules/openid_connect/app/models/openid_connect/provider.rb+++ b/modules/openid_connect/app/models/openid_connect/provider.rb@@ -33,6 +33,9 @@ module OpenIDConnectinclude HashBuilderhas_many :remote_identities, as: :auth_source, dependent: :destroy+ has_many :oidc_group_memberships, inverse_of: :auth_provider,+ class_name: "::OpenIDConnect::GroupMembership",+ dependent: :delete_allOIDC_PROVIDERS = %w[google microsoft_entra custom].freezeDISCOVERABLE_STRING_ATTRIBUTES_MANDATORY = %i[authorization_endpoint@@ -70,6 +73,11 @@ module OpenIDConnectstore_attribute :options, :claims, :stringstore_attribute :options, :acr_values, :string+ store_attribute :options, :sync_groups, :boolean, default: false+ store_attribute :options, :groups_claim, :string, default: "groups"+ store_attribute :options, :group_prefixes, :json, default: []+ store_attribute :options, :group_regexes, :json, default: []+# azure specific optionstore_attribute :options, :use_graph_api, :boolean@@ -133,5 +141,15 @@ module OpenIDConnectdef scopes(scope || "").splitend++ def group_matchers+ if group_prefixes.present?+ group_prefixes.map { |p| Regexp.new("^#{Regexp.escape(p)}(.+)$") }+ elsif group_regexes.present?+ group_regexes.map { |r| Regexp.new(r) }+ else+ [/(.+)/]+ end+ endendenddiff --git a/modules/openid_connect/app/services/openid_connect/groups/sync_service.rb b/modules/openid_connect/app/services/openid_connect/groups/sync_service.rbnew file mode 100644index 00000000000..97f54f2621f--- /dev/null+++ b/modules/openid_connect/app/services/openid_connect/groups/sync_service.rb@@ -0,0 +1,111 @@+# frozen_string_literal: true++#-- copyright+# OpenProject is an open source project management software.+# Copyright (C) the OpenProject GmbH+#+# This program is free software; you can redistribute it and/or+# modify it under the terms of the GNU General Public License version 3.+#+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:+# Copyright (C) 2006-2013 Jean-Philippe Lang+# Copyright (C) 2010-2013 the ChiliProject Team+#+# This program is free software; you can redistribute it and/or+# modify it under the terms of the GNU General Public License+# as published by the Free Software Foundation; either version 2+# of the License, or (at your option) any later version.+#+# This program is distributed in the hope that it will be useful,+# but WITHOUT ANY WARRANTY; without even the implied warranty of+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the+# GNU General Public License for more details.+#+# You should have received a copy of the GNU General Public License+# along with this program; if not, write to the Free Software+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.+#+# See COPYRIGHT and LICENSE files for more details.+#++++module OpenIDConnect+ module Groups+ class SyncService+ def initialize(user:)+ @user = user+ @result = ServiceResult.success+ end++ def call(groups_claim:)+ raise ArgumentError, "groups_claim must not be nil" if groups_claim.nil?++ user_groups = []++ groups_claim.each do |oidc_group_name|+ group = process_oidc_group(oidc_group_name)+ user_groups << group if group+ end++ remove_groups_except(user_groups)++ @result+ end++ private++ def process_oidc_group(oidc_group_name)+ oidc_group_name = filter_and_name_group(oidc_group_name)+ return nil if oidc_group_name.nil?++ group = find_group(oidc_group_name)+ update_group_users(group) { |user_ids| (user_ids + [@user.id]).uniq }++ membership = group.group_users.find_by(user: @user)+ membership.oidc_group_memberships.find_or_create_by!(auth_provider: authentication_provider)++ group+ end++ def remove_groups_except(keep_groups)+ (@user.groups - keep_groups).each do |group|+ update_group_users(group) { |user_ids| user_ids - [@user.id] }+ end+ end++ def filter_and_name_group(group_name)+ matcher = authentication_provider.group_matchers.find { |m| m.match?(group_name) }+ return nil if matcher.nil?++ match = matcher.match(group_name)+ if match.size > 1+ match[1..].join.presence+ else+ group_name+ end+ end++ def find_group(oidc_group_name)+ group_link = GroupLink.find_or_initialize_by(auth_provider: authentication_provider, oidc_group_name:)+ if group_link.group.nil?+ group_link.group = ::Group.find_or_create_by!(name: oidc_group_name)+ group_link.save!+ end++ group_link.group+ end++ def update_group_users(group)+ # TODO: is that service well suited for many small group changes?+ current_user_ids = group.group_users.pluck(:user_id)+ new_user_ids = yield current_user_ids+ @result.merge!(+ ::Groups::UpdateService.new(user: User.system, model: group).call(user_ids: new_user_ids)+ )+ end++ def authentication_provider+ @user.authentication_provider # TODO: should we find that differently? (risk of multiple auth providers)+ end+ end+ end+enddiff --git a/modules/openid_connect/db/migrate/20250710133700_add_oidc_group_links.rb b/modules/openid_connect/db/migrate/20250710133700_add_oidc_group_links.rbnew file mode 100644index 00000000000..82ea82e945f--- /dev/null+++ b/modules/openid_connect/db/migrate/20250710133700_add_oidc_group_links.rb@@ -0,0 +1,43 @@+# frozen_string_literal: true++#-- copyright+# OpenProject is an open source project management software.+# Copyright (C) the OpenProject GmbH+#+# This program is free software; you can redistribute it and/or+# modify it under the terms of the GNU General Public License version 3.+#+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:+# Copyright (C) 2006-2013 Jean-Philippe Lang+# Copyright (C) 2010-2013 the ChiliProject Team+#+# This program is free software; you can redistribute it and/or+# modify it under the terms of the GNU General Public License+# as published by the Free Software Foundation; either version 2+# of the License, or (at your option) any later version.+#+# This program is distributed in the hope that it will be useful,+# but WITHOUT ANY WARRANTY; without even the implied warranty of+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the+# GNU General Public License for more details.+#+# You should have received a copy of the GNU General Public License+# along with this program; if not, write to the Free Software+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.+#+# See COPYRIGHT and LICENSE files for more details.+#++++class AddOidcGroupLinks < ActiveRecord::Migration[8.0]+ def change+ create_table :oidc_group_links do |t|+ t.belongs_to :group, null: false, index: true, foreign_key: { to_table: :users, on_delete: :cascade }++ t.belongs_to :auth_provider, null: false, index: false, foreign_key: { on_delete: :cascade }+ t.string :oidc_group_name, null: false+ t.index %i[auth_provider_id oidc_group_name], unique: true++ t.timestamps null: false+ end+ end+enddiff --git a/modules/openid_connect/db/migrate/20250711133700_add_oidc_group_memberships.rb b/modules/openid_connect/db/migrate/20250711133700_add_oidc_group_memberships.rbnew file mode 100644index 00000000000..efd51fd2e08--- /dev/null+++ b/modules/openid_connect/db/migrate/20250711133700_add_oidc_group_memberships.rb@@ -0,0 +1,45 @@+# frozen_string_literal: true++#-- copyright+# OpenProject is an open source project management software.+# Copyright (C) the OpenProject GmbH+#+# This program is free software; you can redistribute it and/or+# modify it under the terms of the GNU General Public License version 3.+#+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:+# Copyright (C) 2006-2013 Jean-Philippe Lang+# Copyright (C) 2010-2013 the ChiliProject Team+#+# This program is free software; you can redistribute it and/or+# modify it under the terms of the GNU General Public License+# as published by the Free Software Foundation; either version 2+# of the License, or (at your option) any later version.+#+# This program is distributed in the hope that it will be useful,+# but WITHOUT ANY WARRANTY; without even the implied warranty of+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the+# GNU General Public License for more details.+#+# You should have received a copy of the GNU General Public License+# along with this program; if not, write to the Free Software+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.+#+# See COPYRIGHT and LICENSE files for more details.+#++++class AddOidcGroupMemberships < ActiveRecord::Migration[8.0]+ def change+ create_table :oidc_group_memberships do |t|+ t.belongs_to :auth_provider, null: false,+ index: false,+ foreign_key: { on_delete: :cascade }+ t.belongs_to :group_user, null: false,+ index: true,+ foreign_key: { on_delete: :cascade }+ t.index %i[auth_provider_id group_user_id], unique: true++ t.timestamps null: false+ end+ end+enddiff --git a/modules/openid_connect/lib/open_project/openid_connect/engine.rb b/modules/openid_connect/lib/open_project/openid_connect/engine.rbindex a7d9b37a20f..1511d674afe 100644--- a/modules/openid_connect/lib/open_project/openid_connect/engine.rb+++ b/modules/openid_connect/lib/open_project/openid_connect/engine.rb@@ -56,7 +56,7 @@ module OpenProject::OpenIDConnectopenid_connect/auth_provider-custom.png)- patches %i[Sessions::UserSession User]+ patches %i[Sessions::UserSession Group User GroupUser]class_inflection_override("openid_connect" => "OpenIDConnect")@@ -87,6 +87,7 @@ module OpenProject::OpenIDConnectomniauth.oidc_access_tokenomniauth.oidc_refresh_tokenomniauth.oidc_expires_in+ omniauth.oidc_groups]h[:backchannel_logout_callback] = ->(logout_token) dodiff --git a/modules/openid_connect/lib/open_project/openid_connect/hooks/hook.rb b/modules/openid_connect/lib/open_project/openid_connect/hooks/hook.rbindex 3a03b45eaac..69f550f649e 100644--- a/modules/openid_connect/lib/open_project/openid_connect/hooks/hook.rb+++ b/modules/openid_connect/lib/open_project/openid_connect/hooks/hook.rb@@ -54,6 +54,9 @@ module OpenProject::OpenIDConnectclear_previous: true)end++ groups_claim = session["omniauth.oidc_groups"]+ OpenIDConnect::Groups::SyncService.new(user:).call(groups_claim:) unless groups_claim.nil?end##@@ -61,11 +64,16 @@ module OpenProject::OpenIDConnectdef omniauth_user_authorized(context)controller = context.fetch(:controller)session = controller.session+ provider = OpenIDConnect::Provider.find_by(slug: context.dig(:auth_hash, :provider))- if OpenIDConnect::Provider.exists?(slug: context.dig(:auth_hash, :provider))+ if providersession["omniauth.oidc_access_token"] = context.dig(:auth_hash, :credentials, :token)session["omniauth.oidc_refresh_token"] = context.dig(:auth_hash, :credentials, :refresh_token)session["omniauth.oidc_expires_in"] = parse_expires_in(context.dig(:auth_hash, :credentials, :expires_in))++ if provider.sync_groups+ session["omniauth.oidc_groups"] = context.dig(:auth_hash, :extra, :raw_info, provider.groups_claim)+ endendnildiff --git a/modules/openid_connect/lib/open_project/openid_connect/patches/group_patch.rb b/modules/openid_connect/lib/open_project/openid_connect/patches/group_patch.rbnew file mode 100644index 00000000000..12a19b1c9b5--- /dev/null+++ b/modules/openid_connect/lib/open_project/openid_connect/patches/group_patch.rb@@ -0,0 +1,46 @@+# frozen_string_literal: true++#-- copyright+# OpenProject is an open source project management software.+# Copyright (C) the OpenProject GmbH+#+# This program is free software; you can redistribute it and/or+# modify it under the terms of the GNU General Public License version 3.+#+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:+# Copyright (C) 2006-2013 Jean-Philippe Lang+# Copyright (C) 2010-2013 the ChiliProject Team+#+# This program is free software; you can redistribute it and/or+# modify it under the terms of the GNU General Public License+# as published by the Free Software Foundation; either version 2+# of the License, or (at your option) any later version.+#+# This program is distributed in the hope that it will be useful,+# but WITHOUT ANY WARRANTY; without even the implied warranty of+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the+# GNU General Public License for more details.+#+# You should have received a copy of the GNU General Public License+# along with this program; if not, write to the Free Software+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.+#+# See COPYRIGHT and LICENSE files for more details.+#++++module OpenProject::OpenIDConnect::Patches::GroupPatch+ def self.included(base) # :nodoc:+ base.extend(ClassMethods)+ base.include(InstanceMethods)++ base.class_eval do+ has_many :oidc_group_links, class_name: "OpenIDConnect::GroupLink"+ end+ end++ module ClassMethods+ end++ module InstanceMethods+ end+enddiff --git a/modules/openid_connect/lib/open_project/openid_connect/patches/group_user_patch.rb b/modules/openid_connect/lib/open_project/openid_connect/patches/group_user_patch.rbnew file mode 100644index 00000000000..a06eb392039--- /dev/null+++ b/modules/openid_connect/lib/open_project/openid_connect/patches/group_user_patch.rb@@ -0,0 +1,46 @@+# frozen_string_literal: true++#-- copyright+# OpenProject is an open source project management software.+# Copyright (C) the OpenProject GmbH+#+# This program is free software; you can redistribute it and/or+# modify it under the terms of the GNU General Public License version 3.+#+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:+# Copyright (C) 2006-2013 Jean-Philippe Lang+# Copyright (C) 2010-2013 the ChiliProject Team+#+# This program is free software; you can redistribute it and/or+# modify it under the terms of the GNU General Public License+# as published by the Free Software Foundation; either version 2+# of the License, or (at your option) any later version.+#+# This program is distributed in the hope that it will be useful,+# but WITHOUT ANY WARRANTY; without even the implied warranty of+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the+# GNU General Public License for more details.+#+# You should have received a copy of the GNU General Public License+# along with this program; if not, write to the Free Software+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.+#+# See COPYRIGHT and LICENSE files for more details.+#++++module OpenProject::OpenIDConnect::Patches::GroupUserPatch+ def self.included(base) # :nodoc:+ base.extend(ClassMethods)+ base.include(InstanceMethods)++ base.class_eval do+ has_many :oidc_group_memberships, class_name: "OpenIDConnect::GroupMembership"+ end+ end++ module ClassMethods+ end++ module InstanceMethods+ end+enddiff --git a/modules/openid_connect/spec/factories/oidc_group_link_factory.rb b/modules/openid_connect/spec/factories/oidc_group_link_factory.rbnew file mode 100644index 00000000000..a141cff9cc3--- /dev/null+++ b/modules/openid_connect/spec/factories/oidc_group_link_factory.rb@@ -0,0 +1,37 @@+# frozen_string_literal: true++#-- copyright+# OpenProject is an open source project management software.+# Copyright (C) the OpenProject GmbH+#+# This program is free software; you can redistribute it and/or+# modify it under the terms of the GNU General Public License version 3.+#+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:+# Copyright (C) 2006-2013 Jean-Philippe Lang+# Copyright (C) 2010-2013 the ChiliProject Team+#+# This program is free software; you can redistribute it and/or+# modify it under the terms of the GNU General Public License+# as published by the Free Software Foundation; either version 2+# of the License, or (at your option) any later version.+#+# This program is distributed in the hope that it will be useful,+# but WITHOUT ANY WARRANTY; without even the implied warranty of+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the+# GNU General Public License for more details.+#+# You should have received a copy of the GNU General Public License+# along with this program; if not, write to the Free Software+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.+#+# See COPYRIGHT and LICENSE files for more details.+#++++FactoryBot.define do+ factory :oidc_group_link, class: "OpenIDConnect::GroupLink" do+ group+ auth_provider factory: :oidc_provider+ sequence(:oidc_group_name) { |i| "oidc_group_#{i}" }+ end+enddiff --git a/modules/openid_connect/spec/models/provider_spec.rb b/modules/openid_connect/spec/models/provider_spec.rbindex 4c9f868ec21..abda679a65d 100644--- a/modules/openid_connect/spec/models/provider_spec.rb+++ b/modules/openid_connect/spec/models/provider_spec.rb@@ -54,4 +54,53 @@ RSpec.describe OpenIDConnect::Provider doit { is_expected.to be_falsey }endend++ describe "#group_matchers" do+ subject { provider.group_matchers }++ let(:provider) { create(:oidc_provider, group_prefixes:, group_regexes:) }++ context "when prefixes and regular expressions were never defined" do+ let(:group_prefixes) { nil }+ let(:group_regexes) { nil }++ it { is_expected.to eq([/(.+)/]) }+ end++ context "when prefixes and regular expressions are empty" do+ let(:group_prefixes) { [] }+ let(:group_regexes) { [] }++ it { is_expected.to eq([/(.+)/]) }+ end++ context "when prefixes were defined" do+ let(:group_prefixes) { ["a_", "b_"] }+ let(:group_regexes) { [] }++ it { is_expected.to eq([/^a_(.+)$/, /^b_(.+)$/]) }++ context "and when prefix contains regular expression special characters" do+ let(:group_prefixes) { ["pre.fix", "(prefix)"] }++ it { is_expected.to eq([/^pre\.fix(.+)$/, /^\(prefix\)(.+)$/]) }+ end+ end++ context "when regular expressions were defined" do+ let(:group_prefixes) { [] }+ let(:group_regexes) { ["[a-z_]+", "^specific_group_name$"] }++ it { is_expected.to eq([/[a-z_]+/, /^specific_group_name$/]) }+ end++ context "when prefixes and regular expressions were defined" do+ let(:group_prefixes) { ["a"] }+ let(:group_regexes) { [/[b]/] }++ it "prefers prefixes over regular expressions" do+ expect(subject).to eq([/^a(.+)$/])+ end+ end+ endenddiff --git a/modules/openid_connect/spec/requests/openid_connect_spec.rb b/modules/openid_connect/spec/requests/openid_connect_spec.rbindex bace9261cba..e3c466a174a 100644--- a/modules/openid_connect/spec/requests/openid_connect_spec.rb+++ b/modules/openid_connect/spec/requests/openid_connect_spec.rb@@ -45,7 +45,8 @@ RSpec.describe "OpenID Connect", :skip_2fa_stage, # Prevent redirects to 2FA staname: "Hans Wurst",email: "[email protected]",given_name: "Hans",- family_name: "Wurst"+ family_name: "Wurst",+ groups: ["my-group"]}endlet(:access_token) { "foo-bar-baz" }@@ -76,7 +77,7 @@ RSpec.describe "OpenID Connect", :skip_2fa_stage, # Prevent redirects to 2FA stalet(:limit_self_registration) { false }let!(:provider) { create(:oidc_provider, slug: "keycloak", limit_self_registration:) }- it "signs up and logs in the user", :freeze_time do+ it "signs up and logs in the user", :freeze_time do # rubocop:disable RSpec/ExampleLength### it should redirect to the provider's openid connect authentication endpointclick_on_signin("keycloak")@@ -99,8 +100,11 @@ RSpec.describe "OpenID Connect", :skip_2fa_stage, # Prevent redirects to 2FA stauser = User.find_by(mail: user_info[:email])- expect(user).not_to be_nil- expect(user.active?).to be true+ aggregate_failures "user details" do+ expect(user).not_to be_nil+ expect(user.active?).to be true+ expect(user.groups).to be_empty # group-sync not enabled+ endsession = Sessions::UserSession.for_user(user).firstsession_link = session&.oidc_session_link@@ -118,6 +122,22 @@ RSpec.describe "OpenID Connect", :skip_2fa_stage, # Prevent redirects to 2FA staendend+ context "when provider is configured to synchronize groups" do+ let!(:provider) do+ create(:oidc_provider, slug: "keycloak", limit_self_registration:, sync_groups: true, groups_claim: "groups")+ end++ it "signs up and logs in the user, adding them to the group", :freeze_time do+ click_on_signin("keycloak")+ redirect_from_provider("keycloak")++ user = User.find_by(mail: user_info[:email])++ expect(user).not_to be_nil+ expect(user.groups.pluck(:name)).to eq(["my-group"])+ end+ end+context "when the user is already registered" dobefore doclick_on_signin("keycloak")@@ -139,6 +159,34 @@ RSpec.describe "OpenID Connect", :skip_2fa_stage, # Prevent redirects to 2FA staexpect(response).to have_http_status :foundexpect(response.location).to eq "http://#{Setting.host_name}/"end++ context "when synchronizing groups, but the groups-claim is empty" do+ let!(:provider) do+ create(:oidc_provider, slug: "keycloak", limit_self_registration:, sync_groups: true, groups_claim: "groups")+ end+ let(:user_info) do+ {+ sub: "87117114115116",+ name: "Hans Wurst",+ email: "[email protected]",+ given_name: "Hans",+ family_name: "Wurst",+ groups: []+ }+ end++ before do+ User.find_by(mail: user_info[:email]).groups.create!(name: "A group")+ end++ it "removes all groups" do+ click_on_signin("keycloak")+ redirect_from_provider("keycloak")++ user = User.find_by(mail: user_info[:email])+ expect(user.groups.pluck(:name)).to be_empty+ end+ endendcontext "with self-registration disabled and provider respecting that",diff --git a/modules/openid_connect/spec/services/openid_connect/groups/sync_service_spec.rb b/modules/openid_connect/spec/services/openid_connect/groups/sync_service_spec.rbnew file mode 100644index 00000000000..2de0757c924--- /dev/null+++ b/modules/openid_connect/spec/services/openid_connect/groups/sync_service_spec.rb@@ -0,0 +1,259 @@+# frozen_string_literal: true++#-- copyright+# OpenProject is an open source project management software.+# Copyright (C) the OpenProject GmbH+#+# This program is free software; you can redistribute it and/or+# modify it under the terms of the GNU General Public License version 3.+#+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:+# Copyright (C) 2006-2013 Jean-Philippe Lang+# Copyright (C) 2010-2013 the ChiliProject Team+#+# This program is free software; you can redistribute it and/or+# modify it under the terms of the GNU General Public License+# as published by the Free Software Foundation; either version 2+# of the License, or (at your option) any later version.+#+# This program is distributed in the hope that it will be useful,+# but WITHOUT ANY WARRANTY; without even the implied warranty of+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the+# GNU General Public License for more details.+#+# You should have received a copy of the GNU General Public License+# along with this program; if not, write to the Free Software+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.+#+# See COPYRIGHT and LICENSE files for more details.+#++++require "spec_helper"++RSpec.describe OpenIDConnect::Groups::SyncService do+ subject(:call_service) { described_class.new(user:).call(groups_claim:) }++ let(:user) { create(:user, authentication_provider: provider) }+ let(:provider) { create(:oidc_provider) }+ let(:groups_claim) { ["oidc_group_a"] }++ it { is_expected.to be_success }++ it "creates a group" do+ call_service++ expect(Group.first&.name).to eq("oidc_group_a")+ end++ it "links the OIDC group to the local group" do+ call_service+ expect(Group.first.oidc_group_links.where(oidc_group_name: "oidc_group_a", auth_provider: provider)).to be_exist+ end++ it "adds the user to the group" do+ call_service++ expect(user.reload.groups).to include(Group.first)+ end++ it "marks the connection between user and group to be OIDC-related" do+ call_service++ oidc_membership = provider.oidc_group_memberships.first+ expect(oidc_membership).not_to be_nil+ expect(oidc_membership.user).to eq(user)+ expect(oidc_membership.group.name).to eq("oidc_group_a")+ end++ context "when a group already exists" do+ context "and it has the same name" do+ let!(:existing_group) { create(:group, name: "oidc_group_a") }++ it { is_expected.to be_success }++ it "links the OIDC group to the local group" do+ call_service+ expect(existing_group.oidc_group_links.where(oidc_group_name: "oidc_group_a", auth_provider: provider)).to be_exist+ end++ it "adds the user to the existing group" do+ call_service++ expect(user.reload.groups).to include(existing_group)+ end+ end++ context "and it is linked to the OIDC group" do+ let!(:existing_group) { create(:group, name: "local_group_a") }+ let!(:group_link) do+ create(:oidc_group_link, group: existing_group, auth_provider: provider, oidc_group_name: "oidc_group_a")+ end++ it "adds the user to the existing group" do+ call_service++ expect(user.reload.groups).to include(existing_group)+ end+ end+ end++ context "when the user was member of the group before" do+ let!(:existing_group) { create(:group, name: "oidc_group_a", members: [user]) }++ it { is_expected.to be_success }++ it "keeps the user in the group" do+ call_service++ expect(user.reload.groups).to include(existing_group)+ end++ it "marks the connection between user and group to be OIDC-related" do+ call_service++ oidc_membership = provider.oidc_group_memberships.first+ expect(oidc_membership).not_to be_nil+ expect(oidc_membership.user).to eq(user)+ expect(oidc_membership.group.name).to eq("oidc_group_a")+ end++ context "and when the membership was already marked as being OIDC-related" do+ before do+ existing_group.group_users.find_by!(user:).oidc_group_memberships.create!(auth_provider: provider)+ end++ it { is_expected.to be_success }++ it "doesn't mark the connection between user and group to be OIDC-related twice" do+ call_service++ oidc_memberships = existing_group.group_users.find_by!(user:).oidc_group_memberships+ expect(oidc_memberships.count).to eq(1)+ end+ end+ end++ context "when the user was member of a different group before" do+ let!(:existing_group) { create(:group, name: "oidc_group_b", members: [user]) }++ it { is_expected.to be_success }++ it "removes the user from the other group" do+ call_service++ expect(user.reload.groups).not_to include(existing_group)+ end++ context "and that was marked through an OIDC group membership" do+ let!(:membership) do+ existing_group.group_users.find_by(user:).oidc_group_memberships.create!(auth_provider: provider)+ end++ it { is_expected.to be_success }++ it "removes the user from the other group" do+ call_service++ expect(user.reload.groups).not_to include(existing_group)+ end++ it "removes the OIDC group membership as well" do+ expect { call_service }.to change { OpenIDConnect::GroupMembership.where(id: membership.id).count }.from(1).to(0)+ end+ end++ context "and the groups claim adds the user to zero groups" do+ let(:groups_claim) { [] }++ it { is_expected.to be_success }++ it "removes the user from all groups" do+ call_service++ expect(user.reload.groups).to be_empty+ end+ end+ end++ describe "group prefix matching" do+ let(:provider) { create(:oidc_provider, group_prefixes: ["/abc/", "/xyz/"]) }+ let(:groups_claim) { ["/abc/def/ghi", "/abc/ghi/def", "/def/abc/ghi", "/xyz/stu"] }++ it "creates matching groups" do+ expect { call_service }.to change(Group, :count).by(3)+ end++ it "cuts the prefix from the created group names" do+ call_service++ expect(Group.order(:name).pluck(:name)).to eq(["def/ghi", "ghi/def", "stu"])+ end++ it "links the OIDC group to the local group" do+ call_service++ expect(OpenIDConnect::GroupLink.find_by(oidc_group_name: "def/ghi")&.group&.name).to eq("def/ghi")+ end++ context "when prefix captures the full group name" do+ let(:provider) { create(:oidc_provider, group_prefixes: ["/abc/"]) }+ let(:groups_claim) { ["/abc/"] }++ it "creates no group (empty group name)" do+ expect { call_service }.not_to change(Group, :count)+ end+ end+ end++ describe "group regexp matching" do+ let(:provider) { create(:oidc_provider, group_regexes: ["/abc/(.{2})", "/xyz/(.{3})"]) }+ let(:groups_claim) { ["/abc/def/ghi", "abc/123", "/def/abc/ghi", "/xyz/stu"] }++ it "creates matching groups" do+ expect { call_service }.to change(Group, :count).by(3)+ end++ it "uses regular expression groups to determine name" do+ call_service++ expect(Group.order(:name).pluck(:name)).to eq(["de", "gh", "stu"])+ end++ it "links the OIDC group to the local group with correct names on both ends" do+ call_service++ expect(OpenIDConnect::GroupLink.find_by(oidc_group_name: "de")&.group&.name).to eq("de")+ end++ context "when there is no regular expression group" do+ let(:provider) { create(:oidc_provider, group_regexes: ["/abc/"]) }+ let(:groups_claim) { ["/abc/def/ghi", "/xyz/stu"] }++ it "uses the full group name" do+ call_service++ expect(Group.order(:name).pluck(:name)).to eq(["/abc/def/ghi"])+ end+ end++ context "when there are multiple regular expression groups" do+ let(:provider) { create(:oidc_provider, group_regexes: ["/abc/([a-z]+)/([a-z]+)"]) }+ let(:groups_claim) { ["/abc/def/ghi", "/def/abc/ghi/jkl", "/abc/stu"] }++ it "concatenates the match groups" do+ call_service++ expect(Group.order(:name).pluck(:name)).to eq(["defghi", "ghijkl"])+ end+ end++ context "when regex captures an empty group name" do+ let(:provider) { create(:oidc_provider, group_regexes: ["/abc/([a-z]*)"]) }+ let(:groups_claim) { ["/abc/"] }++ it "creates no group" do+ expect { call_service }.not_to change(Group, :count)+ end+ end+ end+enddiff --git a/modules/openid_connect/spec/services/principals/delete_job_integration_spec.rb b/modules/openid_connect/spec/services/principals/delete_job_integration_spec.rbnew file mode 100644index 00000000000..44d67b79e25--- /dev/null+++ b/modules/openid_connect/spec/services/principals/delete_job_integration_spec.rb@@ -0,0 +1,50 @@+# frozen_string_literal: true++#-- copyright+# OpenProject is an open source project management software.+# Copyright (C) the OpenProject GmbH+#+# This program is free software; you can redistribute it and/or+# modify it under the terms of the GNU General Public License version 3.+#+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:+# Copyright (C) 2006-2013 Jean-Philippe Lang+# Copyright (C) 2010-2013 the ChiliProject Team+#+# This program is free software; you can redistribute it and/or+# modify it under the terms of the GNU General Public License+# as published by the Free Software Foundation; either version 2+# of the License, or (at your option) any later version.+#+# This program is distributed in the hope that it will be useful,+# but WITHOUT ANY WARRANTY; without even the implied warranty of+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the+# GNU General Public License for more details.+#+# You should have received a copy of the GNU General Public License+# along with this program; if not, write to the Free Software+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.+#+# See COPYRIGHT and LICENSE files for more details.+#++++require "spec_helper"++RSpec.describe Principals::DeleteJob, "OpenIDConnect", type: :model do+ subject(:job) { described_class.perform_now(principal) }++ let(:principal) do+ create(:group)+ end++ context "with an OIDC group link" do+ let!(:link) { create(:oidc_group_link, group: principal) }++ it "deletes both the group and the group link" do+ job++ expect(Group.find_by(id: principal.id)).to be_nil+ expect(OpenIDConnect::GroupLink.find_by(id: link.id)).to be_nil+ end+ end+end