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