.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 "Jifty::DBI::Filter::SaltHash 3pm"
.TH Jifty::DBI::Filter::SaltHash 3pm "2022-06-15" "perl v5.34.0" "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"
Jifty::DBI::Filter::SaltHash \- salts and hashes a value before storing it
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This filter will generate a random 4\-byte salt, and then \s-1MD5\s0 the given
value with the salt appended to the value. It will store the hash and
the salt in the database, and return a data structure that contains
both on decode. The salt and hash are stored in hexadecimal in the
database, so that you can put them in a text field.
.PP
This filter is intended for storing passwords in a database.
.SS "encode"
.IX Subsection "encode"
Generate a random 4\-byte salt, \s-1MD5\s0 the value with the salt (encoded to
hexadecimal) appended to it, and store both in the database.
.SS "generate_salt"
.IX Subsection "generate_salt"
Return a random 4\-byte salt value, encoded as an 8\-character hex
string.
.SS "decode"
.IX Subsection "decode"
Return an arrayref of (hash, salt), both as hex strings.
.PP
To test whether a provided value is the same one originally encoded,
use
.PP
.Vb 1
\&    $hash eq md5_hex($value . $salt);
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Jifty::DBI::Filter, Digest::MD5