2 Unix SMB/CIFS implementation.
3 client connect/disconnect routines
4 Copyright (C) Andrew Tridgell 1994-1998
5 Copyright (C) Gerald (Jerry) Carter 2004
6 Copyright (C) Jeremy Allison 2007
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>.
24 /********************************************************************
27 DFS paths are *always* of the form \server\share\<pathname> (the \ characters
28 are not C escaped here).
30 - but if we're using POSIX paths then <pathname> may contain
31 '/' separators, not '\\' separators. So cope with '\\' or '/'
32 as a separator when looking at the pathname part.... JRA.
33 ********************************************************************/
35 struct client_connection {
36 struct client_connection *prev, *next;
37 struct cli_state *cli;
41 /* global state....globals reek! */
42 int max_protocol = PROTOCOL_NT1;
44 static struct cm_cred_struct {
49 bool fallback_after_kerberos;
53 static void cm_set_password(const char *newpass);
56 static int name_type = 0x20;
58 static struct client_connection *connections;
60 static bool cli_check_msdfs_proxy(TALLOC_CTX *ctx,
61 struct cli_state *cli,
62 const char *sharename,
70 /********************************************************************
71 Ensure a connection is encrypted.
72 ********************************************************************/
74 NTSTATUS cli_cm_force_encryption(struct cli_state *c,
78 const char *sharename)
80 NTSTATUS status = cli_force_encryption(c,
85 if (NT_STATUS_EQUAL(status,NT_STATUS_NOT_SUPPORTED)) {
86 d_printf("Encryption required and "
87 "server that doesn't support "
88 "UNIX extensions - failing connect\n");
89 } else if (NT_STATUS_EQUAL(status,NT_STATUS_UNKNOWN_REVISION)) {
90 d_printf("Encryption required and "
91 "can't get UNIX CIFS extensions "
92 "version from server.\n");
93 } else if (NT_STATUS_EQUAL(status,NT_STATUS_UNSUPPORTED_COMPRESSION)) {
94 d_printf("Encryption required and "
95 "share %s doesn't support "
96 "encryption.\n", sharename);
97 } else if (!NT_STATUS_IS_OK(status)) {
98 d_printf("Encryption required and "
99 "setup failed with error %s.\n",
106 /********************************************************************
107 Return a connection to a server.
108 ********************************************************************/
110 static struct cli_state *do_connect(TALLOC_CTX *ctx,
116 struct cli_state *c = NULL;
117 struct nmb_name called, calling;
118 const char *server_n;
119 struct sockaddr_storage ss;
122 char *newserver, *newshare;
123 const char *username;
124 const char *password;
127 /* make a copy so we don't modify the global string 'service' */
128 servicename = talloc_strdup(ctx,share);
132 sharename = servicename;
133 if (*sharename == '\\') {
135 if (server == NULL) {
138 sharename = strchr_m(sharename,'\\');
150 make_nmb_name(&calling, global_myname(), 0x0);
151 make_nmb_name(&called , server, name_type);
156 /* have to open a new connection */
157 if (!(c=cli_initialise()) || (cli_set_port(c, port) != port)) {
158 d_printf("Connection to %s failed\n", server_n);
164 status = cli_connect(c, server_n, &ss);
165 if (!NT_STATUS_IS_OK(status)) {
166 d_printf("Connection to %s failed (Error %s)\n",
173 c->protocol = max_protocol;
174 c->use_kerberos = cm_creds.use_kerberos;
175 c->fallback_after_kerberos = cm_creds.fallback_after_kerberos;
176 cli_setup_signing_state(c, cm_creds.signing_state);
178 if (!cli_session_request(c, &calling, &called)) {
180 d_printf("session request to %s failed (%s)\n",
181 called.name, cli_errstr(c));
184 if ((p=strchr_m(called.name, '.'))) {
188 if (strcmp(called.name, "*SMBSERVER")) {
189 make_nmb_name(&called , "*SMBSERVER", 0x20);
195 DEBUG(4,(" session request ok\n"));
197 status = cli_negprot(c);
199 if (!NT_STATUS_IS_OK(status)) {
200 d_printf("protocol negotiation failed: %s\n",
206 if (!cm_creds.got_pass && !cm_creds.use_kerberos) {
209 label = talloc_asprintf(ctx, "Enter %s's password: ",
211 pass = getpass(label);
213 cm_set_password(pass);
218 username = cm_creds.username ? cm_creds.username : "";
219 password = cm_creds.password ? cm_creds.password : "";
221 if (!NT_STATUS_IS_OK(cli_session_setup(c, username,
222 password, strlen(password),
223 password, strlen(password),
225 /* If a password was not supplied then
226 * try again with a null username. */
227 if (password[0] || !username[0] || cm_creds.use_kerberos ||
228 !NT_STATUS_IS_OK(cli_session_setup(c, "",
232 d_printf("session setup failed: %s\n", cli_errstr(c));
233 if (NT_STATUS_V(cli_nt_error(c)) ==
234 NT_STATUS_V(NT_STATUS_MORE_PROCESSING_REQUIRED))
235 d_printf("did you forget to run kinit?\n");
239 d_printf("Anonymous login successful\n");
242 if ( show_sessetup ) {
243 if (*c->server_domain) {
244 DEBUG(0,("Domain=[%s] OS=[%s] Server=[%s]\n",
245 c->server_domain,c->server_os,c->server_type));
246 } else if (*c->server_os || *c->server_type) {
247 DEBUG(0,("OS=[%s] Server=[%s]\n",
248 c->server_os,c->server_type));
251 DEBUG(4,(" session setup ok\n"));
253 /* here's the fun part....to support 'msdfs proxy' shares
254 (on Samba or windows) we have to issues a TRANS_GET_DFS_REFERRAL
255 here before trying to connect to the original share.
256 check_dfs_proxy() will fail if it is a normal share. */
258 if ((c->capabilities & CAP_DFS) &&
259 cli_check_msdfs_proxy(ctx, c, sharename,
260 &newserver, &newshare,
266 return do_connect(ctx, newserver,
267 newshare, false, force_encrypt);
270 /* must be a normal share */
272 if (!cli_send_tconX(c, sharename, "?????",
273 password, strlen(password)+1)) {
274 d_printf("tree connect failed: %s\n", cli_errstr(c));
280 status = cli_cm_force_encryption(c,
285 if (!NT_STATUS_IS_OK(status)) {
291 DEBUG(4,(" tconx ok\n"));
295 /****************************************************************************
296 ****************************************************************************/
298 static void cli_cm_set_mntpoint(struct cli_state *c, const char *mnt)
300 struct client_connection *p;
303 for (p=connections,i=0; p; p=p->next,i++) {
304 if (strequal(p->cli->desthost, c->desthost) &&
305 strequal(p->cli->share, c->share)) {
311 char *name = clean_name(NULL, mnt);
315 TALLOC_FREE(p->mount);
316 p->mount = talloc_strdup(p, name);
321 /****************************************************************************
322 ****************************************************************************/
324 const char *cli_cm_get_mntpoint(struct cli_state *c)
326 struct client_connection *p;
329 for (p=connections,i=0; p; p=p->next,i++) {
330 if (strequal(p->cli->desthost, c->desthost) &&
331 strequal(p->cli->share, c->share)) {
342 /********************************************************************
343 Add a new connection to the list
344 ********************************************************************/
346 static struct cli_state *cli_cm_connect(TALLOC_CTX *ctx,
347 struct cli_state *referring_cli,
353 struct client_connection *node;
355 /* NB This must be the null context here... JRA. */
356 node = TALLOC_ZERO_ARRAY(NULL, struct client_connection, 1);
361 node->cli = do_connect(ctx, server, share, show_hdr, force_encrypt);
368 DLIST_ADD( connections, node );
370 cli_cm_set_mntpoint(node->cli, "");
372 if (referring_cli && referring_cli->posix_capabilities) {
374 uint32 caplow, caphigh;
375 if (cli_unix_extensions_version(node->cli, &major,
376 &minor, &caplow, &caphigh)) {
377 cli_set_unix_extensions_capabilities(node->cli,
386 /********************************************************************
387 Return a connection to a server.
388 ********************************************************************/
390 static struct cli_state *cli_cm_find(const char *server, const char *share)
392 struct client_connection *p;
394 for (p=connections; p; p=p->next) {
395 if ( strequal(server, p->cli->desthost) &&
396 strequal(share,p->cli->share)) {
404 /****************************************************************************
405 Open a client connection to a \\server\share. Set's the current *cli
406 global variable as a side-effect (but only if the connection is successful).
407 ****************************************************************************/
409 struct cli_state *cli_cm_open(TALLOC_CTX *ctx,
410 struct cli_state *referring_cli,
418 /* try to reuse an existing connection */
420 c = cli_cm_find(server, share);
422 c = cli_cm_connect(ctx, referring_cli,
423 server, share, show_hdr, force_encrypt);
429 /****************************************************************************
430 ****************************************************************************/
432 void cli_cm_shutdown(void)
434 struct client_connection *p, *x;
436 for (p=connections; p;) {
437 cli_shutdown(p->cli);
448 /****************************************************************************
449 ****************************************************************************/
451 void cli_cm_display(void)
453 struct client_connection *p;
456 for ( p=connections,i=0; p; p=p->next,i++ ) {
457 d_printf("%d:\tserver=%s, share=%s\n",
458 i, p->cli->desthost, p->cli->share );
462 /****************************************************************************
463 ****************************************************************************/
465 static void cm_set_password(const char *newpass)
467 SAFE_FREE(cm_creds.password);
468 cm_creds.password = SMB_STRDUP(newpass);
469 if (cm_creds.password) {
470 cm_creds.got_pass = true;
474 /****************************************************************************
475 ****************************************************************************/
477 void cli_cm_set_credentials(struct user_auth_info *auth_info)
479 SAFE_FREE(cm_creds.username);
480 cm_creds.username = SMB_STRDUP(get_cmdline_auth_info_username(
483 if (get_cmdline_auth_info_got_pass(auth_info)) {
484 cm_set_password(get_cmdline_auth_info_password(auth_info));
487 cm_creds.use_kerberos = get_cmdline_auth_info_use_kerberos(auth_info);
488 cm_creds.fallback_after_kerberos = false;
489 cm_creds.signing_state = get_cmdline_auth_info_signing_state(auth_info);
492 /****************************************************************************
493 ****************************************************************************/
495 void cli_cm_set_port(int port_number)
500 /****************************************************************************
501 ****************************************************************************/
503 void cli_cm_set_dest_name_type(int type)
508 /****************************************************************************
509 ****************************************************************************/
511 void cli_cm_set_signing_state(int state)
513 cm_creds.signing_state = state;
516 /****************************************************************************
517 ****************************************************************************/
519 void cli_cm_set_username(const char *username)
521 SAFE_FREE(cm_creds.username);
522 cm_creds.username = SMB_STRDUP(username);
525 /****************************************************************************
526 ****************************************************************************/
528 void cli_cm_set_password(const char *newpass)
530 SAFE_FREE(cm_creds.password);
531 cm_creds.password = SMB_STRDUP(newpass);
532 if (cm_creds.password) {
533 cm_creds.got_pass = true;
537 /****************************************************************************
538 ****************************************************************************/
540 void cli_cm_set_use_kerberos(void)
542 cm_creds.use_kerberos = true;
545 /****************************************************************************
546 ****************************************************************************/
548 void cli_cm_set_fallback_after_kerberos(void)
550 cm_creds.fallback_after_kerberos = true;
553 /**********************************************************************
554 split a dfs path into the server, share name, and extrapath components
555 **********************************************************************/
557 static void split_dfs_path(TALLOC_CTX *ctx,
558 const char *nodepath,
568 *pp_extrapath = NULL;
570 path = talloc_strdup(ctx, nodepath);
575 if ( path[0] != '\\' ) {
579 p = strchr_m( path + 1, '\\' );
587 /* Look for any extra/deep path */
588 q = strchr_m(p, '\\');
592 *pp_extrapath = talloc_strdup(ctx, q);
594 *pp_extrapath = talloc_strdup(ctx, "");
597 *pp_share = talloc_strdup(ctx, p);
598 *pp_server = talloc_strdup(ctx, &path[1]);
601 /****************************************************************************
602 Return the original path truncated at the directory component before
603 the first wildcard character. Trust the caller to provide a NULL
605 ****************************************************************************/
607 static char *clean_path(TALLOC_CTX *ctx, const char *path)
613 /* No absolute paths. */
614 while (IS_DIRECTORY_SEP(*path)) {
618 path_out = talloc_strdup(ctx, path);
623 p1 = strchr_m(path_out, '*');
624 p2 = strchr_m(path_out, '?');
636 /* Now go back to the start of this component. */
637 p1 = strrchr_m(path_out, '/');
638 p2 = strrchr_m(path_out, '\\');
645 /* Strip any trailing separator */
647 len = strlen(path_out);
648 if ( (len > 0) && IS_DIRECTORY_SEP(path_out[len-1])) {
649 path_out[len-1] = '\0';
655 /****************************************************************************
656 ****************************************************************************/
658 static char *cli_dfs_make_full_path(TALLOC_CTX *ctx,
659 struct cli_state *cli,
662 /* Ensure the extrapath doesn't start with a separator. */
663 while (IS_DIRECTORY_SEP(*dir)) {
667 return talloc_asprintf(ctx, "\\%s\\%s\\%s",
668 cli->desthost, cli->share, dir);
671 /********************************************************************
672 check for dfs referral
673 ********************************************************************/
675 static bool cli_dfs_check_error( struct cli_state *cli, NTSTATUS status )
677 uint32 flgs2 = SVAL(cli->inbuf,smb_flg2);
679 /* only deal with DS when we negotiated NT_STATUS codes and UNICODE */
681 if (!((flgs2&FLAGS2_32_BIT_ERROR_CODES) &&
682 (flgs2&FLAGS2_UNICODE_STRINGS)))
685 if (NT_STATUS_EQUAL(status, NT_STATUS(IVAL(cli->inbuf,smb_rcls))))
691 /********************************************************************
692 Get the dfs referral link.
693 ********************************************************************/
695 bool cli_dfs_get_referral(TALLOC_CTX *ctx,
696 struct cli_state *cli,
698 CLIENT_DFS_REFERRAL**refs,
702 unsigned int data_len = 0;
703 unsigned int param_len = 0;
704 uint16 setup = TRANSACT2_GET_DFS_REFERRAL;
706 char *rparam=NULL, *rdata=NULL;
709 size_t pathlen = 2*(strlen(path)+1);
710 uint16 num_referrals;
711 CLIENT_DFS_REFERRAL *referrals = NULL;
717 param = SMB_MALLOC_ARRAY(char, 2+pathlen+2);
721 SSVAL(param, 0, 0x03); /* max referral level */
724 p += clistr_push(cli, p, path, pathlen, STR_TERMINATE);
725 param_len = PTR_DIFF(p, param);
727 if (!cli_send_trans(cli, SMBtrans2,
729 -1, 0, /* fid, flags */
730 &setup, 1, 0, /* setup, length, max */
731 param, param_len, 2, /* param, length, max */
732 NULL, 0, cli->max_xmit /* data, length, max */
740 if (!cli_receive_trans(cli, SMBtrans2,
742 &rdata, &data_len)) {
750 endp = rdata + data_len;
752 *consumed = SVAL(rdata, 0);
753 num_referrals = SVAL(rdata, 2);
755 if (num_referrals != 0) {
761 referrals = TALLOC_ARRAY(ctx, CLIENT_DFS_REFERRAL,
767 /* start at the referrals array */
770 for (i=0; i<num_referrals && p < endp; i++) {
774 ref_version = SVAL(p, 0);
775 ref_size = SVAL(p, 2);
776 node_offset = SVAL(p, 16);
778 if (ref_version != 3) {
783 referrals[i].proximity = SVAL(p, 8);
784 referrals[i].ttl = SVAL(p, 10);
786 if (p + node_offset > endp) {
789 clistr_pull_talloc(ctx, cli, &referrals[i].dfspath,
791 STR_TERMINATE|STR_UNICODE );
793 if (!referrals[i].dfspath) {
798 if (i < num_referrals) {
805 *num_refs = num_referrals;
815 /********************************************************************
816 ********************************************************************/
818 bool cli_resolve_path(TALLOC_CTX *ctx,
820 struct cli_state *rootcli,
822 struct cli_state **targetcli,
823 char **pp_targetpath)
825 CLIENT_DFS_REFERRAL *refs = NULL;
828 struct cli_state *cli_ipc = NULL;
829 char *dfs_path = NULL;
830 char *cleanpath = NULL;
831 char *extrapath = NULL;
835 struct cli_state *newcli = NULL;
836 char *newpath = NULL;
837 char *newmount = NULL;
839 SMB_STRUCT_STAT sbuf;
842 if ( !rootcli || !path || !targetcli ) {
846 /* Don't do anything if this is not a DFS root. */
848 if ( !rootcli->dfsroot) {
849 *targetcli = rootcli;
850 *pp_targetpath = talloc_strdup(ctx, path);
851 if (!*pp_targetpath) {
859 /* Send a trans2_query_path_info to check for a referral. */
861 cleanpath = clean_path(ctx, path);
866 dfs_path = cli_dfs_make_full_path(ctx, rootcli, cleanpath);
871 if (cli_qpathinfo_basic( rootcli, dfs_path, &sbuf, &attributes)) {
872 /* This is an ordinary path, just return it. */
873 *targetcli = rootcli;
874 *pp_targetpath = talloc_strdup(ctx, path);
875 if (!*pp_targetpath) {
881 /* Special case where client asked for a path that does not exist */
883 if (cli_dfs_check_error(rootcli, NT_STATUS_OBJECT_NAME_NOT_FOUND)) {
884 *targetcli = rootcli;
885 *pp_targetpath = talloc_strdup(ctx, path);
886 if (!*pp_targetpath) {
892 /* We got an error, check for DFS referral. */
894 if (!cli_dfs_check_error(rootcli, NT_STATUS_PATH_NOT_COVERED)) {
898 /* Check for the referral. */
900 if (!(cli_ipc = cli_cm_open(ctx, rootcli,
903 (rootcli->trans_enc_state != NULL)))) {
907 if (!cli_dfs_get_referral(ctx, cli_ipc, dfs_path, &refs,
908 &num_refs, &consumed) || !num_refs) {
912 /* Just store the first referral for now. */
914 if (!refs[0].dfspath) {
917 split_dfs_path(ctx, refs[0].dfspath, &server, &share, &extrapath );
919 if (!server || !share) {
923 /* Make sure to recreate the original string including any wildcards. */
925 dfs_path = cli_dfs_make_full_path(ctx, rootcli, path);
929 pathlen = strlen(dfs_path)*2;
930 consumed = MIN(pathlen, consumed);
931 *pp_targetpath = talloc_strdup(ctx, &dfs_path[consumed/2]);
932 if (!*pp_targetpath) {
935 dfs_path[consumed/2] = '\0';
938 * *pp_targetpath is now the unconsumed part of the path.
939 * dfs_path is now the consumed part of the path
940 * (in \server\share\path format).
943 /* Open the connection to the target server & share */
944 if ((*targetcli = cli_cm_open(ctx, rootcli,
948 (rootcli->trans_enc_state != NULL))) == NULL) {
949 d_printf("Unable to follow dfs referral [\\%s\\%s]\n",
954 if (extrapath && strlen(extrapath) > 0) {
955 *pp_targetpath = talloc_asprintf(ctx,
959 if (!*pp_targetpath) {
964 /* parse out the consumed mount path */
965 /* trim off the \server\share\ */
969 if (*ppath != '\\') {
970 d_printf("cli_resolve_path: "
971 "dfs_path (%s) not in correct format.\n",
976 ppath++; /* Now pointing at start of server name. */
978 if ((ppath = strchr_m( dfs_path, '\\' )) == NULL) {
982 ppath++; /* Now pointing at start of share name. */
984 if ((ppath = strchr_m( ppath+1, '\\' )) == NULL) {
988 ppath++; /* Now pointing at path component. */
990 newmount = talloc_asprintf(ctx, "%s\\%s", mountpt, ppath );
995 cli_cm_set_mntpoint(*targetcli, newmount);
997 /* Check for another dfs referral, note that we are not
998 checking for loops here. */
1000 if (!strequal(*pp_targetpath, "\\") && !strequal(*pp_targetpath, "/")) {
1001 if (cli_resolve_path(ctx,
1008 * When cli_resolve_path returns true here it's always
1009 * returning the complete path in newpath, so we're done
1012 *targetcli = newcli;
1013 *pp_targetpath = newpath;
1020 /* If returning true ensure we return a dfs root full path. */
1021 if ((*targetcli)->dfsroot) {
1022 dfs_path = talloc_strdup(ctx, *pp_targetpath);
1026 *pp_targetpath = cli_dfs_make_full_path(ctx, *targetcli, dfs_path);
1032 /********************************************************************
1033 ********************************************************************/
1035 static bool cli_check_msdfs_proxy(TALLOC_CTX *ctx,
1036 struct cli_state *cli,
1037 const char *sharename,
1038 char **pp_newserver,
1041 const char *username,
1042 const char *password,
1045 CLIENT_DFS_REFERRAL *refs = NULL;
1046 size_t num_refs = 0;
1048 char *fullpath = NULL;
1051 char *newextrapath = NULL;
1053 if (!cli || !sharename) {
1059 /* special case. never check for a referral on the IPC$ share */
1061 if (strequal(sharename, "IPC$")) {
1065 /* send a trans2_query_path_info to check for a referral */
1067 fullpath = talloc_asprintf(ctx, "\\%s\\%s", cli->desthost, sharename );
1072 /* check for the referral */
1074 if (!cli_send_tconX(cli, "IPC$", "IPC", NULL, 0)) {
1078 if (force_encrypt) {
1079 NTSTATUS status = cli_cm_force_encryption(cli,
1084 if (!NT_STATUS_IS_OK(status)) {
1089 res = cli_dfs_get_referral(ctx, cli, fullpath, &refs, &num_refs, &consumed);
1091 if (!cli_tdis(cli)) {
1097 if (!res || !num_refs) {
1101 if (!refs[0].dfspath) {
1105 split_dfs_path(ctx, refs[0].dfspath, pp_newserver,
1106 pp_newshare, &newextrapath );
1108 if ((*pp_newserver == NULL) || (*pp_newshare == NULL)) {
1112 /* check that this is not a self-referral */
1114 if (strequal(cli->desthost, *pp_newserver) &&
1115 strequal(sharename, *pp_newshare)) {