s4:lib/tevent: rename structs
[gd/samba-autobuild/.git] / source4 / auth / gensec / gensec.h
index 2951e13dd91c65d36f044faf934423af097af373..c627bda0244cbe6329709d7779701b05a446d452 100644 (file)
@@ -8,7 +8,7 @@
    
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2 of the License, or
+   the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
    
    This program is distributed in the hope that it will be useful,
    GNU General Public License for more details.
    
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
-#define GENSEC_OID_NTLMSSP "1 3 6 1 4 1 311 2 2 10"
-#define GENSEC_OID_SPNEGO "1 3 6 1 5 5 2"
-#define GENSEC_OID_KERBEROS5 "1 2 840 113554 1 2 2"
-#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"
+#ifndef __GENSEC_H__
+#define __GENSEC_H__
+
+#include "../lib/util/data_blob.h"
+#include "libcli/util/ntstatus.h"
+
+#define GENSEC_OID_NTLMSSP "1.3.6.1.4.1.311.2.2.10"
+#define GENSEC_OID_SPNEGO "1.3.6.1.5.5.2"
+#define GENSEC_OID_KERBEROS5 "1.2.840.113554.1.2.2"
+#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"
+
+enum gensec_priority {
+       GENSEC_SPNEGO = 90,
+       GENSEC_GSSAPI = 80,
+       GENSEC_KRB5 = 70,
+       GENSEC_SCHANNEL = 60,
+       GENSEC_NTLMSSP = 50,
+       GENSEC_SASL = 20,
+       GENSEC_OTHER = 0
+};
 
 struct gensec_security;
 struct gensec_target {
        const char *principal;
        const char *hostname;
-       const struct sock_addr *addr;
        const char *service;
 };
 
@@ -40,6 +54,9 @@ struct gensec_target {
 #define GENSEC_FEATURE_SEAL            0x00000004
 #define GENSEC_FEATURE_DCE_STYLE       0x00000008
 #define GENSEC_FEATURE_ASYNC_REPLIES   0x00000010
+#define GENSEC_FEATURE_DATAGRAM_MODE   0x00000020
+#define GENSEC_FEATURE_SIGN_PKT_HEADER 0x00000040
+#define GENSEC_FEATURE_NEW_SPNEGO      0x00000080
 
 /* GENSEC mode */
 enum gensec_role
@@ -49,6 +66,27 @@ enum gensec_role
 };
 
 struct auth_session_info;
