keyhole logo

Functions

Heimdal NTLM library

Functions

void heim_ntlm_free_buf (struct ntlm_buf *p)
void heim_ntlm_free_targetinfo (struct ntlm_targetinfo *ti)
int heim_ntlm_encode_targetinfo (const struct ntlm_targetinfo *ti, int ucs2, struct ntlm_buf *data)
int heim_ntlm_decode_targetinfo (const struct ntlm_buf *data, int ucs2, struct ntlm_targetinfo *ti)
void heim_ntlm_free_type1 (struct ntlm_type1 *data)
int heim_ntlm_encode_type1 (const struct ntlm_type1 *type1, struct ntlm_buf *data)
void heim_ntlm_free_type2 (struct ntlm_type2 *data)
int heim_ntlm_encode_type2 (const struct ntlm_type2 *type2, struct ntlm_buf *data)
void heim_ntlm_free_type3 (struct ntlm_type3 *data)
int heim_ntlm_encode_type3 (const struct ntlm_type3 *type3, struct ntlm_buf *data)
int heim_ntlm_nt_key (const char *password, struct ntlm_buf *key)
int heim_ntlm_calculate_ntlm1 (void *key, size_t len, unsigned char challenge[8], struct ntlm_buf *answer)
int heim_ntlm_build_ntlm1_master (void *key, size_t len, struct ntlm_buf *session, struct ntlm_buf *master)
int heim_ntlm_build_ntlm2_master (void *key, size_t len, struct ntlm_buf *blob, struct ntlm_buf *session, struct ntlm_buf *master)
int heim_ntlm_keyex_unwrap (struct ntlm_buf *baseKey, struct ntlm_buf *encryptedSession, struct ntlm_buf *session)
int heim_ntlm_ntlmv2_key (const void *key, size_t len, const char *username, const char *target, unsigned char ntlmv2[16])
int heim_ntlm_calculate_lm2 (const void *key, size_t len, const char *username, const char *target, const unsigned char serverchallenge[8], unsigned char ntlmv2[16], struct ntlm_buf *answer)
int heim_ntlm_calculate_ntlm2 (const void *key, size_t len, const char *username, const char *target, const unsigned char serverchallenge[8], const struct ntlm_buf *infotarget, unsigned char ntlmv2[16], struct ntlm_buf *answer)
int heim_ntlm_verify_ntlm2 (const void *key, size_t len, const char *username, const char *target, time_t now, const unsigned char serverchallenge[8], const struct ntlm_buf *answer, struct ntlm_buf *infotarget, unsigned char ntlmv2[16])

Detailed Description

The NTLM core functions implement the string2key generation function, message encode and decode function, and the hash function functions.


Function Documentation

int heim_ntlm_build_ntlm1_master ( void *  key,
size_t  len,
struct ntlm_buf session,
struct ntlm_buf master 
)

Generates an NTLMv1 session random with assosited session master key.

Parameters:
keythe ntlm v1 key
lenlength of key
sessiongenerated session nonce, should be freed with heim_ntlm_free_buf().
mastercalculated session master key, should be freed with heim_ntlm_free_buf().
Returns:
In case of success 0 is return, an errors, a errno in what went wrong.
int heim_ntlm_build_ntlm2_master ( void *  key,
size_t  len,
struct ntlm_buf blob,
struct ntlm_buf session,
struct ntlm_buf master 
)

Generates an NTLMv2 session random with associated session master key.

Parameters:
keythe NTLMv2 key
lenlength of key
blobthe NTLMv2 "blob"
sessiongenerated session nonce, should be freed with heim_ntlm_free_buf().
mastercalculated session master key, should be freed with heim_ntlm_free_buf().
Returns:
In case of success 0 is return, an errors, a errno in what went wrong.
int heim_ntlm_calculate_lm2 ( const void *  key,
size_t  len,
const char *  username,
const char *  target,
const unsigned char  serverchallenge[8],
unsigned char  ntlmv2[16],
struct ntlm_buf answer 
)

Calculate LMv2 response

Parameters:
keythe ntlm key
lenlength of key
usernamename of the user, as sent in the message, assumed to be in UTF8.
targetthe name of the target, assumed to be in UTF8.
serverchallengechallenge as sent by the server in the type2 message.
ntlmv2calculated session key
answerntlm response answer, should be freed with heim_ntlm_free_buf().
Returns:
In case of success 0 is return, an errors, a errno in what went wrong.
int heim_ntlm_calculate_ntlm1 ( void *  key,
size_t  len,
unsigned char  challenge[8],
struct ntlm_buf answer 
)

Calculate NTLMv1 response hash

Parameters:
keythe ntlm v1 key
lenlength of key
challengesent by the server
answercalculated answer, should be freed with heim_ntlm_free_buf().
Returns:
In case of success 0 is return, an errors, a errno in what went wrong.
Examples:
test_ntlm.c.
int heim_ntlm_calculate_ntlm2 ( const void *  key,
size_t  len,
const char *  username,
const char *  target,
const unsigned char  serverchallenge[8],
const struct ntlm_buf infotarget,
unsigned char  ntlmv2[16],
struct ntlm_buf answer 
)

Calculate NTLMv2 response

Parameters:
keythe ntlm key
lenlength of key
usernamename of the user, as sent in the message, assumed to be in UTF8.
targetthe name of the target, assumed to be in UTF8.
serverchallengechallenge as sent by the server in the type2 message.
infotargetinfotarget as sent by the server in the type2 message.
ntlmv2calculated session key
answerntlm response answer, should be freed with heim_ntlm_free_buf().
Returns:
In case of success 0 is return, an errors, a errno in what went wrong.
Examples:
test_ntlm.c.
int heim_ntlm_decode_targetinfo ( const struct ntlm_buf data,
int  ucs2,
struct ntlm_targetinfo *  ti 
)

