Versions Compared

Key

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


German


Serverseitige Einrichtung

Die Kommunikation zwischen Client und Server ist grundsätzlich symmetrisch verschlüsselt. Die meisten unserer Kunden betreiben SmartNotes "on premise" im eigenen Firmennetzwerk. Für dieses Szenario ist diese Art der Verschlüsselung ausreichend.

Als weitere Möglichkeit für Kunden mit einem SmartNotes Server außerhalb des eigenen Firmennetzwerks haben wir nun die Verschlüsselung per SSL implement.

Für die Kommunikation wird ein Keypaar zwischen dem SmartNotes Server und dem SmartNotes Client ausgetauscht. 


Section


Column
width40%


Column
width60%

Für die Erstellung des Zertifikats auf dem SmartNotes Server starten Sie zunächst die Microsoft Management Console (Ausführen -> mmc).

Im nun geöffneten Fenster öffnen Sie den Reiter „Datei und klicken auf „Snap-In hinzufügen/entfernen“.



Section


Column
width40%


Column
width60%

Wählen Sie hier den Punkt „Zertifikate" aus und fügen diesen über den mittleren Button hinzu.



Section


Column
width40%


Column
width60%

Nun wählen Sie das Computerkonto aus und schließen im nächsten Schritt die Einrichtung des Zertifikates ab.



Section


Column
width40%


Column
width60%

Nun sehen Sie in der Baumstruktur links den neuen Punkt „Eigene Zertifikate“. Klicken Sie mit einem rechten Mausklick auf diesen Menüpunkt und wählen Sie „Neues Zertifikat anfordern“. 



Section


Column
width40%


Column
width60%

Fahren Sie nun mit der Erstellung des Zertifikats fort, bis Sie die Registrierungsrichtlinie erhalten. Wählen Sie nun den Punkt „Computer“ aus, klappen diesen über „Details" auf und öffnen die Eigenschaften.



Section


Column
width40%


Column
width60%

Unter dem Punkt „Privater Schlüssel“ muss das Häkchen bei „Privaten Schlüssel exportierbar machen“ gesetzt werden. Danach kann die Änderung übernommen und der Schlüssel registriert werden. 



Section


Column
width40%


Column
width60%

Das neu erstellte Zertifikat sollten Sie nun in der Übersicht sehen können. Da SmartNotes einen eindeutigen Namen des Zertifikats verlangt, können sie zusätzlich einen Alias vergeben. Dieser Schritt ist optional und muss nur ausgeführt werden, falls mehrere Zertifikate mit demselben Namen existieren. Den Alias können Sie mit einem Rechtsklick auf das Zertifikat unter den Eigenschaften hinterlegen.



Section


Column
width40%


Column
width60%

Nun kann das Zertifikat exportiert werden. Dieses Zertifikat muss in den nächsten Schritten auf den einzelnen Clients hinterlegt werden.



Section


Column
width40%


Column
width60%

Damit das Zertifikat auf den Clients hinterlegt werden kann, muss das Exportieren des privaten Schlüssels aktiviert werden. Das Zertifikat sollte im nächsten Schritt als PKCS #12 (.PFX) erstellt werden. 



Section


Column
width40%


Column
width60%

Das Exportieren des Zertifikats erfordert die Eingabe eines Passworts. Das Server-Zertifikat muss im Nachgang auf allen Clients eingespielt werden, die eine Verbindung zum SmartNotes Server erhalten sollen.




Clientseitige Einrichtung


Section


Column
width40%


Column
width60%

Im nächsten Schritt muss noch ein Zertifikat auf der Clientseite erstellt werden. Die Schritte verlaufen ähnlich zur Zertifikatserstellung auf dem Server. Für die Erstellung des Zertifikats auf dem SmartNotes Server starten Sie bitte die Microsoft Management Console (Ausführen -> mmc). 

Im nun geöffneten Fenster öffnen Sie bitte den Reiter Datei und klicken auf „Snap-In hinzufügen/entfernen“. 

Es genügt dabei, das Zertifikat auf einem Client zu erstellen und im Nachgang auf allen Servern zu hinterlegen.



Section


Column
width40%


Column
width60%

Wählen Sie hier bitte den Punkt Zertifikate aus und fügen diesen über den mittigen Button hinzu. 



Section


Column
width40%


Column
width60%

