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 # A file containing the environment settings for connecting to gpg-agent.
  42 #agent_env_file=/path/to/some/file
  43
  44 # Kill the smartcard daemon after each OPEN or SAVE.
  45 #kill_scd=false
  46
  47 # Set to false to call mlockall(2) after a client connects. Uses more memory
  48 # but is also more secure. Most will probably find it overkill since the
  49 # contents of all memory is cleared before being freed.
  50 #disable_mlockall=true
  51
  52 # Disable the XPATH, LIST and DUMP commands. When "true" and a client sends
  53 # these commands the error GPG_ERR_NOT_IMPLEMENTED will be returned.
  54 #disable_list_and_dump=false
  55
  56 # When sending data to the client an XFER status message will be sent after
  57 # N bytes. N is rounded to ASSUAN_LINELENGTH (1002) bytes.
  58 #xfer_progress=8196
  59
  60 # A comma separated list of filenames to add to the file cache upon startup.
  61 # You will be prompted for the passphrasefor each file if required. The files
  62 # are looked for in ~/.pwmd/data. This also affects rcfile reloading via
  63 # SIGHUP.
  64 #cache_push=somefile,anotherfile
  65
  66 # The number of seconds to keep a file in the cache. If -1, the file will be
  67 # kept forever. If 0 then every OPEN will require a passphrase.
  68 #cache_timeout=-1
  69
  70 # The maximum recursion depth when resolving elements that contain a "target"
  71 # attribute. When this value is exceeded an error will be returned.
  72 #recursion_depth=100
  73
  74 # The priority or nice value of the server process. The default is inherited
  75 # from the parent process.
  76 #priority=10
  77
  78 # The cipher to use for newly created files.
  79 #cipher=aes256
  80
  81 # The number of cipher encryption iterations of the data. This differs from
  82 # the s2k_count option (see below) that determines the hash iterations of the
  83 # passphrase.
  84 #cipher_iterations=0
  85
  86 # Send a status message to the client after this many encryption/decryption
  87 # iterations.
  88 #cipher_progress=2000
  89
  90 # The key pair algorithm and number of bits to use for newly created files.
  91 #algo=rsa
  92 #nbits=2048
  93
  94 # The number of passphrase hashing iterations for new files and when changing
  95 # the passphrase of a secret key. The default is the calibrated value of the
  96 # machine, or 0.
  97 #s2k_count=0
  98
  99 # Whether to enable TCP/TLS server support. If enabled, both TCP and the local
 100 # unix domain socket will listen for connections.
 101 #enable_tcp=false
 102
 103 # If TCP is enabled, the port to listen on.
 104 #tcp_port=6466
 105
 106 # A comma separated list of client x509 certificate fingerprints in SHA-1
 107 # format that will be allowed to open a file. If prefixed with !, access is
 108 # denied for the connected client. The access control is for filenames and
 109 # this option can be in either the global section or a defined filename
 110 # section. If defined but empty then access will be denied. If only "+" is
 111 # present then all clients will be able to connect.
 112 #tls_access=
 113
 114 # Require the client to provide the key to open a file even if the file is
 115 # cached.
 116 #tcp_require_key=false
 117
 118 # The time in tenths of a second to wait for a new TCP connection.  Setting to
 119 # 0 will disable waiting.
 120 #tcp_wait=3
 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
 128
 129 # When true and exists, ~/.pwmd/crl.pem will be used as an X509 CRL.
 130 #tls_use_crl=true
 131
 132 # END GLOBAL SETTINGS
 133
 134 # File specific settings are allowed by placing the filename in braces. Each
 135 # file can have it's own configuration settings from those listed below.
 136 #[somefile]
 137 #cache_timeout=300
 138 #passphrase=password
 139 #passphrase_file=/path/to/file.key
 140 #backup=true
 141 #xfer_progress=1024
 142 #recursion_depth=200