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