s3: Remove header==NULL code from db_ctdb_marshall_record
[kai/samba.git] / source3 / include / auth.h
index de75ff68f6f5ec1abe8ec25ca5887d335ddd1c22..07f8b9eee1abe548118258c77fba8bbcf32506fb 100644 (file)
@@ -4,74 +4,73 @@
    Unix SMB/CIFS implementation.
    Standardised Authentication types
    Copyright (C) Andrew Bartlett 2001
-   
+
    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,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    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/>.
 */
 
-typedef 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;
-       
-       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 */
-       char *wksta_name;             /* workstation name (netbios calling
-                                      * name) unicode string */
-       
-       uint32 logon_parameters;
-
-} auth_usersupplied_info;
-
-typedef struct auth_serversupplied_info {
-       BOOL guest;
-
-       DOM_SID *sids;  /* These SIDs are preliminary between
-                          check_ntlm_password and the token creation. */
-       size_t num_sids;
-
-       uid_t uid;
-       gid_t gid;
-       
-       /* This groups info is needed for when we become_user() for this uid */
-       size_t n_groups;
-       gid_t *groups;
-       
+#include "../auth/common_auth.h"
+
+struct gensec_security;
+
+struct extra_auth_info {
+       struct dom_sid user_sid;
+       struct dom_sid pgid_sid;
+};
+
+struct auth_serversupplied_info {
+       bool guest;
+       bool system;
+
+       struct security_unix_token utok;
+
        /* NT group information taken from the info3 structure */
-       
-       NT_USER_TOKEN *ptok;
-       
-       DATA_BLOB user_session_key;
+
+       struct security_token *security_token;
+
+       /* 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 session_key;
        DATA_BLOB lm_session_key;
 
-        char *login_server; /* which server authorized the login? */
-       
-       struct samu *sam_account;
-       
-       void *pam_handle;
+       struct netr_SamInfo3 *info3;
+
+       /* this structure is filled *only* in pathological cases where the user
+        * sid or the primary group sid are not sids of the domain. Normally
+        * this happens only for unix accounts that have unix domain sids.
+        * This is checked only when info3.rid and/or info3.primary_gid are set
+        * to the special invalid value of 0xFFFFFFFF */
+       struct extra_auth_info extra;
+
+       /*
+        * This is a token from /etc/passwd and /etc/group
+        */
+       bool nss_token;
 
-       BOOL was_mapped;        /* Did the username map match? */
        char *unix_name;
-       
-} auth_serversupplied_info;
+};
+
+typedef NTSTATUS (*prepare_gensec_fn)(TALLOC_CTX *mem_ctx,
+                                     struct gensec_security **gensec_context);
+
+typedef NTSTATUS (*make_auth4_context_fn)(TALLOC_CTX *mem_ctx,
+                                         struct auth4_context **auth4_context);
 
 struct auth_context {
        DATA_BLOB challenge; 
@@ -79,19 +78,11 @@ struct auth_context {
        /* 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;  
 
-       TALLOC_CTX *mem_ctx;
-       const uint8 *(*get_ntlm_challenge)(struct auth_context *auth_context);
-       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;
 };
 
 typedef struct auth_methods
@@ -103,24 +94,13 @@ typedef struct auth_methods
                         void *my_private_data, 
                         TALLOC_CTX *mem_ctx,
                         const struct auth_usersupplied_info *user_info, 
-                        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);
-       
+                        struct auth_serversupplied_info **server_info);
+
+       /* 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;
-       
-       /* Function to clean up the above arbitary structure */
-       void (*free_private_data)(void **private_data);
-
-       /* Function to send a keepalive message on the above structure */
-       void (*send_keepalive)(void **private_data);
 
 } auth_methods;
 
@@ -135,14 +115,18 @@ struct auth_init_function_entry {
        struct auth_init_function_entry *prev, *next;
 };
 
-typedef struct auth_ntlmssp_state {
-       TALLOC_CTX *mem_ctx;
-       struct auth_context *auth_context;
-       struct auth_serversupplied_info *server_info;
-       struct ntlmssp_state *ntlmssp_state;
-} 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 */
+#define AUTH_INTERFACE_VERSION 3
+
+#include "auth/proto.h"
 
 #endif /* _SMBAUTH_H_ */