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 pinentry binary.
  10 #pinentry_path=/usr/bin/pinentry
  11
  12 # The number of seconds to wait for a pinentry before giving up.
  13 #pinentry_timeout=30
  14
  15 # Location of the listening socket.
  16 #socket_path=~/.pwmd/socket
  17
  18 # Socket permissions. This will override any umask setting.
  19 #socket_perms=0600
  20
  21 # Usernames or groups obtained via SO_PEERCRED which are allowed to
  22 # connect to the socket. Groups should be prefixed with a '@'. When not
  23 # specified only the invoking user is allowed.
  24 #allowed = username,another_user,@group,-not_this_user
  25
  26 # Username to use as the default in an element ACL. The default is the
  27 # invoking user.
  28 #invoking_user=nobody
  29
  30 # Like invoking_user, but for remote connections, an SHA1 hash of a client
  31 # TLS fingerprint.
  32 #invoking_tls=#FINGERPRINT
  33
  34 # When false, disable keeping backups for data files.
  35 #backup=true
  36
  37 # Log file location.
  38 #log_path=~/.pwmd/log
  39
  40 # Set to true to enable logging to log_path.
  41 #enable_logging=false
  42
  43 # Disable to close the logging file descriptor (log_path) after writing each
  44 # line.
  45 #log_keepopen=true
  46
  47 # Set to true to enable logging to syslog.
  48 #syslog=false
  49
  50 # The logging level: 0=connections and errors, 1=client commands.
  51 #log_level=0
  52
  53 # Enable gpg-agent support.
  54 #use_agent=false
  55
  56 # A file containing the environment settings for connecting to gpg-agent.
  57 #agent_env_file=/path/to/some/file
  58
  59 # Kill the smartcard daemon after each OPEN or SAVE.
  60 #kill_scd=false
  61
  62 # Require the passphrase needed for a data file before each SAVE.
  63 #require_save_key=true
  64
  65 # Set to false to call mlockall(2) after a client connects. Uses more memory
  66 # but is also more secure. Most will probably find it overkill since the
  67 # contents of all memory is cleared before being freed.
  68 #disable_mlockall=true
  69
  70 # Disable the XPATH, LIST and DUMP commands. When "true" and a client sends
  71 # these commands the error GPG_ERR_NOT_IMPLEMENTED will be returned.
  72 #disable_list_and_dump=false
  73
  74 # When sending data to the client an XFER status message will be sent after
  75 # N bytes. N is rounded to ASSUAN_LINELENGTH (1002) bytes.
  76 #xfer_progress=8196
  77
  78 # A comma separated list of filenames to add to the file cache upon startup.
  79 # You will be prompted for the passphrasefor each file if required. The files
  80 # are looked for in ~/.pwmd/data. This also affects rcfile reloading via
  81 # SIGHUP.
  82 #cache_push=somefile,anotherfile
  83
  84 # The number of seconds to keep a file in the cache. If -1, the file will be
  85 # kept forever. If 0 then every OPEN will require a passphrase.
  86 #cache_timeout=600
  87
  88 # The maximum recursion depth when resolving elements that contain a "target"
  89 # attribute. When this value is exceeded an error will be returned.
  90 #recursion_depth=100
  91
  92 # The priority or nice value of the server process. The default is inherited
  93 # from the parent process.
  94 #priority=10
  95
  96 # The cipher to use for newly created files.
  97 #cipher=aes256
  98
  99 # The number of cipher encryption iterations of the data. This differs from
 100 # the s2k_count option (see below) that determines the hash iterations of the
 101 # passphrase.
 102 #cipher_iterations=0
 103
 104 # Send a status message to the client after this many encryption/decryption
 105 # iterations.
 106 #cipher_progress=2000
 107
 108 # The default key parameters to use when generating a new keypair
 109 # (RSA 2048 bit).
 110 #keyparam=(genkey (rsa (nbits 4:2048)))
 111
 112 # The number of passphrase hashing iterations for new files and when changing
 113 # the passphrase of a secret key. The default is the calibrated value of the
 114 # machine, or 0.
 115 #s2k_count=0
 116
 117 # Whether to enable TCP/TLS server support. If enabled, both TCP and the local
 118 # unix domain socket will listen for connections.
 119 #enable_tcp=false
 120
 121 # If TCP is enabled, the port to listen on.
 122 #tcp_port=6466
 123
 124 # The network interface to listen on.
 125 #tcp_interface=eth1
 126
 127 # The number of seconds to wait for a network read and write to complete
 128 # for TLS connections.
 129 #tls_timeout=300
 130
 131 # A comma separated list of client x509 certificate fingerprints in
 132 # SHA-1 format that will be allowed to connect or open a file. See the
 133 # documentation for details.
 134 #tls_access=#ALLOWEDFINGERPRINT,#ANOTHERFINGERPRINT
 135
 136 # Require the client to provide the key to open a file even if the file is
 137 # cached.
 138 #tcp_require_key=false
 139
 140 # The time in tenths of a second to wait for a new TCP connection.  Setting to
 141 # 0 will disable waiting.
 142 #tcp_wait=3
 143
 144 # Accept TCP connections from the specified protocol. One of: ipv4, ipv6 or
 145 # any. The default is "any".
 146 #tcp_bind=any
 147
 148 # The GnuTLS cipher suite and protocol to use.
 149 #tls_cipher_suite=SECURE256
 150
 151 # The interval in seconds to send the KEEPALIVE status message when
 152 # not in a command.
 153 #keepalive_interval=60
 154
 155 # END GLOBAL SETTINGS
 156
 157 # File specific settings are allowed by placing the filename in braces. Each
 158 # file can have it's own configuration settings from those listed below.
 159 #[somefile]
 160 #tls_access=+,!DENIEDFINGERPRINT
 161 #cache_timeout=300
 162 #passphrase=password
 163 #passphrase_file=/path/to/file.key
 164 #backup=true
 165 #xfer_progress=1024
 166 #recursion_depth=200