File: customize.html

package info (click to toggle)
keepass2 2.57%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 14,516 kB
  • sloc: cs: 120,930; xml: 6,271; cpp: 322; sh: 53; makefile: 49
file content (265 lines) | stat: -rw-r--r-- 11,973 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

	<meta http-equiv="X-UA-Compatible" content="IE=edge" />
	<meta http-equiv="expires" content="0" />
	<meta http-equiv="cache-control" content="no-cache" />
	<meta http-equiv="pragma" content="no-cache" />

	<meta name="author" content="Dominik Reichl" />

	
	

	<meta name="DC.title" content="Customization (2.x) - KeePass" />
	<meta name="DC.creator" content="Dominik Reichl" />
	<meta name="DC.type" content="Text" />
	<meta name="DC.format" content="text/html" />
	<meta name="DC.language" content="en" />
	<meta name="DC.rights" content="Copyright (C) 2003-2024 Dominik Reichl" />

	<meta name="robots" content="index, follow" />

	<title>Customization (2.x) - KeePass</title>
	<base target="_self" />
	<link rel="stylesheet" type="text/css" href="../../default.css" />

	
	<style type="text/css">
	/* <![CDATA[ */
	table.flagstbl tr th:nth-of-type(1), table.flagstbl tr th:nth-of-type(2),
	table.flagstbl tr td:nth-of-type(1), table.flagstbl tr td:nth-of-type(2) {
		text-align: right;
	}
	/* ]]> */
	</style>

</head>
<body>





<table class="sectionheader"><tr>
<td><img src="../images/b64x64_package_system.png" alt="" /></td>
<td><h1>Customization (2.x)</h1>
<p>KeePass 2.x features various options for network administrators to
customize the program's appearance and behavior.</p></td>
</tr></table>

<ul>
<li><a href="#start">Preliminaries</a></li>
<li><a href="#masterpwreq">Minimum Master Password Requirements</a></li>
<li><a href="#uiflags">Specifying UI Element States</a></li>
<li><a href="#opt">More Options</a></li>
</ul>

<br />

<a name="start"></a>
<h2 class="sectiontitle"><img src="../images/b16x16_package_system.png" alt="" />
Preliminaries</h2>

<p>Most options below are configured by directly editing the
<code>KeePass.config.xml</code> configuration file. If you're planning to
deploy a customized KeePass version, you should fully understand the
KeePass <a href="../base/configuration.html">configuration system</a>,
especially how to enforce some settings and leave others up to users.</p>

<p>Note that KeePass features a rich plugin framework. If there's no
item in the XML file to configure what you're thinking about, you might
want to write a plugin.</p>

<br />

<a name="masterpwreq"></a>
<h2 class="sectiontitle"><img src="../images/b16x16_kgpg.png" alt="" />
Minimum Master Password Requirements</h2>

<p>You can specify several properties that master passwords must have
in order to be accepted (length, estimated quality, ...).
See <a href="../base/keys.html#pwmin">Specifying Minimum Master Password
Properties</a>.</p>

<br />

<a name="uiflags"></a>
<h2 class="sectiontitle"><img src="../images/b16x16_file_locked.png" alt="" />
Specifying UI Element States</h2>

<p>The state (enabled, disabled, visible, hidden) of several user interface
(UI) elements can be specified using the <code>UIFlags</code> value
of the <code>UI</code> node in the configuration file.
This can be a bitwise combination of one or more of
the following flags:</p>

