Jenkins-Integrationshandbuch

Die Integration von Jenkins in die CodeSign Secure-Lösung von Encryption Consulting umfasst die Konfiguration Ihrer Jenkins-Umgebung und Build-Jobs. Die Lösung ist durch ein umfangreiches Ökosystem an Plug-Ins hochgradig erweiterbar und lässt sich so an verschiedene Entwicklungsumgebungen anpassen.

CodeSign Secure KSP einrichten

Der Encryption Consulting Key Storage Provider (KSP) für Windows ist eine Softwarekomponente, die das Microsoft Cryptography API: Next Generation (CNG)-Framework erweitert. Sein Hauptzweck besteht darin, Windows-Anwendungen wie signtool.exe die nahtlose Interaktion mit den in einem HSM gespeicherten kryptografischen Schlüsseln und Zertifikaten zu ermöglichen.

Schritte:

1. Laden Sie das EC KSP herunter

   • Melden Sie sich beim CodeSign Secure-Portal an und navigieren Sie zum Abschnitt „Signing Tools“, um „EC KSP für Windows“ herunterzuladen.

     

   • Extrahieren Sie die ZIP-Datei, um die Datei „Setup.msi“ zu erhalten.
2. Installieren Sie den EC KSP

   • Führen Sie das Installationsprogramm „Setup.msi“ mit Administratorrechten aus.

     

   • Folgen Sie den Anweisungen des Installationsassistenten auf dem Bildschirm.

     1. Akzeptieren Sie die Endbenutzer-Lizenzvereinbarung.
     2. Wählen Sie das Installationsverzeichnis (der Standard ist C:\Programme\Encryption Consulting\SigningKSP).
     3. Wählen Sie, ob Sie das KSP für alle oder nur für den aktuellen Benutzer installieren möchten

     

   • Geben Sie die angeforderten Details ein, beispielsweise:

     1. Benutzername: Der Benutzername/die E-Mail-Adresse, die Sie zum Anmelden beim CodeSign Secure-Portal verwenden.
     2. Code: Der Geheimcode, den Sie beim Einrichten der CodeSign Secure-Lösung festgelegt haben.
     3. Identitätstyp: Dieses Feld als Standard beibehalten (2)
     4. CodeSign Secure URL: Die URL für den Zugriff auf das Portal (Denken Sie daran, am Ende der URL „/api/“ hinzuzufügen)

     

   • Klicken Sie auf Weiter und bestätigen Sie die Installation.

     

3. Konfigurieren Sie die Einstellungen des Registrierungseditors

   • Öffnen Sie den Registrierungseditor und navigieren Sie zum Verzeichnis HKEY_CURRENT_USER>Software>Encryption Consulting>SigningKSP.

     

   • Öffnen Sie nun das CodeSign Secure-Portal und navigieren Sie zu System-Setup > Benutzer. Wählen Sie im Dropdown-Menü auf der rechten Seite „API-Schlüssel generieren“ aus.

     

   • Erstellen Sie ein Token für Ihr Konto, indem Sie einen Namen und eine Gültigkeitsdauer angeben. Denken Sie daran, das Token zu kopieren, da es nur einmal angezeigt wird.

     

   • Fügen Sie dieses Token zum Feld „ectoken“ im Registrierungseditor hinzu.

     

Einrichten des P12-Authentifizierungszertifikats

Zum Einrichten eines P12-Zertifikats müssen Sie Ihre Umgebungsvariablen konfigurieren, um Ihren Clientcomputer mit CodeSign Secure von Encryption Consulting zu authentifizieren.

Schritte:

1. Konfigurieren der Umgebungsvariablen

   • Öffnen Sie die Umgebungsvariablen über Ihr Startmenü

     

   • Fügen Sie neue Systemvariablen hinzu, indem Sie auf die Schaltfläche „Neu“ klicken. Geben Sie den folgenden Variablennamen und die entsprechenden Details an.

     1. EC_Client_Auth: Entspricht dem Pfad Ihres SSL-Authentifizierungszertifikats, das von CodeSignSecure erstellt werden kann
     2. EC_Client_Pass: Entspricht dem Passwort Ihres Zertifikats, das bei der Erstellung des Zertifikats angegeben wird.
     3. EC_SSL_VERBOSE: Entspricht der Einstellung, die Debug-Ausgabe für EC KSP entweder zu aktivieren (1) oder zu deaktivieren (0).

     

Einrichten von Signtool zum Signieren

Beim Einrichten von Signtool für die Codesignatur müssen Sie sicherstellen, dass das Dienstprogramm Signtool.exe auf Ihrem Computer verfügbar und für die korrekte Interaktion mit dem Kryptografieanbieter von Encryption Consulting konfiguriert ist, der Zugriff auf den privaten Schlüssel Ihres Codesignaturzertifikats bietet.

