.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.22)
.\"
.\" 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 "SmbHash 3pm"
.TH SmbHash 3pm "2005-09-24" "perl v5.14.2" "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::SmbHash \- Perl\-only implementation of lanman and nt md4 hash functions, for use in Samba style smbpasswd entries
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Crypt::SmbHash;
\&
\&  ntlmgen SCALAR, LMSCALAR, NTSCALAR;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module generates Lanman and \s-1NT\s0 \s-1MD4\s0 style password hashes, using
perl-only code for portability. The module aids in the administration
of Samba style systems.
.PP
In the Samba distribution, authentication is referred to a private
smbpasswd file. Entries have similar forms to the following:
.PP
username:unixuid:LM:NT
.PP
Where \s-1LM\s0 and \s-1NT\s0 are one-way password hashes of the same password.
.PP
ntlmgen generates the hashes given in the first argument, and places
the result in the second and third arguments.
.PP
Example:
To generate a smbpasswd entry:
.PP
.Vb 10
\&   #!/usr/local/bin/perl 
\&   use Crypt::SmbHash;
\&   $username = $ARGV[0];
\&   $password = $ARGV[1];
\&   if ( !$password ) {
\&           print "Not enough arguments\en";
\&           print "Usage: $0 username password\en";
\&           exit 1;
\&   }
\&   $uid = (getpwnam($username))[2];
\&   my ($login,undef,$uid) = getpwnam($ARGV[0]);
\&   ntlmgen $password, $lm, $nt;
\&   printf "%s:%d:%s:%s:[%\-11s]:LCT\-%08X\en", $login, $uid, $lm, $nt, "U", time;
.Ve
.PP
ntlmgen returns returns the hash values in a list context, so the alternative
method of using it is:
.PP
.Vb 1
\&   ( $lm, $nt ) = ntlmgen $password;
.Ve
.PP
The functions lmhash and nthash are used by ntlmgen to generate the
hashes, and are available when requested:
.PP
.Vb 3
\&   use Crypt::SmbHash qw(lmhash nthash)
\&   $lm = lmhash($pass);
\&   $nt = nthash($pass);
.Ve
.PP
If Encoding is available (part of perl\-5.8) the \f(CW$pass\fR argument to
ntlmgen, lmhash and nthash must be a perl string. In double use this:
.PP
.Vb 5
\&   use Crypt::SmbHash qw(ntlmgen lmhash nthash);
\&   use Encode;
\&   ( $lm, $nt ) = ntlmgen decode(\*(Aqiso\-8859\-1\*(Aq, $pass);
\&   $lm = lmhash(decode_utf8($pass), $pwenc);
\&   $nt = nthash(decode_utf8($pass));
.Ve
.PP
The \f(CW$pwenc\fR parameter to \fIlmhash()\fR is optional and defaults to 'iso\-8859\-1'.
It specifies the encoding to which the password is encoded before hashing.
.SH "MD4"
.IX Header "MD4"
The algorithm used in nthash requires the md4 algorithm. This algorithm
is included in this module for completeness, but because it is written
in all-perl code ( rather than in C ), it's not very quick.
.PP
However if you have the Digest::MD4 module installed, Crypt::SmbHash will
try to use that module instead, making it much faster.
.PP
A simple test compared calling nthash without Digest::MD4 installed, and
with, this showed that using nthash on a system with Digest::MD4 installed
proved to be over 90 times faster.
.SH "AUTHOR"
.IX Header "AUTHOR"
Ported from Samba by Benjamin Kuit <lt>bj@it.uts.edu.au<gt>.
.PP
Samba is Copyright(C) Andrew Tridgell 1997\-1998
.PP
Because this module is a direct port of code within the Samba
distribution, it follows the same license, that is:
.PP
.Vb 4
\&   This program is free software; you can redistribute it and/or modify
\&   it under the terms of the GNU General Public License as published by
\&   the Free Software Foundation; either version 2 of the License, or
\&   (at your option) any later version.
\&
\&   This program is distributed in the hope that it will be useful,
\&   but WITHOUT ANY WARRANTY; without even the implied warranty of
\&   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
\&   GNU General Public License for more details.
.Ve