<table class="tablebox75 flagstbl">
<tr><th>Flag (Hex)</th><th>Flag (Dec)</th>
<th>Description</th></tr>
<tr><td>0x0</td><td>0</td>
<td>Don't force any states (default).</td></tr>
<tr><td>0x1</td><td>1</td>
<td>Disable 'Tools' &rarr; 'Options' menu item.</td></tr>
<tr><td>0x2</td><td>2</td>
<td>Disable 'Tools' &rarr; 'Plugins' menu item.</td></tr>
<tr><td>0x4</td><td>4</td>
<td>Disable 'Tools' &rarr; 'Triggers' menu item.</td></tr>
<tr><td>0x8</td><td>8</td>
<td>Disable controls to specify after how many
days the master key should/must be changed.</td></tr>
<tr><td>0x10</td><td>16</td>
<td>Hide password quality progress bars and information labels.</td></tr>
<tr><td>0x20</td><td>32</td>
<td>Disable 'Help' &rarr; 'Check for Updates' menu item.</td></tr>
<tr><td>0x40</td><td>64</td>
<td>Disable 'Tools' &rarr; 'Database Tools' &rarr; 'XML Replace' menu item.</td></tr>
<tr><td>0x80</td><td>128</td>
<td>Disable 'File' &rarr; 'Database Settings' menu item.</td></tr>
<tr><td>0x10000</td><td>65536</td>
<td>Hide built-in profiles in the
password generator context menu of the entry editing dialog.</td></tr>
<tr><td>0x20000</td><td>131072</td>
<td>Show UI elements related to last access times.<br />
<em>Note:</em> Databases are not marked as modified when a last access time
changes. Thus, when only last access times are changed and the user closes the
database (without saving manually first and without a save forced e.g. by a trigger or plugin),
the changes to the last access times are lost.</td></tr>
<tr><td>0x40000</td><td>262144</td>
<td>Do not display information dialogs when creating a new database.</td></tr>
<tr><td>0x80000</td><td>524288</td>
<td>Do not display auto-type obfuscation compatibility information dialogs.</td></tr>
<tr><td>0x100000</td><td>1048576</td>
<td>Do not clear the quick search terms list when closing/locking a database.<br />
<em>Note:</em> Even if this flag is set, the list is cleared when exiting
KeePass. If you frequently perform the same searches, consider using
<a href="../v2/entry.html#tags">tags</a> or
<a href="../base/search.html#prf">search profiles</a>.</td></tr>
<tr><td>0x200000</td><td>2097152</td>
<td>Enable the Input Method Editor (IME) on
<a href="https://keepass.info/help/kb/sec_desk.html" target="_blank">secure desktops</a>.<br />
<img src="../images/b16x16_warning.png" class="textimg" alt="Warning" />
This can result in problems (black screen, IME/CTF process with
high CPU usage, ...). See
'<a href="https://keepass.info/help/kb/sec_desk.html#ime" target="_blank">Why
does the Input Method Editor (IME) not work?</a>'.</td></tr>
<tr><td>0x400000</td><td>4194304</td>
<td>Automatically adjust weak <a href="../base/security.html#secdictprotect">key transformation</a>
settings to the current default values, without a warning/confirmation dialog.
If this <code>UIFlags</code> bit is set, the option
'Show warning when the key transformation settings are weak'
(which is activated by default) has no effect. When adjusting the
key transformation settings, the database is marked as modified.</td></tr>
</table>

<p>The value of <code>UIFlags</code> must be specified in decimal notation.</p>

<p>For example, if you want to disable the 'Options' and 'Check for Updates'
menu items, you'd specify 33 as value for the <code>UIFlags</code> node
(0x1 + 0x20 = 1 + 32 = 33).</p>

<br />

<a name="opt"></a>
<h2 class="sectiontitle"><img src="../images/b16x16_kcmsystem.png" alt="" />
More Options</h2>

<ul class="withspc">
<li><b>Configuration/Application/ConfigSave</b>:<br />
If this option is set to <code>false</code>, KeePass does not save
any configuration settings (i.e. the configuration is loaded normally,
but changes to it are discarded when exiting KeePass).</li>

<li><b>Configuration/Application/ExpirySoonDays</b>:<br />
Specifies the number of days within which entries are considered
to expire &quot;soon&quot;. The default value is 7.</li>

<li><b>Configuration/Application/HelpUrl</b>:<br />
Specifies the URL that is opened for a help page.
This overrides all other help sources (local and online).
<a href="../base/placeholders.html">Spr</a>-compiled;
the relative help page path is inserted by <code>{BASE}</code>.
This element is used only if it is stored in the
<a href="https://keepass.info/help/kb/config_enf.html" target="_blank">enforced
configuration file</a>.</li>

<li><b>Configuration/Defaults/WinFavsBaseFolderName</b>:<br />
For the 'Windows Favorites' export:
name of the root folder; the default value is 'KeePass'.</li>

