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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<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="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="Plugins - 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-2019 Dominik Reichl" />
<meta name="robots" content="index, follow" />
<meta name="flattr:id" content="42rykv" />
<title>Plugins - KeePass</title>
<base target="_self" />
<link rel="stylesheet" type="text/css" href="../../default.css" />
</head>
<body>
<table class="sectionsummary"><tr><td width="68">
<img src="../images/b64x64_blockdevice.png" width="64" height="64"
class="singleimg" align="left" alt="Plugin" />
</td><td valign="middle"><h1>KeePass Plugins</h1><br />
Installation, uninstallation and security of KeePass plugins.
</td></tr></table>
<br />
<h2 class="sectiontitle">
<img src="../images/b16x16_blockdevice.png" class="singleimg" alt="Plugin" /> Introduction</h2>
<p>KeePass features a plugin framework. Plugins can provide additional
functionality, like support of more file formats for import/export,
network functionalities, backup features, etc.</p>
<br />
<h2 class="sectiontitle">
<img src="../images/b16x16_message.png" class="singleimg" alt="Info" /> Online
Resources</h2>
<p>Plugins can be found on the
<a href="https://keepass.info/plugins.html" target="_blank">Plugins</a> page.</p>
<br />
<h2 class="sectiontitle">
<img src="../images/b16x16_package_system.png" class="singleimg" alt="Computer" /> Plugin
Installation and Uninstallation</h2>
<p>If there are no explicit instructions how to install the plugin,
follow these steps:</p>
<ol>
<li>Download the plugin from the page above and unpack the ZIP file to a
new folder.</li>
<li>In KeePass, click 'Tools' → 'Plugins' → button
'Open Folder'; KeePass now opens a folder called 'Plugins'.
Move the new folder (containing the plugin files) into the 'Plugins' folder.</li>
<li>Restart KeePass in order to load the new plugin.</li>
</ol>
<!-- <p>In short, to install a plugin you simply need to unpack it
somewhere into the 'Plugins' folder.</p> -->
<p>To uninstall a plugin, delete the plugin files.</p>
<p><strong>Linux:</strong><br />
On some Linux systems, the <code>mono-complete</code> package may be
required for plugins to work properly.</p>
<p><strong>Portability:</strong><br />
PLGX plugins are compiled by KeePass and the generated files are stored
in a <a href="#cache">plugin cache</a>, which by default is located in the
user's application data directory (so, running a PLGX plugin by default
creates files outside the KeePass application directory).
These plugin cache files do not need to be copied to other systems though,
because they are generated on each system and do not contain any user data.</p>
<br />
<h2 class="sectiontitle">
<img src="../images/b16x16_file_locked.png" class="singleimg" alt="Locked" /> Security</h2>
<p><i>What about the security of plugins? Can't malicious plugins
'inject' themselves into KeePass?</i></p>
<p>If plugins can register themselves
(i.e. have write access to the KeePass directory), they could also just
replace the whole 'KeePass.exe' file. It's a problem of file access
rights, not the plugin system.</p>
<p>If you worry about this,
install KeePass as administrator into the program files directory
(which is the default, typically in a folder in 'C:\Program Files (x86)').
Afterwards, run KeePass and other applications only as normal user
(without administrator privileges).</p>
<p>This solves the problem above. As the KeePass directory is write-protected
for normal users, no other program can copy files into it. KeePass requires the plugins to
be in the application directory. Therefore, plugins cannot inject themselves anymore.</p>
<p>If you use the portable package of KeePass or installed it into a different
directory, you need to adjust the directory permissions yourself.</p>
<br />
<a name="cache"></a>
<h2 class="sectiontitle">
<img src="../images/b16x16_package_system.png" class="singleimg" alt="Computer" /> Plugin
Cache</h2>
<p>PLGX plugins are compiled and stored in a plugin cache directory on the
user's system. This cache highly improves the startup performance of KeePass.
Old files are normally deleted from the cache
automatically (this can be disabled in the plugins dialog).
The cache does not contain any user data.</p>
<p>By default, the plugin cache is located in the user's application data
directory. However, this can be overridden using the
<code>Application/PluginCachePath</code> setting in the configuration file
(this setting supports placeholders and environment variables).
So, if you're for example using KeePass on a portable device and don't want
the cache to be on the system, you could set the path to <code>{APPDIR}\PluginCache</code>.</p>
<p><img src="../images/b16x16_warning.png" alt="Warning"
style="vertical-align: middle; height: 1em;" />
Do not relocate the plugin cache into the 'Plugins' folder of the
KeePass application directory, because this can result in a severe
performance degradation.</p>
</body></html>
|