Schritte:

1. Herunterladen und Installieren des Windows SDK

   • Laden Sie über den folgenden Download-Link das Windows Software Development Kit mit den folgenden ausgewählten Tools herunter: developer.microsoft.com/en-us/windows/downloads/windows-10-sdk/

     

   • Öffnen Sie das Installationsprogramm nach dem Download und wählen Sie auf dem ersten Bildschirm „Weiter“, um die Standardeinstellungen beizubehalten.

     

   • Folgen Sie den Anweisungen des Installationsassistenten auf dem Bildschirm.

     1. Akzeptieren Sie die Datenschutzbestimmungen des Windows Kit.
     2. Akzeptieren Sie die Endbenutzer-Lizenzvereinbarung.

   • Deaktivieren Sie alles außer „Windows SDK Signing Tools for Desktop Apps“ und wählen Sie „Installieren“.

     

   • Gehen Sie zum folgenden Pfad, in den die Tools heruntergeladen worden sein sollten: „C:\Programme (x86)\Windows Kits\10\bin“. Wählen Sie das gewünschte Versionsverzeichnis aus und prüfen Sie, ob die Datei „signtool.exe“ vorhanden ist.

     

   • Stellen Sie sicher, dass Sie sich im x64-Verzeichnis befinden, und kopieren Sie diesen Verzeichnispfad.
2. Pfad zu Signtool.exe in Umgebungsvariablen hinzufügen

   • Öffnen Sie die Umgebungsvariablen über das Startmenü.

     

   • Scrollen Sie durch die Systemvariablen in der unteren Tabelle nach unten, bis Sie PATH in den Variablennamen finden.

     

   • Doppelklicken Sie in den Systemvariablen auf PATH und wählen Sie links auf dem Bildschirm Neu. Fügen Sie den kopierten Verzeichnispfad von „signtool.exe“ in die neue Auswahl ein.

     

   • Wählen Sie unten „OK“ aus, um die Seite „Umgebungsvariablen“ zu verlassen.

Richten Sie Jenkins ein

Beim Einrichten von Jenkins müssen Sie Ihren Jenkins-Automatisierungsserver und seine Build-Agenten so konfigurieren, dass sie in die CodeSign Secure-Lösung von Encryption Consulting zur automatischen Code-Signierung integriert werden.

Schritte:

1. Laden Sie die Jenkins-Anwendung herunter und installieren Sie sie

   • Laden Sie die Jenkins-Anwendung für Windows herunter von werden auf dieser Seite erläutert.

   • Wenn Sie den Windows Installer starten, öffnet sich ein Installationsassistent. Klicken Sie im Setup-Assistenten auf „Weiter“, um die Installation zu starten.

     

   • Wählen Sie den Zielordner für Ihre Jenkins-Installation und klicken Sie dann auf „Weiter“, um fortzufahren.

     

   • Beim Einrichten von Jenkins empfiehlt es sich, es als eigenständigen Windows-Dienst mit einem lokalen oder Domänenbenutzer zu installieren und auszuführen. Geben Sie den Domänenbenutzernamen und das Kennwort für Jenkins ein. Klicken Sie anschließend auf „Anmeldeinformationen testen“, um Ihre Domänenanmeldeinformationen zu überprüfen, und klicken Sie auf „Weiter“.

     

   • Wählen Sie den Port, auf dem Jenkins ausgeführt werden soll. Überprüfen Sie mit der Schaltfläche „Port testen“, ob der angegebene Port auf Ihrem Computer verfügbar ist. Ist der Port frei, wird unten ein grünes Häkchen angezeigt. Klicken Sie anschließend auf „Weiter“, um fortzufahren.

     

   • Der Installationsvorgang prüft, ob Java auf Ihrem Computer vorhanden ist. Das Dialogfeld wird automatisch mit dem Java-Home-Verzeichnis ausgefüllt. Falls die benötigte Java-Version nicht installiert ist, werden Sie aufgefordert, sie zu installieren. Klicken Sie nach Auswahl Ihres Java-Home-Verzeichnisses auf Weiter, um fortzufahren.

     

     Sie können die Java-Anforderungen und -Versionen überprüfen werden auf dieser Seite erläutert.

   • Wählen Sie zusätzliche Dienste aus, die für die Jenkins-Installation erforderlich sind, und klicken Sie dann auf „Weiter“.

     

   • Klicken Sie auf die Schaltfläche „Installieren“, um mit der Installation von Jenkins zu beginnen.

     

   • Klicken Sie nach Abschluss der Installation auf „Fertig stellen“, um den Vorgang abzuschließen.

     

