path: root/README
diff options
authorZofia Abramowska <>2014-05-14 16:39:57 (GMT)
committerZofia Abramowska <>2014-05-22 15:40:33 (GMT)
commit75eefc778a27ef1bbaa5f25405eda4cfe2afa29c (patch)
tree0e7ef4f49aa5afa1a628dd58c8f839574ed1a83c /README
parent4b0983df07687e9a2bf60a2e2cc474b0306bbb2a (diff)
Initial commit
Change-Id: I4e7b15fdcfdc4f4fe6c0b9401d30b9dea038866f
Diffstat (limited to 'README')
1 files changed, 35 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..64d79c2
--- /dev/null
+++ b/README
@@ -0,0 +1,35 @@
+README for key-manager project
+key-manager project contains of two parts:
+1) the server part, that is implemented as a daemon that has vast rights for
+vulnerable, security-related data, and that may be trusted by its clients.
+2) the client part, libkey-manager-client: a library that allows programs to
+communicate with the server part.
+The libkey-manager-client library's API is available in the header file
+The libkey-manager-client API may be used to:
+The server part of manager is implemented in a /src/manager directory.
+The implementation is divided into:
+ communication manager part: that is responsible for threads and communication management
+ with no awareness of what information is being transferred. This part is
+ implemented by SocketManager class that works with GenericSocketService as
+ a generalization for services that key-manager provides.
+ services part: implemented as classes derived from GenericSocketService
+ grouped in src/manager/service directory that defines actions done by
+ key-manager after receiving certain requests from client side.
+Adding services to key-manager should be done by creating a new class
+derived from GenericSocketService, implementing proper functions for it,
+registering it to SocketManager in main loop and making unix socket for service.
+The paths of unix sockets used in communication between server and libclient are
+defined in src/manager/common directory. Sockets themselves are configured in
+files in systemd directory.