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_SASL_NAME_NTLMSSP "NTLM"
  30
  31 #define GENSEC_OID_NTLMSSP "1.3.6.1.4.1.311.2.2.10"
  32 #define GENSEC_OID_SPNEGO "1.3.6.1.5.5.2"
  33 #define GENSEC_OID_KERBEROS5 "1.2.840.113554.1.2.2"
  34 #define GENSEC_OID_KERBEROS5_OLD "1.2.840.48018.1.2.2"
  35 #define GENSEC_OID_KERBEROS5_USER2USER "1.2.840.113554.1.2.2.3"
  36
  37 enum gensec_priority {
  38         GENSEC_SPNEGO = 90,
  39         GENSEC_GSSAPI = 80,
  40         GENSEC_KRB5 = 70,
  41         GENSEC_SCHANNEL = 60,
  42         GENSEC_NTLMSSP = 50,
  43         GENSEC_SASL = 20,
  44         GENSEC_OTHER = 0
  45 };
  46
  47 struct gensec_security;
  48 struct gensec_target {
  49         const char *principal;
  50         const char *hostname;
  51         const char *service;
  52 };
  53
  54 #define GENSEC_FEATURE_SESSION_KEY      0x00000001
  55 #define GENSEC_FEATURE_SIGN             0x00000002
  56 #define GENSEC_FEATURE_SEAL             0x00000004
  57 #define GENSEC_FEATURE_DCE_STYLE        0x00000008
  58 #define GENSEC_FEATURE_ASYNC_REPLIES    0x00000010
  59 #define GENSEC_FEATURE_DATAGRAM_MODE    0x00000020
  60 #define GENSEC_FEATURE_SIGN_PKT_HEADER  0x00000040
  61 #define GENSEC_FEATURE_NEW_SPNEGO       0x00000080
  62 #define GENSEC_FEATURE_UNIX_TOKEN       0x00000100
  63
  64 /* GENSEC mode */
  65 enum gensec_role
  66 {
  67         GENSEC_SERVER,
  68         GENSEC_CLIENT
  69 };
  70
  71 struct auth_session_info;
  72 struct cli_credentials;
  73 struct gensec_settings;
  74 struct tevent_context;
  75 struct tevent_req;
  76 struct smb_krb5_context;
  77
  78 struct gensec_settings {
  79         struct loadparm_context *lp_ctx;
  80         const char *target_hostname;
  81
  82         /* this allows callers to specify a specific set of ops that
  83          * should be used, rather than those loaded by the plugin
  84          * mechanism */
  85         struct gensec_security_ops **backends;
  86
  87         /* To fill in our own name in the NTLMSSP server */
  88         const char *server_dns_domain;
  89         const char *server_dns_name;
  90 };
  91
  92 struct gensec_security_ops {
  93         const char *name;
  94         const char *sasl_name;
  95         uint8_t auth_type;  /* 0 if not offered on DCE-RPC */
  96         const char **oid;  /* NULL if not offered by SPNEGO */
  97         NTSTATUS (*client_start)(struct gensec_security *gensec_security);
  98         NTSTATUS (*server_start)(struct gensec_security *gensec_security);
  99         /**
 100            Determine if a packet has the right 'magic' for this mechanism
 101         */
 102         NTSTATUS (*magic)(struct gensec_security *gensec_security,
 103                           const DATA_BLOB *first_packet);
 104         NTSTATUS (*update)(struct gensec_security *gensec_security, TALLOC_CTX *out_mem_ctx,
 105                            struct tevent_context *ev,
 106                            const DATA_BLOB in, DATA_BLOB *out);
 107         NTSTATUS (*seal_packet)(struct gensec_security *gensec_security, TALLOC_CTX *sig_mem_ctx,
 108                                 uint8_t *data, size_t length,
 109                                 const uint8_t *whole_pdu, size_t pdu_length,
 110                                 DATA_BLOB *sig);
 111         NTSTATUS (*sign_packet)(struct gensec_security *gensec_security, TALLOC_CTX *sig_mem_ctx,
 112                                 const uint8_t *data, size_t length,
 113                                 const uint8_t *whole_pdu, size_t pdu_length,
 114                                 DATA_BLOB *sig);
 115         size_t   (*sig_size)(struct gensec_security *gensec_security, size_t data_size);
 116         size_t   (*max_input_size)(struct gensec_security *gensec_security);
 117         size_t   (*max_wrapped_size)(struct gensec_security *gensec_security);
 118         NTSTATUS (*check_packet)(struct gensec_security *gensec_security,
 119                                  const uint8_t *data, size_t length,
 120                                  const uint8_t *whole_pdu, size_t pdu_length,
 121                                  const DATA_BLOB *sig);
 122         NTSTATUS (*unseal_packet)(struct gensec_security *gensec_security,
 123                                   uint8_t *data, size_t length,
 124                                   const uint8_t *whole_pdu, size_t pdu_length,
 125                                   const DATA_BLOB *sig);
 126         NTSTATUS (*wrap)(struct gensec_security *gensec_security,
 127                                   TALLOC_CTX *mem_ctx,
 128                                   const DATA_BLOB *in,
 129                                   DATA_BLOB *out);
 130         NTSTATUS (*unwrap)(struct gensec_security *gensec_security,
 131                            TALLOC_CTX *mem_ctx,
 132                            const DATA_BLOB *in,
 133                            DATA_BLOB *out);
 134         NTSTATUS (*wrap_packets)(struct gensec_security *gensec_security,
 135                                  TALLOC_CTX *mem_ctx,
 136                                  const DATA_BLOB *in,
 137                                  DATA_BLOB *out,
 138                                  size_t *len_processed);
 139         NTSTATUS (*unwrap_packets)(struct gensec_security *gensec_security,
 140                                    TALLOC_CTX *mem_ctx,
 141                                    const DATA_BLOB *in,
 142                                    DATA_BLOB *out,
 143                                    size_t *len_processed);
 144         NTSTATUS (*packet_full_request)(struct gensec_security *gensec_security,
 145                                         DATA_BLOB blob, size_t *size);
 146         NTSTATUS (*session_key)(struct gensec_security *gensec_security, TALLOC_CTX *mem_ctx,
 147                                 DATA_BLOB *session_key);
 148         NTSTATUS (*session_info)(struct gensec_security *gensec_security, TALLOC_CTX *mem_ctx,
 149                                  struct auth_session_info **session_info);
 150         void (*want_feature)(struct gensec_security *gensec_security,
 151                                     uint32_t feature);
 152         bool (*have_feature)(struct gensec_security *gensec_security,
 153                                     uint32_t feature);
 154         bool enabled;
 155         bool kerberos;
 156         enum gensec_priority priority;
 157 };
 158
 159 struct gensec_security_ops_wrapper {
 160         const struct gensec_security_ops *op;
 161         const char *oid;
 162 };
 163
 164 #define GENSEC_INTERFACE_VERSION 0
 165
 166 struct gensec_security {
 167         const struct gensec_security_ops *ops;
 168         void *private_data;
 169         struct cli_credentials *credentials;
 170         struct gensec_target target;
 171         enum gensec_role gensec_role;
 172         bool subcontext;
 173         uint32_t want_features;
 174         uint32_t max_update_size;
 175         uint8_t dcerpc_auth_level;
 176         struct tsocket_address *local_addr, *remote_addr;
 177         struct gensec_settings *settings;
 178
 179         /* When we are a server, this may be filled in to provide an
 180          * NTLM authentication backend, and user lookup (such as if no
 181          * PAC is found) */
 182         struct auth4_context *auth_context;
 183 };
 184
 185 /* this structure is used by backends to determine the size of some critical types */
 186 struct gensec_critical_sizes {
 187         int interface_version;
 188         int sizeof_gensec_security_ops;
 189         int sizeof_gensec_security;
 190 };
 191
 192 /* Socket wrapper */
 193
 194 struct gensec_security;
 195 struct socket_context;
 196 struct auth4_context;
 197 struct auth_user_info_dc;
 198
 199 /* These functions are for use here only (public because SPNEGO must
 200  * use them for recursion) */
 201 NTSTATUS gensec_wrap_packets(struct gensec_security *gensec_security,
 202                              TALLOC_CTX *mem_ctx,
 203                              const DATA_BLOB *in,
 204                              DATA_BLOB *out,
 205                              size_t *len_processed);
 206 /* These functions are for use here only (public because SPNEGO must
 207  * use them for recursion) */
 208 NTSTATUS gensec_unwrap_packets(struct gensec_security *gensec_security,
 209                                TALLOC_CTX *mem_ctx,
 210                                const DATA_BLOB *in,
 211                                DATA_BLOB *out,
 212                                size_t *len_processed);
 213
 214 /* These functions are for use here only (public because SPNEGO must
 215  * use them for recursion) */
 216 NTSTATUS gensec_packet_full_request(struct gensec_security *gensec_security,
 217                                     DATA_BLOB blob, size_t *size);
 218
 219 struct loadparm_context;
 220
 221 NTSTATUS gensec_subcontext_start(TALLOC_CTX *mem_ctx,
 222                                  struct gensec_security *parent,
 223                                  struct gensec_security **gensec_security);
 224 NTSTATUS gensec_client_start(TALLOC_CTX *mem_ctx,
 225                              struct gensec_security **gensec_security,
 226                              struct gensec_settings *settings);
 227 NTSTATUS gensec_start_mech_by_ops(struct gensec_security *gensec_security,
 228                                   const struct gensec_security_ops *ops);
 229 NTSTATUS gensec_start_mech_by_sasl_list(struct gensec_security *gensec_security,
 230                                                  const char **sasl_names);
 231 void gensec_set_max_update_size(struct gensec_security *gensec_security,
 232                                 uint32_t max_update_size);
 233 size_t gensec_max_update_size(struct gensec_security *gensec_security);
 234 NTSTATUS gensec_update(struct gensec_security *gensec_security, TALLOC_CTX *out_mem_ctx,
 235                        struct tevent_context *ev,
 236                        const DATA_BLOB in, DATA_BLOB *out);
 237 struct tevent_req *gensec_update_send(TALLOC_CTX *mem_ctx,
 238                                       struct tevent_context *ev,
 239                                       struct gensec_security *gensec_security,
 240                                       const DATA_BLOB in);
 241 NTSTATUS gensec_update_recv(struct tevent_req *req, TALLOC_CTX *out_mem_ctx, DATA_BLOB *out);
 242 void gensec_want_feature(struct gensec_security *gensec_security,
 243                          uint32_t feature);
 244 bool gensec_have_feature(struct gensec_security *gensec_security,
 245                          uint32_t feature);
 246 NTSTATUS gensec_set_credentials(struct gensec_security *gensec_security, struct cli_credentials *credentials);
 247 NTSTATUS gensec_set_target_service(struct gensec_security *gensec_security, const char *service);
 248 const char *gensec_get_target_service(struct gensec_security *gensec_security);
 249 NTSTATUS gensec_set_target_hostname(struct gensec_security *gensec_security, const char *hostname);
 250 const char *gensec_get_target_hostname(struct gensec_security *gensec_security);
 251 NTSTATUS gensec_session_key(struct gensec_security *gensec_security,
 252                             TALLOC_CTX *mem_ctx,
 253                             DATA_BLOB *session_key);
 254 NTSTATUS gensec_start_mech_by_oid(struct gensec_security *gensec_security,
 255                                   const char *mech_oid);
 256 const char *gensec_get_name_by_oid(struct gensec_security *gensec_security, const char *oid_string);
 257 struct cli_credentials *gensec_get_credentials(struct gensec_security *gensec_security);
 258 NTSTATUS gensec_init(void);
 259 NTSTATUS gensec_register(const struct gensec_security_ops *ops);
 260 const struct gensec_security_ops *gensec_security_by_oid(struct gensec_security *gensec_security,
 261                                                          const char *oid_string);
 262 const struct gensec_security_ops *gensec_security_by_sasl_name(struct gensec_security *gensec_security,
 263                                                                const char *sasl_name);
 264 struct gensec_security_ops **gensec_security_mechs(struct gensec_security *gensec_security,
 265                                                    TALLOC_CTX *mem_ctx);
 266 const struct gensec_security_ops_wrapper *gensec_security_by_oid_list(
 267                                         struct gensec_security *gensec_security,
 268                                         TALLOC_CTX *mem_ctx,
 269                                         const char **oid_strings,
 270                                         const char *skip);
 271 const char **gensec_security_oids(struct gensec_security *gensec_security,
 272                                   TALLOC_CTX *mem_ctx,
 273                                   const char *skip);
 274 const char **gensec_security_oids_from_ops_wrapped(TALLOC_CTX *mem_ctx,
 275                                 const struct gensec_security_ops_wrapper *wops);
 276 size_t gensec_max_input_size(struct gensec_security *gensec_security);
 277 size_t gensec_max_wrapped_size(struct gensec_security *gensec_security);
 278 NTSTATUS gensec_unseal_packet(struct gensec_security *gensec_security,
 279                               uint8_t *data, size_t length,
 280                               const uint8_t *whole_pdu, size_t pdu_length,
 281                               const DATA_BLOB *sig);
 282 NTSTATUS gensec_check_packet(struct gensec_security *gensec_security,
 283                              const uint8_t *data, size_t length,
 284                              const uint8_t *whole_pdu, size_t pdu_length,
 285                              const DATA_BLOB *sig);
 286 size_t gensec_sig_size(struct gensec_security *gensec_security, size_t data_size);
 287 NTSTATUS gensec_seal_packet(struct gensec_security *gensec_security,
 288                             TALLOC_CTX *mem_ctx,
 289                             uint8_t *data, size_t length,
 290                             const uint8_t *whole_pdu, size_t pdu_length,
 291                             DATA_BLOB *sig);
 292 NTSTATUS gensec_sign_packet(struct gensec_security *gensec_security,
 293                             TALLOC_CTX *mem_ctx,
 294                             const uint8_t *data, size_t length,
 295                             const uint8_t *whole_pdu, size_t pdu_length,
 296                             DATA_BLOB *sig);
 297 NTSTATUS gensec_start_mech(struct gensec_security *gensec_security);
 298 NTSTATUS gensec_start_mech_by_authtype(struct gensec_security *gensec_security,
 299                                        uint8_t auth_type, uint8_t auth_level);
 300 const char *gensec_get_name_by_authtype(struct gensec_security *gensec_security, uint8_t authtype);
 301 NTSTATUS gensec_server_start(TALLOC_CTX *mem_ctx,
 302                              struct gensec_settings *settings,
 303                              struct auth4_context *auth_context,
 304                              struct gensec_security **gensec_security);
 305 NTSTATUS gensec_session_info(struct gensec_security *gensec_security,
 306                              TALLOC_CTX *mem_ctx,
 307                              struct auth_session_info **session_info);
 308
 309 NTSTATUS gensec_set_local_address(struct gensec_security *gensec_security,
 310                 const struct tsocket_address *local);
 311 NTSTATUS gensec_set_remote_address(struct gensec_security *gensec_security,
 312                 const struct tsocket_address *remote);
 313 const struct tsocket_address *gensec_get_local_address(struct gensec_security *gensec_security);
 314 const struct tsocket_address *gensec_get_remote_address(struct gensec_security *gensec_security);
 315
 316 NTSTATUS gensec_start_mech_by_name(struct gensec_security *gensec_security,
 317                                         const char *name);
 318
 319 NTSTATUS gensec_unwrap(struct gensec_security *gensec_security,
 320                        TALLOC_CTX *mem_ctx,
 321                        const DATA_BLOB *in,
 322                        DATA_BLOB *out);
 323 NTSTATUS gensec_wrap(struct gensec_security *gensec_security,
 324                      TALLOC_CTX *mem_ctx,
 325                      const DATA_BLOB *in,
 326                      DATA_BLOB *out);
 327
 328 struct gensec_security_ops **gensec_security_all(void);
 329 bool gensec_security_ops_enabled(struct gensec_security_ops *ops, struct gensec_security *security);
 330 struct gensec_security_ops **gensec_use_kerberos_mechs(TALLOC_CTX *mem_ctx,
 331                                                        struct gensec_security_ops **old_gensec_list,
 332                                                        struct cli_credentials *creds);
 333
 334 NTSTATUS gensec_start_mech_by_sasl_name(struct gensec_security *gensec_security,
 335                                         const char *sasl_name);
 336
 337 int gensec_setting_int(struct gensec_settings *settings, const char *mechanism, const char *name, int default_value);
 338 bool gensec_setting_bool(struct gensec_settings *settings, const char *mechanism, const char *name, bool default_value);
 339
 340 NTSTATUS gensec_set_target_principal(struct gensec_security *gensec_security, const char *principal);
 341 const char *gensec_get_target_principal(struct gensec_security *gensec_security);
 342
 343 NTSTATUS gensec_generate_session_info_pac(TALLOC_CTX *mem_ctx,
 344                                           struct gensec_security *gensec_security,
 345                                           struct smb_krb5_context *smb_krb5_context,
 346                                           DATA_BLOB *pac_blob,
 347                                           const char *principal_string,
 348                                           const struct tsocket_address *remote_address,
 349                                           struct auth_session_info **session_info);
 350
 351
 352 #endif /* __GENSEC_H__ */