.. include:: vars.rst

.. _section-release-notes:

Release Notes
*************

Supported Platforms
===================

|CDS| is supported on the platforms listed in
:numref:`TableSupportedPlatforms`. 

.. list-table:: Supported Platforms
    :name: TableSupportedPlatforms
    :widths: 10 90
    :header-rows: 1

    * - Platform
      - Operating System
    *
      - Linux®
      - All Linux platforms on x64 CPUs in the |CORE_RELNOTES| with the 
        same version number, except SUSE® Linux Enterprise Server.
    *
      - macOS®
      - All macOS platforms in the |CORE_RELNOTES| with the same version 
        number, except macOS 11 on Arm v8 CPU.
    *
      - Windows®
      - All Windows platforms in the |CORE_RELNOTES| with the same version 
        number.

Note: POSIX®-compliant architectures that end with "FACE_GP" are not
supported and custom platforms are not supported.

Compatibility
=============

For backward compatibility information between |CDS| 6.1.1 and
previous releases, please see the *Migration Guide* on the
`RTI Community portal <https://community.rti.com/Documentation/>`_.

Connext DDS compatibility
-------------------------

|CDS| can be used to provide discovery for applications built with
*RTI Connext DDS*, except as noted below.

- Starting in *RTI Connext DDS* 5.1.0, the default ``message_size_max`` for the
  UDPv4, UDPv6, TCP, Secure WAN, and shared-memory transports changed to provide
  better out-of-the-box performance. |CDS| also uses the new value for
  ``message_size_max``. Consequently, |CDS| is not out-of-the-box compatible
  with applications running older versions of |CONNEXT|. Please see the
  |CORE_RELNOTES| for instructions on how to
  resolve this compatibility issue with older |CONNEXT| applications.

What's New in 6.1.1
===================

New platform
------------

This release has validated that the libraries for architecture
x64Darwin17clang9.0 can also be used on macOS 11 (Big Sur)
systems with x64 CPUs. 

For more information on this architecture, see the 
*RTI Connext DDS Core Libraries Platform Notes* for this release.

.. _section-cds-611-third-party-upgrades:

Third-party software upgrades
-----------------------------

.. CDS-152,153

The following third-party software used by |CDS| has been upgraded:

.. list-table:: Third-Party Software Changes
    :name: ThirdPartyChanges
    :widths: 40 40 40
    :header-rows: 1

    * - Third-Party Software
      - Previous Version
      - Current Version 
    * - libxml2	
      - 2.9.4	
      - 2.9.12
    * - libxslt	
      - 1.1.29
      - 1.1.34

Some of these upgrades may fix potential vulnerabilities.
See :ref:`section-cds-611-fixed-vulnerabilities`.

For information on third-party software used by *Connext DDS* products,
see the "3rdPartySoftware" documents in your installation: 
``<NDDSHOME>/doc/manuals/connext_dds_professional/release_notes_3rdparty``.

What's Fixed in 6.1.1
=====================

Incorrect XSD and behavior of <deny_domain_id> in <domain_list> tag
-------------------------------------------------------------------

The XSD for <deny_domain_id> was incorrect.
This caused |CDS| to report an error and not start, unless you used
the ``-ignoreXsdValidation`` command-line option.

There was also an issue in parsing <deny_domain_id> tag values. 

In addition, <deny_domain_id> values were not assigned a higher
precedence over <allow_domain_id> values, as stated in the
documentation examples. 

These three issues have been resolved.

[RTI Issue ID CDS-112]

.. _section-cds-611-fixed-vulnerabilities:

Fixes related to vulnerabilities
--------------------------------

This release fixes some potential vulnerabilities, described below. 

Potential |CDS_HEADING| crash or leak of sensitive information due to vulnerabilities in libxml2
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The |CDS| XML parser had a third-party dependency on libxml2 2.9.4. 
That version of libxml2 is known to be affected by a number of publicly 
disclosed vulnerabilities. 

Those vulnerabilities have been fixed by upgrading to the latest 
stable release of libxml2, 2.9.12 (see :ref:`section-cds-611-third-party-upgrades`).

The impact on |CDS| of using the previous version varied depending on your |CDS| 
configuration:

* With *Connext Secure* (enabling RTPS protection):

  * Exploitable through a compromised local file system containing
    a malicious XML file.
  * |CDS| could have crashed or leaked sensitive information. An attacker
    could have compromised |CDS| integrity.
  * CVSS v3.1 Score: 7.3 HIGH
  * CVSS v3.1 Vector: `AV:L/AC:L/PR:N/UI:N/S:U/C:L/I:L/A:H <https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator?vector=AV:L/AC:L/PR:N/UI:N/S:U/C:L/I:L/A:H&version=3.1>`_

