Merge develop to master

docs/Migration-Instructions.md

@@ -2,6 +2,7 @@
 
 This page contains PowerAuth Push Server migration instructions.
 
+- [PowerAuth Push Server 1.9.0](./PowerAuth-Push-Server-1.9.0.md)
 - [PowerAuth Push Server 1.8.0](./PowerAuth-Push-Server-1.8.0.md)
 - [PowerAuth Push Server 1.7.0](./PowerAuth-Push-Server-1.7.0.md)
 - [PowerAuth Push Server 1.6.0](./PowerAuth-Push-Server-1.6.0.md)

docs/PowerAuth-Push-Server-1.7.0.md

@@ -5,6 +5,14 @@ This guide contains instructions for migration from PowerAuth Push Server versio
 
 ## Database Changes
 
+For convenience, you can use liquibase for your database migration.
+
+If you prefer to make manual DB schema changes, please use the following SQL scripts:
+
+- [PostgreSQL script](./sql/postgresql/migration_1.6.0_1.7.0.sql)
+- [Oracle script](./sql/oracle/migration_1.6.0_1.7.0.sql)
+- [MSSQL script](./sql/mssql/migration_1.6.0_1.7.0.sql)
+
 
 ### Huawei Mobile Services
 

docs/PowerAuth-Push-Server-1.9.0.md

@@ -0,0 +1,5 @@
+# Migration from 1.8.x to 1.9.x
+
+This guide contains instructions for migration from PowerAuth Push Server version `1.8.x` to version `1.9.x`.
+
+No migration steps nor database changes are required.

docs/sql/mssql/migration_1.6.0_1.7.0.sql

@@ -0,0 +1,19 @@
+-- Changeset powerauth-push-server/1.7.x/20240119-push_app_credentials-hms.xml::1::Lubos Racansky
+-- Add hms_project_id, hms_client_id, and hms_client_secret columns to push_app_credentials
+ALTER TABLE push_app_credentials ADD hms_project_id varchar(255);
+GO
+
+ALTER TABLE push_app_credentials ADD hms_client_id varchar(255);
+GO
+
+ALTER TABLE push_app_credentials ADD hms_client_secret varchar(255);
+GO
+
+IF EXISTS( SELECT extended_properties.value FROM sys.extended_properties WHERE major_id = OBJECT_ID('dbo.push_app_credentials') AND name = N'MS_DESCRIPTION' AND minor_id = ( SELECT column_id FROM sys.columns WHERE name = 'hms_project_id' AND object_id = OBJECT_ID('dbo.push_app_credentials')) ) BEGIN EXEC sys.sp_updateextendedproperty @name = N'MS_Description' , @value = N'Project ID defined in Huawei AppGallery Connect.' , @level0type = N'SCHEMA' , @level0name = N'dbo' , @level1type = N'TABLE' , @level1name = N'push_app_credentials' , @level2type = N'COLUMN' , @level2name = N'hms_project_id' END ELSE BEGIN EXEC sys.sp_addextendedproperty @name = N'MS_Description' , @value = N'Project ID defined in Huawei AppGallery Connect.' , @level0type = N'SCHEMA' , @level0name = N'dbo' , @level1type = N'TABLE' , @level1name = N'push_app_credentials' , @level2type = N'COLUMN' , @level2name = N'hms_project_id' END;
+GO
+
+IF EXISTS( SELECT extended_properties.value FROM sys.extended_properties WHERE major_id = OBJECT_ID('dbo.push_app_credentials') AND name = N'MS_DESCRIPTION' AND minor_id = ( SELECT column_id FROM sys.columns WHERE name = 'hms_client_id' AND object_id = OBJECT_ID('dbo.push_app_credentials')) ) BEGIN EXEC sys.sp_updateextendedproperty @name = N'MS_Description' , @value = N'Huawei OAuth 2.0 Client ID.' , @level0type = N'SCHEMA' , @level0name = N'dbo' , @level1type = N'TABLE' , @level1name = N'push_app_credentials' , @level2type = N'COLUMN' , @level2name = N'hms_client_id' END ELSE BEGIN EXEC sys.sp_addextendedproperty @name = N'MS_Description' , @value = N'Huawei OAuth 2.0 Client ID.' , @level0type = N'SCHEMA' , @level0name = N'dbo' , @level1type = N'TABLE' , @level1name = N'push_app_credentials' , @level2type = N'COLUMN' , @level2name = N'hms_client_id' END;
+GO
+
+IF EXISTS( SELECT extended_properties.value FROM sys.extended_properties WHERE major_id = OBJECT_ID('dbo.push_app_credentials') AND name = N'MS_DESCRIPTION' AND minor_id = ( SELECT column_id FROM sys.columns WHERE name = 'hms_client_secret' AND object_id = OBJECT_ID('dbo.push_app_credentials')) ) BEGIN EXEC sys.sp_updateextendedproperty @name = N'MS_Description' , @value = N'Huawei OAuth 2.0 Client Secret.' , @level0type = N'SCHEMA' , @level0name = N'dbo' , @level1type = N'TABLE' , @level1name = N'push_app_credentials' , @level2type = N'COLUMN' , @level2name = N'hms_client_secret' END ELSE BEGIN EXEC sys.sp_addextendedproperty @name = N'MS_Description' , @value = N'Huawei OAuth 2.0 Client Secret.' , @level0type = N'SCHEMA' , @level0name = N'dbo' , @level1type = N'TABLE' , @level1name = N'push_app_credentials' , @level2type = N'COLUMN' , @level2name = N'hms_client_secret' END;
+GO

