Mercurial > trustbridge
changeset 1240:17aa7cf0bedd
(help-admin) Added new help page about installation, server and gui.
author | Emanuel Schuetze <emanuel@intevation.de> |
---|---|
date | Wed, 24 Sep 2014 17:50:09 +0200 |
parents | 5839d864239c |
children | 4692f8860a24 |
files | doc/help/admin/_static/gui.png doc/help/admin/_static/installationspaket-erstellen.png doc/help/admin/_static/liste-erstellen.png doc/help/admin/_static/liste-laden.png doc/help/admin/_static/liste-signieren.png doc/help/admin/_static/minus.png doc/help/admin/_static/plus.png doc/help/admin/_static/zertifikat-entfernen.png doc/help/admin/_static/zertifikat-hinzu.png doc/help/admin/bedienung.rst doc/help/admin/index.rst doc/help/admin/installation.rst doc/help/admin/server.rst doc/help/client/index.rst |
diffstat | 14 files changed, 134 insertions(+), 45 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/help/admin/bedienung.rst Wed Sep 24 15:52:32 2014 +0200 +++ b/doc/help/admin/bedienung.rst Wed Sep 24 17:50:09 2014 +0200 @@ -2,6 +2,90 @@ ======================== -Die **TrustBridge-Verwaltungsanwendung** ... +Die **TrustBridge-Verwaltungsanwendung** dient zur Erstellung von Zertifikatslisten +und TrustBridge-Installationspaketen. Die nachfolgende Abbildung zeigt +die Oberfläche, welche stets die aktuelle Zertifikatsliste darstellt und verschiedene +Bearbeitungsmöglichkeiten bietet. -TODO: Screenshot +.. figure:: _static/gui.png + :alt: Die Oberfläche der TrustBridge-Verwaltung unter Windows 8 + :width: 100% + + +Zertifikatsliste erstellen +--------------------------- + +|zertifikat-hinzu| fügt eins oder mehrere ausgewählte Zertifikatsdateien der aktuellen Liste hinzu. + +|zertifikat-entfernen| löscht ein versehentlich hinzugefügtes +Zertifikat. + +*Bitte beachten Sie: Sobald die Zertifikatsliste erstellt wurde, +lassen sich die darin enthaltenen Zertifikate nicht mehr löschen +sondern nur noch zum Deinstallieren markieren! Der Grund dafür ist, +dass eine Liste schon veröffentlicht und beim Nutzer installiert sein könnte und somit +das Löschen eines Zertifikats nur über eine neue Liste mit einer weiteren Deinstallationsempfehlung +erfolgen kann.* + +|liste-erstellen| speichert und signiert eine neue Liste. Zuvor +bekommen Sie eine Übersicht, welche Zertifikate Sie seit Speichern der letzten Liste +geändert haben. Zum Signieren müssen Sie den Listen-Signaturschlüssel +sowie das Ausgabeverzeichnis angeben: + +.. figure:: _static/liste-signieren.png + :alt: Zertifikatsliste signieren und speichern + :width: 100% + +Jede erstellte Zertifikatsliste wird zusätzlich - zu Protokollierungszwecken - im angegebenen +Archiv-Verzeichnis abgelegt. + + +|liste-laden| öffnet eine ausgewählte Zertifikatsliste, die Sie vorher +gespeichert haben. + +*Beachten Sie: Beim Starten von TrustBridge-Verwaltung wird automatisch +die Zertifikatsliste geöffnet, die Sie zuletzt bearbeitet hatten.* + + +|plus| |minus| zeigt an, ob der Nutzer ein Zertifikat als "empfohlenes" (linkes Icon) +oder "abgeratenes" (rechtes Icon) Wurzelzertifikat in TrustBridge +sieht. Empfohlene Zertifikate werden durch TrustBridge installiert, abgeratene +Zertifikate werden deinstalliert. + + + +Installationspaket erzeugen +--------------------------- +TrustBridge-Admin erstellt aus vorliegenden Binärdaten +Installationspakete für die TrustBridge-Client-Anwendung für Windows und Linux. + +Öffnen Sie dazu über [Menü > Installationspaket erstellen...] folgenden +Dialog... + +.. figure:: _static/installationspaket-erstellen.png + :alt: Installationspaket erstellen und signieren + :width: 100% + +... und geben das entpackte Binärverzeichnis an (enthält die Datei +meta.ini), das Code-Signing-Zertifikat zum Signieren des +Windows-Installers sowie das Ausgabverzeichnis, wo die erstellten +Installationpakete abgelegt werden sollen, an. + +Die Angaben werden für den nächsten Aufruf dieses Dialogs +gespeichert. + +Als Ergebnis erhalten Sie drei signierte Dateien, die Sie nun auf den +Update-Server hochladen können: + +* TrustBridge-|version|.exe (Windows-Installer) +* TrustBridge-|version|-amd64.sh (Linux 64-Bit-Installer) +* TrustBridge-|version|-i386.sh (Linux 32-Bit-Installer) + + + +.. |minus| image:: _static/minus.png +.. |plus| image:: _static/plus.png +.. |liste-erstellen| image:: _static/liste-erstellen.png +.. |liste-laden| image:: _static/liste-laden.png +.. |zertifikat-entfernen| image:: _static/zertifikat-entfernen.png +.. |zertifikat-hinzu| image:: _static/zertifikat-hinzu.png
--- a/doc/help/admin/index.rst Wed Sep 24 15:52:32 2014 +0200 +++ b/doc/help/admin/index.rst Wed Sep 24 17:50:09 2014 +0200 @@ -1,59 +1,54 @@ -Was ist TrustBridge? -==================== - -TrustBridge ist eine Anwendung vom `Bundesamt für Sicherheit in der -Informationstechnik (BSI) <https://bsi.bund.de>`_ für die Verbreitung -von empfohlenen Wurzelzertifikaten. - -TrustBridge macht es Nutzern einfacher, Wurzelzertifikate für eine -X.509-basierende, öffentliche Zertifikatsinfrastruktur (PKI) -einzuspielen und aktuell zu halten. TrustBridge verteilt -Wurzelzertifikate, welche von den Betriebssystemen und Webbrowsern -nicht mitgeliefert werden. Existierende Zertifikate, die korrumpiert -oder missbraucht wurden, können von TrustBridge über eine -Deinstallations-Empfehlung entfernt werden. Dabei ist unerheblich, ob -die Zertifikate auf der Anwenderebene vorher bereits installiert -waren. - -**Wurzelzertifikate** (auch Rootzertifikate genannt) sind die Basis -einer PKI zur Feststellung der Authentizität des -Kommunikationspartners und der Integrität seiner Nachrichten für -verschiedene Anwendungen -- insbesondere bei der Übertragung über -unsichere Kommunikationskanäle, wie dem Internet. - -Ein Wurzelzertifikat dient als Vertrauensanker ("Trust Anchor") für -alle darunter hängenden Zertifikate. Unterhalb der Wurzel folgt eine -Sicherheitskette ("Trust Chain") von ein oder mehreren -Zwischenzertifikaten der Zertifizierungsstellen, gefolgt von den -ausgestellten Zertifikaten für die Anwendungen. Die Zertifikate -sichern per Public-Key-Kryptoverfahren nach dem X.509-v3 Standard -beispielsweise TLS-Verbindungen von Webbrowser zu Webserver (HTTPS) -oder E-Mail-Klient zu E-Mail-Server (IMAPS). Ein weiteres Beispiel ist -die Ende-zu-Ende Absicherung von E-Mail per S/MIME-Standard. - - -Über diese Hilfe -================ -Diese Hilfe unterstützt Sie bei der Bedienung der -TrustBridge-Verwaltungsanwendung und gibt Hinweise zum Betrieb des -Download-Servers. Die Hilfeseiten im Überblick: +Inhaltsverzeichnis +================== .. toctree:: :maxdepth: 2 installation bedienung + server + + +Was ist TrustBridge? +==================== +TrustBridge erleichtert Ihnen das Einpflegen von Wurzelzertifikaten +zur Absicherung Ihrer Kommunikation durch Verschlüsselung und Signaturen. +Dazu holt sich TrustBridge regelmäßig die Wurzelzertifikate, +welche von einer zentralen Stelle vorgeschlagen werden und bietet +Sie Ihnen zum Einfügen in den Zertifikatspeicher Ihres Rechners an. + +Über TrustBridge werden üblicherweise nur Zertifikate verteilt, +welche von Ihrem Betriebssystem nicht mitgeliefert werden. Sie können sich +dafür entscheiden nur einen Teil der Wurzelzertifikate zu übernehmen. +TrustBridge respektiert Ihre bisherigen Wurzelzertifikatsentscheidungen. + +Wenn ein früher vorschlagenes Wurzelzertifikat lange in Benutzung war +oder ein Problem damit bekannt wurde, empfiehlt TrustBridge +es wieder zu entfernen. Auch für diese Änderung holt sich TrustBridge +erst Ihre Erlaubnis. + +Wurzelzertifikate verwalten den Zugang zu Ihren Daten. +Verwenden Sie TrustBridge deshalb nur, wenn Sie der Organisation, +(von der Sie die Software erhalten haben +und welche die Wurzelzertifikatsvorschläge pflegt) vertrauen. + +TrustBridge arbeitet im Hintergrund und meldet sich +bei Ihnen, wenn es etwas Neues gibt. + +TrustBridge ist eine Anwendung vom `Bundesamt für Sicherheit in der +Informationstechnik (BSI) <https://bsi.bund.de>`_. Impressum ========= -Copyright 2014 Die Rechte liegen beim `Bundesamt für Sicherheit in der +Ausgabe 2014, Die Rechte liegen beim `Bundesamt für Sicherheit in der Informationstechnik (BSI) <https://bsi.bund.de>`_. TrustBridge wurde von den Unternehmen `Intevation GmbH <http://www.intevation.de>`_ und `DN-Systems GmbH -<http://www.dn-systems.com>`_ entwickelt, im Auftrag vom BSI. +<http://www.dn-systems.com>`_ entwickelt, im Auftrag des BSIs. -Diese TrustBridge-Hilfe ist unter der `Creative Commons CC BY-SA 3.0 +Diese TrustBridge-Verwaltungs-Hilfe ist unter der `Creative Commons CC BY-SA 3.0 <http://creativecommons.org/licenses/by-sa/3.0/>`_ lizensiert. +
--- a/doc/help/admin/installation.rst Wed Sep 24 15:52:32 2014 +0200 +++ b/doc/help/admin/installation.rst Wed Sep 24 17:50:09 2014 +0200 @@ -7,3 +7,9 @@ TODO: Systemvoraussetzung, Windows, Ubuntu + +Systemvoraussetzungen +--------------------- + +* erforderlicher Festplattenplatz: ca. 20 MB +
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/help/admin/server.rst Wed Sep 24 17:50:09 2014 +0200 @@ -0,0 +1,4 @@ +Server-Anforderungen +==================== + +TODO
--- a/doc/help/client/index.rst Wed Sep 24 15:52:32 2014 +0200 +++ b/doc/help/client/index.rst Wed Sep 24 17:50:09 2014 +0200 @@ -12,6 +12,7 @@ Was ist TrustBridge? ==================== + TrustBridge erleichtert Ihnen das Einpflegen von Wurzelzertifikaten zur Absicherung Ihrer Kommunikation durch Verschlüsselung und Signaturen. Dazu holt sich TrustBridge regelmäßig die Wurzelzertifikate, @@ -40,7 +41,6 @@ Informationstechnik (BSI) <https://bsi.bund.de>`_. - Impressum =========