/* Editor Settings: expandtabs and use 4 spaces for indentation
 * ex: set softtabstop=4 tabstop=8 expandtab shiftwidth=4: *
 * -*- mode: c, c-basic-offset: 4 -*- */

/*
 * Copyright Likewise Software    2004-2008
 * All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the license, or (at
 * your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser
 * General Public License for more details.  You should have received a copy
 * of the GNU Lesser General Public License along with this program.  If
 * not, see <http://www.gnu.org/licenses/>.
 *
 * LIKEWISE SOFTWARE MAKES THIS SOFTWARE AVAILABLE UNDER OTHER LICENSING
 * TERMS AS WELL.  IF YOU HAVE ENTERED INTO A SEPARATE LICENSE AGREEMENT
 * WITH LIKEWISE SOFTWARE, THEN YOU MAY ELECT TO USE THE SOFTWARE UNDER THE
 * TERMS OF THAT SOFTWARE LICENSE AGREEMENT INSTEAD OF THE TERMS OF THE GNU
 * LESSER GENERAL PUBLIC LICENSE, NOTWITHSTANDING THE ABOVE NOTICE.  IF YOU
 * HAVE QUESTIONS, OR WISH TO REQUEST A COPY OF THE ALTERNATE LICENSING
 * TERMS OFFERED BY LIKEWISE SOFTWARE, PLEASE CONTACT LIKEWISE SOFTWARE AT
 * license@likewisesoftware.com
 */

/*
 * Copyright (C) Likewise Software. All rights reserved.
 *
 * Module Name:
 *
 *        structs.h
 *
 * Abstract:
 *
 *
 * Authors: Marc Guy (mguy@likewisesoftware.com)
 *
 */

#ifndef __STRUCTS_H__
#define __STRUCTS_H__

typedef struct _NTLM_OS_VERSION
{
    BYTE MajorVersion;
    BYTE MinorVersion;
    WORD BuildNumber;
    DWORD Unknown; // Must be 0x0000000F
} NTLM_OS_VERSION, *PNTLM_OS_VERSION;

typedef struct _NTLM_NEGOTIATE_MESSAGE_V1
{
    UCHAR NtlmSignature[NTLM_NETWORK_SIGNATURE_SIZE];
    DWORD MessageType;
    DWORD NtlmFlags;
} NTLM_NEGOTIATE_MESSAGE_V1, *PNTLM_NEGOTIATE_MESSAGE_V1;

typedef struct _NTLM_NEGOTIATE_MESSAGE_V2
{
    union
    {
        NTLM_NEGOTIATE_MESSAGE_V1 V1;
        struct
        {
            UCHAR NtlmSignature[NTLM_NETWORK_SIGNATURE_SIZE];
            DWORD MessageType;
            DWORD NtlmFlags;
        };
    };
    // These refer to the machine the client is using, not the account they
    // want to authenticate with.
    NTLM_SEC_BUFFER ClientDomain;
    NTLM_SEC_BUFFER ClientWorkstation;
} NTLM_NEGOTIATE_MESSAGE_V2, *PNTLM_NEGOTIATE_MESSAGE_V2;

typedef struct _NTLM_NEGOTIATE_MESSAGE_V3
{
    union
    {
        NTLM_NEGOTIATE_MESSAGE_V2 V2;
        struct
        {
            union
            {
                NTLM_NEGOTIATE_MESSAGE_V1 V1;
                struct
                {
                    UCHAR NtlmSignature[NTLM_NETWORK_SIGNATURE_SIZE];
                    DWORD MessageType;
                    DWORD NtlmFlags;
                };
            };
            // These refer to the machine the client is using, not the account
            // they want to authenticate with.
            NTLM_SEC_BUFFER ClientDomain;
            NTLM_SEC_BUFFER ClientWorkstation;
        };
    };
    NTLM_OS_VERSION Version;
    // Optional Data
} NTLM_NEGOTIATE_MESSAGE_V3, *PNTLM_NEGOTIATE_MESSAGE_V3;

typedef struct _NTLM_CHALLENGE_MESSAGE
{
    UCHAR NtlmSignature[NTLM_NETWORK_SIGNATURE_SIZE];
    DWORD MessageType;
    NTLM_SEC_BUFFER Target;
    DWORD NtlmFlags;
    UCHAR Challenge[NTLM_CHALLENGE_SIZE];
    // Optional Context 8 bytes
    // Optional Target Information NTLM_SEC_BUFFER
    // Optional OS Version 8 bytes
    // Optional Data
} NTLM_CHALLENGE_MESSAGE, *PNTLM_CHALLENGE_MESSAGE;

typedef struct _NTLM_RESPONSE_MESSAGE_V1
{
    UCHAR NtlmSignature[NTLM_NETWORK_SIGNATURE_SIZE];
    DWORD MessageType;
    NTLM_SEC_BUFFER LmResponse;
    NTLM_SEC_BUFFER NtResponse;
    NTLM_SEC_BUFFER AuthTargetName;
    NTLM_SEC_BUFFER UserName;
    NTLM_SEC_BUFFER Workstation;
    // Optional Data
} NTLM_RESPONSE_MESSAGE_V1, *PNTLM_RESPONSE_MESSAGE_V1;

