README

   1 README for key-manager project
   2
   3 key-manager project contains of two parts:
   4 1) the server part, that is implemented as a daemon that has vast rights for
   5 vulnerable, security-related data, and that may be trusted by its clients.
   6
   7 2) the client part, libkey-manager-client: a library that allows programs to
   8 communicate with the server part.
   9
  10 The libkey-manager-client library's API is available in the header file
  11 src/include/key-manager.h.
  12
  13 The libkey-manager-client API may be used to:
  14 #TODO
  15
  16 key-manager:
  17
  18 The server part of manager is implemented in a /src/manager directory.
  19 The implementation is divided into:
  20     communication manager part: that is responsible for threads and communication management
  21     with no awareness of what information is being transferred. This part is
  22     implemented by SocketManager class that works with GenericSocketService as
  23     a generalization for services that key-manager provides.
  24 and
  25     services part: implemented as classes derived from GenericSocketService
  26     grouped in src/manager/service directory that defines actions done by
  27     key-manager after receiving certain requests from client side.
  28
  29 Adding services to key-manager should be done by creating a new class
  30 derived from GenericSocketService, implementing proper functions for it,
  31 registering it to SocketManager in main loop and making unix socket for service.
  32
  33 The paths of unix sockets used in communication between server and libclient are
  34 defined in src/manager/common directory. Sockets themselves are configured in
  35 files in systemd directory.