Commit f31ab5f7 authored by Felix Eckhofer's avatar Felix Eckhofer 💬

Import v3.1

parent 45afe44a
KPCLI-3.0(1) User Contributed Perl Documentation KPCLI-3.0(1)
KPCLI-3.1(1) User Contributed Perl Documentation KPCLI-3.1(1)
......@@ -7,13 +7,15 @@ NAME
DESCRIPTION
A command line interface (interactive shell) to work with KeePass
database files (http://http://en.wikipedia.org/wiki/KeePass). This
program was inspired by my use of "kedpm -c" combined with my need to
migrate to KeePass. The curious can read about the Ked Password Manager
at http://kedpm.sourceforge.net/.
database files (http://en.wikipedia.org/wiki/KeePass). This program
was inspired by my use of "kedpm -c" combined with my need to migrate
to KeePass. The curious can read about the Ked Password Manager at
http://kedpm.sourceforge.net/.
USAGE
Please run the program and type "help" to learn how to use it.
Please run the program and type "help" to learn how to use it. Run the
program with --help as a command line option to learn about its command
line options.
PREREQUISITES
This program requires these non-core modules:
......@@ -33,17 +35,35 @@ PREREQUISITES
robust to suspend, resume, and interrupt - SIGSTP, SIGCONT and SIGINT.
That module is in the libterm-readline-gnu-perl package on Ubuntu.
You can optionally install "Term::ReadLine::Perl5", which is often
preferred on platforms without GNU readline (MacOS, Windows, etc.)
You can optionally install "Clipboard" and "Tiny::Capture" to use the
clipboard features; http://search.cpan.org/~king/Clipboard/ and
libcapture-tiny-perl on Ubuntu 10.04.
You can optionally install "Sub::Install" to use the --timeout feature.
You can optionally install "Data::Password" to use the pwck feature
(Password Quality Check); libdata-password-perl on Ubuntu 10.04.
You can optionally install "Data::Password::passwdqc", which is
preferred by the pwck feature if it is available. That module is not
commonly packaged and its list of dependencies is quite long, but
cpanminus installs it nicely on Linux Mint. It appeared that all of its
upstream dependencies were packaged in Linux Mint and so I apt-get
install'ed them first, and then cpanminus only installed
"Data::Password::passwdqc". Because it is a binding to a C library,
"Data::Password::passwdqc" is much faster than "Data::Password" and
also seems to have a bit more stict password rules.
You can optionally install "Crypt::PWSafe3" in order to import Password
Safe v3 files (http://passwordsafe.sf.net). The dependency list of this
module is hefty and it is not packaged in many distros, but cpanminus
installs it nicely on Linux Mint (https://cpanmin.us/).
Safe v3 files (https://pwsafe.org/). The dependency list of this module
is hefty and it is not packaged in many distros, but cpanminus installs
it nicely on Linux Mint (https://cpanmin.us/).
You can optionally install "Math::Random::ISAAC" in order to use a more
secure rand() function. Package libmath-random-isaac-perl on Debian.
On MS Windows, you can optionally install "Win32::Console::ANSI" to get
ANSI colors in Windows cmd terminals. Strawberry Perl 5.16.2 was used
......@@ -61,15 +81,13 @@ CAVEATS AND WORDS OF CAUTION
kpcli versions, is asked to validate them with both v1 and v2 files.
Some versions of Term::ReadLine::Perl5 are incompatible
Some versions of "Term::ReadLine::Perl5" are incompatible with the
"Term::ReadLine::Perl5" versions 1.39-1.42 are incompatible with the
"Term::ShellUI" module, which is core to kpcli. There is information
about this in kpcli SF bug #18
(http://sourceforge.net/p/kpcli/bugs/18/). The "Term::ReadLine::Perl5"
(http://sourceforge.net/p/kpcli/bugs/18/). The "Term::ReadLine::Perl5"
author submitted a "Term::ShellUI" patch to resolve the issue
(https://rt.cpan.org/Ticket/Display.html?id=105375). As of this
writing that patch is not integrated and so I am making a note of it
here for users that it may bite. Those users are most often on MacOS X
or Windows. Linux users most often use "Term::ReadLine::Gnu".
(https://rt.cpan.org/Ticket/Display.html?id=105375) and he also
released "Term::ReadLine::Perl5" version 1.43 which resolves it.
No history tracking for KeePass 2 (*.kdbx) files
Recording entries' history in KeePass 2 files is not implemented.
......@@ -286,11 +304,23 @@ CHANGELOG
Added $FORCED_READLINE global variable.
Attachments sanity check; SourceForge bug #17.
Endianness fix in magic_file_type(); SF bug #19.
2016-Jul-30 v3.1 - Added the purge command.
Added Data::Password::passwdqc support to the
pwck command and prefer it over Data::Password.
Minor improvements in cli_pwck().
Applied SF patch #6 from Chris van Marle.
Addressed items pointed out in SF patch #7.
In cli_save(), worked around a File::KeePass bug.
- rt.cpan.org tik# 113391; https://goo.gl/v65HKE
Applied SF patch #8 from Maciej Grela.
Optional better RNG; SF bug #30 from Aaron Toponce.
TODO ITEMS
Consider broadening shell_expansion support beyond just mv and ls.
Consider adding /shadow_copies/<entries> feature, where kpcli
will write "shadow copies" of the database, one for each entry,
using the path/password in the url/password fields.
Consider adding a purge command for "Backup"/"Recycle Bin" folders.
Consider broadening shell_expansion support beyond just mv and ls.
Consider adding a tags command for use with v2 files.
- To navigate by entry tags
......@@ -301,9 +331,6 @@ TODO ITEMS
Consider adding KeePass 2.x style multi-user synchronization.
Consider http://search.cpan.org/~sherwin/Data-Password-passwdqc/
for password quality checking.
Consider adding searches for created, modified, and accessed times
older than a user supplied time.
......@@ -322,4 +349,4 @@ OPERATING SYSTEMS AND SCRIPT CATEGORIZATION
perl v5.18.2 2015-06-19 KPCLI-3.0(1)
perl v5.18.2 2016-07-30 KPCLI-3.1(1)
This diff is collapsed.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment