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 "../lib/util/data_blob.h"
  27 #include "libcli/util/ntstatus.h"
  28
  29 #define GENSEC_SASL_NAME_NTLMSSP "NTLM"
  30
  31 #define GENSEC_OID_NTLMSSP "1.3.6.1.4.1.311.2.2.10"
  32 #define GENSEC_OID_SPNEGO "1.3.6.1.5.5.2"
  33 #define GENSEC_OID_KERBEROS5 "1.2.840.113554.1.2.2"
  34 #define GENSEC_OID_KERBEROS5_OLD "1.2.840.48018.1.2.2"
  35 #define GENSEC_OID_KERBEROS5_USER2USER "1.2.840.113554.1.2.2.3"
  36
  37 #define GENSEC_FINAL_AUTH_TYPE_KRB5 "krb5"
  38 #define GENSEC_FINAL_AUTH_TYPE_NTLMSSP "NTLMSSP"
  39
  40 enum gensec_priority {
  41         GENSEC_SPNEGO = 90,
  42         GENSEC_GSSAPI = 80,
  43         GENSEC_KRB5 = 70,
  44         GENSEC_SCHANNEL = 60,
  45         GENSEC_NTLMSSP = 50,
  46         GENSEC_SASL = 20,
  47         GENSEC_OTHER = 10,
  48         GENSEC_EXTERNAL = 0
  49 };
  50
  51 struct gensec_security;
  52 struct gensec_target {
  53         const char *principal;
  54         const char *hostname;
  55         const char *service;
  56         const char *service_description;
  57 };
  58
  59 #define GENSEC_FEATURE_SESSION_KEY      0x00000001
  60 #define GENSEC_FEATURE_SIGN             0x00000002
  61 #define GENSEC_FEATURE_SEAL             0x00000004
  62 #define GENSEC_FEATURE_DCE_STYLE        0x00000008
  63 #define GENSEC_FEATURE_ASYNC_REPLIES    0x00000010
  64 #define GENSEC_FEATURE_DATAGRAM_MODE    0x00000020
  65 #define GENSEC_FEATURE_SIGN_PKT_HEADER  0x00000040
  66 #define GENSEC_FEATURE_NEW_SPNEGO       0x00000080
  67 #define GENSEC_FEATURE_UNIX_TOKEN       0x00000100
  68 #define GENSEC_FEATURE_NTLM_CCACHE      0x00000200
  69 #define GENSEC_FEATURE_LDAP_STYLE       0x00000400
  70 #define GENSEC_FEATURE_NO_AUTHZ_LOG     0x00000800
  71 #define GENSEC_FEATURE_SMB_TRANSPORT    0x00001000
  72 #define GENSEC_FEATURE_LDAPS_TRANSPORT  0x00002000
  73
  74 #define GENSEC_EXPIRE_TIME_INFINITY (NTTIME)0x8000000000000000LL
  75
  76 /* GENSEC mode */
  77 enum gensec_role
  78 {
  79         GENSEC_SERVER,
  80         GENSEC_CLIENT
  81 };
  82
  83 struct auth_session_info;
  84 struct cli_credentials;
  85 struct gensec_settings;
  86 struct tevent_context;
  87 struct tevent_req;
  88 struct smb_krb5_context;
  89 struct tsocket_address;
  90
  91 struct gensec_settings {
  92         struct loadparm_context *lp_ctx;
  93         const char *target_hostname;
  94
  95         /* this allows callers to specify a specific set of ops that
  96          * should be used, rather than those loaded by the plugin
  97          * mechanism */
  98         const struct gensec_security_ops * const *backends;
  99
 100         /* To fill in our own name in the NTLMSSP server */
 101         const char *server_dns_domain;
 102         const char *server_dns_name;
 103         const char *server_netbios_domain;
 104         const char *server_netbios_name;
 105 };
 106
 107 struct gensec_security_ops;
 108 struct gensec_security_ops_wrapper;
 109
 110 #define GENSEC_INTERFACE_VERSION 0
 111
 112 /* this structure is used by backends to determine the size of some critical types */
 113 struct gensec_critical_sizes;
 114 const struct gensec_critical_sizes *gensec_interface_version(void);
 115
 116 /* Socket wrapper */
 117
 118 struct gensec_security;
 119 struct auth4_context;
 120 struct auth_user_info_dc;
 121
 122 struct loadparm_context;
 123
 124 NTSTATUS gensec_subcontext_start(TALLOC_CTX *mem_ctx,
 125                                  struct gensec_security *parent,
 126                                  struct gensec_security **gensec_security);
 127 NTSTATUS gensec_client_start(TALLOC_CTX *mem_ctx,
 128                              struct gensec_security **gensec_security,
 129                              struct gensec_settings *settings);
 130 NTSTATUS gensec_start_mech_by_ops(struct gensec_security *gensec_security,
 131                                   const struct gensec_security_ops *ops);
 132 NTSTATUS gensec_start_mech_by_sasl_list(struct gensec_security *gensec_security,
 133                                                  const char **sasl_names);
 134 void gensec_set_max_update_size(struct gensec_security *gensec_security,
 135                                 uint32_t max_update_size);
 136 size_t gensec_max_update_size(struct gensec_security *gensec_security);
 137 NTSTATUS gensec_update(struct gensec_security *gensec_security,
 138                        TALLOC_CTX *out_mem_ctx,
 139                        const DATA_BLOB in, DATA_BLOB *out);
 140 NTSTATUS gensec_update_ev(struct gensec_security *gensec_security,
 141                           TALLOC_CTX *out_mem_ctx,
 142                           struct tevent_context *ev,
 143                           const DATA_BLOB in, DATA_BLOB *out);
 144 struct tevent_req *gensec_update_send(TALLOC_CTX *mem_ctx,
 145                                       struct tevent_context *ev,
 146                                       struct gensec_security *gensec_security,
 147                                       const DATA_BLOB in);
 148 NTSTATUS gensec_update_recv(struct tevent_req *req, TALLOC_CTX *out_mem_ctx, DATA_BLOB *out);
 149 void gensec_want_feature(struct gensec_security *gensec_security,
 150                          uint32_t feature);
 151 bool gensec_have_feature(struct gensec_security *gensec_security,
 152                          uint32_t feature);
 153 NTTIME gensec_expire_time(struct gensec_security *gensec_security);
 154 NTSTATUS gensec_set_credentials(struct gensec_security *gensec_security, struct cli_credentials *credentials);
 155 /**
 156  * Set the target service (such as 'http' or 'host') on a GENSEC context - ensures it is talloc()ed
 157  *
 158  * This is used for Kerberos service principal name resolution.
 159  */
 160
 161 NTSTATUS gensec_set_target_service(struct gensec_security *gensec_security, const char *service);
 162 const char *gensec_get_target_service(struct gensec_security *gensec_security);
 163 NTSTATUS gensec_set_target_hostname(struct gensec_security *gensec_security, const char *hostname);
 164 const char *gensec_get_target_hostname(struct gensec_security *gensec_security);
 165 /**
 166  * Set the target service (such as 'samr') on an GENSEC context - ensures it is talloc()ed.
 167  *
 168  * This is not the Kerberos service principal, instead this is a
 169  * constant value that can be logged as part of authentication and
 170  * authorization logging
 171  */
 172 const char *gensec_get_target_service_description(struct gensec_security *gensec_security);
 173 NTSTATUS gensec_set_target_service_description(struct gensec_security *gensec_security,
 174                                                const char *service);
 175 NTSTATUS gensec_session_key(struct gensec_security *gensec_security,
 176                             TALLOC_CTX *mem_ctx,
 177                             DATA_BLOB *session_key);
 178 NTSTATUS gensec_start_mech_by_oid(struct gensec_security *gensec_security,
 179                                   const char *mech_oid);
 180 const char *gensec_get_name_by_oid(struct gensec_security *gensec_security, const char *oid_string);
 181 struct cli_credentials *gensec_get_credentials(struct gensec_security *gensec_security);
 182 NTSTATUS gensec_init(void);
 183 NTSTATUS gensec_register(const struct gensec_security_ops *ops);
 184 const struct gensec_security_ops *gensec_security_by_oid(struct gensec_security *gensec_security,
 185                                                          const char *oid_string);
 186 const struct gensec_security_ops *gensec_security_by_sasl_name(struct gensec_security *gensec_security,
 187                                                                const char *sasl_name);
 188 const struct gensec_security_ops *gensec_security_by_auth_type(
 189                                 struct gensec_security *gensec_security,
 190                                 uint32_t auth_type);
 191 const struct gensec_security_ops *gensec_security_by_name(struct gensec_security *gensec_security,
 192                                                           const char *name);
 193 const struct gensec_security_ops **gensec_security_mechs(struct gensec_security *gensec_security,
 194                                                    TALLOC_CTX *mem_ctx);
 195 const struct gensec_security_ops_wrapper *gensec_security_by_oid_list(
 196                                         struct gensec_security *gensec_security,
 197                                         TALLOC_CTX *mem_ctx,
 198                                         const char * const *oid_strings,
 199                                         const char *skip);
 200 const char **gensec_security_oids(struct gensec_security *gensec_security,
 201                                   TALLOC_CTX *mem_ctx,
 202                                   const char *skip);
 203 const char **gensec_security_oids_from_ops_wrapped(TALLOC_CTX *mem_ctx,
 204                                 const struct gensec_security_ops_wrapper *wops);
 205 size_t gensec_max_input_size(struct gensec_security *gensec_security);
 206 size_t gensec_max_wrapped_size(struct gensec_security *gensec_security);
 207 NTSTATUS gensec_unseal_packet(struct gensec_security *gensec_security,
 208                               uint8_t *data, size_t length,
 209                               const uint8_t *whole_pdu, size_t pdu_length,
 210                               const DATA_BLOB *sig);
 211 NTSTATUS gensec_check_packet(struct gensec_security *gensec_security,
 212                              const uint8_t *data, size_t length,
 213                              const uint8_t *whole_pdu, size_t pdu_length,
 214                              const DATA_BLOB *sig);
 215 size_t gensec_sig_size(struct gensec_security *gensec_security, size_t data_size);
 216 NTSTATUS gensec_seal_packet(struct gensec_security *gensec_security,
 217                             TALLOC_CTX *mem_ctx,
 218                             uint8_t *data, size_t length,
 219                             const uint8_t *whole_pdu, size_t pdu_length,
 220                             DATA_BLOB *sig);
 221 NTSTATUS gensec_sign_packet(struct gensec_security *gensec_security,
 222                             TALLOC_CTX *mem_ctx,
 223                             const uint8_t *data, size_t length,
 224                             const uint8_t *whole_pdu, size_t pdu_length,
 225                             DATA_BLOB *sig);
 226 NTSTATUS gensec_start_mech(struct gensec_security *gensec_security);
 227 NTSTATUS gensec_start_mech_by_authtype(struct gensec_security *gensec_security,
 228                                        uint8_t auth_type, uint8_t auth_level);
 229 const char *gensec_get_name_by_authtype(struct gensec_security *gensec_security, uint8_t authtype);
 230 NTSTATUS gensec_server_start(TALLOC_CTX *mem_ctx,
 231                              struct gensec_settings *settings,
 232                              struct auth4_context *auth_context,
 233                              struct gensec_security **gensec_security);
 234 NTSTATUS gensec_session_info(struct gensec_security *gensec_security,
 235                              TALLOC_CTX *mem_ctx,
 236                              struct auth_session_info **session_info);
 237
 238 NTSTATUS gensec_set_local_address(struct gensec_security *gensec_security,
 239                 const struct tsocket_address *local);
 240 NTSTATUS gensec_set_remote_address(struct gensec_security *gensec_security,
 241                 const struct tsocket_address *remote);
 242 const struct tsocket_address *gensec_get_local_address(struct gensec_security *gensec_security);
 243 const struct tsocket_address *gensec_get_remote_address(struct gensec_security *gensec_security);
 244
 245 NTSTATUS gensec_start_mech_by_name(struct gensec_security *gensec_security,
 246                                         const char *name);
 247
 248 NTSTATUS gensec_unwrap(struct gensec_security *gensec_security,
 249                        TALLOC_CTX *mem_ctx,
 250                        const DATA_BLOB *in,
 251                        DATA_BLOB *out);
 252 NTSTATUS gensec_wrap(struct gensec_security *gensec_security,
 253                      TALLOC_CTX *mem_ctx,
 254                      const DATA_BLOB *in,
 255                      DATA_BLOB *out);
 256
 257 const struct gensec_security_ops * const *gensec_security_all(void);
 258 bool gensec_security_ops_enabled(const struct gensec_security_ops *ops, struct gensec_security *security);
 259 const struct gensec_security_ops **gensec_use_kerberos_mechs(TALLOC_CTX *mem_ctx,
 260                         const struct gensec_security_ops * const *old_gensec_list,
 261                         struct cli_credentials *creds);
 262
 263 NTSTATUS gensec_start_mech_by_sasl_name(struct gensec_security *gensec_security,
 264                                         const char *sasl_name);
 265
 266 int gensec_setting_int(struct gensec_settings *settings, const char *mechanism, const char *name, int default_value);
 267 bool gensec_setting_bool(struct gensec_settings *settings, const char *mechanism, const char *name, bool default_value);
 268
 269 NTSTATUS gensec_set_target_principal(struct gensec_security *gensec_security, const char *principal);
 270 const char *gensec_get_target_principal(struct gensec_security *gensec_security);
 271
 272 NTSTATUS gensec_generate_session_info_pac(TALLOC_CTX *mem_ctx,
 273                                           struct gensec_security *gensec_security,
 274                                           struct smb_krb5_context *smb_krb5_context,
 275                                           DATA_BLOB *pac_blob,
 276                                           const char *principal_string,
 277                                           const struct tsocket_address *remote_address,
 278                                           struct auth_session_info **session_info);
 279
 280 NTSTATUS gensec_magic_check_krb5_oid(struct gensec_security *unused,
 281                                         const DATA_BLOB *blob);
 282
 283 #endif /* __GENSEC_H__ */