doc/config.example

   1 #
   2 # Example PWMD configuration file. Edit and save to ~/.pwmd/config or
   3 # specify with the -f command line option. See the pwmd(1) manual page for
   4 # complete details of the options.
   5 #
   6 # The global section is for non-file related settings and defaults for data
   7 # files without a file section.
   8 [global]
   9
  10 # Location of the listening socket.
  11 #socket_path=~/.pwmd/socket
  12
  13 # Socket permissions. This will override any umask setting.
  14 #socket_perms=0600
  15
  16 # Where data files will be read and stored.
  17 #data_directory=~/.pwmd/data
  18
  19 # If false, disable keeping backups for data files.
  20 #backup=true
  21
  22 # Log file location.
  23 #log_path=~/.pwmd/log
  24
  25 # Set to true to enable logging to log_path.
  26 #enable_logging=false
  27
  28 # Set to true to enable logging to syslog.
  29 #syslog=false
  30
  31 # Set to false to call mlockall(2) after a client connects. Uses alot more
  32 # memory but is also more secure. Most will probably find it overkill since
  33 # the contents of all memory is cleared before being freed. Note that this
  34 # doesn't affect the file cache which is always stored in RAM (if possible).
  35 #disable_mlockall=true
  36
  37 # Disable the XPATH, LIST and DUMP commands. When "true" and a client sends
  38 # these commands the error GPG_ERR_NOT_IMPLEMENTED will be returned.
  39 #disable_list_and_dump=false
  40
  41 # The number of encryption iterations for new files. This is the number of
  42 # times the data will be encrypted. Setting this to a high value (10000 or
  43 # more, depending on the size of the data file) will slow down dictionary
  44 # attacks. Setting to 0 will disable encryption.
  45 #iterations=1
  46
  47 # After the set number of encryption or decryption iterations have been
  48 # processed, a status message with the keyword ENCRYPT or DECRYPT will be
  49 # sent to the client. Set to 0 to disable.
  50 #iteration_progress=0
  51
  52 # A list of filenames separated by commas to add to the file cache upon
  53 # startup. You will be prompted for the key for each file if required. The
  54 # files are looked for in data_directory.
  55 #cache_push=somefile, anotherfile
  56
  57 # The number of seconds to keep a file in the cache. If -1, the file will be
  58 # kept forever. If 0, then every OPEN and SAVE command will require a key.
  59 #cache_timeout=-1
  60
  61 # Set to false to disable use of pinentry to retrieve keys.
  62 #enable_pinentry=true
  63 #
  64
  65 # Seconds until the pinentry dialog times out. Set to 0 to wait for input
  66 # forever.
  67 #pinentry_timeout=20
  68
  69 # The default compression level for data files from 1 to 9, 1 being the
  70 # fastest but least compression and 9 being the slowest but best compression.
  71 # To disable compression entirely, set to 0.
  72 #compression_level=6
  73
  74 # The input and output buffer size when compressing and decompressing. This
  75 # affects how often the COMPRESS and DECOMPRESS status messages are sent and
  76 # also affects compression quality. Set to a higher value for larger files.
  77 #zlib_bufsize=65536
  78
  79 # The maximum recursion depth when resolving elements that contain a "target"
  80 # attribute. When this value is exceeded an error will be returned.
  81 #recursion_depth=20
  82
  83 # Sends a KEEPALIVE status message every N seconds. Set to 0 to disable.
  84 #keepalive=30
  85
  86 # The priority or nice value of the server process. The default is inherited
  87 # from the parent process.
  88 #priority=10
  89
  90 # Whether to enable TCP server support. If enabled, both TCP and the local
  91 # unix domain socket will listen for connections.
  92 #enable_tcp=false
  93
  94 # If TCP is enabled, the port to listen on.
  95 #tcp_port=6466
  96
  97 # Only useful if running as root.
  98 #tcp_interface=eth0
  99
 100 # A comma separated list of client x509 certificate fingerprints in SHA-1
 101 # format that will be allowed to open a file. If prefixed with !, access is
 102 # denied for the connected client. The access control is for filenames and
 103 # this option can be in either the global section or a defined filename
 104 # section. If not found in either then access will be granted. If defined but
 105 # empty then access will be denied.
 106 #tcp_access=
 107
 108 # Require the client to provide the key to open a file even if the file is
 109 # cached.
 110 #tcp_require_key=false
 111
 112 # The time in tenths of a second to wait for a new TCP connection.  Setting to
 113 # 0 will disable waiting.
 114 #tcp_wait=3
 115
 116 # The GnuTLS cipher suite and protocol to use.
 117 #cipher_suite=SECURE256
 118
 119 # END GLOBAL SETTINGS
 120
 121 # File specific settings are allowed by placing the filename in braces. Each
 122 # file can have it's own configuration settings from those listed below.
 123 #[somefile]
 124 #cache_timeout=300
 125 #iteration_progress=0
 126 #key=password
 127 #key_file=/path/to/file.key
 128 #compression_level=0
 129 #enable_pinentry=true
 130 #pinentry_timeout=20
 131 #backup=true
 132 #tcp_access=some_sha1_hash