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