Merge branch 'feature/PB-40083_13-Prepare-API-code' into 'master'

PB-40724 v5.0.0

See merge request passbolt/passbolt-ce-api!362

Author: gmougenel

.gitlab-ci/jobs/php_unit_tests/sequential/php_unit_tests.yml

@@ -122,36 +122,16 @@
 ##
 ## CUSTOM COMBINATIONS
 ##
-seq-php7.4-mysql5.7:
+seq-php8.2-mysql5.7:
   variables:
-    PHP_VERSION: "7.4"
+    PHP_VERSION: "8.2"
     DATABASE_ENGINE_VERSION: "${CI_DEPENDENCY_PROXY_DIRECT_GROUP_IMAGE_PREFIX}/mysql:5.7"
   extends:
     - .mysql-template
     - .test-template
   rules:
     - if: "$TEST_DISABLED == null"
 
-seq-php8.0-postgres13:
-  variables:
-    PHP_VERSION: "8.0"
-    DATABASE_ENGINE_VERSION: "${CI_DEPENDENCY_PROXY_DIRECT_GROUP_IMAGE_PREFIX}/postgres:13-alpine"
-  extends:
-    - .postgres-template
-    - .test-template
-  rules:
-    - if: '$TEST_DISABLED == null && $CI_COMMIT_BRANCH == "master"'
-    - if: '$TEST_DISABLED == null && $CI_COMMIT_BRANCH == "develop"'
-
-seq-php8.1-postgres15:
-  variables:
-    PHP_VERSION: "8.1"
-    DATABASE_ENGINE_VERSION: "${CI_DEPENDENCY_PROXY_DIRECT_GROUP_IMAGE_PREFIX}/postgres:15-alpine"
-  extends:
-    - .postgres-template
-    - .test-template
-  allow_failure: true
-
 #seq-php7.4-postgres12.11:
 #  variables:
 #    PHP_VERSION: "7.4"
@@ -177,9 +157,9 @@ seq-php8.1-postgres15:
 #    - if: '$TEST_DISABLED == null'
 
 ## DEBIAN 11 BULLSEYE
-seq-php7.4-mariadb10.5:
+seq-php8.2-mariadb10.5:
   variables:
-    PHP_VERSION: "7.4"
+    PHP_VERSION: "8.2"
     DATABASE_ENGINE_VERSION: "${CI_DEPENDENCY_PROXY_DIRECT_GROUP_IMAGE_PREFIX}/mariadb:10.5"
   extends:
     - .mysql-template
@@ -200,18 +180,6 @@ seq-php7.4-mariadb10.5:
 #    - if: '$TEST_DISABLED == null && $CI_COMMIT_BRANCH == "master"'
 #    - if: '$TEST_DISABLED == null && $CI_COMMIT_BRANCH == "develop"'
 
-## UBUNTU 20.04 LTS FOCAL
-seq-php7.4-mysql8:
-  variables:
-    PHP_VERSION: "7.4"
-    DATABASE_ENGINE_VERSION: "${CI_DEPENDENCY_PROXY_DIRECT_GROUP_IMAGE_PREFIX}/mysql:8.0"
-  extends:
-    - .mysql-template
-    - .test-template
-  rules:
-    - if: '$TEST_DISABLED == null && $CI_COMMIT_BRANCH == "master"'
-    - if: '$TEST_DISABLED == null && $CI_COMMIT_BRANCH == "develop"'
-
 #seq-php7.4-postgres12.11:
 #  variables:
 #    PHP_VERSION: "7.4"
@@ -223,9 +191,9 @@ seq-php7.4-mysql8:
 #    - if: '$TEST_DISABLED == null'
 
 ## UBUNTU 22.04 LTS JAMMY
-seq-php8.1-mysql8:
+seq-php8.2-mysql8:
   variables:
-    PHP_VERSION: "8.1"
+    PHP_VERSION: "8.2"
     DATABASE_ENGINE_VERSION: "${CI_DEPENDENCY_PROXY_DIRECT_GROUP_IMAGE_PREFIX}/mysql:8.0"
   extends:
     - .mysql-template
