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
  77 struct gensec_settings {
  78         struct loadparm_context *lp_ctx;
  79         const char *target_hostname;
  80
  81         /* this allows callers to specify a specific set of ops that
  82          * should be used, rather than those loaded by the plugin
  83          * mechanism */
  84         struct gensec_security_ops **backends;
  85 };
  86
  87 struct gensec_security_ops {
  88         const char *name;
  89         const char *sasl_name;
  90         uint8_t auth_type;  /* 0 if not offered on DCE-RPC */
  91         const char **oid;  /* NULL if not offered by SPNEGO */
  92         NTSTATUS (*client_start)(struct gensec_security *gensec_security);
  93         NTSTATUS (*server_start)(struct gensec_security *gensec_security);
  94         /**
  95            Determine if a packet has the right 'magic' for this mechanism
  96         */
  97         NTSTATUS (*magic)(struct gensec_security *gensec_security,
  98                           const DATA_BLOB *first_packet);
  99         NTSTATUS (*update)(struct gensec_security *gensec_security, TALLOC_CTX *out_mem_ctx,
 100                            struct tevent_context *ev,
 101                            const DATA_BLOB in, DATA_BLOB *out);
 102         NTSTATUS (*seal_packet)(struct gensec_security *gensec_security, TALLOC_CTX *sig_mem_ctx,
 103                                 uint8_t *data, size_t length,
 104                                 const uint8_t *whole_pdu, size_t pdu_length,
 105                                 DATA_BLOB *sig);
 106         NTSTATUS (*sign_packet)(struct gensec_security *gensec_security, TALLOC_CTX *sig_mem_ctx,
 107                                 const uint8_t *data, size_t length,
 108                                 const uint8_t *whole_pdu, size_t pdu_length,
 109                                 DATA_BLOB *sig);
 110         size_t   (*sig_size)(struct gensec_security *gensec_security, size_t data_size);
 111         size_t   (*max_input_size)(struct gensec_security *gensec_security);
 112         size_t   (*max_wrapped_size)(struct gensec_security *gensec_security);
 113         NTSTATUS (*check_packet)(struct gensec_security *gensec_security,
 114                                  const uint8_t *data, size_t length,
 115                                  const uint8_t *whole_pdu, size_t pdu_length,
 116                                  const DATA_BLOB *sig);
 117         NTSTATUS (*unseal_packet)(struct gensec_security *gensec_security,
 118                                   uint8_t *data, size_t length,
 119                                   const uint8_t *whole_pdu, size_t pdu_length,
 120                                   const DATA_BLOB *sig);
 121         NTSTATUS (*wrap)(struct gensec_security *gensec_security,
 122                                   TALLOC_CTX *mem_ctx,
 123                                   const DATA_BLOB *in,
 124                                   DATA_BLOB *out);
 125         NTSTATUS (*unwrap)(struct gensec_security *gensec_security,
 126                            TALLOC_CTX *mem_ctx,
 127                            const DATA_BLOB *in,
 128                            DATA_BLOB *out);
 129         NTSTATUS (*wrap_packets)(struct gensec_security *gensec_security,
 130                                  TALLOC_CTX *mem_ctx,
 131                                  const DATA_BLOB *in,
 132                                  DATA_BLOB *out,
 133                                  size_t *len_processed);
 134         NTSTATUS (*unwrap_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 (*packet_full_request)(struct gensec_security *gensec_security,
 140                                         DATA_BLOB blob, size_t *size);
 141         NTSTATUS (*session_key)(struct gensec_security *gensec_security, TALLOC_CTX *mem_ctx,
 142                                 DATA_BLOB *session_key);
 143         NTSTATUS (*session_info)(struct gensec_security *gensec_security, TALLOC_CTX *mem_ctx,
 144                                  struct auth_session_info **session_info);
 145         void (*want_feature)(struct gensec_security *gensec_security,
 146                                     uint32_t feature);
 147         bool (*have_feature)(struct gensec_security *gensec_security,
 148                                     uint32_t feature);
 149         bool enabled;
 150         bool kerberos;
 151         enum gensec_priority priority;
 152 };
 153
 154 struct gensec_security_ops_wrapper {
 155         const struct gensec_security_ops *op;
 156         const char *oid;
 157 };
 158
 159 #define GENSEC_INTERFACE_VERSION 0
 160
 161 struct gensec_security {
 162         const struct gensec_security_ops *ops;
 163         void *private_data;
 164         struct cli_credentials *credentials;
 165         struct gensec_target target;
 166         enum gensec_role gensec_role;
 167         bool subcontext;
 168         uint32_t want_features;
 169         uint8_t dcerpc_auth_level;
 170         struct tsocket_address *local_addr, *remote_addr;
 171         struct gensec_settings *settings;
 172
 173         /* When we are a server, this may be filled in to provide an
 174          * NTLM authentication backend, and user lookup (such as if no
 175          * PAC is found) */
 176         struct auth4_context *auth_context;
 177 };
 178
 179 /* this structure is used by backends to determine the size of some critical types */
 180 struct gensec_critical_sizes {
 181         int interface_version;
 182         int sizeof_gensec_security_ops;
 183         int sizeof_gensec_security;
 184 };
 185
 186 /* Socket wrapper */
 187
 188 struct gensec_security;
 189 struct socket_context;
 190 struct auth4_context;
 191 struct auth_user_info_dc;
 192
 193 /* These functions are for use here only (public because SPNEGO must
 194  * use them for recursion) */
 195 NTSTATUS gensec_wrap_packets(struct gensec_security *gensec_security,
 196                              TALLOC_CTX *mem_ctx,
 197                              const DATA_BLOB *in,
 198                              DATA_BLOB *out,
 199                              size_t *len_processed);
 200 /* These functions are for use here only (public because SPNEGO must
 201  * use them for recursion) */
 202 NTSTATUS gensec_unwrap_packets(struct gensec_security *gensec_security,
 203                                TALLOC_CTX *mem_ctx,
 204                                const DATA_BLOB *in,
 205                                DATA_BLOB *out,
 206                                size_t *len_processed);
 207
 208 /* These functions are for use here only (public because SPNEGO must
 209  * use them for recursion) */
 210 NTSTATUS gensec_packet_full_request(struct gensec_security *gensec_security,
 211                                     DATA_BLOB blob, size_t *size);
 212
 213 struct loadparm_context;
 214
 215 NTSTATUS gensec_subcontext_start(TALLOC_CTX *mem_ctx,
 216                                  struct gensec_security *parent,
 217                                  struct gensec_security **gensec_security);
 218 NTSTATUS gensec_client_start(TALLOC_CTX *mem_ctx,
 219                              struct gensec_security **gensec_security,
 220                              struct gensec_settings *settings);
 221 NTSTATUS gensec_start_mech_by_ops(struct gensec_security *gensec_security,
 222                                   const struct gensec_security_ops *ops);
 223 NTSTATUS gensec_start_mech_by_sasl_list(struct gensec_security *gensec_security,
 224                                                  const char **sasl_names);
 225 NTSTATUS gensec_update(struct gensec_security *gensec_security, TALLOC_CTX *out_mem_ctx,
 226                        struct tevent_context *ev,
 227                        const DATA_BLOB in, DATA_BLOB *out);
 228 struct tevent_req *gensec_update_send(TALLOC_CTX *mem_ctx,
 229                                       struct tevent_context *ev,
 230                                       struct gensec_security *gensec_security,
 231                                       const DATA_BLOB in);
 232 NTSTATUS gensec_update_recv(struct tevent_req *req, TALLOC_CTX *out_mem_ctx, DATA_BLOB *out);
 233 void gensec_want_feature(struct gensec_security *gensec_security,
 234                          uint32_t feature);
 235 bool gensec_have_feature(struct gensec_security *gensec_security,
 236                          uint32_t feature);
 237 NTSTATUS gensec_set_credentials(struct gensec_security *gensec_security, struct cli_credentials *credentials);
 238 NTSTATUS gensec_set_target_service(struct gensec_security *gensec_security, const char *service);
 239 const char *gensec_get_target_service(struct gensec_security *gensec_security);
 240 NTSTATUS gensec_set_target_hostname(struct gensec_security *gensec_security, const char *hostname);
 241 const char *gensec_get_target_hostname(struct gensec_security *gensec_security);
 242 NTSTATUS gensec_session_key(struct gensec_security *gensec_security,
 243                             TALLOC_CTX *mem_ctx,
 244                             DATA_BLOB *session_key);
 245 NTSTATUS gensec_start_mech_by_oid(struct gensec_security *gensec_security,
 246                                   const char *mech_oid);
 247 const char *gensec_get_name_by_oid(struct gensec_security *gensec_security, const char *oid_string);
 248 struct cli_credentials *gensec_get_credentials(struct gensec_security *gensec_security);
 249 NTSTATUS gensec_init(void);
 250 size_t gensec_max_input_size(struct gensec_security *gensec_security);
 251 NTSTATUS gensec_unseal_packet(struct gensec_security *gensec_security,
 252                               uint8_t *data, size_t length,
 253                               const uint8_t *whole_pdu, size_t pdu_length,
 254                               const DATA_BLOB *sig);
 255 NTSTATUS gensec_check_packet(struct gensec_security *gensec_security,
 256                              const uint8_t *data, size_t length,
 257                              const uint8_t *whole_pdu, size_t pdu_length,
 258                              const DATA_BLOB *sig);
 259 size_t gensec_sig_size(struct gensec_security *gensec_security, size_t data_size);
 260 NTSTATUS gensec_seal_packet(struct gensec_security *gensec_security,
 261                             TALLOC_CTX *mem_ctx,
 262                             uint8_t *data, size_t length,
 263                             const uint8_t *whole_pdu, size_t pdu_length,
 264                             DATA_BLOB *sig);
 265 NTSTATUS gensec_sign_packet(struct gensec_security *gensec_security,
 266                             TALLOC_CTX *mem_ctx,
 267                             const uint8_t *data, size_t length,
 268                             const uint8_t *whole_pdu, size_t pdu_length,
 269                             DATA_BLOB *sig);
 270 NTSTATUS gensec_start_mech(struct gensec_security *gensec_security);
 271 NTSTATUS gensec_start_mech_by_authtype(struct gensec_security *gensec_security,
 272                                        uint8_t auth_type, uint8_t auth_level);
 273 const char *gensec_get_name_by_authtype(struct gensec_security *gensec_security, uint8_t authtype);
 274 NTSTATUS gensec_server_start(TALLOC_CTX *mem_ctx,
 275                              struct gensec_settings *settings,
 276                              struct auth4_context *auth_context,
 277                              struct gensec_security **gensec_security);
 278 NTSTATUS gensec_session_info(struct gensec_security *gensec_security,
 279                              TALLOC_CTX *mem_ctx,
 280                              struct auth_session_info **session_info);
 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__ */