docs/developer-guide/unified-secure-channel.rst

   1 Unified Secure Channel
   2 ======================
   3
   4 Overview
   5 --------
   6
   7 The Unified Secure Channel (USC) feature provides REST API, manager, and
   8 plugin for unified secure channels. The REST API provides a northbound
   9 api. The manager monitors, maintains, and provides channel related
  10 services. The plugin handles the lifecycle of channels.
  11
  12 USC Channel Architecture
  13 ------------------------
  14
  15 -  USC Agent
  16
  17    -  The USC Agent provides proxy and agent functionality on top of all
  18       standard protocols supported by the device. It initiates call-home
  19       with the controller, maintains live connections with with the
  20       controller, acts as a demuxer/muxer for packets with the USC
  21       header, and authenticates the controller.
  22
  23 -  USC Plugin
  24
  25    -  The USC Plugin is responsible for communication between the
  26       controller and the USC agent . It responds to call-home with the
  27       controller, maintains live connections with the devices, acts as a
  28       muxer/demuxer for packets with the USC header, and provides
  29       support for TLS/DTLS.
  30
  31 -  USC Manager
  32
  33    -  The USC Manager handles configurations, high availability,
  34       security, monitoring, and clustering support for USC.
  35
  36 -  USC UI
  37
  38    -  The USC UI is responsible for displaying a graphical user
  39       interface representing the state of USC in the OpenDaylight DLUX
  40       UI.
  41
  42 USC Channel APIs and Interfaces
  43 -------------------------------
  44
  45 This section describes the APIs for interacting with the unified secure
  46 channels.
  47
  48 USC Channel Topology API
  49 ~~~~~~~~~~~~~~~~~~~~~~~~
  50
  51 The USC project maintains a topology that is YANG-based in MD-SAL. These
  52 models are available via RESTCONF.
  53
  54 -  Name: view-channel
  55
  56 -  URL:
  57    `http://${ipaddress}:8181/restconf/operations/usc-channel:view-channel <http://${ipaddress}:8181/restconf/operations/usc-channel:view-channel>`__
  58
  59 -  Description: Views the current state of the USC environment.
  60
  61 API Reference Documentation
  62 ---------------------------
  63
  64 Go to
  65 `http://${ipaddress}:8181/apidoc/explorer/index.html <http://${ipaddress}:8181/apidoc/explorer/index.html>`__,
  66 sign in, and expand the usc-channel panel. From there, users can execute
  67 various API calls to test their USC deployment.
  68