Versions Compared

Key

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

App Registrierung im Azure AD

Da die Integration verschiedener SSO-Funktionalitäten mit steigenden Sicherheitsanforderungen immer relevanter wird möchten wir Ihnen die Integration der Azure AD Integration vollständig zeigen. Beachten Sie bitte, dass die Azure AD Integration erst ab Version 2.9.0.225 möglich ist.


Section


Column
width40%


Column
width60%

Wählen Sie dazu innerhalb Ihrer Azure AD Registrierung den Punkt „App Registrierung“ und legen Sie eine neue Registrierung an.



Section


Column
width40%


Column
width60%

Im nächsten Schritt wird die App selbst registriert. Im Standardfall können Sie die App wie folgt registrieren. Wählen Sie bitte einen eindeutigen Namen und wählen Sie „Nur Konten in diesem Organisationsverzeichnis“. Somit haben Sie eine App registriert und Sie werden in das Untermenü dieser App weitergeleitet.



Section


Column
width40%


Column
width60%

Sie werden direkt in den Punk Authentifizierung geleitet. Falls Sie unter einen anderen Punkt geleitet wurden, wählen Sie bitte Authentifizierung aus. Hier fügen Sie bitte eine Plattform hinzu und wählen in der Spalte Rechts eine „Mobilgerät- und Desktopanwendung“



Section


Column
width40%


Column
width60%

Azure AD bietet eine Reihe von Standard-Redirect URIs, wählen Sie im nächsten Schritt https://login.microsoftonline.com/common/oauth2/nativeclient aus.



Section


Column
width40%


Column
width60%

Sie haben nun die Azure AD Registrierung erstellt. 

Wählen Sie nun bitte den Punkt Übersicht. Hier sehen Sie nun die notwendige Client- und Tenant ID. Diese ist für die weitere Konfiguration wichtig.

Sie können die App natürlich weiter konfigurieren. Unter dem Punkt „Rollen und Administration“ können Sie die User oder ganze Gruppen hinzufügen.






Optional: Administratorzustimmung erteilen


Section


Column
width40%


Column
width60%

Je nach Konfiguration der Azure AD kann es notwendig sein, eine Administratorzustimmung zu erteilen. Klicken Sie hierzu auf den Punkt „API Berechtigungen“ und wählen Sie dann „Administratorzustimmung für Standardverzeichnisse erteilen“.




Konfiguration der Azure AD in SmartNotes


Section


Column
width40%


Column
width60%

Konfiguration des SmartNotes Servers

Die kopierte Client- und Tenant ID müssen Sie nun in die Konfigurationsdateien des Servers und des Clients einfügen. Die Serverconfig finden Sie in Ihrem Server-Verzeichnis (im Standard C:\Program Files (x86)\Amana Consulting\SmartNotesServer).

Suchen Sie hier den Bereich Appsettings und fügen Sie dort die Client- und Tenant ID ein. Beachten Sie bitte, dass zusätzlich noch die Einträge für SingleSignOnMethod und disableSingleSignOn gesetzt werde müssen (Azure und False) damit die Konfiguration funktioniert.

<add key="TenantId" value="Ihre-Tenant-ID" />

 <add key="ClientId" value="Ihre-Client-ID" />

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

<add key="disableSingleSignOn" value="False" />


Starten Sie anschließend den SmartNotes Server neu.



Section


Column
width40%


Column
width60%

Konfiguration des SmartNotes Clients

Die Config-Datei für den Client finden Sie in Ihrem Client-Verzeichnis (C:\Program Files (x86)\Amana Consulting\SmartNotesClient).

Suchen Sie auch hier den Eintrag Appsettings und fügen Sie dort die folgenden Zeilen hinzu:

<add key="TenantId" value="Ihre-Tenant-ID" />

 <add key="ClientId" value="Ihre-Client-ID" />

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

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




Anlage der SmartNotes User


Section


Column
width40%


Column
width60%

