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