source4/libcli/auth/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
   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 2 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, write to the Free Software
  21    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22 */
  23
  24 #define GENSEC_OID_NTLMSSP "1 3 6 1 4 1 311 2 2 10"
  25 #define GENSEC_OID_SPNEGO "1 3 6 1 5 5 2"
  26 #define GENSEC_OID_KERBEROS5 "1 2 840 113554 1 2 2"
  27 #define GENSEC_OID_KERBEROS5_OLD "1 2 840 48018 1 2 2"
  28 #define GENSEC_OID_KERBEROS5_USER2USER "1 2 840 113554 1 2 2 3"
  29
  30 struct gensec_security;
  31 struct gensec_user {
  32         const char *domain;
  33         const char *realm;
  34         const char *name;
  35         const char *password;
  36 };
  37 struct gensec_target {
  38         const char *principal;
  39         const char *hostname;
  40         const struct sock_addr *addr;
  41         const char *service;
  42 };
  43
  44 #define GENSEC_FEATURE_SESSION_KEY      0x00000001
  45 #define GENSEC_FEATURE_SIGN             0x00000002
  46 #define GENSEC_FEATURE_SEAL             0x00000004
  47
  48 /* GENSEC mode */
  49 enum gensec_role
  50 {
  51         GENSEC_SERVER,
  52         GENSEC_CLIENT
  53 };
  54
  55 struct auth_session_info;
  56
  57 struct gensec_security_ops {
  58         const char *name;
  59         const char *sasl_name;
  60         uint8 auth_type;  /* 0 if not offered on DCE-RPC */
  61         const char *oid;  /* NULL if not offered by SPENGO */
  62         NTSTATUS (*client_start)(struct gensec_security *gensec_security);
  63         NTSTATUS (*server_start)(struct gensec_security *gensec_security);
  64         NTSTATUS (*update)(struct gensec_security *gensec_security, TALLOC_CTX *out_mem_ctx,
  65                            const DATA_BLOB in, DATA_BLOB *out);
  66         NTSTATUS (*seal_packet)(struct gensec_security *gensec_security, TALLOC_CTX *sig_mem_ctx,
  67                                 uint8_t *data, size_t length,
  68                                 const uint8_t *whole_pdu, size_t pdu_length,
  69                                 DATA_BLOB *sig);
  70         NTSTATUS (*sign_packet)(struct gensec_security *gensec_security, TALLOC_CTX *sig_mem_ctx,
  71                                 const uint8_t *data, size_t length,
  72                                 const uint8_t *whole_pdu, size_t pdu_length,
  73                                 DATA_BLOB *sig);
  74         size_t   (*sig_size)(struct gensec_security *gensec_security);
  75         NTSTATUS (*check_packet)(struct gensec_security *gensec_security, TALLOC_CTX *sig_mem_ctx,
  76                                  const uint8_t *data, size_t length,
  77                                  const uint8_t *whole_pdu, size_t pdu_length,
  78                                  const DATA_BLOB *sig);
  79         NTSTATUS (*unseal_packet)(struct gensec_security *gensec_security, TALLOC_CTX *sig_mem_ctx,
  80                                   uint8_t *data, size_t length,
  81                                   const uint8_t *whole_pdu, size_t pdu_length,
  82                                   DATA_BLOB *sig);
  83         NTSTATUS (*session_key)(struct gensec_security *gensec_security, DATA_BLOB *session_key);
  84         NTSTATUS (*session_info)(struct gensec_security *gensec_security,
  85                                  struct auth_session_info **session_info);
  86         void (*end)(struct gensec_security *gensec_security);
  87 };
  88
  89 #define GENSEC_INTERFACE_VERSION 0
  90
  91 struct gensec_security {
  92         gensec_password_callback password_callback;
  93         void *password_callback_private;
  94         const struct gensec_security_ops *ops;
  95         void *private_data;
  96         struct gensec_user user;
  97         struct gensec_user default_user;
  98         struct gensec_target target;
  99         enum gensec_role gensec_role;
 100         BOOL subcontext;
 101         uint32 want_features;
 102         uint32 have_features;
 103 };
 104
 105 /* this structure is used by backends to determine the size of some critical types */
 106 struct gensec_critical_sizes {
 107         int interface_version;
 108         int sizeof_gensec_security_ops;
 109         int sizeof_gensec_security;
 110 };
 111
 112
 113 /* pre-declare schannel structure for schannel backend */
 114 struct schannel_state;