Nun wählen Sie bitte das Eigene Benutzerkonto aus und schließen im nächsten Schritt die Einrichtung des Zertifikates auf.



Section


Column
width40%


Column
width60%

Nun sehen Sie in der Baumstruktur links den neuen Punkt „Eigene Zertifikate“. Klicken Sie Rechts auf diesen Menüpunkt und wählen Sie „Neues Zertifikat anfordern“. 



Section


Column
width40%


Column
width60%

Fahren Sie nun mit der Erstellung des Zertifikats fort, bis Sie die Registrierungsrichtlinie erhalten. Wählen Sie nun den Punkt „Benutzer“ aus, klappen diesen auf und öffnen die Eigenschaften.



Section


Column
width40%


Column
width60%

Unter dem Punkt „Privater Schlüssel“ muss das Häkchen bei „Privaten Schlüssel exportierbar machen“ gesetzt werden. Danach kann die Änderung übernommen und der Schlüssel registriert werden. 



Section


Column
width40%


Das neu erstellte Zertifikat sollten Sie nun in der Übersicht sehen können. Da SmartNotes einen eindeutigen Namen des Zertifikats verlangt, können sie zusätzlich einen Alias vergeben. Dieser Schritt ist optional und muss nur ausgeführt werden, falls mehrere Zertifikate mit dem selben Namen existieren. Den Alias können Sie mit einem Rechtsklick auf das Zertifikat unter den Eigenschaften hinterlegen.


Section


Column
width40%


Column
width60%

Nun kann das Zertifikat exportiert werden. Dieses Zertifikat muss auf den einzelnen Clients hinterlegt werden.



Section


Column
width40%


Column
width60%

Damit das Zertifikat auf den Clients hinterlegt werden kann, muss das Exportieren des privaten Schlüssels aktiviert werden. Das Zertifikat sollte im nächsten Schritt als PKCS #12 (.PFX) erstellt werden. 



Section


Column
width40%


Column
width60%

Das Exportieren des Zertifikats erfordert die Eingabe eines Passworts. Das Client-Zertifikat muss im Nachgang auf dem SmartNotesServer, sowie allen Clients eingespielt werden, die eine Verbindung zum SmartNotes Server erhalten sollen.




Konfiguration des Servers


Section


Column
width40%


Column
width60%

Bitte hinterlegen Sie das exportierte Client-Zertifikat nun auf Ihrem Server. Dazu muss dieses einfach über Doppelklick geöffnet werden. Wählen Sie für den Import den Lokalen Computer aus.

Sollten Sie mehrere Client-Zertifikate erstellt haben, müssen Sie diese ebenfalls auf dem Server hinterlegen. 



Section


Column
width40%


Column
width60%

Klicken Sie durch die Installation und geben Sie im folgenden Prozess das Kennwort ein. Den Zertifikatsspeicher im letzten Punkt können Sie auf automatisch belassen.



Section


Column
width40%


Column
width60%

Nun müssen Sie im letzten Schritt noch die Konfiguration des Servers anpassen. Hierzu stehen Ihnen verschiedene Parameter zur Verfügung. Die Anpassungen müssen in der Server-Konfigurationsdatei vorgenommen werden. Im Standard ist der Server unter C:\Program Files (x86)\Amana Consulting\SmartNotesServer installiert. Stoppen Sie vor Anpassung der Konfigurationsdatei bitte den Server.



Section


Column
width40%


Column
width60%

