doc/cfg/areas.texi

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