inginious.frontend.plugins.auth package¶

Auth plugins

Submodules¶

inginious.frontend.plugins.auth.saml2_auth module¶

SAML SSO plugin

class inginious.frontend.plugins.auth.saml2_auth.MetadataPage[source]¶

Bases: inginious.frontend.pages.utils.INGIniousPage

GET(id)[source]¶

methods: t.ClassVar[t.Collection[str] | None] = {'GET', 'POST'}¶: The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class inginious.frontend.plugins.auth.saml2_auth.SAMLAuthMethod(id, name, imlink, settings)[source]¶

Bases: inginious.frontend.user_manager.AuthMethod

SAML SSO auth method

callback(auth_storage)[source]¶

Parameters: auth_storage – The session auth method storage dict
Returns: User tuple and , or None, if failed

get_auth_link(auth_storage)[source]¶

Parameters: auth_storage – The session auth method storage dict
Returns: The authentication link

get_id()[source]¶

Returns: The auth method id

get_imlink()[source]¶

Returns: The image link

get_name()[source]¶

Returns: The name of the auth method, to be displayed publicly

get_settings()[source]¶

inginious.frontend.plugins.auth.saml2_auth.init(plugin_manager, course_factory, client, conf)[source]¶

inginious.frontend.plugins.auth.saml2_auth.prepare_request(settings)[source]¶: Prepare SAML request

inginious.frontend.plugins.auth.ldap_auth module¶

LDAP plugin

class inginious.frontend.plugins.auth.ldap_auth.LDAPAuthenticationPage[source]¶

Bases: inginious.frontend.pages.social.AuthenticationPage

GET(id)[source]¶

POST(id)[source]¶

methods: t.ClassVar[t.Collection[str] | None] = {'GET', 'POST'}¶: The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class inginious.frontend.plugins.auth.ldap_auth.LdapAuthMethod(id, name, imlink, settings)[source]¶

Bases: inginious.frontend.user_manager.AuthMethod

LDAP auth method

callback(auth_storage)[source]¶

Parameters: auth_storage – The session auth method storage dict
Returns: User tuple and , or None, if failed

get_auth_link(auth_storage)[source]¶

Parameters: auth_storage – The session auth method storage dict
Returns: The authentication link

get_id()[source]¶

Returns: The auth method id

get_imlink()[source]¶

Returns: The image link

get_name()[source]¶

Returns: The name of the auth method, to be displayed publicly

get_settings()[source]¶

inginious.frontend.plugins.auth.ldap_auth.init(plugin_manager, _, _2, conf)[source]¶

Allow to connect through a LDAP service

Available configuration:

plugins:
    - plugin_module": "inginious.frontend.plugins.auth.ldap_auth",

      host: "ldap.test.be",
      port: 0,
      encryption: "ssl",
      base_dn: "o=test,c=be",
      request: "(uid={})",
      name: "LDAP Login"

host: The host of the ldap server
encryption: Encryption method used to connect to the LDAP server Can be either “none”, “ssl” or “tls”
request: Request made to the server in order to find the dn of the user. The characters “{}” will be replaced by the login name.