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-2009
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/>.
23 #include "libsmb/libsmb.h"
24 #include "libsmb/clirap.h"
27 #include "libsmb/nmblib.h"
29 /********************************************************************
32 DFS paths are *always* of the form \server\share\<pathname> (the \ characters
33 are not C escaped here).
35 - but if we're using POSIX paths then <pathname> may contain
36 '/' separators, not '\\' separators. So cope with '\\' or '/'
37 as a separator when looking at the pathname part.... JRA.
38 ********************************************************************/
40 /********************************************************************
41 Ensure a connection is encrypted.
42 ********************************************************************/
44 NTSTATUS cli_cm_force_encryption(struct cli_state *c,
48 const char *sharename)
50 NTSTATUS status = cli_force_encryption(c,
55 if (NT_STATUS_EQUAL(status,NT_STATUS_NOT_SUPPORTED)) {
56 d_printf("Encryption required and "
57 "server that doesn't support "
58 "UNIX extensions - failing connect\n");
59 } else if (NT_STATUS_EQUAL(status,NT_STATUS_UNKNOWN_REVISION)) {
60 d_printf("Encryption required and "
61 "can't get UNIX CIFS extensions "
62 "version from server.\n");
63 } else if (NT_STATUS_EQUAL(status,NT_STATUS_UNSUPPORTED_COMPRESSION)) {
64 d_printf("Encryption required and "
65 "share %s doesn't support "
66 "encryption.\n", sharename);
67 } else if (!NT_STATUS_IS_OK(status)) {
68 d_printf("Encryption required and "
69 "setup failed with error %s.\n",
76 /********************************************************************
77 Return a connection to a server.
78 ********************************************************************/
80 static NTSTATUS do_connect(TALLOC_CTX *ctx,
83 const struct user_auth_info *auth_info,
89 struct cli_state **pcli)
91 struct cli_state *c = NULL;
94 char *newserver, *newshare;
99 /* make a copy so we don't modify the global string 'service' */
100 servicename = talloc_strdup(ctx,share);
102 return NT_STATUS_NO_MEMORY;
104 sharename = servicename;
105 if (*sharename == '\\') {
107 if (server == NULL) {
110 sharename = strchr_m(sharename,'\\');
112 return NT_STATUS_NO_MEMORY;
117 if (server == NULL) {
118 return NT_STATUS_INVALID_PARAMETER;
121 status = cli_connect_nb(
122 server, NULL, port, name_type, NULL,
123 get_cmdline_auth_info_signing_state(auth_info), &c);
125 if (!NT_STATUS_IS_OK(status)) {
126 d_printf("Connection to %s failed (Error %s)\n",
132 if (max_protocol == 0) {
133 max_protocol = PROTOCOL_NT1;
135 c->protocol = max_protocol;
136 c->use_kerberos = get_cmdline_auth_info_use_kerberos(auth_info);
137 c->fallback_after_kerberos =
138 get_cmdline_auth_info_fallback_after_kerberos(auth_info);
139 c->use_ccache = get_cmdline_auth_info_use_ccache(auth_info);
141 DEBUG(4,(" session request ok\n"));
143 status = cli_negprot(c);
145 if (!NT_STATUS_IS_OK(status)) {
146 d_printf("protocol negotiation failed: %s\n",
152 username = get_cmdline_auth_info_username(auth_info);
153 password = get_cmdline_auth_info_password(auth_info);
155 status = cli_session_setup(c, username,
156 password, strlen(password),
157 password, strlen(password),
159 if (!NT_STATUS_IS_OK(status)) {
160 /* If a password was not supplied then
161 * try again with a null username. */
162 if (password[0] || !username[0] ||
163 get_cmdline_auth_info_use_kerberos(auth_info) ||
164 !NT_STATUS_IS_OK(status = cli_session_setup(c, "",
168 d_printf("session setup failed: %s\n",
170 if (NT_STATUS_V(cli_nt_error(c)) ==
171 NT_STATUS_V(NT_STATUS_MORE_PROCESSING_REQUIRED))
172 d_printf("did you forget to run kinit?\n");
176 d_printf("Anonymous login successful\n");
177 status = cli_init_creds(c, "", lp_workgroup(), "");
179 status = cli_init_creds(c, username, lp_workgroup(), password);
182 if (!NT_STATUS_IS_OK(status)) {
183 DEBUG(10,("cli_init_creds() failed: %s\n", nt_errstr(status)));
188 if ( show_sessetup ) {
189 if (*c->server_domain) {
190 DEBUG(0,("Domain=[%s] OS=[%s] Server=[%s]\n",
191 c->server_domain,c->server_os,c->server_type));
192 } else if (*c->server_os || *c->server_type) {
193 DEBUG(0,("OS=[%s] Server=[%s]\n",
194 c->server_os,c->server_type));
197 DEBUG(4,(" session setup ok\n"));
199 /* here's the fun part....to support 'msdfs proxy' shares
200 (on Samba or windows) we have to issues a TRANS_GET_DFS_REFERRAL
201 here before trying to connect to the original share.
202 cli_check_msdfs_proxy() will fail if it is a normal share. */
204 if ((cli_state_capabilities(c) & CAP_DFS) &&
205 cli_check_msdfs_proxy(ctx, c, sharename,
206 &newserver, &newshare,
212 return do_connect(ctx, newserver,
213 newshare, auth_info, false,
214 force_encrypt, max_protocol,
215 port, name_type, pcli);
218 /* must be a normal share */
220 status = cli_tcon_andx(c, sharename, "?????",
221 password, strlen(password)+1);
222 if (!NT_STATUS_IS_OK(status)) {
223 d_printf("tree connect failed: %s\n", nt_errstr(status));
229 status = cli_cm_force_encryption(c,
234 if (!NT_STATUS_IS_OK(status)) {
240 DEBUG(4,(" tconx ok\n"));
245 /****************************************************************************
246 ****************************************************************************/
248 static void cli_set_mntpoint(struct cli_state *cli, const char *mnt)
250 char *name = clean_name(NULL, mnt);
254 TALLOC_FREE(cli->dfs_mountpoint);
255 cli->dfs_mountpoint = talloc_strdup(cli, name);
259 /********************************************************************
260 Add a new connection to the list.
261 referring_cli == NULL means a new initial connection.
262 ********************************************************************/
264 static NTSTATUS cli_cm_connect(TALLOC_CTX *ctx,
265 struct cli_state *referring_cli,
268 const struct user_auth_info *auth_info,
274 struct cli_state **pcli)
276 struct cli_state *cli;
279 status = do_connect(ctx, server, share,
281 show_hdr, force_encrypt, max_protocol,
282 port, name_type, &cli);
284 if (!NT_STATUS_IS_OK(status)) {
288 /* Enter into the list. */
290 DLIST_ADD_END(referring_cli, cli, struct cli_state *);
293 if (referring_cli && referring_cli->requested_posix_capabilities) {
295 uint32 caplow, caphigh;
296 status = cli_unix_extensions_version(cli, &major, &minor,
298 if (NT_STATUS_IS_OK(status)) {
299 cli_set_unix_extensions_capabilities(cli,
309 /********************************************************************
310 Return a connection to a server on a particular share.
311 ********************************************************************/
313 static struct cli_state *cli_cm_find(struct cli_state *cli,
323 /* Search to the start of the list. */
324 for (p = cli; p; p = DLIST_PREV(p)) {
325 const char *remote_name =
326 cli_state_remote_name(p);
328 if (strequal(server, remote_name) &&
329 strequal(share,p->share)) {
334 /* Search to the end of the list. */
335 for (p = cli->next; p; p = p->next) {
336 const char *remote_name =
337 cli_state_remote_name(p);
339 if (strequal(server, remote_name) &&
340 strequal(share,p->share)) {
348 /****************************************************************************
349 Open a client connection to a \\server\share.
350 ****************************************************************************/
352 NTSTATUS cli_cm_open(TALLOC_CTX *ctx,
353 struct cli_state *referring_cli,
356 const struct user_auth_info *auth_info,
362 struct cli_state **pcli)
364 /* Try to reuse an existing connection in this list. */
365 struct cli_state *c = cli_cm_find(referring_cli, server, share);
373 if (auth_info == NULL) {
374 /* Can't do a new connection
375 * without auth info. */
376 d_printf("cli_cm_open() Unable to open connection [\\%s\\%s] "
377 "without auth info\n",
379 return NT_STATUS_INVALID_PARAMETER;
382 status = cli_cm_connect(ctx,
393 if (!NT_STATUS_IS_OK(status)) {
400 /****************************************************************************
401 ****************************************************************************/
403 void cli_cm_display(struct cli_state *cli)
407 for (i=0; cli; cli = cli->next,i++ ) {
408 d_printf("%d:\tserver=%s, share=%s\n",
409 i, cli_state_remote_name(cli), cli->share);
413 /****************************************************************************
414 ****************************************************************************/
416 /****************************************************************************
417 ****************************************************************************/
420 void cli_cm_set_credentials(struct user_auth_info *auth_info)
422 SAFE_FREE(cm_creds.username);
423 cm_creds.username = SMB_STRDUP(get_cmdline_auth_info_username(
426 if (get_cmdline_auth_info_got_pass(auth_info)) {
427 cm_set_password(get_cmdline_auth_info_password(auth_info));
430 cm_creds.use_kerberos = get_cmdline_auth_info_use_kerberos(auth_info);
431 cm_creds.fallback_after_kerberos = false;
432 cm_creds.signing_state = get_cmdline_auth_info_signing_state(auth_info);
436 /**********************************************************************
437 split a dfs path into the server, share name, and extrapath components
438 **********************************************************************/
440 static bool split_dfs_path(TALLOC_CTX *ctx,
441 const char *nodepath,
451 *pp_extrapath = NULL;
453 path = talloc_strdup(ctx, nodepath);
458 if ( path[0] != '\\' ) {
462 p = strchr_m( path + 1, '\\' );
470 /* Look for any extra/deep path */
471 q = strchr_m(p, '\\');
475 *pp_extrapath = talloc_strdup(ctx, q);
477 *pp_extrapath = talloc_strdup(ctx, "");
479 if (*pp_extrapath == NULL) {
483 *pp_share = talloc_strdup(ctx, p);
484 if (*pp_share == NULL) {
488 *pp_server = talloc_strdup(ctx, &path[1]);
489 if (*pp_server == NULL) {
497 TALLOC_FREE(*pp_share);
498 TALLOC_FREE(*pp_extrapath);
503 /****************************************************************************
504 Return the original path truncated at the directory component before
505 the first wildcard character. Trust the caller to provide a NULL
507 ****************************************************************************/
509 static char *clean_path(TALLOC_CTX *ctx, const char *path)
515 /* No absolute paths. */
516 while (IS_DIRECTORY_SEP(*path)) {
520 path_out = talloc_strdup(ctx, path);
525 p1 = strchr_m(path_out, '*');
526 p2 = strchr_m(path_out, '?');
538 /* Now go back to the start of this component. */
539 p1 = strrchr_m(path_out, '/');
540 p2 = strrchr_m(path_out, '\\');
547 /* Strip any trailing separator */
549 len = strlen(path_out);
550 if ( (len > 0) && IS_DIRECTORY_SEP(path_out[len-1])) {
551 path_out[len-1] = '\0';
557 /****************************************************************************
558 ****************************************************************************/
560 static char *cli_dfs_make_full_path(TALLOC_CTX *ctx,
561 struct cli_state *cli,
564 char path_sep = '\\';
566 /* Ensure the extrapath doesn't start with a separator. */
567 while (IS_DIRECTORY_SEP(*dir)) {
571 if (cli->requested_posix_capabilities & CIFS_UNIX_POSIX_PATHNAMES_CAP) {
574 return talloc_asprintf(ctx, "%c%s%c%s%c%s",
576 cli_state_remote_name(cli),
583 /********************************************************************
584 check for dfs referral
585 ********************************************************************/
587 static bool cli_dfs_check_error(struct cli_state *cli, NTSTATUS expected,
590 /* only deal with DS when we negotiated NT_STATUS codes and UNICODE */
592 if (!(cli_state_capabilities(cli) & CAP_UNICODE)) {
595 if (!(cli_state_capabilities(cli) & CAP_STATUS32)) {
598 if (NT_STATUS_EQUAL(status, expected)) {
604 /********************************************************************
605 Get the dfs referral link.
606 ********************************************************************/
608 NTSTATUS cli_dfs_get_referral(TALLOC_CTX *ctx,
609 struct cli_state *cli,
611 struct client_dfs_referral **refs,
615 unsigned int data_len = 0;
616 unsigned int param_len = 0;
618 uint16_t recv_flags2;
619 uint8_t *param = NULL;
620 uint8_t *rdata = NULL;
623 smb_ucs2_t *path_ucs;
624 char *consumed_path = NULL;
625 uint16_t consumed_ucs;
626 uint16 num_referrals;
627 struct client_dfs_referral *referrals = NULL;
629 TALLOC_CTX *frame = talloc_stackframe();
634 SSVAL(setup, 0, TRANSACT2_GET_DFS_REFERRAL);
636 param = talloc_array(talloc_tos(), uint8_t, 2);
638 status = NT_STATUS_NO_MEMORY;
641 SSVAL(param, 0, 0x03); /* max referral level */
643 param = trans2_bytes_push_str(param, cli_ucs2(cli),
644 path, strlen(path)+1,
647 status = NT_STATUS_NO_MEMORY;
650 param_len = talloc_get_size(param);
651 path_ucs = (smb_ucs2_t *)¶m[2];
653 status = cli_trans(talloc_tos(), cli, SMBtrans2,
657 NULL, 0, cli->max_xmit,
659 NULL, 0, NULL, /* rsetup */
661 &rdata, 4, &data_len);
662 if (!NT_STATUS_IS_OK(status)) {
666 endp = (char *)rdata + data_len;
668 consumed_ucs = SVAL(rdata, 0);
669 num_referrals = SVAL(rdata, 2);
671 /* consumed_ucs is the number of bytes
672 * of the UCS2 path consumed not counting any
673 * terminating null. We need to convert
674 * back to unix charset and count again
675 * to get the number of bytes consumed from
676 * the incoming path. */
679 if (pull_string_talloc(talloc_tos(),
687 status = map_nt_error_from_unix(errno);
689 status = NT_STATUS_INVALID_NETWORK_RESPONSE;
693 if (consumed_path == NULL) {
694 status = map_nt_error_from_unix(errno);
697 *consumed = strlen(consumed_path);
699 if (num_referrals != 0) {
705 referrals = talloc_array(ctx, struct client_dfs_referral,
709 status = NT_STATUS_NO_MEMORY;
712 /* start at the referrals array */
715 for (i=0; i<num_referrals && p < endp; i++) {
719 ref_version = SVAL(p, 0);
720 ref_size = SVAL(p, 2);
721 node_offset = SVAL(p, 16);
723 if (ref_version != 3) {
728 referrals[i].proximity = SVAL(p, 8);
729 referrals[i].ttl = SVAL(p, 10);
731 if (p + node_offset > endp) {
732 status = NT_STATUS_INVALID_NETWORK_RESPONSE;
735 clistr_pull_talloc(referrals,
738 &referrals[i].dfspath,
740 PTR_DIFF(endp, p+node_offset),
741 STR_TERMINATE|STR_UNICODE);
743 if (!referrals[i].dfspath) {
744 status = map_nt_error_from_unix(errno);
749 if (i < num_referrals) {
750 status = NT_STATUS_INVALID_NETWORK_RESPONSE;
755 *num_refs = num_referrals;
764 /********************************************************************
765 ********************************************************************/
767 NTSTATUS cli_resolve_path(TALLOC_CTX *ctx,
769 const struct user_auth_info *dfs_auth_info,
770 struct cli_state *rootcli,
772 struct cli_state **targetcli,
773 char **pp_targetpath)
775 struct client_dfs_referral *refs = NULL;
778 struct cli_state *cli_ipc = NULL;
779 char *dfs_path = NULL;
780 char *cleanpath = NULL;
781 char *extrapath = NULL;
785 struct cli_state *newcli = NULL;
786 char *newpath = NULL;
787 char *newmount = NULL;
789 SMB_STRUCT_STAT sbuf;
793 if ( !rootcli || !path || !targetcli ) {
794 return NT_STATUS_INVALID_PARAMETER;
797 /* Don't do anything if this is not a DFS root. */
799 if ( !rootcli->dfsroot) {
800 *targetcli = rootcli;
801 *pp_targetpath = talloc_strdup(ctx, path);
802 if (!*pp_targetpath) {
803 return NT_STATUS_NO_MEMORY;
810 /* Send a trans2_query_path_info to check for a referral. */
812 cleanpath = clean_path(ctx, path);
814 return NT_STATUS_NO_MEMORY;
817 dfs_path = cli_dfs_make_full_path(ctx, rootcli, cleanpath);
819 return NT_STATUS_NO_MEMORY;
822 status = cli_qpathinfo_basic( rootcli, dfs_path, &sbuf, &attributes);
823 if (NT_STATUS_IS_OK(status)) {
824 /* This is an ordinary path, just return it. */
825 *targetcli = rootcli;
826 *pp_targetpath = talloc_strdup(ctx, path);
827 if (!*pp_targetpath) {
828 return NT_STATUS_NO_MEMORY;
833 /* Special case where client asked for a path that does not exist */
835 if (cli_dfs_check_error(rootcli, NT_STATUS_OBJECT_NAME_NOT_FOUND,
837 *targetcli = rootcli;
838 *pp_targetpath = talloc_strdup(ctx, path);
839 if (!*pp_targetpath) {
840 return NT_STATUS_NO_MEMORY;
845 /* We got an error, check for DFS referral. */
847 if (!cli_dfs_check_error(rootcli, NT_STATUS_PATH_NOT_COVERED,
852 /* Check for the referral. */
854 status = cli_cm_open(ctx,
856 cli_state_remote_name(rootcli),
860 cli_state_encryption_on(rootcli),
861 cli_state_protocol(rootcli),
865 if (!NT_STATUS_IS_OK(status)) {
869 status = cli_dfs_get_referral(ctx, cli_ipc, dfs_path, &refs,
870 &num_refs, &consumed);
871 if (!NT_STATUS_IS_OK(status) || !num_refs) {
875 /* Just store the first referral for now. */
877 if (!refs[0].dfspath) {
878 return NT_STATUS_NOT_FOUND;
880 if (!split_dfs_path(ctx, refs[0].dfspath, &server, &share,
882 return NT_STATUS_NOT_FOUND;
885 /* Make sure to recreate the original string including any wildcards. */
887 dfs_path = cli_dfs_make_full_path(ctx, rootcli, path);
889 return NT_STATUS_NO_MEMORY;
891 pathlen = strlen(dfs_path);
892 consumed = MIN(pathlen, consumed);
893 *pp_targetpath = talloc_strdup(ctx, &dfs_path[consumed]);
894 if (!*pp_targetpath) {
895 return NT_STATUS_NO_MEMORY;
897 dfs_path[consumed] = '\0';
900 * *pp_targetpath is now the unconsumed part of the path.
901 * dfs_path is now the consumed part of the path
902 * (in \server\share\path format).
905 /* Open the connection to the target server & share */
906 status = cli_cm_open(ctx, rootcli,
911 cli_state_encryption_on(rootcli),
912 cli_state_protocol(rootcli),
916 if (!NT_STATUS_IS_OK(status)) {
917 d_printf("Unable to follow dfs referral [\\%s\\%s]\n",
922 if (extrapath && strlen(extrapath) > 0) {
923 /* EMC Celerra NAS version 5.6.50 (at least) doesn't appear to */
924 /* put the trailing \ on the path, so to be save we put one in if needed */
925 if (extrapath[strlen(extrapath)-1] != '\\' && **pp_targetpath != '\\') {
926 *pp_targetpath = talloc_asprintf(ctx,
931 *pp_targetpath = talloc_asprintf(ctx,
936 if (!*pp_targetpath) {
937 return NT_STATUS_NO_MEMORY;
941 /* parse out the consumed mount path */
942 /* trim off the \server\share\ */
946 if (*ppath != '\\') {
947 d_printf("cli_resolve_path: "
948 "dfs_path (%s) not in correct format.\n",
950 return NT_STATUS_NOT_FOUND;
953 ppath++; /* Now pointing at start of server name. */
955 if ((ppath = strchr_m( dfs_path, '\\' )) == NULL) {
956 return NT_STATUS_NOT_FOUND;
959 ppath++; /* Now pointing at start of share name. */
961 if ((ppath = strchr_m( ppath+1, '\\' )) == NULL) {
962 return NT_STATUS_NOT_FOUND;
965 ppath++; /* Now pointing at path component. */
967 newmount = talloc_asprintf(ctx, "%s\\%s", mountpt, ppath );
969 return NT_STATUS_NOT_FOUND;
972 cli_set_mntpoint(*targetcli, newmount);
974 /* Check for another dfs referral, note that we are not
975 checking for loops here. */
977 if (!strequal(*pp_targetpath, "\\") && !strequal(*pp_targetpath, "/")) {
978 status = cli_resolve_path(ctx,
985 if (NT_STATUS_IS_OK(status)) {
987 * When cli_resolve_path returns true here it's always
988 * returning the complete path in newpath, so we're done
992 *pp_targetpath = newpath;
999 /* If returning true ensure we return a dfs root full path. */
1000 if ((*targetcli)->dfsroot) {
1001 dfs_path = talloc_strdup(ctx, *pp_targetpath);
1003 return NT_STATUS_NO_MEMORY;
1005 *pp_targetpath = cli_dfs_make_full_path(ctx, *targetcli, dfs_path);
1006 if (*pp_targetpath == NULL) {
1007 return NT_STATUS_NO_MEMORY;
1011 return NT_STATUS_OK;
1014 /********************************************************************
1015 ********************************************************************/
1017 bool cli_check_msdfs_proxy(TALLOC_CTX *ctx,
1018 struct cli_state *cli,
1019 const char *sharename,
1020 char **pp_newserver,
1023 const char *username,
1024 const char *password,
1027 struct client_dfs_referral *refs = NULL;
1028 size_t num_refs = 0;
1029 size_t consumed = 0;
1030 char *fullpath = NULL;
1033 char *newextrapath = NULL;
1035 const char *remote_name;
1037 if (!cli || !sharename) {
1041 remote_name = cli_state_remote_name(cli);
1042 cnum = cli_state_get_tid(cli);
1044 /* special case. never check for a referral on the IPC$ share */
1046 if (strequal(sharename, "IPC$")) {
1050 /* send a trans2_query_path_info to check for a referral */
1052 fullpath = talloc_asprintf(ctx, "\\%s\\%s", remote_name, sharename);
1057 /* check for the referral */
1059 if (!NT_STATUS_IS_OK(cli_tcon_andx(cli, "IPC$", "IPC", NULL, 0))) {
1063 if (force_encrypt) {
1064 status = cli_cm_force_encryption(cli,
1069 if (!NT_STATUS_IS_OK(status)) {
1074 status = cli_dfs_get_referral(ctx, cli, fullpath, &refs,
1075 &num_refs, &consumed);
1076 res = NT_STATUS_IS_OK(status);
1078 status = cli_tdis(cli);
1079 if (!NT_STATUS_IS_OK(status)) {
1083 cli_state_set_tid(cli, cnum);
1085 if (!res || !num_refs) {
1089 if (!refs[0].dfspath) {
1093 if (!split_dfs_path(ctx, refs[0].dfspath, pp_newserver,
1094 pp_newshare, &newextrapath)) {
1098 /* check that this is not a self-referral */
1100 if (strequal(remote_name, *pp_newserver) &&
1101 strequal(sharename, *pp_newshare)) {