===== Installation eduMFA =====

siehe [[https://edumfa.readthedocs.io/en/latest/installation/index.html|Installationsanleitung eduMFA]]

===== Konfiguration eduMFA =====

==== Einrichtung eines Funktionsnutzers ====
Das fudiscr-Plugin kommuniziert mit eduMFA über dessen API. Es werden drei Endpunkte verwendet:

  * /token/ (Abrufen einer Liste von Tokens)
  * /validate/triggerchallenge (Initiieren einer Token-Challenge)
  * /validate/check (Überprüfen eines OTP ggf. in Kombination mit einer PIN)

Ein Nutzer muss also über die Berechtigungen verfügen, die Aktionen, die bei Aufruf dieser Endpunkte ausgelöst werden, ausführen zu dürfen. Am besten sollte dieser Nutzer über keine weiteren Rechte verfügen.
\\

=== Anlegen eines Admin-Nutzers ===
----
**Achtung**: Wir gehen davon aus, das der initiale Admin-Supernutzer //admin// vorhanden ist.
Zunächst muss ein Admin-Nutzer für den Zugriff vom Identity Provider angelegt werden. Es empfiehlt sich, hierfür auch einen eigenen (administrativen) Realm anzulegen, um Berechtigungen für unterschiedliche Arten von Admin später besser trennen zu können. Der anzulegende Nutzer kann dann aus einer beliebigen externen Quelle kommen und über einen in eduMFA definierten Resolver importiert werden.

Das Anlegen von Realms und Resolvern ist nicht Thema dieser Anleitung. Wir legen hier jedoch der Einfachheit und Anschaulichkeit wegen einen eduMFA-internen IdP-Admin-Nutzer an.

<code>
edumfa-manage admin add idp-admin
</code>

**Um die Anzahl an API-Anfragen zu reduzieren, sollte für den //idp-admin// anstelle von Benutzernamen und Passwort ein Token für den Zugriff erzeugt werden.** Dieser Token kann mit einer beliebigen Gültigkeitsdauer in Tagen (default 365) versehen werden. Das nachfolgende Beispiel legt eine Gültigkeitsdauer von zehn Jahren fest:

<code>
edumfa-manage api createtoken -r admin -u idp-admin -d 3650
</code>
\\

=== Vergeben der Berechtigungen ===
----
Die notwendigen Berechtigungen werden via Policy in eduMFA eingetragen.

**Achtung**: Admins in eduMFA haben zu Beginn Rechte für alle Aktionen.
Dies gilt solange, wie keine Admin-Policy definiert ist.
Definiert man eine Policy im Scope 'admin', so gelten für alle Admins nur noch die den Policies eingetragenen Rechte.
Sollte es noch keine weitere Admin-Policy geben, sollte man daher darauf achten, sich nicht selbst aus dem Web-UI auszusperren.

Zunächst wird mit der Richtlinien-Vorlage //superuser// die funktionserhaltende Richtlinie für den Admin-Supernutzer erstellt, und der Nutzer //admin// zugewiesen.

Anschließend wird nun eine neue Policy für den Nutzer //idp-admin// erstellt.

Hierfür wird eine neue Datei //idp-admin-policy// erstellt, welche die Parameter der Policy als Python-Dictionary enthält. Der Inhalt sollte wie folgt aussehen:
<file python idp-admin-policy>
{   'policy': [   
      {
        'action': {'tokenlist':True, 'triggerchallenge':True},
        'active': True,
        'adminuser': ['idp-admin'],
        'name': 'idp-admin-policy',
        'scope': 'admin'
      }
   ]
}
</file>

Die Policy kann unter Nutzung dieser Datei erstellt werden:
<code>
edumfa-manage policy p_import -f idp-admin-policy
</code>
\\

==== Notwendige Richtlinien ====
Das fudiscr-Plugin benötigt für bestimmte Token-Verfahren wie WebAuthn und zur Reduzierung von API-Anfragen das Recht, für ''/validate/triggerchallenge'' auf Token-Typen einschränken zu können.

Hierfür wird eine neue Datei //idp-application-tokentype// erstellt, welche die Parameter der Policy als Python-Dictionary enthält. Der Inhalt sollte so aussehen:
<file python idp-application-tokentype>
{   'policy': [
      {
        'action': {
          'application_tokentype': True
        },
        'active': True,
        'name': 'idp-application-tokentype',
        'scope': 'authorization'
      }
   ]
}
</file>

Die Policy kann unter Nutzung dieser Datei erstellt werden:
<code>
edumfa-manage policy p_import -f idp-application-tokentype
</code>

=== Richtlinien für fudispasskeys ===
Für fudispasskeys werden zwei zusätzliche Richtlinien benötigt:

<file python webauthn-enrollment>
{   'policy': [
      {
        'action': {
          'webauthn_authenticator_attestation_form': 'none',
          'webauthn_authenticator_attestation_level': 'none',
          'webauthn_public_key_credential_algorithms': 'ecdsa '
                                                       'rsassa-pss '
                                                       'rsassa-pkcs1v1_5',
          'webauthn_relying_party_id': '<domain of your institution>',
          'webauthn_relying_party_name': '<name of your institution>',
          'webauthn_user_verification_requirement': 'required'
        },
        'active': True,
        'name': 'webauthn-enrollment',
        'scope': 'enrollment'
      }
   ]
}
</file>
Die Policy kann unter Nutzung dieser Datei erstellt werden:
<code>
edumfa-manage policy p_import -f webauthn-enrollment
</code>
''webauthn_authenticator_attestation_form'', ''webauthn_authenticator_attestation_level'' und ''webauthn_public_key_credential_algorithms'' müssen nicht per Richtlinie gesetzt werden. Die hier vorgeschlagenen Werte erhöhen aber die Kompatibilität mit verschiedenen WebAuthn fähigen Geräten.

<file python webauthn-authentication>
{   'policy': [
      {
        'action': {
          'webauthn_user_verification_requirement': 'required',
          'webauthn_usernameless_authn': True
        },
        'active': True,
        'name': 'webauthn-authentication',
        'scope': 'authentication'
      }
   ]
}
</file>
Die Policy kann unter Nutzung dieser Datei erstellt werden:
<code>
edumfa-manage policy p_import -f webauthn-authentication
</code>
\\

==== Notwendiges Event für WebAuthn ====
In Verbindung mit der zuvor genannten Policy //idp-application-tokentype// muss der Parameter ''webauthn_allowed_transports'' per Event gesetzt werden.

Hierfür wird eine neue Datei //idp-webauthn-allowed-transports// erstellt, welche die Parameter des Events als Python-Dictionary enthält. Der Inhalt sollte so aussehen:
<file python idp-webauthn-allowed-transports>
{   'event': [
      {
        'action': 'set',
        'active': True,
        'conditions': {
          'tokentype': 'webauthn'
        },
        'event': [
          'validate_triggerchallenge'
        ],
        'handlermodule': 'RequestMangler',
        'name': 'idp-webauthn-allowed-transports',
        'options': {
          'parameter': 'webauthn_allowed_transports',
          'value': 'usb ble nfc internal'
        },
        'position': 'pre'
      }
   ]
}
</file>

Das Event kann unter Nutzung dieser Datei erstellt werden:
<code>
edumfa-manage event e_import -f idp-webauthn-allowed-transports
</code>

**Achtung:** Wenn per Policy der Wert ''webauthn_allowed_transports'' angepasst wird, dann sollte auch passend dazu das Event angepasst werden.
\\
==== Weitere Konfigurationsempfehlung ====
Damit möglichst viele WebAuthn-Token funktionieren und auch Passkeys via QR-Code im Browser funktioniert, wird folgende weitere Richtlinie (Datei //webauthn-enrollment//) empfohlen:

<file python webauthn-enrollment>
{   'policy': [
      {
        'action': {
          'webauthn_authenticator_attestation_form': 'indirect',
          'webauthn_authenticator_attestation_level': 'none'
        },
        'active': True,
        'name': 'webauthn-enrollment',
        'scope': 'enrollment',
      }
   ]
}
</file>

Die Policy kann unter Nutzung der Datei (//webauthn-enrollment//) erstellt werden:
<code>
edumfa-manage policy p_import -f webauthn-enrollment
</code>

Die die für WebAuthn notwendigen Enrollment Parameter ''webauthn_relying_party_id'' und ''webauthn_relying_party_name'' können mit dieser oder einer separaten Richtlinie definiert werden. Allgemein gilt, dass die Domain des Identity Providers entweder identisch mit ''webauthn_relying_party_id'' oder eine Subdomain von ''webauthn_relying_party_id'' sein muss. (Es findet keine Vorabfilterung statt, ob die Domain des Identity Providers mit der ''webauthn_relying_party_id'' des WebAuthn-Token verträglich ist.)

==== Allgemeine Konfigurationsoptionen ====
Die zwei **fett** markierten Optionen sollten mindestens gesetzt werden.

^Option^Default-Wert^Beschreibung^
|**''fudiscr.edumfa.authorization_token''**|//leer//|Authorization-Token aus vorherigem Anleitungsschritt für die Zugriffssteuerung auf die eduMFA-API.| 
|**''fudiscr.edumfa.base_uri''**|''https://localhost''|Basis-URLs der eduMFA-API, z.B.// https://localhost //. Mehrere URLs können durch Leerzeichen getrennt angegeben werden.|
|''fudiscr.edumfa.connection_strategy''|''ACTIVE_PASSIVE''|Werden in ''fudiscr.edumfa.base_uri'' mehrere eduMFA-Server angegeben, so kann mit dieser Option festgelegt werden, wie die Anfragen verteilt werden. Bei ''ACTIVE_PASSIVE'' (default) werden die URLs immer beginnend mit der ersten URL in Reihenfolge angefragt bis ein Server erfolgreich antwortet. Bei ''ROUND_ROBIN'' werden die URLs als zyklische Liste verwendet und bei jeder Anfrage wird die nächste URL aus der Liste benutzt.|
|''fudiscr.edumfa.check_connection_certificate''|''true''|Falls das Serverzertifikat vom API-Endpunkt nicht geprüft werden soll, kann der Wert auf ''false'' gesetzt werden.|
|''fudiscr.edumfa.default_realm''|//leer//|Mit dieser Option kann festgelegt werden, ob ein Realm der API-Anfrage an eduMFA hinzugefügt wird, wenn in vorherigen Schritten kein Realm dem Nutzer zugeordnet ist. Der hier definierte Realm wird dem allgemeinen User-Objekt im fudiscr-Plugin nicht hinzugefügt!|
|''fudiscr.edumfa.preferred_parameter_name''|''fudis_preferred''|Wird mit dieser Option ein Name angegeben, so wird nach diesem Namen in den Token-Infos in eduMFA gesucht und versucht, den zugehörigen Wert als Boolean zu interpretieren. Sollte der Wert ''true'' ergeben, so wird der Token auf der eventuellen Auswahlseite der Token vorselektiert.|
|''fudiscr.edumfa.reduce_trigger_challenge_requests''|''false''|Wenn diese Option auf ''true'' gesetzt ist, dann wird kein// /validate/challenge //für die Token-Typen //motp//, //registration//, //spass//, //tan//, //totp//, //yubico//, //yubikey// in eduMFA angefordert, aber eine Pseudo-Transaktion wird erzeugt. Bei ''false'' werden nur Pseudo-Transaktionen für den Token-Typ //spass// erzeugt. Bei Pseudotransaktionen wird nur ein// /validate/check //mit der jeweiligen Seriennummer des einzelnen Tokens angefordert.|
|''fudiscr.edumfa.relying_party_id_parameter_name''|//leer//|Wird mit dieser Option ein Name angegeben, so wird bei jeder Anfrage gegen die eduMFA-API die entityID des Service Providers als Parameter mit diesem Namen übergeben.|
|''fudiscr.edumfa.replace_all_token_types_with_custom_map''|''false''|Wenn benutzerdefinierte Typen mit ''fudiscr.edumfa.CustomTokenTypesMap'' definiert werden, kann mit dieser Option festgelegt werden, ob die Standardtypen vollständig ersetzt (''true'') oder ergänzt (''false'') werden.|
|''fudiscr.edumfa.service_password''|//leer//|Passwort des Admin-Users; Alternative zu ''fudiscr.edumfa.authorization_token'' oder zur Absicherung, falls Authorization-Token abläuft.|
|''fudiscr.edumfa.service_realm''|//leer//|Realm des Admin-Users; Alternative zu ''fudiscr.edumfa.authorization_token'' oder zur Absicherung, falls Authorization-Token abläuft.|
|''fudiscr.edumfa.service_username''|//leer//|Username des Admin-Users; Alternative zu ''fudiscr.edumfa.authorization_token'' oder zur Absicherung, falls Authorization-Token abläuft.|
|''fudiscr.edumfa.singleton''|''true''|Gibt an, ob der vom fudiscr-Plugin verwendete //EduMfaChallengeResponseClient// nur einmal instanziiert wird. In manchen Anwendungsfällen kann es die Performance verbessern, wenn mehrere Instanzen zugelassen werden.|
|''fudiscr.edumfa.user_agent_ip_address_parameter_name''|//leer//|Wird mit dieser Option ein Name angegeben, so wird bei jeder Anfrage gegen die eduMFA-API die IP-Adresse des Users als Parameter mit diesem Namen übergeben.|
|''fudiscr.edumfa.with_additional_pin_response''|''false''|In eduMFA ist es möglich, neben dem one time password/code noch eine PIN zu verlangen. Wenn dieser Konfigurationsparameter auf ''true'' gesetzt ist, dann ergänzt das fudiscr-Plugin auf der Eingabeseite für die Response ein PIN-Feld. Nur für die Token-Typen //hotp//, //indexed_tan//, //registration_code//, //tan//, //totp// und //yubikey_otp// wird diese Funktionalität unterstützt.|

**Hinweis**: In Abhängigkeit von der Konfigurationsweise des Shibboleth Identity Providers empfiehlt es sich, Token und Passwörter wie in ''fudiscr.edumfa.authorization_token'' und ''fudiscr.edumfa.service_password'' in geschützte/unversionierte Dateien wie ''%{idp.home}/credentials/secrets.properties'' auszulagern.

===== Custom Token Types =====
Für den Sonderfall, dass in eduMFA eigene Token-Typen implementiert werden, gibt es die Möglichkeit, diese auch über das fudiscr-Plugin zur Verfügung zu stellen. Dies ist aber nur möglich, wenn dieser neue Token-Typ keine Challenge erzeugt, die an Nutzer*innen zurückgegeben werden muss und wenn nur ein einfaches one time password verlangt wird. Der Token muss sich in der Nutzer-Interaktion also vergleichbar zu TOTP verhalten.

In  ''%{idp.home}/conf/global.xml'' kann hierfür die Bean ''fudiscr.edumfa.CustomTokenTypesMap'' definiert werden:
<file xml>
<util:map id="fudiscr.edumfa.CustomTokenTypesMap" map-class="java.util.HashMap" key-type="java.lang.String" value-type="java.lang.String">
   <entry key="custom_token_type_name_in_edumfa" value="custom_token_type_name_in_fudiscr"/>
</util:map>
</file>
Die Map ''fudiscr.edumfa.CustomTokenTypesMap'' kann auch dafür verwendet werden, das Mapping der Token-Typen auf die Bezeichnung in fudiscr anzupassen. Erlaubt sind nur 1:1-Beziehungen.

Ergänzend entscheidet die Option ''fudiscr.edumfa.replace_all_token_types_with_custom_map''  darüber, ob die Mappings aus ''fudiscr.edumfa.CustomTokenTypesMap'' das Standardmapping ergänzen (''false'' //default//) oder vollständig ersetzen (''true'').