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

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