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