Explicitly set pthread compiler flags on Android.
[pwmd.git] / doc / config.example
blobdcfa795ae91c78ddaf7b5f80b25491205be36a84
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.
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]
9 # Location of the pinentry binary.
10 #pinentry_path=/usr/bin/pinentry
12 # The number of seconds to wait for a pinentry before giving up.
13 #pinentry_timeout=30
15 # Location of the listening socket.
16 #socket_path=~/.pwmd/socket
18 # Socket permissions. This will override any umask setting.
19 #socket_perms=0600
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. You can also specify an SHA256
24 # TLS fingerprint by prefixing it with a '#'.
25 #allowed = username,another_user,@group,!not_this_user,#TLS-FINGERPRINT
27 # Same syntax as the 'allowed' parameter with one entry per line.
28 #allowed_file = ~/path/to/file
30 # Username to use as the default in an element ACL. The default is the
31 # user that starts pwmd.
32 #invoking_user=nobody
34 # Like invoking_user, but for remote connections, an SHA-256 hash of a client
35 # TLS fingerprint.
36 #invoking_tls=#FINGERPRINT
38 # When false, disable keeping backups for data files.
39 #backup=true
41 # Log file location.
42 #log_path=~/.pwmd/log
44 # Set to true to enable logging to log_path.
45 #enable_logging=false
47 # Disable to close the logging file descriptor (log_path) after writing each
48 # line.
49 #log_keepopen=true
51 # Set to true to enable logging to syslog.
52 #syslog=false
54 # The logging level: 0=connections and errors, 1=client commands.
55 #log_level=0
57 # Enable gpg-agent support.
58 #use_agent=false
60 # The location of the gpg-agent socket.
61 #gpg_agent_socket=~/.gnupg/S.gpg-agent
63 # Kill the smartcard daemon after each OPEN or SAVE.
64 #kill_scd=false
66 # Require the passphrase needed for a data file before each SAVE.
67 #require_save_key=true
69 # Set to false to call mlockall(2) after a client connects. Uses more memory
70 # but is also more secure. Most will probably find it overkill since the
71 # contents of all memory is cleared before being freed.
72 #disable_mlockall=true
74 # Disable the XPATH, LIST and DUMP commands. When "true" and a client sends
75 # these commands the error GPG_ERR_NOT_IMPLEMENTED will be returned.
76 #disable_list_and_dump=false
78 # When sending data to the client an XFER status message will be sent after
79 # N bytes. N is rounded to ASSUAN_LINELENGTH (1002) bytes.
80 #xfer_progress=8196
82 # A comma separated list of filenames to add to the file cache upon startup.
83 # You will be prompted for the passphrasefor each file if required. The files
84 # are looked for in ~/.pwmd/data. This also affects rcfile reloading via
85 # SIGHUP.
86 #cache_push=somefile,anotherfile
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
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
96 # The priority or nice value of the server process. The default is inherited
97 # from the parent process.
98 #priority=10
100 # The cipher to use for newly created files.
101 #cipher=aes256
103 # The number of cipher encryption iterations of the data. This differs from
104 # the s2k_count option (see below) that determines the hash iterations of the
105 # passphrase.
106 #cipher_iterations=0
108 # Send a status message to the client after this many encryption/decryption
109 # iterations.
110 #cipher_progress=2000
112 # The default key parameters to use when generating a new keypair
113 # (RSA 2048 bit).
114 #keyparam=(genkey (rsa (nbits 4:2048)))
116 # The number of passphrase hashing iterations for new files and when changing
117 # the passphrase of a secret key. The default is the calibrated value of the
118 # machine, or 0.
119 #s2k_count=0
121 # In tenths of a second, the amount of time to wait for a file lock before
122 # returning an error to the client.
123 #lock_timeout=50
125 # Whether to enable TCP/TLS server support. If enabled, both TCP and the local
126 # unix domain socket will listen for connections.
127 #enable_tcp=false
129 # If TCP is enabled, the port to listen on.
130 #tcp_port=6466
132 # The network interface to listen on.
133 #tcp_interface=eth1
135 # The number of seconds to wait for a network read and write to complete
136 # for TLS connections.
137 #tls_timeout=300
139 # Require the client to provide the key to open a file even if the file is
140 # cached.
141 #tcp_require_key=false
143 # The time in tenths of a second to wait for a new TCP connection.  Setting to
144 # 0 will disable waiting.
145 #tcp_wait=3
147 # Accept TCP connections from the specified protocol. One of: ipv4, ipv6 or
148 # any. The default is "any".
149 #tcp_bind=any
151 # The GnuTLS cipher suite and protocol to use.
152 #tls_cipher_suite=SECURE256
154 # TLS key exchange security level: low, medium or high.
155 #tls_dh_level=medium
157 # The interval in seconds to send the KEEPALIVE status message when
158 # not in a command.
159 #keepalive_interval=60
161 # Send client state information to all connected clients. 0=disable, 1=all,
162 # 2=invoking user clients only.
163 #send_state=2
165 # END GLOBAL SETTINGS
167 # File specific settings are allowed by placing the filename in braces. Each
168 # file can have it's own configuration settings from those listed below.
169 #[somefile]
170 #allowed=@group,!not_this_user,!#DENIEDFINGERPRINT
171 #cache_timeout=300
172 #passphrase=password
173 #passphrase_file=/path/to/file.key
174 #backup=true
175 #xfer_progress=1024
176 #recursion_depth=200