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