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 "core.h"
  27
  28 #define GENSEC_OID_NTLMSSP "1.3.6.1.4.1.311.2.2.10"
  29 #define GENSEC_OID_SPNEGO "1.3.6.1.5.5.2"
  30 #define GENSEC_OID_KERBEROS5 "1.2.840.113554.1.2.2"
  31 #define GENSEC_OID_KERBEROS5_OLD "1.2.840.48018.1.2.2"
  32 #define GENSEC_OID_KERBEROS5_USER2USER "1.2.840.113554.1.2.2.3"
  33
  34 enum gensec_priority {
  35         GENSEC_SPNEGO = 90,
  36         GENSEC_GSSAPI = 80,
  37         GENSEC_KRB5 = 70,
  38         GENSEC_SCHANNEL = 60,
  39         GENSEC_NTLMSSP = 50,
  40         GENSEC_SASL = 20,
  41         GENSEC_OTHER = 0
  42 };
  43
  44 enum credentials_use_kerberos;
  45
  46 struct gensec_security;
  47 struct gensec_target {
  48         const char *principal;
  49         const char *hostname;
  50         const char *service;
  51 };
  52
  53 #define GENSEC_FEATURE_SESSION_KEY      0x00000001
  54 #define GENSEC_FEATURE_SIGN             0x00000002
  55 #define GENSEC_FEATURE_SEAL             0x00000004
  56 #define GENSEC_FEATURE_DCE_STYLE        0x00000008
  57 #define GENSEC_FEATURE_ASYNC_REPLIES    0x00000010
  58 #define GENSEC_FEATURE_DATAGRAM_MODE    0x00000020
  59
  60 /* GENSEC mode */
  61 enum gensec_role
  62 {
  63         GENSEC_SERVER,
  64         GENSEC_CLIENT
  65 };
  66
  67 struct auth_session_info;
  68
  69 struct gensec_update_request {
  70         struct gensec_security *gensec_security;
  71         void *private_data;
  72         DATA_BLOB in;
  73         DATA_BLOB out;
  74         NTSTATUS status;
  75         struct {
  76                 void (*fn)(struct gensec_update_request *req, void *private_data);
  77                 void *private_data;
  78         } callback;
  79 };
  80
  81 struct gensec_security_ops {
  82         const char *name;
  83         const char *sasl_name;
  84         uint8_t auth_type;  /* 0 if not offered on DCE-RPC */
  85         const char **oid;  /* NULL if not offered by SPNEGO */
  86         NTSTATUS (*client_start)(struct gensec_security *gensec_security);
  87         NTSTATUS (*server_start)(struct gensec_security *gensec_security);
  88         /**
  89            Determine if a packet has the right 'magic' for this mechanism
  90         */
  91         NTSTATUS (*magic)(struct gensec_security *gensec_security,
  92                           const DATA_BLOB *first_packet);
  93         NTSTATUS (*update)(struct gensec_security *gensec_security, TALLOC_CTX *out_mem_ctx,
  94                            const DATA_BLOB in, DATA_BLOB *out);
  95         NTSTATUS (*seal_packet)(struct gensec_security *gensec_security, TALLOC_CTX *sig_mem_ctx,
  96                                 uint8_t *data, size_t length,
  97                                 const uint8_t *whole_pdu, size_t pdu_length,
  98                                 DATA_BLOB *sig);
  99         NTSTATUS (*sign_packet)(struct gensec_security *gensec_security, TALLOC_CTX *sig_mem_ctx,
 100                                 const uint8_t *data, size_t length,
 101                                 const uint8_t *whole_pdu, size_t pdu_length,
 102                                 DATA_BLOB *sig);
 103         size_t   (*sig_size)(struct gensec_security *gensec_security, size_t data_size);
 104         size_t   (*max_input_size)(struct gensec_security *gensec_security);
 105         size_t   (*max_wrapped_size)(struct gensec_security *gensec_security);
 106         NTSTATUS (*check_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                                  const DATA_BLOB *sig);
 110         NTSTATUS (*unseal_packet)(struct gensec_security *gensec_security, TALLOC_CTX *sig_mem_ctx,
 111                                   uint8_t *data, size_t length,
 112                                   const uint8_t *whole_pdu, size_t pdu_length,
 113                                   const DATA_BLOB *sig);
 114         NTSTATUS (*wrap)(struct gensec_security *gensec_security,
 115                                   TALLOC_CTX *mem_ctx,
 116                                   const DATA_BLOB *in,
 117                                   DATA_BLOB *out);
 118         NTSTATUS (*unwrap)(struct gensec_security *gensec_security,
 119                            TALLOC_CTX *mem_ctx,
 120                            const DATA_BLOB *in,
 121                            DATA_BLOB *out);
 122         NTSTATUS (*wrap_packets)(struct gensec_security *gensec_security,
 123                                  TALLOC_CTX *mem_ctx,
 124                                  const DATA_BLOB *in,
 125                                  DATA_BLOB *out,
 126                                  size_t *len_processed);
 127         NTSTATUS (*unwrap_packets)(struct gensec_security *gensec_security,
 128                                    TALLOC_CTX *mem_ctx,
 129                                    const DATA_BLOB *in,
 130                                    DATA_BLOB *out,
 131                                    size_t *len_processed);
 132         NTSTATUS (*packet_full_request)(struct gensec_security *gensec_security,
 133                                         DATA_BLOB blob, size_t *size);
 134         NTSTATUS (*session_key)(struct gensec_security *gensec_security, DATA_BLOB *session_key);
 135         NTSTATUS (*session_info)(struct gensec_security *gensec_security,
 136                                  struct auth_session_info **session_info);
 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 event_context *event_ctx;
 160         struct messaging_context *msg_ctx; /* only valid as server */
 161         struct socket_address *my_addr, *peer_addr;
 162 };
 163
 164 /* this structure is used by backends to determine the size of some critical types */
 165 struct gensec_critical_sizes {
 166         int interface_version;
 167         int sizeof_gensec_security_ops;
 168         int sizeof_gensec_security;
 169 };
 170
 171 #include "auth/gensec/gensec_proto.h"
 172
 173 #endif /* __GENSEC_H__ */