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