Jenkins Integratiegids

Het integreren van Jenkins met de CodeSign Secure-oplossing van Encryption Consulting vereist het configureren van uw Jenkins-omgeving en buildjobs. Het is zeer uitbreidbaar via een uitgebreid ecosysteem van plug-ins, waardoor het aanpasbaar is aan diverse ontwikkelomgevingen.

CodeSign Secure KSP instellen

De Encryption Consulting Key Storage Provider (KSP) voor Windows is een softwarecomponent die het Microsoft Cryptography API: Next Generation (CNG) framework uitbreidt. Het primaire doel is om Windows-applicaties, zoals signtool.exe, naadloos te laten samenwerken met de cryptografische sleutels en certificaten die in een HSM zijn opgeslagen.

Stappen:

1. Download de EC KSP

   • Meld u aan bij de CodeSign Secure-portal en ga naar het gedeelte Ondertekeningshulpmiddelen om 'EC KSP voor Windows' te downloaden.

     

   • Pak het zipbestand uit om het bestand “Setup.msi” te verkrijgen.
2. Installeer de EC KSP

   • Voer het installatieprogramma “Setup.msi” uit met beheerdersrechten.

     

   • Volg de instructies op het scherm van de installatiewizard.

     1. Accepteer de licentieovereenkomst voor eindgebruikers.
     2. Kies de installatiemap (standaard is dit C:\Program Files\Encryption Consulting\SigningKSP).
     3. Kies of u de KSP voor iedereen wilt installeren of alleen voor de huidige gebruiker

     

   • Voer de gevraagde gegevens in, zoals:

     1. Gebruikersnaam: De gebruikersnaam/het e-mailadres waarmee u inlogt op de CodeSign Secure-portal.
     2. Code: De geheime code die u instelt bij het instellen van de CodeSign Secure-oplossing.
     3. Identiteitstype: Houd dit veld als standaard (2)
     4. CodeSign Beveiligde URL: De URL om toegang te krijgen tot de portal (vergeet niet om “/api/” aan het einde van de URL toe te voegen)

     

   • Klik op Volgende en bevestig de installatie.

     

3. De instellingen van de Register-editor configureren

   • Open de Register-editor en ga naar de map HKEY_CURRENT_USER>Software>Encryption Consulting>SigningKSP.

     

   • Open nu de CodeSign Secure-portal en ga naar Systeeminstellingen > Gebruiker. Selecteer de vervolgkeuzelijst aan de rechterkant om 'API-sleutel genereren' te selecteren.

     

   • Maak een token aan voor je account door een naam en de geldigheidsduur op te geven. Vergeet niet de token te kopiëren, want deze wordt maar één keer weergegeven.

     

   • Voeg dit token toe aan het veld “ectoken” in de Register-editor.

     

P12-authenticatiecertificaat instellen

Voor het instellen van een P12-certificaat configureert u uw omgevingsvariabelen om uw clientcomputer te verifiëren met CodeSign Secure van Encryption Consulting.

Stappen:

1. Configureer de omgevingsvariabelen

   • Open de omgevingsvariabelen vanuit uw startmenu

     

   • Voeg nieuwe systeemvariabelen toe door op de knop Nieuw te klikken. Geef de volgende variabelenaam en de bijbehorende details op.

     1. EC_Client_Auth: Komt overeen met het pad van uw SSL-authenticatiecertificaat, dat kan worden aangemaakt vanuit CodeSignSecure
     2. EC_Client_Pass: Komt overeen met het wachtwoord van uw certificaat, dat u ontvangt bij het aanmaken van het certificaat.
     3. EC_SSL_VERBOSE: Komt overeen met de instelling om de foutopsporingsuitgang voor EC KSP in te schakelen (1) of uit te schakelen (0).

     

Signtool instellen voor ondertekening