docs/sql/oracle/migration_1.6.0_1.7.0.sql

@@ -0,0 +1,13 @@
+-- Changeset powerauth-push-server/1.7.x/20240119-push_app_credentials-hms.xml::1::Lubos Racansky
+-- Add hms_project_id, hms_client_id, and hms_client_secret columns to push_app_credentials
+ALTER TABLE push_app_credentials ADD hms_project_id VARCHAR2(255);
+
+ALTER TABLE push_app_credentials ADD hms_client_id VARCHAR2(255);
+
+ALTER TABLE push_app_credentials ADD hms_client_secret VARCHAR2(255);
+
+COMMENT ON COLUMN push_app_credentials.hms_project_id IS 'Project ID defined in Huawei AppGallery Connect.';
+
+COMMENT ON COLUMN push_app_credentials.hms_client_id IS 'Huawei OAuth 2.0 Client ID.';
+
+COMMENT ON COLUMN push_app_credentials.hms_client_secret IS 'Huawei OAuth 2.0 Client Secret.';

docs/sql/postgresql/migration_1.6.0_1.7.0.sql

@@ -0,0 +1,13 @@
+-- Changeset powerauth-push-server/1.7.x/20240119-push_app_credentials-hms.xml::1::Lubos Racansky
+-- Add hms_project_id, hms_client_id, and hms_client_secret columns to push_app_credentials
+ALTER TABLE push_app_credentials ADD hms_project_id VARCHAR(255);
+
+ALTER TABLE push_app_credentials ADD hms_client_id VARCHAR(255);
+
+ALTER TABLE push_app_credentials ADD hms_client_secret VARCHAR(255);
+
+COMMENT ON COLUMN push_app_credentials.hms_project_id IS 'Project ID defined in Huawei AppGallery Connect.';
+
+COMMENT ON COLUMN push_app_credentials.hms_client_id IS 'Huawei OAuth 2.0 Client ID.';
+
+COMMENT ON COLUMN push_app_credentials.hms_client_secret IS 'Huawei OAuth 2.0 Client Secret.';

pom.xml

@@ -8,13 +8,13 @@
 
  <groupId>io.getlime.security</groupId>
  <artifactId>powerauth-push-server-parent</artifactId>
- <version>1.8.0</version>
+ <version>1.9.0-SNAPSHOT</version>
  <packaging>pom</packaging>
 
  <parent>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-parent</artifactId>
- <version>3.3.2</version>
+ <version>3.3.4</version>
  <relativePath/> <!-- lookup parent from repository -->
  </parent>
 
@@ -69,22 +69,20 @@
 
  <properties>
  <!-- Wultra Dependencies -->
- <wultra-core.version>1.10.0</wultra-core.version>
- <powerauth.version>1.8.0</powerauth.version>
- <powerauth-crypto.version>1.8.0</powerauth-crypto.version>
- <powerauth-restful-integration.version>1.8.0</powerauth-restful-integration.version>
+ <wultra-core.version>1.11.0</wultra-core.version>
+ <powerauth.version>1.9.0-SNAPSHOT</powerauth.version>
+ <powerauth-crypto.version>1.9.0-SNAPSHOT</powerauth-crypto.version>
+ <powerauth-restful-integration.version>1.9.0-SNAPSHOT</powerauth-restful-integration.version>
 
  <!-- Library Versions -->
  <pushy.version>0.15.4</pushy.version>
