2 Unix SMB/CIFS implementation.
4 User credentials handling
6 Copyright (C) Jelmer Vernooij 2005
7 Copyright (C) Tim Potter 2001
8 Copyright (C) Andrew Bartlett <abartlet@samba.org> 2005
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>.
25 #include "librpc/gen_ndr/samr.h" /* for struct samrPassword */
26 #include "auth/credentials/credentials.h"
27 #include "auth/credentials/credentials_krb5.h"
28 #include "libcli/auth/libcli_auth.h"
29 #include "lib/events/events.h"
30 #include "param/param.h"
33 * Create a new credentials structure
34 * @param mem_ctx TALLOC_CTX parent for credentials structure
36 _PUBLIC_ struct cli_credentials *cli_credentials_init(TALLOC_CTX *mem_ctx)
38 struct cli_credentials *cred = talloc(mem_ctx, struct cli_credentials);
43 cred->netlogon_creds = NULL;
44 cred->machine_account_pending = false;
45 cred->workstation_obtained = CRED_UNINITIALISED;
46 cred->username_obtained = CRED_UNINITIALISED;
47 cred->password_obtained = CRED_UNINITIALISED;
48 cred->domain_obtained = CRED_UNINITIALISED;
49 cred->realm_obtained = CRED_UNINITIALISED;
50 cred->ccache_obtained = CRED_UNINITIALISED;
51 cred->client_gss_creds_obtained = CRED_UNINITIALISED;
52 cred->server_gss_creds_obtained = CRED_UNINITIALISED;
53 cred->keytab_obtained = CRED_UNINITIALISED;
54 cred->principal_obtained = CRED_UNINITIALISED;
56 cred->ccache_threshold = CRED_UNINITIALISED;
57 cred->client_gss_creds_threshold = CRED_UNINITIALISED;
59 cred->old_password = NULL;
60 cred->smb_krb5_context = NULL;
61 cred->salt_principal = NULL;
62 cred->machine_account = false;
67 cred->callback_running = false;
69 cli_credentials_set_kerberos_state(cred, CRED_AUTO_USE_KERBEROS);
70 cli_credentials_set_gensec_features(cred, 0);
76 * Create a new anonymous credential
77 * @param mem_ctx TALLOC_CTX parent for credentials structure
79 _PUBLIC_ struct cli_credentials *cli_credentials_init_anon(TALLOC_CTX *mem_ctx)
81 struct cli_credentials *anon_credentials;
83 anon_credentials = cli_credentials_init(mem_ctx);
84 cli_credentials_set_anonymous(anon_credentials);
86 return anon_credentials;
89 _PUBLIC_ void cli_credentials_set_kerberos_state(struct cli_credentials *creds,
90 enum credentials_use_kerberos use_kerberos)
92 creds->use_kerberos = use_kerberos;
95 _PUBLIC_ enum credentials_use_kerberos cli_credentials_get_kerberos_state(struct cli_credentials *creds)
97 return creds->use_kerberos;
100 _PUBLIC_ void cli_credentials_set_gensec_features(struct cli_credentials *creds, uint32_t gensec_features)
102 creds->gensec_features = gensec_features;
105 _PUBLIC_ uint32_t cli_credentials_get_gensec_features(struct cli_credentials *creds)
107 return creds->gensec_features;
112 * Obtain the username for this credentials context.
113 * @param cred credentials context
114 * @retval The username set on this context.
115 * @note Return value will never be NULL except by programmer error.
117 _PUBLIC_ const char *cli_credentials_get_username(struct cli_credentials *cred)
119 if (cred->machine_account_pending) {
120 cli_credentials_set_machine_account(cred,
121 cred->machine_account_pending_lp_ctx);
124 if (cred->username_obtained == CRED_CALLBACK &&
125 !cred->callback_running) {
126 cred->callback_running = true;
127 cred->username = cred->username_cb(cred);
128 cred->callback_running = false;
129 cred->username_obtained = CRED_SPECIFIED;
130 cli_credentials_invalidate_ccache(cred, cred->username_obtained);
133 return cred->username;
136 _PUBLIC_ bool cli_credentials_set_username(struct cli_credentials *cred,
137 const char *val, enum credentials_obtained obtained)
139 if (obtained >= cred->username_obtained) {
140 cred->username = talloc_strdup(cred, val);
141 cred->username_obtained = obtained;
142 cli_credentials_invalidate_ccache(cred, cred->username_obtained);
149 bool cli_credentials_set_username_callback(struct cli_credentials *cred,
150 const char *(*username_cb) (struct cli_credentials *))
152 if (cred->username_obtained < CRED_CALLBACK) {
153 cred->username_cb = username_cb;
154 cred->username_obtained = CRED_CALLBACK;
161 _PUBLIC_ bool cli_credentials_set_bind_dn(struct cli_credentials *cred,
164 cred->bind_dn = talloc_strdup(cred, bind_dn);
169 * Obtain the BIND DN for this credentials context.
170 * @param cred credentials context
171 * @retval The username set on this context.
172 * @note Return value will be NULL if not specified explictly
174 _PUBLIC_ const char *cli_credentials_get_bind_dn(struct cli_credentials *cred)
176 return cred->bind_dn;
181 * Obtain the client principal for this credentials context.
182 * @param cred credentials context
183 * @retval The username set on this context.
184 * @note Return value will never be NULL except by programmer error.
186 _PUBLIC_ const char *cli_credentials_get_principal(struct cli_credentials *cred, TALLOC_CTX *mem_ctx)
188 if (cred->machine_account_pending) {
189 cli_credentials_set_machine_account(cred,
190 cred->machine_account_pending_lp_ctx);
193 if (cred->principal_obtained == CRED_CALLBACK &&
194 !cred->callback_running) {
195 cred->callback_running = true;
196 cred->principal = cred->principal_cb(cred);
197 cred->callback_running = false;
198 cred->principal_obtained = CRED_SPECIFIED;
199 cli_credentials_invalidate_ccache(cred, cred->principal_obtained);
202 if (cred->principal_obtained < cred->username_obtained) {
203 if (cred->domain_obtained > cred->realm_obtained) {
204 return talloc_asprintf(mem_ctx, "%s@%s",
205 cli_credentials_get_username(cred),
206 cli_credentials_get_domain(cred));
208 return talloc_asprintf(mem_ctx, "%s@%s",
209 cli_credentials_get_username(cred),
210 cli_credentials_get_realm(cred));
213 return talloc_reference(mem_ctx, cred->principal);
216 bool cli_credentials_set_principal(struct cli_credentials *cred,
218 enum credentials_obtained obtained)
220 if (obtained >= cred->principal_obtained) {
221 cred->principal = talloc_strdup(cred, val);
222 cred->principal_obtained = obtained;
223 cli_credentials_invalidate_ccache(cred, cred->principal_obtained);
230 /* Set a callback to get the principal. This could be a popup dialog,
231 * a terminal prompt or similar. */
232 bool cli_credentials_set_principal_callback(struct cli_credentials *cred,
233 const char *(*principal_cb) (struct cli_credentials *))
235 if (cred->principal_obtained < CRED_CALLBACK) {
236 cred->principal_cb = principal_cb;
237 cred->principal_obtained = CRED_CALLBACK;
244 /* Some of our tools are 'anonymous by default'. This is a single
245 * function to determine if authentication has been explicitly
248 _PUBLIC_ bool cli_credentials_authentication_requested(struct cli_credentials *cred)
254 if (cli_credentials_is_anonymous(cred)){
258 if (cred->principal_obtained >= CRED_SPECIFIED) {
261 if (cred->username_obtained >= CRED_SPECIFIED) {
265 if (cli_credentials_get_kerberos_state(cred) == CRED_MUST_USE_KERBEROS) {
273 * Obtain the password for this credentials context.
274 * @param cred credentials context
275 * @retval If set, the cleartext password, otherwise NULL
277 _PUBLIC_ const char *cli_credentials_get_password(struct cli_credentials *cred)
279 if (cred->machine_account_pending) {
280 cli_credentials_set_machine_account(cred,
281 cred->machine_account_pending_lp_ctx);
284 if (cred->password_obtained == CRED_CALLBACK &&
285 !cred->callback_running) {
286 cred->callback_running = true;
287 cred->password = cred->password_cb(cred);
288 cred->callback_running = false;
289 cred->password_obtained = CRED_CALLBACK_RESULT;
290 cli_credentials_invalidate_ccache(cred, cred->password_obtained);
293 return cred->password;
296 /* Set a password on the credentials context, including an indication
297 * of 'how' the password was obtained */
299 _PUBLIC_ bool cli_credentials_set_password(struct cli_credentials *cred,
301 enum credentials_obtained obtained)
303 if (obtained >= cred->password_obtained) {
304 cred->password = talloc_strdup(cred, val);
305 cred->password_obtained = obtained;
306 cli_credentials_invalidate_ccache(cred, cred->password_obtained);
308 cred->nt_hash = NULL;
315 _PUBLIC_ bool cli_credentials_set_password_callback(struct cli_credentials *cred,
316 const char *(*password_cb) (struct cli_credentials *))
318 if (cred->password_obtained < CRED_CALLBACK) {
319 cred->password_cb = password_cb;
320 cred->password_obtained = CRED_CALLBACK;
321 cli_credentials_invalidate_ccache(cred, cred->password_obtained);
329 * Obtain the 'old' password for this credentials context (used for join accounts).
330 * @param cred credentials context
331 * @retval If set, the cleartext password, otherwise NULL
333 const char *cli_credentials_get_old_password(struct cli_credentials *cred)
335 if (cred->machine_account_pending) {
336 cli_credentials_set_machine_account(cred,
337 cred->machine_account_pending_lp_ctx);
340 return cred->old_password;
343 bool cli_credentials_set_old_password(struct cli_credentials *cred,
345 enum credentials_obtained obtained)
347 cred->old_password = talloc_strdup(cred, val);
352 * Obtain the password, in the form MD4(unicode(password)) for this credentials context.
354 * Sometimes we only have this much of the password, while the rest of
355 * the time this call avoids calling E_md4hash themselves.
357 * @param cred credentials context
358 * @retval If set, the cleartext password, otherwise NULL
360 _PUBLIC_ const struct samr_Password *cli_credentials_get_nt_hash(struct cli_credentials *cred,
363 const char *password = cli_credentials_get_password(cred);
366 struct samr_Password *nt_hash = talloc(mem_ctx, struct samr_Password);
371 E_md4hash(password, nt_hash->hash);
375 return cred->nt_hash;
379 _PUBLIC_ bool cli_credentials_set_nt_hash(struct cli_credentials *cred,
380 const struct samr_Password *nt_hash,
381 enum credentials_obtained obtained)
383 if (obtained >= cred->password_obtained) {
384 cli_credentials_set_password(cred, NULL, obtained);
386 cred->nt_hash = talloc(cred, struct samr_Password);
387 *cred->nt_hash = *nt_hash;
389 cred->nt_hash = NULL;
398 * Obtain the 'short' or 'NetBIOS' domain for this credentials context.
399 * @param cred credentials context
400 * @retval The domain set on this context.
401 * @note Return value will never be NULL except by programmer error.
403 _PUBLIC_ const char *cli_credentials_get_domain(struct cli_credentials *cred)
405 if (cred->machine_account_pending) {
406 cli_credentials_set_machine_account(cred,
407 cred->machine_account_pending_lp_ctx);
410 if (cred->domain_obtained == CRED_CALLBACK &&
411 !cred->callback_running) {
412 cred->callback_running = true;
413 cred->domain = cred->domain_cb(cred);
414 cred->callback_running = false;
415 cred->domain_obtained = CRED_SPECIFIED;
416 cli_credentials_invalidate_ccache(cred, cred->domain_obtained);
423 _PUBLIC_ bool cli_credentials_set_domain(struct cli_credentials *cred,
425 enum credentials_obtained obtained)
427 if (obtained >= cred->domain_obtained) {
428 /* it is important that the domain be in upper case,
429 * particularly for the sensitive NTLMv2
431 cred->domain = strupper_talloc(cred, val);
432 cred->domain_obtained = obtained;
433 cli_credentials_invalidate_ccache(cred, cred->domain_obtained);
440 bool cli_credentials_set_domain_callback(struct cli_credentials *cred,
441 const char *(*domain_cb) (struct cli_credentials *))
443 if (cred->domain_obtained < CRED_CALLBACK) {
444 cred->domain_cb = domain_cb;
445 cred->domain_obtained = CRED_CALLBACK;
453 * Obtain the Kerberos realm for this credentials context.
454 * @param cred credentials context
455 * @retval The realm set on this context.
456 * @note Return value will never be NULL except by programmer error.
458 _PUBLIC_ const char *cli_credentials_get_realm(struct cli_credentials *cred)
460 if (cred->machine_account_pending) {
461 cli_credentials_set_machine_account(cred,
462 cred->machine_account_pending_lp_ctx);
465 if (cred->realm_obtained == CRED_CALLBACK &&
466 !cred->callback_running) {
467 cred->callback_running = true;
468 cred->realm = cred->realm_cb(cred);
469 cred->callback_running = false;
470 cred->realm_obtained = CRED_SPECIFIED;
471 cli_credentials_invalidate_ccache(cred, cred->realm_obtained);
478 * Set the realm for this credentials context, and force it to
479 * uppercase for the sainity of our local kerberos libraries
481 _PUBLIC_ bool cli_credentials_set_realm(struct cli_credentials *cred,
483 enum credentials_obtained obtained)
485 if (obtained >= cred->realm_obtained) {
486 cred->realm = strupper_talloc(cred, val);
487 cred->realm_obtained = obtained;
488 cli_credentials_invalidate_ccache(cred, cred->realm_obtained);
495 bool cli_credentials_set_realm_callback(struct cli_credentials *cred,
496 const char *(*realm_cb) (struct cli_credentials *))
498 if (cred->realm_obtained < CRED_CALLBACK) {
499 cred->realm_cb = realm_cb;
500 cred->realm_obtained = CRED_CALLBACK;
508 * Obtain the 'short' or 'NetBIOS' workstation name for this credentials context.
510 * @param cred credentials context
511 * @retval The workstation name set on this context.
512 * @note Return value will never be NULL except by programmer error.
514 _PUBLIC_ const char *cli_credentials_get_workstation(struct cli_credentials *cred)
516 if (cred->workstation_obtained == CRED_CALLBACK &&
517 !cred->callback_running) {
518 cred->callback_running = true;
519 cred->workstation = cred->workstation_cb(cred);
520 cred->callback_running = false;
521 cred->workstation_obtained = CRED_SPECIFIED;
524 return cred->workstation;
527 _PUBLIC_ bool cli_credentials_set_workstation(struct cli_credentials *cred,
529 enum credentials_obtained obtained)
531 if (obtained >= cred->workstation_obtained) {
532 cred->workstation = talloc_strdup(cred, val);
533 cred->workstation_obtained = obtained;
540 bool cli_credentials_set_workstation_callback(struct cli_credentials *cred,
541 const char *(*workstation_cb) (struct cli_credentials *))
543 if (cred->workstation_obtained < CRED_CALLBACK) {
544 cred->workstation_cb = workstation_cb;
545 cred->workstation_obtained = CRED_CALLBACK;
553 * Given a string, typically obtained from a -U argument, parse it into domain, username, realm and password fields
555 * The format accepted is [domain\\]user[%password] or user[@realm][%password]
557 * @param credentials Credentials structure on which to set the password
558 * @param data the string containing the username, password etc
559 * @param obtained This enum describes how 'specified' this password is
562 _PUBLIC_ void cli_credentials_parse_string(struct cli_credentials *credentials, const char *data, enum credentials_obtained obtained)
566 if (strcmp("%",data) == 0) {
567 cli_credentials_set_anonymous(credentials);
571 uname = talloc_strdup(credentials, data);
572 if ((p = strchr_m(uname,'%'))) {
574 cli_credentials_set_password(credentials, p+1, obtained);
577 if ((p = strchr_m(uname,'@'))) {
578 cli_credentials_set_principal(credentials, uname, obtained);
580 cli_credentials_set_realm(credentials, p+1, obtained);
582 } else if ((p = strchr_m(uname,'\\')) || (p = strchr_m(uname, '/'))) {
584 cli_credentials_set_domain(credentials, uname, obtained);
587 cli_credentials_set_username(credentials, uname, obtained);
591 * Given a a credentials structure, print it as a string
593 * The format output is [domain\\]user[%password] or user[@realm][%password]
595 * @param credentials Credentials structure on which to set the password
596 * @param mem_ctx The memory context to place the result on
599 _PUBLIC_ const char *cli_credentials_get_unparsed_name(struct cli_credentials *credentials, TALLOC_CTX *mem_ctx)
601 const char *bind_dn = cli_credentials_get_bind_dn(credentials);
603 const char *username;
607 name = talloc_reference(mem_ctx, bind_dn);
609 cli_credentials_get_ntlm_username_domain(credentials, mem_ctx, &username, &domain);
610 if (domain && domain[0]) {
611 name = talloc_asprintf(mem_ctx, "%s\\%s",
614 name = talloc_asprintf(mem_ctx, "%s",
622 * Specifies default values for domain, workstation and realm
623 * from the smb.conf configuration file
625 * @param cred Credentials structure to fill in
627 _PUBLIC_ void cli_credentials_set_conf(struct cli_credentials *cred,
628 struct loadparm_context *lp_ctx)
630 cli_credentials_set_username(cred, "", CRED_UNINITIALISED);
631 cli_credentials_set_domain(cred, lp_workgroup(lp_ctx), CRED_UNINITIALISED);
632 cli_credentials_set_workstation(cred, lp_netbios_name(lp_ctx), CRED_UNINITIALISED);
633 cli_credentials_set_realm(cred, lp_realm(lp_ctx), CRED_UNINITIALISED);
637 * Guess defaults for credentials from environment variables,
638 * and from the configuration file
640 * @param cred Credentials structure to fill in
642 _PUBLIC_ void cli_credentials_guess(struct cli_credentials *cred,
643 struct loadparm_context *lp_ctx)
647 if (lp_ctx != NULL) {
648 cli_credentials_set_conf(cred, lp_ctx);
651 if (getenv("LOGNAME")) {
652 cli_credentials_set_username(cred, getenv("LOGNAME"), CRED_GUESS_ENV);
655 if (getenv("USER")) {
656 cli_credentials_parse_string(cred, getenv("USER"), CRED_GUESS_ENV);
657 if ((p = strchr_m(getenv("USER"),'%'))) {
658 memset(p,0,strlen(cred->password));
662 if (getenv("PASSWD")) {
663 cli_credentials_set_password(cred, getenv("PASSWD"), CRED_GUESS_ENV);
666 if (getenv("PASSWD_FD")) {
667 cli_credentials_parse_password_fd(cred, atoi(getenv("PASSWD_FD")),
671 p = getenv("PASSWD_FILE");
673 cli_credentials_parse_password_file(cred, p, CRED_GUESS_FILE);
676 if (cli_credentials_get_kerberos_state(cred) != CRED_DONT_USE_KERBEROS) {
677 cli_credentials_set_ccache(cred, event_context_find(cred), lp_ctx, NULL, CRED_GUESS_FILE);
682 * Attach NETLOGON credentials for use with SCHANNEL
685 _PUBLIC_ void cli_credentials_set_netlogon_creds(struct cli_credentials *cred,
686 struct creds_CredentialState *netlogon_creds)
688 cred->netlogon_creds = talloc_reference(cred, netlogon_creds);
692 * Return attached NETLOGON credentials
695 struct creds_CredentialState *cli_credentials_get_netlogon_creds(struct cli_credentials *cred)
697 return cred->netlogon_creds;
701 * Set NETLOGON secure channel type
704 _PUBLIC_ void cli_credentials_set_secure_channel_type(struct cli_credentials *cred,
705 enum netr_SchannelType secure_channel_type)
707 cred->secure_channel_type = secure_channel_type;
711 * Return NETLOGON secure chanel type
714 _PUBLIC_ enum netr_SchannelType cli_credentials_get_secure_channel_type(struct cli_credentials *cred)
716 return cred->secure_channel_type;
720 * Fill in a credentials structure as the anonymous user
722 _PUBLIC_ void cli_credentials_set_anonymous(struct cli_credentials *cred)
724 cli_credentials_set_username(cred, "", CRED_SPECIFIED);
725 cli_credentials_set_domain(cred, "", CRED_SPECIFIED);
726 cli_credentials_set_password(cred, NULL, CRED_SPECIFIED);
727 cli_credentials_set_realm(cred, NULL, CRED_SPECIFIED);
728 cli_credentials_set_workstation(cred, "", CRED_UNINITIALISED);
732 * Describe a credentials context as anonymous or authenticated
733 * @retval true if anonymous, false if a username is specified
736 _PUBLIC_ bool cli_credentials_is_anonymous(struct cli_credentials *cred)
738 const char *username;
740 if (cred->machine_account_pending) {
741 cli_credentials_set_machine_account(cred,
742 cred->machine_account_pending_lp_ctx);
745 username = cli_credentials_get_username(cred);
747 /* Yes, it is deliberate that we die if we have a NULL pointer
748 * here - anonymous is "", not NULL, which is 'never specified,
749 * never guessed', ie programmer bug */
758 * Mark the current password for a credentials struct as wrong. This will
759 * cause the password to be prompted again (if a callback is set).
761 * This will decrement the number of times the password can be tried.
763 * @retval whether the credentials struct is finished
765 _PUBLIC_ bool cli_credentials_wrong_password(struct cli_credentials *cred)
767 if (cred->password_obtained != CRED_CALLBACK_RESULT) {
771 cred->password_obtained = CRED_CALLBACK;
775 return (cred->tries > 0);