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