+struct cli_credentials;
+struct gensec_settings;
+struct tevent_context;
+
+struct gensec_update_request {
+       struct gensec_security *gensec_security;
+       void *private_data;
+       DATA_BLOB in;
+       DATA_BLOB out;
+       NTSTATUS status;
+       struct {
+               void (*fn)(struct gensec_update_request *req, void *private_data);
+               void *private_data;
+       } callback;
+};
+
+struct gensec_settings {
+       struct loadparm_context *lp_ctx;
+       struct smb_iconv_convenience *iconv_convenience;
+       const char *target_hostname;
+};
 
 struct gensec_security_ops {
        const char *name;
@@ -57,6 +95,11 @@ struct gensec_security_ops {
        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,
                           const DATA_BLOB in, DATA_BLOB *out);
        NTSTATUS (*seal_packet)(struct gensec_security *gensec_security, TALLOC_CTX *sig_mem_ctx,
@@ -67,7 +110,9 @@ struct gensec_security_ops {
                                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   (*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, TALLOC_CTX *sig_mem_ctx, 
                                 const uint8_t *data, size_t length, 
                                 const uint8_t *whole_pdu, size_t pdu_length, 
@@ -81,15 +126,31 @@ struct gensec_security_ops {
                                  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); 
+                          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, DATA_BLOB *session_key);
        NTSTATUS (*session_info)(struct gensec_security *gensec_security, 
                                 struct auth_session_info **session_info); 
-       BOOL (*have_feature)(struct gensec_security *gensec_security,
+       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 enabled;
+       bool kerberos;
+       enum gensec_priority priority;
 };
        
 struct gensec_security_ops_wrapper {
@@ -100,16 +161,17 @@ struct gensec_security_ops_wrapper {
 #define GENSEC_INTERFACE_VERSION 0
 
 struct gensec_security {
-       gensec_password_callback password_callback;
-       void *password_callback_private;
        const struct gensec_security_ops *ops;
        void *private_data;
        struct cli_credentials *credentials;
        struct gensec_target target;
        enum gensec_role gensec_role;
-       BOOL subcontext;
+       bool subcontext;
        uint32_t want_features;
-       struct event_context *event_ctx;
+       struct tevent_context *event_ctx;
+       struct messaging_context *msg_ctx; /* only valid as server */
+       struct socket_address *my_addr, *peer_addr;
+       struct gensec_settings *settings;
 };
 
 /* this structure is used by backends to determine the size of some critical types */
@@ -119,6 +181,133 @@ struct gensec_critical_sizes {
        int sizeof_gensec_security;
 };
 
+/* Socket wrapper */
+
+struct gensec_security;
+struct socket_context;
+
+NTSTATUS gensec_socket_init(struct gensec_security *gensec_security,
+                           TALLOC_CTX *mem_ctx, 
+                           struct socket_context *current_socket,
+                           struct tevent_context *ev,
+                           void (*recv_handler)(void *, uint16_t),
+                           void *recv_private,
+                           struct socket_context **new_socket);
+/* 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, 
+                                struct gensec_security *parent, 
+                                struct gensec_security **gensec_security);
+NTSTATUS gensec_client_start(TALLOC_CTX *mem_ctx, 
+                            struct gensec_security **gensec_security,
+                            struct tevent_context *ev,
+                            struct gensec_settings *settings);
+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, 
+                      const DATA_BLOB in, DATA_BLOB *out);
+void gensec_update_send(struct gensec_security *gensec_security, const DATA_BLOB in,
+                                void (*callback)(struct gensec_update_request *req, void *private_data),
+                                void *private_data);
+NTSTATUS gensec_update_recv(struct gensec_update_request *req, TALLOC_CTX *out_mem_ctx, DATA_BLOB *out);
+void gensec_want_feature(struct gensec_security *gensec_security,
+                        uint32_t feature);
+bool gensec_have_feature(struct gensec_security *gensec_security,
+                        uint32_t feature);
+NTSTATUS gensec_set_credentials(struct gensec_security *gensec_security, struct cli_credentials *credentials);
+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);
+NTSTATUS gensec_session_key(struct gensec_security *gensec_security, 
+                           DATA_BLOB *session_key);
+NTSTATUS gensec_start_mech_by_oid(struct gensec_security *gensec_security, 
+                                 const char *mech_oid);
+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);
+struct socket_address *gensec_get_peer_addr(struct gensec_security *gensec_security);
+NTSTATUS gensec_init(struct loadparm_context *lp_ctx);
+NTSTATUS gensec_unseal_packet(struct gensec_security *gensec_security, 
+                             TALLOC_CTX *mem_ctx, 
+                             uint8_t *data, size_t length, 
+                             const uint8_t *whole_pdu, size_t pdu_length, 
+                             const DATA_BLOB *sig);
+NTSTATUS gensec_check_packet(struct gensec_security *gensec_security, 
+                            TALLOC_CTX *mem_ctx, 
+                            const uint8_t *data, size_t length, 
+                            const uint8_t *whole_pdu, size_t pdu_length, 
+                            const DATA_BLOB *sig);
+size_t gensec_sig_size(struct gensec_security *gensec_security, size_t data_size);
+NTSTATUS gensec_seal_packet(struct gensec_security *gensec_security, 
+                           TALLOC_CTX *mem_ctx, 
+                           uint8_t *data, size_t length, 
+                           const uint8_t *whole_pdu, size_t pdu_length, 
+                           DATA_BLOB *sig);
+NTSTATUS gensec_sign_packet(struct gensec_security *gensec_security, 
+                           TALLOC_CTX *mem_ctx, 
+                           const uint8_t *data, size_t length, 
+                           const uint8_t *whole_pdu, size_t pdu_length, 
+                           DATA_BLOB *sig);
+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);
+NTSTATUS gensec_server_start(TALLOC_CTX *mem_ctx, 
+                            struct tevent_context *ev,
+                            struct gensec_settings *settings,
+                            struct messaging_context *msg,
+                            struct gensec_security **gensec_security);
+NTSTATUS gensec_session_info(struct gensec_security *gensec_security, 
+                            struct auth_session_info **session_info);
+NTSTATUS auth_nt_status_squash(NTSTATUS nt_status);
+struct creds_CredentialState;
+NTSTATUS dcerpc_schannel_creds(struct gensec_security *gensec_security,
+                              TALLOC_CTX *mem_ctx,
+                              struct creds_CredentialState **creds);
+NTSTATUS gensec_set_peer_addr(struct gensec_security *gensec_security, struct socket_address *peer_addr);
+NTSTATUS gensec_set_my_addr(struct gensec_security *gensec_security, struct socket_address *my_addr);
+
+NTSTATUS gensec_start_mech_by_name(struct gensec_security *gensec_security, 
+                                       const char *name);
+
+NTSTATUS gensec_unwrap(struct gensec_security *gensec_security, 
+                      TALLOC_CTX *mem_ctx, 
+                      const DATA_BLOB *in, 
+                      DATA_BLOB *out);
+NTSTATUS gensec_wrap(struct gensec_security *gensec_security, 
+                    TALLOC_CTX *mem_ctx, 
+                    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 loadparm_context *lp_ctx);
+struct gensec_security_ops **gensec_use_kerberos_mechs(TALLOC_CTX *mem_ctx, 
+                                                      struct gensec_security_ops **old_gensec_list, 
+                                                      struct cli_credentials *creds);
+
+NTSTATUS gensec_start_mech_by_sasl_name(struct gensec_security *gensec_security, 
+                                       const char *sasl_name);
+
+int gensec_setting_int(struct gensec_settings *settings, const char *mechanism, const char *name, int default_value);
+bool gensec_setting_bool(struct gensec_settings *settings, const char *mechanism, const char *name, bool default_value);
 
-/* pre-declare schannel structure for schannel backend */       
-struct schannel_state;
+#endif /* __GENSEC_H__ */