2 # ABSTRACT: Encrypted database to store secret text and files
8 use Crypt
::Digest
qw(digest_data);
9 use Crypt
::PRNG
qw(random_bytes);
10 use Devel
::GlobalDestruction
;
11 use File
::KDBX
::Constants
qw(:all :icon);
12 use File
::KDBX
::Error
;
14 use File
::KDBX
::Util
qw(:class :coercion :empty :search :uuid erase simple_expression_query snakify);
15 use Hash
::Util
::FieldHash
qw(fieldhashes);
16 use List
::Util
qw(any first);
17 use Ref
::Util
qw(is_ref is_arrayref is_plain_hashref);
18 use Scalar
::Util
qw(blessed);
23 our $VERSION = '999.999'; # VERSION
26 fieldhashes \
my (%SAFE, %KEYS);
30 $kdbx = File
::KDBX-
>new(%attributes);
31 $kdbx = File
::KDBX-
>new($kdbx); # copy constructor
33 Construct a new L
<File
::KDBX
>.
41 return $_[0]->clone if @_ == 1 && blessed
$_[0] && $_[0]->isa($class);
43 my $self = bless {}, $class;
45 $self->_set_nonlazy_attributes if empty
$self;
49 sub DESTROY
{ local ($., $@, $!, $^E, $?); !in_global_destruction
and $_[0]->reset }
53 $kdbx = $kdbx->init(%attributes);
55 Initialize a L
<File
::KDBX
> with a set of attributes
. Returns itself to allow
method chaining
.
57 This
is called by L
</new
>.
65 @$self{keys %args} = values %args;
74 Set a L
<File
::KDBX
> to an empty
state, ready to load a KDBX file
or build a new one
. Returns itself to allow
81 erase
$self->headers->{+HEADER_INNER_RANDOM_STREAM_KEY
};
82 erase
$self->inner_headers->{+INNER_HEADER_INNER_RANDOM_STREAM_KEY
};
91 $kdbx_copy = $kdbx->clone;
92 $kdbx_copy = File
::KDBX-
>new($kdbx);
94 Clone a L
<File
::KDBX
>. The clone will be an exact copy
and completely independent of the original
.
101 return Storable
::dclone
($self);
104 sub STORABLE_freeze
{
110 return '', $copy, $KEYS{$self} // (), $SAFE{$self} // ();
121 @$self{keys %$clone} = values %$clone;
123 $SAFE{$self} = $safe;
125 # Dualvars aren't cloned as dualvars, so coerce the compression flags.
126 $self->compression_flags($self->compression_flags);
128 $self->objects(history
=> 1)->each(sub { $_->kdbx($self) });
131 ##############################################################################
141 $kdbx = KDBX
::File-
>load(\
$string, $key);
142 $kdbx = KDBX
::File-
>load(*IO
, $key);
143 $kdbx = KDBX
::File-
>load($filepath, $key);
144 $kdbx->load(...); # also instance method
146 $kdbx = File
::KDBX-
>load_string($string, $key);
147 $kdbx = File
::KDBX-
>load_string(\
$string, $key);
148 $kdbx->load_string(...); # also instance method
150 $kdbx = File
::KDBX-
>load_file($filepath, $key);
151 $kdbx->load_file(...); # also instance method
153 $kdbx = File
::KDBX-
>load_handle($fh, $key);
154 $kdbx = File
::KDBX-
>load_handle(*IO
, $key);
155 $kdbx->load_handle(...); # also instance method
157 Load a KDBX file from a string buffer
, IO handle
or file from a filesystem
.
159 L
<File
::KDBX
::Loader
> does the heavy lifting
.
163 sub load
{ shift-
>_loader->load(@_) }
164 sub load_string
{ shift-
>_loader->load_string(@_) }
165 sub load_file
{ shift-
>_loader->load_file(@_) }
166 sub load_handle
{ shift-
>_loader->load_handle(@_) }
170 $self = $self->new if !ref $self;
171 require File
::KDBX
::Loader
;
172 File
::KDBX
::Loader-
>new(kdbx
=> $self);
183 $kdbx->dump(\
$string, $key);
184 $kdbx->dump(*IO
, $key);
185 $kdbx->dump($filepath, $key);
187 $kdbx->dump_string(\
$string, $key);
188 \
$string = $kdbx->dump_string($key);
190 $kdbx->dump_file($filepath, $key);
192 $kdbx->dump_handle($fh, $key);
193 $kdbx->dump_handle(*IO
, $key);
195 Dump a KDBX file to a string buffer
, IO handle
or file
in a filesystem
.
197 L
<File
::KDBX
::Dumper
> does the heavy lifting
.
201 sub dump { shift-
>_dumper->dump(@_) }
202 sub dump_string
{ shift-
>_dumper->dump_string(@_) }
203 sub dump_file
{ shift-
>_dumper->dump_file(@_) }
204 sub dump_handle
{ shift-
>_dumper->dump_handle(@_) }
208 $self = $self->new if !ref $self;
209 require File
::KDBX
::Dumper
;
210 File
::KDBX
::Dumper-
>new(kdbx
=> $self);
213 ##############################################################################
215 =method user_agent_string
217 $string = $kdbx->user_agent_string;
219 Get a text string identifying the database client software
.
223 sub user_agent_string
{
225 sprintf('%s/%s (%s/%s; %s/%s; %s)',
226 __PACKAGE__
, $VERSION, @Config::Config
{qw(package version osname osvers archname)});
229 has sig1
=> KDBX_SIG1
, coerce
=> \
&to_number
;
230 has sig2
=> KDBX_SIG2_2
, coerce
=> \
&to_number
;
231 has version
=> KDBX_VERSION_3_1
, coerce
=> \
&to_number
;
233 has inner_headers
=> {};
236 has deleted_objects
=> {};
237 has raw
=> coerce
=> \
&to_string
;
240 has 'headers.comment' => '', coerce
=> \
&to_string
;
241 has 'headers.cipher_id' => CIPHER_UUID_CHACHA20
, coerce
=> \
&to_uuid
;
242 has 'headers.compression_flags' => COMPRESSION_GZIP
, coerce
=> \
&to_compression_constant
;
243 has 'headers.master_seed' => sub { random_bytes
(32) }, coerce
=> \
&to_string
;
244 has 'headers.encryption_iv' => sub { random_bytes
(16) }, coerce
=> \
&to_string
;
245 has 'headers.stream_start_bytes' => sub { random_bytes
(32) }, coerce
=> \
&to_string
;
246 has 'headers.kdf_parameters' => sub {
248 KDF_PARAM_UUID
() => KDF_UUID_AES
,
249 KDF_PARAM_AES_ROUNDS
() => $_[0]->headers->{+HEADER_TRANSFORM_ROUNDS
} // KDF_DEFAULT_AES_ROUNDS
,
250 KDF_PARAM_AES_SEED
() => $_[0]->headers->{+HEADER_TRANSFORM_SEED
} // random_bytes
(32),
253 # has 'headers.transform_seed' => sub { random_bytes(32) };
254 # has 'headers.transform_rounds' => 100_000;
255 # has 'headers.inner_random_stream_key' => sub { random_bytes(32) }; # 64 ?
256 # has 'headers.inner_random_stream_id' => STREAM_ID_CHACHA20;
257 # has 'headers.public_custom_data' => {};
260 has 'meta.generator' => '', coerce
=> \
&to_string
;
261 has 'meta.header_hash' => '', coerce
=> \
&to_string
;
262 has 'meta.database_name' => '', coerce
=> \
&to_string
;
263 has 'meta.database_name_changed' => sub { gmtime }, coerce
=> \
&to_time
;
264 has 'meta.database_description' => '', coerce
=> \
&to_string
;
265 has 'meta.database_description_changed' => sub { gmtime }, coerce
=> \
&to_time
;
266 has 'meta.default_username' => '', coerce
=> \
&to_string
;
267 has 'meta.default_username_changed' => sub { gmtime }, coerce
=> \
&to_time
;
268 has 'meta.maintenance_history_days' => HISTORY_DEFAULT_MAX_AGE
, coerce
=> \
&to_number
;
269 has 'meta.color' => '', coerce
=> \
&to_string
;
270 has 'meta.master_key_changed' => sub { gmtime }, coerce
=> \
&to_time
;
271 has 'meta.master_key_change_rec' => -1, coerce
=> \
&to_number
;
272 has 'meta.master_key_change_force' => -1, coerce
=> \
&to_number
;
273 # has 'meta.memory_protection' => {};
274 has 'meta.custom_icons' => [];
275 has 'meta.recycle_bin_enabled' => true
, coerce
=> \
&to_bool
;
276 has 'meta.recycle_bin_uuid' => UUID_NULL
, coerce
=> \
&to_uuid
;
277 has 'meta.recycle_bin_changed' => sub { gmtime }, coerce
=> \
&to_time
;
278 has 'meta.entry_templates_group' => UUID_NULL
, coerce
=> \
&to_uuid
;
279 has 'meta.entry_templates_group_changed' => sub { gmtime }, coerce
=> \
&to_time
;
280 has 'meta.last_selected_group' => UUID_NULL
, coerce
=> \
&to_uuid
;
281 has 'meta.last_top_visible_group' => UUID_NULL
, coerce
=> \
&to_uuid
;
282 has 'meta.history_max_items' => HISTORY_DEFAULT_MAX_ITEMS
, coerce
=> \
&to_number
;
283 has 'meta.history_max_size' => HISTORY_DEFAULT_MAX_SIZE
, coerce
=> \
&to_number
;
284 has 'meta.settings_changed' => sub { gmtime }, coerce
=> \
&to_time
;
285 # has 'meta.binaries' => {};
286 # has 'meta.custom_data' => {};
288 has 'memory_protection.protect_title' => false
, coerce
=> \
&to_bool
;
289 has 'memory_protection.protect_username' => false
, coerce
=> \
&to_bool
;
290 has 'memory_protection.protect_password' => true
, coerce
=> \
&to_bool
;
291 has 'memory_protection.protect_url' => false
, coerce
=> \
&to_bool
;
292 has 'memory_protection.protect_notes' => false
, coerce
=> \
&to_bool
;
293 # has 'memory_protection.auto_enable_visual_hiding' => false;
296 HEADER_TRANSFORM_SEED
,
297 HEADER_TRANSFORM_ROUNDS
,
298 HEADER_INNER_RANDOM_STREAM_KEY
,
299 HEADER_INNER_RANDOM_STREAM_ID
,
300 HEADER_PUBLIC_CUSTOM_DATA
,
302 sub _set_nonlazy_attributes
{
304 $self->$_ for list_attributes
(ref $self), @ATTRS;
307 =method memory_protection
309 \
%settings = $kdbx->memory_protection
310 $kdbx->memory_protection(\
%settings);
312 $bool = $kdbx->memory_protection($string_key);
313 $kdbx->memory_protection($string_key => $bool);
315 Get
or set memory protection settings
. This globally
(for the whole database
) configures whether
and which of
316 the standard strings should be memory-protected
. The
default setting
is to memory-protect only I
<Password
>
319 Memory protection can be toggled individually
for each entry string
, and individual settings
take precedence
320 over these global settings
.
324 sub memory_protection
{
326 $self->{meta
}{memory_protection
} = shift if @_ == 1 && is_plain_hashref
($_[0]);
327 return $self->{meta
}{memory_protection
} //= {} if !@_;
329 my $string_key = shift;
330 my $key = 'protect_' . lc($string_key);
332 $self->meta->{memory_protection
}{$key} = shift if @_;
333 $self->meta->{memory_protection
}{$key};
336 =method minimum_version
338 $version = $kdbx->minimum_version;
340 Determine the minimum file version required to save a database losslessly
. Using certain databases features
341 might increase this value
. For example
, setting the KDF to Argon2 will increase the minimum version to at
342 least C
<KDBX_VERSION_4_0
> (i
.e
. C
<0x00040000>) because Argon2 was introduced with KDBX4
.
344 This
method never returns less than C
<KDBX_VERSION_3_1
> (i
.e
. C
<0x00030001>). That file version
is so
345 ubiquitous
and well-supported
, there are seldom reasons to
dump in a lesser format nowadays
.
347 B
<WARNING
:> If you
dump a database with a minimum version higher than the current L
</version
>, the dumper will
348 typically issue a warning
and automatically upgrade the database
. This seems like the safest behavior
in order
349 to avoid data loss
, but lower versions have the benefit of being compatible with more software
. It
is possible
350 to prevent auto-upgrades by explicitly telling the dumper which version to
use, but you
do run the risk of
351 data loss
. A database will never be automatically downgraded
.
355 sub minimum_version
{
358 return KDBX_VERSION_4_1
if any
{
359 nonempty
$_->{last_modification_time
}
360 } values %{$self->custom_data};
362 return KDBX_VERSION_4_1
if any
{
363 nonempty
$_->{name
} || nonempty
$_->{last_modification_time
}
364 } @{$self->custom_icons};
366 return KDBX_VERSION_4_1
if $self->groups->next(sub {
367 nonempty
$_->previous_parent_group ||
369 (any
{ nonempty
$_->{last_modification_time
} } values %{$_->custom_data})
372 return KDBX_VERSION_4_1
if $self->entries(history
=> 1)->next(sub {
373 nonempty
$_->previous_parent_group ||
374 (defined $_->quality_check && !$_->quality_check) ||
375 (any
{ nonempty
$_->{last_modification_time
} } values %{$_->custom_data})
378 return KDBX_VERSION_4_0
if $self->kdf->uuid ne KDF_UUID_AES
;
380 return KDBX_VERSION_4_0
if nonempty
$self->public_custom_data;
382 return KDBX_VERSION_4_0
if $self->objects->next(sub {
383 nonempty
$_->custom_data
386 return KDBX_VERSION_3_1
;
389 ##############################################################################
393 $group = $kdbx->root;
396 Get
or set a database
's root group. You don't necessarily need to explicitly create
or set a root group
397 because it autovivifies
when adding entries
and groups to the database
.
399 Every database
has only a single root group at a
time. Some old KDB files might have multiple root groups
.
400 When reading such files
, a single implicit root group
is created to contain the actual root groups
. When
401 writing to such a format
, if the root group looks like it was implicitly created then it won
't be written and
402 the resulting file might have multiple root groups, as it was before loading. This allows working with older
403 files without changing their written internal structure while still adhering to modern semantics while the
406 The root group of a KDBX database contains all of the database's entries
and other groups
. If you replace the
407 root group
, you are essentially replacing the entire database contents with something
else.
414 $self->{root
} = $self->_wrap_group(@_);
415 $self->{root
}->kdbx($self);
417 $self->{root
} //= $self->_implicit_root;
418 return $self->_wrap_group($self->{root
});
421 # Called by File::KeePass::KDBX so that a File::KDBX an be treated as a File::KDBX::Group in that both types
422 # can have subgroups. File::KDBX already has a `groups' method that does something different from the
423 # File::KDBX::Groups `groups' method.
426 return [] if !$self->{root
};
427 return $self->_has_implicit_root ? $self->root->groups : [$self->root];
430 sub _has_implicit_root
{
432 my $root = $self->root;
433 my $temp = __PACKAGE__-
>_implicit_root;
434 # If an implicit root group has been changed in any significant way, it is no longer implicit.
435 return $root->name eq $temp->name &&
436 $root->is_expanded ^ $temp->is_expanded &&
437 $root->notes eq $temp->notes &&
438 !@{$root->entries} &&
439 !defined $root->custom_icon_uuid &&
440 !keys %{$root->custom_data} &&
441 $root->icon_id == $temp->icon_id &&
442 $root->expires ^ $temp->expires &&
443 $root->default_auto_type_sequence eq $temp->default_auto_type_sequence &&
444 !defined $root->enable_auto_type &&
445 !defined $root->enable_searching;
450 require File
::KDBX
::Group
;
451 return File
::KDBX
::Group-
>new(
454 notes
=> 'Added as an implicit root group by '.__PACKAGE__
.'.',
455 ref $self ? (kdbx
=> $self) : (),
459 =method trace_lineage
461 \
@lineage = $kdbx->trace_lineage($group);
462 \
@lineage = $kdbx->trace_lineage($group, $base_group);
463 \
@lineage = $kdbx->trace_lineage($entry);
464 \
@lineage = $kdbx->trace_lineage($entry, $base_group);
466 Get the direct line of ancestors from C
<$base_group> (default: the root group
) to a group
or entry
. The
467 lineage includes the base group but I
<not> the target group
or entry
. Returns C
<undef> if the target
is not in
468 the database structure
.
475 return $object->lineage(@_);
483 push @lineage, $self->root if !@lineage;
484 my $base = $lineage[-1] or return [];
486 my $uuid = $object->uuid;
487 return \
@lineage if any
{ $_->uuid eq $uuid } @{$base->groups}, @{$base->entries};
489 for my $subgroup (@{$base->groups}) {
490 my $result = $self->_trace_lineage($object, @lineage, $subgroup);
491 return $result if $result;
497 $group = $kdbx->recycle_bin;
498 $kdbx->recycle_bin($group);
500 Get
or set the recycle bin group
. Returns C
<undef> if there
is no recycle bin
and L
</recycle_bin_enabled
> is
501 false
, otherwise the current recycle bin
or an autovivified recycle bin group
is returned
.
507 if (my $group = shift) {
508 $self->recycle_bin_uuid($group->uuid);
512 my $uuid = $self->recycle_bin_uuid;
513 $group = $self->groups->grep(uuid
=> $uuid)->next if $uuid ne UUID_NULL
;
514 if (!$group && $self->recycle_bin_enabled) {
515 $group = $self->add_group(
516 name
=> 'Recycle Bin',
517 icon_id
=> ICON_TRASHCAN_FULL
,
518 enable_auto_type
=> false
,
519 enable_searching
=> false
,
521 $self->recycle_bin_uuid($group->uuid);
526 =method entry_templates
528 $group = $kdbx->entry_templates;
529 $kdbx->entry_templates($group);
531 Get
or set the entry templates group
. May
return C
<undef> if unset
.
535 sub entry_templates
{
537 if (my $group = shift) {
538 $self->entry_templates_group($group->uuid);
541 my $uuid = $self->entry_templates_group;
542 return if $uuid eq UUID_NULL
;
543 return $self->groups->grep(uuid
=> $uuid)->next;
546 =method last_selected
548 $group = $kdbx->last_selected;
549 $kdbx->last_selected($group);
551 Get
or set the
last selected group
. May
return C
<undef> if unset
.
557 if (my $group = shift) {
558 $self->last_selected_group($group->uuid);
561 my $uuid = $self->last_selected_group;
562 return if $uuid eq UUID_NULL
;
563 return $self->groups->grep(uuid
=> $uuid)->next;
566 =method last_top_visible
568 $group = $kdbx->last_top_visible;
569 $kdbx->last_top_visible($group);
571 Get
or set the
last top visible group
. May
return C
<undef> if unset
.
575 sub last_top_visible
{
577 if (my $group = shift) {
578 $self->last_top_visible_group($group->uuid);
581 my $uuid = $self->last_top_visible_group;
582 return if $uuid eq UUID_NULL
;
583 return $self->groups->grep(uuid
=> $uuid)->next;
586 ##############################################################################
590 $kdbx->add_group($group);
591 $kdbx->add_group(%group_attributes, %options);
593 Add a group to a database
. This
is equivalent to identifying a parent group
and calling
594 L
<File
::KDBX
::Group
/add_group
> on the parent group
, forwarding the arguments
. Available options
:
597 * C<group> - Group object or group UUID to add the group to (default: root group)
603 my $group = @_ % 2 == 1 ? shift : undef;
606 # find the right group to add the group to
607 my $parent = delete $args{group
} // $self->root;
608 $parent = $self->groups->grep({uuid
=> $parent})->next if !ref $parent;
609 $parent or throw
'Invalid group';
611 return $parent->add_group(defined $group ? $group : (), %args, kdbx
=> $self);
617 require File
::KDBX
::Group
;
618 return File
::KDBX
::Group-
>wrap($group, $self);
623 \
&iterator
= $kdbx->groups(%options);
624 \
&iterator
= $kdbx->groups($base_group, %options);
626 Get an L
<File
::KDBX
::Iterator
> over I
<groups
> within a database
. Options
:
629 * C<base> - Only include groups within a base group (same as C<$base_group>) (default: L</root>)
630 * C<inclusive> - Include the base group in the results (default: true)
631 * C<algorithm> - Search algorithm, one of C<ids>, C<bfs> or C<dfs> (default: C<ids>)
637 my %args = @_ % 2 == 0 ? @_ : (base
=> shift, @_);
638 my $base = delete $args{base
} // $self->root;
640 return $base->all_groups(%args);
643 ##############################################################################
647 $kdbx->add_entry($entry, %options);
648 $kdbx->add_entry(%entry_attributes, %options);
650 Add a entry to a database
. This
is equivalent to identifying a parent group
and calling
651 L
<File
::KDBX
::Group
/add_entry
> on the parent group
, forwarding the arguments
. Available options
:
654 * C<group> - Group object or group UUID to add the entry to (default: root group)
660 my $entry = @_ % 2 == 1 ? shift : undef;
663 # find the right group to add the entry to
664 my $parent = delete $args{group
} // $self->root;
665 $parent = $self->groups->grep({uuid
=> $parent})->next if !ref $parent;
666 $parent or throw
'Invalid group';
668 return $parent->add_entry(defined $entry ? $entry : (), %args, kdbx
=> $self);
674 require File
::KDBX
::Entry
;
675 return File
::KDBX
::Entry-
>wrap($entry, $self);
680 \
&iterator
= $kdbx->entries(%options);
681 \
&iterator
= $kdbx->entries($base_group, %options);
683 Get an L
<File
::KDBX
::Iterator
> over I
<entries
> within a database
. Supports the same options as L
</groups
>,
687 * C<auto_type> - Only include entries with auto-type enabled (default: false, include all)
688 * C<searching> - Only include entries within groups with searching enabled (default: false, include all)
689 * C<history> - Also include historical entries (default: false, include only current entries)
695 my %args = @_ % 2 == 0 ? @_ : (base
=> shift, @_);
696 my $base = delete $args{base
} // $self->root;
698 return $base->all_entries(%args);
701 ##############################################################################
705 \
&iterator
= $kdbx->objects(%options);
706 \
&iterator
= $kdbx->objects($base_group, %options);
708 Get an L
<File
::KDBX
::Iterator
> over I
<objects
> within a database
. Groups
and entries are considered objects
,
709 so this
is essentially a combination of L
</groups> and L</entries
>. This won
't often be useful, but it can be
710 convenient for maintenance tasks. This method takes the same options as L</groups> and L</entries>.
716 my %args = @_ % 2 == 0 ? @_ : (base => shift, @_);
717 my $base = delete $args{base} // $self->root;
719 return $base->all_objects(%args);
722 sub __iter__ { $_[0]->objects }
724 ##############################################################################
728 \%icon = $kdbx->custom_icon($uuid);
729 $kdbx->custom_icon($uuid => \%icon);
730 $kdbx->custom_icon(%icon);
731 $kdbx->custom_icon(uuid => $value, %icon);
733 Get or set custom icons.
739 my %args = @_ == 2 ? (uuid => shift, data => shift)
740 : @_ % 2 == 1 ? (uuid => shift, @_) : @_;
742 if (!$args{uuid} && !$args{data}) {
743 my %standard = (uuid => 1, data => 1, name => 1, last_modification_time => 1);
744 my @other_keys = grep { !$standard{$_} } keys %args;
745 if (@other_keys == 1) {
746 my $key = $args{key} = $other_keys[0];
747 $args{data} = delete $args{$key};
751 my $uuid = $args{uuid} or throw 'Must provide a custom icon UUID to access
';
752 my $icon = (first { $_->{uuid} eq $uuid } @{$self->custom_icons}) // do {
753 push @{$self->custom_icons}, my $i = { uuid => $uuid };
758 $fields = $args{data} if is_plain_hashref($args{data});
760 while (my ($field, $value) = each %$fields) {
761 $icon->{$field} = $value;
766 =method custom_icon_data
768 $image_data = $kdbx->custom_icon_data($uuid);
770 Get a custom icon image data.
774 sub custom_icon_data {
776 my $uuid = shift // return;
777 my $icon = first { $_->{uuid} eq $uuid } @{$self->custom_icons} or return;
778 return $icon->{data};
781 =method add_custom_icon
783 $uuid = $kdbx->add_custom_icon($image_data, %attributes);
784 $uuid = $kdbx->add_custom_icon(%attributes);
786 Add a custom icon and get its UUID. If not provided, a random UUID will be generated. Possible attributes:
789 * C<uuid> - Icon UUID (default: autogenerated)
790 * C<data> - Image data (same as C<$image_data>)
791 * C<name> - Name of the icon (text, KDBX4.1+)
792 * C<last_modification_time> - Just what it says (datetime, KDBX4.1+)
796 sub add_custom_icon {
798 my %args = @_ % 2 == 1 ? (data => shift, @_) : @_;
800 defined $args{data} or throw 'Must provide image data
';
802 my $uuid = $args{uuid} // generate_uuid;
803 push @{$self->custom_icons}, {
811 =method remove_custom_icon
813 $kdbx->remove_custom_icon($uuid);
815 Remove a custom icon.
819 sub remove_custom_icon {
823 @{$self->custom_icons} = grep { $_->{uuid} eq $uuid ? do { push @deleted, $_; 0 } : 1 }
824 @{$self->custom_icons};
825 $self->add_deleted_object($uuid) if @deleted;
829 ##############################################################################
833 \%all_data = $kdbx->custom_data;
834 $kdbx->custom_data(\%all_data);
836 \%data = $kdbx->custom_data($key);
837 $kdbx->custom_data($key => \%data);
838 $kdbx->custom_data(%data);
839 $kdbx->custom_data(key => $value, %data);
841 Get and set custom data. Custom data is metadata associated with a database.
843 Each data item can have a few attributes associated with it.
846 * C<key> - A unique text string identifier used to look up the data item (required)
847 * C<value> - A text string value (required)
848 * C<last_modification_time> (optional, KDBX4.1+)
854 $self->{meta}{custom_data} = shift if @_ == 1 && is_plain_hashref($_[0]);
855 return $self->{meta}{custom_data} //= {} if !@_;
857 my %args = @_ == 2 ? (key => shift, value => shift)
858 : @_ % 2 == 1 ? (key => shift, @_) : @_;
860 if (!$args{key} && !$args{value}) {
861 my %standard = (key => 1, value => 1, last_modification_time => 1);
862 my @other_keys = grep { !$standard{$_} } keys %args;
863 if (@other_keys == 1) {
864 my $key = $args{key} = $other_keys[0];
865 $args{value} = delete $args{$key};
869 my $key = $args{key} or throw 'Must provide a custom_data key to access
';
871 return $self->{meta}{custom_data}{$key} = $args{value} if is_plain_hashref($args{value});
873 while (my ($field, $value) = each %args) {
874 $self->{meta}{custom_data}{$key}{$field} = $value;
876 return $self->{meta}{custom_data}{$key};
879 =method custom_data_value
881 $value = $kdbx->custom_data_value($key);
883 Exactly the same as L</custom_data> except returns just the custom data's value rather than a structure of
884 attributes
. This
is a shortcut
for:
886 my $data = $kdbx->custom_data($key);
887 my $value = defined $data ? $data->{value
} : undef;
891 sub custom_data_value
{
893 my $data = $self->custom_data(@_) // return;
894 return $data->{value
};
897 =method public_custom_data
899 \
%all_data = $kdbx->public_custom_data;
900 $kdbx->public_custom_data(\
%all_data);
902 $value = $kdbx->public_custom_data($key);
903 $kdbx->public_custom_data($key => $value);
905 Get
and set public custom data
. Public custom data
is similar to custom data but different
in some important
906 ways
. Public custom data
:
909 * can store strings, booleans and up to 64-bit integer values (custom data can only store text values)
910 * is NOT encrypted within a KDBX file (hence the "public" part of the name)
911 * is a plain hash/dict of key-value pairs with no other associated fields (like modification times)
915 sub public_custom_data
{
917 $self->{headers
}{+HEADER_PUBLIC_CUSTOM_DATA
} = shift if @_ == 1 && is_plain_hashref
($_[0]);
918 return $self->{headers
}{+HEADER_PUBLIC_CUSTOM_DATA
} //= {} if !@_;
920 my $key = shift or throw
'Must provide a public_custom_data key to access';
921 $self->{headers
}{+HEADER_PUBLIC_CUSTOM_DATA
}{$key} = shift if @_;
922 return $self->{headers
}{+HEADER_PUBLIC_CUSTOM_DATA
}{$key};
925 ##############################################################################
932 # my %options = @_; # prefer_old / prefer_new
933 # $other->merge_from($self);
940 # die 'Not implemented';
943 =method add_deleted_object
945 $kdbx->add_deleted_object($uuid);
947 Add a UUID to the deleted objects list
. This list
is used to support automatic database merging
.
949 You typically
do not need to call this yourself because the list will be populated automatically as objects
954 sub add_deleted_object
{
958 # ignore null and meta stream UUIDs
959 return if $uuid eq UUID_NULL
|| $uuid eq '0' x
16;
961 $self->deleted_objects->{$uuid} = {
963 deletion_time
=> scalar gmtime,
967 =method remove_deleted_object
969 $kdbx->remove_deleted_object($uuid);
971 Remove a UUID from the deleted objects list
. This list
is used to support automatic database merging
.
973 You typically
do not need to call this yourself because the list will be maintained automatically as objects
978 sub remove_deleted_object
{
981 delete $self->deleted_objects->{$uuid};
984 =method clear_deleted_objects
986 Remove all UUIDs from the deleted objects list
. This list
is used to support automatic database merging
, but
987 if you don
't need merging then you can clear deleted objects to reduce the database file size.
991 sub clear_deleted_objects {
993 %{$self->deleted_objects} = ();
996 ##############################################################################
998 =method resolve_reference
1000 $string = $kdbx->resolve_reference($reference);
1001 $string = $kdbx->resolve_reference($wanted, $search_in, $expression);
1003 Resolve a L<field reference|https://keepass.info/help/base/fieldrefs.html>. A field reference is a kind of
1004 string placeholder. You can use a field reference to refer directly to a standard field within an entry. Field
1005 references are resolved automatically while expanding entry strings (i.e. replacing placeholders), but you can
1006 use this method to resolve on-the-fly references that aren't part of any actual string
in the database
.
1008 If the reference
does not resolve to any field
, C
<undef> is returned
. If the reference resolves to multiple
1009 fields
, only the first one
is returned
(in the same order as iterated by L
</entries
>). To avoid ambiguity
, you
1010 can refer to a specific entry by its UUID
.
1012 The syntax of a reference
is: C
<< {REF
:<WantedField
>@<SearchIn
>:<Text
>} >>. C
<Text
> is a
1013 L
</"Simple Expression">. C
<WantedField
> and C
<SearchIn
> are both single character codes representing a field
:
1022 * C<O> - Other custom strings
1024 Since C<O> does not represent any specific field, it cannot be used as the C<WantedField>.
1028 To get the value of the I<UserName> string of the first entry with "My Bank" in the title:
1030 my $username = $kdbx->resolve_reference('{REF:U@T:"My Bank"}');
1031 # OR the {REF:...} wrapper is optional
1032 my $username = $kdbx->resolve_reference('U@T:"My Bank"');
1033 # OR separate the arguments
1034 my $username = $kdbx->resolve_reference(U => T => '"My Bank"');
1036 Note how the text is a L</"Simple Expression">, so search terms with spaces must be surrounded in double
1039 To get the I<Password> string of a specific entry (identified by its UUID):
1041 my $password = $kdbx->resolve_reference('{REF:P@I:46C9B1FFBD4ABC4BBB260C6190BAD20C}');
1045 sub resolve_reference
{
1047 my $wanted = shift // return;
1048 my $search_in = shift;
1051 if (!defined $text) {
1052 $wanted =~ s/^\{REF:([^\}]+)\}$/$1/i;
1053 ($wanted, $search_in, $text) = $wanted =~ /^([TUPANI])\@([TUPANIO]):(.*)$/i;
1055 $wanted && $search_in && nonempty
($text) or return;
1058 T
=> 'expand_title',
1059 U
=> 'expand_username',
1060 P
=> 'expand_password',
1062 N
=> 'expand_notes',
1064 O
=> 'other_strings',
1066 $wanted = $fields{$wanted} or return;
1067 $search_in = $fields{$search_in} or return;
1069 my $query = $search_in eq 'uuid' ? query
($search_in => uuid
($text))
1070 : simple_expression_query
($text, '=~', $search_in);
1072 my $entry = $self->entries->grep($query)->next;
1075 return $entry->$wanted;
1078 our %PLACEHOLDERS = (
1079 # 'PLACEHOLDER' => sub { my ($entry, $arg) = @_; ... };
1080 'TITLE' => sub { $_[0]->expand_title },
1081 'USERNAME' => sub { $_[0]->expand_username },
1082 'PASSWORD' => sub { $_[0]->expand_password },
1083 'NOTES' => sub { $_[0]->expand_notes },
1084 'S:' => sub { $_[0]->string_value($_[1]) },
1085 'URL' => sub { $_[0]->expand_url },
1086 'URL:RMVSCM' => sub { local $_ = $_[0]->url; s!^[^:/\?\#]+://!!; $_ },
1087 'URL:WITHOUTSCHEME' => sub { local $_ = $_[0]->url; s!^[^:/\?\#]+://!!; $_ },
1088 'URL:SCM' => sub { (split_url
($_[0]->url))[0] },
1089 'URL:SCHEME' => sub { (split_url
($_[0]->url))[0] }, # non-standard
1090 'URL:HOST' => sub { (split_url
($_[0]->url))[2] },
1091 'URL:PORT' => sub { (split_url
($_[0]->url))[3] },
1092 'URL:PATH' => sub { (split_url
($_[0]->url))[4] },
1093 'URL:QUERY' => sub { (split_url
($_[0]->url))[5] },
1094 'URL:HASH' => sub { (split_url
($_[0]->url))[6] }, # non-standard
1095 'URL:FRAGMENT' => sub { (split_url
($_[0]->url))[6] }, # non-standard
1096 'URL:USERINFO' => sub { (split_url
($_[0]->url))[1] },
1097 'URL:USERNAME' => sub { (split_url
($_[0]->url))[7] },
1098 'URL:PASSWORD' => sub { (split_url
($_[0]->url))[8] },
1099 'UUID' => sub { local $_ = format_uuid
($_[0]->uuid); s/-//g; $_ },
1100 'REF:' => sub { $_[0]->kdbx->resolve_reference($_[1]) },
1101 'INTERNETEXPLORER' => sub { load_optional
('IPC::Cmd'); IPC
::Cmd
::can_run
('iexplore') },
1102 'FIREFOX' => sub { load_optional
('IPC::Cmd'); IPC
::Cmd
::can_run
('firefox') },
1103 'GOOGLECHROME' => sub { load_optional
('IPC::Cmd'); IPC
::Cmd
::can_run
('google-chrome') },
1104 'OPERA' => sub { load_optional
('IPC::Cmd'); IPC
::Cmd
::can_run
('opera') },
1105 'SAFARI' => sub { load_optional
('IPC::Cmd'); IPC
::Cmd
::can_run
('safari') },
1106 'APPDIR' => sub { load_optional
('FindBin'); $FindBin::Bin
},
1107 'GROUP' => sub { my $p = $_[0]->group; $p ? $p->name : undef },
1108 'GROUP_PATH' => sub { $_[0]->path },
1109 'GROUP_NOTES' => sub { my $p = $_[0]->group; $p ? $p->notes : undef },
1118 'ENV:' => sub { $ENV{$_[1]} },
1119 'ENV_DIRSEP' => sub { load_optional
('File::Spec')->catfile('', '') },
1120 'ENV_PROGRAMFILES_X86' => sub { $ENV{'ProgramFiles(x86)'} || $ENV{'ProgramFiles'} },
1123 'DT_SIMPLE' => sub { localtime-
>strftime('%Y%m%d%H%M%S') },
1124 'DT_YEAR' => sub { localtime-
>strftime('%Y') },
1125 'DT_MONTH' => sub { localtime-
>strftime('%m') },
1126 'DT_DAY' => sub { localtime-
>strftime('%d') },
1127 'DT_HOUR' => sub { localtime-
>strftime('%H') },
1128 'DT_MINUTE' => sub { localtime-
>strftime('%M') },
1129 'DT_SECOND' => sub { localtime-
>strftime('%S') },
1130 'DT_UTC_SIMPLE' => sub { gmtime-
>strftime('%Y%m%d%H%M%S') },
1131 'DT_UTC_YEAR' => sub { gmtime-
>strftime('%Y') },
1132 'DT_UTC_MONTH' => sub { gmtime-
>strftime('%m') },
1133 'DT_UTC_DAY' => sub { gmtime-
>strftime('%d') },
1134 'DT_UTC_HOUR' => sub { gmtime-
>strftime('%H') },
1135 'DT_UTC_MINUTE' => sub { gmtime-
>strftime('%M') },
1136 'DT_UTC_SECOND' => sub { gmtime-
>strftime('%S') },
1143 'HMACOTP' => sub { $_[0]->hmac_otp },
1144 'TIMEOTP' => sub { $_[0]->time_otp },
1145 'C:' => sub { '' }, # comment
1153 ##############################################################################
1159 Encrypt all protected strings
and binaries
in a database
. The encrypted data
is stored
in
1160 a L
<File
::KDBX
::Safe
> associated with the database
and the actual
values will be replaced with C
<undef> to
1161 indicate their protected
state. Returns itself to allow
method chaining
.
1163 You can call C
<lock> on an already-locked database to memory-protect any unprotected strings
and binaries
1164 added after the
last time the database was locked
.
1170 $SAFE{$self} = shift if @_;
1174 sub _remove_safe
{ delete $SAFE{$_[0]} }
1179 $self->_safe and return $self;
1183 $self->entries(history
=> 1)->each(sub {
1184 push @strings, grep { $_->{protect
} } values %{$_->strings}, values %{$_->binaries};
1187 $self->_safe(File
::KDBX
::Safe-
>new(\
@strings));
1196 Decrypt all protected strings
and binaries
in a database
, replacing C
<undef> value placeholders with their
1197 actual
, unprotected
values. Returns itself to allow
method chaining
.
1203 my $safe = $self->_safe or return $self;
1206 $self->_remove_safe;
1211 =method unlock_scoped
1213 $guard = $kdbx->unlock_scoped;
1215 Unlock a database temporarily
, relocking
when the guard
is released
(typically at the end of a scope
). Returns
1216 C
<undef> if the database
is already unlocked
.
1218 See L
</lock> and L</unlock
>.
1223 my $guard = $kdbx->unlock_scoped;
1226 # $kdbx is now memory-locked
1231 throw
'Programmer error: Cannot call unlock_scoped in void context' if !defined wantarray;
1233 return if !$self->is_locked;
1234 require Scope
::Guard
;
1235 my $guard = Scope
::Guard-
>new(sub { $self->lock });
1242 $string = $kdbx->peek(\
%string);
1243 $string = $kdbx->peek(\
%binary);
1245 Peek at the value of a protected string
or binary without unlocking the whole database
. The argument can be
1246 a string
or binary hashref as returned by L
<File
::KDBX
::Entry
/string> or L<File::KDBX::Entry/binary
>.
1253 my $safe = $self->_safe or return;
1254 return $safe->peek($string);
1259 $bool = $kdbx->is_locked;
1261 Get whether
or not a database
's contents are in a locked (i.e. memory-protected) state. If this is true, then
1262 some or all of the protected strings and binaries within the database will be unavailable (literally have
1263 C<undef> values) until L</unlock> is called.
1267 sub is_locked { !!$_[0]->_safe }
1269 ##############################################################################
1272 # - Fixer tool. Can repair inconsistencies, including:
1273 # - Orphaned binaries... not really a thing anymore since we now distribute binaries amongst entries
1274 # - Unused custom icons (OFF, data loss)
1276 # - All data types are valid
1277 # - date times are correct
1279 # - All UUIDs refer to things that exist
1280 # - previous parent group
1282 # - last selected group
1283 # - last visible group
1284 # - Enforce history size limits (ON)
1285 # - Check headers/meta (ON)
1286 # - Duplicate deleted objects (ON)
1287 # - Duplicate window associations (OFF)
1288 # - Header UUIDs match known ciphers/KDFs?
1291 =method remove_empty_groups
1293 $kdbx->remove_empty_groups;
1295 Remove groups with no subgroups and no entries.
1299 sub remove_empty_groups {
1302 $self->groups(algorithm => 'dfs
')
1303 ->where(-true => 'is_empty
')
1304 ->each(sub { push @removed, $_->remove });
1308 =method remove_unused_icons
1310 $kdbx->remove_unused_icons;
1312 Remove icons that are not associated with any entry or group in the database.
1316 sub remove_unused_icons {
1318 my %icons = map { $_->{uuid} => 0 } @{$self->custom_icons};
1320 $self->objects->each(sub { ++$icons{$_->custom_icon_uuid // ''} });
1323 push @removed, $self->remove_custom_icon($_) for grep { $icons{$_} == 0 } keys %icons;
1327 =method remove_duplicate_icons
1329 $kdbx->remove_duplicate_icons;
1331 Remove duplicate icons as determined by hashing the icon data.
1335 sub remove_duplicate_icons {
1340 for my $icon (@{$self->custom_icons}) {
1341 my $digest = digest_data('SHA256
', $icon->{data});
1342 if (my $other = $seen{$digest}) {
1343 $dup{$icon->{uuid}} = $other->{uuid};
1346 $seen{$digest} = $icon;
1351 while (my ($old_uuid, $new_uuid) = each %dup) {
1353 ->where(custom_icon_uuid => $old_uuid)
1354 ->each(sub { $_->custom_icon_uuid($new_uuid) });
1355 push @removed, $self->remove_custom_icon($old_uuid);
1360 =method prune_history
1362 $kdbx->prune_history(%options);
1364 Remove just as many older historical entries as necessary to get under certain limits.
1367 * C<max_items> - Maximum number of historical entries to keep (default: value of L</history_max_items>, no
1369 * C<max_size> - Maximum total size (in bytes) of historical entries to keep (default: value of
1370 L</history_max_size>, no limit: -1)
1371 * C<max_age> - Maximum age (in days) of historical entries to keep (default: 365, no limit: -1)
1379 my $max_items = $args{max_items} // $self->history_max_items // HISTORY_DEFAULT_MAX_ITEMS;
1380 my $max_size = $args{max_size} // $self->history_max_size // HISTORY_DEFAULT_MAX_SIZE;
1381 my $max_age = $args{max_age} // $self->maintenance_history_days // HISTORY_DEFAULT_MAX_AGE;
1384 $self->entries->each(sub {
1385 push @removed, $_->prune_history(
1386 max_items => $max_items,
1387 max_size => $max_size,
1388 max_age => $max_age,
1394 =method randomize_seeds
1396 $kdbx->randomize_seeds;
1398 Set various keys, seeds and IVs to random values. These values are used by the cryptographic functions that
1399 secure the database when dumped. The attributes that will be randomized are:
1403 * L</inner_random_stream_key>
1405 * L</stream_start_bytes>
1406 * L</transform_seed>
1408 Randomizing these values has no effect on a loaded database. These are only used when a database is dumped.
1409 You normally do not need to call this method explicitly because the dumper does it explicitly by default.
1413 sub randomize_seeds {
1415 $self->encryption_iv(random_bytes(16));
1416 $self->inner_random_stream_key(random_bytes(64));
1417 $self->master_seed(random_bytes(32));
1418 $self->stream_start_bytes(random_bytes(32));
1419 $self->transform_seed(random_bytes(32));
1422 ##############################################################################
1427 $key = $kdbx->key($key);
1428 $key = $kdbx->key($primitive);
1430 Get or set a L<File::KDBX::Key>. This is the master key (e.g. a password or a key file that can decrypt
1431 a database). You can also pass a primitive castable to a B<Key>. See L<File::KDBX::Key/new> for an explanation
1432 of what the primitive can be.
1434 You generally don't need to call this directly because you can provide the key directly to the loader
or
1435 dumper
when loading
or dumping a KDBX file
.
1441 $KEYS{$self} = File
::KDBX
::Key-
>new(@_) if @_;
1445 =method composite_key
1447 $key = $kdbx->composite_key($key);
1448 $key = $kdbx->composite_key($primitive);
1450 Construct a L
<File
::KDBX
::Key
::Composite
> from a B
<Key
> or primitive
. See L
<File
::KDBX
::Key
/new
> for an
1451 explanation of what the primitive can be
. If the primitive
does not represent a composite key
, it will be
1454 You generally don
't need to call this directly. The loader and dumper use it to transform a master key into
1455 a raw encryption key.
1461 require File::KDBX::Key::Composite;
1462 return File::KDBX::Key::Composite->new(@_);
1467 $kdf = $kdbx->kdf(%options);
1468 $kdf = $kdbx->kdf(\%parameters, %options);
1470 Get a L<File::KDBX::KDF> (key derivation function).
1475 * C<params> - KDF parameters, same as C<\%parameters> (default: value of L</kdf_parameters>)
1481 my %args = @_ % 2 == 1 ? (params => shift, @_) : @_;
1483 my $params = $args{params};
1484 my $compat = $args{compatible} // 1;
1486 $params //= $self->kdf_parameters;
1487 $params = {%{$params || {}}};
1489 if (empty $params || !defined $params->{+KDF_PARAM_UUID}) {
1490 $params->{+KDF_PARAM_UUID} = KDF_UUID_AES;
1492 if ($params->{+KDF_PARAM_UUID} eq KDF_UUID_AES) {
1493 # AES_CHALLENGE_RESPONSE is equivalent to AES if there are no challenge-response keys, and since
1494 # non-KeePassXC implementations don't support challenge-response
keys anyway
, there
's no problem with
1495 # always using AES_CHALLENGE_RESPONSE for all KDBX4+ databases.
1496 # For compatibility, we should not *write* AES_CHALLENGE_RESPONSE, but the dumper handles that.
1497 if ($self->version >= KDBX_VERSION_4_0) {
1498 $params->{+KDF_PARAM_UUID} = KDF_UUID_AES_CHALLENGE_RESPONSE;
1500 $params->{+KDF_PARAM_AES_SEED} //= $self->transform_seed;
1501 $params->{+KDF_PARAM_AES_ROUNDS} //= $self->transform_rounds;
1504 require File::KDBX::KDF;
1505 return File::KDBX::KDF->new(%$params);
1508 sub transform_seed {
1510 $self->headers->{+HEADER_TRANSFORM_SEED} =
1511 $self->headers->{+HEADER_KDF_PARAMETERS}{+KDF_PARAM_AES_SEED} = shift if @_;
1512 $self->headers->{+HEADER_TRANSFORM_SEED} =
1513 $self->headers->{+HEADER_KDF_PARAMETERS}{+KDF_PARAM_AES_SEED} //= random_bytes(32);
1516 sub transform_rounds {
1518 $self->headers->{+HEADER_TRANSFORM_ROUNDS} =
1519 $self->headers->{+HEADER_KDF_PARAMETERS}{+KDF_PARAM_AES_ROUNDS} = shift if @_;
1520 $self->headers->{+HEADER_TRANSFORM_ROUNDS} =
1521 $self->headers->{+HEADER_KDF_PARAMETERS}{+KDF_PARAM_AES_ROUNDS} //= 100_000;
1526 $cipher = $kdbx->cipher(key => $key);
1527 $cipher = $kdbx->cipher(key => $key, iv => $iv, uuid => $uuid);
1529 Get a L<File::KDBX::Cipher> capable of encrypting and decrypting the body of a database file.
1531 A key is required. This should be a raw encryption key made up of a fixed number of octets (depending on the
1532 cipher), not a L<File::KDBX::Key> or primitive.
1534 If not passed, the UUID comes from C<< $kdbx->headers->{cipher_id} >> and the encryption IV comes from
1535 C<< $kdbx->headers->{encryption_iv} >>.
1537 You generally don't need to call this directly
. The loader
and dumper
use it to decrypt
and encrypt KDBX
1546 $args{uuid
} //= $self->headers->{+HEADER_CIPHER_ID
};
1547 $args{iv
} //= $self->headers->{+HEADER_ENCRYPTION_IV
};
1549 require File
::KDBX
::Cipher
;
1550 return File
::KDBX
::Cipher-
>new(%args);
1553 =method random_stream
1555 $cipher = $kdbx->random_stream;
1556 $cipher = $kdbx->random_stream(id
=> $stream_id, key
=> $key);
1558 Get a L
<File
::KDBX
::Cipher
::Stream
> for decrypting
and encrypting protected
values.
1560 If
not passed
, the ID
and encryption key comes from C
<< $kdbx->headers->{inner_random_stream_id
} >> and
1561 C
<< $kdbx->headers->{inner_random_stream_key
} >> (respectively
) for KDBX3 files
and from
1562 C
<< $kdbx->inner_headers->{inner_random_stream_key
} >> and
1563 C
<< $kdbx->inner_headers->{inner_random_stream_id
} >> (respectively
) for KDBX4 files
.
1565 You generally don
't need to call this directly. The loader and dumper use it to scramble protected strings.
1573 $args{stream_id} //= delete $args{id} // $self->inner_random_stream_id;
1574 $args{key} //= $self->inner_random_stream_key;
1576 require File::KDBX::Cipher;
1577 File::KDBX::Cipher->new(%args);
1580 sub inner_random_stream_id {
1582 $self->inner_headers->{+INNER_HEADER_INNER_RANDOM_STREAM_ID}
1583 = $self->headers->{+HEADER_INNER_RANDOM_STREAM_ID} = shift if @_;
1584 $self->inner_headers->{+INNER_HEADER_INNER_RANDOM_STREAM_ID}
1585 //= $self->headers->{+HEADER_INNER_RANDOM_STREAM_ID} //= do {
1586 my $version = $self->minimum_version;
1587 $version < KDBX_VERSION_4_0 ? STREAM_ID_SALSA20 : STREAM_ID_CHACHA20;
1591 sub inner_random_stream_key {
1594 # These are probably the same SvPV so erasing one will CoW, but erasing the second should do the
1596 erase \$self->inner_headers->{+INNER_HEADER_INNER_RANDOM_STREAM_KEY};
1597 erase \$self->headers->{+HEADER_INNER_RANDOM_STREAM_KEY};
1598 $self->inner_headers->{+INNER_HEADER_INNER_RANDOM_STREAM_KEY}
1599 = $self->headers->{+HEADER_INNER_RANDOM_STREAM_KEY} = shift;
1601 $self->inner_headers->{+INNER_HEADER_INNER_RANDOM_STREAM_KEY}
1602 //= $self->headers->{+HEADER_INNER_RANDOM_STREAM_KEY} //= random_bytes(64); # 32
1605 #########################################################################################
1607 sub _handle_signal {
1613 'entry
.added
' => \&_handle_object_added,
1614 'group
.added
' => \&_handle_object_added,
1615 'entry
.removed
' => \&_handle_object_removed,
1616 'group
.removed
' => \&_handle_object_removed,
1617 'entry
.uuid
.changed
' => \&_handle_entry_uuid_changed,
1618 'group
.uuid
.changed
' => \&_handle_group_uuid_changed,
1620 my $handler = $handlers{$type} or return;
1621 $self->$handler($object, @_);
1624 sub _handle_object_added {
1627 $self->remove_deleted_object($object->uuid);
1630 sub _handle_object_removed {
1633 my $old_uuid = $object->{uuid} // return;
1635 my $meta = $self->meta;
1636 $self->recycle_bin_uuid(UUID_NULL) if $old_uuid eq ($meta->{recycle_bin_uuid} // '');
1637 $self->entry_templates_group(UUID_NULL) if $old_uuid eq ($meta->{entry_templates_group} // '');
1638 $self->last_selected_group(UUID_NULL) if $old_uuid eq ($meta->{last_selected_group} // '');
1639 $self->last_top_visible_group(UUID_NULL) if $old_uuid eq ($meta->{last_top_visible_group} // '');
1641 $self->add_deleted_object($old_uuid);
1644 sub _handle_entry_uuid_changed {
1647 my $new_uuid = shift;
1648 my $old_uuid = shift // return;
1650 my $old_pretty = format_uuid($old_uuid);
1651 my $new_pretty = format_uuid($new_uuid);
1652 my $fieldref_match = qr/\{REF:([TUPANI])\@I:\Q$old_pretty\E\}/is;
1654 $self->entries->each(sub {
1655 $_->previous_parent_group($new_uuid) if $old_uuid eq ($_->{previous_parent_group} // '');
1657 for my $string (values %{$_->strings}) {
1658 next if !defined $string->{value} || $string->{value} !~ $fieldref_match;
1659 my $txn = $_->begin_work;
1660 $string->{value} =~ s/$fieldref_match/{REF:$1\@I:$new_pretty}/g;
1666 sub _handle_group_uuid_changed {
1669 my $new_uuid = shift;
1670 my $old_uuid = shift // return;
1672 my $meta = $self->meta;
1673 $self->recycle_bin_uuid($new_uuid) if $old_uuid eq ($meta->{recycle_bin_uuid} // '');
1674 $self->entry_templates_group($new_uuid) if $old_uuid eq ($meta->{entry_templates_group} // '');
1675 $self->last_selected_group($new_uuid) if $old_uuid eq ($meta->{last_selected_group} // '');
1676 $self->last_top_visible_group($new_uuid) if $old_uuid eq ($meta->{last_top_visible_group} // '');
1678 $self->groups->each(sub {
1679 $_->last_top_visible_entry($new_uuid) if $old_uuid eq ($_->{last_top_visible_entry} // '');
1680 $_->previous_parent_group($new_uuid) if $old_uuid eq ($_->{previous_parent_group} // '');
1682 $self->entries->each(sub {
1683 $_->previous_parent_group($new_uuid) if $old_uuid eq ($_->{previous_parent_group} // '');
1687 #########################################################################################
1703 =attr deleted_objects
1705 Hash of UUIDs for objects that have been deleted. This includes groups, entries and even custom icons.
1709 Bytes contained within the encrypted layer of a KDBX file. This is only set when using
1710 L<File::KDBX::Loader::Raw>.
1714 A text string associated with the database. Often unset.
1718 The UUID of a cipher used to encrypt the database when stored as a file.
1720 See L<File::KDBX::Cipher>.
1722 =attr compression_flags
1724 Configuration for whether or not and how the database gets compressed. See
1725 L<File::KDBX::Constants/":compression">.
1729 The master seed is a string of 32 random bytes that is used as salt in hashing the master key when loading
1730 and saving the database. If a challenge-response key is used in the master key, the master seed is also the
1733 The master seed I<should> be changed each time the database is saved to file.
1735 =attr transform_seed
1737 The transform seed is a string of 32 random bytes that is used in the key derivation function, either as the
1738 salt or the key (depending on the algorithm).
1740 The transform seed I<should> be changed each time the database is saved to file.
1742 =attr transform_rounds
1744 The number of rounds or iterations used in the key derivation function. Increasing this number makes loading
1745 and saving the database slower by design in order to make dictionary and brute force attacks more costly.
1749 The initialization vector used by the cipher.
1751 The encryption IV I<should> be changed each time the database is saved to file.
1753 =attr inner_random_stream_key
1755 The encryption key (possibly including the IV, depending on the cipher) used to encrypt the protected strings
1756 within the database.
1758 =attr stream_start_bytes
1760 A string of 32 random bytes written in the header and encrypted in the body. If the bytes do not match when
1761 loading a file then the wrong master key was used or the file is corrupt. Only KDBX 2 and KDBX 3 files use
1762 this. KDBX 4 files use an improved HMAC method to verify the master key and data integrity of the header and
1765 =attr inner_random_stream_id
1767 A number indicating the cipher algorithm used to encrypt the protected strings within the database, usually
1768 Salsa20 or ChaCha20. See L<File::KDBX::Constants/":random_stream">.
1770 =attr kdf_parameters
1772 A hash/dict of key-value pairs used to configure the key derivation function. This is the KDBX4+ way to
1773 configure the KDF, superceding L</transform_seed> and L</transform_rounds>.
1777 The name of the software used to generate the KDBX file.
1781 The header hash used to verify that the file header is not corrupt. (KDBX 2 - KDBX 3.1, removed KDBX 4.0)
1785 Name of the database.
1787 =attr database_name_changed
1789 Timestamp indicating when the database name was last changed.
1791 =attr database_description
1793 Description of the database
1795 =attr database_description_changed
1797 Timestamp indicating when the database description was last changed.
1799 =attr default_username
1801 When a new entry is created, the I<UserName> string will be populated with this value.
1803 =attr default_username_changed
1805 Timestamp indicating when the default username was last changed.
1809 A color associated with the database (in the form C<#ffffff> where "f" is a hexidecimal digit). Some agents
1810 use this to help users visually distinguish between different databases.
1812 =attr master_key_changed
1814 Timestamp indicating when the master key was last changed.
1816 =attr master_key_change_rec
1818 Number of days until the agent should prompt to recommend changing the master key.
1820 =attr master_key_change_force
1822 Number of days until the agent should prompt to force changing the master key.
1824 Note: This is purely advisory. It is up to the individual agent software to actually enforce it.
1825 B<File::KDBX> does NOT enforce it.
1829 Array of custom icons that can be associated with groups and entries.
1831 This list can be managed with the methods L</add_custom_icon> and L</remove_custom_icon>.
1833 =attr recycle_bin_enabled
1835 Boolean indicating whether removed groups and entries should go to a recycle bin or be immediately deleted.
1837 =attr recycle_bin_uuid
1839 The UUID of a group used to store thrown-away groups and entries.
1841 =attr recycle_bin_changed
1843 Timestamp indicating when the recycle bin group was last changed.
1845 =attr entry_templates_group
1847 The UUID of a group containing template entries used when creating new entries.
1849 =attr entry_templates_group_changed
1851 Timestamp indicating when the entry templates group was last changed.
1853 =attr last_selected_group
1855 The UUID of the previously-selected group.
1857 =attr last_top_visible_group
1859 The UUID of the group visible at the top of the list.
1861 =attr history_max_items
1863 The maximum number of historical entries that should be kept for each entry. Default is 10.
1865 =attr history_max_size
1867 The maximum total size (in bytes) that each individual entry's history
is allowed to grow
. Default
is 6 MiB
.
1869 =attr maintenance_history_days
1871 The maximum age
(in days
) historical entries should be kept
. Default it
365.
1873 =attr settings_changed
1875 Timestamp indicating
when the database settings were
last updated
.
1879 Alias of the L
</memory_protection
> setting
for the I
<Title
> string
.
1881 =attr protect_username
1883 Alias of the L
</memory_protection
> setting
for the I
<UserName
> string
.
1885 =attr protect_password
1887 Alias of the L
</memory_protection
> setting
for the I
<Password
> string
.
1891 Alias of the L
</memory_protection
> setting
for the I
<URL
> string
.
1895 Alias of the L
</memory_protection
> setting
for the I
<Notes
> string
.
1899 #########################################################################################
1901 sub TO_JSON
{ +{%{$_[0]}} }
1906 =for Pod::Coverage STORABLE_freeze STORABLE_thaw TO_JSON
1912 # Create a new database from scratch
1913 my $kdbx = File::KDBX->new;
1915 # Add some objects to the database
1916 my $group = $kdbx->add_group(
1917 name => 'Passwords',
1919 my $entry = $group->add_entry(
1921 username => 'mreynolds',
1922 password => 's3cr3t',
1925 # Save the database to the filesystem
1926 $kdbx->dump_file('passwords.kdbx', 'masterpw changeme');
1928 # Load the database from the filesystem into a new database instance
1929 my $kdbx2 = File::KDBX->load_file('passwords.kdbx', 'masterpw changeme');
1931 # Iterate over database entries, print entry titles
1932 $kdbx2->entries->each(sub($entry, @) {
1933 say 'Entry: ', $entry->title;
1936 See L</RECIPES> for more examples.
1940 B<File::KDBX> provides everything you need to work with KDBX databases. A KDBX database is a hierarchical
1941 object database which is commonly used to store secret information securely. It was developed for the KeePass
1942 password safe. See L</"Introduction to KDBX"> for more information about KDBX.
1944 This module lets you query entries, create new entries, delete entries, modify entries and more. The
1945 distribution also includes various parsers and generators for serializing and persisting databases.
1947 The design of this software was influenced by the L<KeePassXC|https://github.com/keepassxreboot/keepassxc>
1948 implementation of KeePass as well as the L<File::KeePass> module. B<File::KeePass> is an alternative module
1949 that works well in most cases but has a small backlog of bugs and security issues and also does not work with
1950 newer KDBX version 4 files. If you're coming here from the B<File::KeePass> world, you might be interested in
1951 L<File::KeePass::KDBX> that is a drop-in replacement for B<File::KeePass> that uses B<File::KDBX> for storage.
1953 This software is a B<pre-1.0 release>. The interface should be considered pretty stable, but there might be
1954 minor changes up until a 1.0 release. Breaking changes will be noted in the F<Changes> file.
1959 * ☑ Read and write KDBX version 3 - version 4.1
1960 * ☑ Read and write KDB files (requires L<File::KeePass>)
1961 * ☑ Unicode character strings
1962 * ☑ L</"Simple Expression"> Searching
1963 * ☑ L<Placeholders|File::KDBX::Entry/Placeholders> and L<field references|/resolve_reference>
1964 * ☑ L<One-time passwords|File::KDBX::Entry/"One-time Passwords">
1965 * ☑ L<Very secure|/SECURITY>
1966 * ☑ L</"Memory Protection">
1967 * ☑ Challenge-response key components, like L<YubiKey|File::KDBX::Key::YubiKey>
1968 * ☑ Variety of L<key file|File::KDBX::Key::File> types: binary, hexed, hashed, XML v1 and v2
1969 * ☑ Pluggable registration of different kinds of ciphers and key derivation functions
1970 * ☑ Built-in database maintenance functions
1971 * ☑ Pretty fast, with L<XS optimizations|File::KDBX::XS> available
1972 * ☒ Database synchronization / merging (not yet)
1974 =head2 Introduction to KDBX
1976 A KDBX database consists of a tree of I<groups> and I<entries>, with a single I<root> group. Entries can
1977 contain zero or more key-value pairs of I<strings> and zero or more I<binaries> (i.e. octet strings). Groups,
1978 entries, strings and binaries: that's the KDBX vernacular. A small amount of metadata (timestamps, etc.) is
1979 associated with each entry, group and the database as a whole.
1981 You can think of a KDBX database kind of like a file system, where groups are directories, entries are files,
1982 and strings and binaries make up a file's contents.
1984 Databases are typically persisted as encrypted, compressed files. They are usually accessed directly (i.e.
1985 not over a network). The primary focus of this type of database is data security. It is ideal for storing
1986 relatively small amounts of data (strings and binaries) that must remain secret except to such individuals as
1987 have the correct I<master key>. Even if the database file were to be "leaked" to the public Internet, it
1988 should be virtually impossible to crack with a strong key. The KDBX format is most often used by password
1989 managers to store passwords so that users can know a single strong password and not have to reuse passwords
1990 across different websites. See L</SECURITY> for an overview of security considerations.
1994 =head2 Create a new database
1996 my $kdbx = File::KDBX->new;
1998 my $group = $kdbx->add_group(name => 'Passwords);
1999 my $entry = $group->add_entry(
2000 title => 'WayneCorp',
2001 username => 'bwayne',
2002 password => 'iambatman',
2003 url => 'https://example.com/login'
2005 $entry->add_auto_type_window_association('WayneCorp - Mozilla Firefox', '{PASSWORD}{ENTER}');
2007 $kdbx->dump_file('mypasswords.kdbx', 'master password CHANGEME');
2009 =head2 Read an existing database
2011 my $kdbx = File::KDBX->load_file('mypasswords.kdbx', 'master password CHANGEME');
2012 $kdbx->unlock; # cause $entry->password below to be defined
2014 $kdbx->entries->each(sub($entry, @) {
2015 say 'Found password for: ', $entry->title;
2016 say ' Username: ', $entry->username;
2017 say ' Password: ', $entry->password;
2020 =head2 Search for entries
2022 my @entries = $kdbx->entries(searching => 1)
2023 ->grep(title => 'WayneCorp')
2024 ->each; # return all matches
2026 The C<searching> option limits results to only entries within groups with searching enabled. Other options are
2027 also available. See L</entries>.
2029 See L</QUERY> for many more query examples.
2031 =head2 Search for entries by auto-type window association
2033 my $window_title = 'WayneCorp - Mozilla Firefox';
2035 my $entries = $kdbx->entries(auto_type => 1)
2037 my ($ata) = grep { $_->{window} =~ /\Q$window_title\E/i } @{$_->auto_type_associations};
2038 return [$_, $ata->{keystroke_sequence}] if $ata;
2041 my ($entry, $keys) = @$_;
2042 say 'Entry title: ', $entry->title, ', key sequence: ', $keys;
2047 Entry title: WayneCorp, key sequence: {PASSWORD}{ENTER}
2049 =head2 Remove entries from a database
2052 ->grep(notes => {'=~' => qr/too old/i})
2053 ->each(sub { $_->recycle });
2055 Recycle all entries with the string "too old" appearing in the B<Notes> string.
2057 =head2 Remove empty groups
2059 $kdbx->groups(algorithm => 'dfs')
2060 ->where(-true => 'is_empty')
2063 With the search/iteration C<algorithm> set to "dfs", groups will be ordered deepest first and the root group
2064 will be last. This allows removing groups that only contain empty groups.
2066 This can also be done with one call to L</remove_empty_groups>.
2070 One of the biggest threats to your database security is how easily the encryption key can be brute-forced.
2071 Strong brute-force protection depends on:
2074 * Using unguessable passwords, passphrases and key files.
2075 * Using a brute-force resistent key derivation function.
2077 The first factor is up to you. This module does not enforce strong master keys. It is up to you to pick or
2078 generate strong keys.
2080 The KDBX format allows for the key derivation function to be tuned. The idea is that you want each single
2081 brute-force attempt to be expensive (in terms of time, CPU usage or memory usage), so that making a lot of
2082 attempts (which would be required if you have a strong master key) gets I<really> expensive.
2084 How expensive you want to make each attempt is up to you and can depend on the application.
2086 This and other KDBX-related security issues are covered here more in depth:
2087 L<https://keepass.info/help/base/security.html>
2089 Here are other security risks you should be thinking about:
2093 This distribution uses the excellent L<CryptX> and L<Crypt::Argon2> packages to handle all crypto-related
2094 functions. As such, a lot of the security depends on the quality of these dependencies. Fortunately these
2095 modules are maintained and appear to have good track records.
2097 The KDBX format has evolved over time to incorporate improved security practices and cryptographic functions.
2098 This package uses the following functions for authentication, hashing, encryption and random number
2104 * Argon2d & Argon2id
2109 * Salsa20 & ChaCha20
2112 At the time of this writing, I am not aware of any successful attacks against any of these functions. These
2113 are among the most-analyzed and widely-adopted crypto functions available.
2115 The KDBX format allows the body cipher and key derivation function to be configured. If a flaw is discovered
2116 in one of these functions, you can hopefully just switch to a better function without needing to update this
2117 software. A later software release may phase out the use of any functions which are no longer secure.
2119 =head2 Memory Protection
2121 It is not a good idea to keep secret information unencrypted in system memory for longer than is needed. The
2122 address space of your program can generally be read by a user with elevated privileges on the system. If your
2123 system is memory-constrained or goes into a hibernation mode, the contents of your address space could be
2124 written to a disk where it might be persisted for long time.
2126 There might be system-level things you can do to reduce your risk, like using swap encryption and limiting
2127 system access to your program's address space while your program is running.
2129 B<File::KDBX> helps minimize (but not eliminate) risk by keeping secrets encrypted in memory until accessed
2130 and zeroing out memory that holds secrets after they're no longer needed, but it's not a silver bullet.
2132 For one thing, the encryption key is stored in the same address space. If core is dumped, the encryption key
2133 is available to be found out. But at least there is the chance that the encryption key and the encrypted
2134 secrets won't both be paged out together while memory-constrained.
2136 Another problem is that some perls (somewhat notoriously) copy around memory behind the scenes willy nilly,
2137 and it's difficult know when perl makes a copy of a secret in order to be able to zero it out later. It might
2138 be impossible. The good news is that perls with SvPV copy-on-write (enabled by default beginning with perl
2139 5.20) are much better in this regard. With COW, it's mostly possible to know what operations will cause perl
2140 to copy the memory of a scalar string, and the number of copies will be significantly reduced. There is a unit
2141 test named F<t/memory-protection.t> in this distribution that can be run on POSIX systems to determine how
2142 well B<File::KDBX> memory protection is working.
2144 Memory protection also depends on how your application handles secrets. If your app code is handling scalar
2145 strings with secret information, it's up to you to make sure its memory is zeroed out when no longer needed.
2146 L<File::KDBX::Util/erase> et al. provide some tools to help accomplish this. Or if you're not too concerned
2147 about the risks memory protection is meant to mitigate, then maybe don't worry about it. The security policy
2148 of B<File::KDBX> is to try hard to keep secrets protected while in memory so that your app might claim a high
2149 level of security, in case you care about that.
2151 There are some memory protection strategies that B<File::KDBX> does NOT use today but could in the future:
2153 Many systems allow programs to mark unswappable pages. Secret information should ideally be stored in such
2154 pages. You could potentially use L<mlockall(2)> (or equivalent for your system) in your own application to
2155 prevent the entire address space from being swapped.
2157 Some systems provide special syscalls for storing secrets in memory while keeping the encryption key outside
2158 of the program's address space, like C<CryptProtectMemory> for Windows. This could be a good option, though
2159 unfortunately not portable.
2163 To find things in a KDBX database, you should use a filtered iterator. If you have an iterator, such as
2164 returned by L</entries>, L</groups> or even L</objects> you can filter it using L<File::KDBX::Iterator/where>.
2166 my $filtered_entries = $kdbx->entries->where(\&query);
2168 A C<\&query> is just a subroutine that you can either write yourself or have generated for you from either
2169 a L</"Simple Expression"> or L</"Declarative Syntax">. It's easier to have your query generated, so I'll cover
2172 =head2 Simple Expression
2174 A simple expression is mostly compatible with the KeePass 2 implementation
2175 L<described here|https://keepass.info/help/base/search.html#mode_se>.
2177 An expression is a string with one or more space-separated terms. Terms with spaces can be enclosed in double
2178 quotes. Terms are negated if they are prefixed with a minus sign. A record must match every term on at least
2179 one of the given fields.
2181 So a simple expression is something like what you might type into a search engine. You can generate a simple
2182 expression query using L<File::KDBX::Util/simple_expression_query> or by passing the simple expression as
2183 a B<scalar reference> to C<where>.
2185 To search for all entries in a database with the word "canyon" appearing anywhere in the title:
2187 my $entries = $kdbx->entries->where(\'canyon', qw[title]);
2189 Notice the first argument is a B<scalarref>. This disambiguates a simple expression from other types of
2190 queries covered below.
2192 As mentioned, a simple expression can have multiple terms. This simple expression query matches any entry that
2193 has the words "red" B<and> "canyon" anywhere in the title:
2195 my $entries = $kdbx->entries->where(\'red canyon', qw[title]);
2197 Each term in the simple expression must be found for an entry to match.
2199 To search for entries with "red" in the title but B<not> "canyon", just prepend "canyon" with a minus sign:
2201 my $entries = $kdbx->entries->where(\'red -canyon', qw[title]);
2203 To search over multiple fields simultaneously, just list them all. To search for entries with "grocery" (but
2204 not "Foodland") in the title or notes:
2206 my $entries = $kdbx->entries->where(\'grocery -Foodland', qw[title notes]);
2208 The default operator is a case-insensitive regexp match, which is fine for searching text loosely. You can use
2209 just about any binary comparison operator that perl supports. To specify an operator, list it after the simple
2210 expression. For example, to search for any entry that has been used at least five times:
2212 my $entries = $kdbx->entries->where(\5, '>=', qw[usage_count]);
2214 It helps to read it right-to-left, like "usage_count is greater than or equal to 5".
2216 If you find the disambiguating structures to be distracting or confusing, you can also use the
2217 L<File::KDBX::Util/simple_expression_query> function as a more intuitive alternative. The following example is
2218 equivalent to the previous:
2220 my $entries = $kdbx->entries->where(simple_expression_query(5, '>=', qw[usage_count]));
2222 =head2 Declarative Syntax
2224 Structuring a declarative query is similar to L<SQL::Abstract/"WHERE CLAUSES">, but you don't have to be
2225 familiar with that module. Just learn by examples here.
2227 To search for all entries in a database titled "My Bank":
2229 my $entries = $kdbx->entries->where({ title => 'My Bank' });
2231 The query here is C<< { title => 'My Bank' } >>. A hashref can contain key-value pairs where the key is an
2232 attribute of the thing being searched for (in this case an entry) and the value is what you want the thing's
2233 attribute to be to consider it a match. In this case, the attribute we're using as our match criteria is
2234 L<File::KDBX::Entry/title>, a text field. If an entry has its title attribute equal to "My Bank", it's
2237 A hashref can contain multiple attributes. The search candidate will be a match if I<all> of the specified
2238 attributes are equal to their respective values. For example, to search for all entries with a particular URL
2241 my $entries = $kdbx->entries->where({
2242 url => 'https://example.com',
2246 To search for entries matching I<any> criteria, just change the hashref to an arrayref. To search for entries
2247 with a particular URL B<OR> username:
2249 my $entries = $kdbx->entries->where([ # <-- Notice the square bracket
2250 url => 'https://example.com',
2254 You can use different operators to test different types of attributes. The L<File::KDBX::Entry/icon_id>
2255 attribute is a number, so we should use a number comparison operator. To find entries using the smartphone
2258 my $entries = $kdbx->entries->where({
2259 icon_id => { '==', ICON_SMARTPHONE },
2262 Note: L<File::KDBX::Constants/ICON_SMARTPHONE> is just a constant from L<File::KDBX::Constants>. It isn't
2263 special to this example or to queries generally. We could have just used a literal number.
2265 The important thing to notice here is how we wrapped the condition in another hashref with a single key-value
2266 pair where the key is the name of an operator and the value is the thing to match against. The supported
2270 * C<eq> - String equal
2271 * C<ne> - String not equal
2272 * C<lt> - String less than
2273 * C<gt> - String greater than
2274 * C<le> - String less than or equal
2275 * C<ge> - String greater than or equal
2276 * C<==> - Number equal
2277 * C<!=> - Number not equal
2278 * C<< < >> - Number less than
2279 * C<< > >> - Number greater than
2280 * C<< <= >> - Number less than or equal
2281 * C<< >= >> - Number less than or equal
2282 * C<=~> - String match regular expression
2283 * C<!~> - String does not match regular expression
2284 * C<!> - Boolean false
2285 * C<!!> - Boolean true
2287 Other special operators:
2290 * C<-true> - Boolean true
2291 * C<-false> - Boolean false
2292 * C<-not> - Boolean false (alias for C<-false>)
2293 * C<-defined> - Is defined
2294 * C<-undef> - Is not defined
2295 * C<-empty> - Is empty
2296 * C<-nonempty> - Is not empty
2297 * C<-or> - Logical or
2298 * C<-and> - Logical and
2300 Let's see another example using an explicit operator. To find all groups except one in particular (identified
2301 by its L<File::KDBX::Group/uuid>), we can use the C<ne> (string not equal) operator:
2303 my $groups = $kdbx->groups->where(
2305 'ne' => uuid('596f7520-6172-6520-7370-656369616c2e'),
2309 Note: L<File::KDBX::Util/uuid> is a little utility function to convert a UUID in its pretty form into bytes.
2310 This utility function isn't special to this example or to queries generally. It could have been written with
2311 a literal such as C<"\x59\x6f\x75\x20\x61...">, but that's harder to read.
2313 Notice we searched for groups this time. Finding groups works exactly the same as it does for entries.
2315 Notice also that we didn't wrap the query in hashref curly-braces or arrayref square-braces. Those are
2316 optional. By default it will only match ALL attributes (as if there were curly-braces).
2318 Testing the truthiness of an attribute is a little bit different because it isn't a binary operation. To find
2319 all entries with the password quality check disabled:
2321 my $entries = $kdbx->entries->where('!' => 'quality_check');
2323 This time the string after the operator is the attribute name rather than a value to compare the attribute
2324 against. To test that a boolean value is true, use the C<!!> operator (or C<-true> if C<!!> seems a little too
2325 weird for your taste):
2327 my $entries = $kdbx->entries->where('!!' => 'quality_check');
2328 my $entries = $kdbx->entries->where(-true => 'quality_check'); # same thing
2330 Yes, there is also a C<-false> and a C<-not> if you prefer one of those over C<!>. C<-false> and C<-not>
2331 (along with C<-true>) are also special in that you can use them to invert the logic of a subquery. These are
2332 logically equivalent:
2334 my $entries = $kdbx->entries->where(-not => { title => 'My Bank' });
2335 my $entries = $kdbx->entries->where(title => { 'ne' => 'My Bank' });
2337 These special operators become more useful when combined with two more special operators: C<-and> and C<-or>.
2338 With these, it is possible to construct more interesting queries with groups of logic. For example:
2340 my $entries = $kdbx->entries->where({
2341 title => { '=~', qr/bank/ },
2344 notes => { '=~', qr/business/ },
2345 icon_id => { '==', ICON_TRASHCAN_FULL },
2350 In English, find entries where the word "bank" appears anywhere in the title but also do not have either the
2351 word "business" in the notes or are using the full trashcan icon.
2353 =head2 Subroutine Query
2355 Lastly, as mentioned at the top, you can ignore all this and write your own subroutine. Your subroutine will
2356 be called once for each object being searched over. The subroutine should match the candidate against whatever
2357 criteria you want and return true if it matches or false to skip. To do this, just pass your subroutine
2358 coderef to C<where>.
2360 To review the different types of queries, these are all equivalent to find all entries in the database titled
2363 my $entries = $kdbx->entries->where(\'"My Bank"', 'eq', qw[title]); # simple expression
2364 my $entries = $kdbx->entries->where(title => 'My Bank'); # declarative syntax
2365 my $entries = $kdbx->entries->where(sub { $_->title eq 'My Bank' }); # subroutine query
2367 This is a trivial example, but of course your subroutine can be arbitrarily complex.
2369 All of these query mechanisms described in this section are just tools, each with its own set of limitations.
2370 If the tools are getting in your way, you can of course iterate over the contents of a database and implement
2371 your own query logic, like this:
2373 my $entries = $kdbx->entries;
2374 while (my $entry = $entries->next) {
2375 if (wanted($entry)) {
2376 do_something($entry);
2385 Iterators are the built-in way to navigate or walk the database tree. You get an iterator from L</entries>,
2386 L</groups> and L</objects>. You can specify the search algorithm to iterate over objects in different orders
2387 using the C<algorithm> option, which can be one of these L<constants|File::KDBX::Constants/":iteration">:
2390 * C<ITERATION_IDS> - Iterative deepening search (default)
2391 * C<ITERATION_DFS> - Depth-first search
2392 * C<ITERATION_BFS> - Breadth-first search
2394 When iterating over objects generically, groups always precede their direct entries (if any). When the
2395 C<history> option is used, current entries always precede historical entries.
2397 If you have a database tree like this:
2409 * IDS order of groups is: Root, Group1, Group2, Group3
2410 * IDS order of entries is: EntryA, EntryB, EntryC
2411 * IDS order of objects is: Root, Group1, EntryA, Group2, EntryB, Group3, EntryC
2412 * DFS order of groups is: Group2, Group1, Group3, Root
2413 * DFS order of entries is: EntryB, EntryA, EntryC
2414 * DFS order of objects is: Group2, EntryB, Group1, EntryA, Group3, EntryC, Root
2415 * BFS order of groups is: Root, Group1, Group3, Group2
2416 * BFS order of entries is: EntryA, EntryC, EntryB
2417 * BFS order of objects is: Root, Group1, EntryA, Group3, EntryC, Group2, EntryB
2419 =head1 SYNCHRONIZING
2421 B<TODO> - This is a planned feature, not yet implemented.
2425 Errors in this package are constructed as L<File::KDBX::Error> objects and propagated using perl's built-in
2426 mechanisms. Fatal errors are propagated using L<perlfunc/"die LIST"> and non-fatal errors (a.k.a. warnings)
2427 are propagated using L<perlfunc/"warn LIST"> while adhering to perl's L<warnings> system. If you're already
2428 familiar with these mechanisms, you can skip this section.
2430 You can catch fatal errors using L<perlfunc/"eval BLOCK"> (or something like L<Try::Tiny>) and non-fatal
2431 errors using C<$SIG{__WARN__}> (see L<perlvar/%SIG>). Examples:
2433 use File::KDBX::Error qw(error);
2435 my $key = ''; # uh oh
2437 $kdbx->load_file('whatever.kdbx', $key);
2439 if (my $error = error($@)) {
2440 handle_missing_key($error) if $error->type eq 'key.missing';
2444 or using C<Try::Tiny>:
2447 $kdbx->load_file('whatever.kdbx', $key);
2453 Catching non-fatal errors:
2456 local $SIG{__WARN__} = sub { push @warnings, $_[0] };
2458 $kdbx->load_file('whatever.kdbx', $key);
2460 handle_warnings(@warnings) if @warnings;
2462 By default perl prints warnings to C<STDERR> if you don't catch them. If you don't want to catch them and also
2463 don't want them printed to C<STDERR>, you can suppress them lexically (perl v5.28 or higher required):
2466 no warnings 'File::KDBX';
2473 local $File::KDBX::WARNINGS = 0;
2477 or globally in your program:
2479 $File::KDBX::WARNINGS = 0;
2481 You cannot suppress fatal errors, and if you don't catch them your program will exit.
2485 This software will alter its behavior depending on the value of certain environment variables:
2488 * C<PERL_FILE_KDBX_XS> - Do not use L<File::KDBX::XS> if false (default: true)
2489 * C<PERL_ONLY> - Do not use L<File::KDBX::XS> if true (default: false)
2490 * C<NO_FORK> - Do not fork if true (default: false)
2495 * L<KeePass Password Safe|https://keepass.info/> - The original KeePass
2496 * L<KeePassXC|https://keepassxc.org/> - Cross-Platform Password Manager written in C++
2497 * L<File::KeePass> has overlapping functionality. It's good but has a backlog of some pretty critical bugs and
2498 lacks support for newer KDBX features.
2504 [![Linux](https://github.com/chazmcgarvey/File-KDBX/actions/workflows/linux.yml/badge.svg)](https://github.com/chazmcgarvey/File-KDBX/actions/workflows/linux.yml)
2505 [![macOS](https://github.com/chazmcgarvey/File-KDBX/actions/workflows/macos.yml/badge.svg)](https://github.com/chazmcgarvey/File-KDBX/actions/workflows/macos.yml)
2506 [![Windows](https://github.com/chazmcgarvey/File-KDBX/actions/workflows/windows.yml/badge.svg)](https://github.com/chazmcgarvey/File-KDBX/actions/workflows/windows.yml)
2512 <a title="Linux" href="https://github.com/chazmcgarvey/File-KDBX/actions/workflows/linux.yml"><img src="https://github.com/chazmcgarvey/File-KDBX/actions/workflows/linux.yml/badge.svg"></a>
2513 <a title="macOS" href="https://github.com/chazmcgarvey/File-KDBX/actions/workflows/macos.yml"><img src="https://github.com/chazmcgarvey/File-KDBX/actions/workflows/macos.yml/badge.svg"></a>
2514 <a title="Windows" href="https://github.com/chazmcgarvey/File-KDBX/actions/workflows/windows.yml"><img src="https://github.com/chazmcgarvey/File-KDBX/actions/workflows/windows.yml/badge.svg"></a>