From b54478e7e1e82bde1eddcab63126e9b2d423f68f Mon Sep 17 00:00:00 2001 From: Andrew Bonney Date: Tue, 12 Sep 2023 08:51:13 +0100 Subject: [PATCH] oidc: fix recognition of x forwarded headers from v2.4.11 The Apache mod_auth_openidc requires explicit configuration in order to read the X-Forwarded-Proto from the reverse proxy as of version v2.4.11 which comes in from Ubuntu Jammy. Eventually this will need to become the default and the variable added in this patch can be removed. Change-Id: Ic9d37a8463d137508d20de20b10af806a223f852 --- ...oidc-forwarded-proto-92471121e3949428.yaml | 5 + templates/keystone-httpd.conf.j2 | 3 + vars/ubuntu-22.04.yml | 106 ++++++++++++++++++ 3 files changed, 114 insertions(+) create mode 100644 releasenotes/notes/keystone-oidc-forwarded-proto-92471121e3949428.yaml create mode 100644 vars/ubuntu-22.04.yml diff --git a/releasenotes/notes/keystone-oidc-forwarded-proto-92471121e3949428.yaml b/releasenotes/notes/keystone-oidc-forwarded-proto-92471121e3949428.yaml new file mode 100644 index 00000000..3135700e --- /dev/null +++ b/releasenotes/notes/keystone-oidc-forwarded-proto-92471121e3949428.yaml @@ -0,0 +1,5 @@ +--- +fixes: + - | + Fixes use of Apache mod_auth_openidc on Ubuntu Jammy where a new + OIDCXForwardedHeaders configuration option is required. diff --git a/templates/keystone-httpd.conf.j2 b/templates/keystone-httpd.conf.j2 index 2f9108d4..74961cc8 100644 --- a/templates/keystone-httpd.conf.j2 +++ b/templates/keystone-httpd.conf.j2 @@ -53,6 +53,9 @@ Listen {{ keystone_web_server_bind_address }}:{{ keystone_service_port }} OIDCClientSecret {{ keystone_sp.trusted_idp_list.0.oidc_client_secret }} OIDCCryptoPassphrase {{ keystone_sp.trusted_idp_list.0.oidc_crypto_passphrase }} OIDCRedirectURI {{ keystone_sp.trusted_idp_list.0.oidc_redirect_uri }} + {% if _keystone_sp_apache_mod_auth_openidc_gte_2_4_11 is defined -%} + OIDCXForwardedHeaders {{ keystone_secure_proxy_ssl_header }} + {% endif -%} {% if keystone_sp.trusted_idp_list.0.oidc_auth_verify_jwks_uri is defined -%} OIDCOAuthVerifyJwksUri {{ keystone_sp.trusted_idp_list.0.oidc_auth_verify_jwks_uri }} {% endif -%} diff --git a/vars/ubuntu-22.04.yml b/vars/ubuntu-22.04.yml new file mode 100644 index 00000000..3bce800e --- /dev/null +++ b/vars/ubuntu-22.04.yml @@ -0,0 +1,106 @@ +--- +# Copyright 2016, Rackspace US, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +cache_timeout: 600 + +keystone_distro_packages: + - git + - libldap-common + - openssh-server + - rsync + - cron + - libpython3-dev + +keystone_devel_distro_packages: + - docutils-common + - libffi-dev + - libjs-sphinxdoc + - libjs-underscore + - libldap2-dev + - libsasl2-dev + - libsystemd-dev + - libssl-dev + - libxslt1.1 + - libxslt1-dev + - libxml2-dev + - pkg-config + +keystone_service_distro_packages: + - python3-keystone + - python3-systemd + - uwsgi + - uwsgi-plugin-python3 + +keystone_apache_distro_packages: + - apache2 + - apache2-utils + - libapache2-mod-proxy-uwsgi + +keystone_idp_distro_packages: + - ssl-cert + - xmlsec1 + +keystone_sp_apache_mod_packages: + - name: libapache2-mod-shib + state: "{{ keystone_sp_apache_mod_shib | ternary('present', 'absent') }}" + - name: libapache2-mod-auth-openidc + state: "{{ keystone_sp_apache_mod_auth_openidc | ternary('present', 'absent') }}" + +keystone_developer_mode_distro_packages: + - build-essential + +keystone_oslomsg_amqp1_distro_packages: + - libsasl2-modules + - sasl2-bin + +keystone_apache_default_sites: + - "/etc/apache2/sites-enabled/000-default.conf" + +keystone_apache_site_available: "/etc/apache2/sites-available/keystone-httpd.conf" +keystone_apache_site_enabled: "/etc/apache2/sites-enabled/keystone-httpd.conf" +keystone_apache_conf: "/etc/apache2/apache2.conf" +keystone_apache_default_log_folder: "/var/log/apache2" +keystone_apache_default_log_owner: "root" +keystone_apache_default_log_grp: "adm" +keystone_apache_security_conf: "/etc/apache2/conf-available/security.conf" + +keystone_apache_configs: + - { src: "keystone-ports.conf.j2", dest: "/etc/apache2/ports.conf" } + - { src: "keystone-httpd.conf.j2", dest: "/etc/apache2/sites-available/keystone-httpd.conf" } + - { src: "keystone-httpd-mpm.conf.j2", dest: "/etc/apache2/mods-available/mpm_{{ keystone_httpd_mpm_backend }}.conf" } + +keystone_apache_modules: + - name: "ssl" + state: "{{ (keystone_backend_ssl | bool) | ternary('present', 'absent') }}" + - name: "shib" + state: "{{ keystone_sp_apache_mod_shib | ternary('present', 'absent') }}" + - name: "auth_openidc" + state: "{{ keystone_sp_apache_mod_auth_openidc | ternary('present', 'absent') }}" + - name: "proxy_uwsgi" + state: "present" + - name: "headers" + state: "present" +# This can be enabled when Apache2.5+ is available +# - name: "mod_journald" +# state: "present + +keystone_system_service_name: "{{ (keystone_use_uwsgi | bool) | ternary('keystone-wsgi-public', 'apache2') }}" + +keystone_uwsgi_bin: '/usr/bin' + +keystone_sshd: ssh + +# From 2.4.11, mod_auth_openidc ignores X-Forwarded headers unless explicitly configured +_keystone_sp_apache_mod_auth_openidc_gte_2_4_11: True