OBS/CloudConnect/oAuth2

Aus OBS Wiki
Zur Navigation springen Zur Suche springen
HINWEIS: Bitte beachten sie dass für den Betrieb der Schnittstelle der Cloud-Dienst in OBS aktiviert sein muss.


Allgemein

OAuth 2.0 (Open Authorization) ist der Name eines offenen Protokolls, das eine standardisierte, sichere API-Autorisierung für Desktop-, Web- und Mobile-Anwendungen erlaubt. Ein Endbenutzer kann mit Hilfe dieses Protokolls einer Anwendung den Zugriff auf seine Daten erlauben (z.B.: E-Mails), die von einem anderen Dienst (z.B.: Office365) bereitgestellt werden, ohne geheime Details seiner Zugangsberechtigung (Authentifizierung) der Anwendung preiszugeben.

Voraussetzungen

Für das aktivieren der Authentifizierung muss die jeweilige API des Providers (z.B.: Microsoft oder Google) aktiviert werden. Zusätzlich muss für OBS eine Anwendungs-ID und eine Geheime-ID generiert werden. Auch kann es nötig sein weitere Einstellungen für die API zu aktivieren (z.B.: Authentifiziertes SMTP bei Exchange)

Im Folgenden ist dies für Google und Microsoft beschrieben.

Microsoft konfigurieren

OAuth AppID.png

App-Registrierungen

htpps://localhost:2132/ steht erst mit der Version vom 19.10.2022 zur Verfügung.

    • Microsoft AppUri.png
  • Die Anwendungs-ID-URI muss festgelegt werden. Standard Wert kann beibehalten werden.
    • Microsoft IDURI.png

API-Berechtigungen

es sind keine speziellen Berechtigungen nötig. Folgende Berechtigung sollte automatisch angelegt werden

  • Microsoft Graph (1)
    • User.Read

Zertifikate & Geheimnisse

OAuth AppID geheim.png

Über einen Klick auf "+ Neuen geheimen Clientschlüssel" erhalten Sie ein können Sie einen neuen Schlüssel mit Namen und Gültigkeit definieren.

Mit der daraus erhaltenen "Geheimen ID" (App Secret ID) und der Anwendungs-ID (App ID) können Sie die Einrichtung in OBS vornehmen.

Einrichtung OBS

ACHTUNG: Für jeden Zugang (z.B.: E-Mail-Konto) muss eine eigene oAuth2 Authentifizierung freigeschaltet werden (Cloud-Connect). Dabei kann der API-Key aber mehrfach verwendet werden, wenn die Zugänge über ein Hauptkonto verwaltet werden (Bei Microsoft ist dies über ein Organisationskonto geregelt)
ACHTUNG: Ein Cloud-Connect bei dem Sie sich mit Info@test.de angemeldet haben, können Sie nicht für das E-Mail-Konto für obs@test.de nutzen!

Beispiel zur Einrichtung eines Microsoft E-Mail-Kontos

  1. API-Key aktivieren und ID bekommen
  2. Eintrag hinzufügen
    1. Dabei wählen Sie bei Cloud Typ den entsprechenden oAuth2 Typen aus. Weitere Infos im Abschnitt Definitionen
    2. OAuth2 Cloud Edit.png
  3. Authentifizieren und Zugangstoken erhalten
    1. Beim speichern der Daten werden die Daten geprüft und Ihr Standard Browser öffnet sich. Hier werden Sie aufgefordert sich anzumelden und den oAuth2-Zugang zu genehmigen.
    2. Nachträglich kann dies in der Eingabemaske mit F10 gemacht werden.
    3. OAuth Idle.png
    4. OAuth AppLogin.png
  4. Nun können Sie den Zugang in E-Mail-Konto hinterlegen
    1. OAuth mail.png

Definitionen

Bei der Einrichtung von oAuth2 sind bestimmte Daten notwendig, damit der korrekte Authentifikations-Dienst der jeweiligen Organisation (Google, Microsoft) angesprochen werden kann.

Diese sind über F10 erreichbar.

HINWEIS: Hier sind auch andere Cloud-Typen zu finden. Die oAuth2 Typen sind vom Typ ctOAuth2

Dazu zählen folgende Daten, welche im Netz zu finden sind:

  • Authorisations Endpunkt
  • Token Endpoint
  • Scope und weitere Daten

OAuth Def.png

Diese werden von seitens OBS bereit gestellt. Sollte mal ein Anbieter nicht verfügbar sein, können Sie diese Daten manuell nach erfassen und nutzen.

ACHTUNG: die von OBS erstellten Einträge werden beim Update mit unseren Standard Werten überschrieben. Bitte bei Änderungen neue Einträge erstellen.
Abgerufen von „http:///index.php?title=OBS/CloudConnect/oAuth2&oldid=61470“