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