webcit-ng/README.txt

   1
   2
   3 This is WebCit-NG, a complete refactoring of the WebCit server that will
   4 focus on "REST first" and build around that.  The code will be well
   5 layered with as little spaghetti as possible.
   6
   7 Please don't mess with this yet.  I'm only pushing it upstream so it gets
   8 backed up.
   9
  10
  11 DESIGN GOALS:
  12 -------------
  13
  14 *       Hold as little state as possible
  15
  16 *       Require NO cleanup.   Killing the process lets the OS reclaim all resources.
  17
  18 *       As much as possible, resources should be freed by just coming back down the stack.
  19
  20 *       Readability of the code is more important than shaving off a few CPU cycles.
  21
  22 *       Throw sensitive data such as passwords back and forth in clear text.
  23         If you want privacy, encrypt the whole session.  Anything else is false security.
  24
  25
  26
  27
  28 REST format URIs will generally take the form of:
  29
  30         /ctdl/objectClass/[container/]object[/operation]
  31
  32 We are using:
  33
  34 *       libcitadel for information about the Citadel server, some string handling, and the JSON encoder
  35 *       Expat for DAV handling
  36 *       OpenSSL for TLS