.. _`Preface`:


#######
Preface
#######


About The Secure Networking Configuration Guide
***********************************************

The *OpenSplice Secure Networking Configuration Guide*
is intended to be a complete reference for configuring and managing the
OpenSplice Secure Networking Module.


Intended Audience
*****************

The *Secure Networking Configuration Guide*
is the starting point for anyone who wishes to use and configure the
OpenSplice Secure Networking Module for securing information
transmission between DDS applications across multiple system nodes.



Organisation
************

The *Guide* is organised as follows:

The :ref:`Overview <Overview>` provides an introduction to the secure
networking module.

:ref:`Secure Networking Configuration <Secure Networking Configuration>`
describes how to configure the OpenSplice Secure Networking Module.

The :ref:`Tutorial <Secure Networking Tutorial>`
gives a step-by-step example showing how to configure the
OpenSplice Secure Networking Module.

The next section explains how :ref:`Access Control <Access Control>`
is realized in OpenSplice.

:ref:`Access Control Configuration <Access Control Configuration>`
describes how to configure the OpenSplice Mandatory Access Control Module.

Finally, the :ref:`Troubleshooting <Troubleshooting>` section
provides information to help with the diagnosis of common
security-related error messages and configuration problems.


Conventions
***********

The icons shown below are used in ZettaScale product documentation
to help readers to quickly identify information relevant to their
specific use of OpenSplice.


 ========= ==================================================================
 *Icon*    *Meaning*
 ========= ==================================================================
 |caution| Item of special significance or where caution needs to be taken.
 |info|    Item contains helpful hint or special information.
 |windows| Information applies to Windows (*e.g.* XP, 2003, Windows 7) only.
 |unix|    Information applies to Unix-based systems (*e.g.* Solaris) only.
 |linux|   Information applies to Linux-based systems (*e.g.* Ubuntu) only.
 |c|       C language specific.
 |cpp|     C++ language specific.
 |csharp|  C# language specific.
 |java|    Java language specific.
 ========= ==================================================================




.. |caution| image:: ./images/icon-caution.*
            :height: 6mm
.. |info|   image:: ./images/icon-info.*
            :height: 6mm
.. |windows| image:: ./images/icon-windows.*
            :height: 6mm
.. |unix| image:: ./images/icon-unix.*
            :height: 6mm
.. |linux| image:: ./images/icon-linux.*
            :height: 6mm
.. |c| image:: ./images/icon-c.*
            :height: 6mm
.. |cpp| image:: ./images/icon-cpp.*
            :height: 6mm
.. |csharp| image:: ./images/icon-csharp.*
            :height: 6mm
.. |java| image:: ./images/icon-java.*
            :height: 6mm