<li><b>Configuration/Defaults/WinFavsFileNamePrefix</b>:<br />
For the 'Windows Favorites' export:
prefix for the title of every favorite; the default value is an empty string.</li>

<li><b>Configuration/Defaults/WinFavsFileNameSuffix</b>:<br />
For the 'Windows Favorites' export:
suffix for the title of every favorite; the default value is an empty string.</li>

<li><b>Configuration/Integration/AutoTypeInterKeyDelay</b>:<br />
Specifies the default delay (in ms) between two keypresses sent by auto-type.
The minimum is 1 ms.
Note that very small delays may result in target applications not being able
to process the keypresses correctly.</li>

<li><b>Configuration/Integration/AutoTypeAbortOnWindows</b>:<br />
This node may contain one or more <code>Window</code> nodes that
specify disallowed auto-type target windows (the value of each node must
be a <a href="../base/autotype.html#autowindows">target window filter</a>).

<p>For example, the following configuration disallows auto-typing into
WordPad and LibreOffice Writer:</p>
<pre>&lt;AutoTypeAbortOnWindows&gt;
&nbsp;&nbsp;&nbsp;&nbsp;&lt;Window&gt;* - WordPad&lt;/Window&gt;
&nbsp;&nbsp;&nbsp;&nbsp;&lt;Window&gt;* - LibreOffice Writer&lt;/Window&gt;
&lt;/AutoTypeAbortOnWindows&gt;</pre></li>

<li><b>Configuration/Security/MasterKeyTries</b>:<br />
Specifies how often the master key dialog appears when entering incorrect
master keys. The default value is 3.</li>

<!-- <li><b>Configuration/Security/PreventScreenCapture</b>:<br />
If this option is set to <code>true</code>, KeePass protects its windows
against certain screen capture operations (on Windows 7 and higher;
for details, see the
<a href="https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-setwindowdisplayaffinity"
target="_blank"><code>SetWindowDisplayAffinity</code></a> function).<br />
<img src="../images/b16x16_warning.png" class="textimg" alt="Warning" />
This may also prevent legitimate other software
(accessibility-related tools like Windows Magnifier, remote desktop
solutions, etc.) from seeing KeePass windows.</li> -->

<li><b>Configuration/Security/ProtectProcessWithDacl</b>:<br />
If this option is set to <code>true</code>, KeePass protects its process with a
<!-- https://docs.microsoft.com/en-us/windows/win32/secauthz/dacls-and-aces -->
<a href="https://learn.microsoft.com/en-us/windows/win32/secauthz/dacls-and-aces"
target="_blank">discretionary access control list</a> (DACL).<br />
<img src="../images/b16x16_warning.png" class="textimg" alt="Warning" />
Please note that this also blocks legitimate other software
(accessibility-related tools like Windows Narrator, other security
products like anti-virus programs or firewalls, tools providing user interface
enhancements, etc.) from working with KeePass. Furthermore, various problems
like application hangs, exceptions and crashes may occur.
Therefore, this option is turned off by default and can only be turned on
by manually editing the configuration file.
It only works reasonably in very specific, limited usage scenarios
and is not recommended for most users.<br />
This option works on Windows only and requires the KeePassLibC DLL
(included in default installations and packages).</li>

<li><b>Configuration/UI/TrayIcon/ShowOnlyIfTrayedEx</b>:<br />
If this option is set to <code>true</code>, the KeePass icon in the
system tray is displayed only if the main window has been minimized
to the tray.<br />
<img src="../images/b16x16_warning.png" class="textimg" alt="Warning" />
Turning on this option can result in denial-of-service problems.
If you want to hide the KeePass icon, it is recommended to configure
this in the system settings instead; <!-- (in Windows: 'Personalization' &rarr;
'Taskbar' &rarr; 'Select which icons appear on the taskbar'). -->
see '<a href="https://support.microsoft.com/en-us/windows/customize-the-taskbar-notification-area-e159e8d2-9ac5-b2bd-61c5-bb63c1d437c3"
target="_blank">Customize the taskbar notification area</a>'.</li>
</ul>

</body></html>