auth/credentials/credentials.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3
   4    User credentials handling
   5
   6    Copyright (C) Jelmer Vernooij 2005
   7    Copyright (C) Tim Potter 2001
   8    Copyright (C) Andrew Bartlett <abartlet@samba.org> 2005
   9
  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.
  14
  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.
  19
  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/>.
  22 */
  23
  24 #include "includes.h"
  25 #include "librpc/gen_ndr/samr.h" /* for struct samrPassword */
  26 #include "auth/credentials/credentials.h"
  27 #include "libcli/auth/libcli_auth.h"
  28 #include "tevent.h"
  29 #include "param/param.h"
  30 #include "system/filesys.h"
  31
  32 /**
  33  * Create a new credentials structure
  34  * @param mem_ctx TALLOC_CTX parent for credentials structure
  35  */
  36 _PUBLIC_ struct cli_credentials *cli_credentials_init(TALLOC_CTX *mem_ctx)
  37 {
  38         struct cli_credentials *cred = talloc(mem_ctx, struct cli_credentials);
  39         if (cred == NULL) {
  40                 return cred;
  41         }
  42
  43         cred->workstation_obtained = CRED_UNINITIALISED;
  44         cred->username_obtained = CRED_UNINITIALISED;
  45         cred->password_obtained = CRED_UNINITIALISED;
  46         cred->domain_obtained = CRED_UNINITIALISED;
  47         cred->realm_obtained = CRED_UNINITIALISED;
  48         cred->ccache_obtained = CRED_UNINITIALISED;
  49         cred->client_gss_creds_obtained = CRED_UNINITIALISED;
  50         cred->principal_obtained = CRED_UNINITIALISED;
  51         cred->keytab_obtained = CRED_UNINITIALISED;
  52         cred->server_gss_creds_obtained = CRED_UNINITIALISED;
  53
  54         cred->ccache_threshold = CRED_UNINITIALISED;
  55         cred->client_gss_creds_threshold = CRED_UNINITIALISED;
  56
  57         cred->workstation = NULL;
  58         cred->username = NULL;
  59         cred->password = NULL;
  60         cred->old_password = NULL;
  61         cred->domain = NULL;
  62         cred->realm = NULL;
  63         cred->principal = NULL;
  64         cred->salt_principal = NULL;
  65         cred->impersonate_principal = NULL;
  66         cred->self_service = NULL;
  67         cred->target_service = NULL;
  68
  69         cred->bind_dn = NULL;
  70
  71         cred->nt_hash = NULL;
  72
  73         cred->lm_response.data = NULL;
  74         cred->lm_response.length = 0;
  75         cred->nt_response.data = NULL;
  76         cred->nt_response.length = 0;
  77
  78         cred->ccache = NULL;
  79         cred->client_gss_creds = NULL;
  80         cred->keytab = NULL;
  81         cred->server_gss_creds = NULL;
  82
  83         cred->workstation_cb = NULL;
  84         cred->password_cb = NULL;
  85         cred->username_cb = NULL;
  86         cred->domain_cb = NULL;
  87         cred->realm_cb = NULL;
  88         cred->principal_cb = NULL;
  89
  90         cred->priv_data = NULL;
  91
  92         cred->netlogon_creds = NULL;
  93         cred->secure_channel_type = SEC_CHAN_NULL;
  94
  95         cred->kvno = 0;
  96
  97         cred->password_last_changed_time = 0;
  98
  99         cred->smb_krb5_context = NULL;
 100
 101         cred->machine_account_pending = false;
 102         cred->machine_account_pending_lp_ctx = NULL;
 103
 104         cred->machine_account = false;
 105
 106         cred->tries = 3;
 107
 108         cred->callback_running = false;
 109
 110         cli_credentials_set_kerberos_state(cred, CRED_AUTO_USE_KERBEROS);
 111         cli_credentials_set_gensec_features(cred, 0);
 112         cli_credentials_set_krb_forwardable(cred, CRED_AUTO_KRB_FORWARDABLE);
 113
 114         return cred;
 115 }
 116
 117 /**
 118  * Create a new anonymous credential
 119  * @param mem_ctx TALLOC_CTX parent for credentials structure
 120  */
 121 _PUBLIC_ struct cli_credentials *cli_credentials_init_anon(TALLOC_CTX *mem_ctx)
 122 {
 123         struct cli_credentials *anon_credentials;
 124
 125         anon_credentials = cli_credentials_init(mem_ctx);
 126         cli_credentials_set_anonymous(anon_credentials);
 127
 128         return anon_credentials;
 129 }
 130
 131 _PUBLIC_ void cli_credentials_set_kerberos_state(struct cli_credentials *creds,
 132                                         enum credentials_use_kerberos use_kerberos)
 133 {
 134         creds->use_kerberos = use_kerberos;
 135 }
 136
 137 _PUBLIC_ void cli_credentials_set_krb_forwardable(struct cli_credentials *creds,
 138                                                   enum credentials_krb_forwardable krb_forwardable)
 139 {
 140         creds->krb_forwardable = krb_forwardable;
 141 }
 142
 143 _PUBLIC_ enum credentials_use_kerberos cli_credentials_get_kerberos_state(struct cli_credentials *creds)
 144 {
 145         return creds->use_kerberos;
 146 }
 147
 148 _PUBLIC_ enum credentials_krb_forwardable cli_credentials_get_krb_forwardable(struct cli_credentials *creds)
 149 {
 150         return creds->krb_forwardable;
 151 }
 152
 153 _PUBLIC_ void cli_credentials_set_gensec_features(struct cli_credentials *creds, uint32_t gensec_features)
 154 {
 155         creds->gensec_features = gensec_features;
 156 }
 157
 158 _PUBLIC_ uint32_t cli_credentials_get_gensec_features(struct cli_credentials *creds)
 159 {
 160         return creds->gensec_features;
 161 }
 162
 163
 164 /**
 165  * Obtain the username for this credentials context.
 166  * @param cred credentials context
 167  * @retval The username set on this context.
 168  * @note Return value will never be NULL except by programmer error.
 169  */
 170 _PUBLIC_ const char *cli_credentials_get_username(struct cli_credentials *cred)
 171 {
 172         if (cred->machine_account_pending) {
 173                 cli_credentials_set_machine_account(cred,
 174                                         cred->machine_account_pending_lp_ctx);
 175         }
 176
 177         if (cred->username_obtained == CRED_CALLBACK &&
 178             !cred->callback_running) {
 179                 cred->callback_running = true;
 180                 cred->username = cred->username_cb(cred);
 181                 cred->callback_running = false;
 182                 cred->username_obtained = CRED_SPECIFIED;
 183                 cli_credentials_invalidate_ccache(cred, cred->username_obtained);
 184         }
 185
 186         return cred->username;
 187 }
 188
 189 _PUBLIC_ bool cli_credentials_set_username(struct cli_credentials *cred,
 190                                   const char *val, enum credentials_obtained obtained)
 191 {
 192         if (obtained >= cred->username_obtained) {
 193                 cred->username = talloc_strdup(cred, val);
 194                 cred->username_obtained = obtained;
 195                 cli_credentials_invalidate_ccache(cred, cred->username_obtained);
 196                 return true;
 197         }
 198
 199         return false;
 200 }
 201
 202 _PUBLIC_ bool cli_credentials_set_username_callback(struct cli_credentials *cred,
 203                                   const char *(*username_cb) (struct cli_credentials *))
 204 {
 205         if (cred->username_obtained < CRED_CALLBACK) {
 206                 cred->username_cb = username_cb;
 207                 cred->username_obtained = CRED_CALLBACK;
 208                 return true;
 209         }
 210
 211         return false;
 212 }
 213
 214 _PUBLIC_ bool cli_credentials_set_bind_dn(struct cli_credentials *cred,
 215                                  const char *bind_dn)
 216 {
 217         cred->bind_dn = talloc_strdup(cred, bind_dn);
 218         return true;
 219 }
 220
 221 /**
 222  * Obtain the BIND DN for this credentials context.
 223  * @param cred credentials context
 224  * @retval The username set on this context.
 225  * @note Return value will be NULL if not specified explictly
 226  */
 227 _PUBLIC_ const char *cli_credentials_get_bind_dn(struct cli_credentials *cred)
 228 {
 229         return cred->bind_dn;
 230 }
 231
 232
 233 /**
 234  * Obtain the client principal for this credentials context.
 235  * @param cred credentials context
 236  * @retval The username set on this context.
 237  * @note Return value will never be NULL except by programmer error.
 238  */
 239 _PUBLIC_ const char *cli_credentials_get_principal_and_obtained(struct cli_credentials *cred, TALLOC_CTX *mem_ctx, enum credentials_obtained *obtained)
 240 {
 241         if (cred->machine_account_pending) {
 242                 cli_credentials_set_machine_account(cred,
 243                                         cred->machine_account_pending_lp_ctx);
 244         }
 245
 246         if (cred->principal_obtained == CRED_CALLBACK &&
 247             !cred->callback_running) {
 248                 cred->callback_running = true;
 249                 cred->principal = cred->principal_cb(cred);
 250                 cred->callback_running = false;
 251                 cred->principal_obtained = CRED_SPECIFIED;
 252                 cli_credentials_invalidate_ccache(cred, cred->principal_obtained);
 253         }
 254
 255         if (cred->principal_obtained < cred->username_obtained
 256             || cred->principal_obtained < MAX(cred->domain_obtained, cred->realm_obtained)) {
 257                 if (cred->domain_obtained > cred->realm_obtained) {
 258                         *obtained = MIN(cred->domain_obtained, cred->username_obtained);
 259                         return talloc_asprintf(mem_ctx, "%s@%s",
 260                                                cli_credentials_get_username(cred),
 261                                                cli_credentials_get_domain(cred));
 262                 } else {
 263                         *obtained = MIN(cred->domain_obtained, cred->username_obtained);
 264                         return talloc_asprintf(mem_ctx, "%s@%s",
 265                                                cli_credentials_get_username(cred),
 266                                                cli_credentials_get_realm(cred));
 267                 }
 268         }
 269         *obtained = cred->principal_obtained;
 270         return talloc_reference(mem_ctx, cred->principal);
 271 }
 272
 273 /**
 274  * Obtain the client principal for this credentials context.
 275  * @param cred credentials context
 276  * @retval The username set on this context.
 277  * @note Return value will never be NULL except by programmer error.
 278  */
 279 _PUBLIC_ const char *cli_credentials_get_principal(struct cli_credentials *cred, TALLOC_CTX *mem_ctx)
 280 {
 281         enum credentials_obtained obtained;
 282         return cli_credentials_get_principal_and_obtained(cred, mem_ctx, &obtained);
 283 }
 284
 285 _PUBLIC_ bool cli_credentials_set_principal(struct cli_credentials *cred,
 286                                    const char *val,
 287                                    enum credentials_obtained obtained)
 288 {
 289         if (obtained >= cred->principal_obtained) {
 290                 cred->principal = talloc_strdup(cred, val);
 291                 cred->principal_obtained = obtained;
 292                 cli_credentials_invalidate_ccache(cred, cred->principal_obtained);
 293                 return true;
 294         }
 295
 296         return false;
 297 }
 298
 299 /* Set a callback to get the principal.  This could be a popup dialog,
 300  * a terminal prompt or similar.  */
 301 _PUBLIC_ bool cli_credentials_set_principal_callback(struct cli_credentials *cred,
 302                                   const char *(*principal_cb) (struct cli_credentials *))
 303 {
 304         if (cred->principal_obtained < CRED_CALLBACK) {
 305                 cred->principal_cb = principal_cb;
 306                 cred->principal_obtained = CRED_CALLBACK;
 307                 return true;
 308         }
 309
 310         return false;
 311 }
 312
 313 /* Some of our tools are 'anonymous by default'.  This is a single
 314  * function to determine if authentication has been explicitly
 315  * requested */
 316
 317 _PUBLIC_ bool cli_credentials_authentication_requested(struct cli_credentials *cred)
 318 {
 319         if (cred->bind_dn) {
 320                 return true;
 321         }
 322
 323         if (cli_credentials_is_anonymous(cred)){
 324                 return false;
 325         }
 326
 327         if (cred->principal_obtained >= CRED_SPECIFIED) {
 328                 return true;
 329         }
 330         if (cred->username_obtained >= CRED_SPECIFIED) {
 331                 return true;
 332         }
 333
 334         if (cli_credentials_get_kerberos_state(cred) == CRED_MUST_USE_KERBEROS) {
 335                 return true;
 336         }
 337
 338         return false;
 339 }
 340
 341 /**
 342  * Obtain the password for this credentials context.
 343  * @param cred credentials context
 344  * @retval If set, the cleartext password, otherwise NULL
 345  */
 346 _PUBLIC_ const char *cli_credentials_get_password(struct cli_credentials *cred)
 347 {
 348         if (cred->machine_account_pending) {
 349                 cli_credentials_set_machine_account(cred,
 350                                                     cred->machine_account_pending_lp_ctx);
 351         }
 352
 353         if (cred->password_obtained == CRED_CALLBACK &&
 354             !cred->callback_running) {
 355                 cred->callback_running = true;
 356                 cred->password = cred->password_cb(cred);
 357                 cred->callback_running = false;
 358                 cred->password_obtained = CRED_CALLBACK_RESULT;
 359                 cli_credentials_invalidate_ccache(cred, cred->password_obtained);
 360         }
 361
 362         return cred->password;
 363 }
 364
 365 /* Set a password on the credentials context, including an indication
 366  * of 'how' the password was obtained */
 367
 368 _PUBLIC_ bool cli_credentials_set_password(struct cli_credentials *cred,
 369                                   const char *val,
 370                                   enum credentials_obtained obtained)
 371 {
 372         if (obtained >= cred->password_obtained) {
 373                 cred->password = talloc_strdup(cred, val);
 374                 cred->password_obtained = obtained;
 375                 cli_credentials_invalidate_ccache(cred, cred->password_obtained);
 376
 377                 cred->nt_hash = NULL;
 378                 cred->lm_response = data_blob(NULL, 0);
 379                 cred->nt_response = data_blob(NULL, 0);
 380                 return true;
 381         }
 382
 383         return false;
 384 }
 385
 386 _PUBLIC_ bool cli_credentials_set_password_callback(struct cli_credentials *cred,
 387                                            const char *(*password_cb) (struct cli_credentials *))
 388 {
 389         if (cred->password_obtained < CRED_CALLBACK) {
 390                 cred->password_cb = password_cb;
 391                 cred->password_obtained = CRED_CALLBACK;
 392                 cli_credentials_invalidate_ccache(cred, cred->password_obtained);
 393                 return true;
 394         }
 395
 396         return false;
 397 }
 398
 399 /**
 400  * Obtain the 'old' password for this credentials context (used for join accounts).
 401  * @param cred credentials context
 402  * @retval If set, the cleartext password, otherwise NULL
 403  */
 404 _PUBLIC_ const char *cli_credentials_get_old_password(struct cli_credentials *cred)
 405 {
 406         if (cred->machine_account_pending) {
 407                 cli_credentials_set_machine_account(cred,
 408                                                     cred->machine_account_pending_lp_ctx);
 409         }
 410
 411         return cred->old_password;
 412 }
 413
 414 _PUBLIC_ bool cli_credentials_set_old_password(struct cli_credentials *cred,
 415                                       const char *val,
 416                                       enum credentials_obtained obtained)
 417 {
 418         cred->old_password = talloc_strdup(cred, val);
 419         return true;
 420 }
 421
 422 /**
 423  * Obtain the password, in the form MD4(unicode(password)) for this credentials context.
 424  *
 425  * Sometimes we only have this much of the password, while the rest of
 426  * the time this call avoids calling E_md4hash themselves.
 427  *
 428  * @param cred credentials context
 429  * @retval If set, the cleartext password, otherwise NULL
 430  */
 431 _PUBLIC_ const struct samr_Password *cli_credentials_get_nt_hash(struct cli_credentials *cred,
 432                                                         TALLOC_CTX *mem_ctx)
 433 {
 434         const char *password = cli_credentials_get_password(cred);
 435
 436         if (password) {
 437                 struct samr_Password *nt_hash = talloc(mem_ctx, struct samr_Password);
 438                 if (!nt_hash) {
 439                         return NULL;
 440                 }
 441
 442                 E_md4hash(password, nt_hash->hash);
 443
 444                 return nt_hash;
 445         } else {
 446                 return cred->nt_hash;
 447         }
 448 }
 449
 450 /**
 451  * Obtain the 'short' or 'NetBIOS' domain for this credentials context.
 452  * @param cred credentials context
 453  * @retval The domain set on this context.
 454  * @note Return value will never be NULL except by programmer error.
 455  */
 456 _PUBLIC_ const char *cli_credentials_get_domain(struct cli_credentials *cred)
 457 {
 458         if (cred->machine_account_pending) {
 459                 cli_credentials_set_machine_account(cred,
 460                                                     cred->machine_account_pending_lp_ctx);
 461         }
 462
 463         if (cred->domain_obtained == CRED_CALLBACK &&
 464             !cred->callback_running) {
 465                 cred->callback_running = true;
 466                 cred->domain = cred->domain_cb(cred);
 467                 cred->callback_running = false;
 468                 cred->domain_obtained = CRED_SPECIFIED;
 469                 cli_credentials_invalidate_ccache(cred, cred->domain_obtained);
 470         }
 471
 472         return cred->domain;
 473 }
 474
 475
 476 _PUBLIC_ bool cli_credentials_set_domain(struct cli_credentials *cred,
 477                                 const char *val,
 478                                 enum credentials_obtained obtained)
 479 {
 480         if (obtained >= cred->domain_obtained) {
 481                 /* it is important that the domain be in upper case,
 482                  * particularly for the sensitive NTLMv2
 483                  * calculations */
 484                 cred->domain = strupper_talloc(cred, val);
 485                 cred->domain_obtained = obtained;
 486                 cli_credentials_invalidate_ccache(cred, cred->domain_obtained);
 487                 return true;
 488         }
 489
 490         return false;
 491 }
 492
 493 bool cli_credentials_set_domain_callback(struct cli_credentials *cred,
 494                                          const char *(*domain_cb) (struct cli_credentials *))
 495 {
 496         if (cred->domain_obtained < CRED_CALLBACK) {
 497                 cred->domain_cb = domain_cb;
 498                 cred->domain_obtained = CRED_CALLBACK;
 499                 return true;
 500         }
 501
 502         return false;
 503 }
 504
 505 /**
 506  * Obtain the Kerberos realm for this credentials context.
 507  * @param cred credentials context
 508  * @retval The realm set on this context.
 509  * @note Return value will never be NULL except by programmer error.
 510  */
 511 _PUBLIC_ const char *cli_credentials_get_realm(struct cli_credentials *cred)
 512 {
 513         if (cred->machine_account_pending) {
 514                 cli_credentials_set_machine_account(cred,
 515                                                     cred->machine_account_pending_lp_ctx);
 516         }
 517
 518         if (cred->realm_obtained == CRED_CALLBACK &&
 519             !cred->callback_running) {
 520                 cred->callback_running = true;
 521                 cred->realm = cred->realm_cb(cred);
 522                 cred->callback_running = false;
 523                 cred->realm_obtained = CRED_SPECIFIED;
 524                 cli_credentials_invalidate_ccache(cred, cred->realm_obtained);
 525         }
 526
 527         return cred->realm;
 528 }
 529
 530 /**
 531  * Set the realm for this credentials context, and force it to
 532  * uppercase for the sainity of our local kerberos libraries
 533  */
 534 _PUBLIC_ bool cli_credentials_set_realm(struct cli_credentials *cred,
 535                                const char *val,
 536                                enum credentials_obtained obtained)
 537 {
 538         if (obtained >= cred->realm_obtained) {
 539                 cred->realm = strupper_talloc(cred, val);
 540                 cred->realm_obtained = obtained;
 541                 cli_credentials_invalidate_ccache(cred, cred->realm_obtained);
 542                 return true;
 543         }
 544
 545         return false;
 546 }
 547
 548 bool cli_credentials_set_realm_callback(struct cli_credentials *cred,
 549                                         const char *(*realm_cb) (struct cli_credentials *))
 550 {
 551         if (cred->realm_obtained < CRED_CALLBACK) {
 552                 cred->realm_cb = realm_cb;
 553                 cred->realm_obtained = CRED_CALLBACK;
 554                 return true;
 555         }
 556
 557         return false;
 558 }
 559
 560 /**
 561  * Obtain the 'short' or 'NetBIOS' workstation name for this credentials context.
 562  *
 563  * @param cred credentials context
 564  * @retval The workstation name set on this context.
 565  * @note Return value will never be NULL except by programmer error.
 566  */
 567 _PUBLIC_ const char *cli_credentials_get_workstation(struct cli_credentials *cred)
 568 {
 569         if (cred->workstation_obtained == CRED_CALLBACK &&
 570             !cred->callback_running) {
 571                 cred->callback_running = true;
 572                 cred->workstation = cred->workstation_cb(cred);
 573                 cred->callback_running = false;
 574                 cred->workstation_obtained = CRED_SPECIFIED;
 575         }
 576
 577         return cred->workstation;
 578 }
 579
 580 _PUBLIC_ bool cli_credentials_set_workstation(struct cli_credentials *cred,
 581                                      const char *val,
 582                                      enum credentials_obtained obtained)
 583 {
 584         if (obtained >= cred->workstation_obtained) {
 585                 cred->workstation = talloc_strdup(cred, val);
 586                 cred->workstation_obtained = obtained;
 587                 return true;
 588         }
 589
 590         return false;
 591 }
 592
 593 bool cli_credentials_set_workstation_callback(struct cli_credentials *cred,
 594                                               const char *(*workstation_cb) (struct cli_credentials *))
 595 {
 596         if (cred->workstation_obtained < CRED_CALLBACK) {
 597                 cred->workstation_cb = workstation_cb;
 598                 cred->workstation_obtained = CRED_CALLBACK;
 599                 return true;
 600         }
 601
 602         return false;
 603 }
 604
 605 /**
 606  * Given a string, typically obtained from a -U argument, parse it into domain, username, realm and password fields
 607  *
 608  * The format accepted is [domain\\]user[%password] or user[@realm][%password]
 609  *
 610  * @param credentials Credentials structure on which to set the password
 611  * @param data the string containing the username, password etc
 612  * @param obtained This enum describes how 'specified' this password is
 613  */
 614
 615 _PUBLIC_ void cli_credentials_parse_string(struct cli_credentials *credentials, const char *data, enum credentials_obtained obtained)
 616 {
 617         char *uname, *p;
 618
 619         if (strcmp("%",data) == 0) {
 620                 cli_credentials_set_anonymous(credentials);
 621                 return;
 622         }
 623
 624         uname = talloc_strdup(credentials, data);
 625         if ((p = strchr_m(uname,'%'))) {
 626                 *p = 0;
 627                 cli_credentials_set_password(credentials, p+1, obtained);
 628         }
 629
 630         if ((p = strchr_m(uname,'@'))) {
 631                 cli_credentials_set_principal(credentials, uname, obtained);
 632                 *p = 0;
 633                 cli_credentials_set_realm(credentials, p+1, obtained);
 634                 return;
 635         } else if ((p = strchr_m(uname,'\\')) || (p = strchr_m(uname, '/'))) {
 636                 *p = 0;
 637                 cli_credentials_set_domain(credentials, uname, obtained);
 638                 uname = p+1;
 639         }
 640         cli_credentials_set_username(credentials, uname, obtained);
 641 }
 642
 643 /**
 644  * Given a a credentials structure, print it as a string
 645  *
 646  * The format output is [domain\\]user[%password] or user[@realm][%password]
 647  *
 648  * @param credentials Credentials structure on which to set the password
 649  * @param mem_ctx The memory context to place the result on
 650  */
 651
 652 _PUBLIC_ const char *cli_credentials_get_unparsed_name(struct cli_credentials *credentials, TALLOC_CTX *mem_ctx)
 653 {
 654         const char *bind_dn = cli_credentials_get_bind_dn(credentials);
 655         const char *domain;
 656         const char *username;
 657         const char *name;
 658
 659         if (bind_dn) {
 660                 name = talloc_reference(mem_ctx, bind_dn);
 661         } else {
 662                 cli_credentials_get_ntlm_username_domain(credentials, mem_ctx, &username, &domain);
 663                 if (domain && domain[0]) {
 664                         name = talloc_asprintf(mem_ctx, "%s\\%s",
 665                                                domain, username);
 666                 } else {
 667                         name = talloc_asprintf(mem_ctx, "%s",
 668                                                username);
 669                 }
 670         }
 671         return name;
 672 }
 673
 674 /**
 675  * Specifies default values for domain, workstation and realm
 676  * from the smb.conf configuration file
 677  *
 678  * @param cred Credentials structure to fill in
 679  */
 680 _PUBLIC_ void cli_credentials_set_conf(struct cli_credentials *cred,
 681                               struct loadparm_context *lp_ctx)
 682 {
 683         cli_credentials_set_username(cred, "", CRED_UNINITIALISED);
 684         if (lpcfg_parm_is_cmdline(lp_ctx, "workgroup")) {
 685                 cli_credentials_set_domain(cred, lpcfg_workgroup(lp_ctx), CRED_SPECIFIED);
 686         } else {
 687                 cli_credentials_set_domain(cred, lpcfg_workgroup(lp_ctx), CRED_UNINITIALISED);
 688         }
 689         if (lpcfg_parm_is_cmdline(lp_ctx, "netbios name")) {
 690                 cli_credentials_set_workstation(cred, lpcfg_netbios_name(lp_ctx), CRED_SPECIFIED);
 691         } else {
 692                 cli_credentials_set_workstation(cred, lpcfg_netbios_name(lp_ctx), CRED_UNINITIALISED);
 693         }
 694         if (lpcfg_parm_is_cmdline(lp_ctx, "realm")) {
 695                 cli_credentials_set_realm(cred, lpcfg_realm(lp_ctx), CRED_SPECIFIED);
 696         } else {
 697                 cli_credentials_set_realm(cred, lpcfg_realm(lp_ctx), CRED_UNINITIALISED);
 698         }
 699 }
 700
 701 /**
 702  * Guess defaults for credentials from environment variables,
 703  * and from the configuration file
 704  *
 705  * @param cred Credentials structure to fill in
 706  */
 707 _PUBLIC_ void cli_credentials_guess(struct cli_credentials *cred,
 708                            struct loadparm_context *lp_ctx)
 709 {
 710         char *p;
 711         const char *error_string;
 712
 713         if (lp_ctx != NULL) {
 714                 cli_credentials_set_conf(cred, lp_ctx);
 715         }
 716
 717         if (getenv("LOGNAME")) {
 718                 cli_credentials_set_username(cred, getenv("LOGNAME"), CRED_GUESS_ENV);
 719         }
 720
 721         if (getenv("USER")) {
 722                 cli_credentials_parse_string(cred, getenv("USER"), CRED_GUESS_ENV);
 723                 if ((p = strchr_m(getenv("USER"),'%'))) {
 724                         memset(p,0,strlen(cred->password));
 725                 }
 726         }
 727
 728         if (getenv("PASSWD")) {
 729                 cli_credentials_set_password(cred, getenv("PASSWD"), CRED_GUESS_ENV);
 730         }
 731
 732         if (getenv("PASSWD_FD")) {
 733                 cli_credentials_parse_password_fd(cred, atoi(getenv("PASSWD_FD")),
 734                                                   CRED_GUESS_FILE);
 735         }
 736
 737         p = getenv("PASSWD_FILE");
 738         if (p && p[0]) {
 739                 cli_credentials_parse_password_file(cred, p, CRED_GUESS_FILE);
 740         }
 741
 742         if (cli_credentials_get_kerberos_state(cred) != CRED_DONT_USE_KERBEROS) {
 743                 cli_credentials_set_ccache(cred, lp_ctx, NULL, CRED_GUESS_FILE,
 744                                            &error_string);
 745         }
 746 }
 747
 748 /**
 749  * Attach NETLOGON credentials for use with SCHANNEL
 750  */
 751
 752 _PUBLIC_ void cli_credentials_set_netlogon_creds(struct cli_credentials *cred,
 753                                                  struct netlogon_creds_CredentialState *netlogon_creds)
 754 {
 755         cred->netlogon_creds = talloc_reference(cred, netlogon_creds);
 756 }
 757
 758 /**
 759  * Return attached NETLOGON credentials
 760  */
 761
 762 _PUBLIC_ struct netlogon_creds_CredentialState *cli_credentials_get_netlogon_creds(struct cli_credentials *cred)
 763 {
 764         return cred->netlogon_creds;
 765 }
 766
 767 /**
 768  * Set NETLOGON secure channel type
 769  */
 770
 771 _PUBLIC_ void cli_credentials_set_secure_channel_type(struct cli_credentials *cred,
 772                                              enum netr_SchannelType secure_channel_type)
 773 {
 774         cred->secure_channel_type = secure_channel_type;
 775 }
 776
 777 /**
 778  * Return NETLOGON secure chanel type
 779  */
 780
 781 _PUBLIC_ time_t cli_credentials_get_password_last_changed_time(struct cli_credentials *cred)
 782 {
 783         return cred->password_last_changed_time;
 784 }
 785
 786 /**
 787  * Set NETLOGON secure channel type
 788  */
 789
 790 _PUBLIC_ void cli_credentials_set_password_last_changed_time(struct cli_credentials *cred,
 791                                                              time_t last_changed_time)
 792 {
 793         cred->password_last_changed_time = last_changed_time;
 794 }
 795
 796 /**
 797  * Return NETLOGON secure chanel type
 798  */
 799
 800 _PUBLIC_ enum netr_SchannelType cli_credentials_get_secure_channel_type(struct cli_credentials *cred)
 801 {
 802         return cred->secure_channel_type;
 803 }
 804
 805 /**
 806  * Fill in a credentials structure as the anonymous user
 807  */
 808 _PUBLIC_ void cli_credentials_set_anonymous(struct cli_credentials *cred)
 809 {
 810         cli_credentials_set_username(cred, "", CRED_SPECIFIED);
 811         cli_credentials_set_domain(cred, "", CRED_SPECIFIED);
 812         cli_credentials_set_password(cred, NULL, CRED_SPECIFIED);
 813         cli_credentials_set_realm(cred, NULL, CRED_SPECIFIED);
 814         cli_credentials_set_workstation(cred, "", CRED_UNINITIALISED);
 815 }
 816
 817 /**
 818  * Describe a credentials context as anonymous or authenticated
 819  * @retval true if anonymous, false if a username is specified
 820  */
 821
 822 _PUBLIC_ bool cli_credentials_is_anonymous(struct cli_credentials *cred)
 823 {
 824         const char *username;
 825
 826         /* if bind dn is set it's not anonymous */
 827         if (cred->bind_dn) {
 828                 return false;
 829         }
 830
 831         if (cred->machine_account_pending) {
 832                 cli_credentials_set_machine_account(cred,
 833                                                     cred->machine_account_pending_lp_ctx);
 834         }
 835
 836         username = cli_credentials_get_username(cred);
 837
 838         /* Yes, it is deliberate that we die if we have a NULL pointer
 839          * here - anonymous is "", not NULL, which is 'never specified,
 840          * never guessed', ie programmer bug */
 841         if (!username[0]) {
 842                 return true;
 843         }
 844
 845         return false;
 846 }
 847
 848 /**
 849  * Mark the current password for a credentials struct as wrong. This will
 850  * cause the password to be prompted again (if a callback is set).
 851  *
 852  * This will decrement the number of times the password can be tried.
 853  *
 854  * @retval whether the credentials struct is finished
 855  */
 856 _PUBLIC_ bool cli_credentials_wrong_password(struct cli_credentials *cred)
 857 {
 858         if (cred->password_obtained != CRED_CALLBACK_RESULT) {
 859                 return false;
 860         }
 861
 862         cred->password_obtained = CRED_CALLBACK;
 863
 864         cred->tries--;
 865
 866         return (cred->tries > 0);
 867 }
 868
 869 _PUBLIC_ void cli_credentials_get_ntlm_username_domain(struct cli_credentials *cred, TALLOC_CTX *mem_ctx,
 870                                               const char **username,
 871                                               const char **domain)
 872 {
 873         if (cred->principal_obtained > cred->username_obtained) {
 874                 *domain = talloc_strdup(mem_ctx, "");
 875                 *username = cli_credentials_get_principal(cred, mem_ctx);
 876         } else {
 877                 *domain = cli_credentials_get_domain(cred);
 878                 *username = cli_credentials_get_username(cred);
 879         }
 880 }
 881
 882 /**
 883  * Read a named file, and parse it for username, domain, realm and password
 884  *
 885  * @param credentials Credentials structure on which to set the password
 886  * @param file a named file to read the details from
 887  * @param obtained This enum describes how 'specified' this password is
 888  */
 889
 890 _PUBLIC_ bool cli_credentials_parse_file(struct cli_credentials *cred, const char *file, enum credentials_obtained obtained)
 891 {
 892         uint16_t len = 0;
 893         char *ptr, *val, *param;
 894         char **lines;
 895         int i, numlines;
 896
 897         lines = file_lines_load(file, &numlines, 0, NULL);
 898
 899         if (lines == NULL)
 900         {
 901                 /* fail if we can't open the credentials file */
 902                 d_printf("ERROR: Unable to open credentials file!\n");
 903                 return false;
 904         }
 905
 906         for (i = 0; i < numlines; i++) {
 907                 len = strlen(lines[i]);
 908
 909                 if (len == 0)
 910                         continue;
 911
 912                 /* break up the line into parameter & value.
 913                  * will need to eat a little whitespace possibly */
 914                 param = lines[i];
 915                 if (!(ptr = strchr_m (lines[i], '=')))
 916                         continue;
 917
 918                 val = ptr+1;
 919                 *ptr = '\0';
 920
 921                 /* eat leading white space */
 922                 while ((*val!='\0') && ((*val==' ') || (*val=='\t')))
 923                         val++;
 924
 925                 if (strwicmp("password", param) == 0) {
 926                         cli_credentials_set_password(cred, val, obtained);
 927                 } else if (strwicmp("username", param) == 0) {
 928                         cli_credentials_set_username(cred, val, obtained);
 929                 } else if (strwicmp("domain", param) == 0) {
 930                         cli_credentials_set_domain(cred, val, obtained);
 931                 } else if (strwicmp("realm", param) == 0) {
 932                         cli_credentials_set_realm(cred, val, obtained);
 933                 }
 934                 memset(lines[i], 0, len);
 935         }
 936
 937         talloc_free(lines);
 938
 939         return true;
 940 }
 941
 942 /**
 943  * Read a named file, and parse it for a password
 944  *
 945  * @param credentials Credentials structure on which to set the password
 946  * @param file a named file to read the password from
 947  * @param obtained This enum describes how 'specified' this password is
 948  */
 949
 950 _PUBLIC_ bool cli_credentials_parse_password_file(struct cli_credentials *credentials, const char *file, enum credentials_obtained obtained)
 951 {
 952         int fd = open(file, O_RDONLY, 0);
 953         bool ret;
 954
 955         if (fd < 0) {
 956                 fprintf(stderr, "Error opening password file %s: %s\n",
 957                                 file, strerror(errno));
 958                 return false;
 959         }
 960
 961         ret = cli_credentials_parse_password_fd(credentials, fd, obtained);
 962
 963         close(fd);
 964
 965         return ret;
 966 }
 967
 968
 969 /**
 970  * Read a file descriptor, and parse it for a password (eg from a file or stdin)
 971  *
 972  * @param credentials Credentials structure on which to set the password
 973  * @param fd open file descriptor to read the password from
 974  * @param obtained This enum describes how 'specified' this password is
 975  */
 976
 977 _PUBLIC_ bool cli_credentials_parse_password_fd(struct cli_credentials *credentials,
 978                                        int fd, enum credentials_obtained obtained)
 979 {
 980         char *p;
 981         char pass[128];
 982
 983         for(p = pass, *p = '\0'; /* ensure that pass is null-terminated */
 984                 p && p - pass < sizeof(pass);) {
 985                 switch (read(fd, p, 1)) {
 986                 case 1:
 987                         if (*p != '\n' && *p != '\0') {
 988                                 *++p = '\0'; /* advance p, and null-terminate pass */
 989                                 break;
 990                         }
 991                         /* fall through */
 992                 case 0:
 993                         if (p - pass) {
 994                                 *p = '\0'; /* null-terminate it, just in case... */
 995                                 p = NULL; /* then force the loop condition to become false */
 996                                 break;
 997                         } else {
 998                                 fprintf(stderr, "Error reading password from file descriptor %d: %s\n", fd, "empty password\n");
 999                                 return false;
1000                         }
1001
1002                 default:
1003                         fprintf(stderr, "Error reading password from file descriptor %d: %s\n",
1004                                         fd, strerror(errno));
1005                         return false;
1006                 }
1007         }
1008
1009         cli_credentials_set_password(credentials, pass, obtained);
1010         return true;
1011 }
1012
1013