Migration from 0.23.0 to 0.24.0

This guide contains instructions for migration from PowerAuth Server version 0.23.0 to version 0.24.0.

Bouncy Castle Library Update to Version 1.65

Bouncy Castle library has been updated to version 1.65. The newest version of Bouncy Castle library can be downloaded from: https://www.bouncycastle.org/download/bcprov-jdk15on-165.jar

Installation on Java 8:

• Update Bouncy Castle library the lib/ext folder of the Java runtime

Installation on Java 11:

• Tomcat: update Bouncy Castle library in CATALINA_HOME/lib
• JBoss / Wildfly: update Bouncy Castle library global module
• Other web containers: follow instructions for installing a global library for the web container
• Standalone mode: PowerAuth Server can no longer be started from command line because of missing Bouncy Castle library in the war file. Contact us if you want to run PowerAuth Server in standalone mode.

For more details about installation of the library see Installing Bouncy Castle.

Database Changes

Following DB changes occurred between version 0.23.0 and 0.24.0:

• Table pa_activation - added columns device_info, platform, activation_otp, activation_otp_validation.
• Table pa_activation_history - renamed column blocked_reason to event_reason.

Migration script for Oracle:

ALTER TABLE "PA_ACTIVATION" ADD "PLATFORM" VARCHAR2(255 CHAR);
ALTER TABLE "PA_ACTIVATION" ADD "DEVICE_INFO" VARCHAR2(255 CHAR);
ALTER TABLE "PA_ACTIVATION" ADD "ACTIVATION_OTP" VARCHAR2(255 CHAR);
ALTER TABLE "PA_ACTIVATION" ADD "ACTIVATION_OTP_VALIDATION" NUMBER(2,0) DEFAULT 0 NOT NULL;
ALTER TABLE "PA_ACTIVATION_HISTORY" RENAME COLUMN "BLOCKED_REASON" TO "EVENT_REASON";

Migration script for MySQL:

ALTER TABLE `pa_activation` ADD `platform` varchar(255);
ALTER TABLE `pa_activation` ADD `device_info` varchar(255);
ALTER TABLE `pa_activation` ADD `activation_otp` varchar(255);
ALTER TABLE `pa_activation` ADD `activation_otp_validation` int DEFAULT 0 NOT NULL;
ALTER TABLE `pa_activation_history` CHANGE COLUMN `blocked_reason` `event_reason` varchar(255);

Migration script for PostgreSQL:

ALTER TABLE "pa_activation" ADD "platform" VARCHAR(255);
ALTER TABLE "pa_activation" ADD "device_info" VARCHAR(255);
ALTER TABLE "pa_activation" ADD "activation_otp" VARCHAR(255);
ALTER TABLE "pa_activation" ADD "activation_otp_validation" INTEGER DEFAULT 0 NOT NULL;
ALTER TABLE "pa_activation_history" RENAME COLUMN "blocked_reason" TO "event_reason";

Service Interface Changes

PowerAuth server in version 0.24.0 slightly changed SOAP interface for protocol version 3 (namespace http://getlime.io/security/powerauth/v3):

Activation Status Enumeration Change

The ActivationStatus.OTP_USED enumeration was renamed to ActivationStatus.PENDING_COMMIT. This change was done to avoid a terminology clash with the new Activation OTP feature. In case you call the PowerAuth Server web service methods directly, make sure to rebuild the web service client code with updated model classes.

Support for Additional Activation OTP

• Added new enumeration ActivationOtpValidation with following values:
  • NONE – no additional OTP validation is required during the activation.
  • ON_KEY_EXCHANGE – an additional OTP is validated during the key exchange activation phase.
  • ON_COMMIT – an additional OTP is validated during the activation commit phase.
• InitActivationRequest request object has now optional activationOtp and activationOtpValidation properties.
• PrepareActivationResponse response object now contains activationStatus property that contains the current status of the activation.
• CreateActivationRequest request object has now optional activationOtp property.
• CommitActivationRequest request object has now optional activationOtp property.
• RecoveryCodeActivationRequest request object has now optional activationOtp property.
• GetActivationStatusResponse response object now contains new activationOtpValidation, platform and deviceInfo properties.
• UpdateActivationOtp is a new SOAP API method with UpdateActivationOtpRequest and UpdateActivationOtpResponse objects.
• ActivationHistoryResponse request object has blockedReason property renamed to eventReason. The property now contains also reasons unrelated to the activation block.

Check Additional Activation OTP document for more details.

Revoking Recovery Codes on Activation Removal

We added an optional revokeRecoveryCodes attribute to activation removal service call. This flag indicates if recovery codes that are associated with removed activation should be also revoked. By default, the value of the flag is false, hence omitting the flag results in the same behavior as before this change.

RESTful integration Changes

PowerAuth restful integration libraries in version 0.24.0 have the following important changes:

• It’s now possible to auto-commit activation when it’s created with using the regular activation code. So, your implementation of CustomActivationProvider must be prepared that shouldAutoCommitActivation() method can receive CODE as a new supported type of activation.