Für den sauberen Abgleich zu SmartNotes sind zu der Anlage der Azure AD App Registrierung auch User innerhalb von SmartNotes notwendig. Öffnen Sie dazu bitte die Berechtigungsverwaltung und legen Sie dort einen neuen Benutzer an.



Section


Column
width40%


Column
width60%

Mit der Konfiguration als SSO Benutzer erhalten Sie dann beim Start die Azure AD Anmeldemaske. Wichtig ist, dass die Benutzer analog zu Ihrer Anmeldung im Azure AD angelegt werden.



Verknüpfen von Azure AD/Entra ID Gruppen zu SmartNotes

Sie haben auch die Möglichkeit, die Azure AD vollständig anzubinden. Dabei werden die User bei Änderungen automatisch in bestimmten Intervallen aus dem AD geladen. Im Standard passiert dies einmal täglich.

Um diese Anbindung einzurichten, sind zusätzlich Anpassungen in der Serverconfig erforderlich:

Öffnen Sei bitte die SmartNotesServerService.exe.config und kommentieren Sie die folgenden Zeilen ein:

image-20240429-135835.pngImage Added

image-20240429-135842.pngImage Added

Fügen Sie an dieser Stelle bitte Ihre Client- und Tenant-ID ein, sowie das Secret ein. Dadurch wird der Server technisch für die Anbindung der Azure AD vorbereitet.

image-20240429-135954.pngImage Added

Fügen Sie im Bereich AppSettings in der Serverconfig nun bitte noch den Eintrag <add key="UserProvider" value="Azure" /> hinzu.

image-20240430-074202.pngImage Added

Außerdem muss ein Secret angegeben werden, welches zuvor verschlüsselt werden muss. Ö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.

image-2022-10-20_13-59-37 (1)-20240430-061918.pngImage Added

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

image-2022-10-20_14-0-48-20240430-073956.pngImage Added

In der Clientconfig werden Client- und Tenant-ID wie in der Dokumentation angegeben hinerlegt.

Im letzten Schritt muss in den SmartNotes Systemeinstellungen der Eintrag enableActiveDirectoryAuthentication hinzugefügt werden. Öffnen Sie dazu SmartNotes, und navigieren Sie zu Dokument-> Einstellungen->Grundlegende Einstellungen->Systemeinstellungen öffnen. Hier finden Sie die datenbankseitigen Systemeinstellungen. Scrollen Sie in der Übersicht nach unten und fügen Sie den Eintrag enableActiveDirectoryAuthentication hinzu. Setzen Sie den Wert dazu auf 1 und drücken Sie enter. Anschließend können Sie die Übersicht schließen und in den Einstellungen speichern. Es ist ein Neustart des SmartNotes Servers erforderlich.

image-20240430-094639.pngImage Added

Sie können nun in der Gruppen und Rollenverwaltung mit einem Klick auf den Button “Von ActiveDirectory” eine SmartNotes Gruppe an eine Azure AD Gruppe anbinden.

image-20240430-094804.pngImage Added


English

App registration in Azure AD

Since the integration of various SSO functionalities is becoming more and more relevant with increasing security requirements, we would like to show you the Azure AD integration in full. Please note that Azure AD integration is only possible from version 2.9.0.225.


Section


Column
width40%


Column
width60%

To do this, select the "App Registration" item within your Azure AD registration and create a new registration.



Section


Column
width40%


Column
width60%

The next step is to register the app itself. In the default case, you can register the app as follows. Please choose a unique name and select "Accounts in this organizational directory only". Thus you have registered an app and you will be redirected to the submenu of this app.



Section


Column
width40%


Column
width60%

You will be taken directly to the Authentication point. If you were directed to another point, please select Authentication. Here please add a platform and select a "Mobile device and desktop application" in the column on the right.



Section


Column
width40%


Column
width60%

Azure AD provides a set of default redirect URIs, select https://login.microsoftonline.com/common/oauth2/nativeclient in the next step.