Im Bereich <appSettings>…</appSettings> in dieser Datei müssen Sie nun die folgenden Parameter pflegen.

  • <add key="UseSslForEncryption" value="true" /> - Dieser Wert muss auf true gesetzt werden, um die Verschlüsselung einzuschalten.

    Note

    Sobald dieser Wert auf True gesetzt wurde, ist der Zugriff nur noch über Zertifikate gestattet. Sollten Sie die Zertifikate nicht richtig hinterlegt oder installiert haben, ist der Zugriff nicht möglich.


  • <add key="SslServerAuthenticationX509CertificateSubjectName" value="SmartNotesServer" /> - Dieser Wert beinhaltet den Subject Name des hinterlegten Server-Zertifikats. Den Namen finden Sie in Ihrem Zertifikatsspeicher im Reiter „Ausgestellt für“
  • <add key="SslClientAuthenticationX509CertificateSubjectName" value="SmartNotesClient" /> - Dieser Wert beinhaltet den Subject Name des hinterlegten Client-Zertifikats. Den Namen finden Sie in Ihrem Zertifikatsspeicher im Reiter „Ausgestellt für“
  • <add key="SslServerAuthenticationX509CertificateFriendlyName" value="xyz" /> - Sofern ein Anzeigename für das Server-Zertifikat angelegt wurde, muss dieser über diesen Parameter angegeben werden.
  • <add key="SslClientAuthenticationX509CertificateFriendlyName" value="xyz" /> - Sofern ein Anzeigename für das Client-Zertifikat angelegt wurde, muss dieser über diesen Parameter angegeben werden.
  • <add key="X509CertificateStoreLocation" value="LocalMachine" /> - Über diesen Eintrag kann der Speicherort der Zertifikate geändert werden. Sofern die Zertifikate im Computerkonto gespeichert wurden, können Sie diesen Eintrag auslassen. Nur bei einer Speicherung im Benutzerkonto muss dieser Eintrag auf CurrentUser gesetzt werden. 



Section


Column
width40%



Column
width60%

Nach der Hinterlegung der Parameter können Sie den Serverdienst wieder neu starten. Die Verschlüsselung über den Server ist nun aktiviert. 

Note

Beachten Sie bitte, dass nach der Aktivierung der SSL-Verschlüsselung der Server nur erreichbar ist, wenn diese client- und serverseitig hinterlegt sind. Sofern die Konfiguration nicht auf beiden Seiten korrekt angelegt ist, kann die Verbindung eventuell gestört sein. 





Konfiguration des Clients


Section


Column
width40%


Column
width60%

Bitte hinterlegen Sie das exportierte Server-Zertifikat nun auf Ihrem Client. Dieser Schritt muss für alle Clients wiederholt werden, die Zugriff auf den Server erhalten sollen.

Dazu muss dieses einfach über Doppelklick geöffnet werden. Wählen Sie für den Import den aktuellen Benutzer aus. 



Section


Column
width40%


Column
width60%

Klicken Sie durch die Installation und geben Sie im folgenden Prozess das Kennwort ein. Den Zertifikatsspeicher im letzten Punkt können Sie auf automatisch belassen.



Section


Column
width40%


Column
width60%

Nun müssen Sie im letzten Schritt noch die Konfiguration des Clients anpassen. Hierzu stehen Ihnen verschiedene Parameter zur Verfügung. 

Note

Beachten Sie bitte, dass die Anpassung der Client-Konfigurationsdatei auf jedem Client durchgeführt werden muss. Natürlich können Sie die die identische Konfigurationsdatei für alle User verwenden. 

Im Standard ist der Server unter C:\Program Files (x86)\Amana Consulting\SmartNotesClient installiert. Schließen Sie vor Änderungen an dieser Datei immer Ihren aktiven SmartNotesClient. 



Section


Column
width40%


Column
width60%

Im Bereich <appSettings>…</appSettings> in dieser Datei müssen Sie nun die folgenden Parameter pflegen.

  • <add key="UseSslForEncryption" value="true" /> - Dieser Wert muss auf true gesetzt werden, um die Verschlüsselung einzuschalten.

    Note

    Sobald dieser Wert auf True gesetzt wurde, ist der Zugriff nur noch über Zertifikate gestattet. Sollten Sie die Zertifikate nicht richtig hinterlegt oder installiert haben, ist der Zugriff nicht möglich.


  • <add key="SslServerAuthenticationX509CertificateSubjectName" value="SmartNotesServer" /> - Dieser Wert beinhaltet den Subject Name des hinterlegten Server-Zertifikats. Den Namen finden Sie in Ihrem Zertifikatsspeicher im Reiter „Ausgestellt für“
  • <add key="SslClientAuthenticationX509CertificateSubjectName" value="SmartNotesClient" /> - Dieser Wert beinhaltet den Subject Name des hinterlegten Client-Zertifikats. Den Namen finden Sie in Ihrem Zertifikatsspeicher im Reiter „Ausgestellt für“
  • <add key="SslServerAuthenticationX509CertificateFriendlyName" value="xyz" /> - Sofern ein Anzeigename für das Server-Zertifikat angelegt wurde, muss dieser über diesen Parameter angegeben werden.
  • <add key="SslClientAuthenticationX509CertificateFriendlyName" value="xyz" /> - Sofern ein Anzeigename für das Client-Zertifikat angelegt wurde, muss dieser über diesen Parameter angegeben werden.
  • <add key="X509CertificateStoreLocation" value="CurrentUser" /> - Über diesen Eintrag kann der Speicherort der Zertifikate geändert werden. Da die Zertifikate auf dem Server unter dem aktuellen Benutzerkonto gespeichert sind, muss diese Option zwingend gesetzt sein. 