@@ -234,54 +202,20 @@ seq-php8.1-mysql8:
     - if: '$TEST_DISABLED == null && $CI_COMMIT_BRANCH == "master"'
     - if: '$TEST_DISABLED == null && $CI_COMMIT_BRANCH == "develop"'
 
-#seq-php8.1-postgres14.3:
-#  variables:
-#    PHP_VERSION: "8.1"
-#    DATABASE_ENGINE_VERSION: '${CI_DEPENDENCY_PROXY_DIRECT_GROUP_IMAGE_PREFIX}/postgres:14-alpine'
-#  extends:
-#    - .postgres-template
-#    - .test-template
-#  rules:
-#    - if: '$TEST_DISABLED == null'
-
 ##
 ## RPM COMBINATIONS
 ##
 ## CENTOS 7 - with remi and mariadb repos
 seq-php8.2-mariadb10.3:
   variables:
-    PHP_VERSION: "7.4"
+    PHP_VERSION: "8.2"
     DATABASE_ENGINE_VERSION: "${CI_DEPENDENCY_PROXY_DIRECT_GROUP_IMAGE_PREFIX}/mariadb:10.3"
   extends:
     - .mysql-template
     - .test-template
   rules:
     - if: "$TEST_DISABLED == null"
 
-## ROCKY LINUX 8.6
-seq-php8.0-mariadb10.5:
-  variables:
-    PHP_VERSION: "8.0"
-    DATABASE_ENGINE_VERSION: "${CI_DEPENDENCY_PROXY_DIRECT_GROUP_IMAGE_PREFIX}/mariadb:10.5"
-  extends:
-    - .mysql-template
-    - .test-template
-  rules:
-    - if: '$TEST_DISABLED == null && $CI_COMMIT_BRANCH == "master"'
-    - if: '$TEST_DISABLED == null && $CI_COMMIT_BRANCH == "develop"'
-
-## RHEL 9
-seq-php8.0-mariadb8.0:
-  variables:
-    PHP_VERSION: "8.0"
-    DATABASE_ENGINE_VERSION: "${CI_DEPENDENCY_PROXY_DIRECT_GROUP_IMAGE_PREFIX}/mysql:8.0"
-  extends:
-    - .mysql-template
-    - .test-template
-  rules:
-    - if: '$TEST_DISABLED == null && $CI_COMMIT_BRANCH == "master"'
-    - if: '$TEST_DISABLED == null && $CI_COMMIT_BRANCH == "develop"'
-
 #seq-php8.0-postgres13.7:
 #  variables:
 #    PHP_VERSION: "8.0"
@@ -293,6 +227,14 @@ seq-php8.0-mariadb8.0:
 #    - if: '$TEST_DISABLED == null && $CI_COMMIT_BRANCH == "master"'
 #    - if: '$TEST_DISABLED == null && $CI_COMMIT_BRANCH == "develop"'
 
+seq-php8.2-postgres15:
+  variables:
+    PHP_VERSION: "8.2"
+    DATABASE_ENGINE_VERSION: "${CI_DEPENDENCY_PROXY_DIRECT_GROUP_IMAGE_PREFIX}/postgres:15-alpine"
+  extends:
+    - .postgres-template
+    - .test-template
+
 seq-php8.3-mariadb10.5:
   variables:
     PHP_VERSION: "8.3"
@@ -303,36 +245,20 @@ seq-php8.3-mariadb10.5:
   rules:
     - if: "$TEST_DISABLED == null"
 
-
-# Mariadb 11.5 tests
-
-seq-php8.0-mariadb11.5:
+seq-php8.3-postgres13:
   variables:
