Skip to content

Saml2 #6

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
cmd-ntrf wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Saml2 #6

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
8bbfd82
Update metrix to 1.7.0
cmd-ntrf Jul 3, 2026
14a92c4
Add support for SAML2 authentication
cmd-ntrf Jul 3, 2026
9250ee4
update SAML config and CSRF_TRUSTED_ORIGINS for BASE_URL with trailin…
cmd-ntrf Jul 3, 2026
8cdcd50
add the actual domain in the ALLOWED_HOSTS
mboisson Jun 19, 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
113 changes: 113 additions & 0 deletions manifests/auth/ldap.pp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
class metrix::auth::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'],
before => Uv::Venv['metrix_venv'],
}
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,
before => Uv::Venv['metrix_venv'],
}
file { 'remove_40-saml':
ensure => absent,
path => '/var/www/metrix/userportal/settings/40-saml.py',
before => Uv::Venv['metrix_venv'],
}
file_line { 'cffi':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^cffi',
match_for_absence => true,
before => Uv::Venv['metrix_venv'],
}
file_line { 'cryptography':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^cryptography',
match_for_absence => true,
before => Uv::Venv['metrix_venv'],
}
file_line { 'defusedxml':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^defusedxml',
match_for_absence => true,
before => Uv::Venv['metrix_venv'],
}
file_line { 'djangosaml2':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^djangosaml2',
match_for_absence => true,
before => Uv::Venv['metrix_venv'],
}
file_line { 'elementpath':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^elementpath',
match_for_absence => true,
before => Uv::Venv['metrix_venv'],
}
file_line { 'pycparser':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^pycparser',
match_for_absence => true,
before => Uv::Venv['metrix_venv'],
}
file_line { 'pyparsing':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^pyparsing',
match_for_absence => true,
before => Uv::Venv['metrix_venv'],
}
file_line { 'pysaml2':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^pysaml2',
match_for_absence => true,
before => Uv::Venv['metrix_venv'],
}
file_line { 'pyOpenSSL':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^pyOpenSSL',
match_for_absence => true,
before => Uv::Venv['metrix_venv'],
}
file_line { 'xmlschema':
ensure => absent,
path => '/var/www/metrix/requirements.txt',
match => '^xmlschema',
match_for_absence => true,
before => Uv::Venv['metrix_venv'],
}
file_line { 'django-auth-ldap':
line => 'django-auth-ldap',
path => '/var/www/metrix/requirements.txt',
before => Uv::Venv['metrix_venv'],
}

file { '/var/www/metrix/userportal/settings/92-local_auth.py':
show_diff => false,
content => epp('metrix/92-local_ldap.py',
{
}
),
owner => 'apache',
group => 'apache',
mode => '0600',
require => Class['metrix::install'],
}
}
43 changes: 43 additions & 0 deletions manifests/auth/saml2.pp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
class metrix::auth::saml2 (
String $ssl_private_key,
String $ssl_public_cert,
String $idp_metadata,
Array[String] $extra_required_attributes = [],
) {
ensure_packages(['libffi-devel', 'xmlsec1', 'xmlsec1-openssl'])

file { '/var/www/metrix/saml2-private.key':
content => $ssl_private_key,
mode => '0400',
owner => 'apache',
group => 'apache',
require => File['/var/www/metrix'],
}
file { '/var/www/metrix/saml2-public.pem':
content => $ssl_public_cert,
mode => '0422',
owner => 'apache',
group => 'apache',
require => File['/var/www/metrix'],
}
file { '/var/www/metrix/idp_metadata.xml':
content => $idp_metadata,
mode => '0422',
owner => 'apache',
group => 'apache',
require => File['/var/www/metrix'],
}

file { '/var/www/metrix/userportal/settings/92-local_auth.py':
show_diff => false,
content => epp('metrix/92-local_saml2.py',
{
'extra_required_attributes' => $extra_required_attributes,
}
),
owner => 'apache',
group => 'apache',
mode => '0600',
require => Class['metrix::install'],
}
}
20 changes: 16 additions & 4 deletions manifests/init.pp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,26 @@
String $cluster_name,
String $subdomain,
String $slurm_user = 'slurm',
Enum['ldap', 'saml2'] $auth_type = 'ldap',
Optional[String] $slurm_db_ip = undef,
Optional[Integer] $slurm_db_port = undef,
) {
include metrix::install
case $auth_type {
'ldap': {
include metrix::auth::ldap
}
'saml2': {
include metrix::auth::saml2
}
default: {
fail('Unsupported auth_type')
}
}

file { '/var/www/metrix/userportal/settings/99-local.py':
file { '/var/www/metrix/userportal/settings/91-local.py':
show_diff => false,
content => epp('metrix/99-local.py',
content => epp('metrix/91-local.py',
{
'password' => $password,
'slurm_user' => $slurm_user,
Expand Down Expand Up @@ -85,7 +97,7 @@
subscribe => [
Mysql::Db['metrix'],
Class['metrix::install'],
File['/var/www/metrix/userportal/settings/99-local.py'],
File['/var/www/metrix/userportal/settings/91-local.py'],
File['/var/www/metrix/userportal/local.py'],
],
notify => Service['metrix'],
Expand All @@ -98,7 +110,7 @@
'/opt/software/metrix-env/bin',
],
require => [
File['/var/www/metrix/userportal/settings/99-local.py'],
File['/var/www/metrix/userportal/settings/91-local.py'],
File['/var/www/metrix/userportal/local.py'],
Class['metrix::install'],
],
Expand Down
128 changes: 28 additions & 100 deletions manifests/install.pp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,24 @@
class metrix::install (
String $version = '1.6.0',
String $source_url = "https://github.com/guilbaults/TrailblazingTurtle/archive/refs/tags/v${version}.tar.gz",
String $version = '1.7.0',
String $python_version = '3.13',
) {
stdlib::ensure_packages(['gcc', 'openldap-devel',])
$auth_type = lookup('metrix::auth_type')

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

file { '/var/www/metrix/':
ensure => 'directory',
owner => 'apache',
group => 'apache',
ensure => 'directory',
owner => 'apache',
group => 'apache',
require => Package['httpd'],
}
-> archive { 'metrix':
ensure => present,
source => "https://github.com/guilbaults/TrailblazingTurtle/archive/refs/tags/v${version}.tar.gz",
source => inline_template($source_url),
creates => '/var/www/metrix/manage.py',
path => '/tmp/metrix.tar.gz',
extract => true,
Expand All @@ -20,97 +27,18 @@
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,
}
# 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 @@ -170,25 +98,25 @@
}
# Replace mysqlclient by a pure python compatible alternative to reduce install dependencies
-> file_line { 'mysqlclient':
path => '/var/www/metrix/requirements.txt',
match => '^mysqlclient',
line => 'pymysql~=1.1',
path => '/var/www/metrix/requirements.txt',
match => '^mysqlclient',
line => 'pymysql~=1.1',
before => Uv::Venv['metrix_venv'],
}
-> uv::venv { 'metrix_venv':

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'],
],
}
Package <| tag == 'metrix' |> -> Uv::Venv['metrix_venv']

# Replace mysqlclient by pymysql in the Python code import.
-> file_line { 'pymysql':
path => '/var/www/metrix/manage.py',
after => '^import sys',
line => 'import pymysql; pymysql.install_as_MySQLdb()',
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