auth/gensec/gensec_internal.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_INTERNAL_H__
  24 #define __GENSEC_INTERNAL_H__
  25
  26 struct gensec_security;
  27
  28 struct gensec_security_ops {
  29         const char *name;
  30         const char *sasl_name;
  31         uint8_t auth_type;  /* 0 if not offered on DCE-RPC */
  32         const char **oid;  /* NULL if not offered by SPNEGO */
  33         NTSTATUS (*client_start)(struct gensec_security *gensec_security);
  34         NTSTATUS (*server_start)(struct gensec_security *gensec_security);
  35         /**
  36            Determine if a packet has the right 'magic' for this mechanism
  37         */
  38         NTSTATUS (*magic)(struct gensec_security *gensec_security,
  39                           const DATA_BLOB *first_packet);
  40         NTSTATUS (*update)(struct gensec_security *gensec_security, TALLOC_CTX *out_mem_ctx,
  41                            struct tevent_context *ev,
  42                            const DATA_BLOB in, DATA_BLOB *out);
  43         struct tevent_req *(*update_send)(TALLOC_CTX *mem_ctx,
  44                                           struct tevent_context *ev,
  45                                           struct gensec_security *gensec_security,
  46                                           const DATA_BLOB in);
  47         NTSTATUS (*update_recv)(struct tevent_req *req,
  48                                 TALLOC_CTX *out_mem_ctx,
  49                                 DATA_BLOB *out);
  50         NTSTATUS (*seal_packet)(struct gensec_security *gensec_security, TALLOC_CTX *sig_mem_ctx,
  51                                 uint8_t *data, size_t length,
  52                                 const uint8_t *whole_pdu, size_t pdu_length,
  53                                 DATA_BLOB *sig);
  54         NTSTATUS (*sign_packet)(struct gensec_security *gensec_security, TALLOC_CTX *sig_mem_ctx,
  55                                 const uint8_t *data, size_t length,
  56                                 const uint8_t *whole_pdu, size_t pdu_length,
  57                                 DATA_BLOB *sig);
  58         size_t   (*sig_size)(struct gensec_security *gensec_security, size_t data_size);
  59         size_t   (*max_input_size)(struct gensec_security *gensec_security);
  60         size_t   (*max_wrapped_size)(struct gensec_security *gensec_security);
  61         NTSTATUS (*check_packet)(struct gensec_security *gensec_security,
  62                                  const uint8_t *data, size_t length,
  63                                  const uint8_t *whole_pdu, size_t pdu_length,
  64                                  const DATA_BLOB *sig);
  65         NTSTATUS (*unseal_packet)(struct gensec_security *gensec_security,
  66                                   uint8_t *data, size_t length,
  67                                   const uint8_t *whole_pdu, size_t pdu_length,
  68                                   const DATA_BLOB *sig);
  69         NTSTATUS (*wrap)(struct gensec_security *gensec_security,
  70                                   TALLOC_CTX *mem_ctx,
  71                                   const DATA_BLOB *in,
  72                                   DATA_BLOB *out);
  73         NTSTATUS (*unwrap)(struct gensec_security *gensec_security,
  74                            TALLOC_CTX *mem_ctx,
  75                            const DATA_BLOB *in,
  76                            DATA_BLOB *out);
  77         NTSTATUS (*session_key)(struct gensec_security *gensec_security, TALLOC_CTX *mem_ctx,
  78                                 DATA_BLOB *session_key);
  79         NTSTATUS (*session_info)(struct gensec_security *gensec_security, TALLOC_CTX *mem_ctx,
  80                                  struct auth_session_info **session_info);
  81         void (*want_feature)(struct gensec_security *gensec_security,
  82                                     uint32_t feature);
  83         bool (*have_feature)(struct gensec_security *gensec_security,
  84                                     uint32_t feature);
  85         NTTIME (*expire_time)(struct gensec_security *gensec_security);
  86         bool enabled;
  87         bool kerberos;
  88         enum gensec_priority priority;
  89 };
  90
  91 struct gensec_security_ops_wrapper {
  92         const struct gensec_security_ops *op;
  93         const char *oid;
  94 };
  95
  96 struct gensec_security {
  97         const struct gensec_security_ops *ops;
  98         void *private_data;
  99         struct cli_credentials *credentials;
 100         struct gensec_target target;
 101         enum gensec_role gensec_role;
 102         bool subcontext;
 103         uint32_t want_features;
 104         uint32_t max_update_size;
 105         uint8_t dcerpc_auth_level;
 106         struct tsocket_address *local_addr, *remote_addr;
 107         struct gensec_settings *settings;
 108
 109         /* When we are a server, this may be filled in to provide an
 110          * NTLM authentication backend, and user lookup (such as if no
 111          * PAC is found) */
 112         struct auth4_context *auth_context;
 113 };
 114
 115 /* this structure is used by backends to determine the size of some critical types */
 116 struct gensec_critical_sizes {
 117         int interface_version;
 118         int sizeof_gensec_security_ops;
 119         int sizeof_gensec_security;
 120 };
 121
 122 #endif /* __GENSEC_H__ */