English


Panel


Section


Column
width60%


Section


Column
width100%




Column
width40%


Panel
bgColor#ECECEC

<< Technical Documentation




Server side setup

Communication between client and server is always symmetrically encrypted. Most of our customers run SmartNotes "on premise" in their own company network. For this scenario, this type of encryption is sufficient.

As a further option for customers with a SmartNotes server outside their own company network, we have now implemented encryption via SSL.

For communication, a key pair is exchanged between the SmartNotes server and the SmartNotes client. 


Section


Column
width40%


Column
width60%

To create the certificate on the SmartNotes server please start the Microsoft Management Console (Run -> mmc).

In the opened window please open the File tab and click on "Add/Remove Snap-In".



Section


Column
width40%


Column
width60%

Please select the Certificates item here and add it via the center button



Section


Column
width40%


Column
width60%

Now please select the computer account and complete the certificate setup in the next step.



Section


Column
width40%


Column
width60%

Now you see in the tree structure on the left the new item "Own certificates" click right on this menu item and select "Request new certificate". 



Section


Column
width40%


Column
width60%

Now continue creating the certificate until you get the registration policy. Now select the "Computer" item, expand it and open the properties.



Section


Column
width40%

Under the item "Private key", the checkbox "Make private key exportable" must be set. After that, the change can be applied and the key can be registered. 


Section


Column
width40%


Column
width60%

You should now be able to see the newly created certificate in the overview. Since SmartNotes requires a unique name of the certificate, you can also assign an alias. This step is optional and only needs to be done if multiple certificates with the same name exist. You can store the alias with a right click on the certificate under the properties.



Section


Column
width40%


Column
width60%

Now the certificate can be exported. This certificate must be stored on the individual clients in the next steps.



Section


Column
width40%


Column
width60%

In order for the certificate to be deposited on the clients, exporting of the private key must be enabled. The certificate should be created as PKCS #12 (.PFX) in the next step. 



Section


Column
width40%


Column
width60%

Exporting the certificate requires the entry of a password. The server certificate must subsequently be imported on all clients that are to receive a connection to the SmartNotes server.




Client side setup


Section


Column
width40%


Column
width60%

The next step is to create a certificate on the client side. The steps are similar to the certificate creation on the server. To create the certificate on the SmartNotes server, please start the Microsoft Management Console (Run -> mmc). 

In the opened window open the File tab and click on "Add/Remove Snap-in". 

It is sufficient to create the certificate on one client and then add it to all servers.



Section


Column
width40%


Column
width60%

Please select the Certificates item here and add it using the center button. 



Section


Column
width40%


Column
width60%

Now please select the My User Account and complete the certificate setup in the next step.



Section


Column
width40%


Column
width60%

Now you can see the new item "Own certificates" in the tree structure on the left. Click on this menu item on the right and select "Request new certificate". 



Section


Column
width40%


Column
width60%

Now continue creating the certificate until you get the registration policy. Now select the "User" item, expand it and open the properties.



Section


Column
width40%


Column
width60%

Under the item "Private key", the checkbox "Make private key exportable" must be set. After that, the change can be applied and the key can be registered. 



Section


Column
width40%

You should now be able to see the newly created certificate in the overview. Since SmartNotes requires a unique name of the certificate, you can also assign an alias. This step is optional and only needs to be done if multiple certificates with the same name exist. You can store the alias with a right click on the certificate under the properties.


Section


Column
width40%


Column
width60%

Now the certificate can be exported. This certificate must be stored on the individual clients.



Section


Column
width40%


Column
width60%

In order for the certificate to be deposited on the clients, exporting of the private key must be enabled. The certificate should be created as PKCS #12 (.PFX) in the next step



Section


Column
width40%


Column
width60%

Exporting the certificate requires a password to be entered. The client certificate must subsequently be imported on the SmartNotes server and on all clients that are to connect to the SmartNotes server.




