Added tag v4.20.1 for changeset 7e2eb896a02c
Added tag v4.20.1 for changeset 7e2eb896a02c

File last commit:

r4306:09801de9 default
r4468:28135035 stable
Show More
107 lines | 4.1 KiB | text/x-python | PythonLexer
# -*- coding: utf-8 -*-
# Copyright (C) 2012-2020 RhodeCode GmbH
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License, version 3
# (only), as published by the Free Software Foundation.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# GNU General Public License for more details.
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <>.
# This program is dual-licensed. If you wish to learn more about the
# RhodeCode Enterprise Edition, including its added features, Support services,
# and proprietary license terms, please see
import logging
from pyramid.exceptions import ConfigurationError
from zope.interface import implementer
from rhodecode.authentication.interface import IAuthnPluginRegistry
from rhodecode.lib.utils2 import safe_str
from rhodecode.model.settings import SettingsModel
log = logging.getLogger(__name__)
class AuthenticationPluginRegistry(object):
# INI settings key to set a fallback authentication plugin.
fallback_plugin_key = 'rhodecode.auth_plugin_fallback'
def __init__(self, settings):
self._plugins = {}
self._plugins_for_auth = None
self._fallback_plugin = settings.get(self.fallback_plugin_key, None)
def add_authn_plugin(self, config, plugin):
plugin_id = plugin.get_id()
if plugin_id in self._plugins.keys():
raise ConfigurationError(
'Cannot register authentication plugin twice: "%s"', plugin_id)
log.debug('Register authentication plugin: "%s"', plugin_id)
self._plugins[plugin_id] = plugin
def get_plugins(self):
def sort_key(plugin):
return str.lower(safe_str(plugin.get_display_name()))
return sorted(self._plugins.values(), key=sort_key)
def get_plugin(self, plugin_id):
return self._plugins.get(plugin_id, None)
def get_plugin_by_uid(self, plugin_uid):
for plugin in self._plugins.values():
if plugin.uid == plugin_uid:
return plugin
def invalidate_plugins_for_auth(self):
log.debug('Invalidating cached plugins for authentication')
self._plugins_for_auth = None
def get_plugins_for_authentication(self):
Returns a list of plugins which should be consulted when authenticating
a user. It only returns plugins which are enabled and active.
Additionally it includes the fallback plugin from the INI file, if
`rhodecode.auth_plugin_fallback` is set to a plugin ID.
if self._plugins_for_auth is not None:
return self._plugins_for_auth
plugins = []
# Add all enabled and active plugins to the list. We iterate over the
# auth_plugins setting from DB because it also represents the ordering.
enabled_plugins = SettingsModel().get_auth_plugins()
raw_settings = SettingsModel().get_all_settings()
for plugin_id in enabled_plugins:
plugin = self.get_plugin(plugin_id)
if plugin is not None and plugin.is_active(
# inject settings into plugin, we can re-use the DB fetched settings here
plugin._settings = plugin._propagate_settings(raw_settings)
# Add the fallback plugin from ini file.
if self._fallback_plugin:
'Using fallback authentication plugin from INI file: "%s"',
plugin = self.get_plugin(self._fallback_plugin)
if plugin is not None and plugin not in plugins:
plugin._settings = plugin._propagate_settings(raw_settings)
self._plugins_for_auth = plugins
return self._plugins_for_auth