- <google-api-client.version>2.6.0</google-api-client.version>
+ <google-api-client.version>2.7.0</google-api-client.version>
  <firebase-admin.version>9.3.0</firebase-admin.version>
- <logstash.version>7.4</logstash.version>
+ <logstash.version>8.0</logstash.version>
 
  <!-- Documentation Dependencies -->
  <springdoc-openapi-starter-webmvc-ui.version>2.6.0</springdoc-openapi-starter-webmvc-ui.version>
- <swagger-annotations-jakarta.version>2.2.22</swagger-annotations-jakarta.version>
-
- <maven-javadoc-plugin.version>3.5.0</maven-javadoc-plugin.version>
+ <swagger-annotations-jakarta.version>2.2.25</swagger-annotations-jakarta.version>
  </properties>
 
  <dependencyManagement>
@@ -161,10 +159,38 @@
  </execution>
  </executions>
  </plugin>
+
+ <plugin>
+ <groupId>org.projectlombok</groupId>
+ <artifactId>lombok-maven-plugin</artifactId>
+ <version>1.18.20.0</version>
+ <dependencies>
+ <dependency>
+ <groupId>org.projectlombok</groupId>
+ <artifactId>lombok</artifactId>
+ <version>${lombok.version}</version>
+ </dependency>
+ </dependencies>
+ <configuration>
+ <outputDirectory>${project.build.directory}/delombok</outputDirectory>
+ <sourceDirectory>${project.basedir}/src/main/java</sourceDirectory>
+ <addOutputDirectory>false</addOutputDirectory>
+ </configuration>
+ <executions>
+ <execution>
+ <phase>generate-sources</phase>
+ <goals>
+ <goal>delombok</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+
  <plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-javadoc-plugin</artifactId>
  <configuration>
+ <sourcepath>${project.build.directory}/delombok</sourcepath>
  <failOnError>false</failOnError>
  </configuration>
  <executions>

powerauth-push-client/pom.xml

@@ -10,7 +10,7 @@
  <parent>
  <artifactId>powerauth-push-server-parent</artifactId>
  <groupId>io.getlime.security</groupId>
- <version>1.8.0</version>
+ <version>1.9.0-SNAPSHOT</version>
  </parent>
 
  <dependencies>

powerauth-push-model/pom.xml

@@ -11,7 +11,7 @@
  <parent>
  <artifactId>powerauth-push-server-parent</artifactId>
  <groupId>io.getlime.security</groupId>
- <version>1.8.0</version>
+ <version>1.9.0-SNAPSHOT</version>
  </parent>
 
  <dependencies>

powerauth-push-server/pom.xml

@@ -11,7 +11,7 @@
  <parent>
  <groupId>io.getlime.security</groupId>
  <artifactId>powerauth-push-server-parent</artifactId>
- <version>1.8.0</version>
+ <version>1.9.0-SNAPSHOT</version>
  </parent>
 
  <dependencyManagement>

powerauth-push-server/src/main/java/io/getlime/push/service/PushMessageSenderService.java

@@ -261,16 +261,24 @@ private AppCredentialsEntity getAppCredentials(String appId) throws PushServerEx
  }
 
  // Return list of devices related to given user or activation ID (if present). List of devices is related to particular application as well.
