Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This article describes how to upgrade Smart ID Certificate Manager to the latest version. For all other upgrade paths, contact Nexus.

...

Note

8.4.0 was replaced by 8.4.1. For more information, see Release note Certificate Manager 8.4.1

Prerequisites

title
Expand

Prerequisites

The following prerequisites apply: 

...

  • Use the files in the folder Upgrade/Upgrade from CM x.x.x to x.x.x.

See an example here:
Info
titleExample

To upgrade from 8.3.0 to 8.7.1, use the files in the following folders in sequence:

  1. Upgrade from CM 8.3.x to 8.4.1
  2. Upgrade from CM 8.4.x to 8.5.0 
  3. Upgrade from CM 8.5.x to 8.6.1
  4. Upgrade from CM 8.6.x to 8.7.1


Step-by-step instruction

1. Upgrade database

...

titleUpgrade database

Database scripts for MSSQL, MySQL, PostgreSQL, Oracle, MariaDB, and AzureSQL are often included in the delivery of Certificate Manager. Some releases do not include database scripts to run due to no updates in the databases. The following applies: 

  • If there are no scripts included in the release bundle, go to the next step in this upgrade instruction (Upgrade Certificate Manager services).
  • If there are scripts included in the release bundle, run all included scripts. 
Info
titleSelect version

Make sure to select the specific script for the upgrade. You must run each DB script from the start version to the target version in sequence.

The script examples below displays x_x_x as a reference to the CM version number that you are upgrading to. 


Note
titleException: Upgrade from 7.18.x to 8.0.0

Support for the Oracle database version 11g has been removed in version 8.0.0 of Certificate Manager due to EOL. If you use Oracle 11g, you must upgrade before you proceed with the steps below. 


Do the following:

  1. To upgrade the CMDB (Certificate Manager Database), run the appropriate script in the MSSQL Server Management Studio, MySQL client, Oracle SQLPlus, or PostgreSQL client

...

  1. .

  2. Verify that no errors occurred.
DatabaseScriptComment
MSSQLdatabase/CMDBUpgrade_MSSQL_x_x_x.sql

...

...

titleImportant note!

The following applies: 

  • If there are no scripts included in the release bundle, go to the next step in this upgrade instruction (Upgrade Certificate Manager services).
  • If there are scripts included in the release bundle, run all included scripts. 


MySQLdatabase/CMDBUpgrade_MySQL_x_x_x.sql
Oracledatabase/CMDBUpgrade_Oracle_x_x_x.sql
PostgreSQLdatabase/CMDBUpgrade_PostgreSQL_x_x_x.sql
MariaDBdatabase/CMDBUpgrade_MariaDB_x_x_x.sqlStarting from 8.2.x to 8.3.0, you must run the database script for MariaDB.
AzureSQLdatabase/CMDBUpgrade_AzureSQL_x_x_x.sqlStarting from 8.6.x to 8.7.0, you must run the database script for AzureSQL.

...

Verify that no errors occurred.


2. Upgrade Certificate Manager services

...

Prerequisites
Info
titleFinal upgrade step - the lib, bin, and tool folders

The lib, bin, and tool folders should always be postponed until the last step of the upgrade procedure to enable a successful upgrade to the latest version. Starting the system while upgrading may lead to error, such as corrupted data or failure to use the system.

Expand
title

Before you start, make sure to:


Updated license file required

CM 8.x requires an updated license file in order to start. License files issued for CM 7.x cannot be used for CM 8.x. Place the updated license file in the directory <cm-server-home>/license/.

 

Expand
titleFrom 7.18.x to 8.0.0
  1. Make a backup copy of these folders before applying any changes:

    1. <cm-server-home>/config

    2. <cm-server-home>/lib

  2. On the server(s) running the Nexus CF, Nexus CIS, or Nexus SNMP services:

    1. Do the configuration changes in <cm-server-home>/config/ described in the respective files under the <server> folder.

    2. Remove the following files from <cm-server-home>/config:
      • requestformats/httpclient.conf
      • http.conf
  3. The suggested default log levels for CM-SNMP has been reduced from FINEST to INFO. If you use CM-SNMP and want to change to the new default values, change this in the file <cm-server-home>/config/snmplog.properties.
  4. The following deprecated modifiers have been replaced or removed. If you use customized format files, make sure that none of the deprecated modifiers are used.
    1. These deprecated modifiers have been replaced:
      • SubjectKeyIdAdder > SubjectKeyIdentifierModifier
      • ScepUniqueness > RenewalAllowed
      • AltNameModifier > SubjectAltNameModifier
    2. These deprecated modifiers have been removed:
      • CheckCertWithSubject
      • CisFailoverModifier
      • DynamicValidity
      • InputStringBoundChecker
      • MonetaryLimitAttributeModifier
      • PublicKeyHash
      • RelativeValidity
      • ScepUniqueness
      • SubjectIdentifierSs
