doc/config.example

   1 # Example PWMD configuration file. Edit and save to ~/.pwmd/config or
   2 # specify with the -f command line option. See the pwmd(1) manual page or the
   3 # pwmd.info documentation for complete details of the options.
   4 #
   5 # The global section is for non-file related settings and defaults for data
   6 # files without a file section of their own.
   7 [global]
   8
   9 # The number of seconds to wait for a pinentry before giving up.
  10 #pinentry_timeout=30
  11
  12 # Location of the listening socket.
  13 #socket_path=~/.pwmd/socket
  14
  15 # Socket permissions. This will override any umask setting.
  16 #socket_perms=0600
  17
  18 # Usernames or groups obtained via SO_PEERCRED which are allowed to
  19 # connect to the socket. Groups should be prefixed with a '@'. When not
  20 # specified only the invoking user is allowed. You can also specify an SHA256
  21 # TLS fingerprint by prefixing it with a '#'.
  22 #allowed = username,another_user,@group,-not_this_user,#TLS-FINGERPRINT
  23
  24 # Same syntax as the 'allowed' parameter with one entry per line.
  25 #allowed_file=~/path/to/file
  26
  27 # Username to use as the default in an element ACL. The default is the
  28 # user that starts pwmd.
  29 #invoking_user=nobody,@group,!notme,#TLSFINGERPRINT
  30
  31 # Same syntax as the 'invoking_user' parameter with one entry per line.
  32 #invoking_file=~/path/to/file
  33
  34 # Allow killing another client of the same UID or TLS fingerprint when not an
  35 # invoking_user.
  36 #strict_kill=false
  37
  38 # When false, disable keeping backups for data files.
  39 #backup=true
  40
  41 # Where gpg2(1) will store is configuration including public and private keys.
  42 #gpg_homedir = ~/.pwmd/.gnupg
  43
  44 # Whether to kill scdaemon after each OPEN, SAVE or PASSWD command.
  45 #kill_scd=false
  46
  47 # Whether to use the gpg(1) option to always encrypt to a specified key.
  48 #encrypt_to=false
  49
  50 # Whether to allow encrypting to untrusted public keys.
  51 #always_trust=false
  52
  53 # Log file location.
  54 #log_path=~/.pwmd/log
  55
  56 # Set to true to enable logging to log_path.
  57 #enable_logging=false
  58
  59 # Disable to close the logging file descriptor (log_path) after writing each
  60 # line.
  61 #log_keepopen=true
  62
  63 # Set to true to enable logging to syslog.
  64 #syslog=false
  65
  66 # The logging level: 0=connections and errors, 1=recipients/signers,
  67 # 2=commands
  68 #log_level=0
  69
  70 # Require the passphrase needed to OPEN a data file before each SAVE.
  71 #require_save_key=true
  72
  73 # Set to false to call mlockall(2) after a client connects. Uses more memory
  74 # but is also more secure. Most will probably find it overkill since the
  75 # contents of all memory is cleared before being freed.
  76 #disable_mlockall=true
  77
  78 # Disable the XPATH, LIST and DUMP commands. When "true" and a client sends
  79 # these commands the error GPG_ERR_NOT_IMPLEMENTED will be returned.
  80 #disable_list_and_dump=false
  81
  82 # When sending data to the client an XFER status message will be sent after
  83 # N bytes. N is rounded to ASSUAN_LINELENGTH (1002) bytes.
  84 #xfer_progress=8196
  85
  86 # A comma separated list of filenames to add to the file cache upon startup.
  87 # You will be prompted for the passphrasefor each file if required. The files
  88 # are looked for in ~/.pwmd/data.
  89 #cache_push=somefile,anotherfile
  90
  91 # The number of seconds to keep a file in the cache. If -1, the file will be
  92 # kept forever. If 0 then every OPEN will require a passphrase.
  93 #cache_timeout=600
  94
  95 # The maximum recursion depth when resolving elements that contain a "target"
  96 # attribute. When this value is exceeded an error will be returned.
  97 #recursion_depth=100
  98
  99 # The priority or nice value of the server process. The default is inherited
 100 # from the parent process.
 101 #priority=10
 102
 103 # In tenths of a second, the amount of time to wait for a file lock before
 104 # returning an error to the client.
 105 #lock_timeout=50
 106
 107 # Whether to enable TCP/TLS server support. If enabled, both TCP and the local
 108 # unix domain socket will listen for connections.
 109 #enable_tcp=false
 110
 111 # If TCP is enabled, the port to listen on.
 112 #tcp_port=6466
 113
 114 # The network interface to listen on.
 115 #tcp_interface=eth1
 116
 117 # The number of seconds to wait for a network read and write to complete
 118 # for TLS connections.
 119 #tls_timeout=300
 120
 121 # Require the client to provide the key to open a file even if the file is
 122 # cached.
 123 #tcp_require_key=false
 124
 125 # The time in tenths of a second to wait for a new TCP connection.  Setting to
 126 # 0 will disable waiting.
 127 #tcp_wait=3
 128
 129 # Accept TCP connections from the specified protocol. One of: ipv4, ipv6 or
 130 # any. The default is "any".
 131 #tcp_bind=any
 132
 133 # The GnuTLS cipher suite and protocol to use.
 134 #tls_cipher_suite=SECURE256
 135
 136 # TLS key exchange security level: low, medium or high.
 137 #tls_dh_level=medium
 138
 139 # The interval in seconds to send the KEEPALIVE status message when
 140 # not in a command.
 141 #keepalive_interval=60
 142
 143 # Send client state information to all connected clients. 0=disable, 1=all,
 144 # 2=invoking user clients only.
 145 #send_state=2
 146
 147 # END GLOBAL SETTINGS
 148
 149 # File specific settings are allowed by placing the filename in braces. Each
 150 # file can have it's own configuration settings from those listed below.
 151 #[somefile]
 152 #cache_timeout=300
 153 #passphrase_file=/path/to/file.key
 154 #backup=true
 155 #xfer_progress=1024
 156 #recursion_depth=200
 157 #require_save_key=true
 158 #tcp_require_key=true
 159 #allowed=@group,-notme