Jenkins integrationsguide

Att integrera Jenkins med Encryption Consultings CodeSign Secure-lösning innebär att konfigurera din Jenkins-miljö och bygga jobb. Den är mycket utbyggbar genom ett stort ekosystem av plugins, vilket gör den anpassningsbar till olika utvecklingsmiljöer.

Konfigurera CodeSign Secure KSP

Encryption Consulting Key Storage Provider (KSP) för Windows är en programvarukomponent som utökar Microsoft Cryptography API: Next Generation (CNG)-ramverket. Dess primära syfte är att göra det möjligt för Windows-applikationer, som signtool.exe, att interagera sömlöst med kryptografiska nycklar och certifikat som lagras i en HSM.

Steg:

  1. Ladda ner EC KSP

    • Logga in på CodeSign Secure-portalen och navigera till avsnittet Signeringsverktyg för att ladda ner "EC KSP för Windows".

      Rutt för signeringsverktyg
    • Extrahera zip-filen för att hämta filen "Setup.msi".
  2. Installera EC KSP

    • Kör installationsprogrammet "Setup.msi" med administratörsbehörighet.

      Installationsprogrammet

    • Följ installationsguidens anvisningar på skärmen.

      1. Godkänn slutanvändarlicensavtalet.
      2. Välj installationskatalogen (standard är C:\Program Files\Encryption Consulting\SigningKSP).
      3. Välj om du vill installera KSP för alla eller bara för den aktuella användaren.
      Installationsmapp

    • Ange de uppmanade uppgifterna, till exempel:

      1. AnvändarnamnAnvändarnamnet/e-postadressen som du använder för att logga in på CodeSign Secure-portalen.
      2. Koda: Den hemliga kod som du angav när du konfigurerade CodeSign Secure-lösningen.
      3. IdentitetstypBehåll detta fält som standard (2)
      4. CodeSign säker URLURL:en för att komma åt portalen (Kom ihåg att lägga till "/api/" i slutet av URL:en)
      API-användarautentiseringsinformation

    • Klicka på Nästa och bekräfta installationen.

      Installera KSP
  3. Konfigurera inställningarna för registerredigeraren

    • Öppna Registereditorn och navigera till katalogen HKEY_CURRENT_USER>Programvara>Krypteringskonsultation>SigningKSP.

      Registereditorn

    • Öppna nu CodeSign Secure-portalen och navigera till Systeminställningar>Användare. Välj rullgardinsmenyn till höger för att "Generera API-nyckel".

      Skapa API-nyckel

    • Skapa en token för ditt konto genom att ange ett namn och giltighetsperiod. Kom ihåg att kopiera token eftersom den bara visas en gång.

      Skapa API-nyckel

    • Lägg till denna token i fältet "ectoken" i Registereditorn.

      ektoken

Konfigurera P12-autentiseringscertifikat

Att konfigurera ett P12-certifikat innebär att du konfigurerar dina miljövariabler för att autentisera din klientdator med Encryption Consultings CodeSign Secure.

Steg:

  1. Konfigurera miljövariablerna

    • Öppna miljövariablerna från din Start-meny

      Systemegenskaper

    • Lägg till nya systemvariabler genom att klicka på knappen Ny. Ange följande variabelnamn och motsvarande information.

      1. EC_Client_AuthMotsvarar sökvägen till ditt SSL-autentiseringscertifikat, vilket kan skapas från CodeSignSecure
      2. EC_Client_PassMotsvarar lösenordet för ditt certifikat, vilket anges när certifikatet skapas.
      3. EC_SSL_VERBOSEMotsvarar inställningen för att antingen aktivera (1) eller inaktivera (0) felsökningsutgången för EC KSP.
      Miljövariabler

Konfigurera Signtool för signering

Att konfigurera signtool för kodsignering innebär att säkerställa att verktyget Signtool.exe är tillgängligt på din dator och konfigurerat för att korrekt interagera med Encryption Consultings kryptografiska leverantör som ger åtkomst till ditt kodsigneringscertifikats privata nyckel.

Steg:

  1. Ladda ner och installera Windows SDK

    • Använd följande nedladdningslänk för att ladda ner Windows Software Development Kit med följande verktyg valda: developer.microsoft.com/en-us/windows/downloads/windows-10-sdk/

      Windows SDK

    • Öppna installationsprogrammet när det har laddats ner och välj "Nästa" på den första skärmen för att behålla standardinställningarna.

      Windows SDK-installationsprogram

    • Följ installationsguidens anvisningar på skärmen.

      1. Acceptera Windows Kit-sekretesspolicyn.
      2. Godkänn slutanvändarlicensavtalet.

    • Avmarkera allt utom "Windows SDK-signeringsverktyg för skrivbordsappar" och välj "Installera".

      Windows SDK-funktion

    • Gå till följande sökväg där verktygen ska ha laddats ner: "C:\Program Files (x86)\Windows Kits\10\bin". Välj önskad versionskatalog och kontrollera om filen "signtool.exe" finns.

      Verktygsväg för skyltning
    • Se till att du är i x64-katalogen och kopiera den här katalogsökvägen.
  2. Lägg till sökväg till Signtool.exe i miljövariabler

    • Öppna miljövariablerna från Start-menyn.

      Signera verktygssökväg i miljövariabel

    • Bläddra nedåt genom systemvariablerna i den nedre tabellen tills du hittar PATH i variabelnamnen.

      Variabelnamn

    • Dubbelklicka på PATH i systemvariablerna och välj New till vänster på skärmen. Klistra in din kopierade sökväg för "signtool.exe" i den nya markeringen.

      Sökväg till signeringsverktyget
    • Välj OK längst ner för att avsluta sidan Miljövariabler.

Ställ in Jenkins

