NTLMUtilities (MINA 2.0.13 API文档 - 即时通讯网(52im.net))

java.lang.Object
- org.apache.mina.proxy.handlers.http.ntlm.NTLMUtilities

所有已实现的接口:

NTLMConstants
```
public class NTLMUtilities
extends java.lang.Object
implements NTLMConstants
```
NTLMUtilities.java - NTLM functions used for authentication and unit testing.

从以下版本开始:

MINA 2.0.0-M3

作者:

Apache MINA Project

字段概要
- 从接口继承的字段 org.apache.mina.proxy.handlers.http.ntlm.NTLMConstants
  DEFAULT_FLAGS, DEFAULT_OS_VERSION, FLAG_NEGOTIATE_128_BIT_ENCRYPTION, FLAG_NEGOTIATE_56_BIT_ENCRYPTION, FLAG_NEGOTIATE_ALWAYS_SIGN, FLAG_NEGOTIATE_ANONYMOUS, FLAG_NEGOTIATE_DATAGRAM_STYLE, FLAG_NEGOTIATE_DOMAIN_SUPPLIED, FLAG_NEGOTIATE_KEY_EXCHANGE, FLAG_NEGOTIATE_LAN_MANAGER_KEY, FLAG_NEGOTIATE_LOCAL_CALL, FLAG_NEGOTIATE_NTLM, FLAG_NEGOTIATE_NTLM2, FLAG_NEGOTIATE_OEM, FLAG_NEGOTIATE_SEAL, FLAG_NEGOTIATE_SIGN, FLAG_NEGOTIATE_TARGET_INFO, FLAG_NEGOTIATE_UNICODE, FLAG_NEGOTIATE_WORKSTATION_SUPPLIED, FLAG_REQUEST_SERVER_AUTH_REALM, FLAG_TARGET_TYPE_DOMAIN, FLAG_TARGET_TYPE_SERVER, FLAG_TARGET_TYPE_SHARE, FLAG_UNIDENTIFIED_1, FLAG_UNIDENTIFIED_10, FLAG_UNIDENTIFIED_11, FLAG_UNIDENTIFIED_2, FLAG_UNIDENTIFIED_3, FLAG_UNIDENTIFIED_4, FLAG_UNIDENTIFIED_5, FLAG_UNIDENTIFIED_6, FLAG_UNIDENTIFIED_7, FLAG_UNIDENTIFIED_8, FLAG_UNIDENTIFIED_9, MESSAGE_TYPE_1, MESSAGE_TYPE_2, MESSAGE_TYPE_3, NTLM_SIGNATURE, TARGET_INFORMATION_SUBBLOCK_DNS_DOMAIN_NAME_TYPE, TARGET_INFORMATION_SUBBLOCK_DOMAIN_TYPE, TARGET_INFORMATION_SUBBLOCK_FQDNS_HOSTNAME_TYPE, TARGET_INFORMATION_SUBBLOCK_PARENT_DNS_DOMAIN_NAME_TYPE, TARGET_INFORMATION_SUBBLOCK_SERVER_TYPE, TARGET_INFORMATION_SUBBLOCK_TERMINATOR_TYPE

构造器概要

构造器
构造器和说明

NTLMUtilities()

构造器
构造器和说明
`NTLMUtilities()`

方法概要

