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