2. Jenkins-Dienst konfigurieren

   • Gehen Sie über das Startmenü zu den Diensten auf Ihrem System
   • Scrollen Sie nach unten zu Jenkins. In der Spalte „Anmelden als“ sehen Sie das für Jenkins eingerichtete Benutzerkonto. Wenn es auf etwas anderes (Lokaler Dienst/System, Netzwerkdienst/System) als „.\Administrator“ eingestellt ist, müssen wir es auf „Administrator“ einstellen.
   • Doppelklicken Sie auf Jenkins oder klicken Sie mit der rechten Maustaste auf > Eigenschaften, um die Eigenschaften zu öffnen. Gehen Sie zu Anmelden. Wählen Sie „Dieses Konto“. Legen Sie es als „.\Administrator“ fest. Geben Sie ein Kennwort ein, vorzugsweise ein Administratorkennwort. Klicken Sie anschließend auf Übernehmen.
   • Sobald wir dies eingerichtet haben, gehen wir zu Jenkins. Unabhängig davon, welche URL/welcher Hostname Sie zuvor bei der Einrichtung angegeben haben, gelangen Sie über Ihren Browser zu Jenkins. Hier habe ich http://localhost:8080/ eingerichtet (dies ist auch die Standardeinstellung).

3. Schalte Jenkins frei

   • Navigieren Sie zu http://localhost:8080 (oder dem spezifischen Port, den Sie während der Installation für Jenkins festgelegt haben) und warten Sie, bis die Seite „Jenkins entsperren“ geladen ist.

     

   • Die Datei mit dem anfänglichen Administratorkennwort befindet sich im Verzeichnis, das auf der Jenkins-Browserseite angezeigt wird, z. B. „C:\Programme (x86)\Jenkins\secrets“. Falls Sie sie dort nicht finden, schauen Sie im Jenkins-Installationsverzeichnis nach, das während der Jenkins-Installation angegeben wurde. Dort finden Sie eine Datei mit dem Namen initialAdminPassword

     

   • Öffnen Sie die Datei und kopieren Sie den Inhalt der initialAdminPassword Datei.

     

   • Fügen Sie dieses Passwort auf der Entsperrseite in das Passwort Feld und klicken Sie auf Fortfahren.

4. Einrichten der Jenkins-Pipeline

   • Klicken Sie im Dashboard auf „Jenkins verwalten“ (HINWEIS: „Jenkins verwalten“ wird erst angezeigt, wenn Sie einen Job erstellt haben).

     

   • Scrollen Sie nach unten zu Plugins unter Systemkonfiguration

     

   • Suchen Sie unter „Plugins verwalten“ im Bereich „Verfügbare Plugins“ nach dem PowerShell-Plugin. Es wird in den Suchergebnissen in diesem Bereich nicht angezeigt, wenn es bereits installiert ist. Unter „Installierte Plugins“ sehen Sie die von Ihnen installierten Plugins.

     Aktivieren Sie das Kontrollkästchen des Plugins (falls noch nicht installiert) und klicken Sie auf „Ohne Neustart installieren“. Sie können die Seite nach der Installation aktualisieren.

   • Gehen Sie anschließend zur globalen Toolkonfiguration. Dashboard> Jenkins verwalten > Unter Systemkonfiguration (wie im Bild oben gezeigt) – Globale Toolkonfiguration

   • Scrollen Sie nach unten zu PowerShell. Klicken Sie auf PowerShell hinzufügen. Es erscheint ein Konfigurationsfenster wie im Bild unten. Benennen Sie Ihre PowerShell. Geben Sie den Pfad (wo sie sich auf Ihrem Computer befindet) zu Ihrer PowerShell an.

     Der Standardpfad ist C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe Klicken Sie auf „Übernehmen und Speichern“.

     

   • Klicken Sie nun im Dashboard auf die Option „Neues Element“.

   • Geben Sie einen beliebigen Artikelnamen ein, klicken Sie auf die Pipeline und dann auf „OK“.

     

   • Geben Sie auf der Konfigurationsseite unter „Allgemein“ eine Beschreibung Ihrer Wahl ein.

     

   • Scrollen Sie nach unten, um Pipeline zu finden.

     

   • Schreiben Sie das Skript in das Skriptfeld und klicken Sie auf „Speichern“. Sie müssen Ihre Umgebungsvariable entsprechend Ihrer Konfiguration bearbeiten.

     

5. Ausführen der Jenkins-Pipeline

   • Klicken Sie auf „Jetzt erstellen“, und auf dem Bildschirm wird eine Build-Nummer angezeigt.

     

   • Wenn Sie auf die Build-Nummer klicken und zur Konsolenausgabe gehen, sehen Sie, dass Ihre Datei signiert wurde.