JezK
Edit File: DBIx::Class::InflateColumn::Authen::Passphrase.3pm
.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "DBIx::Class::InflateColumn::Authen::Passphrase 3pm" .TH DBIx::Class::InflateColumn::Authen::Passphrase 3pm "2019-06-30" "perl v5.28.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" DBIx::Class::InflateColumn::Authen::Passphrase \- Inflate/deflate columns to Authen::Passphrase instances .SH "VERSION" .IX Header "VERSION" version 0.03 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& _\|_PACKAGE_\|_\->load_components(qw(InflateColumn::Authen::Passphrase)); \& \& _\|_PACKAGE_\|_\->add_columns( \& id => { \& data_type => \*(Aqinteger\*(Aq, \& is_auto_increment => 1, \& }, \& passphrase_rfc2307 => { \& data_type => \*(Aqtext\*(Aq, \& inflate_passphrase => \*(Aqrfc2307\*(Aq, \& }, \& passphrase_crypt => { \& data_type => \*(Aqtext\*(Aq, \& inflate_passphrase => \*(Aqcrypt\*(Aq, \& }, \& ); \& \& _\|_PACKAGE_\|_\->set_primary_key(\*(Aqid\*(Aq); \& \& \& # in application code \& $rs\->create({ passphrase_rfc2307 => Authen::Passphrase::RejectAll\->new }); \& \& my $row = $rs\->find({ id => $id }); \& if ($row\->passphrase_rfc2307\->match($input)) { ... .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Provides inflation and deflation for Authen::Passphrase instances from and to either \s-1RFC 2307\s0 or crypt encoding. .PP To enable both inflating and deflating, \f(CW\*(C`inflate_passphrase\*(C'\fR must be set to a valid passphrase encoding. Currently the only supported encodings are \f(CW\*(C`rfc2307\*(C'\fR and \f(CW\*(C`crypt\*(C'\fR. The specified encoding will be used both when storing \&\f(CW\*(C`Authen::Passphrase\*(C'\fR instances in columns, and when creating \&\f(CW\*(C`Authen::Passphrase\*(C'\fR instances from columns. See Authen::Passphrase for details on passphrase encodings. .PP Note that not all passphrase schemes supported by \f(CW\*(C`Authen::Passphrase\*(C'\fR can be represented in either \s-1RFC 2307\s0 or crypt encoding. Chose the kind of passphrase encoding you're using based on the encoding supported by the passphrase algorithms you're using. .PP When trying to encode a passphrase instance with an encoding that doesn't support it, an exception will be thrown. Similarly, when trying to load a passphrase instance from a faulty or unknown encoded representation, an exception will be thrown. .SH "METHODS" .IX Header "METHODS" .SS "register_column" .IX Subsection "register_column" Chains with the \f(CW\*(C`register_column\*(C'\fR method in \f(CW\*(C`DBIx::Class::Row\*(C'\fR, and sets up passphrase columns appropriately. This would not normally be directly called by end users. .SH "SUPPORT" .IX Header "SUPPORT" Bugs may be submitted through the \s-1RT\s0 bug tracker <https://rt.cpan.org/Public/Dist/Display.html?Name=DBIx-Class-InflateColumn-Authen-Passphrase> (or bug\-DBIx\-Class\-InflateColumn\-Authen\-Passphrase@rt.cpan.org <mailto:bug-DBIx-Class-InflateColumn-Authen-Passphrase@rt.cpan.org>). .SH "AUTHOR" .IX Header "AUTHOR" Florian Ragwitz <rafl@debian.org> .SH "CONTRIBUTOR" .IX Header "CONTRIBUTOR" Karen Etheridge <ether@cpan.org> .SH "COPYRIGHT AND LICENCE" .IX Header "COPYRIGHT AND LICENCE" This software is copyright (c) 2010 by Florian Ragwitz. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.