summaryrefslogtreecommitdiffstats
path: root/lib/KiokuDB/Serializer/YAML/Crypt.pm
diff options
context:
space:
mode:
Diffstat (limited to 'lib/KiokuDB/Serializer/YAML/Crypt.pm')
-rw-r--r--lib/KiokuDB/Serializer/YAML/Crypt.pm21
1 files changed, 21 insertions, 0 deletions
diff --git a/lib/KiokuDB/Serializer/YAML/Crypt.pm b/lib/KiokuDB/Serializer/YAML/Crypt.pm
index 9902424..5f6f85b 100644
--- a/lib/KiokuDB/Serializer/YAML/Crypt.pm
+++ b/lib/KiokuDB/Serializer/YAML/Crypt.pm
@@ -6,8 +6,29 @@ use namespace::autoclean;
=head1 SYNOPSIS
+ use KiokuDB::Util;
+ use KiokuDB::Serializer::YAML::Crypt;
+
+ my $dsn = '...';
+ my $secret = '...';
+
+ my $backend = KiokuDB::Util::dsn_to_backend(
+ $dsn,
+ serializer => KiokuDB::Serializer::YAML::Crypt->new(
+ crypt_cipher => 'Rijndael',
+ crypt_mode => 'CFB',
+ crypt_key => $secret,
+ ),
+ )
+
+ my $d = KiokuDB->new(backend => $backend);
+
=head1 DESCRIPTION
+This serializer class extends L<KiokuDB::Serializer::YAML> to add
+encryption support. See L<KiokuDB::Serializer::Crypt> for an explanation of the
+allowed attributes.
+
=cut
extends 'KiokuDB::Serializer::YAML';