Section


Column
width40%


Column
width60%

You have now created the Azure AD registration, please select the Overview item. Here you will now see the necessary client and tenant ID. This is important for the further configuration. Of course, you can continue configuring the app. Under the item "Roles and Administration" you can add users or entire groups.





Optional: Grant administrator consent


Section


Column
width40%


Column
width60%

Depending on the configuration of Azure AD, it may be necessary to grant administrator consent. To do this, click on the "API permissions" item and then select "Grant administrator consent for default directories".



Konfiguration der Azure AD in SmartNotes


Section


Column
width40%


Column
width60%

SmartNotes Server configuration

You must now paste the copied client and tenant ID into the server and client configuration files. You can find the serverconfig in your server directory (in the standard C:\Program Files (x86)\Amana Consulting\SmartNotesServer).

Find the Appsettings section here and add the client and tenant ID there. Please note that the entries for SingleSignOnMethod and disableSingleSignOn must also be set (Azure and False) for the configuration to work.

<add key="TenantId" value="Your-Tenant-ID" />

 <add key="ClientId" value="Your-Client-ID" />

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

<add key="disableSingleSignOn" value="False" />


After that, restart the SmartNotes server.



Section


Column
width40%


Column
width60%

SmartNotes Client Configuration

The config file for the client can be found in your client directory (C:\Program Files (x86)\Amana Consulting\SmartNotesClient).

Again, find the Appsettings entry and add the following lines there:

<add key="TenantId" value="Your-Tenant-ID" />

 <add key="ClientId" value="Your-Client-ID" />

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

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



Anlage der SmartNotes User


Section


Column
width40%


Column
width60%

For a clean synchronization with SmartNotes, users within SmartNotes are required in addition to the Azure AD app registration. To do this, please open the authorization management and create a new user there.



Section


Column
width40%


Column
width60%

With the configuration as SSO user, you will then get the Azure AD login screen at startup. It is important that the users are created analogously to your logon in Azure AD.



Linking Azure AD/Entra ID groups to SmartNotes

You also have the option of fully connecting the Azure AD. In this case, the users are automatically loaded from the AD at certain intervals when changes are made. By default, this happens once a day.

To set up this connection, additional adjustments are required in the server config:

Please open the SmartNotesServerService.exe.config and comment in the following lines:

image-20240429-135835.pngImage Addedimage-20240429-135842.pngImage Added

At this point, please enter your client and tenant ID and the secret. This will technically prepare the server for the Azure AD connection.

image-20240429-135954.pngImage Added

Now add the entry <add key=“UserProvider” value=“Azure” /> to the AppSettings area in the server config.

image-20240430-074202.pngImage Added

In addition, a secret must be specified, which must be encrypted beforehand. Open the command line (cmd) and navigate to the SmartNotes server directory (by default: C:\Program Files (x86)\Amana Consulting\SmartNotesServer) and execute SmartNotes.PasswordEncryptor.exe with the parameter set -p:[yourClientSecret] and your client secret.

image-2022-10-20_13-59-37 (1)-20240430-061918.pngImage Added

You will now receive the encrypted client secret, which you can enter in the Config.

image-2022-10-20_14-0-48-20240430-073956.pngImage Added

The client and tenant IDs are added to the client config as specified in the documentation above.

In the last step, the entry enableActiveDirectoryAuthentication must be added to the SmartNotes system settings. To do this, open SmartNotes and navigate to Document-> Settings->Basic Settings->Open System Settings. Here you will find the system settings on the database side. Scroll down in the overview and add the entry enableActiveDirectoryAuthentication. Set the value to 1 and press enter. You can then close the overview and save the settings. A restart of the SmartNotes server is required.

image-20240430-094639.pngImage Added

You can now connect a SmartNotes group to an Azure AD group in the groups and roles administration by clicking on the “From ActiveDirectory” button.

image-20240430-094804.pngImage Added