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