Skip to content

Support SAML2 as authentication #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mboisson wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Support SAML2 as authentication #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
93d1210
allow to configure metrix with saml2 as authentication instead of ldap
mboisson Apr 2, 2026
a33595a
update to metrix 1.7.0 which removes need to fix cffi
mboisson Apr 8, 2026
af04b1b
add configurable extra attributes to request, to access and to get st…
mboisson Apr 10, 2026
fcebced
generalized attributes logic to make it applicable wider than SAML2
mboisson Apr 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 53 additions & 13 deletions manifests/init.pp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,26 +12,41 @@
String $slurm_password,
String $cluster_name,
String $subdomain,
String $ssl_private_key_file = '/etc/ssl/metrix.private.key',
String $ssl_public_cert_file = '/etc/ssl/metrix.public.cert',
Enum['ldap', 'saml2'] $auth_type = 'ldap',
Array[String] $saml2_extra_required_attributes = [],
Array[Hash[String, String]] $staff_attributes = [],
Array[Hash[String, String]] $required_access_attributes = [],
Optional[String] $ssl_private_key = undef,
Optional[String] $ssl_public_cert = undef,
Optional[String] $idp_metadata = undef,
) {
include metrix::install

file { '/var/www/metrix/userportal/settings/99-local.py':
show_diff => false,
content => epp('metrix/99-local.py',
{
'password' => $password,
'slurm_password' => $slurm_password,
'cluster_name' => $cluster_name,
'secret_key' => seeded_rand_string(32, $password),
'domain_name' => $domain_name,
'subdomain' => $subdomain,
'logins' => $logins,
'prometheus_ip' => $prometheus_ip,
'prometheus_port' => $prometheus_port,
'db_ip' => $db_ip,
'db_port' => $db_port,
'base_dn' => $base_dn,
'ldap_password' => $ldap_password,
'password' => $password,
'slurm_password' => $slurm_password,
'cluster_name' => $cluster_name,
'secret_key' => seeded_rand_string(32, $password),
'domain_name' => $domain_name,
'subdomain' => $subdomain,
'logins' => $logins,
'prometheus_ip' => $prometheus_ip,
'prometheus_port' => $prometheus_port,
'db_ip' => $db_ip,
'db_port' => $db_port,
'base_dn' => $base_dn,
'ldap_password' => $ldap_password,
'auth_type' => $auth_type,
'ssl_key_file' => $ssl_private_key_file,
'ssl_cert_file' => $ssl_public_cert_file,
'saml2_extra_required_attributes' => $saml2_extra_required_attributes,
'staff_attributes' => $staff_attributes,
'required_access_attributes' => $required_access_attributes,
}
),
owner => 'apache',
Expand Down Expand Up @@ -131,6 +146,31 @@
mode => '0600',
}

if $ssl_private_key != undef {
file { $ssl_private_key_file:
content => $ssl_private_key,
mode => '0400',
owner => 'apache',
group => 'apache',
}
}
if $ssl_public_cert != undef {
file { $ssl_public_cert_file:
content => $ssl_public_cert,
mode => '0422',
owner => 'apache',
group => 'apache',
}
}
if $idp_metadata != undef {
file { '/var/www/metrix/idp_metadata.xml':
content => $idp_metadata,
mode => '0422',
owner => 'apache',
group => 'apache',
}
}

exec { 'metrix_api_token':
command => Sensitive($api_token_command),
subscribe => [
Expand Down
211 changes: 118 additions & 93 deletions manifests/install.pp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
class metrix::install (
String $version = '1.6.0',
String $version = '1.7.0',
String $python_version = '3.13',
) {
ensure_packages(['gcc', 'openldap-devel',])
$auth_type = lookup('metrix::auth_type')

if $auth_type == 'saml2' {
ensure_packages(['libffi-devel', 'xmlsec1', 'xmlsec1-openssl'])
}
ensure_packages(['gcc', 'openldap-devel'])

file { '/var/www/metrix/':
ensure => 'directory',
Expand All @@ -20,97 +25,101 @@
cleanup => true,
user => 'apache',
}
# We use LDAP auth instead of SAML2 auth, so we can remove all
# code and dependencies related to SAML2
-> file_line { 'remove_saml2_urls':
ensure => absent,
path => '/var/www/metrix/userportal/urls.py',
match => 'saml2',
match_for_absence => true,
multiple => true,
}
-> file_line { 'remove_saml2_10-base':
ensure => absent,
path => '/var/www/metrix/userportal/settings/10-base.py',
match => 'saml2',
match_for_absence => true,
multiple => true,
}
-> file { 'remove_40-saml':
ensure => absent,
path => '/var/www/metrix/userportal/settings/40-saml.py',
}
-> file_line { 'cffi':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^cffi',
match_for_absence => true,
}
-> file_line { 'cryptography':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^cryptography',
match_for_absence => true,
}
-> file_line { 'defusedxml':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^defusedxml',
match_for_absence => true,
}
-> file_line { 'djangosaml2':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^djangosaml2',
match_for_absence => true,
}
-> file_line { 'elementpath':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^elementpath',
match_for_absence => true,
}
-> file_line { 'pycparser':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^pycparser',
match_for_absence => true,
}
-> file_line { 'pyparsing':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^pyparsing',
match_for_absence => true,
}
-> file_line { 'pysaml2':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^pysaml2',
match_for_absence => true,
}
-> file_line { 'pyOpenSSL':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^pyOpenSSL',
match_for_absence => true,
}
-> file_line { 'xmlschema':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^xmlschema',
match_for_absence => true,
if $auth_type == 'ldap' {
# We use LDAP auth instead of SAML2 auth, so we can remove all
# code and dependencies related to SAML2
file_line { 'remove_saml2_urls':
ensure => absent,
path => '/var/www/metrix/userportal/urls.py',
match => 'saml2',
match_for_absence => true,
multiple => true,
require => Archive['metrix']
}
-> file_line { 'remove_saml2_10-base':
ensure => absent,
path => '/var/www/metrix/userportal/settings/10-base.py',
match => 'saml2',
match_for_absence => true,
multiple => true,
}
-> file { 'remove_40-saml':
ensure => absent,
path => '/var/www/metrix/userportal/settings/40-saml.py',
}
-> file_line { 'cffi':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^cffi',
match_for_absence => true,
}
-> file_line { 'cryptography':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^cryptography',
match_for_absence => true,
}
-> file_line { 'defusedxml':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^defusedxml',
match_for_absence => true,
}
-> file_line { 'djangosaml2':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^djangosaml2',
match_for_absence => true,
}
-> file_line { 'elementpath':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^elementpath',
match_for_absence => true,
}
-> file_line { 'pycparser':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^pycparser',
match_for_absence => true,
}
-> file_line { 'pyparsing':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^pyparsing',
match_for_absence => true,
}
-> file_line { 'pysaml2':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^pysaml2',
match_for_absence => true,
}
-> file_line { 'pyOpenSSL':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^pyOpenSSL',
match_for_absence => true,
}
-> file_line { 'xmlschema':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^xmlschema',
match_for_absence => true,
}
}
# Next dependencies are not used by Trailblazing Turtle
# they are dependencies of matplotlib which should be optional
# dependencies of prometheus-api-client, but currently aren't
# so we remove the dependencies and install a fork of prometheus-api-client
# that only make matplotlib optional.
# See: https://github.com/4n4nd/prometheus-api-client-python/pull/303
-> file_line { 'contourpy':
file_line { 'contourpy':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^contourpy',
match_for_absence => true,
require => Archive['metrix'],
}
-> file_line { 'cycler':
ensure => absent,
Expand Down Expand Up @@ -173,22 +182,38 @@
path => '/var/www/metrix/requirements.txt',
match => '^mysqlclient',
line => 'pymysql~=1.1',
}
-> uv::venv { 'metrix_venv':
prefix => '/opt/software/metrix-env',
python => $python_version,
requirements => 'django-auth-ldap',
requirements_path => '/var/www/metrix/requirements.txt',
require => [
Package['gcc'],
Package['openldap-devel'],
],
before => Uv::Venv['metrix_venv'],
}
if $auth_type == 'ldap' {
uv::venv { 'metrix_venv':
prefix => '/opt/software/metrix-env',
python => $python_version,
requirements => 'django-auth-ldap',
requirements_path => '/var/www/metrix/requirements.txt',
require => [
Package['gcc'],
Package['openldap-devel'],
],
}
}
else {
uv::venv { 'metrix_venv':
prefix => '/opt/software/metrix-env',
python => $python_version,
requirements_path => '/var/www/metrix/requirements.txt',
require => [
Package['gcc'],
Package['openldap-devel'],
Package['libffi-devel'],
],
}
}
# Replace mysqlclient by pymysql in the Python code import.
-> file_line { 'pymysql':
file_line { 'pymysql':
path => '/var/www/metrix/manage.py',
after => '^import sys',
line => 'import pymysql; pymysql.install_as_MySQLdb()',
require => Uv::Venv['metrix_venv']
}
-> file_line { 'manage.py_header':
path => '/var/www/metrix/manage.py',
Expand Down
Loading