Note
title


Expand
titleFrom 8.0.x to 8.1.0
  1. Make a backup copy of these folders before applying any changes:

    1. <cm-server-home>/config

    2. <cm-server-home>/lib

  2. On the server(s) running the Nexus CF, Nexus CIS or Nexus SNMP services:

    1. Do the configuration changes in <cm-server-home>/config/ described in the respective files under the <server> folder.

      note

       
      Note the important changes described in the file changes-formats.txt. The file is located here: <Upgrade\Upgrade from CM 8.0.x to 8.1.0\server>.

      The tool used in changes-formats.txt requires updated lib files. Therefore those instructions should be executed after the new jar files has been replace in the final upgrade instruction.

    2. From Upgrade files CM 8.1.0/server/inputviews, add the following files to <cm-server-home>/inputviews, or replace if any of these files already exist:
      • acme-account-reg-search.conf
      • acme-prereg-search.conf
      • countries.conf
      • device-cert-registration.conf
      • estsecretsearch.conf

...

Expand
titleFrom 8.4.x to 8.5.0
  1. Make a backup copy of these folders before applying any changes:

    1. <cm-server-home>/config

    2. <cm-server-home>/lib

    3. <cm-server-home>/bin

    4. <cm-server-home>/deliverynotes
  2. Do the configuration changes in <cm-server-home>/config/ described in the respective files under the <server> folder.

    note

     
    Depending on which 8.4.x version you are currently on, some of the changes may already have been performed as part of an earlier upgrade.

  3. On the servers running the Nexus CF, Nexus CIS or Nexus SNMP service, remove all jar files in the <cm-server-home>/lib folder.
  4. Start the Nexus CIS, CF and SNMP services.

...

Expand
titleFrom 8.5.x to 8.6.1
  1. Make a backup copy of these folders before applying any changes:

    1. <cm-server-home>/config

    2. <cm-server-home>/lib

    3. <cm-server-home>/bin

    4. <cm-server-home>/deliverynotes
  2. Do the configuration changes in <cm-server-home>/config/ described in the respective files under the <server> folder.

    note


Depending on which 8.5.x version you are currently on, some of the changes may already have been performed as part of an earlier upgrade.

note

The ability to manually build CRLs and CILs has been moved from the officer role "Use AWB" to its own role in "Manual build of CRL and CIL". As such, if you have officers that should be able to perform manual builds of CXLs, then their officer profiles will need to be updated.


When you upgrade CM from 8.6.x to 8.7.1, execute only the database script in the folder "Upgrade from CM 8.6.x to 8.7.0" in the release bundle.

Do not use the script in the folder "Upgrade from CM 8.7.0 to 8.7.1"

  1. Make a backup copy of these folders before applying any changes:
    1. <cm-server-home>/config

    2. <cm-server-home>/lib

    3. <cm-server-home>/bin

    4. <cm-server-home>/deliverynotes
  2. Do the configuration changes in <cm-server-home>/config/ described in the respective files under the <server> folder.

Certificate Manager v8

From 8.7.0 to 8.7.1

Important! Certificate Manager version 8.7.0 is no longer available on Nexus support portal

. From 8.7.0 to 8.7

.

1

  1. Make a backup copy of these folders before applying any changes:

    1. <cm-server-home>/config

    2. <cm-server-home>/lib

    3. <cm-server-home>/bin

    4. <cm-server-home>/deliverynotes
  2. Do the configuration changes on the server(s) running the Nexus CF, Nexus SNMP and Nexus CIS service in: <cm-server-home>/config/  and <cm-server-home>/inputviews/ described in the respective files under the <server> folder.
    From Upgrade files CM 8.7.1/server/inputviews, add the following file to <cm-server-home>/inputviews:

    • kerberos-pkinit-san.conf

  3. Rename any custom formats files used by Certificate Manager that has a filename that begins with  the "_" character to something the does not begin with the "_" character. The reason for this is that formats starting with "_" will not be loaded.
Expand
titleFrom 8.6.x to 8.7.1
Note
titleDatabase script usage
Note
title

