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