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