source4/auth/ntlmssp/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 #include "librpc/gen_ndr/samr.h"
  23 #include "../librpc/gen_ndr/ntlmssp.h"
  24
  25 /* NTLMSSP mode */
  26 enum ntlmssp_role
  27 {
  28         NTLMSSP_SERVER,
  29         NTLMSSP_CLIENT
  30 };
  31
  32 /* NTLMSSP message types */
  33 enum ntlmssp_message_type
  34 {
  35         NTLMSSP_INITIAL = 0 /* samba internal state */,
  36         NTLMSSP_NEGOTIATE = 1,
  37         NTLMSSP_CHALLENGE = 2,
  38         NTLMSSP_AUTH      = 3,
  39         NTLMSSP_UNKNOWN   = 4,
  40         NTLMSSP_DONE      = 5 /* samba final state */
  41 };
  42
  43 struct gensec_ntlmssp_state
  44 {
  45         enum ntlmssp_role role;
  46         enum samr_Role server_role;
  47         uint32_t expected_state;
  48
  49         bool unicode;
  50         bool use_ntlmv2;
  51         bool use_nt_response;  /* Set to 'False' to debug what happens when the NT response is omited */
  52         bool allow_lm_key;     /* The LM_KEY code is not functional at this point, and it's not
  53                                   very secure anyway */
  54
  55         bool server_multiple_authentications;  /* Set to 'True' to allow squid 2.5
  56                                                   style 'challenge caching' */
  57
  58         char *user;
  59         const char *domain;
  60         const char *workstation;
  61         char *server_domain;
  62
  63         DATA_BLOB internal_chal; /* Random challenge as supplied to the client for NTLM authentication */
  64
  65         DATA_BLOB chal; /* Random challenge as input into the actual NTLM (or NTLM2) authentication */
  66         DATA_BLOB lm_resp;
  67         DATA_BLOB nt_resp;
  68         DATA_BLOB session_key;
  69
  70         uint32_t neg_flags; /* the current state of negotiation with the NTLMSSP partner */
  71
  72         /* internal variables used by KEY_EXCH (client-supplied user session key */
  73         DATA_BLOB encrypted_session_key;
  74
  75         /**
  76          * Private data for the callback functions
  77          */
  78         void *callback_private;
  79
  80         /**
  81          * Callback to get the 'challenge' used for NTLM authentication.
  82          *
  83          * @param ntlmssp_state This structure
  84          * @return 8 bytes of challenge data, determined by the server to be the challenge for NTLM authentication
  85          *
  86          */
  87         NTSTATUS (*get_challenge)(const struct gensec_ntlmssp_state *,
  88                                   uint8_t challenge[8]);
  89
  90         /**
  91          * Callback to find if the challenge used by NTLM authentication may be modified
  92          *
  93          * The NTLM2 authentication scheme modifies the effective challenge, but this is not compatiable with the
  94          * current 'security=server' implementation..
  95          *
  96          * @param ntlmssp_state This structure
  97          * @return Can the challenge be set to arbitary values?
  98          *
  99          */
 100         bool (*may_set_challenge)(const struct gensec_ntlmssp_state *);
 101
 102         /**
 103          * Callback to set the 'challenge' used for NTLM authentication.
 104          *
 105          * The callback may use the void *auth_context to store state information, but the same value is always available
 106          * from the DATA_BLOB chal on this structure.
 107          *
 108          * @param ntlmssp_state This structure
 109          * @param challenge 8 bytes of data, agreed by the client and server to be the effective challenge for NTLM2 authentication
 110          *
 111          */
 112         NTSTATUS (*set_challenge)(struct gensec_ntlmssp_state *, DATA_BLOB *challenge);
 113
 114         /**
 115          * Callback to check the user's password.
 116          *
 117          * The callback must reads the feilds of this structure for the information it needs on the user
 118          * @param ntlmssp_state This structure
 119          * @param nt_session_key If an NT session key is returned by the authentication process, return it here
 120          * @param lm_session_key If an LM session key is returned by the authentication process, return it here
 121          *
 122          */
 123         NTSTATUS (*check_password)(struct gensec_ntlmssp_state *,
 124                                    DATA_BLOB *nt_session_key, DATA_BLOB *lm_session_key);
 125
 126         const char *server_name;
 127
 128         bool doing_ntlm2;
 129
 130         union {
 131                 /* NTLM */
 132                 struct {
 133                         uint32_t seq_num;
 134                         struct arcfour_state *arcfour_state;
 135                 } ntlm;
 136
 137                 /* NTLM2 */
 138                 struct {
 139                         uint32_t send_seq_num;
 140                         uint32_t recv_seq_num;
 141                         DATA_BLOB send_sign_key;
 142                         DATA_BLOB recv_sign_key;
 143                         struct arcfour_state *send_seal_arcfour_state;
 144                         struct arcfour_state *recv_seal_arcfour_state;
 145
 146                         /* internal variables used by NTLM2 */
 147                         uint8_t session_nonce[16];
 148                 } ntlm2;
 149         } crypt;
 150 };
 151
 152 struct gensec_ntlmssp_context {
 153         struct gensec_security *gensec_security;
 154         struct gensec_ntlmssp_state *ntlmssp_state;
 155         struct auth_context *auth_context;
 156         struct auth_serversupplied_info *server_info;
 157 };
 158
 159 struct loadparm_context;
 160 struct auth_session_info;
 161
 162 #include "auth/ntlmssp/proto.h"