* Without *Connext Secure* (release mode)

  * Exploitable through a compromised local file system containing malicious
    XML file.
  * Remotely exploitable through malicious RTPS messages.
  * |CDS| could have crashed or leaked sensitive information. An attacker
    could have compromised |CDS| integrity.
  * CVSS v3.1 Score: 8.6 HIGH
  * CVSS v3.1 Vector: `AV:N/AC:L/PR:N/UI:N/S:U/C:L/I:L/A:H <https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator?vector=AV:N/AC:L/PR:N/UI:N/S:U/C:L/I:L/A:H&version=3.1>`_

* Without *Connext Secure* (debug mode)

  * Exploitable through a compromised local file system containing malicious
    XML file.
  * Remotely exploitable through malicious RTPS messages.
  * |CDS| could have crashed or leaked sensitive information. An attacker
    could have compromised |CDS| integrity.
  * CVSS v3.1 Score: 9.8 CRITICAL
  * CVSS v3.1 Vector: `AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H <https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator?vector=AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H&version=3.1>`_

[RTI Issue ID CDS-151]


Previous Release
================

What's new in 6.1.0
-------------------

New platforms
^^^^^^^^^^^^^

|CDS| now includes support for these platforms:

- macOS 10.15 (x64)
- Red Hat® Enterprise Linux 7.6 (x64)
- Ubuntu® 20.04 LTS (x64)

For more information on these platforms, see the |CORE_PLATNOTES|.

Removed platforms
^^^^^^^^^^^^^^^^^

These platforms are no longer supported:

- 32-bit Linux and Windows platforms
- macOS 10.12
- Ubuntu 12.04 LTS 
 
 
Advanced logging support
^^^^^^^^^^^^^^^^^^^^^^^^

.. CDS-47 

This release provides you with more context while troubleshooting, 
and helps RTI Support better diagnose problems when inspecting a
log file.

For information on the various logging verbosities, see
:ref:`section-cloud-discovery-service-command-line-parameters`.

Remote monitoring support
^^^^^^^^^^^^^^^^^^^^^^^^^

.. CDS-48

This release adds support for remote monitoring. This allows
you to enable the publication of samples on the three
standard monitoring topics (Config, Event and Periodic). 
It also provides a way to check the health of the service when
deployed in production. 

For details, including the metrics published by |CDS|, see 
:ref:`section-cloud-discovery-service-monitoring`.

Remote administration support
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. CDS-56

This release adds support for remote administration. This
allows you to issue remote commands to control the service
and inspect its internal state. For details, see
:ref:`section-cloud-discovery-service-administration`.

Service API support for C and Modern C++
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. CDS-57

This release adds support for the Service API in the C and
Modern C++ languages. This allows you to integrate |CDS| as
a component in your own application. 
For details, see :ref:`section-sdk`.



What's fixed in 6.1.0
---------------------

Memory leak after receiving repeat discovery announcement if role_name or name set in DomainParticipant's ENTITY_NAME QosPolicy
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

When |CDS| received a repeat discovery announcement from an existing
*DomainParticipant*, it leaked memory if either the ``name`` or ``role_name``
was set in the *DomainParticipant's* ENTITY_NAME QosPolicy. 
This problem has been resolved.

[RTI Issue ID CDS-74]

Crash when a dispose or update participant announcement was received
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

In previous releases of |CDS|, on some Windows architectures, if a dispose
or update participant announcement was received, it would result in a crash.
This was due to an issue when trying to look up an inserted value. This 
problem has been resolved.

[RTI Issue ID CDS-80]

Known Issues
============

|CDS| does not terminate when its internal |DP| does not initialize properly
-----------------------------------------------------------------------------
|CDS| creates an internal |DP| that reserves the *participant_id* 0, on domain ID 0.
This |DP| is required by |CDS| to relay the participant discovery announcements.
If the *participant_id* 0 for domain ID 0 is already being used by another
|CONNEXT| application, |CDS| throws errors but doesn't terminate.

Although such a |CDS| instance is running, it won't be able to relay any participant
discovery announcements. A simple workaround is to ensure that |CDS| is always
the first |CONNEXT| application started on a given machine.

[RTI Issue ID CDS-143]