2 # ABSTRACT: Encrypted databases to store secret text and files
7 use Crypt
::PRNG
qw(random_bytes);
8 use Devel
::GlobalDestruction
;
9 use File
::KDBX
::Constants
qw(:all);
10 use File
::KDBX
::Error
;
11 use File
::KDBX
::Iterator
;
13 use File
::KDBX
::Util
qw(:class :coercion :empty :search :uuid erase simple_expression_query snakify);
14 use Hash
::Util
::FieldHash
qw(fieldhashes);
15 use List
::Util
qw(any first);
16 use Ref
::Util
qw(is_ref is_arrayref is_plain_hashref);
17 use Scalar
::Util
qw(blessed);
22 our $VERSION = '999.999'; # VERSION
25 fieldhashes \
my (%SAFE, %KEYS);
29 $kdbx = File
::KDBX-
>new(%attributes);
30 $kdbx = File
::KDBX-
>new($kdbx); # copy constructor
32 Construct a new L
<File
::KDBX
>.
40 return $_[0]->clone if @_ == 1 && blessed
$_[0] && $_[0]->isa($class);
42 my $self = bless {}, $class;
44 $self->_set_nonlazy_attributes if empty
$self;
48 sub DESTROY
{ local ($., $@, $!, $^E, $?); !in_global_destruction
and $_[0]->reset }
52 $kdbx = $kdbx->init(%attributes);
54 Initialize a L
<File
::KDBX
> with a set of attributes
. Returns itself to allow
method chaining
.
56 This
is called by L
</new
>.
64 @$self{keys %args} = values %args;
73 Set a L
<File
::KDBX
> to an empty
state, ready to load a KDBX file
or build a new one
. Returns itself to allow
80 erase
$self->headers->{+HEADER_INNER_RANDOM_STREAM_KEY
};
81 erase
$self->inner_headers->{+INNER_HEADER_INNER_RANDOM_STREAM_KEY
};
90 $kdbx_copy = $kdbx->clone;
91 $kdbx_copy = File
::KDBX-
>new($kdbx);
93 Clone a L
<File
::KDBX
>. The clone will be an exact copy
and completely independent of the original
.
100 return Storable
::dclone
($self);
103 sub STORABLE_freeze
{
109 return '', $copy, $KEYS{$self} // (), $SAFE{$self} // ();
120 @$self{keys %$clone} = values %$clone;
122 $SAFE{$self} = $safe;
124 # Dualvars aren't cloned as dualvars, so coerce the compression flags.
125 $self->compression_flags($self->compression_flags);
127 $self->objects(history
=> 1)->each(sub { $_->kdbx($self) });
130 ##############################################################################
140 $kdbx = KDBX
::File-
>load(\
$string, $key);
141 $kdbx = KDBX
::File-
>load(*IO
, $key);
142 $kdbx = KDBX
::File-
>load($filepath, $key);
143 $kdbx->load(...); # also instance method
145 $kdbx = File
::KDBX-
>load_string($string, $key);
146 $kdbx = File
::KDBX-
>load_string(\
$string, $key);
147 $kdbx->load_string(...); # also instance method
149 $kdbx = File
::KDBX-
>load_file($filepath, $key);
150 $kdbx->load_file(...); # also instance method
152 $kdbx = File
::KDBX-
>load_handle($fh, $key);
153 $kdbx = File
::KDBX-
>load_handle(*IO
, $key);
154 $kdbx->load_handle(...); # also instance method
156 Load a KDBX file from a string buffer
, IO handle
or file from a filesystem
.
158 L
<File
::KDBX
::Loader
> does the heavy lifting
.
162 sub load
{ shift-
>_loader->load(@_) }
163 sub load_string
{ shift-
>_loader->load_string(@_) }
164 sub load_file
{ shift-
>_loader->load_file(@_) }
165 sub load_handle
{ shift-
>_loader->load_handle(@_) }
169 $self = $self->new if !ref $self;
170 require File
::KDBX
::Loader
;
171 File
::KDBX
::Loader-
>new(kdbx
=> $self);
182 $kdbx->dump(\
$string, $key);
183 $kdbx->dump(*IO
, $key);
184 $kdbx->dump($filepath, $key);
186 $kdbx->dump_string(\
$string, $key);
187 \
$string = $kdbx->dump_string($key);
189 $kdbx->dump_file($filepath, $key);
191 $kdbx->dump_handle($fh, $key);
192 $kdbx->dump_handle(*IO
, $key);
194 Dump a KDBX file to a string buffer
, IO handle
or file
in a filesystem
.
196 L
<File
::KDBX
::Dumper
> does the heavy lifting
.
200 sub dump { shift-
>_dumper->dump(@_) }
201 sub dump_string
{ shift-
>_dumper->dump_string(@_) }
202 sub dump_file
{ shift-
>_dumper->dump_file(@_) }
203 sub dump_handle
{ shift-
>_dumper->dump_handle(@_) }
207 $self = $self->new if !ref $self;
208 require File
::KDBX
::Dumper
;
209 File
::KDBX
::Dumper-
>new(kdbx
=> $self);
212 ##############################################################################
214 =method user_agent_string
216 $string = $kdbx->user_agent_string;
218 Get a text string identifying the database client software
.
222 sub user_agent_string
{
224 sprintf('%s/%s (%s/%s; %s/%s; %s)',
225 __PACKAGE__
, $VERSION, @Config::Config
{qw(package version osname osvers archname)});
228 has sig1
=> KDBX_SIG1
, coerce
=> \
&to_number
;
229 has sig2
=> KDBX_SIG2_2
, coerce
=> \
&to_number
;
230 has version
=> KDBX_VERSION_3_1
, coerce
=> \
&to_number
;
232 has inner_headers
=> {};
235 has deleted_objects
=> {};
236 has raw
=> coerce
=> \
&to_string
;
239 has 'headers.comment' => '', coerce
=> \
&to_string
;
240 has 'headers.cipher_id' => CIPHER_UUID_CHACHA20
, coerce
=> \
&to_uuid
;
241 has 'headers.compression_flags' => COMPRESSION_GZIP
, coerce
=> \
&to_compression_constant
;
242 has 'headers.master_seed' => sub { random_bytes
(32) }, coerce
=> \
&to_string
;
243 has 'headers.encryption_iv' => sub { random_bytes
(16) }, coerce
=> \
&to_string
;
244 has 'headers.stream_start_bytes' => sub { random_bytes
(32) }, coerce
=> \
&to_string
;
245 has 'headers.kdf_parameters' => sub {
247 KDF_PARAM_UUID
() => KDF_UUID_AES
,
248 KDF_PARAM_AES_ROUNDS
() => $_[0]->headers->{+HEADER_TRANSFORM_ROUNDS
} // KDF_DEFAULT_AES_ROUNDS
,
249 KDF_PARAM_AES_SEED
() => $_[0]->headers->{+HEADER_TRANSFORM_SEED
} // random_bytes
(32),
252 # has 'headers.transform_seed' => sub { random_bytes(32) };
253 # has 'headers.transform_rounds' => 100_000;
254 # has 'headers.inner_random_stream_key' => sub { random_bytes(32) }; # 64 ?
255 # has 'headers.inner_random_stream_id' => STREAM_ID_CHACHA20;
256 # has 'headers.public_custom_data' => {};
259 has 'meta.generator' => '', coerce
=> \
&to_string
;
260 has 'meta.header_hash' => '', coerce
=> \
&to_string
;
261 has 'meta.database_name' => '', coerce
=> \
&to_string
;
262 has 'meta.database_name_changed' => sub { gmtime }, coerce
=> \
&to_time
;
263 has 'meta.database_description' => '', coerce
=> \
&to_string
;
264 has 'meta.database_description_changed' => sub { gmtime }, coerce
=> \
&to_time
;
265 has 'meta.default_username' => '', coerce
=> \
&to_string
;
266 has 'meta.default_username_changed' => sub { gmtime }, coerce
=> \
&to_time
;
267 has 'meta.maintenance_history_days' => 0, coerce
=> \
&to_number
;
268 has 'meta.color' => '', coerce
=> \
&to_string
;
269 has 'meta.master_key_changed' => sub { gmtime }, coerce
=> \
&to_time
;
270 has 'meta.master_key_change_rec' => -1, coerce
=> \
&to_number
;
271 has 'meta.master_key_change_force' => -1, coerce
=> \
&to_number
;
272 # has 'meta.memory_protection' => {};
273 has 'meta.custom_icons' => [];
274 has 'meta.recycle_bin_enabled' => true
, coerce
=> \
&to_bool
;
275 has 'meta.recycle_bin_uuid' => UUID_NULL
, coerce
=> \
&to_uuid
;
276 has 'meta.recycle_bin_changed' => sub { gmtime }, coerce
=> \
&to_time
;
277 has 'meta.entry_templates_group' => UUID_NULL
, coerce
=> \
&to_uuid
;
278 has 'meta.entry_templates_group_changed' => sub { gmtime }, coerce
=> \
&to_time
;
279 has 'meta.last_selected_group' => UUID_NULL
, coerce
=> \
&to_uuid
;
280 has 'meta.last_top_visible_group' => UUID_NULL
, coerce
=> \
&to_uuid
;
281 has 'meta.history_max_items' => HISTORY_DEFAULT_MAX_ITEMS
, coerce
=> \
&to_number
;
282 has 'meta.history_max_size' => HISTORY_DEFAULT_MAX_SIZE
, coerce
=> \
&to_number
;
283 has 'meta.settings_changed' => sub { gmtime }, coerce
=> \
&to_time
;
284 # has 'meta.binaries' => {};
285 # has 'meta.custom_data' => {};
287 has 'memory_protection.protect_title' => false
, coerce
=> \
&to_bool
;
288 has 'memory_protection.protect_username' => false
, coerce
=> \
&to_bool
;
289 has 'memory_protection.protect_password' => true
, coerce
=> \
&to_bool
;
290 has 'memory_protection.protect_url' => false
, coerce
=> \
&to_bool
;
291 has 'memory_protection.protect_notes' => false
, coerce
=> \
&to_bool
;
292 # has 'memory_protection.auto_enable_visual_hiding' => false;
295 HEADER_TRANSFORM_SEED
,
296 HEADER_TRANSFORM_ROUNDS
,
297 HEADER_INNER_RANDOM_STREAM_KEY
,
298 HEADER_INNER_RANDOM_STREAM_ID
,
299 HEADER_PUBLIC_CUSTOM_DATA
,
301 sub _set_nonlazy_attributes
{
303 $self->$_ for list_attributes
(ref $self), @ATTRS;
306 =method memory_protection
308 \
%settings = $kdbx->memory_protection
309 $kdbx->memory_protection(\
%settings);
311 $bool = $kdbx->memory_protection($string_key);
312 $kdbx->memory_protection($string_key => $bool);
314 Get
or set memory protection settings
. This globally
(for the whole database
) configures whether
and which of
315 the standard strings should be memory-protected
. The
default setting
is to memory-protect only I
<Password
>
318 Memory protection can be toggled individually
for each entry string
, and individual settings
take precedence
319 over these global settings
.
323 sub memory_protection
{
325 $self->{meta
}{memory_protection
} = shift if @_ == 1 && is_plain_hashref
($_[0]);
326 return $self->{meta
}{memory_protection
} //= {} if !@_;
328 my $string_key = shift;
329 my $key = 'protect_' . lc($string_key);
331 $self->meta->{memory_protection
}{$key} = shift if @_;
332 $self->meta->{memory_protection
}{$key};
335 =method minimum_version
337 $version = $kdbx->minimum_version;
339 Determine the minimum file version required to save a database losslessly
. Using certain databases features
340 might increase this value
. For example
, setting the KDF to Argon2 will increase the minimum version to at
341 least C
<KDBX_VERSION_4_0
> (i
.e
. C
<0x00040000>) because Argon2 was introduced with KDBX4
.
343 This
method never returns less than C
<KDBX_VERSION_3_1
> (i
.e
. C
<0x00030001>). That file version
is so
344 ubiquitious
and well-supported
, there are seldom reasons to
dump in a lesser format nowadays
.
346 B
<WARNING
:> If you
dump a database with a minimum version higher than the current L
</version
>, the dumper will
347 typically issue a warning
and automatically upgrade the database
. This seems like the safest behavior
in order
348 to avoid data loss
, but lower versions have the benefit of being compatible with more software
. It
is possible
349 to prevent auto-upgrades by explicitly telling the dumper which version to
use, but you
do run the risk of
350 data loss
. A database will never be automatically downgraded
.
354 sub minimum_version
{
357 return KDBX_VERSION_4_1
if any
{
358 nonempty
$_->{last_modification_time
}
359 } values %{$self->custom_data};
361 return KDBX_VERSION_4_1
if any
{
362 nonempty
$_->{name
} || nonempty
$_->{last_modification_time
}
363 } @{$self->custom_icons};
365 return KDBX_VERSION_4_1
if $self->groups->next(sub {
366 nonempty
$_->previous_parent_group ||
368 (any
{ nonempty
$_->{last_modification_time
} } values %{$_->custom_data})
369 # TODO replace next paragraph with this
370 # || $_->entries(history => 1)->next(sub {
371 # nonempty $_->previous_parent_group ||
372 # (defined $_->quality_check && !$_->quality_check) ||
373 # (any { nonempty $_->{last_modification_time} } values %{$_->custom_data})
377 return KDBX_VERSION_4_1
if $self->entries(history
=> 1)->next(sub {
378 nonempty
$_->previous_parent_group ||
379 (defined $_->quality_check && !$_->quality_check) ||
380 (any
{ nonempty
$_->{last_modification_time
} } values %{$_->custom_data})
383 return KDBX_VERSION_4_0
if $self->kdf->uuid ne KDF_UUID_AES
;
385 return KDBX_VERSION_4_0
if nonempty
$self->public_custom_data;
387 return KDBX_VERSION_4_0
if $self->objects->next(sub {
388 nonempty
$_->custom_data
391 return KDBX_VERSION_3_1
;
394 ##############################################################################
398 $group = $kdbx->root;
401 Get
or set a database
's root group. You don't necessarily need to explicitly create
or set a root group
402 because it autovivifies
when adding entries
and groups to the database
.
404 Every database
has only a single root group at a
time. Some old KDB files might have multiple root groups
.
405 When reading such files
, a single implicit root group
is created to contain the actual root groups
. When
406 writing to such a format
, if the root group looks like it was implicitly created then it won
't be written and
407 the resulting file might have multiple root groups. This allows working with older files without changing
408 their written internal structure while still adhering to modern semantics while the database is opened.
410 The root group of a KDBX database contains all of the database's entries
and other groups
. If you replace the
411 root group
, you are essentially replacing the entire database contents with something
else.
418 $self->{root
} = $self->_wrap_group(@_);
419 $self->{root
}->kdbx($self);
421 $self->{root
} //= $self->_implicit_root;
422 return $self->_wrap_group($self->{root
});
425 # Called by File::KeePass::KDBX so that a File::KDBX an be treated as a File::KDBX::Group in that both types
426 # can have subgroups. File::KDBX already has a `groups' method that does something different from the
427 # File::KDBX::Groups `groups' method.
430 return [] if !$self->{root
};
431 return $self->_has_implicit_root ? $self->root->groups : [$self->root];
434 sub _has_implicit_root
{
436 my $root = $self->root;
437 my $temp = __PACKAGE__-
>_implicit_root;
438 # If an implicit root group has been changed in any significant way, it is no longer implicit.
439 return $root->name eq $temp->name &&
440 $root->is_expanded ^ $temp->is_expanded &&
441 $root->notes eq $temp->notes &&
442 !@{$root->entries} &&
443 !defined $root->custom_icon_uuid &&
444 !keys %{$root->custom_data} &&
445 $root->icon_id == $temp->icon_id &&
446 $root->expires ^ $temp->expires &&
447 $root->default_auto_type_sequence eq $temp->default_auto_type_sequence &&
448 !defined $root->enable_auto_type &&
449 !defined $root->enable_searching;
454 require File
::KDBX
::Group
;
455 return File
::KDBX
::Group-
>new(
458 notes
=> 'Added as an implicit root group by '.__PACKAGE__
.'.',
459 ref $self ? (kdbx
=> $self) : (),
463 =method trace_lineage
465 \
@lineage = $kdbx->trace_lineage($group);
466 \
@lineage = $kdbx->trace_lineage($group, $base_group);
467 \
@lineage = $kdbx->trace_lineage($entry);
468 \
@lineage = $kdbx->trace_lineage($entry, $base_group);
470 Get the direct line of ancestors from C
<$base_group> (default: the root group
) to a group
or entry
. The
471 lineage includes the base group but I
<not> the target group
or entry
. Returns C
<undef> if the target
is not in
472 the database structure
.
479 return $object->lineage(@_);
487 push @lineage, $self->root if !@lineage;
488 my $base = $lineage[-1] or return [];
490 my $uuid = $object->uuid;
491 return \
@lineage if any
{ $_->uuid eq $uuid } @{$base->groups || []}, @{$base->entries || []};
493 for my $subgroup (@{$base->groups || []}) {
494 my $result = $self->_trace_lineage($object, @lineage, $subgroup);
495 return $result if $result;
499 ##############################################################################
503 $kdbx->add_group($group, %options);
504 $kdbx->add_group(%group_attributes, %options);
506 Add a group to a database
. This
is equivalent to identifying a parent group
and calling
507 L
<File
::KDBX
::Group
/add_group
> on the parent group
, forwarding the arguments
. Available options
:
510 * C<group> (aka C<parent>) - Group object or group UUID to add the group to (default: root group)
516 my $group = @_ % 2 == 1 ? shift : undef;
519 # find the right group to add the group to
520 my $parent = delete $args{group
} // delete $args{parent
} // $self->root;
521 $parent = $self->groups->grep({uuid
=> $parent})->next if !ref $parent;
522 $parent or throw
'Invalid group';
524 return $parent->add_group(defined $group ? $group : (), %args, kdbx
=> $self);
530 require File
::KDBX
::Group
;
531 return File
::KDBX
::Group-
>wrap($group, $self);
536 \
&iterator
= $kdbx->groups(%options);
537 \
&iterator
= $kdbx->groups($base_group, %options);
539 Get an iterator over I
<groups
> within a database
. Options
:
542 * C<base> - Only include groups within a base group (same as C<$base_group>) (default: L</root>)
543 * C<inclusive> - Include the base group in the results (default: true)
544 * C<algorithm> - Search algorithm, one of C<ids>, C<bfs> or C<dfs> (default: C<ids>)
550 my %args = @_ % 2 == 0 ? @_ : (base
=> shift, @_);
551 my $base = $args{base
} // $self->root;
553 my @groups = ($args{inclusive
} // 1) ? $base : @{$base->groups};
554 my $algo = lc($args{algorithm
} || 'ids');
556 if ($algo eq 'dfs') {
558 return File
::KDBX
::Iterator-
>new(sub {
559 my $next = shift @groups or return;
560 if (!$visited{Hash
::Util
::FieldHash
::id
($next)}++) {
561 while (my @children = @{$next->groups}) {
562 unshift @groups, @children, $next;
563 $next = shift @groups;
564 $visited{Hash
::Util
::FieldHash
::id
($next)}++;
570 elsif ($algo eq 'bfs') {
571 return File
::KDBX
::Iterator-
>new(sub {
572 my $next = shift @groups or return;
573 push @groups, @{$next->groups};
577 return File
::KDBX
::Iterator-
>new(sub {
578 my $next = shift @groups or return;
579 unshift @groups, @{$next->groups};
584 ##############################################################################
588 $kdbx->add_entry($entry, %options);
589 $kdbx->add_entry(%entry_attributes, %options);
591 Add a entry to a database
. This
is equivalent to identifying a parent group
and calling
592 L
<File
::KDBX
::Group
/add_entry
> on the parent group
, forwarding the arguments
. Available options
:
595 * C<group> (aka C<parent>) - Group object or group UUID to add the entry to (default: root group)
601 my $entry = @_ % 2 == 1 ? shift : undef;
604 # find the right group to add the entry to
605 my $parent = delete $args{group
} // delete $args{parent
} // $self->root;
606 $parent = $self->groups->grep({uuid
=> $parent})->next if !ref $parent;
607 $parent or throw
'Invalid group';
609 return $parent->add_entry(defined $entry ? $entry : (), %args, kdbx
=> $self);
615 require File
::KDBX
::Entry
;
616 return File
::KDBX
::Entry-
>wrap($entry, $self);
621 \
&iterator
= $kdbx->entries(%options);
622 \
&iterator
= $kdbx->entries($base_group, %options);
624 Get an iterator over I
<entries
> within a database
. Supports the same options as L
</groups
>, plus some new
628 * C<auto_type> - Only include entries with auto-type enabled (default: false, include all)
629 * C<searching> - Only include entries within groups with search enabled (default: false, include all)
630 * C<history> - Also include historical entries (default: false, include only current entries)
636 my %args = @_ % 2 == 0 ? @_ : (base
=> shift, @_);
638 my $searching = $args{searching
};
639 my $auto_type = $args{auto_type
};
640 my $history = $args{history
};
642 my $groups = $self->groups(%args);
645 return File
::KDBX
::Iterator-
>new(sub {
647 while (my $group = $groups->next) {
648 next if $searching && !$group->effective_enable_searching;
649 next if $auto_type && !$group->effective_enable_auto_type;
650 @entries = @{$group->entries};
651 @entries = grep { $_->auto_type->{enabled
} } @entries if $auto_type;
652 @entries = map { ($_, @{$_->history}) } @entries if $history;
660 ##############################################################################
664 \
&iterator
= $kdbx->entries(%options);
665 \
&iterator
= $kdbx->entries($base_group, %options);
667 Get an iterator over I
<objects
> within a database
. Groups
and entries are considered objects
, so this
is
668 essentially a combination of L
</groups> and L</entries
>. This won
't often be useful, but it can be convenient
669 for maintenance tasks. This method takes the same options as L</groups> and L</entries>.
675 my %args = @_ % 2 == 0 ? @_ : (base => shift, @_);
677 my $searching = $args{searching};
678 my $auto_type = $args{auto_type};
679 my $history = $args{history};
681 my $groups = $self->groups(%args);
684 return File::KDBX::Iterator->new(sub {
686 while (my $group = $groups->next) {
687 next if $searching && !$group->effective_enable_searching;
688 next if $auto_type && !$group->effective_enable_auto_type;
689 @entries = @{$group->entries};
690 @entries = grep { $_->auto_type->{enabled} } @entries if $auto_type;
691 @entries = map { ($_, @{$_->history}) } @entries if $history;
699 sub __iter__ { $_[0]->objects }
701 ##############################################################################
705 \%icon = $kdbx->custom_icon($uuid);
706 $kdbx->custom_icon($uuid => \%icon);
707 $kdbx->custom_icon(%icon);
708 $kdbx->custom_icon(uuid => $value, %icon);
710 Get or set custom icons.
716 my %args = @_ == 2 ? (uuid => shift, data => shift)
717 : @_ % 2 == 1 ? (uuid => shift, @_) : @_;
719 if (!$args{uuid} && !$args{data}) {
720 my %standard = (uuid => 1, data => 1, name => 1, last_modification_time => 1);
721 my @other_keys = grep { !$standard{$_} } keys %args;
722 if (@other_keys == 1) {
723 my $key = $args{key} = $other_keys[0];
724 $args{data} = delete $args{$key};
728 my $uuid = $args{uuid} or throw 'Must provide a custom icon UUID to access
';
729 my $icon = (first { $_->{uuid} eq $uuid } @{$self->custom_icons}) // do {
730 push @{$self->custom_icons}, my $i = { uuid => $uuid };
735 $fields = $args{data} if is_plain_hashref($args{data});
737 while (my ($field, $value) = each %$fields) {
738 $icon->{$field} = $value;
743 =method custom_icon_data
745 $image_data = $kdbx->custom_icon_data($uuid);
747 Get a custom icon image data.
751 sub custom_icon_data {
753 my $uuid = shift // return;
754 my $icon = first { $_->{uuid} eq $uuid } @{$self->custom_icons} or return;
755 return $icon->{data};
758 =method add_custom_icon
760 $uuid = $kdbx->add_custom_icon($image_data, %attributes);
762 Add a custom icon and get its UUID. If not provided, a random UUID will be generated. Possible attributes:
765 * C<uuid> - Icon UUID (default: autogenerated)
766 * C<name> - Name of the icon (text, KDBX4.1+)
767 * C<last_modification_time> - Just what it says (datetime, KDBX4.1+)
771 sub add_custom_icon {
773 my $img = shift or throw 'Must provide image data
';
776 my $uuid = $args{uuid} // generate_uuid;
777 push @{$self->custom_icons}, {
785 =method remove_custom_icon
787 $kdbx->remove_custom_icon($uuid);
789 Remove a custom icon.
793 sub remove_custom_icon {
797 @{$self->custom_icons} = grep { $_->{uuid} eq $uuid ? do { push @deleted, $_; 0 } : 1 }
798 @{$self->custom_icons};
799 $self->add_deleted_object($uuid) if @deleted;
803 ##############################################################################
807 \%all_data = $kdbx->custom_data;
808 $kdbx->custom_data(\%all_data);
810 \%data = $kdbx->custom_data($key);
811 $kdbx->custom_data($key => \%data);
812 $kdbx->custom_data(%data);
813 $kdbx->custom_data(key => $value, %data);
815 Get and set custom data. Custom data is metadata associated with a database.
817 Each data item can have a few attributes associated with it.
820 * C<key> - A unique text string identifier used to look up the data item (required)
821 * C<value> - A text string value (required)
822 * C<last_modification_time> (optional, KDBX4.1+)
828 $self->{meta}{custom_data} = shift if @_ == 1 && is_plain_hashref($_[0]);
829 return $self->{meta}{custom_data} //= {} if !@_;
831 my %args = @_ == 2 ? (key => shift, value => shift)
832 : @_ % 2 == 1 ? (key => shift, @_) : @_;
834 if (!$args{key} && !$args{value}) {
835 my %standard = (key => 1, value => 1, last_modification_time => 1);
836 my @other_keys = grep { !$standard{$_} } keys %args;
837 if (@other_keys == 1) {
838 my $key = $args{key} = $other_keys[0];
839 $args{value} = delete $args{$key};
843 my $key = $args{key} or throw 'Must provide a custom_data key to access
';
845 return $self->{meta}{custom_data}{$key} = $args{value} if is_plain_hashref($args{value});
847 while (my ($field, $value) = each %args) {
848 $self->{meta}{custom_data}{$key}{$field} = $value;
850 return $self->{meta}{custom_data}{$key};
853 =method custom_data_value
855 $value = $kdbx->custom_data_value($key);
857 Exactly the same as L</custom_data> except returns just the custom data's value rather than a structure of
858 attributes
. This
is a shortcut
for:
860 my $data = $kdbx->custom_data($key);
861 my $value = defined $data ? $data->{value
} : undef;
865 sub custom_data_value
{
867 my $data = $self->custom_data(@_) // return;
868 return $data->{value
};
871 =method public_custom_data
873 \
%all_data = $kdbx->public_custom_data;
874 $kdbx->public_custom_data(\
%all_data);
876 $value = $kdbx->public_custom_data($key);
877 $kdbx->public_custom_data($key => $value);
879 Get
and set public custom data
. Public custom data
is similar to custom data but different
in some important
880 ways
. Public custom data
:
883 * can store strings, booleans and up to 64-bit integer values (custom data can only store text values)
884 * is NOT encrypted within a KDBX file (hence the "public" part of the name)
885 * is a plain hash/dict of key-value pairs with no other associated fields (like modification times)
889 sub public_custom_data
{
891 $self->{headers
}{+HEADER_PUBLIC_CUSTOM_DATA
} = shift if @_ == 1 && is_plain_hashref
($_[0]);
892 return $self->{headers
}{+HEADER_PUBLIC_CUSTOM_DATA
} //= {} if !@_;
894 my $key = shift or throw
'Must provide a public_custom_data key to access';
895 $self->{headers
}{+HEADER_PUBLIC_CUSTOM_DATA
}{$key} = shift if @_;
896 return $self->{headers
}{+HEADER_PUBLIC_CUSTOM_DATA
}{$key};
899 ##############################################################################
906 # my %options = @_; # prefer_old / prefer_new
907 # $other->merge_from($self);
914 # die 'Not implemented';
917 =method add_deleted_object
919 $kdbx->add_deleted_object($uuid);
921 Add a UUID to the deleted objects list
. This list
is used to support automatic database merging
.
923 You typically
do not need to call this yourself because the list will be populated automatically as objects
928 sub add_deleted_object
{
932 # ignore null and meta stream UUIDs
933 return if $uuid eq UUID_NULL
|| $uuid eq '0' x
16;
935 $self->deleted_objects->{$uuid} = {
937 deletion_time
=> scalar gmtime,
941 =method remove_deleted_object
943 $kdbx->remove_deleted_object($uuid);
945 Remove a UUID from the deleted objects list
. This list
is used to support automatic database merging
.
947 You typically
do not need to call this yourself because the list will be maintained automatically as objects
952 sub remove_deleted_object
{
955 delete $self->deleted_objects->{$uuid};
958 =method clear_deleted_objects
960 Remove all UUIDs from the deleted objects list
. This list
is used to support automatic database merging
, but
961 if you don
't need merging then you can clear deleted objects to reduce the database file size.
965 sub clear_deleted_objects {
967 %{$self->deleted_objects} = ();
970 ##############################################################################
972 =method resolve_reference
974 $string = $kdbx->resolve_reference($reference);
975 $string = $kdbx->resolve_reference($wanted, $search_in, $expression);
977 Resolve a L<field reference|https://keepass.info/help/base/fieldrefs.html>. A field reference is a kind of
978 string placeholder. You can use a field reference to refer directly to a standard field within an entry. Field
979 references are resolved automatically while expanding entry strings (i.e. replacing placeholders), but you can
980 use this method to resolve on-the-fly references that aren't part of any actual string
in the database
.
982 If the reference
does not resolve to any field
, C
<undef> is returned
. If the reference resolves to multiple
983 fields
, only the first one
is returned
(in the same order as iterated by L
</entries
>). To avoid ambiguity
, you
984 can refer to a specific entry by its UUID
.
986 The syntax of a reference
is: C
<< {REF
:<WantedField
>@<SearchIn
>:<Text
>} >>. C
<Text
> is a
987 L
</"Simple Expression">. C
<WantedField
> and C
<SearchIn
> are both single character codes representing a field
:
996 * C<O> - Other custom strings
998 Since C<O> does not represent any specific field, it cannot be used as the C<WantedField>.
1002 To get the value of the I<UserName> string of the first entry with "My Bank" in the title:
1004 my $username = $kdbx->resolve_reference('{REF:U@T:"My Bank"}');
1005 # OR the {REF:...} wrapper is optional
1006 my $username = $kdbx->resolve_reference('U@T:"My Bank"');
1007 # OR separate the arguments
1008 my $username = $kdbx->resolve_reference(U => T => '"My Bank"');
1010 Note how the text is a L</"Simple Expression">, so search terms with spaces must be surrounded in double
1013 To get the I<Password> string of a specific entry (identified by its UUID):
1015 my $password = $kdbx->resolve_reference('{REF:P@I:46C9B1FFBD4ABC4BBB260C6190BAD20C}');
1019 sub resolve_reference
{
1021 my $wanted = shift // return;
1022 my $search_in = shift;
1025 if (!defined $text) {
1026 $wanted =~ s/^\{REF:([^\}]+)\}$/$1/i;
1027 ($wanted, $search_in, $text) = $wanted =~ /^([TUPANI])\@([TUPANIO]):(.*)$/i;
1029 $wanted && $search_in && nonempty
($text) or return;
1032 T
=> 'expanded_title',
1033 U
=> 'expanded_username',
1034 P
=> 'expanded_password',
1035 A
=> 'expanded_url',
1036 N
=> 'expanded_notes',
1038 O
=> 'other_strings',
1040 $wanted = $fields{$wanted} or return;
1041 $search_in = $fields{$search_in} or return;
1043 my $query = $search_in eq 'uuid' ? query
($search_in => uuid
($text))
1044 : simple_expression_query
($text, '=~', $search_in);
1046 my $entry = $self->entries->grep($query)->next;
1049 return $entry->$wanted;
1052 our %PLACEHOLDERS = (
1053 # 'PLACEHOLDER' => sub { my ($entry, $arg) = @_; ... };
1054 'TITLE' => sub { $_[0]->expanded_title },
1055 'USERNAME' => sub { $_[0]->expanded_username },
1056 'PASSWORD' => sub { $_[0]->expanded_password },
1057 'NOTES' => sub { $_[0]->expanded_notes },
1058 'S:' => sub { $_[0]->string_value($_[1]) },
1059 'URL' => sub { $_[0]->expanded_url },
1060 'URL:RMVSCM' => sub { local $_ = $_[0]->url; s!^[^:/\?\#]+://!!; $_ },
1061 'URL:WITHOUTSCHEME' => sub { local $_ = $_[0]->url; s!^[^:/\?\#]+://!!; $_ },
1062 'URL:SCM' => sub { (split_url
($_[0]->url))[0] },
1063 'URL:SCHEME' => sub { (split_url
($_[0]->url))[0] }, # non-standard
1064 'URL:HOST' => sub { (split_url
($_[0]->url))[2] },
1065 'URL:PORT' => sub { (split_url
($_[0]->url))[3] },
1066 'URL:PATH' => sub { (split_url
($_[0]->url))[4] },
1067 'URL:QUERY' => sub { (split_url
($_[0]->url))[5] },
1068 'URL:HASH' => sub { (split_url
($_[0]->url))[6] }, # non-standard
1069 'URL:FRAGMENT' => sub { (split_url
($_[0]->url))[6] }, # non-standard
1070 'URL:USERINFO' => sub { (split_url
($_[0]->url))[1] },
1071 'URL:USERNAME' => sub { (split_url
($_[0]->url))[7] },
1072 'URL:PASSWORD' => sub { (split_url
($_[0]->url))[8] },
1073 'UUID' => sub { local $_ = format_uuid
($_[0]->uuid); s/-//g; $_ },
1074 'REF:' => sub { $_[0]->kdbx->resolve_reference($_[1]) },
1075 'INTERNETEXPLORER' => sub { load_optional
('IPC::Cmd'); IPC
::Cmd
::can_run
('iexplore') },
1076 'FIREFOX' => sub { load_optional
('IPC::Cmd'); IPC
::Cmd
::can_run
('firefox') },
1077 'GOOGLECHROME' => sub { load_optional
('IPC::Cmd'); IPC
::Cmd
::can_run
('google-chrome') },
1078 'OPERA' => sub { load_optional
('IPC::Cmd'); IPC
::Cmd
::can_run
('opera') },
1079 'SAFARI' => sub { load_optional
('IPC::Cmd'); IPC
::Cmd
::can_run
('safari') },
1080 'APPDIR' => sub { load_optional
('FindBin'); $FindBin::Bin
},
1081 'GROUP' => sub { my $p = $_[0]->parent; $p ? $p->name : undef },
1082 'GROUP_PATH' => sub { $_[0]->path },
1083 'GROUP_NOTES' => sub { my $p = $_[0]->parent; $p ? $p->notes : undef },
1092 'ENV:' => sub { $ENV{$_[1]} },
1093 'ENV_DIRSEP' => sub { load_optional
('File::Spec')->catfile('', '') },
1094 'ENV_PROGRAMFILES_X86' => sub { $ENV{'ProgramFiles(x86)'} || $ENV{'ProgramFiles'} },
1097 'DT_SIMPLE' => sub { localtime-
>strftime('%Y%m%d%H%M%S') },
1098 'DT_YEAR' => sub { localtime-
>strftime('%Y') },
1099 'DT_MONTH' => sub { localtime-
>strftime('%m') },
1100 'DT_DAY' => sub { localtime-
>strftime('%d') },
1101 'DT_HOUR' => sub { localtime-
>strftime('%H') },
1102 'DT_MINUTE' => sub { localtime-
>strftime('%M') },
1103 'DT_SECOND' => sub { localtime-
>strftime('%S') },
1104 'DT_UTC_SIMPLE' => sub { gmtime-
>strftime('%Y%m%d%H%M%S') },
1105 'DT_UTC_YEAR' => sub { gmtime-
>strftime('%Y') },
1106 'DT_UTC_MONTH' => sub { gmtime-
>strftime('%m') },
1107 'DT_UTC_DAY' => sub { gmtime-
>strftime('%d') },
1108 'DT_UTC_HOUR' => sub { gmtime-
>strftime('%H') },
1109 'DT_UTC_MINUTE' => sub { gmtime-
>strftime('%M') },
1110 'DT_UTC_SECOND' => sub { gmtime-
>strftime('%S') },
1117 'HMACOTP' => sub { $_[0]->hmac_otp },
1118 'TIMEOTP' => sub { $_[0]->time_otp },
1119 'C:' => sub { '' }, # comment
1127 ##############################################################################
1133 Encrypt all protected binaries strings
in a database
. The encrypted strings are stored
in
1134 a L
<File
::KDBX
::Safe
> associated with the database
and the actual strings will be replaced with C
<undef> to
1135 indicate their protected
state. Returns itself to allow
method chaining
.
1141 $SAFE{$self} = shift if @_;
1145 sub _remove_safe
{ delete $SAFE{$_[0]} }
1150 $self->_safe and return $self;
1154 $self->entries(history
=> 1)->each(sub {
1155 push @strings, grep { $_->{protect
} } values %{$_->strings}, values %{$_->binaries};
1158 $self->_safe(File
::KDBX
::Safe-
>new(\
@strings));
1167 Decrypt all protected strings
in a database
, replacing C
<undef> placeholders with unprotected
values. Returns
1168 itself to allow
method chaining
.
1174 my $safe = $self->_safe or return $self;
1177 $self->_remove_safe;
1182 =method unlock_scoped
1184 $guard = $kdbx->unlock_scoped;
1186 Unlock a database temporarily
, relocking
when the guard
is released
(typically at the end of a scope
). Returns
1187 C
<undef> if the database
is already unlocked
.
1189 See L
</lock> and L</unlock
>.
1194 throw
'Programmer error: Cannot call unlock_scoped in void context' if !defined wantarray;
1196 return if !$self->is_locked;
1197 require Scope
::Guard
;
1198 my $guard = Scope
::Guard-
>new(sub { $self->lock });
1205 $string = $kdbx->peek(\
%string);
1206 $string = $kdbx->peek(\
%binary);
1208 Peek at the value of a protected string
or binary without unlocking the whole database
. The argument can be
1209 a string
or binary hashref as returned by L
<File
::KDBX
::Entry
/string> or L<File::KDBX::Entry/binary
>.
1216 my $safe = $self->_safe or return;
1217 return $safe->peek($string);
1222 $bool = $kdbx->is_locked;
1224 Get whether
or not a database
's strings are memory-protected. If this is true, then some or all of the
1225 protected strings within the database will be unavailable (literally have C<undef> values) until L</unlock> is
1230 sub is_locked { $_[0]->_safe ? 1 : 0 }
1232 ##############################################################################
1234 =method randomize_seeds
1236 $kdbx->randomize_seeds;
1238 Set various keys, seeds and IVs to random values. These values are used by the cryptographic functions that
1239 secure the database when dumped. The attributes that will be randomized are:
1243 * L</inner_random_stream_key>
1245 * L</stream_start_bytes>
1246 * L</transform_seed>
1248 Randomizing these values has no effect on a loaded database. These are only used when a database is dumped.
1249 You normally do not need to call this method explicitly because the dumper does it explicitly by default.
1253 sub randomize_seeds {
1255 $self->encryption_iv(random_bytes(16));
1256 $self->inner_random_stream_key(random_bytes(64));
1257 $self->master_seed(random_bytes(32));
1258 $self->stream_start_bytes(random_bytes(32));
1259 $self->transform_seed(random_bytes(32));
1262 ##############################################################################
1267 $key = $kdbx->key($key);
1268 $key = $kdbx->key($primitive);
1270 Get or set a L<File::KDBX::Key>. This is the master key (e.g. a password or a key file that can decrypt
1271 a database). See L<File::KDBX::Key/new> for an explanation of what the primitive can be.
1273 You generally don't need to call this directly because you can provide the key directly to the loader
or
1274 dumper
when loading
or dumping a KDBX file
.
1280 $KEYS{$self} = File
::KDBX
::Key-
>new(@_) if @_;
1284 =method composite_key
1286 $key = $kdbx->composite_key($key);
1287 $key = $kdbx->composite_key($primitive);
1289 Construct a L
<File
::KDBX
::Key
::Composite
> from a primitive
. See L
<File
::KDBX
::Key
/new
> for an explanation of
1290 what the primitive can be
. If the primitive
does not represent a composite key
, it will be wrapped
.
1292 You generally don
't need to call this directly. The parser and writer use it to transform a master key into
1293 a raw encryption key.
1299 require File::KDBX::Key::Composite;
1300 return File::KDBX::Key::Composite->new(@_);
1305 $kdf = $kdbx->kdf(%options);
1306 $kdf = $kdbx->kdf(\%parameters, %options);
1308 Get a L<File::KDBX::KDF> (key derivation function).
1313 * C<params> - KDF parameters, same as C<\%parameters> (default: value of L</kdf_parameters>)
1319 my %args = @_ % 2 == 1 ? (params => shift, @_) : @_;
1321 my $params = $args{params};
1322 my $compat = $args{compatible} // 1;
1324 $params //= $self->kdf_parameters;
1325 $params = {%{$params || {}}};
1327 if (empty $params || !defined $params->{+KDF_PARAM_UUID}) {
1328 $params->{+KDF_PARAM_UUID} = KDF_UUID_AES;
1330 if ($params->{+KDF_PARAM_UUID} eq KDF_UUID_AES) {
1331 # AES_CHALLENGE_RESPONSE is equivalent to AES if there are no challenge-response keys, and since
1332 # non-KeePassXC implementations don't support challenge-response
keys anyway
, there
's no problem with
1333 # always using AES_CHALLENGE_RESPONSE for all KDBX4+ databases.
1334 # For compatibility, we should not *write* AES_CHALLENGE_RESPONSE, but the dumper handles that.
1335 if ($self->version >= KDBX_VERSION_4_0) {
1336 $params->{+KDF_PARAM_UUID} = KDF_UUID_AES_CHALLENGE_RESPONSE;
1338 $params->{+KDF_PARAM_AES_SEED} //= $self->transform_seed;
1339 $params->{+KDF_PARAM_AES_ROUNDS} //= $self->transform_rounds;
1342 require File::KDBX::KDF;
1343 return File::KDBX::KDF->new(%$params);
1346 sub transform_seed {
1348 $self->headers->{+HEADER_TRANSFORM_SEED} =
1349 $self->headers->{+HEADER_KDF_PARAMETERS}{+KDF_PARAM_AES_SEED} = shift if @_;
1350 $self->headers->{+HEADER_TRANSFORM_SEED} =
1351 $self->headers->{+HEADER_KDF_PARAMETERS}{+KDF_PARAM_AES_SEED} //= random_bytes(32);
1354 sub transform_rounds {
1356 $self->headers->{+HEADER_TRANSFORM_ROUNDS} =
1357 $self->headers->{+HEADER_KDF_PARAMETERS}{+KDF_PARAM_AES_ROUNDS} = shift if @_;
1358 $self->headers->{+HEADER_TRANSFORM_ROUNDS} =
1359 $self->headers->{+HEADER_KDF_PARAMETERS}{+KDF_PARAM_AES_ROUNDS} //= 100_000;
1364 $cipher = $kdbx->cipher(key => $key);
1365 $cipher = $kdbx->cipher(key => $key, iv => $iv, uuid => $uuid);
1367 Get a L<File::KDBX::Cipher> capable of encrypting and decrypting the body of a database file.
1369 A key is required. This should be a raw encryption key made up of a fixed number of octets (depending on the
1370 cipher), not a L<File::KDBX::Key> or primitive.
1372 If not passed, the UUID comes from C<< $kdbx->headers->{cipher_id} >> and the encryption IV comes from
1373 C<< $kdbx->headers->{encryption_iv} >>.
1375 You generally don't need to call this directly
. The parser
and writer
use it to decrypt
and encrypt KDBX
1384 $args{uuid
} //= $self->headers->{+HEADER_CIPHER_ID
};
1385 $args{iv
} //= $self->headers->{+HEADER_ENCRYPTION_IV
};
1387 require File
::KDBX
::Cipher
;
1388 return File
::KDBX
::Cipher-
>new(%args);
1391 =method random_stream
1393 $cipher = $kdbx->random_stream;
1394 $cipher = $kdbx->random_stream(id
=> $stream_id, key
=> $key);
1396 Get a L
<File
::KDBX
::Cipher
::Stream
> for decrypting
and encrypting protected
values.
1398 If
not passed
, the ID
and encryption key comes from C
<< $kdbx->headers->{inner_random_stream_id
} >> and
1399 C
<< $kdbx->headers->{inner_random_stream_key
} >> (respectively
) for KDBX3 files
and from
1400 C
<< $kdbx->inner_headers->{inner_random_stream_key
} >> and
1401 C
<< $kdbx->inner_headers->{inner_random_stream_id
} >> (respectively
) for KDBX4 files
.
1403 You generally don
't need to call this directly. The parser and writer use it to scramble protected strings.
1411 $args{stream_id} //= delete $args{id} // $self->inner_random_stream_id;
1412 $args{key} //= $self->inner_random_stream_key;
1414 require File::KDBX::Cipher;
1415 File::KDBX::Cipher->new(%args);
1418 sub inner_random_stream_id {
1420 $self->inner_headers->{+INNER_HEADER_INNER_RANDOM_STREAM_ID}
1421 = $self->headers->{+HEADER_INNER_RANDOM_STREAM_ID} = shift if @_;
1422 $self->inner_headers->{+INNER_HEADER_INNER_RANDOM_STREAM_ID}
1423 //= $self->headers->{+HEADER_INNER_RANDOM_STREAM_ID} //= do {
1424 my $version = $self->minimum_version;
1425 $version < KDBX_VERSION_4_0 ? STREAM_ID_SALSA20 : STREAM_ID_CHACHA20;
1429 sub inner_random_stream_key {
1432 # These are probably the same SvPV so erasing one will CoW, but erasing the second should do the
1434 erase \$self->inner_headers->{+INNER_HEADER_INNER_RANDOM_STREAM_KEY};
1435 erase \$self->headers->{+HEADER_INNER_RANDOM_STREAM_KEY};
1436 $self->inner_headers->{+INNER_HEADER_INNER_RANDOM_STREAM_KEY}
1437 = $self->headers->{+HEADER_INNER_RANDOM_STREAM_KEY} = shift;
1439 $self->inner_headers->{+INNER_HEADER_INNER_RANDOM_STREAM_KEY}
1440 //= $self->headers->{+HEADER_INNER_RANDOM_STREAM_KEY} //= random_bytes(64); # 32
1443 #########################################################################################
1446 # - Fixer tool. Can repair inconsistencies, including:
1447 # - Orphaned binaries... not really a thing anymore since we now distribute binaries amongst entries
1448 # - Unused custom icons (OFF, data loss)
1450 # - All data types are valid
1451 # - date times are correct
1453 # - All UUIDs refer to things that exist
1454 # - previous parent group
1456 # - last selected group
1457 # - last visible group
1458 # - Enforce history size limits (ON)
1459 # - Check headers/meta (ON)
1460 # - Duplicate deleted objects (ON)
1461 # - Duplicate window associations (OFF)
1462 # - Only one root group (ON)
1463 # - Header UUIDs match known ciphers/KDFs?
1466 #########################################################################################
1468 sub _handle_signal {
1474 'entry
.added
' => \&_handle_object_added,
1475 'group
.added
' => \&_handle_object_added,
1476 'entry
.removed
' => \&_handle_object_removed,
1477 'group
.removed
' => \&_handle_object_removed,
1478 'entry
.uuid
.changed
' => \&_handle_entry_uuid_changed,
1479 'group
.uuid
.changed
' => \&_handle_group_uuid_changed,
1481 my $handler = $handlers{$type} or return;
1482 $self->$handler($object, @_);
1485 sub _handle_object_added {
1488 $self->remove_deleted_object($object->uuid);
1491 sub _handle_object_removed {
1494 my $old_uuid = $object->{uuid} // return;
1496 my $meta = $self->meta;
1497 $self->recycle_bin_uuid(UUID_NULL) if $old_uuid eq ($meta->{recycle_bin_uuid} // '');
1498 $self->entry_templates_group(UUID_NULL) if $old_uuid eq ($meta->{entry_templates_group} // '');
1499 $self->last_selected_group(UUID_NULL) if $old_uuid eq ($meta->{last_selected_group} // '');
1500 $self->last_top_visible_group(UUID_NULL) if $old_uuid eq ($meta->{last_top_visible_group} // '');
1502 $self->add_deleted_object($old_uuid);
1505 sub _handle_entry_uuid_changed {
1508 my $new_uuid = shift;
1509 my $old_uuid = shift // return;
1511 my $old_pretty = format_uuid($old_uuid);
1512 my $new_pretty = format_uuid($new_uuid);
1513 my $fieldref_match = qr/\{REF:([TUPANI])\@I:\Q$old_pretty\E\}/is;
1515 $self->entries->each(sub {
1516 $_->previous_parent_group($new_uuid) if $old_uuid eq ($_->{previous_parent_group} // '');
1518 for my $string (values %{$_->strings}) {
1519 next if !defined $string->{value} || $string->{value} !~ $fieldref_match;
1520 my $txn = $_->begin_work;
1521 $string->{value} =~ s/$fieldref_match/{REF:$1\@I:$new_pretty}/g;
1527 sub _handle_group_uuid_changed {
1530 my $new_uuid = shift;
1531 my $old_uuid = shift // return;
1533 my $meta = $self->meta;
1534 $self->recycle_bin_uuid($new_uuid) if $old_uuid eq ($meta->{recycle_bin_uuid} // '');
1535 $self->entry_templates_group($new_uuid) if $old_uuid eq ($meta->{entry_templates_group} // '');
1536 $self->last_selected_group($new_uuid) if $old_uuid eq ($meta->{last_selected_group} // '');
1537 $self->last_top_visible_group($new_uuid) if $old_uuid eq ($meta->{last_top_visible_group} // '');
1539 $self->groups->each(sub {
1540 $_->last_top_visible_entry($new_uuid) if $old_uuid eq ($_->{last_top_visible_entry} // '');
1541 $_->previous_parent_group($new_uuid) if $old_uuid eq ($_->{previous_parent_group} // '');
1543 $self->entries->each(sub {
1544 $_->previous_parent_group($new_uuid) if $old_uuid eq ($_->{previous_parent_group} // '');
1548 #########################################################################################
1552 A text string associated with the database. Often unset.
1556 The UUID of a cipher used to encrypt the database when stored as a file.
1558 See L</File::KDBX::Cipher>.
1560 =attr compression_flags
1562 Configuration for whether or not and how the database gets compressed. See
1563 L<File::KDBX::Constants/":compression">.
1567 The master seed is a string of 32 random bytes that is used as salt in hashing the master key when loading
1568 and saving the database. If a challenge-response key is used in the master key, the master seed is also the
1571 The master seed I<should> be changed each time the database is saved to file.
1573 =attr transform_seed
1575 The transform seed is a string of 32 random bytes that is used in the key derivation function, either as the
1576 salt or the key (depending on the algorithm).
1578 The transform seed I<should> be changed each time the database is saved to file.
1580 =attr transform_rounds
1582 The number of rounds or iterations used in the key derivation function. Increasing this number makes loading
1583 and saving the database slower by design in order to make dictionary and brute force attacks more costly.
1587 The initialization vector used by the cipher.
1589 The encryption IV I<should> be changed each time the database is saved to file.
1591 =attr inner_random_stream_key
1593 The encryption key (possibly including the IV, depending on the cipher) used to encrypt the protected strings
1594 within the database.
1596 =attr stream_start_bytes
1598 A string of 32 random bytes written in the header and encrypted in the body. If the bytes do not match when
1599 loading a file then the wrong master key was used or the file is corrupt. Only KDBX 2 and KDBX 3 files use
1600 this. KDBX 4 files use an improved HMAC method to verify the master key and data integrity of the header and
1603 =attr inner_random_stream_id
1605 A number indicating the cipher algorithm used to encrypt the protected strings within the database, usually
1606 Salsa20 or ChaCha20. See L<File::KDBX::Constants/":random_stream">.
1608 =attr kdf_parameters
1610 A hash/dict of key-value pairs used to configure the key derivation function. This is the KDBX4+ way to
1611 configure the KDF, superceding L</transform_seed> and L</transform_rounds>.
1615 The name of the software used to generate the KDBX file.
1619 The header hash used to verify that the file header is not corrupt. (KDBX 2 - KDBX 3.1, removed KDBX 4.0)
1623 Name of the database.
1625 =attr database_name_changed
1627 Timestamp indicating when the database name was last changed.
1629 =attr database_description
1631 Description of the database
1633 =attr database_description_changed
1635 Timestamp indicating when the database description was last changed.
1637 =attr default_username
1639 When a new entry is created, the I<UserName> string will be populated with this value.
1641 =attr default_username_changed
1643 Timestamp indicating when the default username was last changed.
1645 =attr maintenance_history_days
1647 TODO... not really sure what this is. 😀
1651 A color associated with the database (in the form C<#ffffff> where "f" is a hexidecimal digit). Some agents
1652 use this to help users visually distinguish between different databases.
1654 =attr master_key_changed
1656 Timestamp indicating when the master key was last changed.
1658 =attr master_key_change_rec
1660 Number of days until the agent should prompt to recommend changing the master key.
1662 =attr master_key_change_force
1664 Number of days until the agent should prompt to force changing the master key.
1666 Note: This is purely advisory. It is up to the individual agent software to actually enforce it.
1667 C<File::KDBX> does NOT enforce it.
1669 =attr recycle_bin_enabled
1671 Boolean indicating whether removed groups and entries should go to a recycle bin or be immediately deleted.
1673 =attr recycle_bin_uuid
1675 The UUID of a group used to store thrown-away groups and entries.
1677 =attr recycle_bin_changed
1679 Timestamp indicating when the recycle bin was last changed.
1681 =attr entry_templates_group
1683 The UUID of a group containing template entries used when creating new entries.
1685 =attr entry_templates_group_changed
1687 Timestamp indicating when the entry templates group was last changed.
1689 =attr last_selected_group
1691 The UUID of the previously-selected group.
1693 =attr last_top_visible_group
1695 The UUID of the group visible at the top of the list.
1697 =attr history_max_items
1699 The maximum number of historical entries allowed to be saved for each entry.
1701 =attr history_max_size
1703 The maximum total size (in bytes) that each individual entry's history
is allowed to grow
.
1705 =attr settings_changed
1707 Timestamp indicating
when the database settings were
last updated
.
1711 Alias of the L
</memory_protection
> setting
for the I
<Title
> string
.
1713 =attr protect_username
1715 Alias of the L
</memory_protection
> setting
for the I
<UserName
> string
.
1717 =attr protect_password
1719 Alias of the L
</memory_protection
> setting
for the I
<Password
> string
.
1723 Alias of the L
</memory_protection
> setting
for the I
<URL
> string
.
1727 Alias of the L
</memory_protection
> setting
for the I
<Notes
> string
.
1731 #########################################################################################
1733 sub TO_JSON
{ +{%{$_[0]}} }
1738 =for Pod::Coverage STORABLE_freeze STORABLE_thaw TO_JSON
1744 my $kdbx = File::KDBX->new;
1746 my $group = $kdbx->add_group(
1747 name => 'Passwords',
1750 my $entry = $group->add_entry(
1752 password => 's3cr3t',
1755 $kdbx->dump_file('passwords.kdbx', 'M@st3rP@ssw0rd!');
1757 $kdbx = File::KDBX->load_file('passwords.kdbx', 'M@st3rP@ssw0rd!');
1759 kdbx->entries->each(sub {
1761 say 'Entry: ', $entry->title;
1766 B<File::KDBX> provides everything you need to work with a KDBX database. A KDBX database is a hierarchical
1767 object database which is commonly used to store secret information securely. It was developed for the KeePass
1768 password safe. See L</"KDBX Introduction"> for more information about KDBX.
1770 This module lets you query entries, create new entries, delete entries and modify entries. The distribution
1771 also includes various parsers and generators for serializing and persisting databases.
1773 This design of this software was influenced by the L<KeePassXC|https://github.com/keepassxreboot/keepassxc>
1774 implementation of KeePass as well as the L<File::KeePass> module. B<File::KeePass> is an alternative module
1775 that works well in most cases but has a small backlog of bugs and security issues and also does not work with
1776 newer KDBX version 4 files. If you're coming here from the B<File::KeePass> world, you might be interested in
1777 L<File::KeePass::KDBX> that is a drop-in replacement for B<File::KeePass> that uses B<File::KDBX> for storage.
1779 =head2 KDBX Introduction
1781 A KDBX database consists of a hierarchical I<group> of I<entries>. Entries can contain zero or more key-value
1782 pairs of I<strings> and zero or more I<binaries> (i.e. octet strings). Groups, entries, strings and binaries:
1783 that's the KDBX vernacular. A small amount of metadata (timestamps, etc.) is associated with each entry, group
1784 and the database as a whole.
1786 You can think of a KDBX database kind of like a file system, where groups are directories, entries are files,
1787 and strings and binaries make up a file's contents.
1789 Databases are typically persisted as a encrypted, compressed files. They are usually accessed directly (i.e.
1790 not over a network). The primary focus of this type of database is data security. It is ideal for storing
1791 relatively small amounts of data (strings and binaries) that must remain secret except to such individuals as
1792 have the correct I<master key>. Even if the database file were to be "leaked" to the public Internet, it
1793 should be virtually impossible to crack with a strong key. See L</SECURITY> for an overview of security
1798 =head2 Create a new database
1800 my $kdbx = File::KDBX->new;
1802 my $group = $kdbx->add_group(name => 'Passwords);
1803 my $entry = $group->add_entry(
1804 title => 'WayneCorp',
1805 username => 'bwayne',
1806 password => 'iambatman',
1807 url => 'https://example.com/login'
1809 $entry->add_auto_type_window_association('WayneCorp - Mozilla Firefox', '{PASSWORD}{ENTER}');
1811 $kdbx->dump_file('mypasswords.kdbx', 'master password CHANGEME');
1813 =head2 Read an existing database
1815 my $kdbx = File::KDBX->load_file('mypasswords.kdbx', 'master password CHANGEME');
1818 $kdbx->entries->each(sub {
1820 say 'Found password for ', $entry->title;
1821 say ' Username: ', $entry->username;
1822 say ' Password: ', $entry->password;
1825 =head2 Search for entries
1827 my @entries = $kdbx->entries(searching => 1)
1828 ->grep(title => 'WayneCorp')
1829 ->each; # return all matches
1831 The C<searching> option limits results to only entries within groups with searching enabled. Other options are
1832 also available. See L</entries>.
1834 See L</QUERY> for many more query examples.
1836 =head2 Search for entries by auto-type window association
1838 my $window_title = 'WayneCorp - Mozilla Firefox';
1840 my $entries = $kdbx->entries(auto_type => 1)
1842 my $ata = $_->auto_type_associations->grep(sub { $_->{window} =~ $window_title })->next;
1843 return [$_, $ata->{keystroke_sequence}] if $ata;
1846 my ($entry, $keys) = @$_;
1847 say 'Entry title: ', $entry->title, ', key sequence: ', $keys;
1852 Entry title: WayneCorp, key sequence: {PASSWORD}{ENTER}
1854 =head2 Remove entries from a database
1857 ->grep(notes => {'=~' => qr/too old/i})
1858 ->each(sub { $_->recycle });
1860 Recycle all entries with the string "too old" appearing in the B<Notes> string.
1864 One of the biggest threats to your database security is how easily the encryption key can be brute-forced.
1865 Strong brute-force protection depends on a couple factors:
1868 * Using unguessable passwords, passphrases and key files.
1869 * Using a brute-force resistent key derivation function.
1871 The first factor is up to you. This module does not enforce strong master keys. It is up to you to pick or
1872 generate strong keys.
1874 The KDBX format allows for the key derivation function to be tuned. The idea is that you want each single
1875 brute-foce attempt to be expensive (in terms of time, CPU usage or memory usage), so that making a lot of
1876 attempts (which would be required if you have a strong master key) gets I<really> expensive.
1878 How expensive you want to make each attempt is up to you and can depend on the application.
1880 This and other KDBX-related security issues are covered here more in depth:
1881 L<https://keepass.info/help/base/security.html>
1883 Here are other security risks you should be thinking about:
1887 This distribution uses the excellent L<CryptX> and L<Crypt::Argon2> packages to handle all crypto-related
1888 functions. As such, a lot of the security depends on the quality of these dependencies. Fortunately these
1889 modules are maintained and appear to have good track records.
1891 The KDBX format has evolved over time to incorporate improved security practices and cryptographic functions.
1892 This package uses the following functions for authentication, hashing, encryption and random number
1898 * Argon2d & Argon2id
1903 * Salsa20 & ChaCha20
1906 At the time of this writing, I am not aware of any successful attacks against any of these functions. These
1907 are among the most-analyzed and widely-adopted crypto functions available.
1909 The KDBX format allows the body cipher and key derivation function to be configured. If a flaw is discovered
1910 in one of these functions, you can hopefully just switch to a better function without needing to update this
1911 software. A later software release may phase out the use of any functions which are no longer secure.
1913 =head2 Memory Protection
1915 It is not a good idea to keep secret information unencrypted in system memory for longer than is needed. The
1916 address space of your program can generally be read by a user with elevated privileges on the system. If your
1917 system is memory-constrained or goes into a hibernation mode, the contents of your address space could be
1918 written to a disk where it might be persisted for long time.
1920 There might be system-level things you can do to reduce your risk, like using swap encryption and limiting
1921 system access to your program's address space while your program is running.
1923 B<File::KDBX> helps minimize (but not eliminate) risk by keeping secrets encrypted in memory until accessed
1924 and zeroing out memory that holds secrets after they're no longer needed, but it's not a silver bullet.
1926 For one thing, the encryption key is stored in the same address space. If core is dumped, the encryption key
1927 is available to be found out. But at least there is the chance that the encryption key and the encrypted
1928 secrets won't both be paged out while memory-constrained.
1930 Another problem is that some perls (somewhat notoriously) copy around memory behind the scenes willy nilly,
1931 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
1932 be impossible. The good news is that perls with SvPV copy-on-write (enabled by default beginning with perl
1933 5.20) are much better in this regard. With COW, it's mostly possible to know what operations will cause perl
1934 to copy the memory of a scalar string, and the number of copies will be significantly reduced. There is a unit
1935 test named F<t/memory-protection.t> in this distribution that can be run on POSIX systems to determine how
1936 well B<File::KDBX> memory protection is working.
1938 Memory protection also depends on how your application handles secrets. If your app code is handling scalar
1939 strings with secret information, it's up to you to make sure its memory is zeroed out when no longer needed.
1940 L<File::KDBX::Util/erase> et al. provide some tools to help accomplish this. Or if you're not too concerned
1941 about the risks memory protection is meant to mitigate, then maybe don't worry about it. The security policy
1942 of B<File::KDBX> is to try hard to keep secrets protected while in memory so that your app might claim a high
1943 level of security, in case you care about that.
1945 There are some memory protection strategies that B<File::KDBX> does NOT use today but could in the future:
1947 Many systems allow programs to mark unswappable pages. Secret information should ideally be stored in such
1948 pages. You could potentially use L<mlockall(2)> (or equivalent for your system) in your own application to
1949 prevent the entire address space from being swapped.
1951 Some systems provide special syscalls for storing secrets in memory while keeping the encryption key outside
1952 of the program's address space, like C<CryptProtectMemory> for Windows. This could be a good option, though
1953 unfortunately not portable.
1957 B<TODO> - All these examples are WRONG now.
1959 Several methods take a I<query> as an argument (e.g. L</find_entries>). A query is just a subroutine that you
1960 can either write yourself or have generated for you based on either a simple expression or a declarative
1961 structure. It's easier to have your query generated, so I'll cover that first.
1963 =head2 Simple Expression
1965 A simple expression is mostly compatible with the KeePass 2 implementation
1966 L<described here|https://keepass.info/help/base/search.html#mode_se>.
1968 An expression is a string with one or more space-separated terms. Terms with spaces can be enclosed in double
1969 quotes. Terms are negated if they are prefixed with a minus sign. A record must match every term on at least
1970 one of the given fields.
1972 So a simple expression is something like what you might type into a search engine. You can generate a simple
1973 expression query using L<File::KDBX::Util/simple_expression_query> or by passing the simple expression as
1974 a B<string reference> to search methods like L</find_entries>.
1976 To search for all entries in a database with the word "canyon" appearing anywhere in the title:
1978 my @entries = $kdbx->find_entries([ \'canyon', qw(title) ]);
1980 Notice the first argument is a B<stringref>. This diambiguates a simple expression from other types of queries
1983 As mentioned, a simple expression can have multiple terms. This simple expression query matches any entry that
1984 has the words "red" B<and> "canyon" anywhere in the title:
1986 my @entries = $kdbx->find_entries([ \'red canyon', qw(title) ]);
1988 Each term in the simple expression must be found for an entry to match.
1990 To search for entries with "red" in the title but B<not> "canyon", just prepend "canyon" with a minus sign:
1992 my @entries = $kdbx->find_entries([ \'red -canyon', qw(title) ]);
1994 To search over multiple fields simultaneously, just list them. To search for entries with "grocery" in the
1995 title or notes but not "Foodland":
1997 my @entries = $kdbx->find_entries([ \'grocery -Foodland', qw(title notes) ]);
1999 The default operator is a case-insensitive regexp match, which is fine for searching text loosely. You can use
2000 just about any binary comparison operator that perl supports. To specify an operator, list it after the simple
2001 expression. For example, to search for any entry that has been used at least five times:
2003 my @entries = $kdbx->find_entries([ \5, '>=', qw(usage_count) ]);
2005 It helps to read it right-to-left, like "usage_count is >= 5".
2007 If you find the disambiguating structures to be confusing, you can also the L</find_entries_simple> method as
2008 a more intuitive alternative. The following example is equivalent to the previous:
2010 my @entries = $kdbx->find_entries_simple(5, '>=', qw(usage_count));
2012 =head2 Declarative Query
2014 Structuring a declarative query is similar to L<SQL::Abstract/"WHERE CLAUSES">, but you don't have to be
2015 familiar with that module. Just learn by examples.
2017 To search for all entries in a database titled "My Bank":
2019 my @entries = $kdbx->find_entries({ title => 'My Bank' });
2021 The query here is C<< { title => 'My Bank' } >>. A hashref can contain key-value pairs where the key is
2022 a attribute of the thing being searched for (in this case an entry) and the value is what you want the thing's
2023 attribute to be to consider it a match. In this case, the attribute we're using as our match criteria is
2024 L<File::KDBX::Entry/title>, a text field. If an entry has its title attribute equal to "My Bank", it's
2027 A hashref can contain multiple attributes. The search candidate will be a match if I<all> of the specified
2028 attributes are equal to their respective values. For example, to search for all entries with a particular URL
2031 my @entries = $kdbx->find_entries({
2032 url => 'https://example.com',
2036 To search for entries matching I<any> criteria, just change the hashref to an arrayref. To search for entries
2037 with a particular URL B<OR> a particular username:
2039 my @entries = $kdbx->find_entries([ # <-- square bracket
2040 url => 'https://example.com',
2044 You can user different operators to test different types of attributes. The L<File::KDBX::Entry/icon_id>
2045 attribute is a number, so we should use a number comparison operator. To find entries using the smartphone
2048 my @entries = $kdbx->find_entries({
2049 icon_id => { '==', ICON_SMARTPHONE },
2052 Note: L<File::KDBX::Constants/ICON_SMARTPHONE> is just a constant from L<File::KDBX::Constants>. It isn't
2053 special to this example or to queries generally. We could have just used a literal number.
2055 The important thing to notice here is how we wrapped the condition in another arrayref with a single key-pair
2056 where the key is the name of an operator and the value is the thing to match against. The supported operators
2060 * C<eq> - String equal
2061 * C<ne> - String not equal
2062 * C<lt> - String less than
2063 * C<gt> - String greater than
2064 * C<le> - String less than or equal
2065 * C<ge> - String greater than or equal
2066 * C<==> - Number equal
2067 * C<!=> - Number not equal
2068 * C<< < >> - Number less than
2069 * C<< > >>> - Number greater than
2070 * C<< <= >> - Number less than or equal
2071 * C<< >= >> - Number less than or equal
2072 * C<=~> - String match regular expression
2073 * C<!~> - String does not match regular expression
2074 * C<!> - Boolean false
2075 * C<!!> - Boolean true
2077 Other special operators:
2080 * C<-true> - Boolean true
2081 * C<-false> - Boolean false
2082 * C<-not> - Boolean false (alias for C<-false>)
2083 * C<-defined> - Is defined
2084 * C<-undef> - Is not d efined
2085 * C<-empty> - Is empty
2086 * C<-nonempty> - Is not empty
2087 * C<-or> - Logical or
2088 * C<-and> - Logical and
2090 Let's see another example using an explicit operator. To find all groups except one in particular (identified
2091 by its L<File::KDBX::Group/uuid>), we can use the C<ne> (string not equal) operator:
2093 my ($group, @other) = $kdbx->find_groups({
2095 'ne' => uuid('596f7520-6172-6520-7370-656369616c2e'),
2098 if (@other) { say "Problem: there can be only one!" }
2100 Note: L<File::KDBX::Util/uuid> is a little helper function to convert a UUID in its pretty form into octets.
2101 This helper function isn't special to this example or to queries generally. It could have been written with
2102 a literal such as C<"\x59\x6f\x75\x20\x61...">, but that's harder to read.
2104 Notice we searched for groups this time. Finding groups works exactly the same as it does for entries.
2106 Testing the truthiness of an attribute is a little bit different because it isn't a binary operation. To find
2107 all entries with the password quality check disabled:
2109 my @entries = $kdbx->find_entries({ '!' => 'quality_check' });
2111 This time the string after the operator is the attribute name rather than a value to compare the attribute
2112 against. To test that a boolean value is true, use the C<!!> operator (or C<-true> if C<!!> seems a little too
2113 weird for your taste):
2115 my @entries = $kdbx->find_entries({ '!!' => 'quality_check' });
2116 my @entries = $kdbx->find_entries({ -true => 'quality_check' });
2118 Yes, there is also a C<-false> and a C<-not> if you prefer one of those over C<!>. C<-false> and C<-not>
2119 (along with C<-true>) are also special in that you can use them to invert the logic of a subquery. These are
2120 logically equivalent:
2122 my @entries = $kdbx->find_entries([ -not => { title => 'My Bank' } ]);
2123 my @entries = $kdbx->find_entries({ title => { 'ne' => 'My Bank' } });
2125 These special operators become more useful when combined with two more special operators: C<-and> and C<-or>.
2126 With these, it is possible to construct more interesting queries with groups of logic. For example:
2128 my @entries = $kdbx->find_entries({
2129 title => { '=~', qr/bank/ },
2132 notes => { '=~', qr/business/ },
2133 icon_id => { '==', ICON_TRASHCAN_FULL },
2138 In English, find entries where the word "bank" appears anywhere in the title but also do not have either the
2139 word "business" in the notes or is using the full trashcan icon.
2141 =head2 Subroutine Query
2143 Lastly, as mentioned at the top, you can ignore all this and write your own subroutine. Your subroutine will
2144 be called once for each thing being searched over. The single argument is the search candidate. The subroutine
2145 should match the candidate against whatever criteria you want and return true if it matches. The C<find_*>
2146 methods collect all matching things and return them.
2148 For example, to find all entries in the database titled "My Bank":
2150 my @entries = $kdbx->find_entries(sub { shift->title eq 'My Bank' });
2151 # logically the same as this declarative structure:
2152 my @entries = $kdbx->find_entries({ title => 'My Bank' });
2153 # as well as this simple expression:
2154 my @entries = $kdbx->find_entries([ \'My Bank', 'eq', qw{title} ]);
2156 This is a trivial example, but of course your subroutine can be arbitrarily complex.
2158 All of these query mechanisms described in this section are just tools, each with its own set of limitations.
2159 If the tools are getting in your way, you can of course iterate over the contents of a database and implement
2160 your own query logic, like this:
2162 my $entries = $kdbx->entries;
2163 while (my $entry = $entries->next) {
2164 if (wanted($entry)) {
2165 do_something($entry);
2174 Errors in this package are constructed as L<File::KDBX::Error> objects and propagated using perl's built-in
2175 mechanisms. Fatal errors are propagated using L<functions/die> and non-fatal errors (a.k.a. warnings) are
2176 propagated using L<functions/warn> while adhering to perl's L<warnings> system. If you're already familiar
2177 with these mechanisms, you can skip this section.
2179 You can catch fatal errors using L<functions/eval> (or something like L<Try::Tiny>) and non-fatal errors using
2180 C<$SIG{__WARN__}> (see L<variables/%SIG>). Examples:
2182 use File::KDBX::Error qw(error);
2184 my $key = ''; # uh oh
2186 $kdbx->load_file('whatever.kdbx', $key);
2188 if (my $error = error($@)) {
2189 handle_missing_key($error) if $error->type eq 'key.missing';
2193 or using C<Try::Tiny>:
2196 $kdbx->load_file('whatever.kdbx', $key);
2202 Catching non-fatal errors:
2205 local $SIG{__WARN__} = sub { push @warnings, $_[0] };
2207 $kdbx->load_file('whatever.kdbx', $key);
2209 handle_warnings(@warnings) if @warnings;
2211 By default perl prints warnings to C<STDERR> if you don't catch them. If you don't want to catch them and also
2212 don't want them printed to C<STDERR>, you can suppress them lexically (perl v5.28 or higher required):
2215 no warnings 'File::KDBX';
2222 local $File::KDBX::WARNINGS = 0;
2226 or globally in your program:
2228 $File::KDBX::WARNINGS = 0;
2230 You cannot suppress fatal errors, and if you don't catch them your program will exit.
2234 This software will alter its behavior depending on the value of certain environment variables:
2237 * C<PERL_FILE_KDBX_XS> - Do not use L<File::KDBX::XS> if false (default: true)
2238 * C<PERL_ONLY> - Do not use L<File::KDBX::XS> if true (default: false)
2239 * C<NO_FORK> - Do not fork if true (default: false)
2243 Some features (e.g. parsing) require 64-bit perl. It should be possible and actually pretty easy to make it
2244 work using L<Math::BigInt>, but I need to build a 32-bit perl in order to test it and frankly I'm still
2245 figuring out how. I'm sure it's simple so I'll mark this one "TODO", but for now an exception will be thrown
2246 when trying to use such features with undersized IVs.
2250 L<File::KeePass> is a much older alternative. It's good but has a backlog of bugs and lacks support for newer
2267 =attr deleted_objects
2271 $value = $kdbx->$attr;
2272 $kdbx->$attr($value);
2274 Get and set attributes.