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
  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 /* NTLMSSP negotiation flags */
  43 #define NTLMSSP_NEGOTIATE_UNICODE          0x00000001
  44 #define NTLMSSP_NEGOTIATE_OEM              0x00000002
  45 #define NTLMSSP_REQUEST_TARGET             0x00000004
  46 #define NTLMSSP_NEGOTIATE_SIGN             0x00000010 /* Message integrity */
  47 #define NTLMSSP_NEGOTIATE_SEAL             0x00000020 /* Message confidentiality */
  48 #define NTLMSSP_NEGOTIATE_DATAGRAM_STYLE   0x00000040
  49 #define NTLMSSP_NEGOTIATE_LM_KEY           0x00000080
  50 #define NTLMSSP_NEGOTIATE_NETWARE          0x00000100
  51 #define NTLMSSP_NEGOTIATE_NTLM             0x00000200
  52 #define NTLMSSP_NEGOTIATE_DOMAIN_SUPPLIED  0x00001000
  53 #define NTLMSSP_NEGOTIATE_WORKSTATION_SUPPLIED 0x00002000
  54 #define NTLMSSP_NEGOTIATE_THIS_IS_LOCAL_CALL  0x00004000
  55 #define NTLMSSP_NEGOTIATE_ALWAYS_SIGN      0x00008000
  56 #define NTLMSSP_TARGET_TYPE_DOMAIN            0x10000
  57 #define NTLMSSP_TARGET_TYPE_SERVER            0x20000
  58 #define NTLMSSP_CHAL_INIT_RESPONSE         0x00010000
  59
  60 #define NTLMSSP_CHAL_ACCEPT_RESPONSE       0x00020000
  61 #define NTLMSSP_CHAL_NON_NT_SESSION_KEY    0x00040000
  62 #define NTLMSSP_NEGOTIATE_NTLM2            0x00080000
  63 #define NTLMSSP_CHAL_TARGET_INFO           0x00800000
  64 #define NTLMSSP_UNKNOWN_02000000           0x02000000
  65 #define NTLMSSP_NEGOTIATE_128              0x20000000 /* 128-bit encryption */
  66 #define NTLMSSP_NEGOTIATE_KEY_EXCH         0x40000000
  67 #define NTLMSSP_NEGOTIATE_56               0x80000000
  68
  69 #define NTLMSSP_SIGN_VERSION 1
  70
  71 #define NTLMSSP_SIG_SIZE 16
  72
  73 struct gensec_ntlmssp_state
  74 {
  75         struct gensec_security *gensec_security;
  76
  77         enum ntlmssp_role role;
  78         enum samr_Role server_role;
  79         uint32_t expected_state;
  80
  81         bool unicode;
  82         bool use_ntlmv2;
  83         bool use_nt_response;  /* Set to 'False' to debug what happens when the NT response is omited */
  84         bool allow_lm_key;     /* The LM_KEY code is not functional at this point, and it's not
  85                                   very secure anyway */
  86
  87         bool server_multiple_authentications;  /* Set to 'True' to allow squid 2.5
  88                                                   style 'challenge caching' */
  89
  90         char *user;
  91         const char *domain;
  92         const char *workstation;
  93         char *server_domain;
  94
  95         DATA_BLOB internal_chal; /* Random challenge as supplied to the client for NTLM authentication */
  96
  97         DATA_BLOB chal; /* Random challenge as input into the actual NTLM (or NTLM2) authentication */
  98         DATA_BLOB lm_resp;
  99         DATA_BLOB nt_resp;
 100         DATA_BLOB session_key;
 101
 102         uint32_t neg_flags; /* the current state of negotiation with the NTLMSSP partner */
 103
 104         /* internal variables used by KEY_EXCH (client-supplied user session key */
 105         DATA_BLOB encrypted_session_key;
 106
 107         /**
 108          * Callback to get the 'challenge' used for NTLM authentication.
 109          *
 110          * @param ntlmssp_state This structure
 111          * @return 8 bytes of challenge data, determined by the server to be the challenge for NTLM authentication
 112          *
 113          */
 114         const uint8_t *(*get_challenge)(const struct gensec_ntlmssp_state *);
 115
 116         /**
 117          * Callback to find if the challenge used by NTLM authentication may be modified
 118          *
 119          * The NTLM2 authentication scheme modifies the effective challenge, but this is not compatiable with the
 120          * current 'security=server' implementation..
 121          *
 122          * @param ntlmssp_state This structure
 123          * @return Can the challenge be set to arbitary values?
 124          *
 125          */
 126         bool (*may_set_challenge)(const struct gensec_ntlmssp_state *);
 127
 128         /**
 129          * Callback to set the 'challenge' used for NTLM authentication.
 130          *
 131          * The callback may use the void *auth_context to store state information, but the same value is always available
 132          * from the DATA_BLOB chal on this structure.
 133          *
 134          * @param ntlmssp_state This structure
 135          * @param challenge 8 bytes of data, agreed by the client and server to be the effective challenge for NTLM2 authentication
 136          *
 137          */
 138         NTSTATUS (*set_challenge)(struct gensec_ntlmssp_state *, DATA_BLOB *challenge);
 139
 140         /**
 141          * Callback to check the user's password.
 142          *
 143          * The callback must reads the feilds of this structure for the information it needs on the user
 144          * @param ntlmssp_state This structure
 145          * @param nt_session_key If an NT session key is returned by the authentication process, return it here
 146          * @param lm_session_key If an LM session key is returned by the authentication process, return it here
 147          *
 148          */
 149         NTSTATUS (*check_password)(struct gensec_ntlmssp_state *,
 150                                    TALLOC_CTX *mem_ctx,
 151                                    DATA_BLOB *nt_session_key, DATA_BLOB *lm_session_key);
 152
 153         const char *server_name;
 154
 155         bool doing_ntlm2;
 156
 157         union {
 158                 /* NTLM */
 159                 struct {
 160                         uint32_t seq_num;
 161                         struct arcfour_state *arcfour_state;
 162                 } ntlm;
 163
 164                 /* NTLM2 */
 165                 struct {
 166                         uint32_t send_seq_num;
 167                         uint32_t recv_seq_num;
 168                         DATA_BLOB send_sign_key;
 169                         DATA_BLOB recv_sign_key;
 170                         struct arcfour_state *send_seal_arcfour_state;
 171                         struct arcfour_state *recv_seal_arcfour_state;
 172
 173                         /* internal variables used by NTLM2 */
 174                         uint8_t session_nonce[16];
 175                 } ntlm2;
 176         } crypt;
 177
 178         struct auth_context *auth_context;
 179         struct auth_serversupplied_info *server_info;
 180 };
 181
 182 struct loadparm_context;
 183 struct auth_session_info;
 184
 185 #include "auth/ntlmssp/proto.h"