-    PHP_VERSION: "8.0"
-    DATABASE_ENGINE_VERSION: "${CI_DEPENDENCY_PROXY_DIRECT_GROUP_IMAGE_PREFIX}/mariadb:11.5"
+    PHP_VERSION: "8.3"
+    DATABASE_ENGINE_VERSION: "${CI_DEPENDENCY_PROXY_DIRECT_GROUP_IMAGE_PREFIX}/postgres:13-alpine"
   extends:
-    - .mariadb-template
+    - .postgres-template
     - .test-template
   rules:
     - if: '$TEST_DISABLED == null && $CI_COMMIT_BRANCH == "master"'
     - if: '$TEST_DISABLED == null && $CI_COMMIT_BRANCH == "develop"'
-    - if: '$TEST_DISABLED == null && $CI_COMMIT_BRANCH == "release"'
-  allow_failure: true
 
-seq-php8.1-mariadb11.5:
-  variables:
-    PHP_VERSION: "8.1"
-    DATABASE_ENGINE_VERSION: "${CI_DEPENDENCY_PROXY_DIRECT_GROUP_IMAGE_PREFIX}/mariadb:11.5"
-  extends:
-    - .mariadb-template
-    - .test-template
-  rules:
-      - if: '$TEST_DISABLED == null && $CI_COMMIT_BRANCH == "master"'
-      - if: '$TEST_DISABLED == null && $CI_COMMIT_BRANCH == "develop"'
-      - if: '$TEST_DISABLED == null && $CI_COMMIT_BRANCH == "release"'
-  allow_failure: true
+# Mariadb 11.5 tests
 
-  # This is what we ship with the docker image as of 14 Nov 2024
+# This is what we ship with the docker image as of 14 Nov 2024
 seq-php8.2-mariadb11.5:
   variables:
     PHP_VERSION: "8.2"
@@ -355,4 +281,4 @@ seq-php8.3-mariadb11.5:
       - if: '$TEST_DISABLED == null && $CI_COMMIT_BRANCH == "master"'
       - if: '$TEST_DISABLED == null && $CI_COMMIT_BRANCH == "develop"'
       - if: '$TEST_DISABLED == null && $CI_COMMIT_BRANCH == "release"'
-  allow_failure: true
+  allow_failure: true

.gitlab-ci/jobs/security_check.yml

@@ -1,7 +1,7 @@
 .security-check:
   stage: unit-test
   variables:
-    PHP_VERSION: "7.4"
+    PHP_VERSION: "8.2"
     COMPOSER_ALLOW_SUPERUSER: 1
   image: $CI_REGISTRY_IMAGE_TEST:$PHP_VERSION
   allow_failure: true

.gitlab-ci/jobs/style_check.yml

@@ -1,17 +1,17 @@
 .static-analysis:
   stage: unit-test
   variables:
-    PHP_VERSION: "7.4"
+    PHP_VERSION: "8.2"
     COMPOSER_ALLOW_SUPERUSER: 1
   image: $CI_REGISTRY_IMAGE_TEST:$PHP_VERSION
   allow_failure: false
   script:
     - composer config --global process-timeout 2000
     - composer install --no-interaction
     - composer validate --check-lock --no-check-publish
-    - composer cs-check
     - composer stan
     - composer psalm
+    - composer cs-check
 
 static-analysis:
   extends: .static-analysis

CHANGELOG.md

