docs/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright 2017-2020 AT&T Intellectual Property.  All rights reserved
   4 .. _release_notes:
   5
   6
   7 Portal Platform Release Notes
   8 =============================
   9 Version: 3.2.0
  10 --------------
  11 :Release Date: 2020-05-21
  12
  13 .. toctree::
  14     :maxdepth: 1
  15
  16 This release contains an Angular upgrade, bug fixes and security enhancements.
  17
  18 **New Features**
  19
  20         * Angular Upgrade from 1.X to 7.0 - Portal and SDK (Backward Compatible)
  21         * OParent 2.0 Migration & Self Release Jobs
  22         * UI/TypeScript Test Coverage - (Portal Coverage 60% and SDK Coverage 63%)
  23         * Spring Boot Migration (Portal only/ Partially Completed)
  24
  25 **Bug Fixes**
  26
  27         * License scan issues addressed
  28         * Fixed Sonar reported critical issues.
  29
  30 **Known Issues**
  31         * User management pages do not work properly. We will be addressing this in the Guilin release. So, the work around is:
  32
  33            1.  If we try to add user role by navigating directly to an application, like A&AI, we are unable to add roles.
  34            2.  However, With Portal admin privileges a user (in this case Demo user) can navigate to User screen and select Portal/Default from the drop down.
  35            3.  Then update user roles for A&AI and other applications in the popup.
  36            4.  We validated that this operation is correctly updating the role in AAF.
  37
  38 **Security Notes**
  39
  40         * Closed HTTP Ports (Portal, SDK)
  41         * Address Security Vulnerabilities from Nexus-IQ (Jars and Javascript libraries)
  42         * Containers to run as Non-Root user: portal, portal-sdk, portal-widget
  43
  44 *Fixed Security Issues*
  45
  46         * OJSI-97 - portal-app exposes plain text HTTP endpoint using port 8989 [`OJSI-97 <https://jira.onap.org/browse/OJSI-97>`_]
  47         * OJSI-105 - portal-sdk exposes plain text HTTP endpoint using port 30212 [`OJSI-105 <https://jira.onap.org/browse/OJSI-105>`_]
  48         * OJSI-106 - portal-app exposes plain text HTTP endpoint using port 30215 [`OJSI-106 <https://jira.onap.org/browse/OJSI-106>`_]
  49
  50 *Known Security Issues*
  51
  52 *Known Vulnerabilities in Used Modules*
  53         * Portal was granted a waiver by SECCOM for OJSI-190. Portal stores users passwords encrypted instead of hashed. This was not fixed for Frankfurt.
  54
  55 Quick Links:
  56      - `PORTAL project page <https://wiki.onap.org/display/DW/Portal+Platform+Project>`_
  57
  58      - `Passing Badge information for PORTAL <https://bestpractices.coreinfrastructure.org/en/projects/1441>`_
  59
  60      - `Project Vulnerability Review Table for PORTAL <https://wiki.onap.org/pages/viewpage.action?pageId=68542388>`_
  61
  62 **Upgrade Notes**
  63         * These still apply:
  64            1. For https Apps onboarded to portal, a certificate has to be downloaded in the browser when first trying to access the landing page of the App.
  65            2. For onboarded Apps using http (since Portal is using https) the browser asks the user to click to Proceed to the unsafe URL.
  66            3. For onboarded Apps using http the icon in the URL bar will appear red, click on it and allow unsafe scripts. Different browsers use different methods to accomplish this, Firefox has a security icon near the URL that you can click on "Unblock" and "Disable protection for now"
  67            4. The first time some apps are selected in the Applications panel, an error stating the webpage might be temporarily down, copy the presented URL to a new browser; once that is done, the application will open in the Portal.
  68
  69 **Deprecation Notes**
  70         * 2.6.0 portal/sdk is the last version to support the old AngularJS UI versions.
  71         * Expect upgrade on Angular frontend and SpringBoot backend in next releases: The components like Policy, VID, SDC, AAI, MSB, SO – if any of them use portal/sdk java libraries, then please anticipate MAJOR changes to portal/sdk with respect to technology stack upgrade which is pending for long time on Angular frontend and SpringBoot backend.
  72         * The tech stack upgrade helps resolve many security vulnerabilities and also provides latest rich UI and microservices features that components can take advantage of, just by upgrading to latest portal/sdk.
  73
  74 **Other**
  75         * Below are the docker images released as part of Portal Platform project:
  76         * onap/portal-app:3.2.3
  77         * onap/portal-db:3.2.3
  78         * onap/portal-sdk:3.2.0
  79         * onap/portal-wms:3.2.3
  80         * portal/sdk java artifacts - (Release branch: “release-3.2.0”; Jar Version: "3.0.0")
  81
  82 Version: 2.6.0
  83 --------------
  84 :Release Date: 2019-10-03
  85
  86 .. toctree::
  87     :maxdepth: 1
  88
  89 Maintenance release with bug fixes and security enhancements.
  90
  91 **No New Features**
  92
  93 **Bug Fixes**
  94         * Portal Setup - MariaDB issue.
  95         * Issue editing application url.
  96         * PORTAL-* charts now use nodePortPrefix variable.
  97         * Fixed Sonar reported critical issues.
  98
  99 **Known Issues**
 100         * AAI UI's new role "ui_view" is not registered in AAF, Portal cannot fetch it. So, the work around is
 101
 102            1. upload new role from Bulk Upload in Portal Roles page (create a csv file which has one line like:   ui_view,10 )
 103            2. Sync Roles on same page
 104            3. Assign this ui_view role to demo account in User page
 105            4. Then demo user can access AAI UI app from Portal
 106
 107 **Security Notes**
 108
 109 *Fixed Security Issues*
 110
 111         * CVE-2019-12122 - ONAP Portal allows to retrieve password of currently active user [`OJSI-65 <https://jira.onap.org/browse/OJSI-65>`_]
 112         * CVE-2019-12121 - ONAP Portal is vulnerable for Padding Oracle attack [`OJSI-92 <https://jira.onap.org/browse/OJSI-92>`_]
 113
 114 *Known Security Issues*
 115
 116 *Known Vulnerabilities in Used Modules*
 117         * Addressed security issues reported by NexusIQ Critical and Severe issues
 118
 119 Quick Links:
 120      - `PORTAL project page <https://wiki.onap.org/display/DW/Portal+Platform+Project>`_
 121
 122      - `Passing Badge information for PORTAL <https://bestpractices.coreinfrastructure.org/en/projects/1441>`_
 123
 124      - `Project Vulnerability Review Table for PORTAL <https://wiki.onap.org/pages/viewpage.action?pageId=68542388>`_
 125
 126 **Upgrade Notes**
 127         * For https Apps onboarded to portal, a certificate has to be downloaded in the browser when first trying to access the landing page of the App.
 128         * For onboarded Apps using http (since Portal is using https) the browser asks the user to click to Proceed to the unsafe URL.
 129         * For onboarded Apps using http the icon in the URL bar will appear red, click on it and allow unsafe scripts.
 130         * The first time some apps are selected in the Applications panel, an error stating the webpage might be temporarily down, copy the presented URL to a new browser; once that is done, the application will open in the Portal.
 131
 132 **Deprecation Notes**
 133         * 2.6.0 portal/sdk is the last version to support the old AngularJS UI versions.
 134         * Expect upgrade on Angular frontend and SpringBoot backend in next releases: The components like Policy, VID, SDC, AAI, MSB, SO - if any of them use portal/sdk java libraries, then please anticipate MAJOR changes to portal/sdk with respect to technology stack upgrade which is pending for long time on Angular frontend and SpringBoot backend.
 135         * The tech stack upgrade helps resolve many security vulnerabilities and also provides latest rich UI and microservices features that components can take advantage of, just by upgrading to latest portal/sdk.
 136
 137 **Other**
 138         * Below are the docker images released as part of Portal Platform project:
 139         * onap/portal-app:2.6.0
 140         * onap/portal-db:2.6.0
 141         * onap/portal-sdk:2.6.0
 142         * onap/portal-wms:2.6.0
 143         * portal/sdk java artifacts - (Release branch: "release-2.6.0")
 144
 145
 146 Version: 2.5.0
 147 --------------
 148 :Release Date: 2019-06-13
 149
 150 .. toctree::
 151     :maxdepth: 1
 152
 153 We worked on SDK upgrade to integrate with AAF. We partially implemented multi-language.
 154
 155 **New Features**
 156         * SDK upgrade to integrate with AAF
 157             * Use of CADI
 158         * 68% JUnit Test Coverage
 159         * Addressing security issues
 160         * Angular 6 upgrade delivered foundation code with sample screen
 161             * Documentation on the Angular 6 upgrade can be found `here <https://docs.onap.org/en/latest/submodules/portal.git/docs/tutorials/portal-sdk/your-angular-app.html>`_
 162         * Internationalization language support - partially implemented.
 163         * Reporting feature enhancement in portal/sdk - design and partial code changes
 164         * There is more information about new features at `DEMOS - R4 Dublin Demos <https://wiki.onap.org/display/DW/DEMOS+-+R4+Dublin+Demos>`_
 165
 166 **Bug Fixes**
 167         * Fixed Sonar reported critical issues.
 168
 169 **Known Issues**
 170         * Mismatch while displaying active online user in Portal.
 171         * Internationalization Language component partially completed.
 172         * Functional Menu change requires manual refresh.
 173         * Modifying Onboarded App configurations from the onboarding page malfunctions but changes to the App configuration can be done through accessing the database (portal:fn_app table) directly.
 174
 175 **Security Notes**
 176
 177 *Fixed Security Issues*
 178
 179 *Known Security Issues*
 180
 181         * CVE-2019-12317 - Number of XSS vulnerabilities in Portal [`OJSI-15 <https://jira.onap.org/browse/OJSI-15>`_]
 182         * CVE-2019-12122 - ONAP Portal allows to retrieve password of currently active user [`OJSI-65 <https://jira.onap.org/browse/OJSI-65>`_]
 183         * CVE-2019-12121 - ONAP Portal is vulnerable for Padding Oracle attack [`OJSI-92 <https://jira.onap.org/browse/OJSI-92>`_]
 184         * In default deployment PORTAL (portal-app) exposes HTTP port 8989 outside of cluster. [`OJSI-97 <https://jira.onap.org/browse/OJSI-97>`_]
 185         * In default deployment PORTAL (portal-app) exposes HTTP port 30215 outside of cluster. [`OJSI-105 <https://jira.onap.org/browse/OJSI-105>`_]
 186         * In default deployment PORTAL (portal-sdk) exposes HTTP port 30212 outside of cluster. [`OJSI-106 <https://jira.onap.org/browse/OJSI-106>`_]
 187         * CVE-2019-12318 - Number of SQL Injections in Portal [`OJSI-174 <https://jira.onap.org/browse/OJSI-174>`_]
 188         * Portal stores users passwords encrypted instead of hashed [`OJSI-190 <https://jira.onap.org/browse/OJSI-190>`_]
 189
 190 *Known Vulnerabilities in Used Modules*
 191
 192 PORTAL code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The PORTAL open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=51283057>`_.
 193
 194 Quick Links:
 195      - `PORTAL project page <https://wiki.onap.org/display/DW/Portal+Platform+Project>`_
 196
 197      - `Passing Badge information for PORTAL <https://bestpractices.coreinfrastructure.org/en/projects/1441>`_
 198
 199      - `Project Vulnerability Review Table for PORTAL <https://wiki.onap.org/pages/viewpage.action?pageId=51283057>`_
 200
 201 **Upgrade Notes**
 202         * For https Apps onboarded to portal, a certificate has to be downloaded in the browser when first trying to access the landing page of the App.
 203         * For onboarded Apps using http (since Portal is using https) the browser asks the user to click to Proceed to the unsafe URL.
 204         * For onboarded Apps using http the icon in the URL bar will appear red, click on it and allow unsafe scripts.
 205         * The first time some apps are selected in the Applications panel, an error stating the webpage might be temporarily down, copy the presented URL to a new browser; once that is done, the application will open in the Portal.
 206
 207 **Deprecation Notes**
 208
 209 **Other**
 210         * Below are the docker images released as part of Portal Platform project:
 211         * onap/portal-app:2.5.0
 212         * onap/portal-db:2.5.0
 213         * onap/portal-sdk:2.5.0
 214         * onap/portal-wms:2.5.0
 215         * portal/sdk java artifacts - (Release branch: "release-2.5.0")
 216
 217 Version: 2.3.2
 218 --------------
 219 :Release Date: 2019-04-15
 220
 221 .. toctree::
 222     :maxdepth: 1
 223
 224 This is the official release notes for the Casablanca Maintenance Release 3.0.2.
 225
 226 **Known Issues**
 227         * The issue is an application running on HTTPS will not open in Portal if the AAF root CA is missing.
 228           An error message will appear in a separate tab in Portal. It will say something like:
 229           "The webpage at https://portal.api.simpledemo.onap.org:30200/vid/welcome.htm?cc=........ might
 230           be temporarily down or it may have moved permanently to a new web address."
 231           Here is the work-around, copy above VID (or other app) URL and replace welcome.htm to login.htm
 232           in a new browser window; after login come back to Portal home page and click VID, it will now work.
 233
 234         * For applications running on HTTP (for example SDC), the user needs to disable the security check in the browser to access the application.
 235
 236 **Other**
 237         * Portal updated Keystore certificate from AAF to extend its expiry date; This change was made in OOM project.
 238
 239 Version: 2.3.1
 240 --------------
 241 :Release Date: 2019-01-31
 242
 243 .. toctree::
 244     :maxdepth: 1
 245
 246 This is the official release notes for the Casablanca Maintenance.
 247
 248 **Bug Fixes**
 249         * During installation Maria DB can now be accessed from within the portal-db container. The fix was made in OOM scripts to handle the db issue identified in the previous release.
 250
 251 Version: 2.3.0
 252 --------------
 253 :Release Date: 2018-11-30
 254
 255 .. toctree::
 256     :maxdepth: 1
 257
 258 We worked on SDK upgrade to integrate with AAF. We completed Architecture review for Portal and use case UI to support multi-language.
 259
 260 **New Features**
 261         * Platform Maturity Guidelines - Integrating with OOM
 262         * SDK upgrade to integrate with AAF
 263             * Use of Semantic Versioning - V3 is the supported version
 264             * Integration with AAF via REST; Supports both SDK and Framework Applications
 265         * 65% JUnit Test Coverage
 266         * Addressing security issues
 267         * Internationalization language support - design related
 268         * Reporting feature enhancement in portal/sdk - design and partial code changes
 269         * Platform Enhancements - Improved logging, docker separation, and SDK Simplification
 270         * Angular 5 upgraded with sample POC in SDK to build rich UI
 271
 272 **Bug Fixes**
 273         * Improved exception handling in reporting feature and also in login feature while getting a lock from Zookeeper.
 274         * Improved documentation to get access to Portal through port 8989.
 275         * Fixed Sonar reported critical issues.
 276         * Improved OOM deployment 30235 external port mapping for portal-sdk.
 277
 278 **Known Issues**
 279         * Mismatch while displaying active online user in Portal.
 280         * UI misaligned on updating widgets in Portal.
 281         * On Logout redirect landing page needs to be corrected.
 282         * Functional Menu change requires manual refresh.
 283
 284 **Security Notes**
 285
 286 PORTAL code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The PORTAL open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=35522356>`_.
 287
 288 Quick Links:
 289      - `PORTAL project page <https://wiki.onap.org/display/DW/Portal+Platform+Project>`_
 290
 291      - `Passing Badge information for PORTAL <https://bestpractices.coreinfrastructure.org/en/projects/1441>`_
 292
 293      - `Project Vulnerability Review Table for PORTAL <https://wiki.onap.org/pages/viewpage.action?pageId=35522356>`_
 294
 295 **Upgrade Notes**
 296         * For https Apps onboarded to portal, a certificate has to be downloaded in the browser when first trying to access the landing page of the App.
 297         * For onboarded Apps using http (since Portal is using https) the browser asks the user to click to Proceed to the unsafe URL.
 298
 299 **Deprecation Notes**
 300
 301 **Other**
 302         * Below are the docker images released as part of Portal Platform project:
 303         * onap/portal-app:2.3.1
 304         * onap/portal-db:2.3.1
 305         * onap/portal-sdk:2.3.1
 306         * onap/portal-wms:2.3.1
 307         * portal/sdk java artifacts - (Release branch: "release-2.4.0")
 308
 309 Version: 2.2.0
 310 --------------
 311
 312 :Release Date: 2018-06-07
 313
 314 .. toctree::
 315     :maxdepth: 1
 316
 317 We worked on hardening the ONAP Portal platform by improving code quality and addressing security issues.
 318
 319 **New Features**
 320         * Platform Maturity Guidelines
 321         * Integrating with MUSIC, OOM, and AAF
 322         * 50% JUnit Test Coverage
 323         * Addressing security issues
 324         * Bootstrapping of VID roles and tighter integration with AAF
 325         * Role Centralization capability for framework based partners - design related
 326         * Platform Enhancements - Improved logging, Security Hardening, and SDK Simplification
 327
 328 **Bug Fixes**
 329         * Issues with roles fixed in this release.
 330         * Now able to deselect widget on Widget catalog page
 331         * Replaced the word ECOMP to ONAP
 332         * Terminated menu access by App Admin User that are supposed to be available to Portal Admin only
 333         * Upgraded software packages to resolve security issues
 334
 335 **Known Issues**
 336         * Need to upgrade to new encrypt/decrypt algorithm in coordination with Partnering apps
 337         * Logging needs improvement
 338         * Not able to delete portal admin user
 339         * Add support to connect with AAF Runtime
 340         * Portal's SDK UI documentation in ONAP wiki needs samples
 341         * The Portal/SDK fn_user table has encrypted passwords that need to change to using a hash algorithm
 342         * UI cleanup needed: on adding entries to News Widget and display on Application Onboarding page
 343
 344 **Security Issues**
 345         * https://wiki.onap.org/pages/viewpage.action?pageId=27689089
 346
 347 **Security Notes**
 348
 349 PORTAL code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The PORTAL open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=27689089>`_.
 350
 351 Quick Links:
 352      - `PORTAL project page <https://wiki.onap.org/display/DW/Portal+Platform+Project>`_
 353
 354      - `Passing Badge information for PORTAL <https://bestpractices.coreinfrastructure.org/en/projects/1441>`_
 355
 356      - `Project Vulnerability Review Table for PORTAL <https://wiki.onap.org/pages/viewpage.action?pageId=27689089>`_
 357
 358 **Upgrade Notes**
 359         * Upgrades to Portal platform can be performed using Heat based installation scripts available under demo repository.
 360
 361 **Deprecation Notes**
 362         * The encryption algorithm used in Portal is now changed from AES to AES/CBC/PKCS5PADDING.
 363
 364 **Other**
 365         * Below are the docker images released as part of Portal Platform project:
 366         * onap/portal-db:v2.2.0
 367         * onap/portal-apps:v2.2.0
 368         * onap/portal-wms:v2.2.0
 369         * onap//music/music-cassandra:v3.0
 370         * zookeeper:v3.4.0
 371         * portal/sdk - (Release branch: "release-2.2.0")
 372
 373 Version: 1.3.0
 374 --------------
 375
 376 :Release Date: 2017-11-16
 377
 378 The ONAP Portal is a platform that provides the ability to integrate different ONAP applications into a centralized Portal Core. The platform seed code is improved with below listed enhancements in this release. This is technically the first release of ONAP Portal Platform, previous release was the seed code contribution. As such, the defects fixed in this release were raised during the course of the release and while its integration testing. Anything not closed is captured below under Known Issues. If you want to review the defects fixed in the Amsterdam release, refer to Jira (jira.onap.org).
 379
 380 **New Features**
 381         * Digital Experience Control/UI upgrade.
 382         * Portal Notification Enhancement and act on it w/o copy/paste, e.g. hyperlink to target function with context transfer.
 383         * Prepared onboarding App process where the partner is ready for centralized user authentication via AAF.
 384         * Source code of Portal Platform and its SDK is released under the following repositories on gerrit.onap.org
 385         * portal - (Release branch: "release-1.3.0")
 386         * portal/sdk - (Release branch: "release-1.3.2")
 387
 388 **Bug Fixes**
 389         * Onboarding script updated due to user/role integration/synchronization issues with Partner Applications.
 390         * Fixed search and remove bugs in Widget Onboarding.
 391         * Fixed issues in the Application Onboarding.
 392         * Fixed issues in the Microservice Onboarding.
 393         * Fixed deployment scripts and streamlined the reference variables.
 394
 395 **Known Issues**
 396         * `PORTAL-140 <https://jira.onap.org/browse/PORTAL-140>`_ - Portal role synch error with partner apps.
 397
 398 **Security Issues**
 399         * The issue "`PORTAL-137 <https://jira.onap.org/browse/PORTAL-137>`_ -Enhance Authentication" is fixed in Portal and in its SDK. The Portal team recommend partnering apps like Policy, VID, AAI, and SDC to upgrade to SDK's 1.3.2 or latest version to address the login vulnerability.
 400
 401 **Upgrade Notes**
 402         * This is an initial release.
 403
 404 **Deprecation Notes**
 405         * This is an initial release.
 406
 407 **Other**
 408         * Below are the docker images released as part of Portal Platform project:
 409         * onap/portal-db:v1.3.0
 410         * onap/portal-apps:v1.3.0
 411         * onap/portal-wms:v1.3.0
 412
 413 End of Release Notes