Release Notes
[portal.git] / 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 Maintenance
83 --------------
84 :Release Date: 2020-08-24
85
86 El Alto Maintenance Release 1
87
88 The primary goal of this maintenance release is to address expired certificates.
89 PORTAL-878 Portal certificate renewal pwd patch
90         
91 Version: 2.6.0
92 --------------
93 :Release Date: 2019-10-03
94
95 .. toctree::
96     :maxdepth: 1
97
98
99 **No New Features**
100
101 **Bug Fixes**
102         * Portal Setup - MariaDB issue.
103         * Issue editing application url.
104         * PORTAL-* charts now use nodePortPrefix variable.
105         * Fixed Sonar reported critical issues.
106
107 **Known Issues**
108         * AAI UI's new role "ui_view" is not registered in AAF, Portal cannot fetch it. So, the work around is
109
110            1. upload new role from Bulk Upload in Portal Roles page (create a csv file which has one line like:   ui_view,10 )
111            2. Sync Roles on same page
112            3. Assign this ui_view role to demo account in User page
113            4. Then demo user can access AAI UI app from Portal
114
115 **Security Notes**
116
117 *Fixed Security Issues*
118
119         * CVE-2019-12122 - ONAP Portal allows to retrieve password of currently active user [`OJSI-65 <https://jira.onap.org/browse/OJSI-65>`_]
120         * CVE-2019-12121 - ONAP Portal is vulnerable for Padding Oracle attack [`OJSI-92 <https://jira.onap.org/browse/OJSI-92>`_]
121
122 *Known Security Issues*
123
124 *Known Vulnerabilities in Used Modules*
125         * Addressed security issues reported by NexusIQ Critical and Severe issues
126
127 Quick Links:
128      - `PORTAL project page <https://wiki.onap.org/display/DW/Portal+Platform+Project>`_
129
130      - `Passing Badge information for PORTAL <https://bestpractices.coreinfrastructure.org/en/projects/1441>`_
131
132      - `Project Vulnerability Review Table for PORTAL <https://wiki.onap.org/pages/viewpage.action?pageId=68542388>`_
133
134 **Upgrade Notes**
135         * 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.
136         * For onboarded Apps using http (since Portal is using https) the browser asks the user to click to Proceed to the unsafe URL.
137         * For onboarded Apps using http the icon in the URL bar will appear red, click on it and allow unsafe scripts.
138         * 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.
139
140 **Deprecation Notes**
141         * 2.6.0 portal/sdk is the last version to support the old AngularJS UI versions.
142         * 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.
143         * 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.
144
145 **Other**
146         * Below are the docker images released as part of Portal Platform project:
147         * onap/portal-app:2.6.0
148         * onap/portal-db:2.6.0
149         * onap/portal-sdk:2.6.0
150         * onap/portal-wms:2.6.0
151         * portal/sdk java artifacts - (Release branch: "release-2.6.0")
152
153
154 Version: 2.5.0
155 --------------
156 :Release Date: 2019-06-13
157
158 .. toctree::
159     :maxdepth: 1
160
161 We worked on SDK upgrade to integrate with AAF. We partially implemented multi-language.
162
163 **New Features**
164         * SDK upgrade to integrate with AAF
165             * Use of CADI
166         * 68% JUnit Test Coverage
167         * Addressing security issues
168         * Angular 6 upgrade delivered foundation code with sample screen
169             * 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>`_
170         * Internationalization language support - partially implemented.
171         * Reporting feature enhancement in portal/sdk - design and partial code changes
172         * There is more information about new features at `DEMOS - R4 Dublin Demos <https://wiki.onap.org/display/DW/DEMOS+-+R4+Dublin+Demos>`_
173
174 **Bug Fixes**
175         * Fixed Sonar reported critical issues.
176
177 **Known Issues**
178         * Mismatch while displaying active online user in Portal.
179         * Internationalization Language component partially completed.
180         * Functional Menu change requires manual refresh.
181         * 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.
182
183 **Security Notes**
184
185 *Fixed Security Issues*
186
187 *Known Security Issues*
188
189         * CVE-2019-12317 - Number of XSS vulnerabilities in Portal [`OJSI-15 <https://jira.onap.org/browse/OJSI-15>`_]
190         * CVE-2019-12122 - ONAP Portal allows to retrieve password of currently active user [`OJSI-65 <https://jira.onap.org/browse/OJSI-65>`_]
191         * CVE-2019-12121 - ONAP Portal is vulnerable for Padding Oracle attack [`OJSI-92 <https://jira.onap.org/browse/OJSI-92>`_]
192         * In default deployment PORTAL (portal-app) exposes HTTP port 8989 outside of cluster. [`OJSI-97 <https://jira.onap.org/browse/OJSI-97>`_]
193         * In default deployment PORTAL (portal-app) exposes HTTP port 30215 outside of cluster. [`OJSI-105 <https://jira.onap.org/browse/OJSI-105>`_]
194         * In default deployment PORTAL (portal-sdk) exposes HTTP port 30212 outside of cluster. [`OJSI-106 <https://jira.onap.org/browse/OJSI-106>`_]
195         * CVE-2019-12318 - Number of SQL Injections in Portal [`OJSI-174 <https://jira.onap.org/browse/OJSI-174>`_]
196         * Portal stores users passwords encrypted instead of hashed [`OJSI-190 <https://jira.onap.org/browse/OJSI-190>`_]
197
198 *Known Vulnerabilities in Used Modules*
199
200 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>`_.
201
202 Quick Links:
203      - `PORTAL project page <https://wiki.onap.org/display/DW/Portal+Platform+Project>`_
204
205      - `Passing Badge information for PORTAL <https://bestpractices.coreinfrastructure.org/en/projects/1441>`_
206
207      - `Project Vulnerability Review Table for PORTAL <https://wiki.onap.org/pages/viewpage.action?pageId=51283057>`_
208
209 **Upgrade Notes**
210         * 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.
211         * For onboarded Apps using http (since Portal is using https) the browser asks the user to click to Proceed to the unsafe URL.
212         * For onboarded Apps using http the icon in the URL bar will appear red, click on it and allow unsafe scripts.
213         * 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.
214
215 **Deprecation Notes**
216
217 **Other**
218         * Below are the docker images released as part of Portal Platform project:
219         * onap/portal-app:2.5.0
220         * onap/portal-db:2.5.0
221         * onap/portal-sdk:2.5.0
222         * onap/portal-wms:2.5.0
223         * portal/sdk java artifacts - (Release branch: "release-2.5.0")
224
225 Version: 2.3.2
226 --------------
227 :Release Date: 2019-04-15
228
229 .. toctree::
230     :maxdepth: 1
231
232 This is the official release notes for the Casablanca Maintenance Release 3.0.2.
233
234 **Known Issues**
235         * The issue is an application running on HTTPS will not open in Portal if the AAF root CA is missing.
236           An error message will appear in a separate tab in Portal. It will say something like:
237           "The webpage at https://portal.api.simpledemo.onap.org:30200/vid/welcome.htm?cc=........ might
238           be temporarily down or it may have moved permanently to a new web address."
239           Here is the work-around, copy above VID (or other app) URL and replace welcome.htm to login.htm
240           in a new browser window; after login come back to Portal home page and click VID, it will now work.
241
242         * For applications running on HTTP (for example SDC), the user needs to disable the security check in the browser to access the application.
243
244 **Other**
245         * Portal updated Keystore certificate from AAF to extend its expiry date; This change was made in OOM project.
246
247 Version: 2.3.1
248 --------------
249 :Release Date: 2019-01-31
250
251 .. toctree::
252     :maxdepth: 1
253
254 This is the official release notes for the Casablanca Maintenance.
255
256 **Bug Fixes**
257         * 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.
258
259 Version: 2.3.0
260 --------------
261 :Release Date: 2018-11-30
262
263 .. toctree::
264     :maxdepth: 1
265
266 We worked on SDK upgrade to integrate with AAF. We completed Architecture review for Portal and use case UI to support multi-language.
267
268 **New Features**
269         * Platform Maturity Guidelines - Integrating with OOM
270         * SDK upgrade to integrate with AAF
271             * Use of Semantic Versioning - V3 is the supported version
272             * Integration with AAF via REST; Supports both SDK and Framework Applications
273         * 65% JUnit Test Coverage
274         * Addressing security issues
275         * Internationalization language support - design related
276         * Reporting feature enhancement in portal/sdk - design and partial code changes
277         * Platform Enhancements - Improved logging, docker separation, and SDK Simplification
278         * Angular 5 upgraded with sample POC in SDK to build rich UI
279
280 **Bug Fixes**
281         * Improved exception handling in reporting feature and also in login feature while getting a lock from Zookeeper.
282         * Improved documentation to get access to Portal through port 8989.
283         * Fixed Sonar reported critical issues.
284         * Improved OOM deployment 30235 external port mapping for portal-sdk.
285
286 **Known Issues**
287         * Mismatch while displaying active online user in Portal.
288         * UI misaligned on updating widgets in Portal.
289         * On Logout redirect landing page needs to be corrected.
290         * Functional Menu change requires manual refresh.
291
292 **Security Notes**
293
294 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>`_.
295
296 Quick Links:
297      - `PORTAL project page <https://wiki.onap.org/display/DW/Portal+Platform+Project>`_
298
299      - `Passing Badge information for PORTAL <https://bestpractices.coreinfrastructure.org/en/projects/1441>`_
300
301      - `Project Vulnerability Review Table for PORTAL <https://wiki.onap.org/pages/viewpage.action?pageId=35522356>`_
302
303 **Upgrade Notes**
304         * 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.
305         * For onboarded Apps using http (since Portal is using https) the browser asks the user to click to Proceed to the unsafe URL.
306
307 **Deprecation Notes**
308
309 **Other**
310         * Below are the docker images released as part of Portal Platform project:
311         * onap/portal-app:2.3.1
312         * onap/portal-db:2.3.1
313         * onap/portal-sdk:2.3.1
314         * onap/portal-wms:2.3.1
315         * portal/sdk java artifacts - (Release branch: "release-2.4.0")
316
317 Version: 2.2.0
318 --------------
319
320 :Release Date: 2018-06-07
321
322 .. toctree::
323     :maxdepth: 1
324
325 We worked on hardening the ONAP Portal platform by improving code quality and addressing security issues.
326
327 **New Features**
328         * Platform Maturity Guidelines
329         * Integrating with MUSIC, OOM, and AAF
330         * 50% JUnit Test Coverage
331         * Addressing security issues
332         * Bootstrapping of VID roles and tighter integration with AAF
333         * Role Centralization capability for framework based partners - design related
334         * Platform Enhancements - Improved logging, Security Hardening, and SDK Simplification
335
336 **Bug Fixes**
337         * Issues with roles fixed in this release.
338         * Now able to deselect widget on Widget catalog page
339         * Replaced the word ECOMP to ONAP
340         * Terminated menu access by App Admin User that are supposed to be available to Portal Admin only
341         * Upgraded software packages to resolve security issues
342
343 **Known Issues**
344         * Need to upgrade to new encrypt/decrypt algorithm in coordination with Partnering apps
345         * Logging needs improvement
346         * Not able to delete portal admin user
347         * Add support to connect with AAF Runtime
348         * Portal's SDK UI documentation in ONAP wiki needs samples
349         * The Portal/SDK fn_user table has encrypted passwords that need to change to using a hash algorithm
350         * UI cleanup needed: on adding entries to News Widget and display on Application Onboarding page
351
352 **Security Issues**
353         * https://wiki.onap.org/pages/viewpage.action?pageId=27689089
354
355 **Security Notes**
356
357 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>`_.
358
359 Quick Links:
360      - `PORTAL project page <https://wiki.onap.org/display/DW/Portal+Platform+Project>`_
361
362      - `Passing Badge information for PORTAL <https://bestpractices.coreinfrastructure.org/en/projects/1441>`_
363
364      - `Project Vulnerability Review Table for PORTAL <https://wiki.onap.org/pages/viewpage.action?pageId=27689089>`_
365
366 **Upgrade Notes**
367         * Upgrades to Portal platform can be performed using Heat based installation scripts available under demo repository.
368
369 **Deprecation Notes**
370         * The encryption algorithm used in Portal is now changed from AES to AES/CBC/PKCS5PADDING.
371
372 **Other**
373         * Below are the docker images released as part of Portal Platform project:
374         * onap/portal-db:v2.2.0
375         * onap/portal-apps:v2.2.0
376         * onap/portal-wms:v2.2.0
377         * onap//music/music-cassandra:v3.0
378         * zookeeper:v3.4.0
379         * portal/sdk - (Release branch: "release-2.2.0")
380
381 Version: 1.3.0
382 --------------
383
384 :Release Date: 2017-11-16
385
386 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).
387
388 **New Features**
389         * Digital Experience Control/UI upgrade.
390         * Portal Notification Enhancement and act on it w/o copy/paste, e.g. hyperlink to target function with context transfer.
391         * Prepared onboarding App process where the partner is ready for centralized user authentication via AAF.
392         * Source code of Portal Platform and its SDK is released under the following repositories on gerrit.onap.org
393         * portal - (Release branch: "release-1.3.0")
394         * portal/sdk - (Release branch: "release-1.3.2")
395
396 **Bug Fixes**
397         * Onboarding script updated due to user/role integration/synchronization issues with Partner Applications.
398         * Fixed search and remove bugs in Widget Onboarding.
399         * Fixed issues in the Application Onboarding.
400         * Fixed issues in the Microservice Onboarding.
401         * Fixed deployment scripts and streamlined the reference variables.
402
403 **Known Issues**
404         * `PORTAL-140 <https://jira.onap.org/browse/PORTAL-140>`_ - Portal role synch error with partner apps.
405
406 **Security Issues**
407         * 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.
408
409 **Upgrade Notes**
410         * This is an initial release.
411
412 **Deprecation Notes**
413         * This is an initial release.
414
415 **Other**
416         * Below are the docker images released as part of Portal Platform project:
417         * onap/portal-db:v1.3.0
418         * onap/portal-apps:v1.3.0
419         * onap/portal-wms:v1.3.0
420
421 End of Release Notes