方法
限定符和类型	方法和说明
`static byte[]`	`createType1Message(java.lang.String workStation, java.lang.String domain, java.lang.Integer customFlags, byte[] osVersion)` see http://davenport.sourceforge.net/ntlm.html#theType1Message
`static byte[]`	`createType3Message(java.lang.String user, java.lang.String password, byte[] challenge, java.lang.String target, java.lang.String workstation, java.lang.Integer serverFlags, byte[] osVersion)`
`static byte[]`	`extractChallengeFromType2Message(byte[] msg)` Extracts the NTLM challenge from the type 2 message as an 8 byte array.
`static int`	`extractFlagsFromType2Message(byte[] msg)` Extracts the NTLM flags from the type 2 message.
`static byte[]`	`extractTargetInfoFromType2Message(byte[] msg, java.lang.Integer msgFlags)` Extracts the target information block from the type 2 message.
`static java.lang.String`	`extractTargetNameFromType2Message(byte[] msg, java.lang.Integer msgFlags)` Extracts the target name from the type 2 message.
`static byte[]`	`getOsVersion()` Tries to return a valid OS version on Windows systems.
`static void`	`printTargetInformationBlockFromType2Message(byte[] msg, java.lang.Integer msgFlags, java.io.PrintWriter out)` Prints to the `PrintWriter` the target information block extracted from the type 2 message.
`static byte[]`	`readSecurityBufferTarget(byte[] msg, int securityBufferOffset)` Reads the byte array described by the security buffer stored at the `securityBufferOffset` offset.
`static void`	`writeOSVersion(byte majorVersion, byte minorVersion, short buildNumber, byte[] b, int offset)` Writes the Windows OS version passed in as three byte values (majorVersion.minorVersion.buildNumber) to the given byte array at `offset`.
`static byte[]`	`writeSecurityBuffer(short length, int bufferOffset)`
`static void`	`writeSecurityBuffer(short length, short allocated, int bufferOffset, byte[] b, int offset)` Writes a security buffer to the given array `b` at offset `offset`.
`static int`	`writeSecurityBufferAndUpdatePointer(java.io.ByteArrayOutputStream baos, short len, int pointer)` Writes a security buffer and returns the pointer of the position where to write the next security buffer.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - NTLMUtilities
```
public NTLMUtilities()
```
- 方法详细资料
  - writeSecurityBuffer
```
public static final byte[] writeSecurityBuffer(short length,
                         int bufferOffset)
```
    参数:
    length - The length of the security buffer
    bufferOffset - The offset in the security buffer
    
    返回:
    Th created buffer
    另请参阅:
    writeSecurityBuffer(short, short, int, byte[], int)
  - writeSecurityBuffer