Att konfigurera Jenkins innebär att konfigurera din Jenkins-automationsserver och dess buildagenter för att integrera med Encryption Consultings CodeSign Secure-lösning för automatiserad kodsignering.

Steg:

  1. Ladda ner och installera Jenkins-applikationen

    • Ladda ner Jenkins-applikationen för Windows från här..

    • När du startar Windows Installer öppnas en installationsguide. Klicka på "Nästa" i installationsguiden för att starta installationen.

      Jenkins-installationsprogram

    • Välj destinationsmappen för din Jenkins-installation och klicka sedan på Nästa för att fortsätta.

      Installationsmapp

    • När du konfigurerar Jenkins är det lämpligt att installera och köra det som en fristående Windows-tjänst med en lokal användare eller domänanvändare. Ange domänens användarnamn och lösenord för Jenkins. Klicka sedan på Testa autentiseringsuppgifter för att verifiera dina domänuppgifter och klicka på Nästa.

      Serveruppgifter

    • Välj den port som Jenkins ska köra. Använd knappen Testa port för att kontrollera om den angivna porten är tillgänglig på din dator. Om porten är ledig visas en grön bock nedan, så att du kan fortsätta genom att klicka på Nästa.

      Portval

    • Installationsprocessen verifierar om Java finns på din dator och fyller automatiskt dialogrutan med Java-hemkatalogen. Om den nödvändiga Java-versionen inte är installerad kommer du att bli ombedd att installera den. När du har valt din Java-hemkatalog klickar du på Nästa för att fortsätta.

      Java-hemkatalog

      Du kan kontrollera Java-kraven och versionerna här..

    • Välj ytterligare tjänster som krävs för Jenkins-installationen och klicka sedan på Nästa.

      Anpassad installation

    • Tryck på Installera-knappen för att börja installera Jenkins.

      Inställning

    • När installationen är klar klickar du på Slutför för att slutföra processen.

      Inställning

  2. Konfigurera Jenkins-tjänsten

    • Gå till tjänster på ditt system från Start-menyn
    • Scrolla ner till Jenkins. I kolumnen "Logga in som" kan du se användarkontot som är konfigurerat för Jenkins. Om det är inställt på något annat än ".\Administratör" (Lokal tjänst/System, Nätverkstjänst/System), måste vi ställa in det som Administratör.
    • Dubbelklicka på Jenkins eller högerklicka på > Egenskaper för att öppna Egenskaper. Gå till Logga in. Välj "Detta konto". Ställ in det som ".\Administratör". Ange ett lösenord, helst ett administratörslösenord. Klicka på Verkställ när du är klar.
    • När vi har ställt in detta går vi vidare till Jenkins. Oavsett vilken URL/hostnamn du angav tidigare under konfigurationen, kommer du att nå Jenkins genom att navigera till det från din webbläsare. Här har jag ställt in det som http://localhost:8080/ (Det är också standardinställningen).

  3. Lås upp Jenkins

    • Navigera till http://localhost:8080 (eller den specifika porten du angav för Jenkins under installationen) och vänta på att sidan Lås upp Jenkins laddas.

      Lås upp Jenkins

    • Den initiala administratörslösenordsfilen kommer att finnas i katalogen som visas på Jenkins webbläsarsida, som "C:\Program Files (x86)\Jenkins\secrets". Om du inte hittar den där, kolla i Jenkins installationskatalog som angavs under Jenkins installationsprocess. Där hittar du en fil med namnet initialAdminPassword.

      Administratörens filsökväg

    • Öppna filen och kopiera innehållet i initialAdminPassword fil.

      Ursprungligt administratörslösenord
    • På upplåsningssidan klistrar du in detta lösenord i Lösenord fält och klicka Fortsätta.

  4. Konfigurera Jenkins-pipelinen

    • På instrumentpanelen klickar du på Hantera Jenkins (OBS: Hantera Jenkins visas inte om du inte har skapat ett jobb)

      Dashboard

    • Scrolla ner till Plugins, under Systemkonfiguration

      Hantera Jenkins

    • I avsnittet "Tillgängliga plugin" i avsnittet "Hantera plugin" söker du efter PowerShell-pluginet. Det visas inte i sökresultaten i det här avsnittet om det redan har installerats. Du kan se de plugin som du har installerat under "Installerade plugin".

      Klicka i kryssrutan för plugin-programmet (om det inte redan är installerat) och klicka på Installera utan omstart. Du kan uppdatera sidan när det är installerat.

    • Gå sedan till Global Tool Configuration. Dashboard > Manage Jenkins > Under System Configuration (som visas på bilden ovan) - Global Tool Configuration

    • Scrolla ner till PowerShell. Klicka på Lägg till PowerShell. Du får se ett konfigurationsfönster som bilden nedan. Namnge din PowerShell. Ange sökvägen (där den finns på din dator) till din PowerShell.

      Standardsökvägen är C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe Klicka på Verkställ och Spara.

      Global verktygskonfiguration
    • Klicka nu på alternativet "Nytt objekt" från instrumentpanelen.

    • Ange valfritt objektnamn och klicka på pipelinen och klicka på ok.

      Pipeline

    • På konfigurationssidan, under Allmänt, ange en beskrivning som du önskar.

      konfiguration

    • Scrolla ner till botten för att hitta Pipeline.

      Rörledningskonfiguration

    • Skriv skriptet i skriptrutan och klicka på spara. Du måste redigera din miljövariabel enligt dina inställningar.

      Script

  5. Kör Jenkins-pipelinen

    • Klicka på bygg nu så ser du ett byggnummer som visas på skärmen.

      Byggkörning

    • Om du klickar på byggnumret och väljer konsolutdata ser du att din fil har signerats.

      Signerad