source3/include/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 3 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, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22 /* NTLMSSP mode */
  23 enum NTLMSSP_ROLE
  24 {
  25         NTLMSSP_SERVER,
  26         NTLMSSP_CLIENT
  27 };
  28
  29 /* NTLMSSP message types */
  30 enum NTLM_MESSAGE_TYPE
  31 {
  32         NTLMSSP_INITIAL = 0 /* samba internal state */,
  33         NTLMSSP_NEGOTIATE = 1,
  34         NTLMSSP_CHALLENGE = 2,
  35         NTLMSSP_AUTH      = 3,
  36         NTLMSSP_UNKNOWN   = 4,
  37         NTLMSSP_DONE      = 5 /* samba final state */
  38 };
  39
  40 #define NTLMSSP_FEATURE_SESSION_KEY        0x00000001
  41 #define NTLMSSP_FEATURE_SIGN               0x00000002
  42 #define NTLMSSP_FEATURE_SEAL               0x00000004
  43
  44 typedef struct ntlmssp_state
  45 {
  46         unsigned int ref_count;
  47         enum NTLMSSP_ROLE role;
  48         enum server_types server_role;
  49         uint32 expected_state;
  50
  51         bool unicode;
  52         bool use_ntlmv2;
  53         char *user;
  54         char *domain;
  55         char *workstation;
  56         unsigned char *nt_hash;
  57         unsigned char *lm_hash;
  58         char *server_domain;
  59
  60         DATA_BLOB internal_chal; /* Random challenge as supplied to the client for NTLM authentication */
  61
  62         DATA_BLOB chal; /* Random challenge as input into the actual NTLM (or NTLM2) authentication */
  63         DATA_BLOB lm_resp;
  64         DATA_BLOB nt_resp;
  65         DATA_BLOB session_key;
  66
  67         uint32 neg_flags; /* the current state of negotiation with the NTLMSSP partner */
  68
  69         void *auth_context;
  70
  71         /**
  72          * Callback to get the 'challenge' used for NTLM authentication.
  73          *
  74          * @param ntlmssp_state This structure
  75          * @return 8 bytes of challnege data, determined by the server to be the challenge for NTLM authentication
  76          *
  77          */
  78         void (*get_challenge)(const struct ntlmssp_state *ntlmssp_state,
  79                               uint8_t challenge[8]);
  80
  81         /**
  82          * Callback to find if the challenge used by NTLM authentication may be modified
  83          *
  84          * The NTLM2 authentication scheme modifies the effective challenge, but this is not compatiable with the
  85          * current 'security=server' implementation..
  86          *
  87          * @param ntlmssp_state This structure
  88          * @return Can the challenge be set to arbitary values?
  89          *
  90          */
  91         bool (*may_set_challenge)(const struct ntlmssp_state *ntlmssp_state);
  92
  93         /**
  94          * Callback to set the 'challenge' used for NTLM authentication.
  95          *
  96          * The callback may use the void *auth_context to store state information, but the same value is always available
  97          * from the DATA_BLOB chal on this structure.
  98          *
  99          * @param ntlmssp_state This structure
 100          * @param challenge 8 bytes of data, agreed by the client and server to be the effective challenge for NTLM2 authentication
 101          *
 102          */
 103         NTSTATUS (*set_challenge)(struct ntlmssp_state *ntlmssp_state, DATA_BLOB *challenge);
 104
 105         /**
 106          * Callback to check the user's password.
 107          *
 108          * The callback must reads the feilds of this structure for the information it needs on the user
 109          * @param ntlmssp_state This structure
 110          * @param nt_session_key If an NT session key is returned by the authentication process, return it here
 111          * @param lm_session_key If an LM session key is returned by the authentication process, return it here
 112          *
 113          */
 114         NTSTATUS (*check_password)(struct ntlmssp_state *ntlmssp_state, DATA_BLOB *nt_session_key, DATA_BLOB *lm_session_key);
 115
 116         const char *(*get_global_myname)(void);
 117         const char *(*get_domain)(void);
 118
 119         /* ntlmv2 */
 120
 121         unsigned char send_sign_key[16];
 122         unsigned char send_seal_key[16];
 123         unsigned char recv_sign_key[16];
 124         unsigned char recv_seal_key[16];
 125
 126         struct arcfour_state send_seal_arc4_state;
 127         struct arcfour_state recv_seal_arc4_state;
 128
 129         uint32 ntlm2_send_seq_num;
 130         uint32 ntlm2_recv_seq_num;
 131
 132         /* ntlmv1 */
 133         struct arcfour_state ntlmv1_arc4_state;
 134         uint32 ntlmv1_seq_num;
 135
 136         /* it turns out that we don't always get the
 137            response in at the time we want to process it.
 138            Store it here, until we need it */
 139         DATA_BLOB stored_response;
 140 } NTLMSSP_STATE;