lib/param: Rename "socket address" to "nbt client socket address" to clarify role
[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 3 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, see <http://www.gnu.org/licenses/>.
20 */
21
22 #include "../auth/common_auth.h"
23
24 struct gensec_security;
25
26 struct extra_auth_info {
27         struct dom_sid user_sid;
28         struct dom_sid pgid_sid;
29 };
30
31 struct auth_serversupplied_info {
32         bool guest;
33         bool system;
34
35         struct security_unix_token utok;
36
37         /* NT group information taken from the info3 structure */
38
39         struct security_token *security_token;
40
41         /* These are the intermediate session keys, as provided by a
42          * NETLOGON server and used by NTLMSSP to negotiate key
43          * exchange etc (which will provide the session_key in the
44          * auth_session_info).  It is usually the same as the keys in
45          * the info3, but is a variable length structure here to allow
46          * it to be omitted if the auth module does not know it.
47          */
48
49         DATA_BLOB session_key;
50         DATA_BLOB lm_session_key;
51
52         struct netr_SamInfo3 *info3;
53
54         /* this structure is filled *only* in pathological cases where the user
55          * sid or the primary group sid are not sids of the domain. Normally
56          * this happens only for unix accounts that have unix domain sids.
57          * This is checked only when info3.rid and/or info3.primary_gid are set
58          * to the special invalid value of 0xFFFFFFFF */
59         struct extra_auth_info extra;
60
61         /*
62          * This is a token from /etc/passwd and /etc/group
63          */
64         bool nss_token;
65
66         char *unix_name;
67 };
68
69 typedef NTSTATUS (*prepare_gensec_fn)(TALLOC_CTX *mem_ctx,
70                                       struct gensec_security **gensec_context);
71
72 typedef NTSTATUS (*make_auth4_context_fn)(TALLOC_CTX *mem_ctx,
73                                           struct auth4_context **auth4_context);
74
75 struct auth_context {
76         DATA_BLOB challenge; 
77
78         /* Who set this up in the first place? */ 
79         const char *challenge_set_by; 
80
81         /* What order are the various methods in?   Try to stop it changing under us */ 
82         struct auth_methods *auth_method_list;  
83
84         prepare_gensec_fn prepare_gensec;
85         make_auth4_context_fn make_auth4_context;
86 };
87
88 typedef struct auth_methods
89 {
90         struct auth_methods *prev, *next;
91         const char *name; /* What name got this module */
92
93         NTSTATUS (*auth)(const struct auth_context *auth_context,
94                          void *my_private_data, 
95                          TALLOC_CTX *mem_ctx,
96                          const struct auth_usersupplied_info *user_info, 
97                          struct auth_serversupplied_info **server_info);
98
99         /* Optional methods allowing this module to provide a way to get a gensec context and an auth4_context */
100         prepare_gensec_fn prepare_gensec;
101         make_auth4_context_fn make_auth4_context;
102         /* Used to keep tabs on things like the cli for SMB server authentication */
103         void *private_data;
104
105 } auth_methods;
106
107 typedef NTSTATUS (*auth_init_function)(struct auth_context *, const char *, struct auth_methods **);
108
109 struct auth_init_function_entry {
110         const char *name;
111         /* Function to create a member of the authmethods list */
112
113         auth_init_function init;
114
115         struct auth_init_function_entry *prev, *next;
116 };
117
118 extern const struct gensec_security_ops gensec_ntlmssp3_server_ops;
119
120 /* Intent of use for session key. LSA and SAMR pipes use 16 bytes of session key when doing create/modify calls */
121 enum session_key_use_intent {
122         KEY_USE_FULL = 0,
123         KEY_USE_16BYTES
124 };
125
126 /* Changed from 1 -> 2 to add the logon_parameters field. */
127 /* Changed from 2 -> 3 when we reworked many auth structures to use IDL or be in common with Samba4 */
128 #define AUTH_INTERFACE_VERSION 3
129
130 #include "auth/proto.h"
131
132 #endif /* _SMBAUTH_H_ */