auth_env¶
This pluggable module provides default authentication service based on server environment. In this case the burden of performing actual authentication is on the web server used for serving the web interface. The authentication module then simply uses selected environment variables set up by the server after successful authentication.
This module also provides interface for automated user account registration. The registration form is pre-filled with data gathered again from server environment. The login may not be changed and the value fetched from environment is always used. Other account attributes like name or email address may be tweaked by user before submitting the registration form. Administrator and user are both notified via email about the fact new account was just created.
Environment variables¶
Currently following environment variables set up by the HTTP server are supported:
eppn
,``REMOTE_USER`` (MANDATORY)The
eppn
server variable is set up by the _shibd_ daemon implementing the Shibboleth SSO service. TheREMOTE_USER
variable is set up by many authentication providers. This environment variable is of course mandatory, and it is used as an account username (login).cn
,``givenName``,``sn`` (OPTIONAL)The
cn
server variable is used to fill in user`s name, when available. When not available, user`s name is constructed as contatenation ofgivenName
andsn
server variables. When none of the above is available, user has to input his/her name manually during registration process.perunPreferredMail
,``mail`` (OPTIONAL)The
perunPreferredMail
server variable is used to fill in user`s email address, when available. When not available, the first email address fromemail
server variable is used. When none of the above is available, user has to input his/her email manually during registration process.perunOrganizationName
,``o`` (OPTIONAL)The
perunOrganizationName
server variable is used to fill in user`s home organization name, when available. When not available, the value ofo
server variable is used. When none of the above is available, user has to input his/her home organization name manually during registration process.
Provided endpoints¶
/auth_env/login
Page providing login functionality via server set environment variables.
Authentication: no authentication
Methods:
GET
/auth_env/register
User account registration using server set environment variables.
Authentication: no authentication
Methods:
GET
,POST