typedef struct _NTLM_RESPONSE_MESSAGE_V2
{
    union
    {
        NTLM_RESPONSE_MESSAGE_V1 V1;
        struct
        {
            UCHAR NtlmSignature[NTLM_NETWORK_SIGNATURE_SIZE];
            DWORD MessageType;
            NTLM_SEC_BUFFER LmResponse;
            NTLM_SEC_BUFFER NtResponse;
            NTLM_SEC_BUFFER AuthTargetName;
            NTLM_SEC_BUFFER UserName;
            NTLM_SEC_BUFFER Workstation;
        };
    };
    NTLM_SEC_BUFFER SessionKey;
    DWORD Flags;
    // Optional Data
} NTLM_RESPONSE_MESSAGE_V2, *PNTLM_RESPONSE_MESSAGE_V2;

typedef struct _NTLM_RESPONSE_MESSAGE_V3
{
    union
    {
        NTLM_RESPONSE_MESSAGE_V2 V2;
        struct
        {
            union
            {
                NTLM_RESPONSE_MESSAGE_V1 V1;
                struct
                {
                    UCHAR NtlmSignature[NTLM_NETWORK_SIGNATURE_SIZE];
                    DWORD MessageType;
                    NTLM_SEC_BUFFER LmResponse;
                    NTLM_SEC_BUFFER NtResponse;
                    NTLM_SEC_BUFFER AuthTargetName;
                    NTLM_SEC_BUFFER UserName;
                    NTLM_SEC_BUFFER Workstation;
                };
            };
            NTLM_SEC_BUFFER SessionKey;
            DWORD Flags;
        };
    };
    NTLM_OS_VERSION Version;
    // Optional Data
} NTLM_RESPONSE_MESSAGE_V3, *PNTLM_RESPONSE_MESSAGE_V3;

typedef struct _NTLM_BLOB
{
    BYTE NtlmBlobSignature[4];
    DWORD Reserved1;
    ULONG64 TimeStamp;
    ULONG64 ClientNonce;
    DWORD Reserved2;
    // Target information block
    // DWORD Reserved3
} NTLM_BLOB, *PNTLM_BLOB;

typedef struct _NTLM_TARGET_INFO_BLOCK
{
    SHORT sType;
    SHORT sLength;
    //BYTE  Contents[0];
} NTLM_TARGET_INFO_BLOCK, *PNTLM_TARGET_INFO_BLOCK;

typedef enum
{
    NtlmStateBlank,
    NtlmStateNegotiate,
    NtlmStateChallenge,
    NtlmStateResponse
} NTLM_STATE, *PNTLM_STATE;

typedef struct _NTLM_CONTEXT
{
    NTLM_STATE NtlmState;
    BYTE Challenge[NTLM_CHALLENGE_SIZE];
    PSTR pszClientUsername;
    NTLM_CRED_HANDLE CredHandle;
    DWORD NegotiatedFlags;
    LONG nRefCount;
    BYTE SessionKey[NTLM_SESSION_KEY_SIZE];
    DWORD cbSessionKeyLen;
    PLSA_AUTH_USER_INFO pUserInfo;
    // Set to true if this context was generated through
    // InitializeSecurityContext.
    BOOLEAN bInitiatedSide;

    // These keys are only used with NTLM2 session security. They are ignored
    // with NTLM1 session security.
    BYTE SignKey[MD5_DIGEST_LENGTH];
    BYTE VerifyKey[MD5_DIGEST_LENGTH];

    // With NTLM1 session security, these keys will all point to the same
    // address. With NTLM2 session security, both keys will be unique.
    RC4_KEY* pSealKey;
    RC4_KEY* pUnsealKey;

    // With NTLM1 session security, these sequences numbers will all point to
    // the same address. With NTLM2 session security, the sequence numbers are
    // unique.
    DWORD *pdwSendMsgSeq;
    DWORD *pdwRecvMsgSeq;
} NTLM_CONTEXT, *PNTLM_CONTEXT;

typedef struct _NTLM_CREDENTIALS
{
    LSA_CRED_HANDLE CredHandle;
    DWORD dwCredDirection;
    LONG nRefCount;
} NTLM_CREDENTIALS, *PNTLM_CREDENTIALS;

typedef struct _NTLM_CONFIG
{
    BOOLEAN bSendNTLMv2;
    BOOLEAN bSupport56bit;
    BOOLEAN bSupport128bit;
    BOOLEAN bSupportUnicode;
    BOOLEAN bSupportNTLM2SessionSecurity;
    BOOLEAN bSupportKeyExchange;
} NTLM_CONFIG, *PNTLM_CONFIG;

#endif /* __STRUCTS_H__ */