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