2 samba -- Unix SMB/CIFS implementation.
4 Client credentials structure
6 Copyright (C) Jelmer Vernooij 2004-2006
7 Copyright (C) Andrew Bartlett <abartlet@samba.org> 2005
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #ifndef __CREDENTIALS_H__
23 #define __CREDENTIALS_H__
25 #include "../lib/util/data_blob.h"
26 #include "librpc/gen_ndr/misc.h"
28 struct cli_credentials
;
29 struct ccache_container
;
30 struct tevent_context
;
31 struct netlogon_creds_CredentialState
;
34 struct loadparm_context
;
35 struct ccache_container
;
36 struct gssapi_creds_container
;
37 struct smb_krb5_context
;
38 struct keytab_container
;
41 /* In order of priority */
42 enum credentials_obtained
{
43 CRED_UNINITIALISED
= 0, /* We don't even have a guess yet */
44 CRED_CALLBACK
, /* Callback should be used to obtain value */
45 CRED_GUESS_ENV
, /* Current value should be used, which was guessed */
46 CRED_GUESS_FILE
, /* A guess from a file (or file pointed at in env variable) */
47 CRED_CALLBACK_RESULT
, /* Value was obtained from a callback */
48 CRED_SPECIFIED
/* Was explicitly specified on the command-line */
51 enum credentials_use_kerberos
{
52 CRED_AUTO_USE_KERBEROS
= 0, /* Default, we try kerberos if available */
53 CRED_DONT_USE_KERBEROS
, /* Sometimes trying kerberos just does 'bad things', so don't */
54 CRED_MUST_USE_KERBEROS
/* Sometimes administrators are parinoid, so always do kerberos */
57 enum credentials_krb_forwardable
{
58 CRED_AUTO_KRB_FORWARDABLE
= 0, /* Default, follow library defaults */
59 CRED_NO_KRB_FORWARDABLE
, /* not forwardable */
60 CRED_FORCE_KRB_FORWARDABLE
/* forwardable */
63 #define CLI_CRED_NTLM2 0x01
64 #define CLI_CRED_NTLMv2_AUTH 0x02
65 #define CLI_CRED_LANMAN_AUTH 0x04
66 #define CLI_CRED_NTLM_AUTH 0x08
67 #define CLI_CRED_CLEAR_AUTH 0x10 /* TODO: Push cleartext auth with this flag */
69 const char *cli_credentials_get_workstation(struct cli_credentials
*cred
);
70 bool cli_credentials_set_workstation(struct cli_credentials
*cred
,
72 enum credentials_obtained obtained
);
73 bool cli_credentials_is_anonymous(struct cli_credentials
*cred
);
74 struct cli_credentials
*cli_credentials_init(TALLOC_CTX
*mem_ctx
);
75 void cli_credentials_set_anonymous(struct cli_credentials
*cred
);
76 bool cli_credentials_wrong_password(struct cli_credentials
*cred
);
77 const char *cli_credentials_get_password(struct cli_credentials
*cred
);
78 void cli_credentials_get_ntlm_username_domain(struct cli_credentials
*cred
, TALLOC_CTX
*mem_ctx
,
79 const char **username
,
81 NTSTATUS
cli_credentials_get_ntlm_response(struct cli_credentials
*cred
, TALLOC_CTX
*mem_ctx
,
83 DATA_BLOB challenge
, DATA_BLOB target_info
,
84 DATA_BLOB
*_lm_response
, DATA_BLOB
*_nt_response
,
85 DATA_BLOB
*_lm_session_key
, DATA_BLOB
*_session_key
);
86 const char *cli_credentials_get_realm(struct cli_credentials
*cred
);
87 const char *cli_credentials_get_username(struct cli_credentials
*cred
);
88 int cli_credentials_get_krb5_context(struct cli_credentials
*cred
,
89 struct loadparm_context
*lp_ctx
,
90 struct smb_krb5_context
**smb_krb5_context
);
91 int cli_credentials_get_ccache(struct cli_credentials
*cred
,
92 struct tevent_context
*event_ctx
,
93 struct loadparm_context
*lp_ctx
,
94 struct ccache_container
**ccc
,
95 const char **error_string
);
96 int cli_credentials_get_named_ccache(struct cli_credentials
*cred
,
97 struct tevent_context
*event_ctx
,
98 struct loadparm_context
*lp_ctx
,
100 struct ccache_container
**ccc
, const char **error_string
);
101 bool cli_credentials_failed_kerberos_login(struct cli_credentials
*cred
,
102 const char *principal
,
103 unsigned int *count
);
104 int cli_credentials_get_keytab(struct cli_credentials
*cred
,
105 struct loadparm_context
*lp_ctx
,
106 struct keytab_container
**_ktc
);
107 const char *cli_credentials_get_domain(struct cli_credentials
*cred
);
108 struct netlogon_creds_CredentialState
*cli_credentials_get_netlogon_creds(struct cli_credentials
*cred
);
109 void cli_credentials_set_machine_account_pending(struct cli_credentials
*cred
,
110 struct loadparm_context
*lp_ctx
);
111 void cli_credentials_set_conf(struct cli_credentials
*cred
,
112 struct loadparm_context
*lp_ctx
);
113 const char *cli_credentials_get_principal(struct cli_credentials
*cred
, TALLOC_CTX
*mem_ctx
);
114 int cli_credentials_get_server_gss_creds(struct cli_credentials
*cred
,
115 struct loadparm_context
*lp_ctx
,
116 struct gssapi_creds_container
**_gcc
);
117 int cli_credentials_get_client_gss_creds(struct cli_credentials
*cred
,
118 struct tevent_context
*event_ctx
,
119 struct loadparm_context
*lp_ctx
,
120 struct gssapi_creds_container
**_gcc
,
121 const char **error_string
);
122 void cli_credentials_set_forced_sasl_mech(struct cli_credentials
*creds
,
123 const char *sasl_mech
);
124 void cli_credentials_set_kerberos_state(struct cli_credentials
*creds
,
125 enum credentials_use_kerberos use_kerberos
);
126 void cli_credentials_set_krb_forwardable(struct cli_credentials
*creds
,
127 enum credentials_krb_forwardable krb_forwardable
);
128 bool cli_credentials_set_domain(struct cli_credentials
*cred
,
130 enum credentials_obtained obtained
);
131 bool cli_credentials_set_domain_callback(struct cli_credentials
*cred
,
132 const char *(*domain_cb
) (struct cli_credentials
*));
133 bool cli_credentials_set_username(struct cli_credentials
*cred
,
134 const char *val
, enum credentials_obtained obtained
);
135 bool cli_credentials_set_username_callback(struct cli_credentials
*cred
,
136 const char *(*username_cb
) (struct cli_credentials
*));
137 bool cli_credentials_set_principal(struct cli_credentials
*cred
,
139 enum credentials_obtained obtained
);
140 bool cli_credentials_set_principal_callback(struct cli_credentials
*cred
,
141 const char *(*principal_cb
) (struct cli_credentials
*));
142 bool cli_credentials_set_password(struct cli_credentials
*cred
,
144 enum credentials_obtained obtained
);
145 struct cli_credentials
*cli_credentials_init_anon(TALLOC_CTX
*mem_ctx
);
146 void cli_credentials_parse_string(struct cli_credentials
*credentials
, const char *data
, enum credentials_obtained obtained
);
147 struct samr_Password
*cli_credentials_get_nt_hash(struct cli_credentials
*cred
,
148 TALLOC_CTX
*mem_ctx
);
149 struct samr_Password
*cli_credentials_get_old_nt_hash(struct cli_credentials
*cred
,
150 TALLOC_CTX
*mem_ctx
);
151 bool cli_credentials_set_realm(struct cli_credentials
*cred
,
153 enum credentials_obtained obtained
);
154 void cli_credentials_set_secure_channel_type(struct cli_credentials
*cred
,
155 enum netr_SchannelType secure_channel_type
);
156 void cli_credentials_set_password_last_changed_time(struct cli_credentials
*cred
,
157 time_t last_change_time
);
158 void cli_credentials_set_netlogon_creds(struct cli_credentials
*cred
,
159 struct netlogon_creds_CredentialState
*netlogon_creds
);
160 NTSTATUS
cli_credentials_set_krb5_context(struct cli_credentials
*cred
,
161 struct smb_krb5_context
*smb_krb5_context
);
162 NTSTATUS
cli_credentials_set_stored_principal(struct cli_credentials
*cred
,
163 struct loadparm_context
*lp_ctx
,
164 const char *serviceprincipal
);
165 NTSTATUS
cli_credentials_set_machine_account(struct cli_credentials
*cred
,
166 struct loadparm_context
*lp_ctx
);
168 * Fill in credentials for the machine trust account, from the
169 * secrets.ldb or passed in handle to secrets.tdb (perhaps in CTDB).
171 * This version is used in parts of the code that can link in the
172 * CTDB dbwrap backend, by passing down the already open handle.
174 * @param cred Credentials structure to fill in
175 * @param db_ctx dbwrap context for secrets.tdb
176 * @retval NTSTATUS error detailing any failure
178 NTSTATUS
cli_credentials_set_machine_account_db_ctx(struct cli_credentials
*cred
,
179 struct loadparm_context
*lp_ctx
,
180 struct db_context
*db_ctx
);
182 bool cli_credentials_authentication_requested(struct cli_credentials
*cred
);
183 void cli_credentials_guess(struct cli_credentials
*cred
,
184 struct loadparm_context
*lp_ctx
);
185 bool cli_credentials_set_bind_dn(struct cli_credentials
*cred
,
186 const char *bind_dn
);
187 const char *cli_credentials_get_bind_dn(struct cli_credentials
*cred
);
188 bool cli_credentials_parse_file(struct cli_credentials
*cred
, const char *file
, enum credentials_obtained obtained
);
189 const char *cli_credentials_get_unparsed_name(struct cli_credentials
*credentials
, TALLOC_CTX
*mem_ctx
);
190 bool cli_credentials_set_password_callback(struct cli_credentials
*cred
,
191 const char *(*password_cb
) (struct cli_credentials
*));
192 enum netr_SchannelType
cli_credentials_get_secure_channel_type(struct cli_credentials
*cred
);
193 time_t cli_credentials_get_password_last_changed_time(struct cli_credentials
*cred
);
194 void cli_credentials_set_kvno(struct cli_credentials
*cred
,
196 bool cli_credentials_set_utf16_password(struct cli_credentials
*cred
,
197 const DATA_BLOB
*password_utf16
,
198 enum credentials_obtained obtained
);
199 bool cli_credentials_set_old_utf16_password(struct cli_credentials
*cred
,
200 const DATA_BLOB
*password_utf16
);
201 bool cli_credentials_set_nt_hash(struct cli_credentials
*cred
,
202 const struct samr_Password
*nt_hash
,
203 enum credentials_obtained obtained
);
204 bool cli_credentials_set_old_nt_hash(struct cli_credentials
*cred
,
205 const struct samr_Password
*nt_hash
);
206 bool cli_credentials_set_ntlm_response(struct cli_credentials
*cred
,
207 const DATA_BLOB
*lm_response
,
208 const DATA_BLOB
*nt_response
,
209 enum credentials_obtained obtained
);
210 int cli_credentials_set_keytab_name(struct cli_credentials
*cred
,
211 struct loadparm_context
*lp_ctx
,
212 const char *keytab_name
,
213 enum credentials_obtained obtained
);
214 void cli_credentials_set_gensec_features(struct cli_credentials
*creds
, uint32_t gensec_features
);
215 uint32_t cli_credentials_get_gensec_features(struct cli_credentials
*creds
);
216 int cli_credentials_set_ccache(struct cli_credentials
*cred
,
217 struct loadparm_context
*lp_ctx
,
219 enum credentials_obtained obtained
,
220 const char **error_string
);
221 bool cli_credentials_parse_password_file(struct cli_credentials
*credentials
, const char *file
, enum credentials_obtained obtained
);
222 bool cli_credentials_parse_password_fd(struct cli_credentials
*credentials
,
223 int fd
, enum credentials_obtained obtained
);
224 void cli_credentials_invalidate_ccache(struct cli_credentials
*cred
,
225 enum credentials_obtained obtained
);
226 void cli_credentials_set_salt_principal(struct cli_credentials
*cred
, const char *principal
);
227 void cli_credentials_set_impersonate_principal(struct cli_credentials
*cred
,
228 const char *principal
,
229 const char *self_service
);
230 void cli_credentials_set_target_service(struct cli_credentials
*cred
, const char *principal
);
231 const char *cli_credentials_get_salt_principal(struct cli_credentials
*cred
);
232 const char *cli_credentials_get_impersonate_principal(struct cli_credentials
*cred
);
233 const char *cli_credentials_get_self_service(struct cli_credentials
*cred
);
234 const char *cli_credentials_get_target_service(struct cli_credentials
*cred
);
235 enum credentials_use_kerberos
cli_credentials_get_kerberos_state(struct cli_credentials
*creds
);
236 const char *cli_credentials_get_forced_sasl_mech(struct cli_credentials
*cred
);
237 enum credentials_krb_forwardable
cli_credentials_get_krb_forwardable(struct cli_credentials
*creds
);
238 NTSTATUS
cli_credentials_set_secrets(struct cli_credentials
*cred
,
239 struct loadparm_context
*lp_ctx
,
240 struct ldb_context
*ldb
,
243 char **error_string
);
244 int cli_credentials_get_kvno(struct cli_credentials
*cred
);
246 bool cli_credentials_set_username_callback(struct cli_credentials
*cred
,
247 const char *(*username_cb
) (struct cli_credentials
*));
250 * Obtain the client principal for this credentials context.
251 * @param cred credentials context
252 * @retval The username set on this context.
253 * @note Return value will never be NULL except by programmer error.
255 const char *cli_credentials_get_principal_and_obtained(struct cli_credentials
*cred
, TALLOC_CTX
*mem_ctx
, enum credentials_obtained
*obtained
);
256 bool cli_credentials_set_principal(struct cli_credentials
*cred
,
258 enum credentials_obtained obtained
);
259 bool cli_credentials_set_principal_callback(struct cli_credentials
*cred
,
260 const char *(*principal_cb
) (struct cli_credentials
*));
263 * Obtain the 'old' password for this credentials context (used for join accounts).
264 * @param cred credentials context
265 * @retval If set, the cleartext password, otherwise NULL
267 const char *cli_credentials_get_old_password(struct cli_credentials
*cred
);
268 bool cli_credentials_set_old_password(struct cli_credentials
*cred
,
270 enum credentials_obtained obtained
);
271 bool cli_credentials_set_domain_callback(struct cli_credentials
*cred
,
272 const char *(*domain_cb
) (struct cli_credentials
*));
273 bool cli_credentials_set_realm_callback(struct cli_credentials
*cred
,
274 const char *(*realm_cb
) (struct cli_credentials
*));
275 bool cli_credentials_set_workstation_callback(struct cli_credentials
*cred
,
276 const char *(*workstation_cb
) (struct cli_credentials
*));
278 void cli_credentials_set_callback_data(struct cli_credentials
*cred
,
279 void *callback_data
);
280 void *_cli_credentials_callback_data(struct cli_credentials
*cred
);
281 #define cli_credentials_callback_data(_cred, _type) \
282 talloc_get_type_abort(_cli_credentials_callback_data(_cred), _type)
283 #define cli_credentials_callback_data_void(_cred) \
284 _cli_credentials_callback_data(_cred)
286 struct cli_credentials
*cli_credentials_shallow_copy(TALLOC_CTX
*mem_ctx
,
287 struct cli_credentials
*src
);
290 * Return attached NETLOGON credentials
292 struct netlogon_creds_CredentialState
*cli_credentials_get_netlogon_creds(struct cli_credentials
*cred
);
294 #endif /* __CREDENTIALS_H__ */