@@ -2,9 +2,76 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [4.12.1] - 2025-03-17
+## [5.0.0] - 2025-04-10
+### Added
+- PB-39434 As an administrator I can log user actions on file in an SIEM compatible format
+- PB-39627 Enforce PHP 8.2 as minimum passbolt API requirement
+- PB-40155 Add Passbolt API support of PHP 8.4
+- PB-40247 Add API status documentation link to the health check command
+
+### Fixed
+- PB-39706 When creating a user from CLI the metadata_private_keys should have their fields created_by and modified_by set
+- PB-41356 As an administrator I can delete a resource type associated to deleted resources
+- PB-41374 Fix unlimited session lifetime introduced in CakePHP 5
+- PB-41379 Updates the minimum next version to 8.2 to remove false warning from installation
+
+### Maintenance
+- PB-28246 Refactor the whole application to upgrade CakePHP to version 5
+- PB-39434 Add code coverage to ActionLogsUsernameQueryStrategy
+- PB-39660 Mock MfaFormInterface to avoid tests failing occasionally
+- PB-39630 Fix ResourcesIndexControllerPaginationTest recurrently failing test
+
+## [5.0.0-rc.2] - 2025-04-08
+### Fixed
+- PB-41374 Fix unlimited session lifetime introduced in CakePHP 5
+- PB-41379 Updates the minimum next version to 8.2 to remove false warning from installation
+
+## [5.0.0-rc.1] - 2025-04-07
+### Added
+- PB-39434 As an administrator I can log user actions on file in an SIEM compatible format
+- PB-39627 Enforce PHP 8.2 as minimum passbolt API requirement
+- PB-40155 Add Passbolt API support of PHP 8.4
+- PB-40247 Add API status documentation link to the health check command
+
+### Fixed
+- PB-39706 When creating a user from CLI the metadata_private_keys should have their fields created_by and modified_by set
+- PB-41356 As an administrator I can delete a resource type associated to deleted resources
+
+### Maintenance
+- PB-28246 Refactor the whole application to upgrade CakePHP to version 5
+- PB-39434 Add code coverage to ActionLogsUsernameQueryStrategy
+- PB-39660 Mock MfaFormInterface to avoid tests failing occasionally
+- PB-39630 Fix ResourcesIndexControllerPaginationTest recurrently failing test
+
+## [5.0.0-test.4] - 2025-04-02
+### Added
+- PB-39434 As an administrator I can log user actions on file in an SIEM compatible format
+- PB-40155 Add Passbolt API support of PHP 8.4
+- PB-39627 Enforce PHP 8.2 as minimum passbolt API requirement
+
 ### Fixed
-- PB-39959 Fixes an issue when fetching the locale of suspended users when queried in a sub-query
+- PB-39706 When creating a user from CLI the metadata_private_keys should have their fields created_by and modified_by set
+
+### Improved
+- PB-38164 Migrate passbolt API skeleton to v5
+- PB-40247 Add API status documentation link to the health check command
+
+### Maintenance
+- PB-28246 Refactor the whole application to upgrade CakePHP to version 5
+- PB-39434 Add code coverage to ActionLogsUsernameQueryStrategy
+- PB-39660 Mock MfaFormInterface to avoid tests failing occasionally
+- PB-39630 Fix ResourcesIndexControllerPaginationTest recurrently failing test
+
+## [5.0.0-test.2] - 2025-03-28
+### Maintenance
+- PB-39712 Update CakePHP to version 5
+
+### Fixed
+- PB-40668 Cannot assign bool to property App\Notification\Email\EmailSender::$appFullBaseUrl of type string error
+
+## [5.0.0-test.1] - 2025-03-28
+### Maintenance
+- PB-39712 Update CakePHP to version 5
 
 ## [4.12.1-test.1] - 2025-03-14
 ### Fixed

Gruntfile.js

