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 /* NTLMSSP negotiation flags */
  41 #define NTLMSSP_NEGOTIATE_UNICODE          0x00000001
  42 #define NTLMSSP_NEGOTIATE_OEM              0x00000002
  43 #define NTLMSSP_REQUEST_TARGET             0x00000004
  44 #define NTLMSSP_NEGOTIATE_SIGN             0x00000010 /* Message integrity */
  45 #define NTLMSSP_NEGOTIATE_SEAL             0x00000020 /* Message confidentiality */
  46 #define NTLMSSP_NEGOTIATE_DATAGRAM_STYLE   0x00000040
  47 #define NTLMSSP_NEGOTIATE_LM_KEY           0x00000080
  48 #define NTLMSSP_NEGOTIATE_NETWARE          0x00000100
  49 #define NTLMSSP_NEGOTIATE_NTLM             0x00000200
  50 #define NTLMSSP_NEGOTIATE_DOMAIN_SUPPLIED  0x00001000
  51 #define NTLMSSP_NEGOTIATE_WORKSTATION_SUPPLIED 0x00002000
  52 #define NTLMSSP_NEGOTIATE_THIS_IS_LOCAL_CALL  0x00004000
  53 #define NTLMSSP_NEGOTIATE_ALWAYS_SIGN      0x00008000
  54 #define NTLMSSP_TARGET_TYPE_DOMAIN            0x10000
  55 #define NTLMSSP_TARGET_TYPE_SERVER            0x20000
  56 #define NTLMSSP_CHAL_INIT_RESPONSE         0x00010000
  57
  58 #define NTLMSSP_CHAL_ACCEPT_RESPONSE       0x00020000
  59 #define NTLMSSP_CHAL_NON_NT_SESSION_KEY    0x00040000
  60 #define NTLMSSP_NEGOTIATE_NTLM2            0x00080000
  61 #define NTLMSSP_CHAL_TARGET_INFO           0x00800000
  62 #define NTLMSSP_NEGOTIATE_VERSION          0x02000000
  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_FEATURE_SESSION_KEY        0x00000001
  68 #define NTLMSSP_FEATURE_SIGN               0x00000002
  69 #define NTLMSSP_FEATURE_SEAL               0x00000004
  70
  71 #define NTLMSSP_NAME_TYPE_SERVER      0x01
  72 #define NTLMSSP_NAME_TYPE_DOMAIN      0x02
  73 #define NTLMSSP_NAME_TYPE_SERVER_DNS  0x03
  74 #define NTLMSSP_NAME_TYPE_DOMAIN_DNS  0x04
  75
  76 #define NTLMSSP_SIG_SIZE 16
  77
  78 typedef struct ntlmssp_state
  79 {
  80         unsigned int ref_count;
  81         enum NTLMSSP_ROLE role;
  82         enum server_types server_role;
  83         uint32 expected_state;
  84
  85         bool unicode;
  86         bool use_ntlmv2;
  87         char *user;
  88         char *domain;
  89         char *workstation;
  90         unsigned char *nt_hash;
  91         unsigned char *lm_hash;
  92         char *server_domain;
  93
  94         DATA_BLOB internal_chal; /* Random challenge as supplied to the client for NTLM authentication */
  95
  96         DATA_BLOB chal; /* Random challenge as input into the actual NTLM (or NTLM2) authentication */
  97         DATA_BLOB lm_resp;
  98         DATA_BLOB nt_resp;
  99         DATA_BLOB session_key;
 100
 101         uint32 neg_flags; /* the current state of negotiation with the NTLMSSP partner */
 102
 103         void *auth_context;
 104
 105         /**
 106          * Callback to get the 'challenge' used for NTLM authentication.
 107          *
 108          * @param ntlmssp_state This structure
 109          * @return 8 bytes of challnege data, determined by the server to be the challenge for NTLM authentication
 110          *
 111          */
 112         void (*get_challenge)(const struct ntlmssp_state *ntlmssp_state,
 113                               uint8_t challenge[8]);
 114
 115         /**
 116          * Callback to find if the challenge used by NTLM authentication may be modified
 117          *
 118          * The NTLM2 authentication scheme modifies the effective challenge, but this is not compatiable with the
 119          * current 'security=server' implementation..
 120          *
 121          * @param ntlmssp_state This structure
 122          * @return Can the challenge be set to arbitary values?
 123          *
 124          */
 125         bool (*may_set_challenge)(const struct ntlmssp_state *ntlmssp_state);
 126
 127         /**
 128          * Callback to set the 'challenge' used for NTLM authentication.
 129          *
 130          * The callback may use the void *auth_context to store state information, but the same value is always available
 131          * from the DATA_BLOB chal on this structure.
 132          *
 133          * @param ntlmssp_state This structure
 134          * @param challenge 8 bytes of data, agreed by the client and server to be the effective challenge for NTLM2 authentication
 135          *
 136          */
 137         NTSTATUS (*set_challenge)(struct ntlmssp_state *ntlmssp_state, DATA_BLOB *challenge);
 138
 139         /**
 140          * Callback to check the user's password.
 141          *
 142          * The callback must reads the feilds of this structure for the information it needs on the user
 143          * @param ntlmssp_state This structure
 144          * @param nt_session_key If an NT session key is returned by the authentication process, return it here
 145          * @param lm_session_key If an LM session key is returned by the authentication process, return it here
 146          *
 147          */
 148         NTSTATUS (*check_password)(struct ntlmssp_state *ntlmssp_state, DATA_BLOB *nt_session_key, DATA_BLOB *lm_session_key);
 149
 150         const char *(*get_global_myname)(void);
 151         const char *(*get_domain)(void);
 152
 153         /* ntlmv2 */
 154
 155         unsigned char send_sign_key[16];
 156         unsigned char send_seal_key[16];
 157         unsigned char recv_sign_key[16];
 158         unsigned char recv_seal_key[16];
 159
 160         struct arcfour_state send_seal_arc4_state;
 161         struct arcfour_state recv_seal_arc4_state;
 162
 163         uint32 ntlm2_send_seq_num;
 164         uint32 ntlm2_recv_seq_num;
 165
 166         /* ntlmv1 */
 167         struct arcfour_state ntlmv1_arc4_state;
 168         uint32 ntlmv1_seq_num;
 169
 170         /* it turns out that we don't always get the
 171            response in at the time we want to process it.
 172            Store it here, until we need it */
 173         DATA_BLOB stored_response;
 174 } NTLMSSP_STATE;