Decodes an NTLM targetinfo message

Parameters:
datainput data buffer with the encode NTLM targetinfo message
ucs2if the strings should be encoded with ucs2 (selected by flag in message).
tithe decoded target info, should be freed with heim_ntlm_free_targetinfo().
Returns:
In case of success 0 is return, an errors, a errno in what went wrong.
Examples:
test_ntlm.c.
int heim_ntlm_encode_targetinfo ( const struct ntlm_targetinfo *  ti,
int  ucs2,
struct ntlm_buf data 
)

Encodes a ntlm_targetinfo message.

Parameters:
tithe ntlm_targetinfo message to encode.
ucs2ignored
datais the return buffer with the encoded message, should be freed with heim_ntlm_free_buf().
Returns:
In case of success 0 is return, an errors, a errno in what went wrong.
Examples:
test_ntlm.c.
int heim_ntlm_encode_type1 ( const struct ntlm_type1 type1,
struct ntlm_buf data 
)

Encodes an ntlm_type1 message.

Parameters:
type1the ntlm_type1 message to encode.
datais the return buffer with the encoded message, should be freed with heim_ntlm_free_buf().
Returns:
In case of success 0 is return, an errors, a errno in what went wrong.
Examples:
test_ntlm.c.
int heim_ntlm_encode_type2 ( const struct ntlm_type2 type2,
struct ntlm_buf data 
)

Encodes an ntlm_type2 message.

Parameters:
type2the ntlm_type2 message to encode.
datais the return buffer with the encoded message, should be freed with heim_ntlm_free_buf().
Returns:
In case of success 0 is return, an errors, a errno in what went wrong.
Examples:
test_ntlm.c.
int heim_ntlm_encode_type3 ( const struct ntlm_type3 type3,
struct ntlm_buf data 
)

Encodes an ntlm_type3 message.

Parameters:
type3the ntlm_type3 message to encode.
datais the return buffer with the encoded message, should be freed with heim_ntlm_free_buf().
Returns:
In case of success 0 is return, an errors, a errno in what went wrong.
Examples:
test_ntlm.c.
void heim_ntlm_free_buf ( struct ntlm_buf p )

heim_ntlm_free_buf frees the ntlm buffer

Parameters:
pbuffer to be freed
void heim_ntlm_free_targetinfo ( struct ntlm_targetinfo *  ti )

Frees the ntlm_targetinfo message

Parameters:
titargetinfo to be freed
Examples:
test_ntlm.c.
void heim_ntlm_free_type1 ( struct ntlm_type1 data )

Frees the ntlm_type1 message

Parameters:
datamessage to be freed
Examples:
test_ntlm.c.
void heim_ntlm_free_type2 ( struct ntlm_type2 data )

Frees the ntlm_type2 message

Parameters:
datamessage to be freed
Examples:
test_ntlm.c.
void heim_ntlm_free_type3 ( struct ntlm_type3 data )

Frees the ntlm_type3 message

Parameters:
datamessage to be freed
Examples:
test_ntlm.c.
int heim_ntlm_keyex_unwrap ( struct ntlm_buf baseKey,
struct ntlm_buf encryptedSession,
struct ntlm_buf session 
)

Given a key and encrypted session, unwrap the session key

Parameters:
baseKeythe sessionBaseKey
encryptedSessionencrypted session, type3.session field.
sessiongenerated session nonce, should be freed with heim_ntlm_free_buf().
Returns:
In case of success 0 is return, an errors, a errno in what went wrong.
int heim_ntlm_nt_key ( const char *  password,
struct ntlm_buf key 
)

Calculate the NTLM key, the password is assumed to be in UTF8.

Parameters:
passwordpassword to calcute the key for.
keycalcuted key, should be freed with heim_ntlm_free_buf().
Returns:
In case of success 0 is return, an errors, a errno in what went wrong.
Examples:
test_ntlm.c.
int heim_ntlm_ntlmv2_key ( const void *  key,
size_t  len,
const char *  username,
const char *  target,
unsigned char  ntlmv2[16] 
)

Generates an NTLMv2 session key.

Parameters:
keythe ntlm key
lenlength of key
usernamename of the user, as sent in the message, assumed to be in UTF8.
targetthe name of the target, assumed to be in UTF8.
ntlmv2the ntlmv2 session key
Returns:
0 on success, or an error code on failure.
int heim_ntlm_verify_ntlm2 ( const void *  key,
size_t  len,
const char *  username,
const char *  target,
time_t  now,
const unsigned char  serverchallenge[8],
const struct ntlm_buf answer,
struct ntlm_buf infotarget,
unsigned char  ntlmv2[16] 
)

Verify NTLMv2 response.

Parameters:
keythe ntlm key
lenlength of key
usernamename of the user, as sent in the message, assumed to be in UTF8.
targetthe name of the target, assumed to be in UTF8.
nowthe time now (0 if the library should pick it up itself)
serverchallengechallenge as sent by the server in the type2 message.
answerntlm response answer, should be freed with heim_ntlm_free_buf().
infotargetinfotarget as sent by the server in the type2 message.
ntlmv2calculated session key
Returns:
In case of success 0 is return, an errors, a errno in what went wrong.
Examples:
test_ntlm.c.

Generated on Fri Dec 6 2013 08:13:08 for Heimdalntlmlibrary by doxygen 1.7.2