smbd: Use leases_db in lease_match()
[gd/samba-autobuild/.git] / auth / common_auth.h
1 /*
2    Unix SMB/CIFS implementation.
3    Standardised Authentication types
4    Copyright (C) Andrew Bartlett 2001-2010
5
6    This program is free software; you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 3 of the License, or
9    (at your option) any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
18 */
19
20 #ifndef AUTH_COMMON_AUTH_H
21 #define AUTH_COMMON_AUTH_H
22
23 #include "librpc/gen_ndr/auth.h"
24
25 #define USER_INFO_CASE_INSENSITIVE_USERNAME 0x01 /* username may be in any case */
26 #define USER_INFO_CASE_INSENSITIVE_PASSWORD 0x02 /* password may be in any case */
27 #define USER_INFO_DONT_CHECK_UNIX_ACCOUNT   0x04 /* don't check unix account status */
28 #define USER_INFO_INTERACTIVE_LOGON         0x08 /* Interactive logon */
29 /*unused #define USER_INFO_LOCAL_SAM_ONLY   0x10    Only authenticate against the local SAM, do not map missing passwords to NO_SUCH_USER */
30 #define USER_INFO_INFO3_AND_NO_AUTHZ        0x20 /* Only fill in server_info->info3 and do not do any authorization steps */
31
32 enum auth_password_state {
33         AUTH_PASSWORD_PLAIN = 1,
34         AUTH_PASSWORD_HASH = 2,
35         AUTH_PASSWORD_RESPONSE = 3
36 };
37
38 #define AUTH_SESSION_INFO_DEFAULT_GROUPS     0x01 /* Add the user to the default world and network groups */
39 #define AUTH_SESSION_INFO_AUTHENTICATED      0x02 /* Add the user to the 'authenticated users' group */
40 #define AUTH_SESSION_INFO_SIMPLE_PRIVILEGES  0x04 /* Use a trivial map between users and privilages, rather than a DB */
41 #define AUTH_SESSION_INFO_UNIX_TOKEN         0x08 /* The returned token must have the unix_token and unix_info elements provided */
42 #define AUTH_SESSION_INFO_NTLM               0x10 /* The returned token must have authenticated-with-NTLM flag set */
43
44 struct auth_usersupplied_info
45 {
46         const char *workstation_name;
47         const struct tsocket_address *remote_host;
48         const struct tsocket_address *local_host;
49
50         uint32_t logon_parameters;
51
52         bool mapped_state;
53         bool was_mapped;
54         uint64_t logon_id;
55         /* the values the client gives us */
56         struct {
57                 const char *account_name;
58                 const char *domain_name;
59         } client, mapped;
60
61         enum auth_password_state password_state;
62
63         struct {
64                 struct {
65                         DATA_BLOB lanman;
66                         DATA_BLOB nt;
67                 } response;
68                 struct {
69                         struct samr_Password *lanman;
70                         struct samr_Password *nt;
71                 } hash;
72
73                 char *plaintext;
74         } password;
75         uint32_t flags;
76
77         struct {
78                 uint32_t negotiate_flags;
79                 enum netr_SchannelType secure_channel_type;
80                 const char *computer_name; /* [charset(UTF8)] */
81                 const char *account_name; /* [charset(UTF8)] */
82                 struct dom_sid *sid; /* [unique] */
83         } netlogon_trust_account;
84
85         const char *service_description;
86         const char *auth_description;
87
88         /*
89          * for logging only, normally worked out from the password but
90          * for krb5 logging only (krb5 normally doesn't use this) we
91          * record the enc type here
92          */
93         const char *password_type;
94 };
95
96 struct auth_method_context;
97 struct tevent_context;
98 struct imessaging_context;
99 struct loadparm_context;
100 struct ldb_context;
101 struct smb_krb5_context;
102
103 struct auth4_context {
104         struct {
105                 /* Who set this up in the first place? */
106                 const char *set_by;
107
108                 DATA_BLOB data;
109         } challenge;
110
111         /* methods, in the order they should be called */
112         struct auth_method_context *methods;
113
114         /* the event context to use for calls that can block */
115         struct tevent_context *event_ctx;
116
117         /* the messaging context which can be used by backends */
118         struct imessaging_context *msg_ctx;
119
120         /* loadparm context */
121         struct loadparm_context *lp_ctx;
122
123         /* SAM database for this local machine - to fill in local groups, or to authenticate local NTLM users */
124         struct ldb_context *sam_ctx;
125
126         /* The time this authentication started */
127         struct timeval start_time;
128
129         /* Private data for the callbacks on this auth context */
130         void *private_data;
131
132         NTSTATUS (*check_ntlm_password)(struct auth4_context *auth_ctx,
133                                         TALLOC_CTX *mem_ctx,
134                                         const struct auth_usersupplied_info *user_info,
135                                         uint8_t *pauthoritative,
136                                         void **server_returned_info,
137                                         DATA_BLOB *nt_session_key, DATA_BLOB *lm_session_key);
138         struct tevent_req *(*check_ntlm_password_send)(TALLOC_CTX *mem_ctx,
139                                         struct tevent_context *ev,
140                                         struct auth4_context *auth_ctx,
141                                         const struct auth_usersupplied_info *user_info);
142         NTSTATUS (*check_ntlm_password_recv)(struct tevent_req *req,
143                                         TALLOC_CTX *mem_ctx,
144                                         uint8_t *pauthoritative,
145                                         void **server_returned_info,
146                                         DATA_BLOB *nt_session_key,
147                                         DATA_BLOB *lm_session_key);
148
149         NTSTATUS (*get_ntlm_challenge)(struct auth4_context *auth_ctx, uint8_t chal[8]);
150
151         NTSTATUS (*set_ntlm_challenge)(struct auth4_context *auth_ctx, const uint8_t chal[8], const char *set_by);
152
153         NTSTATUS (*generate_session_info)(struct auth4_context *auth_context,
154                                           TALLOC_CTX *mem_ctx,
155                                           void *server_returned_info,
156                                           const char *original_user_name,
157                                           uint32_t session_info_flags,
158                                           struct auth_session_info **session_info);
159
160         NTSTATUS (*generate_session_info_pac)(struct auth4_context *auth_ctx,
161                                               TALLOC_CTX *mem_ctx,
162                                               struct smb_krb5_context *smb_krb5_context,
163                                               DATA_BLOB *pac_blob,
164                                               const char *principal_name,
165                                               const struct tsocket_address *remote_address,
166                                               uint32_t session_info_flags,
167                                               struct auth_session_info **session_info);
168 };
169
170 #define AUTHZ_TRANSPORT_PROTECTION_NONE "NONE"
171 #define AUTHZ_TRANSPORT_PROTECTION_SMB "SMB"
172 #define AUTHZ_TRANSPORT_PROTECTION_TLS "TLS"
173 #define AUTHZ_TRANSPORT_PROTECTION_SEAL "SEAL"
174 #define AUTHZ_TRANSPORT_PROTECTION_SIGN "SIGN"
175
176 /*
177  * Log details of an authentication attempt.
178  * Successful and unsuccessful attempts are logged.
179  *
180  * NOTE: msg_ctx and lp_ctx is optional, but when supplied allows streaming the
181  * authentication events over the message bus.
182  */
183 void log_authentication_event(struct imessaging_context *msg_ctx,
184                               struct loadparm_context *lp_ctx,
185                               const struct timeval *start_time,
186                               const struct auth_usersupplied_info *ui,
187                               NTSTATUS status,
188                               const char *account_name,
189                               const char *domain_name,
190                               const char *unix_username,
191                               struct dom_sid *sid);
192
193 /*
194  * Log details of a successful authorization to a service.
195  *
196  * Only successful authorizations are logged.  For clarity:
197  * - NTLM bad passwords will be recorded by log_authentication_event
198  * - Kerberos decrypt failures need to be logged in gensec_gssapi et al
199  *
200  * The service may later refuse authorization due to an ACL.
201  *
202  *
203  * NOTE: msg_ctx and lp_ctx is optional, but when supplied allows streaming the
204  * authorization events over the message bus.
205  */
206 void log_successful_authz_event(struct imessaging_context *msg_ctx,
207                                 struct loadparm_context *lp_ctx,
208                                 const struct tsocket_address *remote,
209                                 const struct tsocket_address *local,
210                                 const char *service_description,
211                                 const char *auth_type,
212                                 const char *transport_protection,
213                                 struct auth_session_info *session_info);
214 #endif