Top Description Inners Fields Constructors Methods
org.apache.hc.client5.http.impl.auth

pack-priv final Class NTLMEngineImpl

extends Object
implements NTLMEngine
Class Inheritance
All Implemented Interfaces
org.apache.hc.client5.http.impl.auth.NTLMEngine
Annotations
@Deprecated
Imports
java.nio.charset.Charset, .StandardCharsets, java.security.Key, .MessageDigest, .NoSuchAlgorithmException, java.security.cert.Certificate, .CertificateEncodingException, java.util.Arrays, .Locale, .Random, javax.crypto.Cipher, javax.crypto.spec.SecretKeySpec, org.apache.hc.client5.http.utils.Base64, .ByteArrayBuilder

Deprecated

Do not use.

Provides an implementation for NTLMv1, NTLMv2, and NTLM2 Session forms of the NTLM authentication protocol.
Since
4.1

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static class
NTLMEngineImpl.CipherGen

pack-priv static class
NTLMEngineImpl.Handle

pack-priv static class
NTLMEngineImpl.HMACMD5

Cryptography support - HMACMD5 - algorithmically based on various web resources by Karl Wright

pack-priv static class
NTLMEngineImpl.MD4

Cryptography support - MD4.

pack-priv static enum
NTLMEngineImpl.Mode

pack-priv static class
NTLMEngineImpl.NTLMMessage

NTLM message generation, base class

pack-priv static class
NTLMEngineImpl.Type1Message

Type 1 message assembly class

pack-priv static class
NTLMEngineImpl.Type2Message

Type 2 message class

pack-priv static class
NTLMEngineImpl.Type3Message

Type 3 message assembly class

Field Summary

Modifier and TypeField and Description
private static final Charset
DEFAULT_CHARSET

Character encoding

pack-priv static final int
FLAG_DOMAIN_PRESENT

pack-priv static final int
FLAG_REQUEST_128BIT_KEY_EXCH

pack-priv static final int
FLAG_REQUEST_56BIT_ENCRYPTION

pack-priv static final int
FLAG_REQUEST_ALWAYS_SIGN

pack-priv static final int
FLAG_REQUEST_EXPLICIT_KEY_EXCH

pack-priv static final int
FLAG_REQUEST_LAN_MANAGER_KEY

pack-priv static final int
FLAG_REQUEST_NTLM2_SESSION

pack-priv static final int
FLAG_REQUEST_NTLMv1

pack-priv static final int
FLAG_REQUEST_OEM_ENCODING

pack-priv static final int
FLAG_REQUEST_SEAL

pack-priv static final int
FLAG_REQUEST_SIGN

pack-priv static final int
FLAG_REQUEST_TARGET

pack-priv static final int
FLAG_REQUEST_UNICODE_ENCODING

pack-priv static final int
FLAG_REQUEST_VERSION

pack-priv static final int
FLAG_TARGETINFO_PRESENT

pack-priv static final int
FLAG_WORKSTATION_PRESENT

private static final byte[]
MAGIC_TLS_SERVER_ENDPOINT

pack-priv static final int
MSV_AV_CHANNEL_BINDINGS

pack-priv static final int
MSV_AV_DNS_COMPUTER_NAME

pack-priv static final int
MSV_AV_DNS_DOMAIN_NAME

pack-priv static final int
MSV_AV_DNS_TREE_NAME

pack-priv static final int
MSV_AV_EOL

pack-priv static final int
MSV_AV_FLAGS

pack-priv static final int
MSV_AV_FLAGS_ACCOUNT_AUTH_CONSTAINED

pack-priv static final int
MSV_AV_FLAGS_MIC

pack-priv static final int
MSV_AV_FLAGS_UNTRUSTED_TARGET_SPN

pack-priv static final int
MSV_AV_NB_COMPUTER_NAME

pack-priv static final int
MSV_AV_NB_DOMAIN_NAME

pack-priv static final int
MSV_AV_SINGLE_HOST

pack-priv static final int
MSV_AV_TARGET_NAME

pack-priv static final int
MSV_AV_TIMESTAMP

private static final SecureRandom
RND_GEN

Secure random generator

private static final byte[]
SEAL_MAGIC_CLIENT

private static final byte[]
SEAL_MAGIC_SERVER

private static final byte[]
SIGN_MAGIC_CLIENT

private static final byte[]
SIGN_MAGIC_SERVER

private static final byte[]
SIGNATURE

The signature string as bytes in the default encoding

private static final String
TYPE_1_MESSAGE

private static final Charset
UNICODE_LITTLE_UNMARKED

Unicode encoding

Constructor Summary

AccessConstructor and Description
pack-priv
NTLMEngineImpl()

Method Summary

Modifier and TypeMethod and Description
private static byte[]

Returns:

The blob, used in the calculation of the NTLMv2 Response.
createBlob(final byte[]
The random 8-byte client challenge.
clientChallenge, final byte[]
The target information block from the Type 2 message.
targetInformation, final byte[] timestamp)

Creates the NTLMv2 blob from the given target information block and client challenge.

private static Key

Returns:

A DES encryption key created from the key material starting at the specified offset in the given byte array.
createDESKey(final byte[]
A byte array containing the DES key material.
bytes, final int
The offset in the given byte array at which the 7-byte key material starts.
offset)

Creates a DES encryption key from the given key material.

private static byte[]
encodeLong(final int value)

private static void
encodeLong(final byte[] buf, final int offset, final int value)

pack-priv static int
F(final int x, final int y, final int z)

pack-priv static int
G(final int x, final int y, final int z)