...

Depending on which 8.7.x version you are currently on, some of the changes may already have been performed as part of an earlier upgrade.

  1. From Upgrade files CM 8.9.0/server/inputviews, add the following files to <cm-server-home>/inputviews:

    •  v2x-enroll-enabling-registration.conf

    • kerberos-pkinit-san.conf

  2.  From Upgrade files CM 8.9.0/server/config, add the following file to <cm-server-home>/config:

    • rapcacsv2.conf

  • Rename any custom formats files used by Certificate Manager that has a filename that begins with  the "_" character to something the does not begin with the "_" character. The reason for this is that formats starting with "_" will not be loaded.
  • Only for upgrades coming from earlier that 8.1.x: Run any steps that may have been postponed in earlier steps, such as those required for "copycacerts" when upgrading from CM 7.17.x or those in changes-format.txt when upgrading from CM 8.0.x.

  • Expand
    titleFrom 8.7.x to 8.8.0
    1. Make a backup copy of these folders before applying any changes:

      1. <cm-server-home>/config

      2. <cm-server-home>/lib

      3. <cm-server-home>/bin

      4. <cm-server-home>/deliverynotes
    2. Do the configuration changes on the server(s) running the Nexus CF, Nexus SNMP and Nexus CIS service in: <cm-server-home>/config/  and <cm-server-home>/inputviews/ described in the respective files under the <server> folder.

    Note

    ...

    Expand
    titleFrom 7.18.x to 8.0.0

    The directory containing user-specific settings has moved. These settings include the list of favorite CM servers, the trust store for the server TLS certificates, selected columns in various GUI elements, and other client-specific settings.

    To keep the settings from a previous client installation, move the following directories to the new location:

    On Windows:

    • Previously : %USERPROFILE%\CertificateManager
    • New location: %APPDATA%\Nexus\CertificateManager

    On Linux:

    • Previously : ~/CertificateManager
    • New location: ~/.config/certificatemanager


    Expand
    titleUpgrade CM clients

    Do the following:

    1. Shut down all the Certificate Manager clients.

    2. Make sure Java SE 17 is installed and set as default Java on the system. Certificate Manager clients can be run on both 32-bit and 64-bit JDKs with the following limitations:

      1. Linux:
        64-bit Java is required in order to use clients with Personal.

      2. Windows:
        After the upgrade, if a javaw.exe binary exists under the C:\Windows\SysWOW64 folder, clients will continue to run on 32-bit Java even if default JDK is 64-bit. Remove this binary (and javaws.exe, java.exe) in order to run the clients on 64-bit Java.

    3. Backup the <cm-client-home>/config folder.

    4. Uninstall the Certificate Manager clients components, see Uninstall Certificate Manager server components and clients

      1. On Windows use "Programs and Features" to uninstall "Certificate Manager Clients Components".
      2. On Linux, run <cm-client-home>/install/setup.sh -u.
    5. Remove any remaining hotfix jar files in the <cm-client-home>/lib folder.

      1. On Linux, if there is a <cm-client-home>/P11 folder, backup any config file with customizations to Personal Desktop Client and then delete the folder.

    6. Install the new version of the clients, included in the delivery of Certificate Manager.

    7. Apply any customizations to the new configuration files in the <cm-client-home>/config folder.

    note

    The officer role "Use AWB" is now used for read-only access to the AWB and no longer has permission to do manual builds of CRLs and CILs. Instead, the role "Manual build of CRL and CIL" is needed to perform manual builds.

    The officer profile that was previously used by the officer that performed manual builds must now be modified to include the role "Manual build of CRL and CIL".

    4. Upgrade Certificate Manager Protocol Gateway

    See Upgrade Protocol Gateway

    ...

    title
    Expand
    titleUpgrade Certificate Manager SDK
    Note

    Exception when upgrading from 7.18.x

    When upgrading from 7.18.x to 8.0.0, many deprecated methods have been removed from the CM SDK. See changes-cmsdk.txt in the <Upgrade/Upgrade from CM 7.18.x to 8.0.0/client> folder.

    1. Shut down all applications that are using the CM SDK except for CMWS and PGW.

    2. Backup the library folder of the CM SDK application.

    3. Remove the CM hotfix jar files in the library folder of the CM SDK application folder that adhere to the following patterns:

      • a-*.jar

      • aa*.jar

    4. Replace the jar files in the library folder of the CM SDK application with the supplied files in Upgrade files CM x.x.x/sdk/lib.

    ...