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 #define GENSEC_OID_NTLMSSP "1.3.6.1.4.1.311.2.2.10"
  27 #define GENSEC_OID_SPNEGO "1.3.6.1.5.5.2"
  28 #define GENSEC_OID_KERBEROS5 "1.2.840.113554.1.2.2"
  29 #define GENSEC_OID_KERBEROS5_OLD "1.2.840.48018.1.2.2"
  30 #define GENSEC_OID_KERBEROS5_USER2USER "1.2.840.113554.1.2.2.3"
  31
  32 enum gensec_priority {
  33         GENSEC_SPNEGO = 90,
  34         GENSEC_GSSAPI = 80,
  35         GENSEC_KRB5 = 70,
  36         GENSEC_SCHANNEL = 60,
  37         GENSEC_NTLMSSP = 50,
  38         GENSEC_SASL = 20,
  39         GENSEC_OTHER = 0
  40 };
  41
  42 struct gensec_security;
  43 struct gensec_target {
  44         const char *principal;
  45         const char *hostname;
  46         const char *service;
  47 };
  48
  49 #define GENSEC_FEATURE_SESSION_KEY      0x00000001
  50 #define GENSEC_FEATURE_SIGN             0x00000002
  51 #define GENSEC_FEATURE_SEAL             0x00000004
  52 #define GENSEC_FEATURE_DCE_STYLE        0x00000008
  53 #define GENSEC_FEATURE_ASYNC_REPLIES    0x00000010
  54 #define GENSEC_FEATURE_DATAGRAM_MODE    0x00000020
  55
  56 /* GENSEC mode */
  57 enum gensec_role
  58 {
  59         GENSEC_SERVER,
  60         GENSEC_CLIENT
  61 };
  62
  63 struct auth_session_info;
  64 struct cli_credentials;
  65
  66 struct gensec_update_request {
  67         struct gensec_security *gensec_security;
  68         void *private_data;
  69         DATA_BLOB in;
  70         DATA_BLOB out;
  71         NTSTATUS status;
  72         struct {
  73                 void (*fn)(struct gensec_update_request *req, void *private_data);
  74                 void *private_data;
  75         } callback;
  76 };
  77
  78 struct gensec_security_ops {
  79         const char *name;
  80         const char *sasl_name;
  81         uint8_t auth_type;  /* 0 if not offered on DCE-RPC */
  82         const char **oid;  /* NULL if not offered by SPNEGO */
  83         NTSTATUS (*client_start)(struct gensec_security *gensec_security);
  84         NTSTATUS (*server_start)(struct gensec_security *gensec_security);
  85         /**
  86            Determine if a packet has the right 'magic' for this mechanism
  87         */
  88         NTSTATUS (*magic)(struct gensec_security *gensec_security,
  89                           const DATA_BLOB *first_packet);
  90         NTSTATUS (*update)(struct gensec_security *gensec_security, TALLOC_CTX *out_mem_ctx,
  91                            const DATA_BLOB in, DATA_BLOB *out);
  92         NTSTATUS (*seal_packet)(struct gensec_security *gensec_security, TALLOC_CTX *sig_mem_ctx,
  93                                 uint8_t *data, size_t length,
  94                                 const uint8_t *whole_pdu, size_t pdu_length,
  95                                 DATA_BLOB *sig);
  96         NTSTATUS (*sign_packet)(struct gensec_security *gensec_security, TALLOC_CTX *sig_mem_ctx,
  97                                 const uint8_t *data, size_t length,
  98                                 const uint8_t *whole_pdu, size_t pdu_length,
  99                                 DATA_BLOB *sig);
 100         size_t   (*sig_size)(struct gensec_security *gensec_security, size_t data_size);
 101         size_t   (*max_input_size)(struct gensec_security *gensec_security);
 102         size_t   (*max_wrapped_size)(struct gensec_security *gensec_security);
 103         NTSTATUS (*check_packet)(struct gensec_security *gensec_security, TALLOC_CTX *sig_mem_ctx,
 104                                  const uint8_t *data, size_t length,
 105                                  const uint8_t *whole_pdu, size_t pdu_length,
 106                                  const DATA_BLOB *sig);
 107         NTSTATUS (*unseal_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                                   const DATA_BLOB *sig);
 111         NTSTATUS (*wrap)(struct gensec_security *gensec_security,
 112                                   TALLOC_CTX *mem_ctx,
 113                                   const DATA_BLOB *in,
 114                                   DATA_BLOB *out);
 115         NTSTATUS (*unwrap)(struct gensec_security *gensec_security,
 116                            TALLOC_CTX *mem_ctx,
 117                            const DATA_BLOB *in,
 118                            DATA_BLOB *out);
 119         NTSTATUS (*wrap_packets)(struct gensec_security *gensec_security,
 120                                  TALLOC_CTX *mem_ctx,
 121                                  const DATA_BLOB *in,
 122                                  DATA_BLOB *out,
 123                                  size_t *len_processed);
 124         NTSTATUS (*unwrap_packets)(struct gensec_security *gensec_security,
 125                                    TALLOC_CTX *mem_ctx,
 126                                    const DATA_BLOB *in,
 127                                    DATA_BLOB *out,
 128                                    size_t *len_processed);
 129         NTSTATUS (*packet_full_request)(struct gensec_security *gensec_security,
 130                                         DATA_BLOB blob, size_t *size);
 131         NTSTATUS (*session_key)(struct gensec_security *gensec_security, DATA_BLOB *session_key);
 132         NTSTATUS (*session_info)(struct gensec_security *gensec_security,
 133                                  struct auth_session_info **session_info);
 134         bool (*have_feature)(struct gensec_security *gensec_security,
 135                                     uint32_t feature);
 136         bool enabled;
 137         bool kerberos;
 138         enum gensec_priority priority;
 139 };
 140
 141 struct gensec_security_ops_wrapper {
 142         const struct gensec_security_ops *op;
 143         const char *oid;
 144 };
 145
 146 #define GENSEC_INTERFACE_VERSION 0
 147
 148 struct gensec_security {
 149         const struct gensec_security_ops *ops;
 150         struct loadparm_context *lp_ctx;
 151         void *private_data;
 152         struct cli_credentials *credentials;
 153         struct gensec_target target;
 154         enum gensec_role gensec_role;
 155         bool subcontext;
 156         uint32_t want_features;
 157         struct event_context *event_ctx;
 158         struct messaging_context *msg_ctx; /* only valid as server */
 159         struct socket_address *my_addr, *peer_addr;
 160 };
 161
 162 /* this structure is used by backends to determine the size of some critical types */
 163 struct gensec_critical_sizes {
 164         int interface_version;
 165         int sizeof_gensec_security_ops;
 166         int sizeof_gensec_security;
 167 };
 168
 169 /* Socket wrapper */
 170
 171 struct gensec_security;
 172 struct socket_context;
 173
 174 NTSTATUS gensec_socket_init(struct gensec_security *gensec_security,
 175                             struct socket_context *current_socket,
 176                             struct event_context *ev,
 177                             void (*recv_handler)(void *, uint16_t),
 178                             void *recv_private,
 179                             struct socket_context **new_socket);
 180 /* These functions are for use here only (public because SPNEGO must
 181  * use them for recursion) */
 182 NTSTATUS gensec_wrap_packets(struct gensec_security *gensec_security,
 183                              TALLOC_CTX *mem_ctx,
 184                              const DATA_BLOB *in,
 185                              DATA_BLOB *out,
 186                              size_t *len_processed);
 187 /* These functions are for use here only (public because SPNEGO must
 188  * use them for recursion) */
 189 NTSTATUS gensec_unwrap_packets(struct gensec_security *gensec_security,
 190                                TALLOC_CTX *mem_ctx,
 191                                const DATA_BLOB *in,
 192                                DATA_BLOB *out,
 193                                size_t *len_processed);
 194
 195 /* These functions are for use here only (public because SPNEGO must
 196  * use them for recursion) */
 197 NTSTATUS gensec_packet_full_request(struct gensec_security *gensec_security,
 198                                     DATA_BLOB blob, size_t *size);
 199
 200 struct loadparm_context;
 201
 202 NTSTATUS gensec_subcontext_start(TALLOC_CTX *mem_ctx,
 203                                  struct gensec_security *parent,
 204                                  struct gensec_security **gensec_security);
 205 NTSTATUS gensec_client_start(TALLOC_CTX *mem_ctx,
 206                              struct gensec_security **gensec_security,
 207                              struct event_context *ev,
 208                              struct loadparm_context *lp_ctx);
 209 NTSTATUS gensec_start_mech_by_sasl_list(struct gensec_security *gensec_security,
 210                                                  const char **sasl_names);
 211 NTSTATUS gensec_update(struct gensec_security *gensec_security, TALLOC_CTX *out_mem_ctx,
 212                        const DATA_BLOB in, DATA_BLOB *out);
 213 void gensec_update_send(struct gensec_security *gensec_security, const DATA_BLOB in,
 214                                  void (*callback)(struct gensec_update_request *req, void *private_data),
 215                                  void *private_data);
 216 NTSTATUS gensec_update_recv(struct gensec_update_request *req, TALLOC_CTX *out_mem_ctx, DATA_BLOB *out);
 217 void gensec_want_feature(struct gensec_security *gensec_security,
 218                          uint32_t feature);
 219 bool gensec_have_feature(struct gensec_security *gensec_security,
 220                          uint32_t feature);
 221 NTSTATUS gensec_set_credentials(struct gensec_security *gensec_security, struct cli_credentials *credentials);
 222 NTSTATUS gensec_set_target_service(struct gensec_security *gensec_security, const char *service);
 223 const char *gensec_get_target_service(struct gensec_security *gensec_security);
 224 NTSTATUS gensec_set_target_hostname(struct gensec_security *gensec_security, const char *hostname);
 225 const char *gensec_get_target_hostname(struct gensec_security *gensec_security);
 226 NTSTATUS gensec_session_key(struct gensec_security *gensec_security,
 227                             DATA_BLOB *session_key);
 228 NTSTATUS gensec_start_mech_by_oid(struct gensec_security *gensec_security,
 229                                   const char *mech_oid);
 230 const char *gensec_get_name_by_oid(const char *oid_string);
 231 struct cli_credentials *gensec_get_credentials(struct gensec_security *gensec_security);
 232 struct socket_address *gensec_get_peer_addr(struct gensec_security *gensec_security);
 233 NTSTATUS gensec_init(struct loadparm_context *lp_ctx);
 234 NTSTATUS gensec_unseal_packet(struct gensec_security *gensec_security,
 235                               TALLOC_CTX *mem_ctx,
 236                               uint8_t *data, size_t length,
 237                               const uint8_t *whole_pdu, size_t pdu_length,
 238                               const DATA_BLOB *sig);
 239 NTSTATUS gensec_check_packet(struct gensec_security *gensec_security,
 240                              TALLOC_CTX *mem_ctx,
 241                              const uint8_t *data, size_t length,
 242                              const uint8_t *whole_pdu, size_t pdu_length,
 243                              const DATA_BLOB *sig);
 244 size_t gensec_sig_size(struct gensec_security *gensec_security, size_t data_size);
 245 NTSTATUS gensec_seal_packet(struct gensec_security *gensec_security,
 246                             TALLOC_CTX *mem_ctx,
 247                             uint8_t *data, size_t length,
 248                             const uint8_t *whole_pdu, size_t pdu_length,
 249                             DATA_BLOB *sig);
 250 NTSTATUS gensec_sign_packet(struct gensec_security *gensec_security,
 251                             TALLOC_CTX *mem_ctx,
 252                             const uint8_t *data, size_t length,
 253                             const uint8_t *whole_pdu, size_t pdu_length,
 254                             DATA_BLOB *sig);
 255 NTSTATUS gensec_start_mech_by_authtype(struct gensec_security *gensec_security,
 256                                        uint8_t auth_type, uint8_t auth_level);
 257 const char *gensec_get_name_by_authtype(uint8_t authtype);
 258 NTSTATUS gensec_server_start(TALLOC_CTX *mem_ctx,
 259                              struct event_context *ev,
 260                              struct loadparm_context *lp_ctx,
 261                              struct messaging_context *msg,
 262                              struct gensec_security **gensec_security);
 263 NTSTATUS gensec_session_info(struct gensec_security *gensec_security,
 264                              struct auth_session_info **session_info);
 265 NTSTATUS auth_nt_status_squash(NTSTATUS nt_status);
 266 struct creds_CredentialState;
 267 NTSTATUS dcerpc_schannel_creds(struct gensec_security *gensec_security,
 268                                TALLOC_CTX *mem_ctx,
 269                                struct creds_CredentialState **creds);
 270 NTSTATUS gensec_set_peer_addr(struct gensec_security *gensec_security, struct socket_address *peer_addr);
 271 NTSTATUS gensec_set_my_addr(struct gensec_security *gensec_security, struct socket_address *my_addr);
 272
 273 NTSTATUS gensec_start_mech_by_name(struct gensec_security *gensec_security,
 274                                         const char *name);
 275
 276 NTSTATUS gensec_unwrap(struct gensec_security *gensec_security,
 277                        TALLOC_CTX *mem_ctx,
 278                        const DATA_BLOB *in,
 279                        DATA_BLOB *out);
 280 NTSTATUS gensec_wrap(struct gensec_security *gensec_security,
 281                      TALLOC_CTX *mem_ctx,
 282                      const DATA_BLOB *in,
 283                      DATA_BLOB *out);
 284
 285 struct gensec_security_ops **gensec_security_all(void);
 286 struct gensec_security_ops **gensec_use_kerberos_mechs(TALLOC_CTX *mem_ctx,
 287                                                        struct gensec_security_ops **old_gensec_list,
 288                                                        struct cli_credentials *creds);
 289
 290 NTSTATUS gensec_start_mech_by_sasl_name(struct gensec_security *gensec_security,
 291                                         const char *sasl_name);
 292
 293
 294 #endif /* __GENSEC_H__ */