2 Unix SMB/CIFS implementation.
3 Standardised Authentication types
4 Copyright (C) Andrew Bartlett 2001-2010
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.
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.
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/>.
20 #ifndef AUTH_COMMON_AUTH_H
21 #define AUTH_COMMON_AUTH_H
23 #include "librpc/gen_ndr/auth.h"
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 */
32 enum auth_password_state
{
33 AUTH_PASSWORD_PLAIN
= 1,
34 AUTH_PASSWORD_HASH
= 2,
35 AUTH_PASSWORD_RESPONSE
= 3
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 */
44 struct auth_usersupplied_info
46 const char *workstation_name
;
47 const struct tsocket_address
*remote_host
;
48 const struct tsocket_address
*local_host
;
50 uint32_t logon_parameters
;
55 /* the values the client gives us */
57 const char *account_name
;
58 const char *domain_name
;
61 enum auth_password_state password_state
;
69 struct samr_Password
*lanman
;
70 struct samr_Password
*nt
;
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
;
85 const char *service_description
;
86 const char *auth_description
;
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
93 const char *password_type
;
96 struct auth_method_context
;
97 struct tevent_context
;
98 struct imessaging_context
;
99 struct loadparm_context
;
101 struct smb_krb5_context
;
103 struct auth4_context
{
105 /* Who set this up in the first place? */
111 /* methods, in the order they should be called */
112 struct auth_method_context
*methods
;
114 /* the event context to use for calls that can block */
115 struct tevent_context
*event_ctx
;
117 /* the messaging context which can be used by backends */
118 struct imessaging_context
*msg_ctx
;
120 /* loadparm context */
121 struct loadparm_context
*lp_ctx
;
123 /* SAM database for this local machine - to fill in local groups, or to authenticate local NTLM users */
124 struct ldb_context
*sam_ctx
;
126 /* The time this authentication started */
127 struct timeval start_time
;
129 /* Private data for the callbacks on this auth context */
132 NTSTATUS (*check_ntlm_password
)(struct auth4_context
*auth_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
,
144 uint8_t *pauthoritative
,
145 void **server_returned_info
,
146 DATA_BLOB
*nt_session_key
,
147 DATA_BLOB
*lm_session_key
);
149 NTSTATUS (*get_ntlm_challenge
)(struct auth4_context
*auth_ctx
, uint8_t chal
[8]);
151 NTSTATUS (*set_ntlm_challenge
)(struct auth4_context
*auth_ctx
, const uint8_t chal
[8], const char *set_by
);
153 NTSTATUS (*generate_session_info
)(struct auth4_context
*auth_context
,
155 void *server_returned_info
,
156 const char *original_user_name
,
157 uint32_t session_info_flags
,
158 struct auth_session_info
**session_info
);
160 NTSTATUS (*generate_session_info_pac
)(struct auth4_context
*auth_ctx
,
162 struct smb_krb5_context
*smb_krb5_context
,
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
);
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"
177 * Log details of an authentication attempt.
178 * Successful and unsuccessful attempts are logged.
180 * NOTE: msg_ctx and lp_ctx is optional, but when supplied allows streaming the
181 * authentication events over the message bus.
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
,
188 const char *account_name
,
189 const char *domain_name
,
190 const char *unix_username
,
191 struct dom_sid
*sid
);
194 * Log details of a successful authorization to a service.
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
200 * The service may later refuse authorization due to an ACL.
203 * NOTE: msg_ctx and lp_ctx is optional, but when supplied allows streaming the
204 * authorization events over the message bus.
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
);