caab230a46ed6dcb13ba3b9210d89f6481d8ecb5
[amitay/samba.git] / source4 / auth / auth.h
1 /*
2    Unix SMB/CIFS implementation.
3    Standardised Authentication types
4    Copyright (C) Andrew Bartlett   2001
5    Copyright (C) Stefan Metzmacher 2005
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 3 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    You should have received a copy of the GNU General Public License
18    along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 */
20
21 #ifndef _SAMBA_AUTH_H
22 #define _SAMBA_AUTH_H
23
24 #include "librpc/gen_ndr/ndr_krb5pac.h"
25 #include "librpc/gen_ndr/auth.h"
26 #include "../auth/common_auth.h"
27
28 extern const char *krbtgt_attrs[];
29 extern const char *server_attrs[];
30 extern const char *user_attrs[];
31
32 union netr_Validation;
33 struct netr_SamBaseInfo;
34 struct netr_SamInfo3;
35 struct loadparm_context;
36
37 /* modules can use the following to determine if the interface has changed
38  * please increment the version number after each interface change
39  * with a comment and maybe update struct auth_critical_sizes.
40  */
41 /* version 1 - version from samba 3.0 - metze */
42 /* version 2 - initial samba4 version - metze */
43 /* version 3 - subsequent samba4 version - abartlet */
44 /* version 4 - subsequent samba4 version - metze */
45 /* version 0 - till samba4 is stable - metze */
46 #define AUTH4_INTERFACE_VERSION 0
47
48 #define AUTH_SESSION_INFO_DEFAULT_GROUPS     0x01 /* Add the user to the default world and network groups */
49 #define AUTH_SESSION_INFO_AUTHENTICATED      0x02 /* Add the user to the 'authenticated users' group */
50 #define AUTH_SESSION_INFO_SIMPLE_PRIVILEGES  0x04 /* Use a trivial map between users and privilages, rather than a DB */
51 #define AUTH_SESSION_INFO_UNIX_TOKEN         0x08 /* The returned token must have the unix_token and unix_info elements provided */
52
53 struct auth_method_context;
54 struct auth_check_password_request;
55 struct auth4_context;
56 struct auth_session_info;
57 struct ldb_dn;
58
59 struct auth_operations {
60         const char *name;
61
62         /* If you are using this interface, then you are probably
63          * getting something wrong.  This interface is only for
64          * security=server, and makes a number of compromises to allow
65          * that.  It is not compatible with being a PDC.  */
66
67         NTSTATUS (*get_challenge)(struct auth_method_context *ctx, TALLOC_CTX *mem_ctx, uint8_t chal[8]);
68
69         /* Given the user supplied info, check if this backend want to handle the password checking */
70
71         NTSTATUS (*want_check)(struct auth_method_context *ctx, TALLOC_CTX *mem_ctx,
72                                const struct auth_usersupplied_info *user_info);
73
74         /* Given the user supplied info, check a password */
75
76         NTSTATUS (*check_password)(struct auth_method_context *ctx, TALLOC_CTX *mem_ctx,
77                                    const struct auth_usersupplied_info *user_info,
78                                    struct auth_user_info_dc **interim_info);
79
80         /* Lookup a 'session info interim' return based only on the principal or DN */
81         NTSTATUS (*get_user_info_dc_principal)(TALLOC_CTX *mem_ctx,
82                                                        struct auth4_context *auth_context,
83                                                        const char *principal,
84                                                        struct ldb_dn *user_dn,
85                                                        struct auth_user_info_dc **interim_info);
86 };
87
88 struct auth_method_context {
89         struct auth_method_context *prev, *next;
90         struct auth4_context *auth_ctx;
91         const struct auth_operations *ops;
92         int depth;
93         void *private_data;
94 };
95
96 struct auth4_context {
97         struct {
98                 /* Who set this up in the first place? */
99                 const char *set_by;
100
101                 bool may_be_modified;
102
103                 DATA_BLOB data;
104         } challenge;
105
106         /* methods, in the order they should be called */
107         struct auth_method_context *methods;
108
109         /* the event context to use for calls that can block */
110         struct tevent_context *event_ctx;
111
112         /* the messaging context which can be used by backends */
113         struct imessaging_context *msg_ctx;
114
115         /* loadparm context */
116         struct loadparm_context *lp_ctx;
117
118         /* SAM database for this local machine - to fill in local groups, or to authenticate local NTLM users */
119         struct ldb_context *sam_ctx;
120
121         NTSTATUS (*check_password)(struct auth4_context *auth_ctx,
122                                    TALLOC_CTX *mem_ctx,
123                                    const struct auth_usersupplied_info *user_info,
124                                    struct auth_user_info_dc **user_info_dc);
125
126         NTSTATUS (*get_challenge)(struct auth4_context *auth_ctx, uint8_t chal[8]);
127
128         bool (*challenge_may_be_modified)(struct auth4_context *auth_ctx);
129
130         NTSTATUS (*set_challenge)(struct auth4_context *auth_ctx, const uint8_t chal[8], const char *set_by);
131
132         NTSTATUS (*get_user_info_dc_principal)(TALLOC_CTX *mem_ctx,
133                                                        struct auth4_context *auth_ctx,
134                                                        const char *principal,
135                                                        struct ldb_dn *user_dn,
136                                                        struct auth_user_info_dc **user_info_dc);
137
138         NTSTATUS (*generate_session_info)(TALLOC_CTX *mem_ctx,
139                                           struct auth4_context *auth_context,
140                                           struct auth_user_info_dc *user_info_dc,
141                                           uint32_t session_info_flags,
142                                           struct auth_session_info **session_info);
143 };
144
145 /* this structure is used by backends to determine the size of some critical types */
146 struct auth_critical_sizes {
147         int interface_version;
148         int sizeof_auth_operations;
149         int sizeof_auth_methods;
150         int sizeof_auth_context;
151         int sizeof_auth_usersupplied_info;
152         int sizeof_auth_user_info_dc;
153 };
154
155  NTSTATUS encrypt_user_info(TALLOC_CTX *mem_ctx, struct auth4_context *auth_context,
156                            enum auth_password_state to_state,
157                            const struct auth_usersupplied_info *user_info_in,
158                            const struct auth_usersupplied_info **user_info_encrypted);
159
160 #include "auth/session.h"
161 #include "auth/system_session_proto.h"
162 #include "libcli/security/security.h"
163
164 struct ldb_message;
165 struct ldb_context;
166 struct gensec_security;
167 struct cli_credentials;
168
169 NTSTATUS auth_get_challenge(struct auth4_context *auth_ctx, uint8_t chal[8]);
170 NTSTATUS authsam_account_ok(TALLOC_CTX *mem_ctx,
171                             struct ldb_context *sam_ctx,
172                             uint32_t logon_parameters,
173                             struct ldb_dn *domain_dn,
174                             struct ldb_message *msg,
175                             const char *logon_workstation,
176                             const char *name_for_logs,
177                             bool allow_domain_trust,
178                             bool password_change);
179
180 struct auth_session_info *system_session(struct loadparm_context *lp_ctx);
181 NTSTATUS authsam_make_user_info_dc(TALLOC_CTX *mem_ctx, struct ldb_context *sam_ctx,
182                                            const char *netbios_name,
183                                            const char *domain_name,
184                                            struct ldb_dn *domain_dn,
185                                            struct ldb_message *msg,
186                                            DATA_BLOB user_sess_key, DATA_BLOB lm_sess_key,
187                                   struct auth_user_info_dc **_user_info_dc);
188 NTSTATUS auth_system_session_info(TALLOC_CTX *parent_ctx,
189                                            struct loadparm_context *lp_ctx,
190                                            struct auth_session_info **_session_info) ;
191
192 NTSTATUS auth_context_create_methods(TALLOC_CTX *mem_ctx, const char **methods,
193                                      struct tevent_context *ev,
194                                      struct imessaging_context *msg,
195                                      struct loadparm_context *lp_ctx,
196                                      struct ldb_context *sam_ctx,
197                                      struct auth4_context **auth_ctx);
198 const char **auth_methods_from_lp(TALLOC_CTX *mem_ctx, struct loadparm_context *lp_ctx);
199
200 NTSTATUS auth_context_create(TALLOC_CTX *mem_ctx,
201                              struct tevent_context *ev,
202                              struct imessaging_context *msg,
203                              struct loadparm_context *lp_ctx,
204                              struct auth4_context **auth_ctx);
205 NTSTATUS auth_context_create_from_ldb(TALLOC_CTX *mem_ctx, struct ldb_context *ldb, struct auth4_context **auth_ctx);
206
207 NTSTATUS auth_check_password(struct auth4_context *auth_ctx,
208                              TALLOC_CTX *mem_ctx,
209                              const struct auth_usersupplied_info *user_info,
210                              struct auth_user_info_dc **user_info_dc);
211 NTSTATUS auth4_init(void);
212 NTSTATUS auth_register(const struct auth_operations *ops);
213 NTSTATUS server_service_auth_init(void);
214 NTSTATUS authenticate_username_pw(TALLOC_CTX *mem_ctx,
215                                   struct tevent_context *ev,
216                                   struct imessaging_context *msg,
217                                   struct loadparm_context *lp_ctx,
218                                   const char *nt4_domain,
219                                   const char *nt4_username,
220                                   const char *password,
221                                   const uint32_t logon_parameters,
222                                   struct auth_session_info **session_info);
223
224 struct tevent_req *auth_check_password_send(TALLOC_CTX *mem_ctx,
225                                             struct tevent_context *ev,
226                                             struct auth4_context *auth_ctx,
227                                             const struct auth_usersupplied_info *user_info);
228 NTSTATUS auth_check_password_recv(struct tevent_req *req,
229                                   TALLOC_CTX *mem_ctx,
230                                   struct auth_user_info_dc **user_info_dc);
231
232 bool auth_challenge_may_be_modified(struct auth4_context *auth_ctx);
233 NTSTATUS auth_context_set_challenge(struct auth4_context *auth_ctx, const uint8_t chal[8], const char *set_by);
234
235 NTSTATUS auth_get_user_info_dc_principal(TALLOC_CTX *mem_ctx,
236                                         struct auth4_context *auth_ctx,
237                                         const char *principal,
238                                         struct ldb_dn *user_dn,
239                                         struct auth_user_info_dc **user_info_dc);
240
241 NTSTATUS samba_server_gensec_start(TALLOC_CTX *mem_ctx,
242                                    struct tevent_context *event_ctx,
243                                    struct imessaging_context *msg_ctx,
244                                    struct loadparm_context *lp_ctx,
245                                    struct cli_credentials *server_credentials,
246                                    const char *target_service,
247                                    struct gensec_security **gensec_context);
248
249 #endif /* _SMBAUTH_H_ */