Uppgraderingen till Shibboleth IdPv4 är lite mer komplicerad än en vanlig uppgradering av Shibboleth. Innan man uppgradera till v4, måste man har redan anpassat konfigurationsfilerna till den nya version.
Introduktion
Om din IdP version är under 3.4 så borde du uppgraderar till senaste 3.4 version först. De här instruktionerna är testad på IdPer på version 3.4.6.
Testa först!
Ta en backup eller snapshot innan du påbörjar uppgradering och helst på en test IdP innan du uppgradera din produktion IdP!
Anpassa IdPv3.4.X konfiguration för IdPv4
Detta steg är väldigt viktigt och mest tidskrävande om man inte redan har gjort det.
Du måste ha uppdaterat dina konfigurationsfiler (särskillt attribute-resolver.xml och attribute-filter.xml) till att vara kompatibla med IdP v3.4 och v4 innan du påbörjar uppgradering. Kontrollera loggfilerna för att säkerställa att inga DEPRECATED varnings förekommer. Alla varning måste lösas innan uppgradering. De flesta DEPRECATED varningar förekommer på grund av legacy (IdP v2) konfiguration i attribute-resolver och attribute-filter. De nya standard attribute-resolver och attribute-filter filer finns nedan:
Example of a standard attribute resolver for Shibboleth IdP v3.4.0 and above och Example of a standard attribute filter for Shibboleth IdP v3.4.0 and above
Dessa filer uppfyller de nya rekommendationer för entitetskategorier inom SWAMID. Dessa filer kan inte användas rakt av. Det är rekommenderat att utgå från dessa filer och "migrerar in" lokala anpassningar från nuvarande konfigurationen, sedan testa så mycket som möjligt - helst på en test IdP. Det är rekommenderat att produktionssätta de nya filer ett tag innan uppgraderingen till IdPv4 så man kan säkerställa att attribute resolvern och filtern fungerar som de ska.
IdPv4 uppgraderingen
Här beskriver vi de steg som har testats och fungerar för SWAMID IdPer som tidigare installerats med hjälp av SWAMIDs idp-installer. Dessa steg är testad på Centos 7 och Debian X.
Centos specifik
IdPv4 kräver Java 11. Avinstallera Java 8 och installera Java 11.
Debian specifik
IdPv4 kräver Java 11. Avinstallera Java 8 och installera Java 11
Debian och Centos
Följande steg är samma oavsett om du kör Debian eller Centos. Jetty måste uppgraderas från 9.3 till 9.4. Det är bra att kontrollera dependencies som du kan ha i edit-webapp mappen innan du kör själva Shibboleth uppgraderingen.
Jetty
Shibboleth IdP v4 kräver Jetty 9.4 och ganska mycket har ändrats jämfört med 9.3. SWAMID operations har därför packeterat en jetty-base mapp som är anpassad för SWAMID IdPer. Du kan ladda ner den och packa upp i jetty mappen, därefter finns bara några ändringar som du behöver göra. Den är baserad på en jetty-base som Shibboleth projektet publicerar. Det finns mer information om hur man konfigurerar jetty-base hos Shibboleths Wiki (https://wiki.shibboleth.net/confluence/display/IDP4/Jetty94)
Ladda ner den senaste version av Jetty 9.4. https://www.eclipse.org/jetty/download.html Vid skrivande stund, 9.4.32.v20200930
# cd /opt # wget https://repo1.maven.org/maven2/org/eclipse/jetty/jetty-distribution/9.4.32.v20200930/jetty-distribution-9.4.32.v20200930.zip # unzip jetty-distribution-9.4.32.v20200930
Ladda ner SWAMIDs jetty-base och packa upp. Ladda ner swamid-jetty-base.tar.gz
# cd jetty-distribution-9.4.32.v20200930 # tar zxf /path/to/swamid-jetty-base.tar.gz
Följande filer i jetty-base behöver kontrolleras och uppdateras:
- alla filer under start.d
- https.12 och idp-backchannel.p12 hanteras nu i separata filer, kontrollera path till filerna och byta "changeit" till det riktiga lösenordet.
- start.ini kan behöva justeras om du vill ändra hur mycket minne Jetty kan använda
Mer information om jetty-base finns på Shibboleths wiki, https://wiki.shibboleth.net/confluence/display/IDP4/Jetty94
Länka om jetty till rätt distribution mapp. Först måste du se till att Jetty är avstängd.
# cd /opt # chown -R jetty.jetty jetty-distribution-9.4.32.v20200930 # service jetty stop # rm jetty # ln -s jetty-distribution-9.4.32.v20200930 jetty
Uppdatera /etc/default/jetty. Förutom ändringar till JAVA_HOME, så måste man omdirigera JETTY_START_LOG och JETTY_RUN till lämplig fil resp. mapp. På Centos och Debian så är /var/run (de default mappar) skapat vid boot med fel rättigheter för att Jetty användaren ska kunna skriva till /var/run/jetty.
Kontrollera Jetty start script
# cd /etc/init.d # rm jetty # ln -s /opt/jetty/bin/jetty.sh jetty
Shibboleth IdP v4.X
Ladda ner och packa upp den senaste version av IdP v4, i skrivande stund 4.0.1. Backa upp din shibboleth-idp mapp innan du uppgraderar.
# cd /opt # wget http://shibboleth.net/downloads/identity-provider/latest/shibboleth-identity-provider-4.0.1.tar.gz # tar zxvf shibboleth-identity-provider-4.0.1.tar.gz # cp -r shibboleth-idp shibboleth-idp.orig
Ta bort eventuella gamla jar filer från edit-webapp
Vi har sett att det finns äldre versioner av httpcore, httpclient, commons-dbcp2, commons-pool2 under mapp /opt/shibboleth-idp/edit-webapp/WEB-INF/lib. Om du har dessa jar-filer i /opt/shibboleth-idp/edit-webapp/WEB-INF/lib, tar bort dem. Nyare versioner av dessa filer finns med Shibboleth IdPv4.
MySQL Connector och HikariCP jar-filer
Om du inkluderar andra JAR filer i /opt/shibboleth-idp/edit-webapp/WEB-INF/lib såsom MySQL connector, HikariCP så är det bra att uppgradera dem till senaste version. SWAMID operations har testat med mysql-connector-java-5.1.48-bin.jar och HikariCP-3.4.5.jar.
MySQL Java connector https://dev.mysql.com/downloads/connector/j/5.1.html
HikariCP https://mvnrepository.com/artifact/com.zaxxer/HikariCP
Kontrollera web.xml i edit-webapp/WEB-INF
Vi rekommendera att du jämföra edit-webapp/WEB-INF/web.xml med den som finns i shibboleth-identity-provider-4.0.1/webapp/WEB-INF för att kontrollera att din web.xml under edit-webapp är korrekt och aktuell.
Kör uppgradering av Shibboleth:
# cd /opt # rm shibboleth-identity-provider # ln -s shibboleth-identity-provider-4.0.1 shibboleth-identity-provider # cd shibboleth-identity-provider # bin/install.sh
Starta Jetty
# service jetty start
Kontrollera jetty loggar om någonting inte fungerar. Kontrollera sedan idp-process.log för att hitta eventuella problem med IdPn. Testa med https://release-check.swamid.se