docs: fix a typo in history file
[bbaumbach/samba-autobuild/.git] / source3 / include / auth.h
index 9e55eeec596391d50ca4810368250f7c1b8bb2cc..69e53bb708351c37fc441d846fc1e255282b5598 100644 (file)
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
-struct auth_usersupplied_info {
-       DATA_BLOB lm_resp;
-       DATA_BLOB nt_resp;
-       DATA_BLOB lm_interactive_pwd;
-       DATA_BLOB nt_interactive_pwd;
-       DATA_BLOB plaintext_password;
+#include "../auth/common_auth.h"
 
-       bool encrypted;
-
-       bool was_mapped;              /* Did the username map actually match? */
-       char *client_domain;          /* domain name string */
-       char *domain;                 /* domain name after mapping */
-       char *internal_username;      /* username after mapping */
-       char *smb_name;               /* username before mapping */
-       const char *workstation_name; /* workstation name (netbios calling
-                                      * name) unicode string */
-
-       uint32 logon_parameters;
-
-};
+struct gensec_security;
 
 struct extra_auth_info {
        struct dom_sid user_sid;
@@ -47,25 +30,28 @@ struct extra_auth_info {
 
 struct auth_serversupplied_info {
        bool guest;
-       bool system;
-
-       struct unix_user_token utok;
-
-       /* NT group information taken from the info3 structure */
 
-       NT_USER_TOKEN *ptok;
+       struct security_unix_token utok;
 
-       /* This is the final session key, as used by SMB signing, and
-        * (truncated to 16 bytes) encryption on the SAMR and LSA pipes
-        * when over ncacn_np.
-        * It is calculated by NTLMSSP from the session key in the info3,
-        * and is  set from the Kerberos session key using
-        * krb5_auth_con_getremotesubkey().
+       /*
+        * A complete auth_session_info
         *
-        * Bootom line, it is not the same as the session keys in info3.
+        * This is not normally filled in, during the typical
+        * authentication process.  If filled in, it has already been
+        * finalised by a nasty hack to support a cached guest/system
+        * session_info
+        */
+       const struct auth_session_info *cached_session_info;
+
+       /* These are the intermediate session keys, as provided by a
+        * NETLOGON server and used by NTLMSSP to negotiate key
+        * exchange etc (which will provide the session_key in the
+        * auth_session_info).  It is usually the same as the keys in
+        * the info3, but is a variable length structure here to allow
+        * it to be omitted if the auth module does not know it.
         */
 
-       DATA_BLOB user_session_key;
+       DATA_BLOB session_key;
        DATA_BLOB lm_session_key;
 
        struct netr_SamInfo3 *info3;
@@ -77,47 +63,42 @@ struct auth_serversupplied_info {
         * to the special invalid value of 0xFFFFFFFF */
        struct extra_auth_info extra;
 
-       void *pam_handle;
-
        /*
         * This is a token from /etc/passwd and /etc/group
         */
        bool nss_token;
 
        char *unix_name;
-
-       /*
-        * For performance reasons we keep an alpha_strcpy-sanitized version
-        * of the username around as long as the global variable current_user
-        * still exists. If we did not do keep this, we'd have to call
-        * alpha_strcpy whenever we do a become_user(), potentially on every
-        * smb request. See set_current_user_info.
-        */
-       char *sanitized_username;
 };
 
+struct auth_context;
+
+typedef NTSTATUS (*prepare_gensec_fn)(const struct auth_context *auth_context, 
+                                     TALLOC_CTX *mem_ctx,
+                                     struct gensec_security **gensec_context);
+
+typedef NTSTATUS (*make_auth4_context_fn)(const struct auth_context *auth_context, 
+                                         TALLOC_CTX *mem_ctx,
+                                         struct auth4_context **auth4_context);
+
 struct auth_context {
        DATA_BLOB challenge; 
 
+       /* What time did this start */
+       struct timeval start_time;
+
        /* Who set this up in the first place? */ 
        const char *challenge_set_by; 
 
-       bool challenge_may_be_modified;
-
-       struct auth_methods *challenge_set_method; 
        /* What order are the various methods in?   Try to stop it changing under us */ 
        struct auth_methods *auth_method_list;  
 
-       NTSTATUS (*get_ntlm_challenge)(struct auth_context *auth_context,
-                                      uint8_t chal[8]);
-       NTSTATUS (*check_ntlm_password)(const struct auth_context *auth_context,
-                                       const struct auth_usersupplied_info *user_info, 
-                                       struct auth_serversupplied_info **server_info);
-       NTSTATUS (*nt_status_squash)(NTSTATUS nt_status);
-       void (*free)(struct auth_context **auth_context);
+       prepare_gensec_fn prepare_gensec;
+       make_auth4_context_fn make_auth4_context;
+       const char *forced_samba4_methods;
 };
 
-typedef struct auth_methods
+struct auth_methods
 {
        struct auth_methods *prev, *next;
        const char *name; /* What name got this module */
@@ -128,18 +109,15 @@ typedef struct auth_methods
                         const struct auth_usersupplied_info *user_info, 
                         struct auth_serversupplied_info **server_info);
 
-       /* If you are using this interface, then you are probably
-        * getting something wrong.  This interface is only for
-        * security=server, and makes a number of compromises to allow
-        * that.  It is not compatible with being a PDC.  */
-       DATA_BLOB (*get_chal)(const struct auth_context *auth_context,
-                             void **my_private_data, 
-                             TALLOC_CTX *mem_ctx);
-
+       /* Optional methods allowing this module to provide a way to get a gensec context and an auth4_context */
+       prepare_gensec_fn prepare_gensec;
+       make_auth4_context_fn make_auth4_context;
        /* Used to keep tabs on things like the cli for SMB server authentication */
        void *private_data;
 
-} auth_methods;
+       uint32_t flags;
+
+};
 
 typedef NTSTATUS (*auth_init_function)(struct auth_context *, const char *, struct auth_methods **);
 
@@ -152,9 +130,20 @@ struct auth_init_function_entry {
        struct auth_init_function_entry *prev, *next;
 };
 
-struct auth_ntlmssp_state;
+extern const struct gensec_security_ops gensec_ntlmssp3_server_ops;
+
+/* Intent of use for session key. LSA and SAMR pipes use 16 bytes of session key when doing create/modify calls */
+enum session_key_use_intent {
+       KEY_USE_FULL = 0,
+       KEY_USE_16BYTES
+};
 
 /* Changed from 1 -> 2 to add the logon_parameters field. */
-#define AUTH_INTERFACE_VERSION 2
+/* Changed from 2 -> 3 when we reworked many auth structures to use IDL or be in common with Samba4 */
+/* Changed from 3 -> 4 when we reworked added the flags */
+/* Changed from 4 -> 5 as module init functions now take a TALLOC_CTX * */
+#define AUTH_INTERFACE_VERSION 5
+
+#include "auth/proto.h"
 
 #endif /* _SMBAUTH_H_ */