Om Signtool in te stellen voor codeondertekening, moet u ervoor zorgen dat het hulpprogramma Signtool.exe op uw computer beschikbaar is en correct is geconfigureerd om te communiceren met de cryptografische provider van Encryption Consulting, die toegang biedt tot de privésleutel van uw codeondertekeningscertificaat.

Stappen:

1. Windows SDK downloaden en installeren

   • Gebruik de volgende downloadlink om de Windows Software Development Kit te downloaden en selecteer de volgende tools: developer.microsoft.com/en-us/windows/downloads/windows-10-sdk/

     

   • Open het installatieprogramma nadat u het hebt gedownload en selecteer 'Volgende' op het eerste scherm om de standaardinstellingen te behouden.

     

   • Volg de instructies op het scherm van de installatiewizard.

     1. Accepteer de Windows Kit Privacy.
     2. Accepteer de licentieovereenkomst voor eindgebruikers.

   • Deselecteer alles behalve “Windows SDK Signing Tools for Desktop Apps” en selecteer “Installeren”.

     

   • Ga naar het volgende pad waar de tools gedownload zouden moeten zijn: "C:\Program Files (x86)\Windows Kits\10\bin". Selecteer de gewenste versiemap en controleer of het bestand "signtool.exe" aanwezig is.

     

   • Zorg ervoor dat u zich in de x64-directory bevindt en kopieer dit directorypad.
2. Pad naar Signtool.exe toevoegen in omgevingsvariabelen

   • Open de Omgevingsvariabelen via het Startmenu.

     

   • Blader door de systeemvariabelen in de onderste tabel totdat u PATH in de variabelenamen vindt.

     

   • Dubbelklik op PATH in systeemvariabelen en selecteer Nieuw aan de linkerkant van het scherm. Plak het gekopieerde pad naar "signtool.exe" in de nieuwe selectie.

     

   • Selecteer OK onderaan om de pagina Omgevingsvariabelen te verlaten.

Stel Jenkins in

Bij het instellen van Jenkins configureert u uw Jenkins-automatiseringsserver en de bijbehorende build-agents, zodat deze worden geïntegreerd met de CodeSign Secure-oplossing van Encryption Consulting voor geautomatiseerde codeondertekening.

Stappen:

1. Download en installeer de Jenkins-applicatie

   • Download de Jenkins-applicatie voor Windows van hier.

   • Wanneer u Windows Installer start, wordt een installatiewizard geopend. Klik op 'Volgende' in de installatiewizard om de installatie te starten.

     

   • Kies de doelmap voor uw Jenkins-installatie en klik op Volgende om verder te gaan.

     

   • Bij het instellen van Jenkins is het raadzaam om het te installeren en uit te voeren als een zelfstandige Windows-service met een lokale of domeingebruiker. Voer de gebruikersnaam en het wachtwoord voor Jenkins in. Klik vervolgens op Testreferenties om uw domeinreferenties te verifiëren en klik op Volgende.

     

   • Kies de poort waarop Jenkins moet draaien. Gebruik de knop Testpoort om te controleren of de opgegeven poort beschikbaar is op uw computer. Als de poort vrij is, verschijnt eronder een groen vinkje, zodat u verder kunt gaan door op Volgende te klikken.

     

   • Tijdens de installatie wordt gecontroleerd of Java op uw computer aanwezig is en wordt het dialoogvenster automatisch gevuld met de Java-homedirectory. Als de vereiste Java-versie niet is geïnstalleerd, wordt u gevraagd deze te installeren. Nadat u uw Java-homedirectory hebt geselecteerd, klikt u op Volgende om verder te gaan.

     

     Je kunt de Java-vereisten en -versies hier bekijken.

   • Selecteer de aanvullende services die u nodig hebt voor de Jenkins-installatie en klik op Volgende.

     

   • Klik op de knop Installeren om met de installatie van Jenkins te beginnen.

     

   • Nadat de installatie is voltooid, klikt u op Voltooien om het proces te voltooien.

     

