| java.lang.Object
 org.apache.commons.httpclient.auth.NTLM
| NTLM | | final class NTLM (Code) | | Provides an implementation of the NTLM authentication protocol.
This class provides methods for generating authentication
challenge responses for the NTLM authentication protocol. The NTLM
protocol is a proprietary Microsoft protocol and as such no RFC
exists for it. This class is based upon the reverse engineering
efforts of a wide range of people.
Please note that an implementation of JCE must be correctly installed and configured when
using NTLM support.
This class should not be used externally to HttpClient as it's API is specifically
designed to work with HttpClient's use case, in particular it's connection management.
author:
Adrian Sutton
author:
Jeff Dever
author:
Mike Bowler
version:
$Revision: 480424 $ $Date: 2006-11-29 06:56:49 +0100 (Wed, 29 Nov 2006) $
since:
3.0 |
| Method Summary | |
| public String | getCredentialCharset()
| | final public String | getResponseFor(String message, String username, String password, String host, String domain)
Returns the response for the given message.
Parameters:
message - the message that was received from the server.
Parameters:
username - the username to authenticate with.
Parameters:
password - the password to authenticate with.
Parameters:
host - The host.
Parameters:
domain - the NT domain to authenticate in. | | public String | getType1Message(String host, String domain)
Creates the first message (type 1 message) in the NTLM authentication sequence.
This message includes the user name, domain and host for the authentication session.
Parameters:
host - the computer name of the host requesting authentication.
Parameters:
domain - The domain to authenticate with. | | public String | getType3Message(String user, String password, String host, String domain, byte[] nonce)
Creates the type 3 message using the given server nonce. | | public byte[] | parseType2Message(String message)
Extracts the server nonce out of the given message type 2.
Parameters:
message - the String containing the base64 encoded message. | | public void | setCredentialCharset(String credentialCharset)
|
| DEFAULT_CHARSET | | final public static String DEFAULT_CHARSET(Code) | | Character encoding
|
| getCredentialCharset | | public String getCredentialCharset()(Code) | | Returns the credentialCharset. |
| getResponseFor | | final public String getResponseFor(String message, String username, String password, String host, String domain) throws AuthenticationException(Code) | | Returns the response for the given message.
Parameters:
message - the message that was received from the server.
Parameters:
username - the username to authenticate with.
Parameters:
password - the password to authenticate with.
Parameters:
host - The host.
Parameters:
domain - the NT domain to authenticate in. The response.
throws:
HttpException - If the messages cannot be retrieved. |
| getType1Message | | public String getType1Message(String host, String domain)(Code) | | Creates the first message (type 1 message) in the NTLM authentication sequence.
This message includes the user name, domain and host for the authentication session.
Parameters:
host - the computer name of the host requesting authentication.
Parameters:
domain - The domain to authenticate with. String the message to add to the HTTP request header. |
| getType3Message | | public String getType3Message(String user, String password, String host, String domain, byte[] nonce) throws AuthenticationException(Code) | | Creates the type 3 message using the given server nonce. The type 3 message includes all the
information for authentication, host, domain, username and the result of encrypting the
nonce sent by the server using the user's password as the key.
Parameters:
user - The user name. This should not include the domain name.
Parameters:
password - The password.
Parameters:
host - The host that is originating the authentication request.
Parameters:
domain - The domain to authenticate within.
Parameters:
nonce - the 8 byte array the server sent. The type 3 message.
throws:
AuthenticationException - If fails. |
| parseType2Message | | public byte[] parseType2Message(String message)(Code) | | Extracts the server nonce out of the given message type 2.
Parameters:
message - the String containing the base64 encoded message. an array of 8 bytes that the server sent to be used whenhashing the password. |
| setCredentialCharset | | public void setCredentialCharset(String credentialCharset)(Code) | |
Parameters:
credentialCharset - The credentialCharset to set. |
|
|