modules/entropykey/files/ekeyd.conf

   1 --
   2 -- THIS FILE IS UNDER PUPPET CONTROL. DON'T EDIT IT HERE.
   3 -- USE: git clone git+ssh://$USER@puppet.debian.org/srv/puppet.debian.org/git/dsa-puppet.git
   4 --
   5
   6 -- -*- Lua -*-
   7
   8 -- Sample configuration file for ekeyd
   9
  10 -- -----------------------------------------------[ General setup ]-----
  11
  12 -- If you want a TCP control socket on 127.0.0.1 then uncomment this
  13 -- command.
  14 -- Please note that there is no protection on a TCP socket, anyone on
  15 -- the box can connect to it and there is no authentication process.
  16 -- TCPControlSocket "1234"
  17
  18 -- The unix control socket is typically what we use
  19 UnixControlSocket "/var/run/ekeyd.sock"
  20
  21 -- The keyring contains the keys for the long-term rekey If you change
  22 -- this location from the default then be aware that the
  23 -- long-term-rekey tool may not work.
  24 Keyring "/etc/entropykey/keyring"
  25
  26 -- The daemon background operation may be supressed. In this mode the
  27 -- daemon will run in the foreground and the controlling tty will not
  28 -- be released.
  29 -- Daemonise(false)
  30
  31 -- -------------------------------------------------[ Output Mode ]-----
  32
  33 -- Only one output mode is permitted to be active. Typically on Linux
  34 -- that would be the kernel output mode, however instead you can opt
  35 -- to use the EGD interface. Various other daemons then support taking
  36 -- EGD interfaces and adding entropy to the kernel instead, allowing
  37 -- multiple clients to retrieve entropy by various means.
  38
  39 -- The SetOutputToKernel option places all the gathered entropy into
  40 -- the kernel pool. The data placed into the kernel pool is
  41 -- conservatively estimated to contain 7 shannons of entropy per byte
  42 -- added.
  43 -- Note that the data coming from the UDEKEY01 should have one Shannon
  44 -- of entropy per bit so this value could quite safely be set to
  45 -- 8. The default value only has the effect of reducing the rate
  46 -- entropy is mixed into the kernel pool and no other adverse
  47 -- affect. This default is selected as an conservative choice which is
  48 -- generally preferable when dealing with random sources.
  49 -- SetOutputToKernel(7)
  50
  51 -- The daemon may support the EGD (Entropy Gathering Daemon) socket
  52 -- protocol. There are two choice to create either a TCP or Unix
  53 -- socket which speaks the EGD protocol.
  54 -- Note that you cannot have kernel output *and* EGD output, they are
  55 -- mutually exclusive.
  56 -- The EGD protocol support assumes entropy coming off the ekeys is at
  57 -- the level of 8 shannons per byte and this cannot be changed as it
  58 -- is a limitation of the EGD protocol itself.  The TCP socket can be
  59 -- given an optional parameter to specify the IP address to bind to.
  60 -- It will default to 127.0.0.1 if not specified.
  61
  62 EGDTCPSocket(8888 --[[, "127.0.0.1" ]])
  63 -- EGDUnixSocket "/etc/entropy"
  64
  65 -- EGDUnixSocket can optionally take an octal mode string and
  66 -- username and group to chmod and chown the socket to.
  67 -- If you do not wish to change the user or group, use empty strings.
  68 -- You cannot change the user/group without also providing a mode string.
  69 -- The default is to leave the user/group alone and set the socket to
  70 -- mode 0600
  71 -- EGDUnixSocket("/etc/entropy", "0660", "root", "entropyusers")
  72
  73 -- The SetOutputToFile option writes all gathered entropy to the named
  74 -- file. No additional processing is performed. The output file must
  75 -- exist before the daemon is run. This option is generally only
  76 -- useful if the user wishes to gather data for subsequent testing.
  77 -- Note as with all the other output options this may be the only
  78 -- output selection and may not be used with either the kernel or EGD
  79 -- output enabled.
  80
  81 -- SetOutputToFile "/tmp/entropy"
  82
  83 -- -----------------------------------------------[ Device Config ]-----
  84
  85 -- Add entropy keys from /dev/entropykey where our default udev rules
  86 -- will place symbolic links (on GNU/Linux operating systems).
  87 AddEntropyKeys "/dev/entropykey"
  88 -- Also add keys from /var/run/entropykeys where the UNIX domain socket
  89 -- rules will place sockets if using them.
  90 AddEntropyKeys "/var/run/entropykeys"
  91 -- On OpenBSD/MirBSD you will probably need to use something like this
  92 -- instead (match the device minor (here: 0) with the ucom(4) instance
  93 -- your umodem(4) device attaches to):
  94 -- AddEntropyKey "/dev/cuaU0"