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 sockaddr_storage dest_ss;
60 static struct client_connection *connections;
62 static bool cli_check_msdfs_proxy(TALLOC_CTX *ctx,
63 struct cli_state *cli,
64 const char *sharename,
72 /********************************************************************
73 Ensure a connection is encrypted.
74 ********************************************************************/
76 NTSTATUS cli_cm_force_encryption(struct cli_state *c,
80 const char *sharename)
82 NTSTATUS status = cli_force_encryption(c,
87 if (NT_STATUS_EQUAL(status,NT_STATUS_NOT_SUPPORTED)) {
88 d_printf("Encryption required and "
89 "server that doesn't support "
90 "UNIX extensions - failing connect\n");
91 } else if (NT_STATUS_EQUAL(status,NT_STATUS_UNKNOWN_REVISION)) {
92 d_printf("Encryption required and "
93 "can't get UNIX CIFS extensions "
94 "version from server.\n");
95 } else if (NT_STATUS_EQUAL(status,NT_STATUS_UNSUPPORTED_COMPRESSION)) {
96 d_printf("Encryption required and "
97 "share %s doesn't support "
98 "encryption.\n", sharename);
99 } else if (!NT_STATUS_IS_OK(status)) {
100 d_printf("Encryption required and "
101 "setup failed with error %s.\n",
108 /********************************************************************
109 Return a connection to a server.
110 ********************************************************************/
112 static struct cli_state *do_connect(TALLOC_CTX *ctx,
118 struct cli_state *c = NULL;
119 struct nmb_name called, calling;
120 const char *server_n;
121 struct sockaddr_storage ss;
124 char *newserver, *newshare;
125 const char *username;
126 const char *password;
129 /* make a copy so we don't modify the global string 'service' */
130 servicename = talloc_strdup(ctx,share);
134 sharename = servicename;
135 if (*sharename == '\\') {
136 server = sharename+2;
137 sharename = strchr_m(server,'\\');
149 make_nmb_name(&calling, global_myname(), 0x0);
150 make_nmb_name(&called , server, name_type);
157 /* have to open a new connection */
158 if (!(c=cli_initialise()) || (cli_set_port(c, port) != port)) {
159 d_printf("Connection to %s failed\n", server_n);
165 status = cli_connect(c, server_n, &ss);
166 if (!NT_STATUS_IS_OK(status)) {
167 d_printf("Connection to %s failed (Error %s)\n",
174 c->protocol = max_protocol;
175 c->use_kerberos = cm_creds.use_kerberos;
176 c->fallback_after_kerberos = cm_creds.fallback_after_kerberos;
177 cli_setup_signing_state(c, cm_creds.signing_state);
179 if (!cli_session_request(c, &calling, &called)) {
181 d_printf("session request to %s failed (%s)\n",
182 called.name, cli_errstr(c));
185 if ((p=strchr_m(called.name, '.'))) {
189 if (strcmp(called.name, "*SMBSERVER")) {
190 make_nmb_name(&called , "*SMBSERVER", 0x20);
196 DEBUG(4,(" session request ok\n"));
198 status = cli_negprot(c);
200 if (!NT_STATUS_IS_OK(status)) {
201 d_printf("protocol negotiation failed: %s\n",
207 if (!cm_creds.got_pass && !cm_creds.use_kerberos) {
210 label = talloc_asprintf(ctx, "Enter %s's password: ",
212 pass = getpass(label);
214 cm_set_password(pass);
219 username = cm_creds.username ? cm_creds.username : "";
220 password = cm_creds.password ? cm_creds.password : "";
222 if (!NT_STATUS_IS_OK(cli_session_setup(c, username,
223 password, strlen(password),
224 password, strlen(password),
226 /* If a password was not supplied then
227 * try again with a null username. */
228 if (password[0] || !username[0] || cm_creds.use_kerberos ||
229 !NT_STATUS_IS_OK(cli_session_setup(c, "",
233 d_printf("session setup failed: %s\n", cli_errstr(c));
234 if (NT_STATUS_V(cli_nt_error(c)) ==
235 NT_STATUS_V(NT_STATUS_MORE_PROCESSING_REQUIRED))
236 d_printf("did you forget to run kinit?\n");
240 d_printf("Anonymous login successful\n");
243 if ( show_sessetup ) {
244 if (*c->server_domain) {
245 DEBUG(0,("Domain=[%s] OS=[%s] Server=[%s]\n",
246 c->server_domain,c->server_os,c->server_type));
247 } else if (*c->server_os || *c->server_type) {
248 DEBUG(0,("OS=[%s] Server=[%s]\n",
249 c->server_os,c->server_type));
252 DEBUG(4,(" session setup ok\n"));
254 /* here's the fun part....to support 'msdfs proxy' shares
255 (on Samba or windows) we have to issues a TRANS_GET_DFS_REFERRAL
256 here before trying to connect to the original share.
257 check_dfs_proxy() will fail if it is a normal share. */
259 if ((c->capabilities & CAP_DFS) &&
260 cli_check_msdfs_proxy(ctx, c, sharename,
261 &newserver, &newshare,
267 return do_connect(ctx, newserver,
268 newshare, false, force_encrypt);
271 /* must be a normal share */
273 if (!cli_send_tconX(c, sharename, "?????",
274 password, strlen(password)+1)) {
275 d_printf("tree connect failed: %s\n", cli_errstr(c));
281 status = cli_cm_force_encryption(c,
286 if (!NT_STATUS_IS_OK(status)) {
292 DEBUG(4,(" tconx ok\n"));
296 /****************************************************************************
297 ****************************************************************************/
299 static void cli_cm_set_mntpoint(struct cli_state *c, const char *mnt)
301 struct client_connection *p;
304 for (p=connections,i=0; p; p=p->next,i++) {
305 if (strequal(p->cli->desthost, c->desthost) &&
306 strequal(p->cli->share, c->share)) {
312 char *name = clean_name(NULL, 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 ****************************************************************************/
556 void cli_cm_set_dest_ss(struct sockaddr_storage *pss)
562 /**********************************************************************
563 split a dfs path into the server, share name, and extrapath components
564 **********************************************************************/
566 static void split_dfs_path(TALLOC_CTX *ctx,
567 const char *nodepath,
577 *pp_extrapath = NULL;
579 path = talloc_strdup(ctx, nodepath);
584 if ( path[0] != '\\' ) {
588 p = strchr_m( path + 1, '\\' );
596 /* Look for any extra/deep path */
597 q = strchr_m(p, '\\');
601 *pp_extrapath = talloc_strdup(ctx, q);
603 *pp_extrapath = talloc_strdup(ctx, "");
606 *pp_share = talloc_strdup(ctx, p);
607 *pp_server = talloc_strdup(ctx, &path[1]);
610 /****************************************************************************
611 Return the original path truncated at the directory component before
612 the first wildcard character. Trust the caller to provide a NULL
614 ****************************************************************************/
616 static char *clean_path(TALLOC_CTX *ctx, const char *path)
622 /* No absolute paths. */
623 while (IS_DIRECTORY_SEP(*path)) {
627 path_out = talloc_strdup(ctx, path);
632 p1 = strchr_m(path_out, '*');
633 p2 = strchr_m(path_out, '?');
645 /* Now go back to the start of this component. */
646 p1 = strrchr_m(path_out, '/');
647 p2 = strrchr_m(path_out, '\\');
654 /* Strip any trailing separator */
656 len = strlen(path_out);
657 if ( (len > 0) && IS_DIRECTORY_SEP(path_out[len-1])) {
658 path_out[len-1] = '\0';
664 /****************************************************************************
665 ****************************************************************************/
667 static char *cli_dfs_make_full_path(TALLOC_CTX *ctx,
668 struct cli_state *cli,
671 /* Ensure the extrapath doesn't start with a separator. */
672 while (IS_DIRECTORY_SEP(*dir)) {
676 return talloc_asprintf(ctx, "\\%s\\%s\\%s",
677 cli->desthost, cli->share, dir);
680 /********************************************************************
681 check for dfs referral
682 ********************************************************************/
684 static bool cli_dfs_check_error( struct cli_state *cli, NTSTATUS status )
686 uint32 flgs2 = SVAL(cli->inbuf,smb_flg2);
688 /* only deal with DS when we negotiated NT_STATUS codes and UNICODE */
690 if (!((flgs2&FLAGS2_32_BIT_ERROR_CODES) &&
691 (flgs2&FLAGS2_UNICODE_STRINGS)))
694 if (NT_STATUS_EQUAL(status, NT_STATUS(IVAL(cli->inbuf,smb_rcls))))
700 /********************************************************************
701 Get the dfs referral link.
702 ********************************************************************/
704 bool cli_dfs_get_referral(TALLOC_CTX *ctx,
705 struct cli_state *cli,
707 CLIENT_DFS_REFERRAL**refs,
711 unsigned int data_len = 0;
712 unsigned int param_len = 0;
713 uint16 setup = TRANSACT2_GET_DFS_REFERRAL;
715 char *rparam=NULL, *rdata=NULL;
718 size_t pathlen = 2*(strlen(path)+1);
719 uint16 num_referrals;
720 CLIENT_DFS_REFERRAL *referrals = NULL;
726 param = SMB_MALLOC_ARRAY(char, 2+pathlen+2);
730 SSVAL(param, 0, 0x03); /* max referral level */
733 p += clistr_push(cli, p, path, pathlen, STR_TERMINATE);
734 param_len = PTR_DIFF(p, param);
736 if (!cli_send_trans(cli, SMBtrans2,
738 -1, 0, /* fid, flags */
739 &setup, 1, 0, /* setup, length, max */
740 param, param_len, 2, /* param, length, max */
741 NULL, 0, cli->max_xmit /* data, length, max */
749 if (!cli_receive_trans(cli, SMBtrans2,
751 &rdata, &data_len)) {
759 endp = rdata + data_len;
761 *consumed = SVAL(rdata, 0);
762 num_referrals = SVAL(rdata, 2);
764 if (num_referrals != 0) {
770 referrals = TALLOC_ARRAY(ctx, CLIENT_DFS_REFERRAL,
776 /* start at the referrals array */
779 for (i=0; i<num_referrals && p < endp; i++) {
783 ref_version = SVAL(p, 0);
784 ref_size = SVAL(p, 2);
785 node_offset = SVAL(p, 16);
787 if (ref_version != 3) {
792 referrals[i].proximity = SVAL(p, 8);
793 referrals[i].ttl = SVAL(p, 10);
795 if (p + node_offset > endp) {
798 clistr_pull_talloc(ctx, cli, &referrals[i].dfspath,
800 STR_TERMINATE|STR_UNICODE );
802 if (!referrals[i].dfspath) {
807 if (i < num_referrals) {
814 *num_refs = num_referrals;
824 /********************************************************************
825 ********************************************************************/
827 bool cli_resolve_path(TALLOC_CTX *ctx,
829 struct cli_state *rootcli,
831 struct cli_state **targetcli,
832 char **pp_targetpath)
834 CLIENT_DFS_REFERRAL *refs = NULL;
837 struct cli_state *cli_ipc = NULL;
838 char *dfs_path = NULL;
839 char *cleanpath = NULL;
840 char *extrapath = NULL;
844 struct cli_state *newcli = NULL;
845 char *newpath = NULL;
846 char *newmount = NULL;
848 SMB_STRUCT_STAT sbuf;
851 if ( !rootcli || !path || !targetcli ) {
855 /* Don't do anything if this is not a DFS root. */
857 if ( !rootcli->dfsroot) {
858 *targetcli = rootcli;
859 *pp_targetpath = talloc_strdup(ctx, path);
860 if (!*pp_targetpath) {
868 /* Send a trans2_query_path_info to check for a referral. */
870 cleanpath = clean_path(ctx, path);
875 dfs_path = cli_dfs_make_full_path(ctx, rootcli, cleanpath);
880 if (cli_qpathinfo_basic( rootcli, dfs_path, &sbuf, &attributes)) {
881 /* This is an ordinary path, just return it. */
882 *targetcli = rootcli;
883 *pp_targetpath = talloc_strdup(ctx, path);
884 if (!*pp_targetpath) {
890 /* Special case where client asked for a path that does not exist */
892 if (cli_dfs_check_error(rootcli, NT_STATUS_OBJECT_NAME_NOT_FOUND)) {
893 *targetcli = rootcli;
894 *pp_targetpath = talloc_strdup(ctx, path);
895 if (!*pp_targetpath) {
901 /* We got an error, check for DFS referral. */
903 if (!cli_dfs_check_error(rootcli, NT_STATUS_PATH_NOT_COVERED)) {
907 /* Check for the referral. */
909 if (!(cli_ipc = cli_cm_open(ctx, rootcli,
912 (rootcli->trans_enc_state != NULL)))) {
916 if (!cli_dfs_get_referral(ctx, cli_ipc, dfs_path, &refs,
917 &num_refs, &consumed) || !num_refs) {
921 /* Just store the first referral for now. */
923 if (!refs[0].dfspath) {
926 split_dfs_path(ctx, refs[0].dfspath, &server, &share, &extrapath );
928 if (!server || !share) {
932 /* Make sure to recreate the original string including any wildcards. */
934 dfs_path = cli_dfs_make_full_path(ctx, rootcli, path);
938 pathlen = strlen(dfs_path)*2;
939 consumed = MIN(pathlen, consumed);
940 *pp_targetpath = talloc_strdup(ctx, &dfs_path[consumed/2]);
941 if (!*pp_targetpath) {
944 dfs_path[consumed/2] = '\0';
947 * *pp_targetpath is now the unconsumed part of the path.
948 * dfs_path is now the consumed part of the path
949 * (in \server\share\path format).
952 /* Open the connection to the target server & share */
953 if ((*targetcli = cli_cm_open(ctx, rootcli,
957 (rootcli->trans_enc_state != NULL))) == NULL) {
958 d_printf("Unable to follow dfs referral [\\%s\\%s]\n",
963 if (extrapath && strlen(extrapath) > 0) {
964 *pp_targetpath = talloc_asprintf(ctx,
968 if (!*pp_targetpath) {
973 /* parse out the consumed mount path */
974 /* trim off the \server\share\ */
978 if (*ppath != '\\') {
979 d_printf("cli_resolve_path: "
980 "dfs_path (%s) not in correct format.\n",
985 ppath++; /* Now pointing at start of server name. */
987 if ((ppath = strchr_m( dfs_path, '\\' )) == NULL) {
991 ppath++; /* Now pointing at start of share name. */
993 if ((ppath = strchr_m( ppath+1, '\\' )) == NULL) {
997 ppath++; /* Now pointing at path component. */
999 newmount = talloc_asprintf(ctx, "%s\\%s", mountpt, ppath );
1004 cli_cm_set_mntpoint(*targetcli, newmount);
1006 /* Check for another dfs referral, note that we are not
1007 checking for loops here. */
1009 if (!strequal(*pp_targetpath, "\\") && !strequal(*pp_targetpath, "/")) {
1010 if (cli_resolve_path(ctx,
1017 * When cli_resolve_path returns true here it's always
1018 * returning the complete path in newpath, so we're done
1021 *targetcli = newcli;
1022 *pp_targetpath = newpath;
1029 /* If returning true ensure we return a dfs root full path. */
1030 if ((*targetcli)->dfsroot) {
1031 dfs_path = talloc_strdup(ctx, *pp_targetpath);
1035 *pp_targetpath = cli_dfs_make_full_path(ctx, *targetcli, dfs_path);
1041 /********************************************************************
1042 ********************************************************************/
1044 static bool cli_check_msdfs_proxy(TALLOC_CTX *ctx,
1045 struct cli_state *cli,
1046 const char *sharename,
1047 char **pp_newserver,
1050 const char *username,
1051 const char *password,
1054 CLIENT_DFS_REFERRAL *refs = NULL;
1055 size_t num_refs = 0;
1057 char *fullpath = NULL;
1060 char *newextrapath = NULL;
1062 if (!cli || !sharename) {
1068 /* special case. never check for a referral on the IPC$ share */
1070 if (strequal(sharename, "IPC$")) {
1074 /* send a trans2_query_path_info to check for a referral */
1076 fullpath = talloc_asprintf(ctx, "\\%s\\%s", cli->desthost, sharename );
1081 /* check for the referral */
1083 if (!cli_send_tconX(cli, "IPC$", "IPC", NULL, 0)) {
1087 if (force_encrypt) {
1088 NTSTATUS status = cli_cm_force_encryption(cli,
1093 if (!NT_STATUS_IS_OK(status)) {
1098 res = cli_dfs_get_referral(ctx, cli, fullpath, &refs, &num_refs, &consumed);
1100 if (!cli_tdis(cli)) {
1106 if (!res || !num_refs) {
1110 if (!refs[0].dfspath) {
1114 split_dfs_path(ctx, refs[0].dfspath, pp_newserver,
1115 pp_newshare, &newextrapath );
1117 if ((*pp_newserver == NULL) || (*pp_newshare == NULL)) {
1121 /* check that this is not a self-referral */
1123 if (strequal(cli->desthost, *pp_newserver) &&
1124 strequal(sharename, *pp_newshare)) {