Edit File: LWP::Authen::Ntlm.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 "LWP::Authen::Ntlm 3" .TH LWP::Authen::Ntlm 3 "2015-02-14" "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" LWP::Authen::Ntlm \- Library for enabling NTLM authentication (Microsoft) in LWP .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 3 \& use LWP::UserAgent; \& use HTTP::Request::Common; \& my $url = \*(Aqhttp://www.company.com/protected_page.html\*(Aq; \& \& # Set up the ntlm client and then the base64 encoded ntlm handshake message \& my $ua = LWP::UserAgent\->new(keep_alive=>1); \& $ua\->credentials(\*(Aqwww.company.com:80\*(Aq, \*(Aq\*(Aq, "MyDomain\e\eMyUserCode", \*(AqMyPassword\*(Aq); \& \& $request = GET $url; \& print "\-\-Performing request now...\-\-\-\-\-\-\-\-\-\-\-\en"; \& $response = $ua\->request($request); \& print "\-\-Done with request\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\en"; \& \& if ($response\->is_success) {print "It worked!\->" . $response\->code . "\en"} \& else {print "It didn\*(Aqt work!\->" . $response\->code . "\en"} .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\f(CW\*(C`LWP::Authen::Ntlm\*(C'\fR allows \s-1LWP\s0 to authenticate against servers that are using the \&\s-1NTLM\s0 authentication scheme popularized by Microsoft. This type of authentication is common on intranets of Microsoft-centric organizations. .PP The module takes advantage of the Authen::NTLM module by Mark Bush. Since there is also another Authen::NTLM module available from \s-1CPAN\s0 by Yee Man Chan with an entirely different interface, it is necessary to ensure that you have the correct \&\s-1NTLM\s0 module. .PP In addition, there have been problems with incompatibilities between different versions of Mime::Base64, which Bush's Authen::NTLM makes use of. Therefore, it is necessary to ensure that your Mime::Base64 module supports exporting of the encode_base64 and decode_base64 functions. .SH "USAGE" .IX Header "USAGE" The module is used indirectly through \s-1LWP\s0, rather than including it directly in your code. The \s-1LWP\s0 system will invoke the \s-1NTLM\s0 authentication when it encounters the authentication scheme while attempting to retrieve a \s-1URL\s0 from a server. In order for the \s-1NTLM\s0 authentication to work, you must have a few things set up in your code prior to attempting to retrieve the \s-1URL:\s0 .IP "\(bu" 4 Enable persistent \s-1HTTP\s0 connections .Sp To do this, pass the \*(L"keep_alive=>1\*(R" option to the LWP::UserAgent when creating it, like this: .Sp .Vb 1 \& my $ua = LWP::UserAgent\->new(keep_alive=>1); .Ve .IP "\(bu" 4 Set the credentials on the UserAgent object .Sp The credentials must be set like this: .Sp .Vb 1 \& $ua\->credentials(\*(Aqwww.company.com:80\*(Aq, \*(Aq\*(Aq, "MyDomain\e\eMyUserCode", \*(AqMyPassword\*(Aq); .Ve .Sp Note that you cannot use the HTTP::Request object's \fIauthorization_basic()\fR method to set the credentials. Note, too, that the 'www.company.com:80' portion only sets credentials on the specified port \s-1AND\s0 it is case-sensitive (this is due to the way \s-1LWP\s0 is coded, and has nothing to do with LWP::Authen::Ntlm) .SH "AVAILABILITY" .IX Header "AVAILABILITY" General queries regarding \s-1LWP\s0 should be made to the \s-1LWP\s0 Mailing List. .PP Questions specific to LWP::Authen::Ntlm can be forwarded to jtillman@bigfoot.com .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (c) 2002 James Tillman. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\s-1LWP\s0, LWP::UserAgent, lwpcook.
Back to File Manager