CodeSign Secure Documentation
  • Overview
    • About CodeSign Secure
    • Getting Started
    • Documentation Guide
    • Portal Overview
    • Troubleshooting
      • FAQ
    • Glossary
  • Reference Guide
    • Header Bar
      • CodeSign Secure Documentation
      • Swagger API
      • Profile Section
    • Dashboard
      • Key Performance Indicators
      • Issued Certificates
      • Signatures Generated
      • HSM Health Check
    • Keys and Certificates
      • Key and Certificate Lifecycle
    • App Management
    • Signing Requests
      • Approval Workflows
    • Signing Tools
    • Reports
      • Signing Request Report
      • Audit Trail
      • Certificate Report
      • Client Report
    • Logs
    • System Setup
      • Identity Store
      • Backup
      • User
      • Roles and Permissions
      • Email
      • Signing Projects
      • SSL/TLS Management
      • Environment
      • Plugins
  • Setup & Architecture
    • Identity and Access Control
    • Architecture and Concepts
    • Installation
      • Windows
        • Installing the Server
        • Ports and Protocols
        • High Availability and Backup
        • Upgrades and Compatibility
    • Security
      • Security Hardening Checklist
      • Client Authentication
      • Designing Signing Policies
  • Release Notes
    • Releases for 2026
      • v3.2.1
    • Releases for 2025
      • v3.2.0
    • Releases for 2024
      • v3.1.0
  • API Reference
    • Getting Started
    • Authorizing Requests
    • Securing API Access
    • Request and Response Conventions
    • Endpoint Reference
      • Signing
      • Signing Requests
      • Certificates
      • Applications and Environments
      • User Management
      • Permissions
      • Email
      • System Setup
      • Reports
      • Dashboard
      • License
  • Integration Guides
    • Signing Capabilities
      • Supported Formats and Platforms
      • Timestamping
      • Windows Signing - SignTool
        • Signing
        • Macro Signing
      • Apple Signing
      • AppX & MSIX Signing
      • Visual Studio ClickOnce
      • Jar Signing
      • Sign HLK/HCK using CodeSign Secure
      • NuGet Signing
      • Mage Signing
      • Sign OVA/OVF using Encryption Consulting’s Utility Tool
      • Utility Tool for code signing
      • Container Signing
      • PKCS11 Wrapper
        • APK Signing
        • OpenSSL Signing
        • XML Signing
        • JSign Tool Signing
        • Jarsigner Signing
        • GPG2, Debian & RPM Signing
      • Reproducible Build
        • Automated Hash Validation
        • Reproducible Build Process Flow
        • Pipeline Script Components
        • Hash Validation
    • CI/CD Integration
      • GitHub Actions
      • Jenkins
      • GitLab
      • Azure DevOps
      • TeamCity
      • Bamboo
      • Securing CI/CD Credentials

Upgrades and Version Compatibility

Find out which version you run, prepare for an upgrade, and keep client tools in step with the server.

Find the installed version

Hover over the version in the profile menu of the header bar to see the product version. The portal footer shows the frontend and backend versions. For release 3.02.01, the versions are:

ComponentVersion
Product3.02.01
Backend3.02.01
Frontend3.03.01
Before you upgrade
  • Read the Release Notes for every version between yours and the target version.

  • Create a backup, download it, and store it off the server. See Backup.

  • Confirm that your HSM backup is current.

  • Record the current product, frontend and backend versions.

  • Plan a maintenance window. Signing is unavailable while the server restarts.

  • Tell approvers and pipeline owners when signing will be unavailable, and pause automated pipelines.

Upgrade the server

Encryption Consulting provides the upgrade package and the step-by-step procedure for each release. Contact support before you start, and don’t run a new installer over an existing installation unless the release instructions tell you to.

After you upgrade
  • Sign in and check the version shown in the profile menu and the footer.

  • Check that HSM Health Check is Active.

  • Download the client tools again from Signing Tools and update your build machines.

  • Run a test signing with each client tool you use, then resume pipelines.

Client tool compatibility

Use the client tools published with your server release, which are the ones on your own server’s Signing Tools page. After a server upgrade, update the KSP, EC KSP for Mac, PKCS#11 Wrapper, Utility Tool and ec-signer on your build machines.

Notes for upgrading to 3.02.01
  • The PKCS#11 Wrapper now caches the signing key and can take the key label from an environment variable or the configuration file. No configuration change is required, because automatic key label detection stays on by default. See PKCS#11 Wrapper.

On this Page:
Support Privacy Policy Terms of Service

Copyright Encryption Consulting LLC. All rights reserved.