# Copyright (C) 2012-2021 genua GmbH, 85551 Kirchheim, Germany # All rights reserved. Alle Rechte vorbehalten. - Systemvoraussetzungen: - Windows 7 oder Windows 10 jeweils aktuellstes ServicePack - Microsoft .NET Framework 4 Client Profile: http://www.microsoft.com/en-us/download/details.aspx?id=24872 - Die App benötigt folgende Firewall-Freigaben - Ping/HTTP auf die genucard - HTTP auf 127.0.0.1:33333 (in Default-Einstellungen) - genucard Version: Der volle Funktionsumfang steht ab den genucard Versionen 4.1p0, 4.0p4, 3.0p8 und 2.0p12 zur Verfügung. Die oben genannten Versionen werden für folgende Features benötigt: - Rekeying - Smartcard-PIN ändern - Profile verwalten - System-Konfiguration: - Wir empfehlen das Disablen der FastUserSwitch-Option. Über den Installer möglich. - Der Setupprozess Ist ein MSI Windows-Installer, welcher das Gesamtpaket (Service, CLI, Credential-Provider und GUI) installiert. Im Rahmen des Setup-Prozesses kann auch optional der Key für die Maschinenbindung installiert werden. Ein installierter Schlüssel wird bei der Deinstallation der Software nicht gelöscht. - Setup-Optionen INSTALLDESKTOPSHORTCUT: Default: 1 Beschreibung: Desktop-Shortcut für das GUI erstellen, ja/nein AUTOSTART: Default: 1 Beschreibung: Autostart-Eintrag für das GUI erstellen, ja/nein INSTALLCP: Default: 1 Beschreibung: Credential-Provider installieren, ja/nein (erst ab Windows Vista möglich) KEYFILEPATH: Default: "" Beschreibung: Pfad zur Keydatei für die Maschinenbindung, falls leer keine Installation DISABLEFASTUSERSWITCH: Default: 1 Beschreibung: FastUser-Switching ("Benutzer wechseln") deaktivieren, ja/nein PURGE: Default: 0 Beschreibung: Falls das MSI mit dieser Option installiert wird, werden beim Uninstall auch die Dateien genucard.config und genucard-theme.xml entfernt. - Stille Installation mit Maschinenbindung Das MSI Paket kann auch mittels msiexec und der /quiet-Option installiert werden Beispiel Aufruf für Default-Installation mit Schlüssel für die Maschinenbindung: msiexec /i genucard-setup.msi KEYFILEPATH="C:\PRIVATE.KEY" /quiet - Der Service Der GenucardService wird beim Setupprozess installiert und automatisch gestartet. Der Service läuft als LocalSystem-Benutzer. Wie jeder Windows-Service kann dieser über die Dienste-Übersicht gestartet, gestoppt und neugestartet werden. Per Default wird in das Windows EventLog mit dem Loglevel Info geloggt. (Für Anpassungen siehe weiter unten bei 'Konfiguration') Der Service ist es auch für die Maschinenbindung zuständig, daher brauchen die Benutzer keine besonderen Rechte oder müssen bestimmten Gruppen angehören. - Die CLI Die CLI stellt wie die GUI ein Interface zur Steuerung der genucard dar. Desweiteren übernimmt die CLI das Key-Management für die Maschinenbindung. Mehr Infos und Anwendungsbeispiele in CliUsage.txt. - Die GUI Die GUI ist das Steuerungs-Interface der genucard für den Benutzer. Für diese wird beim Setupprozess eine Verknüpfung auf den Desktop installiert und ein Autostart-Eintrag für alle Benutzer erstellt. Auf der Status-Übersicht werden vier Icons dargestellt, die dem Benutzer Informationen zur Verfügung stellen: - Igel im Computer: Zeigt an ob die genucard physikalisch am Computer angeschlossen ist und in der Registry eingetragen wurde. Sollte kein GenucardService laufen oder keine genucard gefunden werden, dann wird ein Fehler angezeigt. - Netzwerk-Dose: Zeigt an ob die genucard per Netzwerk erreichbar ist, die Maschinenbindung geklappt hat und der Benutzer angemeldet ist. Sollte die genucard nicht erreichbar sein wird ein Fehler angezeigt. Sollte die Maschinenbindung fehlschlagen, ist noch eine Anmeldung nötig oder ist die Netzwerkkonfig fehlerhaft so wird eine Warndreieck dargestellt. - Web-Symbol: Zeigt den aktuellen Status der Internetverbindung an. Sollte eine WISPr Authentisierung erforderlich sein, so wird hier ein Warndreieck dargestellt - Schloss-Symbol: Zeigt den aktuellen Status der VPN-Verbindung an. Bei einem Klick auf ein Icon bekommt man eine Detail-Ansicht mit mehr Informationen zum jeweiligen Status oder Fehler. Das TrayIcon stellt ebenfalls den aktuellen Status dar: - Problem besteht (Fehler, Anmeldung nötig etc.) - Internet verbunden - VPN verbunden Derzeitige Features: - Anmelden an der genucard - Internet-/VPN-Verbindungen aufbauen/abbrechen/trennen - VPN-Verbindung aufbauen ohne bestehendes Internet baut automatisch das ausgewählte Internet mit auf. - Webinterface öffnen über das Rechtsklick-Menü - Themes - WISPr Authentisierung bei Hotspots, die dies verlangen - Details-Fenster mit ausführlichen Informationen zum aktuellen Status - Session-Protokoll in dem alle Ereignisse (Status-Änderungen, Fehler, Infos) in Kurzform dargestellt werden. - Anzeigen von genucenter-Nachrichten - Ändern von Smartcard-PIN - Profile verwalten - Rekeying-Benachrichtigung für den Endnutzer Tastaturkürzel: - Hauptfenster: Strg + Zahl: Wechsel des Tabs Strg + x: Minimieren des Fensters in den System-Tray Strg + Shift + x: Beenden der GUI - Details-Fenster: F5: Update der angezeigten Daten Strg + s: Speichern des genucard-reports in Datei Strg + x: Schließen des Details-Fensters - Der PreLogon Credential-Provider Der Credential-Provider ermöglicht es dem Nutzer ab Windows 7 sich vor dem Windows-Login an der genucard anzumelden und Internet/VPN-Verbindungen zu starten. So ist es zum Beispiel möglich den Windows-Login direkt übers VPN am ActiveDirectory zu machen. - GUI-Themes GUI-Themes werden in der Datei 'genucard-theme.xml' definiert. In dieser Datei können mehrere Themes definiert werden. Die verwendeten Bilder dürfen maximalst eine Höhe von 45 Pixeln haben. Standard genua-Theme: app-symbol.png genua-logo45x100.png genuscreen-banner.png In einem Theme können die Bilder im oberen Bereich der GUI individualisert werden. Das Linke-, Rechte- und Hintergrund-Bild können definiert werden. Sollte der Wert leer sein, so wird dieses Bild transparent dargestellt. - Konfiguration Im Installations-Ordner finden Sie die Datei 'genucard.config'. Diese Datei stellt die systemweite Konfiguration für den Service, GUI und CLI dar. Folgende Optionen sind derzeit implementiert: - Die IPv4-Adresse oder ein Hostname (z.B. my.genucard) der genucard. Falls ein Hostname eingetragen wird, wird nicht mehr nach einer genucard gesucht, sondern stetig versucht die genucard über den Hostname zu erreichen. Deshalb wird hier für die Hardware stets OK angezeigt. Default ist leer und bedeutet, dass die genucard über die Registry gesucht wird. - Die IPv4-Adresse und Port auf dem der Service seine HTTP-Schnittstelle startet Default: 127.0.0.1:33333 Falls sie den CredentialProvider verwenden, ändern sie diesen Wert nicht ab, da dieser noch nicht Konfigurations-Änderungen mitbekommt. - Das Interval in ms mit welchen GUI/Service ihre Daten aktualisieren. Default: 2000 ms - Der Name für den Key der Maschinenbindung. Default: GenuaGenucardClientV2_03 für Kompatibilität mit gctool - Definiert ob die GUI beim Starten versteckt, nur TrayIcon sichtbar, sein soll. Default: False - Definiert ob der Benutzer im Rechtsklick-Menü die "Beenden"-Option angezeigt bekommt. Default: True (Die GUI kann weiterhin über den Taskmanager hart beendet werden) - Definiert ob die GUI beim Finden einer genucard automatisch das Loginfenster anzeigen soll. Default: True - Definiert ob die GUI beim Verbinden mit einem Hotspot, der eine WISPr Authentisierung verlangt, automatisch das Loginfenster zeigen soll. Ein Deaktivieren dieser Einstellung kann nützlich sein, um eine manuelle Anmeldung über den Browser vorzunehmen, falls die Authentisierung über das GUI fehlschlägt Default: True - Definiert ob die GUI in ihr Logfile unter C:\Users\$USER\AppData\Roaming\genucard-client\genucard-gui.log loggen soll. Default: False - Definiert das minimum Loglevel des GUI-Loggings Mögliche Werte: Info/Error/Debug Default: Info - Definiert die Zeit in ms, die die genucard hat um auf Anfragen des GenucardService zu reagieren. Default: 60000 ms - Definiert ob mehrere aktive Windows-Sessions erlaubt sein soll. Falls 'false' werden bei mehreren aktiven Windows-Sessions, die Verbindungen beendet. Zu beachten: Bei 'true' verweigert der Service auch weiterhin bei mehreren aktiven Windows-Sessions die Annahme von Kommandos. Remote-Session-Übernahme oder Remote-Assistance sind ohne Einschränkungen möglich. Default: false - Definiert ob bei einem Logout am Windows bestehende Verbindungen beendet werden sollen. Default: true - Definiert die maximale Anzahl von gleichzeitigen Anfragen, die der Service bearbeitet. Default: 100 - Definiert welcher Theme aus der Datei 'genucard-theme.xml' verwendet werden soll. Default: genua - Definiert ob das Rekeying-Fenster immer wieder angezeigt werden, soll bis der User das Rekeying erfolgreich durchgeführt hat. Keine anderen Aktionen sind dann mehr möglich. Default: true - CMD-Kommando, dass nach dem erfolgreichem Start einer VPN-Verbindung ausgeführt wird. Das Kommando wird vom GUI im Benutzer-Kontext ausgeführt, so dass zum Beispiel Netzwerklaufwerke eingebunden werden können. Default: leer - CMD-Kommando, dass nach dem erfolgreichem Stop einer VPN-Verbindung ausgeführt wird. Das Kommando wird vom GUI im Benutzer-Kontext ausgeführt, so dass zum Beispiel Netzwerklaufwerke ausgehängt werden können. Default: leer - Ein Timeout in ms für die OnVpnStart- und OnVpnStop-Kommandos. Default: 0 (kein Timeout) - Definiert welche Sprache im GUI verwendet werden soll. Möglich sind "de-DE" oder "en-EN". Falls der Wert Leer ist, wird die System-Sprache verwendet. Default: leer - Definiert eine Dauer in Minuten, nach der bei laufenden VPN beim Nutzer nachgefragt werden soll ob die VPN-Verbindung noch benötigt wird. Default: 0 (keine Nachfrage) - Definiert eine Dauer in Minuten, nach der der VPN-Timeout-Dialog automatisch geschlossen und die VPN-Verbindung beendet wird. Default: 30 - Definiert ob der Benutzer im Rechtsklick-Menü die "Logout"-Option angezeigt bekommt. Default: False - Definiert die Position des Credential Providers. Mögliche Werte: top/lowerleft/lowerright/upperleft/upperright/center Default: center - Definiert ob die GUI nach Aufbau des VPNs von selbst verschwinden soll. Default: False - Definiert ob das Credential Provider GUI nach Aufbau des VPNs von selbst verschwinden soll. Default: true - Definiert das Logging des Services. priority: Info (Default)/Error/Debug appender-ref: - ConsoleAppender (falls der Service in der Console gestartet wird) - EventLogAppender (aka. Ereignis-Anzeige, der Default) - RollingLogFileAppender (in die Datei genucard-service.log im Installations-Verzeichnis) Das Logging wurde mittels Log4Net (http://logging.apache.org/log4net/) realisiert und kann angepasst werden. - Verwendete Software Topshelf: http://topshelf-project.com/ (Apache License, Version 2.0) Mit eigener Erweiterung, dass Windows-SessionEvents behandelt werden können. Änderungen sind derzeit im Review der Topshelf-Entwickler: https://github.com/Topshelf/Topshelf/pull/132 Log4Net: http://logging.apache.org/log4net/ (Apache License, Version 2.0 http://logging.apache.org/log4net/license.html) - Apache 2.0 License: Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.