- private List<PushDeviceRegistrationEntity> getPushDevices(Long id, String userId, String activationId) throws PushServerException {
+ private List<PushDeviceRegistrationEntity> getPushDevices(Long appCredentialsId, String userId, String activationId) throws PushServerException {
  if (userId == null || userId.isEmpty()) {
  logger.error("No userId was specified");
  throw new PushServerException("No userId was specified");
  }
+
+ final List<PushDeviceRegistrationEntity> devices;
  if (activationId != null) { // in case the message should go to the specific device
- return pushDeviceRepository.findByUserIdAndAppCredentialsIdAndActivationId(userId, id, activationId);
+ devices = pushDeviceRepository.findByUserIdAndAppCredentialsIdAndActivationId(userId, appCredentialsId, activationId);
  } else {
- return pushDeviceRepository.findByUserIdAndAppCredentialsId(userId, id);
+ devices = pushDeviceRepository.findByUserIdAndAppCredentialsId(userId, appCredentialsId);
+ }
+
+ if (devices.isEmpty()) {
+ logger.warn("No device found for userId={}, appCredentialsId={}, activationId={}", userId, appCredentialsId, activationId);
  }
+
+ return devices;
  }
 
  // Prepare and cache APNS, FCM, and HMS clients for provided app

powerauth-push-server/src/test/java/io/getlime/push/client/PowerAuthTestClientRest.java

@@ -137,7 +137,7 @@ public String createActivation(String userId) throws Exception {
  byte[] applicationSecretBytes = applicationSecret.getBytes(StandardCharsets.UTF_8);
 
  final String protocolVersion = "3.1";
- final EncryptorParameters encryptorParameters = new EncryptorParameters(protocolVersion, applicationKey, null);
+ final EncryptorParameters encryptorParameters = new EncryptorParameters(protocolVersion, applicationKey, null, null);
  final ClientEncryptorSecrets encryptorSecrets = new ClientEncryptorSecrets(masterPK, applicationSecretBytes);
  final ClientEncryptor clientEncryptor = encryptorFactory.getClientEncryptor(EncryptorId.ACTIVATION_LAYER_2, encryptorParameters, encryptorSecrets);
  final ByteArrayOutputStream baosL2 = new ByteArrayOutputStream();

powerauth-push-server/src/test/java/io/getlime/push/controller/MockPowerAuthController.java

@@ -94,6 +94,8 @@ public ObjectResponse<GetApplicationDetailResponse> getApplicationDetail() {
  public ObjectResponse<GetActivationStatusResponse> getActivationStatus(@RequestBody ObjectRequest<GetActivationStatusRequest> request) {
  final GetActivationStatusResponse response = new GetActivationStatusResponse();
  response.setActivationId(request.getRequestObject().getActivationId());
+ response.setUserId(PushServerTestClientFactory.TEST_USER_ID);
+
  if (blockedActivations.contains(request.getRequestObject().getActivationId())) {
  response.setActivationStatus(ActivationStatus.BLOCKED);
  } else {

powerauth-push-server/src/test/java/io/getlime/push/tests/PushServerTests.java

@@ -164,63 +164,69 @@ void updateDeviceStatusTest() throws Exception {
  }
 
  @Test
- @SuppressWarnings("unchecked") //known parameters of HashMap
  void sendPushMessageTest() throws Exception {
- boolean result = pushServerClient.createDevice(powerAuthTestClient.getApplicationId(), MOCK_PUSH_TOKEN, MobilePlatform.ANDROID, powerAuthTestClient.getActivationId());
+ final boolean result = pushServerClient.createDevice(powerAuthTestClient.getApplicationId(), MOCK_PUSH_TOKEN, MobilePlatform.ANDROID, powerAuthTestClient.getActivationId());
  assertTrue(result);
- PushMessage pushMessage = new PushMessage();
- PushMessageAttributes attributes = new PushMessageAttributes();
- PushMessageBody pushMessageBody = new PushMessageBody();
+
+ final PushMessageAttributes attributes = new PushMessageAttributes();
+ attributes.setSilent(false);
+ attributes.setPersonal(true);
+
+ final PushMessageBody pushMessageBody = new PushMessageBody();
  pushMessageBody.setTitle("Balance update");
  pushMessageBody.setBody("Your balance is now $745.00");
  pushMessageBody.setBadge(3);
  pushMessageBody.setSound("riff.wav");
  pushMessageBody.setCategory("balance-update");
  pushMessageBody.setCollapseKey("balance-update");
  pushMessageBody.setValidUntil(Instant.now());
- pushMessageBody.setExtras((Map<String, Object>) new HashMap<String, Object>().put("_comment", "Any custom data."));
- attributes.setSilent(false);
- attributes.setPersonal(true);
- pushMessage.setUserId("Test_User");
+ pushMessageBody.setExtras(Map.of("_comment", "Any custom data."));
+
+ final PushMessage pushMessage = new PushMessage();
+ pushMessage.setUserId(PushServerTestClientFactory.TEST_USER_ID);
  pushMessage.setActivationId(powerAuthTestClient.getActivationId());
  pushMessage.setAttributes(attributes);
  pushMessage.setBody(pushMessageBody);
- pushMessage.setAttributes(attributes);
- ObjectResponse<PushMessageSendResult> actual = pushServerClient.sendPushMessage(powerAuthTestClient.getApplicationId(), Mode.SYNCHRONOUS, pushMessage);
+
+ final ObjectResponse<PushMessageSendResult> actual = pushServerClient.sendPushMessage(powerAuthTestClient.getApplicationId(), Mode.SYNCHRONOUS, pushMessage);
  assertEquals("OK", actual.getStatus());
- List<PushDeviceRegistrationEntity> devices = pushDeviceRepository.findByAppCredentialsAppIdAndPushToken(powerAuthTestClient.getApplicationId(), MOCK_PUSH_TOKEN);
+
+ final List<PushDeviceRegistrationEntity> devices = pushDeviceRepository.findByAppCredentialsAppIdAndPushToken(powerAuthTestClient.getApplicationId(), MOCK_PUSH_TOKEN);
  pushDeviceRepository.deleteAll(devices);
  }
 
 
  @Test
- @SuppressWarnings("unchecked") //known parameters of HashMap
  void sendPushMessageBatchTest() throws Exception {
  boolean result = pushServerClient.createDevice(powerAuthTestClient.getApplicationId(), MOCK_PUSH_TOKEN, MobilePlatform.ANDROID, powerAuthTestClient.getActivationId());
  assertTrue(result);
- List<PushMessage> batch = new ArrayList<>();
- PushMessage pushMessage = new PushMessage();
- PushMessageAttributes attributes = new PushMessageAttributes();
- PushMessageBody pushMessageBody = new PushMessageBody();
+
+ final PushMessageBody pushMessageBody = new PushMessageBody();
  pushMessageBody.setTitle("Balance update");
  pushMessageBody.setBody("Your balance is now $745.00");
  pushMessageBody.setBadge(3);
  pushMessageBody.setSound("riff.wav");
  pushMessageBody.setCategory("balance-update");
  pushMessageBody.setCollapseKey("balance-update");
  pushMessageBody.setValidUntil(Instant.now());
- pushMessageBody.setExtras((Map<String, Object>) new HashMap<String, Object>().put("_comment", "Any custom data."));
+ pushMessageBody.setExtras(Map.of("_comment", "Any custom data."));
+
+ final PushMessageAttributes attributes = new PushMessageAttributes();
  attributes.setSilent(false);
  attributes.setPersonal(true);
- pushMessage.setUserId("Test_User");
+
+ final PushMessage pushMessage = new PushMessage();
+ pushMessage.setUserId(PushServerTestClientFactory.TEST_USER_ID);
  pushMessage.setActivationId(powerAuthTestClient.getActivationId());
  pushMessage.setAttributes(attributes);
  pushMessage.setBody(pushMessageBody);
- pushMessage.setAttributes(attributes);
- batch.add(pushMessage);
- ObjectResponse<PushMessageSendResult> actual = pushServerClient.sendPushMessageBatch(powerAuthTestClient.getApplicationId(), Mode.SYNCHRONOUS, batch);
+
+ final List<PushMessage> batch = List.of(pushMessage);
+
+ final ObjectResponse<PushMessageSendResult> actual = pushServerClient.sendPushMessageBatch(powerAuthTestClient.getApplicationId(), Mode.SYNCHRONOUS, batch);
  assertEquals("OK", actual.getStatus());
- List<PushDeviceRegistrationEntity> devices = pushDeviceRepository.findByAppCredentialsAppIdAndPushToken(powerAuthTestClient.getApplicationId(), MOCK_PUSH_TOKEN);
+
+ final List<PushDeviceRegistrationEntity> devices = pushDeviceRepository.findByAppCredentialsAppIdAndPushToken(powerAuthTestClient.getApplicationId(), MOCK_PUSH_TOKEN);
  pushDeviceRepository.deleteAll(devices);
  }
 
@@ -289,14 +295,18 @@ void deleteUsersFromCampaignTest() throws Exception {
 
  @Test
  void sendTestingCampaignTest() throws Exception {
- boolean actual = pushServerClient.sendTestCampaign(1L, "Test_User");
+ boolean result = pushServerClient.createDevice(powerAuthTestClient.getApplicationId(), MOCK_PUSH_TOKEN, MobilePlatform.ANDROID, powerAuthTestClient.getActivationId());
+ assertTrue(result);
+
+ final Long campaignId = createCampaign().getResponseObject().getId();
+ boolean actual = pushServerClient.sendTestCampaign(campaignId, PushServerTestClientFactory.TEST_USER_ID);
  assertTrue(actual);
  }
 
  @Test
  void sendCampaignTest() throws Exception {
- createCampaign();
- boolean result = pushServerClient.sendCampaign(1L);
+ final Long campaignId = createCampaign().getResponseObject().getId();
+ boolean result = pushServerClient.sendCampaign(campaignId);
  assertTrue(result);
  }