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 enum credentials_use_kerberos;
  43
  44 struct gensec_security;
  45 struct gensec_target {
  46         const char *principal;
  47         const char *hostname;
  48         const char *service;
  49 };
  50
  51 #define GENSEC_FEATURE_SESSION_KEY      0x00000001
  52 #define GENSEC_FEATURE_SIGN             0x00000002
  53 #define GENSEC_FEATURE_SEAL             0x00000004
  54 #define GENSEC_FEATURE_DCE_STYLE        0x00000008
  55 #define GENSEC_FEATURE_ASYNC_REPLIES    0x00000010
  56 #define GENSEC_FEATURE_DATAGRAM_MODE    0x00000020
  57
  58 /* GENSEC mode */
  59 enum gensec_role
  60 {
  61         GENSEC_SERVER,
  62         GENSEC_CLIENT
  63 };
  64
  65 struct auth_session_info;
  66
  67 struct gensec_update_request {
  68         struct gensec_security *gensec_security;
  69         void *private_data;
  70         DATA_BLOB in;
  71         DATA_BLOB out;
  72         NTSTATUS status;
  73         struct {
  74                 void (*fn)(struct gensec_update_request *req, void *private_data);
  75                 void *private_data;
  76         } callback;
  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         bool (*have_feature)(struct gensec_security *gensec_security,
 136                                     uint32_t feature);
 137         bool enabled;
 138         bool kerberos;
 139         enum gensec_priority priority;
 140 };
 141
 142 struct gensec_security_ops_wrapper {
 143         const struct gensec_security_ops *op;
 144         const char *oid;
 145 };
 146
 147 #define GENSEC_INTERFACE_VERSION 0
 148
 149 struct gensec_security {
 150         const struct gensec_security_ops *ops;
 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 #include "auth/gensec/gensec_proto.h"
 170
 171 #endif /* __GENSEC_H__ */