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