Allow CA Renewals parameter setter must be called to initialize KeyManagerService class

Problem:

After upgrading Key Manager to v20.16, you may encounter an issue where the Key Manager does not start. In the logs you may see the following message:

ERROR [org.springframework.boot.SpringApplication] (main) Application run failed
org.springframework.beans.factory.BeanCreationException: Error creating bean with
name 'keyManagerAppServletContext': Invocation of init method failed; nested exception
is com.symphony.security.v2.exceptions.KeyManagerException: 'Allow CA Renewals' parameter
setter must be called to initialize KeyManagerService class

Resolution:

  • Add the "allowRenewals" property to the keymanager_config.json file under the relay section.
{
"relay": {
...
"allowRenewals": false
}
}

While required in v20.16, the property is not in use and can be safely set to "false". The property will be removed starting from the v20.17 release.