Versions Compared

Old Version 4

changes.mady.by.user SGO

Saved on

compared with

New Version 5

changes.mady.by.user SGO

Saved on

Key

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

...

German


Panel


Section


Column
width60%


Section


Column
width100%

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!





Column
width40%


Panel
bgColor#ECECEC

<< Technische Dokumentation

Panel
title





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.

Panel




title

Client-seitige Konfiguration


Section


Column
width40%

Image Modified


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%

Image Modified


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.

Panel




title

Einrichten der Azure AD Authentication


Section


Column
width40%

Image Modified


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%


Image Modified



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. 

Paneltitle




Verschlüsselung des Client Secrets


Section


Column
width40%


Image Modified



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%


Image Modified



Column
width60%

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

panel

title




Test der oAuth Verbindung


Section


Column
width40%


Image Modified



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%

Image Modified


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. 

PanelborderColor#666666bgColor#ECECECborderWidth2





Section


Column
width33%

<< Zurück zu - Encryption (Client/Server) --


Column
width34%

Zurück zur Übersicht - SmartNotes --


Column
width33%

Weiter mit -- SmartNotes Hosting bei AMANA >>





English


panel
Panel


Section


Column
width60%


Section


Column
width100%

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 the next SmartNotes version (>2.9.0.225)!





Column
width40%


Panel
bgColor#ECECEC

<< Technical Documentation

title





Server side configuration


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%

Stop the server and open the SmartNotesService.config file in an editor.

Go to the appSettings section and set the adjoining settings.

Panel




title

Client side configuration


Section


Column
width40%

Image Modified


Column
width60%

Exit the SmartNotes client, go to the installation folder and open the SmartNotes.config file in the editor.
Uncomment the section "AuthenticationSettings" by removing the characters "<!--"  (at the beginning of the line) and "-->" (at the end of the line).



Section


Column
width40%

Image Modified


Column
width60%

Also uncomment the "AuthenticationSettings" and set the following settings:

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




Section


Column
width40%

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

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


Column
width60%

Now go to the "AppSettings" section and change the two settings opposite or enter them if they do not yet exist.

Panel




title

Setting up Azure AD Authentication


Section


Column
width40%

Image Modified


Column
width60%

Server-side configuration

Setting up authentication via Azure AD is simplified and does not require entering metadata, redirect URI and the like, as it is already hardcoded. 

Please open the SmartNotesServer.exe.config in the SmartNotesServer installation directory. 

Please remove the <!-- and → in the AzureActiveDirectoryConnectionSettings section.



Section


Column
width40%

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

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


Column
width60%

Please add these entries in the AppSettings section. 



Section


Column
width40%


Image Modified



Column
width60%

In the AzureActiveDirectoryEntries section, you must then maintain the ClientId and TenantId.



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%

Client-side configuration

Please add these entries in the AppSettings section. 

Paneltitle




Encryption of the Client Secret


Section


Column
width40%


Image Modified



Column
width60%

For some oAuth services it may be necessary to enter a client secret. SmartNotes provides a method for encryption.

Open command line (cmd) and navigate to the SmartNotes server directory (by default: C:\Program Files (x86)\Amana Consulting\SmartNotesServer) and run SmartNotes.PasswordEncryptor.exe with the parameter set -p:[yourClientSecret] and your Client Secret.



Section


Column
width40%


Image Modified



Column
width60%

You will now receive the encrypted Client Secret, which you can enter in the Config. 

panel

title




Testing the oAuth Connection


Section


Column
width40%


Image Modified



Column
width60%

The SmartNotes Client offers the possibility to test the connection data to oAuth before using it productively.

You may bypass errors in the configuration with a previous test. To do this, simply start the Amana.SmartNotes.AuthenticationApp.exe



Section


Column
width40%

Image Modified


Column
width60%

Please enter your oAuth data here. Please note that all fields or only some of them may be required.

Use the dropdown on the left to choose between oAuth and Azure Authentication. 

The screenshot shows an example of an authentication via Google oAuth. 

PanelborderColor#666666bgColor#ECECECborderWidth2





Section


Column
width33%

<< Back to - Client Server SSL Encryption --


Column
width34%

Back to overview - SmartNotes --


Column
width33%

Continue with -- SmartNotes Hosting at AMANA >>