public String
generateType1Msg(final String
Optional Windows domain name. Can be null.
domain, final String
Optional Windows workstation name. Can be null.
workstation)

Implements org.apache.hc.client5.http.impl.auth.NTLMEngine.generateType1Msg.

Generates a Type1 message given the domain and workstation.
public String
generateType3Msg(final String
Windows user name
username, final char[]
Password
password, final String
Windows domain name
domain, final String
Windows workstation name
workstation, final String
Type2 challenge.
challenge)

Implements org.apache.hc.client5.http.impl.auth.NTLMEngine.generateType3Msg.

Generates a Type3 message given the user credentials and the authentication challenge.
private static Charset

Returns:

the character set.
getCharset(final int
is the flags.
flags)

Find the character set based on the flags.

pack-priv static MessageDigest
getMD5()

private static byte[]
getNullTerminatedAsciiString(final String source)

pack-priv static String

Returns:

The response.
getResponseFor(final String
the message that was received from the server.
message, final String
the username to authenticate with.
username, final char[]
the password to authenticate with.
password, final String
The host.
host, final String
the NT domain to authenticate in.
domain)

Returns the response for the given message.

pack-priv static String

Returns:

The response.
getResponseFor(final String
the message that was received from the server.
message, final String
the username to authenticate with.
username, final char[]
the password to authenticate with.
password, final String
The host.
host, final String
the NT domain to authenticate in.
domain, final Certificate peerServerCertificate)

Returns the response for the given message.

pack-priv static String

Returns:

String the message to add to the HTTP request header.
getType1Message(final String
the computer name of the host requesting authentication.
host, final String
The domain to authenticate with.
domain)

Creates the first message (type 1 message) in the NTLM authentication sequence.

pack-priv static String

Returns:

The type 3 message.
getType3Message(final String
The user name. This should not include the domain name.
user, final char[]
The password.
password, final String
The host that is originating the authentication request.
host, final String
The domain to authenticate within.
domain, final byte[]
the 8 byte array the server sent.
nonce, final int type2Flags, final String target, final byte[] targetInformation)

Creates the type 3 message using the given server nonce.

pack-priv static String

Returns:

The type 3 message.
getType3Message(final String
The user name. This should not include the domain name.
user, final char[]
The password.
password, final String
The host that is originating the authentication request.
host, final String
The domain to authenticate within.
domain, final byte[]
the 8 byte array the server sent.
nonce, final int type2Flags, final String target, final byte[] targetInformation, final Certificate peerServerCertificate, final byte[] type1Message, final byte[] type2Message)

Creates the type 3 message using the given server nonce.

pack-priv static int
H(final int x, final int y, final int z)

pack-priv static byte[]
hmacMD5(final byte[] value, final byte[] key)

Calculates HMAC-MD5

private static byte[]

Returns:

The LM Hash of the given password, used in the calculation of the LM Response.
lmHash(final char[]
The password.
password)

Creates the LM Hash of the user's password.

private static byte[]

Returns:

The response (either LM or NTLM, depending on the provided hash).
lmResponse(final byte[]
The LM or NTLM Hash.
hash, final byte[]
The server challenge from the Type 2 message.
challenge)

Creates the LM Response from the given hash and Type 2 challenge.

private static byte[]

Returns:

The LMv2 Hash, used in the calculation of the NTLMv2 and LMv2 Responses.
lmv2Hash(final String domain, final String user, final byte[] ntlmHash)

Creates the LMv2 Hash of the user's password.

private static byte[]

Returns:

The response (either NTLMv2 or LMv2, depending on the client data).
lmv2Response(final byte[]
The NTLMv2 Hash.
hash, final byte[]
The server challenge from the Type 2 message.
challenge, final byte[]
The client data (blob or client challenge).
clientData)

Creates the LMv2 Response from the given hash, client data, and Type 2 challenge.

private static byte[]
makeRandomChallenge(final Random random)

Calculate a challenge block

private static byte[]
makeSecondaryKey(final Random random)

Calculate a 16-byte secondary key

pack-priv static byte[]

Returns:

The NTLM2 Session Response. This is placed in the NTLM response field of the Type 3 message; the LM response field contains the client challenge, null-padded to 24 bytes.
ntlm2SessionResponse(final byte[] ntlmHash, final byte[] challenge, final byte[] clientChallenge)

Calculates the NTLM2 Session Response for the given challenge, using the specified password and client challenge.

private static byte[]

Returns:

The NTLM Hash of the given password, used in the calculation of the NTLM Response and the NTLMv2 and LMv2 Hashes.
ntlmHash(final char[]
The password.
password)

Creates the NTLM Hash of the user's password.

private static byte[]

Returns:

The NTLMv2 Hash, used in the calculation of the NTLMv2 and LMv2 Responses.
ntlmv2Hash(final String domain, final String user, final byte[] ntlmHash)

Creates the NTLMv2 Hash of the user's password.

private static void
oddParity(final byte[]
The data whose parity bits are to be adjusted for odd parity.
bytes)

Applies odd parity to the given byte array.

pack-priv static byte[]
RC4(final byte[] value, final byte[] key)

Calculates RC4

private static byte[]
readSecurityBuffer(final byte[] src, final int index)

private static int
readULong(final byte[] src, final int index)

private static int
readUShort(final byte[] src, final int index)

pack-priv static int
rotintlft(final int val, final int numbits)

pack-priv static void
writeULong(final byte[] buffer, final int value, final int offset)

pack-priv static void
writeUShort(final byte[] buffer, final int value, final int offset)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait