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