This commit was manufactured by cvs2svn to create branch 'SAMBA_3_0'.(This used to...
[kai/samba.git] / source3 / include / auth.h
1 #ifndef _SMBAUTH_H_
2 #define _SMBAUTH_H_
3 /* 
4    Unix SMB/CIFS implementation.
5    Standardised Authentication types
6    Copyright (C) Andrew Bartlett 2001
7    
8    This program is free software; you can redistribute it and/or modify
9    it under the terms of the GNU General Public License as published by
10    the Free Software Foundation; either version 2 of the License, or
11    (at your option) any later version.
12    
13    This program is distributed in the hope that it will be useful,
14    but WITHOUT ANY WARRANTY; without even the implied warranty of
15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16    GNU General Public License for more details.
17    
18    You should have received a copy of the GNU General Public License
19    along with this program; if not, write to the Free Software
20    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 */
22
23 /* AUTH_STR - string */
24 typedef struct normal_string
25 {
26         int len;
27         char *str;
28 } AUTH_STR;
29
30 /* AUTH_UNISTR - unicode string or buffer */
31 typedef struct unicode_string
32 {
33         int len;
34         uchar *unistr;
35 } AUTH_UNISTR;
36
37 typedef struct interactive_password
38 {
39         OWF_INFO          lm_owf;              /* LM OWF Password */
40         OWF_INFO          nt_owf;              /* NT OWF Password */
41 } auth_interactive_password;
42
43 #define AUTH_FLAG_NONE        0x000000
44 #define AUTH_FLAG_PLAINTEXT   0x000001
45 #define AUTH_FLAG_LM_RESP     0x000002
46 #define AUTH_FLAG_NTLM_RESP   0x000004
47 #define AUTH_FLAG_NTLMv2_RESP 0x000008
48
49 typedef struct auth_usersupplied_info
50 {
51         
52         DATA_BLOB lm_resp;
53         DATA_BLOB nt_resp;
54         auth_interactive_password * interactive_password;
55         DATA_BLOB plaintext_password;
56         
57         BOOL encrypted;
58         
59         uint32 auth_flags;
60
61         AUTH_STR           client_domain;          /* domain name string */
62         AUTH_STR           domain;               /* domain name after mapping */
63         AUTH_STR           internal_username;    /* username after mapping */
64         AUTH_STR           smb_name;        /* username before mapping */
65         AUTH_STR           wksta_name;           /* workstation name (netbios calling name) unicode string */
66         
67 } auth_usersupplied_info;
68
69 #define SAM_FILL_NAME  0x01
70 #define SAM_FILL_INFO3 0x02
71 #define SAM_FILL_SAM   0x04
72 #define SAM_FILL_UNIX  0x08
73 #define SAM_FILL_ALL (SAM_FILL_NAME | SAM_FILL_INFO3 | SAM_FILL_SAM | SAM_FILL_UNIX)
74
75 typedef struct auth_serversupplied_info 
76 {
77         BOOL guest;
78         
79         /* This groups info is needed for when we become_user() for this uid */
80         int n_groups;
81         gid_t *groups;
82         
83         /* NT group information taken from the info3 structure */
84         
85         NT_USER_TOKEN *ptok;
86         
87         uint8 session_key[16];
88         
89         uint8 first_8_lm_hash[8];
90
91         uint32 sam_fill_level;  /* How far is this structure filled? */
92         
93         SAM_ACCOUNT *sam_account;
94         
95         void *pam_handle;
96         
97 } auth_serversupplied_info;
98
99 struct auth_context {
100         DATA_BLOB challenge; 
101
102         /* Who set this up in the first place? */ 
103         const char *challenge_set_by; 
104
105         struct auth_methods *challenge_set_method; 
106         /* What order are the various methods in?   Try to stop it changing under us */ 
107         struct auth_methods *auth_method_list;  
108
109         TALLOC_CTX *mem_ctx;
110         const uint8 *(*get_ntlm_challenge)(struct auth_context *auth_context);
111         NTSTATUS (*check_ntlm_password)(const struct auth_context *auth_context,
112                                         const struct auth_usersupplied_info *user_info, 
113                                         struct auth_serversupplied_info **server_info);
114         NTSTATUS (*nt_status_squash)(NTSTATUS nt_status);
115         void (*free)(struct auth_context **auth_context);
116 };
117
118 typedef struct auth_methods
119 {
120         struct auth_methods *prev, *next;
121         const char *name; /* What name got this module */
122
123         NTSTATUS (*auth)(const struct auth_context *auth_context,
124                          void *my_private_data, 
125                          TALLOC_CTX *mem_ctx,
126                          const struct auth_usersupplied_info *user_info, 
127                          auth_serversupplied_info **server_info);
128
129         DATA_BLOB (*get_chal)(const struct auth_context *auth_context,
130                               void **my_private_data, 
131                               TALLOC_CTX *mem_ctx);
132         
133         /* Used to keep tabs on things like the cli for SMB server authentication */
134         void *private_data;
135         
136         /* Function to clean up the above arbitary structure */
137         void (*free_private_data)(void **private_data);
138
139         /* Function to send a keepalive message on the above structure */
140         void (*send_keepalive)(void **private_data);
141
142 } auth_methods;
143
144 typedef NTSTATUS (*auth_init_function)(struct auth_context *, const char *, struct auth_methods **);
145
146 struct auth_init_function_entry {
147         const char *name;
148         /* Function to create a member of the authmethods list */
149
150         auth_init_function init;
151 };
152
153 typedef struct auth_ntlmssp_state
154 {
155         TALLOC_CTX *mem_ctx;
156         struct auth_context *auth_context;
157         struct auth_serversupplied_info *server_info;
158         struct ntlmssp_state *ntlmssp_state;
159 } AUTH_NTLMSSP_STATE;
160
161 #endif /* _SMBAUTH_H_ */