source4/libcli/auth/ntlmssp.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3    SMB parameters and setup
   4    Copyright (C) Andrew Tridgell 1992-1997
   5    Copyright (C) Luke Kenneth Casson Leighton 1996-1997
   6    Copyright (C) Paul Ashton 1997
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 2 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program; if not, write to the Free Software
  20    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21 */
  22
  23 /* NTLMSSP mode */
  24 enum NTLMSSP_ROLE
  25 {
  26         NTLMSSP_SERVER,
  27         NTLMSSP_CLIENT
  28 };
  29
  30 /* NTLMSSP message types */
  31 enum NTLM_MESSAGE_TYPE
  32 {
  33         NTLMSSP_INITIAL = 0 /* samba internal state */,
  34         NTLMSSP_NEGOTIATE = 1,
  35         NTLMSSP_CHALLENGE = 2,
  36         NTLMSSP_AUTH      = 3,
  37         NTLMSSP_UNKNOWN   = 4,
  38         NTLMSSP_DONE   = 5 /* samba final state */
  39 };
  40
  41 /* NTLMSSP negotiation flags */
  42 #define NTLMSSP_NEGOTIATE_UNICODE          0x00000001
  43 #define NTLMSSP_NEGOTIATE_OEM              0x00000002
  44 #define NTLMSSP_REQUEST_TARGET             0x00000004
  45 #define NTLMSSP_NEGOTIATE_SIGN             0x00000010 /* Message integrity */
  46 #define NTLMSSP_NEGOTIATE_SEAL             0x00000020 /* Message confidentiality */
  47 #define NTLMSSP_NEGOTIATE_DATAGRAM_STYLE   0x00000040
  48 #define NTLMSSP_NEGOTIATE_LM_KEY           0x00000080
  49 #define NTLMSSP_NEGOTIATE_NETWARE          0x00000100
  50 #define NTLMSSP_NEGOTIATE_NTLM             0x00000200
  51 #define NTLMSSP_NEGOTIATE_DOMAIN_SUPPLIED  0x00001000
  52 #define NTLMSSP_NEGOTIATE_WORKSTATION_SUPPLIED 0x00002000
  53 #define NTLMSSP_NEGOTIATE_THIS_IS_LOCAL_CALL  0x00004000
  54 #define NTLMSSP_NEGOTIATE_ALWAYS_SIGN      0x00008000
  55 #define NTLMSSP_TARGET_TYPE_DOMAIN            0x10000
  56 #define NTLMSSP_TARGET_TYPE_SERVER            0x20000
  57 #define NTLMSSP_CHAL_INIT_RESPONSE         0x00010000
  58
  59 #define NTLMSSP_CHAL_ACCEPT_RESPONSE       0x00020000
  60 #define NTLMSSP_CHAL_NON_NT_SESSION_KEY    0x00040000
  61 #define NTLMSSP_NEGOTIATE_NTLM2            0x00080000
  62 #define NTLMSSP_CHAL_TARGET_INFO           0x00800000
  63 #define NTLMSSP_NEGOTIATE_128              0x20000000 /* 128-bit encryption */
  64 #define NTLMSSP_NEGOTIATE_KEY_EXCH         0x40000000
  65 #define NTLMSSP_NEGOTIATE_56               0x80000000
  66
  67 #define NTLMSSP_NAME_TYPE_SERVER      0x01
  68 #define NTLMSSP_NAME_TYPE_DOMAIN      0x02
  69 #define NTLMSSP_NAME_TYPE_SERVER_DNS  0x03
  70 #define NTLMSSP_NAME_TYPE_DOMAIN_DNS  0x04
  71
  72 #define NTLMSSP_SIGN_VERSION 1
  73
  74 typedef struct ntlmssp_state
  75 {
  76         TALLOC_CTX *mem_ctx;
  77         unsigned int ref_count;
  78         enum NTLMSSP_ROLE role;
  79         enum server_types server_role;
  80         uint32_t expected_state;
  81
  82         BOOL unicode;
  83         BOOL use_ntlmv2;
  84         BOOL use_nt_response;  /* Set to 'False' to debug what happens when the NT response is omited */
  85         BOOL allow_lm_key;     /* The LM_KEY code is not functional at this point, and it's not
  86                                   very secure anyway */
  87
  88         BOOL server_use_session_keys; /* Set to 'False' for authentication only,
  89                                          that will never return a session key */
  90         BOOL server_multiple_authentications;  /* Set to 'True' to allow squid 2.5
  91                                                   style 'challenge caching' */
  92
  93         char *user;
  94         char *domain;
  95         char *workstation;
  96         char *password;
  97         char *server_domain;
  98
  99         DATA_BLOB internal_chal; /* Random challenge as supplied to the client for NTLM authentication */
 100
 101         DATA_BLOB chal; /* Random challenge as input into the actual NTLM (or NTLM2) authentication */
 102         DATA_BLOB lm_resp;
 103         DATA_BLOB nt_resp;
 104         DATA_BLOB session_key;
 105
 106         uint32_t neg_flags; /* the current state of negotiation with the NTLMSSP partner */
 107
 108         /* internal variables used by NTLM2 */
 109         BOOL doing_ntlm2;
 110         uchar session_nonce[16];
 111
 112         /* internal variables used by KEY_EXCH (client-supplied user session key */
 113         DATA_BLOB encrypted_session_key;
 114
 115         void *auth_context;
 116
 117         /**
 118          * Callback to get the 'challenge' used for NTLM authentication.
 119          *
 120          * @param ntlmssp_state This structure
 121          * @return 8 bytes of challnege data, determined by the server to be the challenge for NTLM authentication
 122          *
 123          */
 124         const uint8 *(*get_challenge)(const struct ntlmssp_state *ntlmssp_state);
 125
 126         /**
 127          * Callback to find if the challenge used by NTLM authentication may be modified
 128          *
 129          * The NTLM2 authentication scheme modifies the effective challenge, but this is not compatiable with the
 130          * current 'security=server' implementation..
 131          *
 132          * @param ntlmssp_state This structure
 133          * @return Can the challenge be set to arbitary values?
 134          *
 135          */
 136         BOOL (*may_set_challenge)(const struct ntlmssp_state *ntlmssp_state);
 137
 138         /**
 139          * Callback to set the 'challenge' used for NTLM authentication.
 140          *
 141          * The callback may use the void *auth_context to store state information, but the same value is always available
 142          * from the DATA_BLOB chal on this structure.
 143          *
 144          * @param ntlmssp_state This structure
 145          * @param challange 8 bytes of data, agreed by the client and server to be the effective challenge for NTLM2 authentication
 146          *
 147          */
 148         NTSTATUS (*set_challenge)(struct ntlmssp_state *ntlmssp_state, DATA_BLOB *challenge);
 149
 150         /**
 151          * Callback to check the user's password.
 152          *
 153          * The callback must reads the feilds of this structure for the information it needs on the user
 154          * @param ntlmssp_state This structure
 155          * @param nt_session_key If an NT session key is returned by the authentication process, return it here
 156          * @param lm_session_key If an LM session key is returned by the authentication process, return it here
 157          *
 158          */
 159         NTSTATUS (*check_password)(struct ntlmssp_state *ntlmssp_state, DATA_BLOB *nt_session_key, DATA_BLOB *lm_session_key);
 160
 161         const char *(*get_global_myname)(void);
 162         const char *(*get_domain)(void);
 163
 164         /* SMB Signing */
 165
 166         uint32_t ntlmssp_seq_num;
 167
 168         /* ntlmv2 */
 169         char send_sign_key[16];
 170         char send_seal_key[16];
 171         char recv_sign_key[16];
 172         char recv_seal_key[16];
 173
 174         unsigned char send_sign_hash[258];
 175         unsigned char send_seal_hash[258];
 176         unsigned char recv_sign_hash[258];
 177         unsigned char recv_seal_hash[258];
 178
 179         /* ntlmv1 */
 180         unsigned char ntlmssp_hash[258];
 181
 182         /* it turns out that we don't always get the
 183            response in at the time we want to process it.
 184            Store it here, until we need it */
 185         DATA_BLOB stored_response;
 186
 187 } NTLMSSP_STATE;
 188