auth/gensec: finally remove unused gensec_update_ev()
[vlendec/samba-autobuild/.git] / auth / gensec / gensec.h
index 9b2ac19fe1157f9237b14fe8205134b5a7f7ae99..d424067d02c8fb25e08fdf36a3413d17aeb41ce0 100644 (file)
@@ -34,6 +34,9 @@
 #define GENSEC_OID_KERBEROS5_OLD "1.2.840.48018.1.2.2"
 #define GENSEC_OID_KERBEROS5_USER2USER "1.2.840.113554.1.2.2.3"
 
+#define GENSEC_FINAL_AUTH_TYPE_KRB5 "krb5"
+#define GENSEC_FINAL_AUTH_TYPE_NTLMSSP "NTLMSSP"
+
 enum gensec_priority {
        GENSEC_SPNEGO = 90,
        GENSEC_GSSAPI = 80,
@@ -41,7 +44,8 @@ enum gensec_priority {
        GENSEC_SCHANNEL = 60,
        GENSEC_NTLMSSP = 50,
        GENSEC_SASL = 20,
-       GENSEC_OTHER = 0
+       GENSEC_OTHER = 10,
+       GENSEC_EXTERNAL = 0
 };
 
 struct gensec_security;
@@ -49,6 +53,7 @@ struct gensec_target {
        const char *principal;
        const char *hostname;
        const char *service;
+       const char *service_description;
 };
 
 #define GENSEC_FEATURE_SESSION_KEY     0x00000001
@@ -60,6 +65,13 @@ struct gensec_target {
 #define GENSEC_FEATURE_SIGN_PKT_HEADER 0x00000040
 #define GENSEC_FEATURE_NEW_SPNEGO      0x00000080
 #define GENSEC_FEATURE_UNIX_TOKEN      0x00000100
+#define GENSEC_FEATURE_NTLM_CCACHE     0x00000200
+#define GENSEC_FEATURE_LDAP_STYLE      0x00000400
+#define GENSEC_FEATURE_NO_AUTHZ_LOG    0x00000800
+#define GENSEC_FEATURE_SMB_TRANSPORT   0x00001000
+#define GENSEC_FEATURE_LDAPS_TRANSPORT 0x00002000
+
+#define GENSEC_EXPIRE_TIME_INFINITY (NTTIME)0x8000000000000000LL
 
 /* GENSEC mode */
 enum gensec_role
@@ -73,6 +85,8 @@ struct cli_credentials;
 struct gensec_settings;
 struct tevent_context;
 struct tevent_req;
+struct smb_krb5_context;
+struct tsocket_address;
 
 struct gensec_settings {
        struct loadparm_context *lp_ctx;
@@ -81,135 +95,31 @@ struct gensec_settings {
        /* this allows callers to specify a specific set of ops that
         * should be used, rather than those loaded by the plugin
         * mechanism */
-       struct gensec_security_ops **backends;
-};
+       const struct gensec_security_ops * const *backends;
 
-struct gensec_security_ops {
-       const char *name;
-       const char *sasl_name;
-       uint8_t auth_type;  /* 0 if not offered on DCE-RPC */
-       const char **oid;  /* NULL if not offered by SPNEGO */
-       NTSTATUS (*client_start)(struct gensec_security *gensec_security);
-       NTSTATUS (*server_start)(struct gensec_security *gensec_security);
-       /**
-          Determine if a packet has the right 'magic' for this mechanism
-       */
-       NTSTATUS (*magic)(struct gensec_security *gensec_security,
-                         const DATA_BLOB *first_packet);
-       NTSTATUS (*update)(struct gensec_security *gensec_security, TALLOC_CTX *out_mem_ctx,
-                          struct tevent_context *ev,
-                          const DATA_BLOB in, DATA_BLOB *out);
-       NTSTATUS (*seal_packet)(struct gensec_security *gensec_security, TALLOC_CTX *sig_mem_ctx,
-                               uint8_t *data, size_t length,
-                               const uint8_t *whole_pdu, size_t pdu_length,
-                               DATA_BLOB *sig);
-       NTSTATUS (*sign_packet)(struct gensec_security *gensec_security, TALLOC_CTX *sig_mem_ctx,
-                               const uint8_t *data, size_t length,
-                               const uint8_t *whole_pdu, size_t pdu_length,
-                               DATA_BLOB *sig);
-       size_t   (*sig_size)(struct gensec_security *gensec_security, size_t data_size);
-       size_t   (*max_input_size)(struct gensec_security *gensec_security);
-       size_t   (*max_wrapped_size)(struct gensec_security *gensec_security);
-       NTSTATUS (*check_packet)(struct gensec_security *gensec_security,
-                                const uint8_t *data, size_t length,
-                                const uint8_t *whole_pdu, size_t pdu_length,
-                                const DATA_BLOB *sig);
-       NTSTATUS (*unseal_packet)(struct gensec_security *gensec_security,
-                                 uint8_t *data, size_t length,
-                                 const uint8_t *whole_pdu, size_t pdu_length,
-                                 const DATA_BLOB *sig);
-       NTSTATUS (*wrap)(struct gensec_security *gensec_security,
-                                 TALLOC_CTX *mem_ctx,
-                                 const DATA_BLOB *in,
-                                 DATA_BLOB *out);
-       NTSTATUS (*unwrap)(struct gensec_security *gensec_security,
-                          TALLOC_CTX *mem_ctx,
-                          const DATA_BLOB *in,
-                          DATA_BLOB *out);
-       NTSTATUS (*wrap_packets)(struct gensec_security *gensec_security,
-                                TALLOC_CTX *mem_ctx,
-                                const DATA_BLOB *in,
-                                DATA_BLOB *out,
-                                size_t *len_processed);
-       NTSTATUS (*unwrap_packets)(struct gensec_security *gensec_security,
-                                  TALLOC_CTX *mem_ctx,
-                                  const DATA_BLOB *in,
-                                  DATA_BLOB *out,
-                                  size_t *len_processed);
-       NTSTATUS (*packet_full_request)(struct gensec_security *gensec_security,
-                                       DATA_BLOB blob, size_t *size);
-       NTSTATUS (*session_key)(struct gensec_security *gensec_security, TALLOC_CTX *mem_ctx,
-                               DATA_BLOB *session_key);
-       NTSTATUS (*session_info)(struct gensec_security *gensec_security, TALLOC_CTX *mem_ctx,
-                                struct auth_session_info **session_info);
-       void (*want_feature)(struct gensec_security *gensec_security,
-                                   uint32_t feature);
-       bool (*have_feature)(struct gensec_security *gensec_security,
-                                   uint32_t feature);
-       bool enabled;
-       bool kerberos;
-       enum gensec_priority priority;
+       /* To fill in our own name in the NTLMSSP server */
+       const char *server_dns_domain;
+       const char *server_dns_name;
+       const char *server_netbios_domain;
+       const char *server_netbios_name;
 };
 
-struct gensec_security_ops_wrapper {
-       const struct gensec_security_ops *op;
-       const char *oid;
-};
+struct gensec_security_ops;
+struct gensec_security_ops_wrapper;
 
-#define GENSEC_INTERFACE_VERSION 0
-
-struct gensec_security {
-       const struct gensec_security_ops *ops;
-       void *private_data;
-       struct cli_credentials *credentials;
-       struct gensec_target target;
-       enum gensec_role gensec_role;
-       bool subcontext;
-       uint32_t want_features;
-       uint8_t dcerpc_auth_level;
-       struct tsocket_address *local_addr, *remote_addr;
-       struct gensec_settings *settings;
-
-       /* When we are a server, this may be filled in to provide an
-        * NTLM authentication backend, and user lookup (such as if no
-        * PAC is found) */
-       struct auth4_context *auth_context;
-};
+/* Change to 1, loadable modules now take a TALLOC_CTX * init() parameter. */
+#define GENSEC_INTERFACE_VERSION 1
 
 /* this structure is used by backends to determine the size of some critical types */
-struct gensec_critical_sizes {
-       int interface_version;
-       int sizeof_gensec_security_ops;
-       int sizeof_gensec_security;
-};
+struct gensec_critical_sizes;
+const struct gensec_critical_sizes *gensec_interface_version(void);
 
 /* Socket wrapper */
 
 struct gensec_security;
-struct socket_context;
 struct auth4_context;
 struct auth_user_info_dc;
 
-/* These functions are for use here only (public because SPNEGO must
- * use them for recursion) */
-NTSTATUS gensec_wrap_packets(struct gensec_security *gensec_security,
-                            TALLOC_CTX *mem_ctx,
-                            const DATA_BLOB *in,
-                            DATA_BLOB *out,
-                            size_t *len_processed);
-/* These functions are for use here only (public because SPNEGO must
- * use them for recursion) */
-NTSTATUS gensec_unwrap_packets(struct gensec_security *gensec_security,
-                              TALLOC_CTX *mem_ctx,
-                              const DATA_BLOB *in,
-                              DATA_BLOB *out,
-                              size_t *len_processed);
-
-/* These functions are for use here only (public because SPNEGO must
- * use them for recursion) */
-NTSTATUS gensec_packet_full_request(struct gensec_security *gensec_security,
-                                   DATA_BLOB blob, size_t *size);
-
 struct loadparm_context;
 
 NTSTATUS gensec_subcontext_start(TALLOC_CTX *mem_ctx,
@@ -222,23 +132,92 @@ NTSTATUS gensec_start_mech_by_ops(struct gensec_security *gensec_security,
                                  const struct gensec_security_ops *ops);
 NTSTATUS gensec_start_mech_by_sasl_list(struct gensec_security *gensec_security,
                                                 const char **sasl_names);
-NTSTATUS gensec_update(struct gensec_security *gensec_security, TALLOC_CTX *out_mem_ctx,
-                      struct tevent_context *ev,
+void gensec_set_max_update_size(struct gensec_security *gensec_security,
+                               uint32_t max_update_size);
+size_t gensec_max_update_size(struct gensec_security *gensec_security);
+NTSTATUS gensec_update(struct gensec_security *gensec_security,
+                      TALLOC_CTX *out_mem_ctx,
                       const DATA_BLOB in, DATA_BLOB *out);
 struct tevent_req *gensec_update_send(TALLOC_CTX *mem_ctx,
                                      struct tevent_context *ev,
                                      struct gensec_security *gensec_security,
                                      const DATA_BLOB in);
 NTSTATUS gensec_update_recv(struct tevent_req *req, TALLOC_CTX *out_mem_ctx, DATA_BLOB *out);
+
+#define GENSEC_UPDATE_IS_NTERROR(status) ( \
+       !NT_STATUS_IS_OK(status) && \
+       !NT_STATUS_EQUAL(status, NT_STATUS_MORE_PROCESSING_REQUIRED) \
+       )
+
+/**
+ * @brief Ask for features for a following authentication
+ *
+ * Typically only one specific feature bit should be passed,
+ * but it also works to ask for more features.
+ *
+ * The features must be requested before starting the
+ * gensec_update*() loop.
+ *
+ * The current expection is GENSEC_FEATURE_SIGN_PKT_HEADER,
+ * it can also be requested once the gensec_update*() loop
+ * returned NT_STATUS_OK.
+ *
+ * The features should not be changed during the gensec_update*()
+ * loop.
+ *
+ * @param[in]  gensec_security The context to be used
+ *
+ * @param[in]  feature         The requested feature[s].
+ *
+ */
 void gensec_want_feature(struct gensec_security *gensec_security,
                         uint32_t feature);
+/**
+ * @brief Ask for one feature after the finished authentication
+ *
+ * Because the return value is bool, the caller can only
+ * ask for one feature at a time.
+ *
+ * The features must be requested after the finished
+ * gensec_update*() loop.
+ *
+ * The current expection is GENSEC_FEATURE_SIGN_PKT_HEADER,
+ * it can also be requested before the gensec_update*() loop,
+ * as the return value only indicates if the backend supports
+ * dcerpc header signing, not if header signing will be used
+ * between client and server. It will be used only if the caller
+ * also used gensec_want_feature(GENSEC_FEATURE_SIGN_PKT_HEADER).
+ *
+ * @param[in]  gensec_security The context to be used.
+ *
+ * @param[in]  feature         The requested feature.
+ *
+ * @return                     true if the feature is supported, false if not.
+ */
 bool gensec_have_feature(struct gensec_security *gensec_security,
                         uint32_t feature);
+NTTIME gensec_expire_time(struct gensec_security *gensec_security);
 NTSTATUS gensec_set_credentials(struct gensec_security *gensec_security, struct cli_credentials *credentials);
+/**
+ * Set the target service (such as 'http' or 'host') on a GENSEC context - ensures it is talloc()ed
+ *
+ * This is used for Kerberos service principal name resolution.
+ */
+
 NTSTATUS gensec_set_target_service(struct gensec_security *gensec_security, const char *service);
 const char *gensec_get_target_service(struct gensec_security *gensec_security);
 NTSTATUS gensec_set_target_hostname(struct gensec_security *gensec_security, const char *hostname);
 const char *gensec_get_target_hostname(struct gensec_security *gensec_security);
+/**
+ * Set the target service (such as 'samr') on an GENSEC context - ensures it is talloc()ed.
+ *
+ * This is not the Kerberos service principal, instead this is a
+ * constant value that can be logged as part of authentication and
+ * authorization logging
+ */
+const char *gensec_get_target_service_description(struct gensec_security *gensec_security);
+NTSTATUS gensec_set_target_service_description(struct gensec_security *gensec_security,
+                                              const char *service);
 NTSTATUS gensec_session_key(struct gensec_security *gensec_security,
                            TALLOC_CTX *mem_ctx,
                            DATA_BLOB *session_key);
@@ -247,7 +226,31 @@ NTSTATUS gensec_start_mech_by_oid(struct gensec_security *gensec_security,
 const char *gensec_get_name_by_oid(struct gensec_security *gensec_security, const char *oid_string);
 struct cli_credentials *gensec_get_credentials(struct gensec_security *gensec_security);
 NTSTATUS gensec_init(void);
+NTSTATUS gensec_register(TALLOC_CTX *ctx,
+               const struct gensec_security_ops *ops);
+const struct gensec_security_ops *gensec_security_by_oid(struct gensec_security *gensec_security,
+                                                        const char *oid_string);
+const struct gensec_security_ops *gensec_security_by_sasl_name(struct gensec_security *gensec_security,
+                                                              const char *sasl_name);
+const struct gensec_security_ops *gensec_security_by_auth_type(
+                               struct gensec_security *gensec_security,
+                               uint32_t auth_type);
+const struct gensec_security_ops *gensec_security_by_name(struct gensec_security *gensec_security,
+                                                         const char *name);
+const struct gensec_security_ops **gensec_security_mechs(struct gensec_security *gensec_security,
+                                                  TALLOC_CTX *mem_ctx);
+const struct gensec_security_ops_wrapper *gensec_security_by_oid_list(
+                                       struct gensec_security *gensec_security,
+                                       TALLOC_CTX *mem_ctx,
+                                       const char * const *oid_strings,
+                                       const char *skip);
+const char **gensec_security_oids(struct gensec_security *gensec_security,
+                                 TALLOC_CTX *mem_ctx,
+                                 const char *skip);
+const char **gensec_security_oids_from_ops_wrapped(TALLOC_CTX *mem_ctx,
+                               const struct gensec_security_ops_wrapper *wops);
 size_t gensec_max_input_size(struct gensec_security *gensec_security);
+size_t gensec_max_wrapped_size(struct gensec_security *gensec_security);
 NTSTATUS gensec_unseal_packet(struct gensec_security *gensec_security,
                              uint8_t *data, size_t length,
                              const uint8_t *whole_pdu, size_t pdu_length,
@@ -267,7 +270,6 @@ NTSTATUS gensec_sign_packet(struct gensec_security *gensec_security,
                            const uint8_t *data, size_t length,
                            const uint8_t *whole_pdu, size_t pdu_length,
                            DATA_BLOB *sig);
-NTSTATUS gensec_start_mech(struct gensec_security *gensec_security);
 NTSTATUS gensec_start_mech_by_authtype(struct gensec_security *gensec_security,
                                       uint8_t auth_type, uint8_t auth_level);
 const char *gensec_get_name_by_authtype(struct gensec_security *gensec_security, uint8_t authtype);
@@ -298,11 +300,11 @@ NTSTATUS gensec_wrap(struct gensec_security *gensec_security,
                     const DATA_BLOB *in,
                     DATA_BLOB *out);
 
-struct gensec_security_ops **gensec_security_all(void);
-bool gensec_security_ops_enabled(struct gensec_security_ops *ops, struct gensec_security *security);
-struct gensec_security_ops **gensec_use_kerberos_mechs(TALLOC_CTX *mem_ctx,
-                                                      struct gensec_security_ops **old_gensec_list,
-                                                      struct cli_credentials *creds);
+const struct gensec_security_ops * const *gensec_security_all(void);
+bool gensec_security_ops_enabled(const struct gensec_security_ops *ops, struct gensec_security *security);
+const struct gensec_security_ops **gensec_use_kerberos_mechs(TALLOC_CTX *mem_ctx,
+                       const struct gensec_security_ops * const *old_gensec_list,
+                       struct cli_credentials *creds);
 
 NTSTATUS gensec_start_mech_by_sasl_name(struct gensec_security *gensec_security,
                                        const char *sasl_name);
@@ -311,5 +313,17 @@ int gensec_setting_int(struct gensec_settings *settings, const char *mechanism,
 bool gensec_setting_bool(struct gensec_settings *settings, const char *mechanism, const char *name, bool default_value);
 
 NTSTATUS gensec_set_target_principal(struct gensec_security *gensec_security, const char *principal);
+const char *gensec_get_target_principal(struct gensec_security *gensec_security);
+
+NTSTATUS gensec_generate_session_info_pac(TALLOC_CTX *mem_ctx,
+                                         struct gensec_security *gensec_security,
+                                         struct smb_krb5_context *smb_krb5_context,
+                                         DATA_BLOB *pac_blob,
+                                         const char *principal_string,
+                                         const struct tsocket_address *remote_address,
+                                         struct auth_session_info **session_info);
+
+NTSTATUS gensec_magic_check_krb5_oid(struct gensec_security *unused,
+                                       const DATA_BLOB *blob);
 
 #endif /* __GENSEC_H__ */