Include config.h in mem.c so gettext.h can be preprocessed correctly.
[pwmd.git] / NEWS
blobedb5f21233e72bf2be0b53fb3d05487ff9ec71cb
1 PWMD v1.0
2 ----------
3 EPWMD_FILE_NOT_FOUND is no longer used. It is up to the client to determine
4 if the file exists by using the GETCONFIG command along with 'data_directory'.
6 The CLEARCACHE command will always succeed (return 0) even if the file is not
7 found.
9 A few minor bugfixes.
12 PWMD v0.12
13 ----------
14 Added gettext support. Translations welcome.
16 Strip the first '!' of a newly created element. If there's a following one
17 it's an error. This is to avoid syntax errors and confusion with other
18 commands and element paths.
20 Only show the number of iterations so far when showing the PROGRESS status
21 message. The client can get the percentage by calculating the
22 "iteration_progress" with GETCONFIG.
24 Fixed a huge memory leak with (de)compression.
26 The cache status message format has changed to only show the used and
27 available slots and without any text strings to make it easier for clients to
28 parse.
30 SIGUSR1 is caught in the child process. This allows for reloading of the
31 configuration file.
33 Fixed pushing files and xml import with compression.
35 Added --enable-mem-debug to use the standard memory allocators. Valgrind seems
36 to work better this way.
38 Fixed a few memory leaks.
40 Fixed creating invalid XML elements. Elements must not begin with punctuation
41 or digit and not contain any whitespace.
43 The output of the LIST command is no longer sorted. Leave it up to the client.
46 PWMD v0.11
47 ----------
48 Added the GETCONFIG command. This will return a value for a configuration
49 parameter for the opened file or the default value if no file has been opened.
50 The "key" and "key_file" parameters are ignored.
52 Rewrote how element handling is done. No longer uses an xmlTextReader but
53 accesses the xmlDocPtr nodes directly.
55 The STORE command will no longer overwrite the element tree of the last
56 element in the specified element path. Instead it will set the content as
57 usual and keep the child nodes. This affects how GET handles empty elements.
58 GET will return EPWMD_EMPTY instead of EPWMD_TRAILING_ELEMENT. The STORE
59 command can also store content in a root element (account) and remove content
60 or store an empty element by not specifying any content after the last TAB in
61 the element path.
63 Each element in an element path can now be prefixed with the literal '!'
64 character. This allows for following targets of elements other than the root
65 element.
67 The LIST command will now shows all reachable elements including target
68 elements for the specified element path. It also prefixes each element with
69 the literal '!' when needed.
71 Added support for compressing data files before encryption. This adds the
72 "compression_level" configuration parameter. The default is 6 and setting to 0
73 will disable.
75 A couple of bug fixes.
78 PWMD v0.10
79 ----------
80 Fixed libgpg-error descriptions. The errors that pwmd uses for bad syntax and
81 invalid keys etc. used to return an error code that used
82 GPG_ERR_SOURCE_DEFAULT as the source. GPG_ERR_SOURCE_USER_1 is what pwmd uses
83 now. This breaks compatibility with clients that make use of the error codes
84 (i.e., libpwmd). Be sure to update.
86 Non-option arguments on the command line are files to cache upon startup. This
87 acts like the 'cache_push' configuration parameter.
89 The location of the default configuration file is now ~/.pwmd/config and the
90 default data directory is ~/.pwmd/data, and the default log file ~/.pwmd/log.
91 This fixes clients opening these non-data filenames.
93 Fixed default configuration values when an rcfile doesn't have one.
95 The configuration parameters 'key' and 'key_file' now check to make sure the
96 key is valid before adding it to the cache like 'cache_push' does.
98 Clear the file cache and free the memlist on SIGABRT when debugging is not
99 enabled.
101 Added command line option -b to fork pwmd to the background.
103 Added configuration parameter "iteration_progress". pwmd will send the client
104 a status message showing the percent of iterations that are complete while
105 encrypting or decrypting a data file. The default is 0 which disables sending
106 status messages.
108 Sending SIGUSR1 to pwmd will reload the configuration file.
110 New protocol command REALPATH. This will resolve any "target" attribute for
111 all elements in the specified element path and return the result.
113 Some portability (FreeBSD and maybe others) fixes.
115 SIGTERM and SIGABRT are now properly caught in a child process.
117 Bugfixes.
120 PWMD v0.9
121 ---------
122 Now uses the assuan protocol. This requires libassuan and libgpg-error.
124 Clear the shared memory on exit.
126 The CACHE sub-commands ISCACHED, CLEARCACHE and CACHETIMEOUT have been made
127 into their own commands removing the CACHE command itself.
129 The RESETCACHE command and the cache_reset_timeout configuration parameter
130 have been removed. The cached files timeout is reset to it's configured value
131 (or set value with CACHETIMEOUT) after each OPEN or SAVE command.
133 The OPEN command can open another file using the same connection. Beware
134 though that if the OPEN of the new file fails, no file will be open at all.
136 When OPEN'ing a new file with a specified key, cache both the filename and
137 key. Before you had to SAVE to cache the key.
139 All commands will check if the file has been modified before continueing. Not
140 the cache commands though.
142 Don't unlink() a socket filename that wasn't created by pwmd.
144 Fixed allocating more slots than needed.
146 The commands GET, STORE, DELETE and ATTR make use of the "target" attribute
147 unless the element path argument is prefixed with a '!'. The LIST command
148 will support "target" in the next release, hopefully.
150 Accounts names can no longer begin with a '!' character to avoid problems with
151 the "target" attribute.
153 Removed EPWMD_ROOT_TEXT_ELEMENT. The STORE command will return
154 EPWMD_COMMAND_SYNTAX instead.
156 Added command line option -D and configuration parameter
157 "disable_list_and_dump". When specified or enabled, the LIST and DUMP protocol
158 commands will return EPWMD_EMPTY_ELEMENT.
161 PWMD v0.8
162 ---------
163 Use AM_XML2_PATH() for finding libxml2.
165 Split pwmd and libpwmd into their own projects. Both can be found at
166 http://bjk.sourceforge.net/pwmd/.
169 PWMD v0.7
170 ---------
171 cache_push and working directory bugfix.
173 Added two new configuration options "key" and "key_file". Works with
174 cache_push too.
176 Added a boolean "cache_reset_timeout" configuration option to reset the timer
177 for a cached key when the OPEN or SAVE commands are used.
179 Added two new protocol commands CACHE RESET which clears only the key for the
180 specified file and CACHE RESETALL which clears the key for all files.
182 The "name" and "target" attributes are now case-sensitive.
184 The value of an element path that contains a "target" attribute can be
185 obtained by prefixing the account element with a '!'.
188 PWMD v0.6
189 ---------
190 Fix for the LIST command. When an element path was specified and the document
191 had following elements in the tree the following elements would be shown.
193 Added the CACHE TIMEOUT command to specify the lifetime of a cached file in
194 seconds. This adds a new configuration file setting "cache_timeout".
196 Added per-file settings in the configuration file. A file section is declared
197 by placing the filename in braces. Only the "iterations" and "cache_timeout"
198 settings are used in a file section.
200 No longer chdir() to the data directory.
203 PWMD v0.5
204 ---------
205 If a file size is 0 then CACHE ISCACHED will return EPWMD_FILE_NOT_FOUND.
207 Write a structure to the data file which specifies the iterations and IV. This
208 lets you open a file that had a different iteration setting than the current
209 setting. Breaks file compatibility with previous versions for hopefully the
210 last time.
212 cache_push with an invalid password bugfix.
214 Added command line option -I to import an XML file and write the encrypted
215 data to stdout.
218 PWMD v0.4
219 ---------
220 Use AES-256-CBC to store the data file. This breaks file compatibility with
221 older versions. Sorry.
223 The ATTR protocol command has a new GET sub-command to get an attribute value
224 for an element path.
226 The LIST protocol command can now take an element path.
228 The DUMP command will format it's output.
230 Use MAP_ANONYMOUS|MAP_SHARED mmap() flags on Linux 2.4+. This won't create a
231 file in /dev/shm. #define MMAP_ANONYMOUS_SHARED in config.h if your OS
232 supports this.
234 Fixed closing file descriptors.
236 Fixed some memory leaks.
238 The contents of all memory allocated by Glib, libXML and libgcrypt is cleared
239 before free()ing.
241 Added an "iterations" configuration parameter. This specifies the amount of
242 times to encrypt the data to prevent dictionary attacks. Idea borrowed from
243 aespipe.
246 PWMD v0.3
247 ---------
248 The SETATTR protocol command has been renamed to ATTR. This new command
249 includes three new sub-commands: SET, DELETE and LIST, to SET or update an
250 attribute, DELETE to delete an attribute and LIST to list attributes of an
251 element path. Read PROTOCOL for details.
253 Added the TARGET attribute. If an element has this attribute set, it's value
254 is another element path. It's recursive too so the destination element path
255 can be an element with a TARGET attribute. Be careful of loops though.
257 Added the DUMP protocol command. It shows the in-memory document. Useful for
258 cleaning up empty elements that aren't shown with any command.
260 The "name" attribute can be used in any element but cannot be removed for the
261 root "account" element.
263 More strict element name validation for new elements.
265 Code reorganization. Protocol commands have been put in src/commands.c.
267 The LIST command won't show element values anymore unless DEBUG was defined at
268 compile time. You must use the GET command to get a value.
270 The OPEN and SAVE protocol commands no longer expect a base64 encoded key.
271 Plain text is where it's at.
273 The STORE command wont base64 encode the value. We'll leave it up to the
274 client. But it's still recommended to avoid parsing errors.
276 All of the command line options have been moved into a configuration file. By
277 default pwmd will look for it in ~/.pwmdrc. You can use -f to specify an
278 alternate file. If the file doesn't exist, then some defaults will be used.
279 There is one new config option though; "cache_push" will take a list of
280 filenames as an argument. This will prompt for passwords upon startup and add
281 the file to the cache. It's a (temporary?) fix for background processes that
282 don't have an attached tty (see libpwmd/KnownBugs). Just make sure the file
283 the other process needs is added to the cache.
286 PWMD v0.2
287 ---------
288 There is a library included in the archive to make interfacing the pwmd alot
289 easier. See libpwmd/README for more information.
291 A (temporary) fix for 100% CPU usage after a client connects.
293 GnuPG is no longer used for data encryption. Instead, libgcrypt will
294 encrypt/decrypt the data with AES-128 key. The OPEN and SAVE commands will
295 need the base64 encoded key.
297 Renamed host to hostname and added sslfingerprint to the DTD.
299 Added command line option -s to specify the socket path.
301 Added command line option -d to specify where pwmd will open and save the data
302 files.
304 Renamed protocol command SET to SETATTR.
306 Added shared memory file caching. If a file is found in the cache then the
307 cached password associated with the file will be used with the OPEN command.
308 With SAVE, if there is no cached password a key is required, else the cached
309 password will be used unless there is a key argument. This also adds a new
310 protocol command CACHE with 3 subcommands CLEARALL, CLEAR and ISCACHED.
311 Sending the SIGHUP signal to pwmd will clear the file cache.
313 Added command line option -M to disable calling mlockall(). mlock() will still
314 be used for the file cache reguardless of this option.
316 Added command line option -C to specify the file cache size. The cache size
317 must be in multiples of PAGE_SIZE.
319 Added command line option -l to enable logging to the specified file.
321 If there is a protocol command error, ERR is returned along with a protocol
322 error code and description. See src/pwmd_error.h for error codes.
324 Fix for the DELETE command and deleting an entire element tree when an invalid
325 element was in the element path.
327 Fix for the GET command and finding elements of the same name in other
328 accounts.
330 Added a manual page.
333 PWMD v0.1
334 ---------
335 Initial release.