| File::KDBX::Entry(3pm) | User Contributed Perl Documentation | File::KDBX::Entry(3pm) |
File::KDBX::Entry - A KDBX database entry
version 0.906
An entry in a KDBX database is a record that can contains strings (also called "fields") and binaries (also called "files" or "attachments"). Every string and binary has a key or name. There is a default set of strings that every entry has:
Beyond this, you can store any number of other strings and any number of binaries that you can use for whatever purpose you want.
There is also some metadata associated with an entry. Each entry in a database is identified uniquely by a UUID. An entry can also have an icon associated with it, and there are various timestamps. Take a look at the attributes to see what's available.
A File::KDBX::Entry is a subclass of File::KDBX::Object. View its documentation to see other attributes and methods available on entries.
Entry string and auto-type key sequences can have placeholders or template tags that can be replaced by other values. Placeholders can appear like "{PLACEHOLDER}". For example, a URL string might have a value of "http://example.com?user={USERNAME}". "{USERNAME}" is a placeholder for the value of the UserName string of the same entry. If the UserName string had a value of "batman", the URL string would expand to "http://example.com?user=batman".
Some placeholders take an argument, where the argument follows the tag after a colon but before the closing brace, like "{PLACEHOLDER:ARGUMENT}".
Placeholders are documented in the KeePass Help Center <https://keepass.info/help/base/placeholders.html>. This software supports many (but not all) of the placeholders documented there.
Entry Placeholders
Field References
File path Placeholders
Date and Time Placeholders
If the current date and time is "2012-07-25 17:05:34", the "simple" form would be 20120725170534.
Special Key Placeholders
Certain placeholders for use in auto-type key sequences are not supported for replacement, but they will remain as-is so that an auto-type engine (not included) can parse and replace them with the appropriate virtual key presses. For completeness, here is the list that the KeePass program claims to support:
"{TAB}", "{ENTER}", "{UP}", "{DOWN}", "{LEFT}", "{RIGHT}", "{HOME}", "{END}", "{PGUP}", "{PGDN}", "{INSERT}", "{DELETE}", "{SPACE}"
"{BACKSPACE}", "{BREAK}", "{CAPSLOCK}", "{ESC}", "{WIN}", "{LWIN}", "{RWIN}", "{APPS}", "{HELP}", "{NUMLOCK}", "{PRTSC}", "{SCROLLLOCK}"
"{F1}", "{F2}", "{F3}", "{F4}", "{F5}", "{F6}", "{F7}", "{F8}", "{F9}", "{F10}", "{F11}", "{F12}", "{F13}", "{F14}", "{F15}", "{F16}"
"{ADD}", "{SUBTRACT}", "{MULTIPLY}", "{DIVIDE}", "{NUMPAD0}", "{NUMPAD1}", "{NUMPAD2}", "{NUMPAD3}", "{NUMPAD4}", "{NUMPAD5}", "{NUMPAD6}", "{NUMPAD7}", "{NUMPAD8}", "{NUMPAD9}"
Miscellaneous Placeholders
Some of these that remain unimplemented, such as "{CLIPBOARD}", cannot be implemented portably. Some of these I haven't implemented (yet) just because they don't seem very useful. You can create your own placeholder to augment the list of default supported placeholders or to replace a built-in placeholder handler. To create a placeholder, just set it in the %File::KDBX::PLACEHOLDERS hash. For example:
$File::KDBX::PLACEHOLDERS{'MY_PLACEHOLDER'} = sub {
my ($entry) = @_;
...;
};
If the placeholder is expanded in the context of an entry, $entry is the File::KDBX::Entry object in context. Otherwise it is "undef". An entry is in context if, for example, the placeholder is in an entry's strings or auto-type key sequences.
$File::KDBX::PLACEHOLDERS{'MY_PLACEHOLDER:'} = sub {
my ($entry, $arg) = @_; # ^ Notice the colon here
...;
};
If the name of the placeholder ends in a colon, then it is expected to receive an argument. During expansion, everything after the colon and before the end of the placeholder is passed to your placeholder handler subroutine. So if the placeholder is "{MY_PLACEHOLDER:whatever}", $arg will have the value whatever.
An argument is required for placeholders than take one. I.e. The placeholder handler won't be called if there is no argument. If you want a placeholder to support an optional argument, you'll need to set the placeholder both with and without a colon (or they could be different subroutines):
$File::KDBX::PLACEHOLDERS{'RAND'} = $File::KDBX::PLACEHOLDERS{'RAND:'} = sub {
(undef, my $arg) = @_;
return defined $arg ? rand($arg) : rand;
};
You can also remove placeholder handlers. If you want to disable placeholder expansion entirely, just delete all the handlers:
%File::KDBX::PLACEHOLDERS = ();
An entry can be configured to generate one-time passwords, both HOTP (HMAC-based) and TOTP (time-based). The configuration storage isn't completely standardized, but this module supports two predominant configuration styles:
NOTE: To use this feature, you must install the suggested dependency:
To configure TOTP in the KeePassXC style, there is only one string to set: "otp". The value should be any valid otpauth URI. When generating an OTP, all of the relevant OTP properties are parsed from the URI.
To configure TOTP in the KeePass 2 style, set the following strings:
To configure HOTP in the KeePass 2 style, set the following strings:
NOTE: The multiple "Secret" strings are simply a way to store a secret in different formats. Only one of these should actually be set or an error will be thrown.
Here's a basic example:
$entry->string(otp => 'otpauth://totp/Issuer:user?secret=NBSWY3DP&issuer=Issuer');
# OR
$entry->string('TimeOtp-Secret-Base32' => 'NBSWY3DP');
my $otp = $entry->time_otp;
Text color represented as a string of the form "#000000".
Background color represented as a string of the form "#FFFFFF".
TODO
Whether or not the entry is eligible to be matched for auto-typing.
Whether or not to use some kind of obfuscation when sending keystroke sequences to applications.
The default auto-type keystroke sequence.
An array of window title / keystroke sequence associations.
{
window => 'Example Window Title',
keystroke_sequence => '{USERNAME}{TAB}{PASSWORD}{ENTER}',
}
Keystroke sequences can have "Placeholders", most commonly "{USERNAME}" and "{PASSWORD}".
Boolean indicating whether the entry password should be tested for weakness and show up in reports.
Hash with entry strings, including the standard strings as well as any custom ones.
{
# Every entry has these five strings:
Title => { value => 'Example Entry' },
UserName => { value => 'jdoe' },
Password => { value => 's3cr3t', protect => true },
URL => { value => 'https://example.com' }
Notes => { value => '' },
# May also have custom strings:
MySystem => { value => 'The mainframe' },
}
There are methods available to provide more convenient access to strings, including "string", "string_value", "expand_string_value" and "string_peek".
Files or attachments. Binaries are similar to strings except they have a value of bytes instead of test characters.
{
'myfile.txt' => {
value => '...',
},
'mysecrets.txt' => {
value => '...',
protect => true,
},
}
There are methods available to provide more convenient access to binaries, including "binary" and "binary_value".
Array of historical entries. Historical entries are prior versions of the same entry so they all share the same UUID with the current entry.
Alias for the Notes string value.
Alias for the Password string value.
Alias for the Title string value.
Alias for the URL string value.
Aliases for the UserName string value.
\%string = $entry->string($string_key);
$entry->string($string_key, \%string);
$entry->string($string_key, %attributes);
$entry->string($string_key, $value); # same as: value => $value
Get or set a string. Every string has a unique (to the entry) key and flags and so are returned as a hash structure. For example:
$string = {
value => 'Password',
protect => true, # optional
};
Every string should have a value (but might be "undef" due to memory protection) and these optional flags which might exist:
$string = $entry->string_value($string_key);
Access a string value directly. The arguments are the same as for "string". Returns "undef" if the string is not set or is currently memory-protected. This is just a shortcut for:
my $string = do {
my $s = $entry->string(...);
defined $s ? $s->{value} : undef;
};
$string = $entry->expand_string_value($string_key);
Same as "string_value" but will substitute placeholders and resolve field references. Any placeholders that do not expand to values are left as-is.
See "Placeholders".
Some placeholders (notably field references) require the entry be connected to a database and will throw an error if it is not.
Shortcut equivalent to "->expand_string_value('Notes')".
Shortcut equivalent to "->expand_string_value('Password')".
Shortcut equivalent to "->expand_string_value('Title')".
Shortcut equivalent to "->expand_string_value('URL')".
Shortcut equivalent to "->expand_string_value('UserName')".
$other = $entry->other_strings;
$other = $entry->other_strings($delimiter);
Get a concatenation of all non-standard string values. The default delimiter is a newline. This is is useful for executing queries to search for entities based on the contents of these other strings (if any).
$string = $entry->string_peek($string_key);
Same as "string_value" but can also retrieve the value from protected-memory if the value is currently protected.
$entry->add_auto_type_association(\%association);
Add a new auto-type association to an entry.
$string = $entry->expand_keystroke_sequence($keystroke_sequence);
$string = $entry->expand_keystroke_sequence(\%association);
$string = $entry->expand_keystroke_sequence; # use default auto-type sequence
Get a keystroke sequence after placeholder expansion.
\%binary = $entry->binary($binary_key);
$entry->binary($binary_key, \%binary);
$entry->binary($binary_key, %attributes);
$entry->binary($binary_key, $value); # same as: value => $value
Get or set a binary. Every binary has a unique (to the entry) key and flags and so are returned as a hash structure. For example:
$binary = {
value => '...',
protect => true, # optional
};
Every binary should have a value (but might be "undef" due to memory protection) and these optional flags which might exist:
$binary = $entry->binary_value($binary_key);
Access a binary value directly. The arguments are the same as for "binary". Returns "undef" if the binary is not set or is currently memory-protected. This is just a shortcut for:
my $binary = do {
my $b = $entry->binary(...);
defined $b ? $b->{value} : undef;
};
$otp = $entry->hmac_otp(%options);
Generate an HMAC-based one-time password, or "undef" if HOTP is not configured for the entry. The entry's strings generally must first be unprotected, just like when accessing the password. Valid options are:
To configure HOTP, see "One-time Passwords".
$otp = $entry->time_otp(%options);
Generate a time-based one-time password, or "undef" if TOTP is not configured for the entry. The entry's strings generally must first be unprotected, just like when accessing the password. Valid options are:
To configure TOTP, see "One-time Passwords".
$uri_string = $entry->hmac_otp_uri;
$uri_string = $entry->time_otp_uri;
Get a HOTP or TOTP otpauth URI for the entry, if available.
To configure OTP, see "One-time Passwords".
$size = $entry->size;
Get the size (in bytes) of an entry.
NOTE: This is not an exact figure because there is no canonical serialization of an entry. This size should only be used as a rough estimate for comparison with other entries or to impose data size limitations.
$size = $entry->history_size;
Get the size (in bytes) of all historical entries combined.
@removed_historical_entries = $entry->prune_history(%options);
Remove just as many older historical entries as necessary to get under the database limits. The limits are taken from the connected database (if any) or can be overridden with %options:
$entry->add_historical_entry($entry);
Add an entry to the history.
$entry->remove_historical_entry($historical_entry);
Remove an entry from the history.
$current_entry = $entry->current_entry;
Get an entry's current entry. If the entry itself is current (not historical), itself is returned.
$bool = $entry->is_current;
Get whether or not an entry is considered current (i.e. not historical). An entry is current if it is directly in the parent group's entry list.
$bool = $entry->is_historical;
Get whether or not an entry is considered historical (i.e. not current).
This is just the inverse of "is_current".
$entry = $entry->remove;
Remove an entry from its parent group. If the entry is historical, remove it from the history of the current entry. If the entry is current, this behaves the same as "remove" in File::KDBX::Object.
$bool = $entry->searching_enabled;
Get whether or not an entry may show up in search results. This is determine from the entry's parent group's "effective_enable_searching" in File::KDBX::Group value.
Throws if entry has no parent group or if the entry is not connected to a database.
Please report any bugs or feature requests on the bugtracker website <https://github.com/chazmcgarvey/File-KDBX/issues>
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
Charles McGarvey <ccm@cpan.org>
This software is copyright (c) 2022 by Charles McGarvey.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
| 2022-11-20 | perl v5.36.0 |