2. Jenkins-service configureren

   • Ga vanuit het Startmenu naar de services op uw systeem
   • Scroll naar beneden naar Jenkins. In de kolom 'Aanmelden als' ziet u het gebruikersaccount dat voor Jenkins is ingesteld. Als dit is ingesteld op iets anders dan '.\Administrator' (Lokale service/systeem, Netwerkservice/systeem), dan moeten we het instellen op 'Administrator'.
   • Dubbelklik op Jenkins of klik met de rechtermuisknop > Eigenschappen om Eigenschappen te openen. Ga naar Aanmelden. Selecteer "Dit account". Stel dit in als ".\Administrator". Geef een wachtwoord op, bij voorkeur een beheerderswachtwoord. Klik op Toepassen als u klaar bent.
   • Zodra we dit hebben ingesteld, gaan we naar Jenkins. De URL/hostname die je eerder tijdens de installatie hebt opgegeven, zal je via je browser naar Jenkins leiden. In dit geval heb ik http://localhost:8080/ ingesteld (dit is ook de standaardwaarde).

3. Ontgrendel Jenkins

   • Ga naar http://localhost:8080 (of de specifieke poort die u voor Jenkins hebt ingesteld tijdens de installatie) en wacht tot de pagina Jenkins ontgrendelen is geladen.

     

   • Het initiële beheerderswachtwoordbestand bevindt zich in de map zoals weergegeven op de Jenkins-browserpagina, bijvoorbeeld "C:\Program Files (x86)\Jenkins\secrets". Als u het daar niet kunt vinden, controleer dan de installatiemap van Jenkins die is opgegeven tijdens het installatieproces. Daar vindt u een bestand met de naam initialAdminPassword.

     

   • Open het bestand en kopieer de inhoud van het bestand initialAdminPassword.

     

   • Plak dit wachtwoord op de ontgrendelpagina in het wachtwoord veld en klik Doorgaan.

4. De Jenkins-pijplijn opzetten

   • Klik op het dashboard op 'Jenkins beheren' (LET OP: 'Jenkins beheren' verschijnt pas als je een taak hebt aangemaakt).

     

   • Scroll naar beneden naar Plugins, onder Systeemconfiguratie

     

   • Ga in het gedeelte 'Beschikbare plug-ins' naar 'Plug-ins beheren' en zoek naar de PowerShell-plug-in. Deze wordt niet weergegeven in de zoekresultaten als deze al is geïnstalleerd. Onder 'Geïnstalleerde plug-ins' kunt u zien welke plug-ins u hebt geïnstalleerd.

     Vink het selectievakje van de plugin aan (indien nog niet geïnstalleerd) en klik op Installeren zonder opnieuw op te starten. U kunt de pagina vernieuwen na de installatie.

   • Ga daarna naar Global Tool Configuration. Dashboard > Jenkins beheren > Onder Systeemconfiguratie (zoals weergegeven in de afbeelding hierboven) ‐ Global Tool Configuration

   • Scroll naar beneden naar PowerShell. Klik op PowerShell toevoegen. Er verschijnt een configuratievenster zoals in de onderstaande afbeelding. Geef uw PowerShell een naam. Geef het pad op naar uw PowerShell (de locatie op uw computer).

     Het standaardpad is C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe. Klik op Toepassen en Opslaan.

     

   • Klik nu vanuit het Dashboard op de optie ‘Nieuw item’.

   • Voer een itemnaam in, klik op de pijplijn en klik op OK.

     

   • Op de configuratiepagina, onder Algemeen, kunt u een omschrijving naar wens invullen.

     

   • Scroll naar beneden om Pipeline te vinden.

     

   • Schrijf het script in het scriptvak en klik op opslaan. Je moet je omgevingsvariabele aanpassen aan je eigen configuratie.

     

5. Voer de Jenkins-pijplijn uit

   • Klik op 'Nu bouwen' en je ziet een buildnummer op het scherm verschijnen.

     

   • Als je op het buildnummer klikt en de console-uitvoer bekijkt, zie je dat je bestand is ondertekend.