@@ -97,14 +97,11 @@ module.exports = function(grunt) {
             // Default Avatars
             'avatar/**',
             // Passbolt logos
-            'logo/icon-20_white.png', 'logo/icon-20_grey.png', 'logo/icon-20.png',
-            'logo/icon-48_white.png', 'logo/icon-48.png',
-            'logo/logo.png', 'logo/logo@2x.png', 'logo/logo.svg', 'logo/logo_white.svg', 'logo/logo_white.png',
+            'logo/logo.png', 'logo/logo.svg', 'logo/logo_white.svg',
             // Image for inputs and controls
             'controls/check_black.svg',
-            'controls/check_white.svg',
+            'controls/check_tick.svg',
             'controls/chevron-down_black.svg',
-            'controls/chevron-down_white.svg',
             'controls/chevron-down_blue.svg',
             'controls/dot_white.svg',
             'controls/dot_red.svg',
@@ -118,13 +115,6 @@ module.exports = function(grunt) {
             'controls/warning.svg',
             'controls/attention.svg',
             // Login page 3rd party logo
-            'third_party/firefox_logo.png',
-            'third_party/FirefoxAMO_black.svg',
-            'third_party/FirefoxAMO_white.svg',
-            'third_party/ChromeWebStore_black.svg',
-            'third_party/ChromeWebStore_white.svg',
-            'third_party/edge-addon-black.svg',
-            'third_party/edge-addon-white.svg',
             'third_party/chosen-sprite.png',
             'third_party/chosen-sprite@2x.png',
             'third_party/firefox.svg',
@@ -135,7 +125,6 @@ module.exports = function(grunt) {
 
             // Smtp provider 3rd party logo
             'third_party/aws-ses.svg',
-            'third_party/azure.svg',
             'third_party/elastic-email.svg',
             'third_party/gmail.svg',
             'third_party/mailgun.svg',

RELEASE_NOTES.md

@@ -1,10 +1,35 @@
-Release song: https://youtu.be/NUTGr5t3MoY?si=1hitMfMv8PDn1Wf2
+Release song: https://www.youtube.com/watch?v=yf1f8zNvR1I
 
-This is a maintenance release. It fixes a reported issue when notifying group administrators that a user should be added to a group. The issue occurred when a group administrator had been suspended.
+“Even the longest day has its end” goes the old Irish proverb, and here we are at long last announcing the Passbolt 5.x series.
+This first release v5.0 ships with a complete redesign of the application’s interface, which had remained largely unchanged since
+Passbolt’s early days and was limiting the addition of new capabilities.
+The new version offers a more spacious layout that provides room for meaningful information and addresses long-standing ergonomic issues.
+If you want to know more, check out what changed in this [Passbolt 5, UI Redesign](https://community.passbolt.com/t/passbolt-5-ui-redesign/12717) community post.
 
-Thank you to the community for the valuable feedback!
+Passbolt v5.0 lays the groundwork for the v5.x series, which will expand the software’s capabilities to handle more sensitive data types that the community has requested,
+such as key-value pairs, SSH keys, and certificates. The blog article about the passbolt v5.0 release is coming soon.
 
+Of course, with each major version come the inevitable breaking changes, which we strive to minimize as much as possible.
+With this release, the minimum server requirement has changed to PHP 8.2 or greater, so be sure to check out our latest blog article on [how to upgrade to PHP 8.2](https://www.passbolt.com/blog/preparing-for-passbolt-v5-php-8-2-requirement).
+Additionally this is a perfect moment to back up your server data and prepare for the unexpected.
+
+Thank you to the community for all your feedback, testing, and support in making this milestone possible. We hope you’ll enjoy what Passbolt v5.0 has to offer and look forward to hearing from you.
+
+## [5.0.0] - 2025-04-10
+### Added
+- PB-39434 As an administrator I can log user actions on file in an SIEM compatible format
+- PB-39627 Enforce PHP 8.2 as minimum passbolt API requirement
+- PB-40155 Add Passbolt API support of PHP 8.4
+- PB-40247 Add API status documentation link to the health check command
 
-## [4.12.1] - 2025-03-17
 ### Fixed
-- PB-39959 Fixes an issue when fetching the locale of suspended users when queried in a sub-query
+- PB-39706 When creating a user from CLI the metadata_private_keys should have their fields created_by and modified_by set
+- PB-41356 As an administrator I can delete a resource type associated to deleted resources
+- PB-41374 Fix unlimited session lifetime introduced in CakePHP 5
+- PB-41379 Updates the minimum next version to 8.2 to remove false warning from installation
+
+### Maintenance
+- PB-28246 Refactor the whole application to upgrade CakePHP to version 5
+- PB-39434 Add code coverage to ActionLogsUsernameQueryStrategy
+- PB-39660 Mock MfaFormInterface to avoid tests failing occasionally
+- PB-39630 Fix ResourcesIndexControllerPaginationTest recurrently failing test