Server configuration


Section


Column
width40%


Column
width60%

Please store the exported client certificate on your server now. To do this, simply open it by double-clicking on it. Select the local computer for the import.

If you have created multiple client certificates, you must also store them on the server. 



Section


Column
width40%


Column
width60%

Click through the installation and enter the password in the following process. You can leave the certificate store in the last item to automatic.



Section


Column
width40%


Column
width60%

Now you have to adjust the configuration of the server in the last step. Various parameters are available for this purpose. The adjustments must be made in the server configuration file. By default, the server is installed in C:\Program Files (x86)\Amana Consulting\SmartNotesServer. Please stop the server before adjusting the configuration file.



Section


Column
width40%


Column
width60%

In the <appSettings>...</appSettings> section of this file, you must now maintain the following parameters.

  • <add key="UseSslForEncryption" value="true" /> - This value must be set to true to enable encryption.

    Note

    Once this value is set to True, access is only allowed via certificates. If you have not stored or installed the certificates correctly, access is not possible.


  • <add key="SslServerAuthenticationX509CertificateSubjectName" value="SmartNotesServer" /> - This value contains the subject name of the stored server certificate. You can find the name in your certificate store in the "Issued for" tab.
  • <add key="SslClientAuthenticationX509CertificateSubjectName" value="SmartNotesClient" /> - This value contains the subject name of the stored client certificate. You can find the name in your certificate store in the "Issued for" tab.
  • <add key="SslServerAuthenticationX509CertificateFriendlyName" value="xyz" /> - If a display name for the server certificate has been created, it must be specified via this parameter.
  • <add key="SslClientAuthenticationX509CertificateFriendlyName" value="xyz" /> - If a display name has been created for the client certificate, it must be specified via this parameter.
  • <add key="X509CertificateStoreLocation" value="LocalMachine" /> - This entry can be used to change the location of the certificates. If the certificates are stored in the computer account, you can omit this entry. Only if the certificates are stored in the user account, this entry must be set to CurrentUser. werden. 



Section


Column
width40%



Column
width60%

After storing the parameters, you can restart the server service again. Encryption via the server is now enabled. 

Note

Please note that after activating the SSL encryption, the server is only accessible if this is stored on the client and server side. If the configuration is not set up correctly on both sides, the connection may be disrupted. 





Client configuration


Section


Column
width40%


Column
width60%

Please deposit the exported server certificate on your client now. This step must be repeated for all clients that are to have access to the server.

For this purpose, this must simply be opened via double-click. Select the current user for the import. 



Section


Column
width40%


Column
width60%

Click through the installation and enter the password in the following process. You can leave the certificate store in the last item to automatic.



Section


Column
width40%


Column
width60%

Now you have to adjust the configuration of the client in the last step. Various parameters are available for this purpose. 

Note

Please note that the customization of the client configuration file must be done on each client. Of course, you can use the identical configuration file for all users. 

By default, the server is installed in C:\Program Files (x86)\Amana Consulting\SmartNotesClient. Always close your active SmartNotesClient before making changes to this file. 



Section


Column
width40%


Column
width60%

In the <appSettings>...</appSettings> section of this file, you must now maintain the following parameters.

  • <add key="UseSslForEncryption" value="true" /> - This value must be set to true to enable encryption.

    Note

    Once this value is set to True, access is only allowed via certificates. If you have not stored or installed the certificates correctly, access is not possible.


  • <add key="SslServerAuthenticationX509CertificateSubjectName" value="SmartNotesServer" /> - This value contains the subject name of the stored server certificate. You can find the name in your certificate store in the "Issued for" tab.
  • <add key="SslClientAuthenticationX509CertificateSubjectName" value="SmartNotesClient" /> - This value contains the subject name of the stored client certificate. You can find the name in your certificate store in the "Issued for" tab.
  • <add key="SslServerAuthenticationX509CertificateFriendlyName" value="xyz" /> - If a display name has been created for the server certificate, it must be specified via this parameter.
  • <add key="SslClientAuthenticationX509CertificateFriendlyName" value="xyz" /> - If a display name has been created for the client certificate, it must be specified via this parameter.
  • <add key="X509CertificateStoreLocation" value="CurrentUser" /> - This entry can be used to change the storage location of the certificates. Since the certificates are stored on the server under the current user account, this option must be set.