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 2 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, write to the Free Software
22 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 #include "librpc/gen_ndr/samr.h" /* for struct samrPassword */
27 #include "auth/credentials/credentials.h"
28 #include "auth/credentials/credentials_krb5.h"
29 #include "libcli/auth/libcli_auth.h"
32 * Create a new credentials structure
33 * @param mem_ctx TALLOC_CTX parent for credentials structure
35 struct cli_credentials
*cli_credentials_init(TALLOC_CTX
*mem_ctx
)
37 struct cli_credentials
*cred
= talloc(mem_ctx
, struct cli_credentials
);
42 cred
->netlogon_creds
= NULL
;
43 cred
->machine_account_pending
= False
;
44 cred
->workstation_obtained
= CRED_UNINITIALISED
;
45 cred
->username_obtained
= CRED_UNINITIALISED
;
46 cred
->password_obtained
= CRED_UNINITIALISED
;
47 cred
->domain_obtained
= CRED_UNINITIALISED
;
48 cred
->realm_obtained
= CRED_UNINITIALISED
;
49 cred
->ccache_obtained
= CRED_UNINITIALISED
;
50 cred
->client_gss_creds_obtained
= CRED_UNINITIALISED
;
51 cred
->server_gss_creds_obtained
= CRED_UNINITIALISED
;
52 cred
->keytab_obtained
= CRED_UNINITIALISED
;
53 cred
->principal_obtained
= CRED_UNINITIALISED
;
55 cred
->old_password
= NULL
;
56 cred
->smb_krb5_context
= NULL
;
57 cred
->salt_principal
= NULL
;
58 cred
->machine_account
= False
;
63 cred
->callback_running
= False
;
65 cli_credentials_set_kerberos_state(cred
, CRED_AUTO_USE_KERBEROS
);
66 cli_credentials_set_gensec_features(cred
, 0);
72 * Create a new anonymous credential
73 * @param mem_ctx TALLOC_CTX parent for credentials structure
75 struct cli_credentials
*cli_credentials_init_anon(TALLOC_CTX
*mem_ctx
)
77 struct cli_credentials
*anon_credentials
;
79 anon_credentials
= cli_credentials_init(mem_ctx
);
80 cli_credentials_set_conf(anon_credentials
);
81 cli_credentials_set_anonymous(anon_credentials
);
83 return anon_credentials
;
86 void cli_credentials_set_kerberos_state(struct cli_credentials
*creds
,
87 enum credentials_use_kerberos use_kerberos
)
89 creds
->use_kerberos
= use_kerberos
;
92 enum credentials_use_kerberos
cli_credentials_get_kerberos_state(struct cli_credentials
*creds
)
94 return creds
->use_kerberos
;
97 void cli_credentials_set_gensec_features(struct cli_credentials
*creds
, uint32_t gensec_features
)
99 creds
->gensec_features
= gensec_features
;
102 uint32_t cli_credentials_get_gensec_features(struct cli_credentials
*creds
)
104 return creds
->gensec_features
;
109 * Obtain the username for this credentials context.
110 * @param cred credentials context
111 * @retval The username set on this context.
112 * @note Return value will never be NULL except by programmer error.
114 const char *cli_credentials_get_username(struct cli_credentials
*cred
)
116 if (cred
->machine_account_pending
) {
117 cli_credentials_set_machine_account(cred
);
120 if (cred
->username_obtained
== CRED_CALLBACK
&&
121 !cred
->callback_running
) {
122 cred
->callback_running
= True
;
123 cred
->username
= cred
->username_cb(cred
);
124 cred
->callback_running
= False
;
125 cred
->username_obtained
= CRED_SPECIFIED
;
128 return cred
->username
;
131 BOOL
cli_credentials_set_username(struct cli_credentials
*cred
,
132 const char *val
, enum credentials_obtained obtained
)
134 if (obtained
>= cred
->username_obtained
) {
135 cred
->username
= talloc_strdup(cred
, val
);
136 cred
->username_obtained
= obtained
;
143 BOOL
cli_credentials_set_username_callback(struct cli_credentials
*cred
,
144 const char *(*username_cb
) (struct cli_credentials
*))
146 if (cred
->username_obtained
< CRED_CALLBACK
) {
147 cred
->username_cb
= username_cb
;
148 cred
->username_obtained
= CRED_CALLBACK
;
155 BOOL
cli_credentials_set_bind_dn(struct cli_credentials
*cred
,
158 cred
->bind_dn
= talloc_strdup(cred
, bind_dn
);
163 * Obtain the BIND DN for this credentials context.
164 * @param cred credentials context
165 * @retval The username set on this context.
166 * @note Return value will be NULL if not specified explictly
168 const char *cli_credentials_get_bind_dn(struct cli_credentials
*cred
)
170 return cred
->bind_dn
;
175 * Obtain the client principal for this credentials context.
176 * @param cred credentials context
177 * @retval The username set on this context.
178 * @note Return value will never be NULL except by programmer error.
180 const char *cli_credentials_get_principal(struct cli_credentials
*cred
, TALLOC_CTX
*mem_ctx
)
182 if (cred
->machine_account_pending
) {
183 cli_credentials_set_machine_account(cred
);
186 if (cred
->principal_obtained
== CRED_CALLBACK
&&
187 !cred
->callback_running
) {
188 cred
->callback_running
= True
;
189 cred
->principal
= cred
->principal_cb(cred
);
190 cred
->callback_running
= False
;
191 cred
->principal_obtained
= CRED_SPECIFIED
;
194 if (cred
->principal_obtained
< cred
->username_obtained
) {
195 if (cred
->domain_obtained
> cred
->realm_obtained
) {
196 return talloc_asprintf(mem_ctx
, "%s@%s",
197 cli_credentials_get_username(cred
),
198 cli_credentials_get_domain(cred
));
200 return talloc_asprintf(mem_ctx
, "%s@%s",
201 cli_credentials_get_username(cred
),
202 cli_credentials_get_realm(cred
));
205 return talloc_reference(mem_ctx
, cred
->principal
);
208 BOOL
cli_credentials_set_principal(struct cli_credentials
*cred
,
210 enum credentials_obtained obtained
)
212 if (obtained
>= cred
->principal_obtained
) {
213 cred
->principal
= talloc_strdup(cred
, val
);
214 cred
->principal_obtained
= obtained
;
221 /* Set a callback to get the principal. This could be a popup dialog,
222 * a terminal prompt or similar. */
224 BOOL
cli_credentials_set_principal_callback(struct cli_credentials
*cred
,
225 const char *(*principal_cb
) (struct cli_credentials
*))
227 if (cred
->principal_obtained
< CRED_CALLBACK
) {
228 cred
->principal_cb
= principal_cb
;
229 cred
->principal_obtained
= CRED_CALLBACK
;
236 /* Some of our tools are 'anonymous by default'. This is a single
237 * function to determine if authentication has been explicitly
240 BOOL
cli_credentials_authentication_requested(struct cli_credentials
*cred
)
246 if (cli_credentials_is_anonymous(cred
)){
250 if (cred
->principal_obtained
>= CRED_SPECIFIED
) {
253 if (cred
->username_obtained
>= CRED_SPECIFIED
) {
257 if (cli_credentials_get_kerberos_state(cred
) == CRED_MUST_USE_KERBEROS
) {
265 * Obtain the password for this credentials context.
266 * @param cred credentials context
267 * @retval If set, the cleartext password, otherwise NULL
269 const char *cli_credentials_get_password(struct cli_credentials
*cred
)
271 if (cred
->machine_account_pending
) {
272 cli_credentials_set_machine_account(cred
);
275 if (cred
->password_obtained
== CRED_CALLBACK
&&
276 !cred
->callback_running
) {
277 cred
->callback_running
= True
;
278 cred
->password
= cred
->password_cb(cred
);
279 cred
->callback_running
= False
;
280 cred
->password_obtained
= CRED_CALLBACK_RESULT
;
283 return cred
->password
;
286 /* Set a password on the credentials context, including an indication
287 * of 'how' the password was obtained */
289 BOOL
cli_credentials_set_password(struct cli_credentials
*cred
,
291 enum credentials_obtained obtained
)
293 if (obtained
>= cred
->password_obtained
) {
294 cred
->password
= talloc_strdup(cred
, val
);
295 cred
->password_obtained
= obtained
;
297 cred
->nt_hash
= NULL
;
304 BOOL
cli_credentials_set_password_callback(struct cli_credentials
*cred
,
305 const char *(*password_cb
) (struct cli_credentials
*))
307 if (cred
->password_obtained
< CRED_CALLBACK
) {
308 cred
->password_cb
= password_cb
;
309 cred
->password_obtained
= CRED_CALLBACK
;
317 * Obtain the 'old' password for this credentials context (used for join accounts).
318 * @param cred credentials context
319 * @retval If set, the cleartext password, otherwise NULL
321 const char *cli_credentials_get_old_password(struct cli_credentials
*cred
)
323 if (cred
->machine_account_pending
) {
324 cli_credentials_set_machine_account(cred
);
327 return cred
->old_password
;
330 BOOL
cli_credentials_set_old_password(struct cli_credentials
*cred
,
332 enum credentials_obtained obtained
)
334 cred
->old_password
= talloc_strdup(cred
, val
);
339 * Obtain the password, in the form MD4(unicode(password)) for this credentials context.
341 * Sometimes we only have this much of the password, while the rest of
342 * the time this call avoids calling E_md4hash themselves.
344 * @param cred credentials context
345 * @retval If set, the cleartext password, otherwise NULL
347 const struct samr_Password
*cli_credentials_get_nt_hash(struct cli_credentials
*cred
,
350 const char *password
= cli_credentials_get_password(cred
);
353 struct samr_Password
*nt_hash
= talloc(mem_ctx
, struct samr_Password
);
358 E_md4hash(password
, nt_hash
->hash
);
362 return cred
->nt_hash
;
366 BOOL
cli_credentials_set_nt_hash(struct cli_credentials
*cred
,
367 const struct samr_Password
*nt_hash
,
368 enum credentials_obtained obtained
)
370 if (obtained
>= cred
->password_obtained
) {
371 cli_credentials_set_password(cred
, NULL
, obtained
);
373 cred
->nt_hash
= talloc(cred
, struct samr_Password
);
374 *cred
->nt_hash
= *nt_hash
;
376 cred
->nt_hash
= NULL
;
385 * Obtain the 'short' or 'NetBIOS' domain for this credentials context.
386 * @param cred credentials context
387 * @retval The domain set on this context.
388 * @note Return value will never be NULL except by programmer error.
390 const char *cli_credentials_get_domain(struct cli_credentials
*cred
)
392 if (cred
->machine_account_pending
) {
393 cli_credentials_set_machine_account(cred
);
396 if (cred
->domain_obtained
== CRED_CALLBACK
&&
397 !cred
->callback_running
) {
398 cred
->callback_running
= True
;
399 cred
->domain
= cred
->domain_cb(cred
);
400 cred
->callback_running
= False
;
401 cred
->domain_obtained
= CRED_SPECIFIED
;
408 BOOL
cli_credentials_set_domain(struct cli_credentials
*cred
,
410 enum credentials_obtained obtained
)
412 if (obtained
>= cred
->domain_obtained
) {
413 /* it is important that the domain be in upper case,
414 * particularly for the sensitive NTLMv2
416 cred
->domain
= strupper_talloc(cred
, val
);
417 cred
->domain_obtained
= obtained
;
424 BOOL
cli_credentials_set_domain_callback(struct cli_credentials
*cred
,
425 const char *(*domain_cb
) (struct cli_credentials
*))
427 if (cred
->domain_obtained
< CRED_CALLBACK
) {
428 cred
->domain_cb
= domain_cb
;
429 cred
->domain_obtained
= CRED_CALLBACK
;
437 * Obtain the Kerberos realm for this credentials context.
438 * @param cred credentials context
439 * @retval The realm set on this context.
440 * @note Return value will never be NULL except by programmer error.
442 const char *cli_credentials_get_realm(struct cli_credentials
*cred
)
444 if (cred
->machine_account_pending
) {
445 cli_credentials_set_machine_account(cred
);
448 if (cred
->realm_obtained
== CRED_CALLBACK
&&
449 !cred
->callback_running
) {
450 cred
->callback_running
= True
;
451 cred
->realm
= cred
->realm_cb(cred
);
452 cred
->callback_running
= False
;
453 cred
->realm_obtained
= CRED_SPECIFIED
;
460 * Set the realm for this credentials context, and force it to
461 * uppercase for the sainity of our local kerberos libraries
463 BOOL
cli_credentials_set_realm(struct cli_credentials
*cred
,
465 enum credentials_obtained obtained
)
467 if (obtained
>= cred
->realm_obtained
) {
468 cred
->realm
= strupper_talloc(cred
, val
);
469 cred
->realm_obtained
= obtained
;
476 BOOL
cli_credentials_set_realm_callback(struct cli_credentials
*cred
,
477 const char *(*realm_cb
) (struct cli_credentials
*))
479 if (cred
->realm_obtained
< CRED_CALLBACK
) {
480 cred
->realm_cb
= realm_cb
;
481 cred
->realm_obtained
= CRED_CALLBACK
;
489 * Obtain the 'short' or 'NetBIOS' workstation name for this credentials context.
491 * @param cred credentials context
492 * @retval The workstation name set on this context.
493 * @note Return value will never be NULL except by programmer error.
495 const char *cli_credentials_get_workstation(struct cli_credentials
*cred
)
497 if (cred
->workstation_obtained
== CRED_CALLBACK
&&
498 !cred
->callback_running
) {
499 cred
->callback_running
= True
;
500 cred
->workstation
= cred
->workstation_cb(cred
);
501 cred
->callback_running
= False
;
502 cred
->workstation_obtained
= CRED_SPECIFIED
;
505 return cred
->workstation
;
508 BOOL
cli_credentials_set_workstation(struct cli_credentials
*cred
,
510 enum credentials_obtained obtained
)
512 if (obtained
>= cred
->workstation_obtained
) {
513 cred
->workstation
= talloc_strdup(cred
, val
);
514 cred
->workstation_obtained
= obtained
;
521 BOOL
cli_credentials_set_workstation_callback(struct cli_credentials
*cred
,
522 const char *(*workstation_cb
) (struct cli_credentials
*))
524 if (cred
->workstation_obtained
< CRED_CALLBACK
) {
525 cred
->workstation_cb
= workstation_cb
;
526 cred
->workstation_obtained
= CRED_CALLBACK
;
534 * Given a string, typically obtained from a -U argument, parse it into domain, username, realm and password fields
536 * The format accepted is [domain\\]user[%password] or user[@realm][%password]
538 * @param credentials Credentials structure on which to set the password
539 * @param data the string containing the username, password etc
540 * @param obtained This enum describes how 'specified' this password is
543 void cli_credentials_parse_string(struct cli_credentials
*credentials
, const char *data
, enum credentials_obtained obtained
)
547 if (strcmp("%",data
) == 0) {
548 cli_credentials_set_anonymous(credentials
);
552 uname
= talloc_strdup(credentials
, data
);
553 if ((p
= strchr_m(uname
,'%'))) {
555 cli_credentials_set_password(credentials
, p
+1, obtained
);
558 if ((p
= strchr_m(uname
,'@'))) {
559 cli_credentials_set_principal(credentials
, uname
, obtained
);
561 cli_credentials_set_realm(credentials
, p
+1, obtained
);
563 } else if ((p
= strchr_m(uname
,'\\')) || (p
= strchr_m(uname
, '/'))) {
565 cli_credentials_set_domain(credentials
, uname
, obtained
);
568 cli_credentials_set_username(credentials
, uname
, obtained
);
572 * Given a a credentials structure, print it as a string
574 * The format output is [domain\\]user[%password] or user[@realm][%password]
576 * @param credentials Credentials structure on which to set the password
577 * @param mem_ctx The memory context to place the result on
580 const char *cli_credentials_get_unparsed_name(struct cli_credentials
*credentials
, TALLOC_CTX
*mem_ctx
)
582 const char *bind_dn
= cli_credentials_get_bind_dn(credentials
);
584 const char *username
;
588 name
= talloc_reference(mem_ctx
, bind_dn
);
590 cli_credentials_get_ntlm_username_domain(credentials
, mem_ctx
, &username
, &domain
);
591 if (domain
&& domain
[0]) {
592 name
= talloc_asprintf(mem_ctx
, "%s\\%s",
595 name
= talloc_asprintf(mem_ctx
, "%s",
603 * Specifies default values for domain, workstation and realm
604 * from the smb.conf configuration file
606 * @param cred Credentials structure to fill in
608 void cli_credentials_set_conf(struct cli_credentials
*cred
)
610 cli_credentials_set_username(cred
, "", CRED_UNINITIALISED
);
611 cli_credentials_set_domain(cred
, lp_workgroup(), CRED_UNINITIALISED
);
612 cli_credentials_set_workstation(cred
, lp_netbios_name(), CRED_UNINITIALISED
);
613 cli_credentials_set_realm(cred
, lp_realm(), CRED_UNINITIALISED
);
617 * Guess defaults for credentials from environment variables,
618 * and from the configuration file
620 * @param cred Credentials structure to fill in
622 void cli_credentials_guess(struct cli_credentials
*cred
)
626 cli_credentials_set_conf(cred
);
628 if (getenv("LOGNAME")) {
629 cli_credentials_set_username(cred
, getenv("LOGNAME"), CRED_GUESS_ENV
);
632 if (getenv("USER")) {
633 cli_credentials_parse_string(cred
, getenv("USER"), CRED_GUESS_ENV
);
634 if ((p
= strchr_m(getenv("USER"),'%'))) {
635 memset(p
,0,strlen(cred
->password
));
639 if (getenv("DOMAIN")) {
640 cli_credentials_set_domain(cred
, getenv("DOMAIN"), CRED_GUESS_ENV
);
643 if (getenv("PASSWD")) {
644 cli_credentials_set_password(cred
, getenv("PASSWD"), CRED_GUESS_ENV
);
647 if (getenv("PASSWD_FD")) {
648 cli_credentials_parse_password_fd(cred
, atoi(getenv("PASSWD_FD")), CRED_GUESS_FILE
);
651 if (getenv("PASSWD_FILE")) {
652 cli_credentials_parse_password_file(cred
, getenv("PASSWD_FILE"), CRED_GUESS_FILE
);
655 if (cli_credentials_get_kerberos_state(cred
) != CRED_DONT_USE_KERBEROS
) {
656 cli_credentials_set_ccache(cred
, NULL
, CRED_GUESS_FILE
);
661 * Attach NETLOGON credentials for use with SCHANNEL
664 void cli_credentials_set_netlogon_creds(struct cli_credentials
*cred
,
665 struct creds_CredentialState
*netlogon_creds
)
667 cred
->netlogon_creds
= talloc_reference(cred
, netlogon_creds
);
671 * Return attached NETLOGON credentials
674 struct creds_CredentialState
*cli_credentials_get_netlogon_creds(struct cli_credentials
*cred
)
676 return cred
->netlogon_creds
;
680 * Set NETLOGON secure channel type
683 void cli_credentials_set_secure_channel_type(struct cli_credentials
*cred
,
684 enum netr_SchannelType secure_channel_type
)
686 cred
->secure_channel_type
= secure_channel_type
;
690 * Return NETLOGON secure chanel type
693 enum netr_SchannelType
cli_credentials_get_secure_channel_type(struct cli_credentials
*cred
)
695 return cred
->secure_channel_type
;
699 * Fill in a credentials structure as the anonymous user
701 void cli_credentials_set_anonymous(struct cli_credentials
*cred
)
703 cli_credentials_set_username(cred
, "", CRED_SPECIFIED
);
704 cli_credentials_set_domain(cred
, "", CRED_SPECIFIED
);
705 cli_credentials_set_password(cred
, NULL
, CRED_SPECIFIED
);
709 * Describe a credentials context as anonymous or authenticated
710 * @retval True if anonymous, False if a username is specified
713 BOOL
cli_credentials_is_anonymous(struct cli_credentials
*cred
)
715 const char *username
;
717 if (cred
->machine_account_pending
) {
718 cli_credentials_set_machine_account(cred
);
721 username
= cli_credentials_get_username(cred
);
723 /* Yes, it is deliberate that we die if we have a NULL pointer
724 * here - anonymous is "", not NULL, which is 'never specified,
725 * never guessed', ie programmer bug */
734 * Mark the current password for a credentials struct as wrong. This will
735 * cause the password to be prompted again (if a callback is set).
737 * This will decrement the number of times the password can be tried.
739 * @retval whether the credentials struct is finished
741 BOOL
cli_credentials_wrong_password(struct cli_credentials
*cred
)
743 if (cred
->password_obtained
!= CRED_CALLBACK_RESULT
) {
747 cred
->password_obtained
= CRED_CALLBACK
;
751 return (cred
->tries
> 0);