doc/cfg/areas.texi

   1 @node CfgAreas
   2 @section Configuration areas options
   3
   4 @ref{Multicast} areas configuration only used with multicast packets.
   5
   6 @verbatim
   7 areas: {
   8   nodelist: {
   9     id: OU67K7NA3RPOPFKJWNVBYJ5GPLRBDGHH6DZSSJ32JL7Q3Q76E52A
  10
  11     pub: ALCX2NJBANMBNFTQ27C3C6W2WJIXSE74R27TSYZQKMD2UJERCEOQ
  12     prv: VQ3B4TLAZZB2G7RS3OSS5NUVKAS44OGY5YMQPMTAHQMZZLNG25MA
  13
  14     subs: ["alice", "bob", "eve"]
  15     incoming: /home/incoming/areas/nodelist
  16   }
  17   echoarea: {
  18     id: CKKJ3HOAVOP7VPNCEGZRNDO34MUOOJ4AXHDFCSVSOE647KN5CMIA
  19
  20     pub: 5MFPTJI2R322EUCTGCWZXTDBCVEL5NCFDBXI5PHPQOTLUVSQ3ZIQ
  21     prv: LVGIZQRQTDE524KEE5FOWLE2GCQBILY4VSQBDHWJC6YUTOJ54QCQ
  22
  23     subs: ["alice", "bob"]
  24     exec: {sendmail: ["/usr/sbin/sendmail"]}
  25     allow-unknown: true
  26   }
  27   whatever.pvt: {
  28     id: OU67K7NA3RPOPFKJWNVBYJ5GPLRBDGHH6DZSSJ32JL7Q3Q76E52A
  29     subs: ["dave", "eve"]
  30   }
  31 }
  32 @end verbatim
  33
  34 Each key is human readable multicast group/area/echo name.
  35
  36 The only required field is the @code{id}. You can not process multicast
  37 packets that has unknown area identification.
  38
  39 @code{subs} contains a list of recipients you must relay incoming
  40 multicast packet on.
  41
  42 Knowledge of @code{pub} and @code{prv} keys gives ability to decrypt
  43 multicast packet and process its contents (file or exec transmission).
  44 For accepting file transmissions you must set @code{incoming}, similar
  45 to @ref{CfgIncoming, neigh's node option}. For accepting exec
  46 transmissions you must set @code{exec}, similar to @ref{CfgExec, neigh's
  47 node option}.
  48
  49 You can accept multicast packets from unknown senders, by setting
  50 @code{allow-unknown} option.
  51
  52 In the example above:
  53
  54 @table @code
  55 @item nodelist
  56 That area is for multicast sending of @file{nodelist} files, with
  57 relaying it to @code{alice}, @code{bob} and @code{eve} further.
  58 @item echoarea
  59 That area is for multicast discussion through @code{sendmail} handled
  60 exec packets. Relaying to @code{alice} and @code{bob} and accepting
  61 messages from unknown participants.
  62 @item whatever.pvt
  63 We just relay that area packets to @code{dave} and @code{eve}, but
  64 without ability to see what is inside them. Pay attention that
  65 @code{allow-unknown} does not play any role here, because we are not
  66 even trying to decrypt (and authenticate) those multicast packets.
  67 @end table