source4/auth/gensec/gensec.h

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    Generic Authentication Interface
   5
   6    Copyright (C) Andrew Tridgell 2003
   7    Copyright (C) Andrew Bartlett <abartlet@samba.org> 2004-2005
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21 */
  22
  23 #ifndef __GENSEC_H__
  24 #define __GENSEC_H__
  25
  26 #include "../lib/util/data_blob.h"
  27 #include "libcli/util/ntstatus.h"
  28
  29 #define GENSEC_OID_NTLMSSP "1.3.6.1.4.1.311.2.2.10"
  30 #define GENSEC_OID_SPNEGO "1.3.6.1.5.5.2"
  31 #define GENSEC_OID_KERBEROS5 "1.2.840.113554.1.2.2"
  32 #define GENSEC_OID_KERBEROS5_OLD "1.2.840.48018.1.2.2"
  33 #define GENSEC_OID_KERBEROS5_USER2USER "1.2.840.113554.1.2.2.3"
  34
  35 enum gensec_priority {
  36         GENSEC_SPNEGO = 90,
  37         GENSEC_GSSAPI = 80,
  38         GENSEC_KRB5 = 70,
  39         GENSEC_SCHANNEL = 60,
  40         GENSEC_NTLMSSP = 50,
  41         GENSEC_SASL = 20,
  42         GENSEC_OTHER = 0
  43 };
  44
  45 struct gensec_security;
  46 struct gensec_target {
  47         const char *principal;
  48         const char *hostname;
  49         const char *service;
  50 };
  51
  52 #define GENSEC_FEATURE_SESSION_KEY      0x00000001
  53 #define GENSEC_FEATURE_SIGN             0x00000002
  54 #define GENSEC_FEATURE_SEAL             0x00000004
  55 #define GENSEC_FEATURE_DCE_STYLE        0x00000008
  56 #define GENSEC_FEATURE_ASYNC_REPLIES    0x00000010
  57 #define GENSEC_FEATURE_DATAGRAM_MODE    0x00000020
  58 #define GENSEC_FEATURE_SIGN_PKT_HEADER  0x00000040
  59 #define GENSEC_FEATURE_NEW_SPNEGO       0x00000080
  60
  61 /* GENSEC mode */
  62 enum gensec_role
  63 {
  64         GENSEC_SERVER,
  65         GENSEC_CLIENT
  66 };
  67
  68 struct auth_session_info;
  69 struct cli_credentials;
  70 struct gensec_settings;
  71 struct tevent_context;
  72 struct tevent_req;
  73
  74 struct gensec_settings {
  75         struct loadparm_context *lp_ctx;
  76         const char *target_hostname;
  77 };
  78
  79 struct gensec_security_ops {
  80         const char *name;
  81         const char *sasl_name;
  82         uint8_t auth_type;  /* 0 if not offered on DCE-RPC */
  83         const char **oid;  /* NULL if not offered by SPNEGO */
  84         NTSTATUS (*client_start)(struct gensec_security *gensec_security);
  85         NTSTATUS (*server_start)(struct gensec_security *gensec_security);
  86         /**
  87            Determine if a packet has the right 'magic' for this mechanism
  88         */
  89         NTSTATUS (*magic)(struct gensec_security *gensec_security,
  90                           const DATA_BLOB *first_packet);
  91         NTSTATUS (*update)(struct gensec_security *gensec_security, TALLOC_CTX *out_mem_ctx,
  92                            const DATA_BLOB in, DATA_BLOB *out);
  93         NTSTATUS (*seal_packet)(struct gensec_security *gensec_security, TALLOC_CTX *sig_mem_ctx,
  94                                 uint8_t *data, size_t length,
  95                                 const uint8_t *whole_pdu, size_t pdu_length,
  96                                 DATA_BLOB *sig);
  97         NTSTATUS (*sign_packet)(struct gensec_security *gensec_security, TALLOC_CTX *sig_mem_ctx,
  98                                 const uint8_t *data, size_t length,
  99                                 const uint8_t *whole_pdu, size_t pdu_length,
 100                                 DATA_BLOB *sig);
 101         size_t   (*sig_size)(struct gensec_security *gensec_security, size_t data_size);
 102         size_t   (*max_input_size)(struct gensec_security *gensec_security);
 103         size_t   (*max_wrapped_size)(struct gensec_security *gensec_security);
 104         NTSTATUS (*check_packet)(struct gensec_security *gensec_security, TALLOC_CTX *sig_mem_ctx,
 105                                  const uint8_t *data, size_t length,
 106                                  const uint8_t *whole_pdu, size_t pdu_length,
 107                                  const DATA_BLOB *sig);
 108         NTSTATUS (*unseal_packet)(struct gensec_security *gensec_security, TALLOC_CTX *sig_mem_ctx,
 109                                   uint8_t *data, size_t length,
 110                                   const uint8_t *whole_pdu, size_t pdu_length,
 111                                   const DATA_BLOB *sig);
 112         NTSTATUS (*wrap)(struct gensec_security *gensec_security,
 113                                   TALLOC_CTX *mem_ctx,
 114                                   const DATA_BLOB *in,
 115                                   DATA_BLOB *out);
 116         NTSTATUS (*unwrap)(struct gensec_security *gensec_security,
 117                            TALLOC_CTX *mem_ctx,
 118                            const DATA_BLOB *in,
 119                            DATA_BLOB *out);
 120         NTSTATUS (*wrap_packets)(struct gensec_security *gensec_security,
 121                                  TALLOC_CTX *mem_ctx,
 122                                  const DATA_BLOB *in,
 123                                  DATA_BLOB *out,
 124                                  size_t *len_processed);
 125         NTSTATUS (*unwrap_packets)(struct gensec_security *gensec_security,
 126                                    TALLOC_CTX *mem_ctx,
 127                                    const DATA_BLOB *in,
 128                                    DATA_BLOB *out,
 129                                    size_t *len_processed);
 130         NTSTATUS (*packet_full_request)(struct gensec_security *gensec_security,
 131                                         DATA_BLOB blob, size_t *size);
 132         NTSTATUS (*session_key)(struct gensec_security *gensec_security, DATA_BLOB *session_key);
 133         NTSTATUS (*session_info)(struct gensec_security *gensec_security,
 134                                  struct auth_session_info **session_info);
 135         void (*want_feature)(struct gensec_security *gensec_security,
 136                                     uint32_t feature);
 137         bool (*have_feature)(struct gensec_security *gensec_security,
 138                                     uint32_t feature);
 139         bool enabled;
 140         bool kerberos;
 141         enum gensec_priority priority;
 142 };
 143
 144 struct gensec_security_ops_wrapper {
 145         const struct gensec_security_ops *op;
 146         const char *oid;
 147 };
 148
 149 #define GENSEC_INTERFACE_VERSION 0
 150
 151 struct gensec_security {
 152         const struct gensec_security_ops *ops;
 153         void *private_data;
 154         struct cli_credentials *credentials;
 155         struct gensec_target target;
 156         enum gensec_role gensec_role;
 157         bool subcontext;
 158         uint32_t want_features;
 159         struct tevent_context *event_ctx;
 160         struct tsocket_address *local_addr, *remote_addr;
 161         struct gensec_settings *settings;
 162
 163         /* When we are a server, this may be filled in to provide an
 164          * NTLM authentication backend, and user lookup (such as if no
 165          * PAC is found) */
 166         struct auth_context *auth_context;
 167 };
 168
 169 /* this structure is used by backends to determine the size of some critical types */
 170 struct gensec_critical_sizes {
 171         int interface_version;
 172         int sizeof_gensec_security_ops;
 173         int sizeof_gensec_security;
 174 };
 175
 176 /* Socket wrapper */
 177
 178 struct gensec_security;
 179 struct socket_context;
 180 struct auth_context;
 181 struct auth_serversupplied_info;
 182
 183 NTSTATUS gensec_socket_init(struct gensec_security *gensec_security,
 184                             TALLOC_CTX *mem_ctx,
 185                             struct socket_context *current_socket,
 186                             struct tevent_context *ev,
 187                             void (*recv_handler)(void *, uint16_t),
 188                             void *recv_private,
 189                             struct socket_context **new_socket);
 190 /* These functions are for use here only (public because SPNEGO must
 191  * use them for recursion) */
 192 NTSTATUS gensec_wrap_packets(struct gensec_security *gensec_security,
 193                              TALLOC_CTX *mem_ctx,
 194                              const DATA_BLOB *in,
 195                              DATA_BLOB *out,
 196                              size_t *len_processed);
 197 /* These functions are for use here only (public because SPNEGO must
 198  * use them for recursion) */
 199 NTSTATUS gensec_unwrap_packets(struct gensec_security *gensec_security,
 200                                TALLOC_CTX *mem_ctx,
 201                                const DATA_BLOB *in,
 202                                DATA_BLOB *out,
 203                                size_t *len_processed);
 204
 205 /* These functions are for use here only (public because SPNEGO must
 206  * use them for recursion) */
 207 NTSTATUS gensec_packet_full_request(struct gensec_security *gensec_security,
 208                                     DATA_BLOB blob, size_t *size);
 209
 210 struct loadparm_context;
 211
 212 NTSTATUS gensec_subcontext_start(TALLOC_CTX *mem_ctx,
 213                                  struct gensec_security *parent,
 214                                  struct gensec_security **gensec_security);
 215 NTSTATUS gensec_client_start(TALLOC_CTX *mem_ctx,
 216                              struct gensec_security **gensec_security,
 217                              struct tevent_context *ev,
 218                              struct gensec_settings *settings);
 219 NTSTATUS gensec_start_mech_by_sasl_list(struct gensec_security *gensec_security,
 220                                                  const char **sasl_names);
 221 NTSTATUS gensec_update(struct gensec_security *gensec_security, TALLOC_CTX *out_mem_ctx,
 222                        const DATA_BLOB in, DATA_BLOB *out);
 223 struct tevent_req *gensec_update_send(TALLOC_CTX *mem_ctx,
 224                                       struct tevent_context *ev,
 225                                       struct gensec_security *gensec_security,
 226                                       const DATA_BLOB in);
 227 NTSTATUS gensec_update_recv(struct tevent_req *req, TALLOC_CTX *out_mem_ctx, DATA_BLOB *out);
 228 void gensec_want_feature(struct gensec_security *gensec_security,
 229                          uint32_t feature);
 230 bool gensec_have_feature(struct gensec_security *gensec_security,
 231                          uint32_t feature);
 232 NTSTATUS gensec_set_credentials(struct gensec_security *gensec_security, struct cli_credentials *credentials);
 233 NTSTATUS gensec_set_target_service(struct gensec_security *gensec_security, const char *service);
 234 const char *gensec_get_target_service(struct gensec_security *gensec_security);
 235 NTSTATUS gensec_set_target_hostname(struct gensec_security *gensec_security, const char *hostname);
 236 const char *gensec_get_target_hostname(struct gensec_security *gensec_security);
 237 NTSTATUS gensec_session_key(struct gensec_security *gensec_security,
 238                             DATA_BLOB *session_key);
 239 NTSTATUS gensec_start_mech_by_oid(struct gensec_security *gensec_security,
 240                                   const char *mech_oid);
 241 const char *gensec_get_name_by_oid(struct gensec_security *gensec_security, const char *oid_string);
 242 struct cli_credentials *gensec_get_credentials(struct gensec_security *gensec_security);
 243 NTSTATUS gensec_init(struct loadparm_context *lp_ctx);
 244 NTSTATUS gensec_unseal_packet(struct gensec_security *gensec_security,
 245                               TALLOC_CTX *mem_ctx,
 246                               uint8_t *data, size_t length,
 247                               const uint8_t *whole_pdu, size_t pdu_length,
 248                               const DATA_BLOB *sig);
 249 NTSTATUS gensec_check_packet(struct gensec_security *gensec_security,
 250                              TALLOC_CTX *mem_ctx,
 251                              const uint8_t *data, size_t length,
 252                              const uint8_t *whole_pdu, size_t pdu_length,
 253                              const DATA_BLOB *sig);
 254 size_t gensec_sig_size(struct gensec_security *gensec_security, size_t data_size);
 255 NTSTATUS gensec_seal_packet(struct gensec_security *gensec_security,
 256                             TALLOC_CTX *mem_ctx,
 257                             uint8_t *data, size_t length,
 258                             const uint8_t *whole_pdu, size_t pdu_length,
 259                             DATA_BLOB *sig);
 260 NTSTATUS gensec_sign_packet(struct gensec_security *gensec_security,
 261                             TALLOC_CTX *mem_ctx,
 262                             const uint8_t *data, size_t length,
 263                             const uint8_t *whole_pdu, size_t pdu_length,
 264                             DATA_BLOB *sig);
 265 NTSTATUS gensec_start_mech_by_authtype(struct gensec_security *gensec_security,
 266                                        uint8_t auth_type, uint8_t auth_level);
 267 const char *gensec_get_name_by_authtype(struct gensec_security *gensec_security, uint8_t authtype);
 268 NTSTATUS gensec_server_start(TALLOC_CTX *mem_ctx,
 269                              struct tevent_context *ev,
 270                              struct gensec_settings *settings,
 271                              struct auth_context *auth_context,
 272                              struct gensec_security **gensec_security);
 273 NTSTATUS gensec_session_info(struct gensec_security *gensec_security,
 274                              struct auth_session_info **session_info);
 275 NTSTATUS auth_nt_status_squash(NTSTATUS nt_status);
 276 struct netlogon_creds_CredentialState;
 277 NTSTATUS dcerpc_schannel_creds(struct gensec_security *gensec_security,
 278                                TALLOC_CTX *mem_ctx,
 279                                struct netlogon_creds_CredentialState **creds);
 280
 281
 282 NTSTATUS gensec_set_local_address(struct gensec_security *gensec_security,
 283                 const struct tsocket_address *local);
 284 NTSTATUS gensec_set_remote_address(struct gensec_security *gensec_security,
 285                 const struct tsocket_address *remote);
 286 const struct tsocket_address *gensec_get_local_address(struct gensec_security *gensec_security);
 287 const struct tsocket_address *gensec_get_remote_address(struct gensec_security *gensec_security);
 288
 289 NTSTATUS gensec_start_mech_by_name(struct gensec_security *gensec_security,
 290                                         const char *name);
 291
 292 NTSTATUS gensec_unwrap(struct gensec_security *gensec_security,
 293                        TALLOC_CTX *mem_ctx,
 294                        const DATA_BLOB *in,
 295                        DATA_BLOB *out);
 296 NTSTATUS gensec_wrap(struct gensec_security *gensec_security,
 297                      TALLOC_CTX *mem_ctx,
 298                      const DATA_BLOB *in,
 299                      DATA_BLOB *out);
 300
 301 struct gensec_security_ops **gensec_security_all(void);
 302 bool gensec_security_ops_enabled(struct gensec_security_ops *ops, struct gensec_security *security);
 303 struct gensec_security_ops **gensec_use_kerberos_mechs(TALLOC_CTX *mem_ctx,
 304                                                        struct gensec_security_ops **old_gensec_list,
 305                                                        struct cli_credentials *creds);
 306
 307 NTSTATUS gensec_start_mech_by_sasl_name(struct gensec_security *gensec_security,
 308                                         const char *sasl_name);
 309
 310 int gensec_setting_int(struct gensec_settings *settings, const char *mechanism, const char *name, int default_value);
 311 bool gensec_setting_bool(struct gensec_settings *settings, const char *mechanism, const char *name, bool default_value);
 312
 313 NTSTATUS gensec_set_target_principal(struct gensec_security *gensec_security, const char *principal);
 314
 315 #endif /* __GENSEC_H__ */