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 "auth/credentials/credentials_proto.h"
29 #include "libcli/auth/libcli_auth.h"
30 #include "lib/events/events.h"
31 #include "param/param.h"
34 * Create a new credentials structure
35 * @param mem_ctx TALLOC_CTX parent for credentials structure
37 _PUBLIC_
struct cli_credentials
*cli_credentials_init(TALLOC_CTX
*mem_ctx
)
39 struct cli_credentials
*cred
= talloc(mem_ctx
, struct cli_credentials
);
44 cred
->netlogon_creds
= NULL
;
45 cred
->machine_account_pending
= false;
46 cred
->workstation_obtained
= CRED_UNINITIALISED
;
47 cred
->username_obtained
= CRED_UNINITIALISED
;
48 cred
->password_obtained
= CRED_UNINITIALISED
;
49 cred
->domain_obtained
= CRED_UNINITIALISED
;
50 cred
->realm_obtained
= CRED_UNINITIALISED
;
51 cred
->ccache_obtained
= CRED_UNINITIALISED
;
52 cred
->client_gss_creds_obtained
= CRED_UNINITIALISED
;
53 cred
->server_gss_creds_obtained
= CRED_UNINITIALISED
;
54 cred
->keytab_obtained
= CRED_UNINITIALISED
;
55 cred
->principal_obtained
= CRED_UNINITIALISED
;
57 cred
->ccache_threshold
= CRED_UNINITIALISED
;
58 cred
->client_gss_creds_threshold
= CRED_UNINITIALISED
;
60 cred
->old_password
= NULL
;
61 cred
->smb_krb5_context
= NULL
;
62 cred
->salt_principal
= NULL
;
63 cred
->machine_account
= false;
68 cred
->callback_running
= false;
70 cli_credentials_set_kerberos_state(cred
, CRED_AUTO_USE_KERBEROS
);
71 cli_credentials_set_gensec_features(cred
, 0);
77 * Create a new anonymous credential
78 * @param mem_ctx TALLOC_CTX parent for credentials structure
80 _PUBLIC_
struct cli_credentials
*cli_credentials_init_anon(TALLOC_CTX
*mem_ctx
)
82 struct cli_credentials
*anon_credentials
;
84 anon_credentials
= cli_credentials_init(mem_ctx
);
85 cli_credentials_set_anonymous(anon_credentials
);
87 return anon_credentials
;
90 _PUBLIC_
void cli_credentials_set_kerberos_state(struct cli_credentials
*creds
,
91 enum credentials_use_kerberos use_kerberos
)
93 creds
->use_kerberos
= use_kerberos
;
96 _PUBLIC_
enum credentials_use_kerberos
cli_credentials_get_kerberos_state(struct cli_credentials
*creds
)
98 return creds
->use_kerberos
;
101 _PUBLIC_
void cli_credentials_set_gensec_features(struct cli_credentials
*creds
, uint32_t gensec_features
)
103 creds
->gensec_features
= gensec_features
;
106 _PUBLIC_
uint32_t cli_credentials_get_gensec_features(struct cli_credentials
*creds
)
108 return creds
->gensec_features
;
113 * Obtain the username for this credentials context.
114 * @param cred credentials context
115 * @retval The username set on this context.
116 * @note Return value will never be NULL except by programmer error.
118 _PUBLIC_
const char *cli_credentials_get_username(struct cli_credentials
*cred
)
120 if (cred
->machine_account_pending
) {
121 cli_credentials_set_machine_account(cred
,
122 cred
->machine_account_pending_lp_ctx
);
125 if (cred
->username_obtained
== CRED_CALLBACK
&&
126 !cred
->callback_running
) {
127 cred
->callback_running
= true;
128 cred
->username
= cred
->username_cb(cred
);
129 cred
->callback_running
= false;
130 cred
->username_obtained
= CRED_SPECIFIED
;
131 cli_credentials_invalidate_ccache(cred
, cred
->username_obtained
);
134 return cred
->username
;
137 _PUBLIC_
bool cli_credentials_set_username(struct cli_credentials
*cred
,
138 const char *val
, enum credentials_obtained obtained
)
140 if (obtained
>= cred
->username_obtained
) {
141 cred
->username
= talloc_strdup(cred
, val
);
142 cred
->username_obtained
= obtained
;
143 cli_credentials_invalidate_ccache(cred
, cred
->username_obtained
);
150 bool cli_credentials_set_username_callback(struct cli_credentials
*cred
,
151 const char *(*username_cb
) (struct cli_credentials
*))
153 if (cred
->username_obtained
< CRED_CALLBACK
) {
154 cred
->username_cb
= username_cb
;
155 cred
->username_obtained
= CRED_CALLBACK
;
162 _PUBLIC_
bool cli_credentials_set_bind_dn(struct cli_credentials
*cred
,
165 cred
->bind_dn
= talloc_strdup(cred
, bind_dn
);
170 * Obtain the BIND DN for this credentials context.
171 * @param cred credentials context
172 * @retval The username set on this context.
173 * @note Return value will be NULL if not specified explictly
175 _PUBLIC_
const char *cli_credentials_get_bind_dn(struct cli_credentials
*cred
)
177 return cred
->bind_dn
;
182 * Obtain the client principal for this credentials context.
183 * @param cred credentials context
184 * @retval The username set on this context.
185 * @note Return value will never be NULL except by programmer error.
187 _PUBLIC_
const char *cli_credentials_get_principal(struct cli_credentials
*cred
, TALLOC_CTX
*mem_ctx
)
189 if (cred
->machine_account_pending
) {
190 cli_credentials_set_machine_account(cred
,
191 cred
->machine_account_pending_lp_ctx
);
194 if (cred
->principal_obtained
== CRED_CALLBACK
&&
195 !cred
->callback_running
) {
196 cred
->callback_running
= true;
197 cred
->principal
= cred
->principal_cb(cred
);
198 cred
->callback_running
= false;
199 cred
->principal_obtained
= CRED_SPECIFIED
;
200 cli_credentials_invalidate_ccache(cred
, cred
->principal_obtained
);
203 if (cred
->principal_obtained
< cred
->username_obtained
) {
204 if (cred
->domain_obtained
> cred
->realm_obtained
) {
205 return talloc_asprintf(mem_ctx
, "%s@%s",
206 cli_credentials_get_username(cred
),
207 cli_credentials_get_domain(cred
));
209 return talloc_asprintf(mem_ctx
, "%s@%s",
210 cli_credentials_get_username(cred
),
211 cli_credentials_get_realm(cred
));
214 return talloc_reference(mem_ctx
, cred
->principal
);
217 bool cli_credentials_set_principal(struct cli_credentials
*cred
,
219 enum credentials_obtained obtained
)
221 if (obtained
>= cred
->principal_obtained
) {
222 cred
->principal
= talloc_strdup(cred
, val
);
223 cred
->principal_obtained
= obtained
;
224 cli_credentials_invalidate_ccache(cred
, cred
->principal_obtained
);
231 /* Set a callback to get the principal. This could be a popup dialog,
232 * a terminal prompt or similar. */
233 bool cli_credentials_set_principal_callback(struct cli_credentials
*cred
,
234 const char *(*principal_cb
) (struct cli_credentials
*))
236 if (cred
->principal_obtained
< CRED_CALLBACK
) {
237 cred
->principal_cb
= principal_cb
;
238 cred
->principal_obtained
= CRED_CALLBACK
;
245 /* Some of our tools are 'anonymous by default'. This is a single
246 * function to determine if authentication has been explicitly
249 _PUBLIC_
bool cli_credentials_authentication_requested(struct cli_credentials
*cred
)
255 if (cli_credentials_is_anonymous(cred
)){
259 if (cred
->principal_obtained
>= CRED_SPECIFIED
) {
262 if (cred
->username_obtained
>= CRED_SPECIFIED
) {
266 if (cli_credentials_get_kerberos_state(cred
) == CRED_MUST_USE_KERBEROS
) {
274 * Obtain the password for this credentials context.
275 * @param cred credentials context
276 * @retval If set, the cleartext password, otherwise NULL
278 _PUBLIC_
const char *cli_credentials_get_password(struct cli_credentials
*cred
)
280 if (cred
->machine_account_pending
) {
281 cli_credentials_set_machine_account(cred
,
282 cred
->machine_account_pending_lp_ctx
);
285 if (cred
->password_obtained
== CRED_CALLBACK
&&
286 !cred
->callback_running
) {
287 cred
->callback_running
= true;
288 cred
->password
= cred
->password_cb(cred
);
289 cred
->callback_running
= false;
290 cred
->password_obtained
= CRED_CALLBACK_RESULT
;
291 cli_credentials_invalidate_ccache(cred
, cred
->password_obtained
);
294 return cred
->password
;
297 /* Set a password on the credentials context, including an indication
298 * of 'how' the password was obtained */
300 _PUBLIC_
bool cli_credentials_set_password(struct cli_credentials
*cred
,
302 enum credentials_obtained obtained
)
304 if (obtained
>= cred
->password_obtained
) {
305 cred
->password
= talloc_strdup(cred
, val
);
306 cred
->password_obtained
= obtained
;
307 cli_credentials_invalidate_ccache(cred
, cred
->password_obtained
);
309 cred
->nt_hash
= NULL
;
310 cred
->lm_response
= data_blob(NULL
, 0);
311 cred
->nt_response
= data_blob(NULL
, 0);
318 _PUBLIC_
bool cli_credentials_set_password_callback(struct cli_credentials
*cred
,
319 const char *(*password_cb
) (struct cli_credentials
*))
321 if (cred
->password_obtained
< CRED_CALLBACK
) {
322 cred
->password_cb
= password_cb
;
323 cred
->password_obtained
= CRED_CALLBACK
;
324 cli_credentials_invalidate_ccache(cred
, cred
->password_obtained
);
332 * Obtain the 'old' password for this credentials context (used for join accounts).
333 * @param cred credentials context
334 * @retval If set, the cleartext password, otherwise NULL
336 const char *cli_credentials_get_old_password(struct cli_credentials
*cred
)
338 if (cred
->machine_account_pending
) {
339 cli_credentials_set_machine_account(cred
,
340 cred
->machine_account_pending_lp_ctx
);
343 return cred
->old_password
;
346 bool cli_credentials_set_old_password(struct cli_credentials
*cred
,
348 enum credentials_obtained obtained
)
350 cred
->old_password
= talloc_strdup(cred
, val
);
355 * Obtain the password, in the form MD4(unicode(password)) for this credentials context.
357 * Sometimes we only have this much of the password, while the rest of
358 * the time this call avoids calling E_md4hash themselves.
360 * @param cred credentials context
361 * @retval If set, the cleartext password, otherwise NULL
363 _PUBLIC_
const struct samr_Password
*cli_credentials_get_nt_hash(struct cli_credentials
*cred
,
366 const char *password
= cli_credentials_get_password(cred
);
369 struct samr_Password
*nt_hash
= talloc(mem_ctx
, struct samr_Password
);
374 E_md4hash(password
, nt_hash
->hash
);
378 return cred
->nt_hash
;
383 * Obtain the 'short' or 'NetBIOS' domain for this credentials context.
384 * @param cred credentials context
385 * @retval The domain set on this context.
386 * @note Return value will never be NULL except by programmer error.
388 _PUBLIC_
const char *cli_credentials_get_domain(struct cli_credentials
*cred
)
390 if (cred
->machine_account_pending
) {
391 cli_credentials_set_machine_account(cred
,
392 cred
->machine_account_pending_lp_ctx
);
395 if (cred
->domain_obtained
== CRED_CALLBACK
&&
396 !cred
->callback_running
) {
397 cred
->callback_running
= true;
398 cred
->domain
= cred
->domain_cb(cred
);
399 cred
->callback_running
= false;
400 cred
->domain_obtained
= CRED_SPECIFIED
;
401 cli_credentials_invalidate_ccache(cred
, cred
->domain_obtained
);
408 _PUBLIC_
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
;
418 cli_credentials_invalidate_ccache(cred
, cred
->domain_obtained
);
425 bool cli_credentials_set_domain_callback(struct cli_credentials
*cred
,
426 const char *(*domain_cb
) (struct cli_credentials
*))
428 if (cred
->domain_obtained
< CRED_CALLBACK
) {
429 cred
->domain_cb
= domain_cb
;
430 cred
->domain_obtained
= CRED_CALLBACK
;
438 * Obtain the Kerberos realm for this credentials context.
439 * @param cred credentials context
440 * @retval The realm set on this context.
441 * @note Return value will never be NULL except by programmer error.
443 _PUBLIC_
const char *cli_credentials_get_realm(struct cli_credentials
*cred
)
445 if (cred
->machine_account_pending
) {
446 cli_credentials_set_machine_account(cred
,
447 cred
->machine_account_pending_lp_ctx
);
450 if (cred
->realm_obtained
== CRED_CALLBACK
&&
451 !cred
->callback_running
) {
452 cred
->callback_running
= true;
453 cred
->realm
= cred
->realm_cb(cred
);
454 cred
->callback_running
= false;
455 cred
->realm_obtained
= CRED_SPECIFIED
;
456 cli_credentials_invalidate_ccache(cred
, cred
->realm_obtained
);
463 * Set the realm for this credentials context, and force it to
464 * uppercase for the sainity of our local kerberos libraries
466 _PUBLIC_
bool cli_credentials_set_realm(struct cli_credentials
*cred
,
468 enum credentials_obtained obtained
)
470 if (obtained
>= cred
->realm_obtained
) {
471 cred
->realm
= strupper_talloc(cred
, val
);
472 cred
->realm_obtained
= obtained
;
473 cli_credentials_invalidate_ccache(cred
, cred
->realm_obtained
);
480 bool cli_credentials_set_realm_callback(struct cli_credentials
*cred
,
481 const char *(*realm_cb
) (struct cli_credentials
*))
483 if (cred
->realm_obtained
< CRED_CALLBACK
) {
484 cred
->realm_cb
= realm_cb
;
485 cred
->realm_obtained
= CRED_CALLBACK
;
493 * Obtain the 'short' or 'NetBIOS' workstation name for this credentials context.
495 * @param cred credentials context
496 * @retval The workstation name set on this context.
497 * @note Return value will never be NULL except by programmer error.
499 _PUBLIC_
const char *cli_credentials_get_workstation(struct cli_credentials
*cred
)
501 if (cred
->workstation_obtained
== CRED_CALLBACK
&&
502 !cred
->callback_running
) {
503 cred
->callback_running
= true;
504 cred
->workstation
= cred
->workstation_cb(cred
);
505 cred
->callback_running
= false;
506 cred
->workstation_obtained
= CRED_SPECIFIED
;
509 return cred
->workstation
;
512 _PUBLIC_
bool cli_credentials_set_workstation(struct cli_credentials
*cred
,
514 enum credentials_obtained obtained
)
516 if (obtained
>= cred
->workstation_obtained
) {
517 cred
->workstation
= talloc_strdup(cred
, val
);
518 cred
->workstation_obtained
= obtained
;
525 bool cli_credentials_set_workstation_callback(struct cli_credentials
*cred
,
526 const char *(*workstation_cb
) (struct cli_credentials
*))
528 if (cred
->workstation_obtained
< CRED_CALLBACK
) {
529 cred
->workstation_cb
= workstation_cb
;
530 cred
->workstation_obtained
= CRED_CALLBACK
;
538 * Given a string, typically obtained from a -U argument, parse it into domain, username, realm and password fields
540 * The format accepted is [domain\\]user[%password] or user[@realm][%password]
542 * @param credentials Credentials structure on which to set the password
543 * @param data the string containing the username, password etc
544 * @param obtained This enum describes how 'specified' this password is
547 _PUBLIC_
void cli_credentials_parse_string(struct cli_credentials
*credentials
, const char *data
, enum credentials_obtained obtained
)
551 if (strcmp("%",data
) == 0) {
552 cli_credentials_set_anonymous(credentials
);
556 uname
= talloc_strdup(credentials
, data
);
557 if ((p
= strchr_m(uname
,'%'))) {
559 cli_credentials_set_password(credentials
, p
+1, obtained
);
562 if ((p
= strchr_m(uname
,'@'))) {
563 cli_credentials_set_principal(credentials
, uname
, obtained
);
565 cli_credentials_set_realm(credentials
, p
+1, obtained
);
567 } else if ((p
= strchr_m(uname
,'\\')) || (p
= strchr_m(uname
, '/'))) {
569 cli_credentials_set_domain(credentials
, uname
, obtained
);
572 cli_credentials_set_username(credentials
, uname
, obtained
);
576 * Given a a credentials structure, print it as a string
578 * The format output is [domain\\]user[%password] or user[@realm][%password]
580 * @param credentials Credentials structure on which to set the password
581 * @param mem_ctx The memory context to place the result on
584 _PUBLIC_
const char *cli_credentials_get_unparsed_name(struct cli_credentials
*credentials
, TALLOC_CTX
*mem_ctx
)
586 const char *bind_dn
= cli_credentials_get_bind_dn(credentials
);
588 const char *username
;
592 name
= talloc_reference(mem_ctx
, bind_dn
);
594 cli_credentials_get_ntlm_username_domain(credentials
, mem_ctx
, &username
, &domain
);
595 if (domain
&& domain
[0]) {
596 name
= talloc_asprintf(mem_ctx
, "%s\\%s",
599 name
= talloc_asprintf(mem_ctx
, "%s",
607 * Specifies default values for domain, workstation and realm
608 * from the smb.conf configuration file
610 * @param cred Credentials structure to fill in
612 _PUBLIC_
void cli_credentials_set_conf(struct cli_credentials
*cred
,
613 struct loadparm_context
*lp_ctx
)
615 cli_credentials_set_username(cred
, "", CRED_UNINITIALISED
);
616 cli_credentials_set_domain(cred
, lp_workgroup(lp_ctx
), CRED_UNINITIALISED
);
617 cli_credentials_set_workstation(cred
, lp_netbios_name(lp_ctx
), CRED_UNINITIALISED
);
618 cli_credentials_set_realm(cred
, lp_realm(lp_ctx
), CRED_UNINITIALISED
);
622 * Guess defaults for credentials from environment variables,
623 * and from the configuration file
625 * @param cred Credentials structure to fill in
627 _PUBLIC_
void cli_credentials_guess(struct cli_credentials
*cred
,
628 struct loadparm_context
*lp_ctx
)
632 if (lp_ctx
!= NULL
) {
633 cli_credentials_set_conf(cred
, lp_ctx
);
636 if (getenv("LOGNAME")) {
637 cli_credentials_set_username(cred
, getenv("LOGNAME"), CRED_GUESS_ENV
);
640 if (getenv("USER")) {
641 cli_credentials_parse_string(cred
, getenv("USER"), CRED_GUESS_ENV
);
642 if ((p
= strchr_m(getenv("USER"),'%'))) {
643 memset(p
,0,strlen(cred
->password
));
647 if (getenv("PASSWD")) {
648 cli_credentials_set_password(cred
, getenv("PASSWD"), CRED_GUESS_ENV
);
651 if (getenv("PASSWD_FD")) {
652 cli_credentials_parse_password_fd(cred
, atoi(getenv("PASSWD_FD")),
656 p
= getenv("PASSWD_FILE");
658 cli_credentials_parse_password_file(cred
, p
, CRED_GUESS_FILE
);
661 if (cli_credentials_get_kerberos_state(cred
) != CRED_DONT_USE_KERBEROS
) {
662 cli_credentials_set_ccache(cred
, event_context_find(cred
), lp_ctx
, NULL
, CRED_GUESS_FILE
);
667 * Attach NETLOGON credentials for use with SCHANNEL
670 _PUBLIC_
void cli_credentials_set_netlogon_creds(struct cli_credentials
*cred
,
671 struct creds_CredentialState
*netlogon_creds
)
673 cred
->netlogon_creds
= talloc_reference(cred
, netlogon_creds
);
677 * Return attached NETLOGON credentials
680 struct creds_CredentialState
*cli_credentials_get_netlogon_creds(struct cli_credentials
*cred
)
682 return cred
->netlogon_creds
;
686 * Set NETLOGON secure channel type
689 _PUBLIC_
void cli_credentials_set_secure_channel_type(struct cli_credentials
*cred
,
690 enum netr_SchannelType secure_channel_type
)
692 cred
->secure_channel_type
= secure_channel_type
;
696 * Return NETLOGON secure chanel type
699 _PUBLIC_
enum netr_SchannelType
cli_credentials_get_secure_channel_type(struct cli_credentials
*cred
)
701 return cred
->secure_channel_type
;
705 * Fill in a credentials structure as the anonymous user
707 _PUBLIC_
void cli_credentials_set_anonymous(struct cli_credentials
*cred
)
709 cli_credentials_set_username(cred
, "", CRED_SPECIFIED
);
710 cli_credentials_set_domain(cred
, "", CRED_SPECIFIED
);
711 cli_credentials_set_password(cred
, NULL
, CRED_SPECIFIED
);
712 cli_credentials_set_realm(cred
, NULL
, CRED_SPECIFIED
);
713 cli_credentials_set_workstation(cred
, "", CRED_UNINITIALISED
);
717 * Describe a credentials context as anonymous or authenticated
718 * @retval true if anonymous, false if a username is specified
721 _PUBLIC_
bool cli_credentials_is_anonymous(struct cli_credentials
*cred
)
723 const char *username
;
725 if (cred
->machine_account_pending
) {
726 cli_credentials_set_machine_account(cred
,
727 cred
->machine_account_pending_lp_ctx
);
730 username
= cli_credentials_get_username(cred
);
732 /* Yes, it is deliberate that we die if we have a NULL pointer
733 * here - anonymous is "", not NULL, which is 'never specified,
734 * never guessed', ie programmer bug */
743 * Mark the current password for a credentials struct as wrong. This will
744 * cause the password to be prompted again (if a callback is set).
746 * This will decrement the number of times the password can be tried.
748 * @retval whether the credentials struct is finished
750 _PUBLIC_
bool cli_credentials_wrong_password(struct cli_credentials
*cred
)
752 if (cred
->password_obtained
!= CRED_CALLBACK_RESULT
) {
756 cred
->password_obtained
= CRED_CALLBACK
;
760 return (cred
->tries
> 0);