s3-auth Remove unused pam_handle
[samba.git] / source3 / include / auth.h
index 03206c03c6a894822936f2fa5f7a177e9b814f7b..93e42b8f27580ef768511bdf84f9aa65d0d0cd6e 100644 (file)
@@ -4,81 +4,76 @@
    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/>.
 */
 
-/* AUTH_STR - string */
-typedef struct normal_string {
-       int len;
-       char *str;
-} AUTH_STR;
-
-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;
-       
-       AUTH_STR           client_domain;          /* domain name string */
-       AUTH_STR           domain;               /* domain name after mapping */
-       AUTH_STR           internal_username;    /* username after mapping */
-       AUTH_STR           smb_name;        /* username before mapping */
-       AUTH_STR           wksta_name;           /* workstation name (netbios calling name) unicode string */
-       
-       uint32 logon_parameters;
-
-} auth_usersupplied_info;
-
-#define SAM_FILL_NAME  0x01
-#define SAM_FILL_INFO3 0x02
-#define SAM_FILL_SAM   0x04
-#define SAM_FILL_UNIX  0x08
-#define SAM_FILL_ALL (SAM_FILL_NAME | SAM_FILL_INFO3 | SAM_FILL_SAM | SAM_FILL_UNIX)
-
-typedef struct auth_serversupplied_info {
-       BOOL guest;
-
-       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 extra_auth_info {
+       struct dom_sid user_sid;
+       struct dom_sid pgid_sid;
+};
+
+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_token *security_token;
+
+       /* 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().
+        *
+        * Bottom line, it is not the same as the session keys in info3.
+        */
+
        DATA_BLOB user_session_key;
        DATA_BLOB lm_session_key;
 
-        char *login_server; /* which server authorized the login? */
-       
-       uint32 sam_fill_level;  /* How far is this structure filled? */
-       
-       SAM_ACCOUNT *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;
 
        char *unix_name;
-       
-} auth_serversupplied_info;
+
+       /*
+        * 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 {
        DATA_BLOB challenge; 
@@ -86,19 +81,18 @@ struct auth_context {
        /* Who set this up in the first place? */ 
        const char *challenge_set_by; 
 
-       BOOL challenge_may_be_modified;
+       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 (*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);
 };
 
 typedef struct auth_methods
@@ -110,7 +104,7 @@ typedef struct auth_methods
                         void *my_private_data, 
                         TALLOC_CTX *mem_ctx,
                         const struct auth_usersupplied_info *user_info, 
-                        auth_serversupplied_info **server_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
@@ -119,15 +113,9 @@ typedef struct auth_methods
        DATA_BLOB (*get_chal)(const struct auth_context *auth_context,
                              void **my_private_data, 
                              TALLOC_CTX *mem_ctx);
-       
+
        /* 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;
 
@@ -142,14 +130,10 @@ 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;
+struct auth_ntlmssp_state;
 
 /* 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
 
 #endif /* _SMBAUTH_H_ */