Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


German

So konfigurieren Sie die OAuth-Authentifizierung in SmartNotes.

Wie bei allen anderen Benutzertypen in SmartNotes: nativ oder ActiveDirectory;

OAuth- oder Azure AD-Benutzer müssen in SmartNotes existieren, um sich anmelden zu können und müssen mit SSO gekennzeichnet sein.

ActiveDirectory-Benutzer können mit dem AD-Connector importiert werden, der Rest muss manuell erstellt werden.

Info

Die OAuth-Authentifizierung ist erst ab der SmartNotes-Version 2.9.0.225 möglich!

English

How to configure OAuth authentication in SmartNotes

As with all other user types in SmartNotes: native or ActiveDirectory;

OAuth Azure AD users must exist in SmartNotes to be able to log in and must be marked with SSO.

ActiveDirectory users can be imported with the AD connector, the rest must be created manuall

Info

OAuth authentication is only possible from SmartNotes version 2.9.0.225!

German


Serverseitige Konfiguration


Section


Column
width40%

<add key="ClientId" value="Needed Value" />

<add key="ProviderMetadata" value="Needed Value" />

<add key="SingleSignOnMethod" value="OAuth" />

<add key="DisableSingleSignOn" value="false" />


Column
width60%

Stoppen Sie den Server und öffnen Sie die Datei SmartNotesService.config in einem Editor.

Gehen Sie zum Abschnitt appSettings und legen Sie die nebenstehenden Einstellungen fest.




Client-seitige Konfiguration


Section


Column
width40%


Column
width60%

Beenden Sie den SmartNotes-Client, wechseln Sie in den Installationsordner und öffnen Sie die Datei SmartNotes.config im Editor.
Entkommentieren Sie die Section „AuthenticationSettings" indem Sie die Zeichen „<!--"  (am Anfang der Zeile) und „-->" (am Ende der Zeile) entfernen.



Section


Column
width40%


Column
width60%

Entkommentieren Sie ebenfalls die „AuthenticationSettings" und legen die folgenden Einstellungen fest:

  • ClientId
  • AuthorizationEndpoint
  • ClientSecret
  • TokenEndpoint
  • UseDefaultBrowser=“True“
  • ProviderMetadata




Section


Column
width40%

<add key="useSingleSignOn" value="True" />

<add key="SingleSignOnMethod" value="OAuth" />


Column
width60%

Gehen Sie nun zum Abschnitt „AppSettings" und ändern Sie die nebenstehende zwei Einstellungen bzw. tragen diese ein, falls noch nicht vorhanden.




Einrichten der Azure AD Authentication


Section


Column
width40%


Column
width60%

Serverseitige Konfiguration

Die Einrichtung der Authentication über Azure AD ist vereinfacht und erfordert nicht die Eingabe von Metadata, Redirect URI und ähnlichem, da diese bereits fest in der Programmierung vorhanden ist. 

Öffnen Sie bitte die SmartNotesServer.exe.config im SmartNotesServer-Installationsverzeichnis. 

Bitte entfernen Sie die <!-- und → im Bereich AzureActiveDirectoryConnectionSettings.



Section


Column
width40%

<add key="SingleSignOnMethod" value="Azure" />

<add key="DisableSingleSignOn" value="false" />


Column
width60%

Fügen Sie bitte diese Einträge im Bereich AppSettings hinzu. 



Section


Column
width40%




Column
width60%

Im Abschitt AzureActiveDirectoryEntries müssen Sie dann noch die Client- und TenantId pflegen. 



Section


Column
width40%

<add key="ClientId" value="Needed Value" />

<add key="TenantId" value="Needed Value" />

<add key="SingleSignOnMethod" value="Azure" />

<add key="UseSingleSignOn" value="false" />


Column
width60%

Clientseitige Einrichtung

Fügen Sie bitte diese Einträge im Bereich AppSettings hinzu. 




Verschlüsselung des Client Secrets


Section


Column
width40%




Column
width60%

Bei manchen oAuth Diensten kann es notwendig sein, einen Client Secret einzugeben. SmartNotes bietet für die Verschlüsselung eine Methode an.

Öffnen Sie Kommandozeile (cmd) und navigieren Sie in das SmartNotes Serverzeichnis (im Standard: C:\Program Files (x86)\Amana Consulting\SmartNotesServer) und führen Sie SmartNotes.PasswordEncryptor.exe mit dem Parameterset -p:[IhrClientSecret] und Ihrem Client Secret aus.



Section


Column
width40%




Column
width60%

Sie erhalten nun das verschlüsselte Client Secret, welches Sie in der Config eintragen können. 




Test der oAuth Verbindung


Section


Column
width40%




Column
width60%

Der SmartNotes Client bietet die Möglichkeit, die Verbindungsdaten zu oAuth zu testen, bevor diese produktiv verwendet werden.

Sie umgehen mit einem vorherigen Test möglicherweise Fehler in der Konfiguration. Starten Sie dazu bitte einfach die Amana.SmartNotes.AuthenticationApp.exe



Section


Column
width40%


Column
width60%

Geben Sie bitte hier Ihre oAuth Daten ein. Beachten Sie bitte, dass unter Umständen alle Felder oder nur einzelne benötigt werden.

Über das Dropdown auf der linken Seite können Sie zwischen oAuth und Azure Authentication auswählen. 

Im Screenshot sehen Sie beispielhaft eine Authentication über Google oAuth.