AnonymousFox

//usr/local/share/man/man3/Crypt::Passwd::XS.3pm

.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Crypt::Passwd::XS 3"
.TH Crypt::Passwd::XS 3 "2011-07-26" "perl v5.10.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"
Crypt::Passwd::XS \- Full XS implementation of common crypt() algorithms
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Crypt::Passwd::XS;
\&
\&  my $plaintext = \*(Aqsecret\*(Aq;
\&  my $salt      = \*(Aq$1$1234\*(Aq;
\&  my $crypted   = Crypt::Passwd::XS::crypt( $plaintext, $salt );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides several common \fIcrypt()\fR schemes as full \s-1XS\s0 implementations.
It allows you to validate crypted passwords that were hashed using a scheme
that the system's native \fIcrypt()\fR implementation does not support.
.SS "Description of functions"
.IX Subsection "Description of functions"
The \fB\f(BIcrypt()\fB\fR function handles all supported crypt methods using the standard
salt prefix system for determinging the crypt type.
.PP
The \fB\f(BIunix_md5_crypt()\fB\fR function performs a \s-1MD5\s0 crypt regardless of the salt
prefix.
.PP
The \fB\f(BIapache_md5_crypt()\fB\fR function performs a \s-1APR1\s0 crypt regardless of the salt
prefix.
.PP
The \fB\f(BIunix_des_crypt()\fB\fR funtion performs a traditional \s-1DES\s0 crypt regardless of
the salt prefix.
.PP
The \fB\f(BIunix_sha256_crypt()\fB\fR function performs a \s-1SHA256\s0 crypt regardless of the
salt prefix.
.PP
The \fB\f(BIunix_sha512_crypt()\fB\fR function performs a \s-1SHA512\s0 crypt regardless of the
salt prefix.
.SH "TODO"
.IX Header "TODO"
The blowfish and Sun \fIcrypt()\fR schemes are currently unsupported.
.SH "AUTHOR"
.IX Header "AUTHOR"
John Lightsey, <jd@cpanel.net>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2011 cPanel, Inc.
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.10.1 or,
at your option, any later version of Perl 5 you may have available.
.PP
The following files are adapted from other sources (primarily DragonFly \s-1BSD\s0.)
See the copyright notices in these files for full details:
.PP
crypt_to64.c \- copyright 1991 University of California
.PP
crypt_to64.h \- copyright 1991 University of California
.PP
des.c \- copyright 1994 David Burren, Geoffrey M. Rehmet, Mark R V Murray
.PP
md5.c \- copyright 1999, 2000, 2002 Aladdin Enterprises
.PP
md5.h \- copyright 1999, 2000, 2002 Aladdin Enterprises
.PP
md5crypt.c \- copyright Poul-Henning Kamp
.PP
md5crypt.h \- copyright Poul-Henning Kamp
.PP
sha256crypt.c \- public domain reference implementation by Ulrich Drepper
.PP
sha512crypt.c \- public domain reference implementation by Ulrich Drepper