```
public static final void writeSecurityBuffer(short length,
                       short allocated,
                       int bufferOffset,
                       byte[] b,
                       int offset)
```
    Writes a security buffer to the given array b at offset offset. A security buffer defines a pointer to an area in the data that defines some data with a variable length. This allows to have a semi-fixed length header thus making a little bit easier the decoding process in the NTLM protocol.
    
    参数:
    length - the length of the security buffer
    allocated - the allocated space for the security buffer (should be greater or equal to length
    bufferOffset - the offset from the main array where the currently defined security buffer will be written
    b - the buffer in which we write the security buffer
    offset - the offset at which to write to the b buffer
  - writeOSVersion
```
public static final void writeOSVersion(byte majorVersion,
                  byte minorVersion,
                  short buildNumber,
                  byte[] b,
                  int offset)
```
    Writes the Windows OS version passed in as three byte values (majorVersion.minorVersion.buildNumber) to the given byte array at offset.
    
    参数:
    majorVersion - the major version number
    minorVersion - the minor version number
    buildNumber - the build number
    b - the target byte array
    offset - the offset at which to write in the array
  - getOsVersion
```
public static final byte[] getOsVersion()
```
    Tries to return a valid OS version on Windows systems. If it fails to do so or if we're running on another OS then a fake Windows XP OS version is returned because the protocol uses it.
    
    返回:
    a NTLM OS version byte buffer
  - createType1Message
```
public static final byte[] createType1Message(java.lang.String workStation,
                        java.lang.String domain,
                        java.lang.Integer customFlags,
                        byte[] osVersion)
```
    see http://davenport.sourceforge.net/ntlm.html#theType1Message
    
    参数:
    workStation - the workstation name
    domain - the domain name
    customFlags - custom flags, if null then NTLMConstants.DEFAULT_CONSTANTS is used
    osVersion - the os version of the client, if null then NTLMConstants.DEFAULT_OS_VERSION is used
    
    返回:
    the type 1 message
  - writeSecurityBufferAndUpdatePointer
```
public static final int writeSecurityBufferAndUpdatePointer(java.io.ByteArrayOutputStream baos,
                                      short len,
                                      int pointer)
                                                     throws java.io.IOException
```
    Writes a security buffer and returns the pointer of the position where to write the next security buffer.
    
    参数:
    baos - the stream where the security buffer is written
    len - the length of the security buffer
    pointer - the position where the security buffer can be written
    
    返回:
    the position where the next security buffer will be written
    
    抛出:
    
    java.io.IOException - if writing to the ByteArrayOutputStream fails
  - extractChallengeFromType2Message
```
public static final byte[] extractChallengeFromType2Message(byte[] msg)
```
    Extracts the NTLM challenge from the type 2 message as an 8 byte array.
    
    参数:
    msg - the type 2 message byte array
    
    返回:
    the challenge
  - extractFlagsFromType2Message
```
public static final int extractFlagsFromType2Message(byte[] msg)
```
    Extracts the NTLM flags from the type 2 message.
    
    参数:
    msg - the type 2 message byte array
    
    返回:
    the proxy flags as an int
  - readSecurityBufferTarget
```
public static final byte[] readSecurityBufferTarget(byte[] msg,
                              int securityBufferOffset)
```
    Reads the byte array described by the security buffer stored at the securityBufferOffset offset.
    
    参数:
    msg - the message where to read the security buffer and it's value
    securityBufferOffset - the offset at which to read the security buffer
    
    返回:
    a new byte array holding the data pointed by the security buffer
  - extractTargetNameFromType2Message
```
public static final java.lang.String extractTargetNameFromType2Message(byte[] msg,
                                                 java.lang.Integer msgFlags)
                                                                throws java.io.UnsupportedEncodingException
```
    Extracts the target name from the type 2 message.
    
    参数:
    msg - the type 2 message byte array
    msgFlags - the flags if null then flags are extracted from the type 2 message
    
    返回:
    the target name
    
    抛出:
    
    java.io.UnsupportedEncodingException - if unable to use the needed UTF-16LE or ASCII charsets
  - extractTargetInfoFromType2Message
```
public static final byte[] extractTargetInfoFromType2Message(byte[] msg,
                                       java.lang.Integer msgFlags)
```
    Extracts the target information block from the type 2 message.
    
    参数:
    msg - the type 2 message byte array
    msgFlags - the flags if null then flags are extracted from the type 2 message
    
    返回:
    the target info
  - printTargetInformationBlockFromType2Message
```
public static final void printTargetInformationBlockFromType2Message(byte[] msg,
                                               java.lang.Integer msgFlags,
                                               java.io.PrintWriter out)
                                                              throws java.io.UnsupportedEncodingException
```
    Prints to the PrintWriter the target information block extracted from the type 2 message.
    
    参数:
    msg - the type 2 message
    msgFlags - the flags if null then flags are extracted from the type 2 message
    out - the output target for the information
    
    抛出:
    
    java.io.UnsupportedEncodingException - if unable to use the needed UTF-16LE or ASCII charsets
  - createType3Message
```
public static final byte[] createType3Message(java.lang.String user,
                        java.lang.String password,
                        byte[] challenge,
                        java.lang.String target,
                        java.lang.String workstation,
                        java.lang.Integer serverFlags,
                        byte[] osVersion)
```
    参数:
    user - the user name
    password - the user password
    challenge - the challenge response
    target - the target name
    workstation - the client workstation's name
    serverFlags - the flags set by the client
    osVersion - the os version of the client
    
    返回:
    the type 3 message
    另请参阅:
    NTLM message type

类 NTLMUtilities

字段概要

从接口继承的字段 org.apache.mina.proxy.handlers.http.ntlm.NTLMConstants

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

NTLMUtilities

方法详细资料

writeSecurityBuffer

writeSecurityBuffer

writeOSVersion

getOsVersion

createType1Message

writeSecurityBufferAndUpdatePointer

extractChallengeFromType2Message

extractFlagsFromType2Message

readSecurityBufferTarget

extractTargetNameFromType2Message

extractTargetInfoFromType2Message

printTargetInformationBlockFromType2Message

createType3Message