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 static struct cm_cred_struct
{
46 bool fallback_after_kerberos
;
50 static void cm_set_password(const char *newpass
);
53 static int name_type
= 0x20;
55 static struct client_connection
*connections
;
57 static bool cli_check_msdfs_proxy(TALLOC_CTX
*ctx
,
58 struct cli_state
*cli
,
59 const char *sharename
,
67 /********************************************************************
68 Ensure a connection is encrypted.
69 ********************************************************************/
71 NTSTATUS
cli_cm_force_encryption(struct cli_state
*c
,
75 const char *sharename
)
77 NTSTATUS status
= cli_force_encryption(c
,
82 if (NT_STATUS_EQUAL(status
,NT_STATUS_NOT_SUPPORTED
)) {
83 d_printf("Encryption required and "
84 "server that doesn't support "
85 "UNIX extensions - failing connect\n");
86 } else if (NT_STATUS_EQUAL(status
,NT_STATUS_UNKNOWN_REVISION
)) {
87 d_printf("Encryption required and "
88 "can't get UNIX CIFS extensions "
89 "version from server.\n");
90 } else if (NT_STATUS_EQUAL(status
,NT_STATUS_UNSUPPORTED_COMPRESSION
)) {
91 d_printf("Encryption required and "
92 "share %s doesn't support "
93 "encryption.\n", sharename
);
94 } else if (!NT_STATUS_IS_OK(status
)) {
95 d_printf("Encryption required and "
96 "setup failed with error %s.\n",
103 /********************************************************************
104 Return a connection to a server.
105 ********************************************************************/
107 static struct cli_state
*do_connect(TALLOC_CTX
*ctx
,
114 struct cli_state
*c
= NULL
;
115 struct nmb_name called
, calling
;
116 const char *server_n
;
117 struct sockaddr_storage ss
;
120 char *newserver
, *newshare
;
121 const char *username
;
122 const char *password
;
125 /* make a copy so we don't modify the global string 'service' */
126 servicename
= talloc_strdup(ctx
,share
);
130 sharename
= servicename
;
131 if (*sharename
== '\\') {
133 if (server
== NULL
) {
136 sharename
= strchr_m(sharename
,'\\');
148 make_nmb_name(&calling
, global_myname(), 0x0);
149 make_nmb_name(&called
, server
, name_type
);
154 /* have to open a new connection */
155 if (!(c
=cli_initialise()) || (cli_set_port(c
, port
) != port
)) {
156 d_printf("Connection to %s failed\n", server_n
);
162 status
= cli_connect(c
, server_n
, &ss
);
163 if (!NT_STATUS_IS_OK(status
)) {
164 d_printf("Connection to %s failed (Error %s)\n",
171 c
->protocol
= max_protocol
;
172 c
->use_kerberos
= cm_creds
.use_kerberos
;
173 c
->fallback_after_kerberos
= cm_creds
.fallback_after_kerberos
;
174 cli_setup_signing_state(c
, cm_creds
.signing_state
);
176 if (!cli_session_request(c
, &calling
, &called
)) {
178 d_printf("session request to %s failed (%s)\n",
179 called
.name
, cli_errstr(c
));
182 if ((p
=strchr_m(called
.name
, '.'))) {
186 if (strcmp(called
.name
, "*SMBSERVER")) {
187 make_nmb_name(&called
, "*SMBSERVER", 0x20);
193 DEBUG(4,(" session request ok\n"));
195 status
= cli_negprot(c
);
197 if (!NT_STATUS_IS_OK(status
)) {
198 d_printf("protocol negotiation failed: %s\n",
204 if (!cm_creds
.got_pass
&& !cm_creds
.use_kerberos
) {
207 label
= talloc_asprintf(ctx
, "Enter %s's password: ",
209 pass
= getpass(label
);
211 cm_set_password(pass
);
216 username
= cm_creds
.username
? cm_creds
.username
: "";
217 password
= cm_creds
.password
? cm_creds
.password
: "";
219 if (!NT_STATUS_IS_OK(cli_session_setup(c
, username
,
220 password
, strlen(password
),
221 password
, strlen(password
),
223 /* If a password was not supplied then
224 * try again with a null username. */
225 if (password
[0] || !username
[0] || cm_creds
.use_kerberos
||
226 !NT_STATUS_IS_OK(cli_session_setup(c
, "",
230 d_printf("session setup failed: %s\n", cli_errstr(c
));
231 if (NT_STATUS_V(cli_nt_error(c
)) ==
232 NT_STATUS_V(NT_STATUS_MORE_PROCESSING_REQUIRED
))
233 d_printf("did you forget to run kinit?\n");
237 d_printf("Anonymous login successful\n");
240 if ( show_sessetup
) {
241 if (*c
->server_domain
) {
242 DEBUG(0,("Domain=[%s] OS=[%s] Server=[%s]\n",
243 c
->server_domain
,c
->server_os
,c
->server_type
));
244 } else if (*c
->server_os
|| *c
->server_type
) {
245 DEBUG(0,("OS=[%s] Server=[%s]\n",
246 c
->server_os
,c
->server_type
));
249 DEBUG(4,(" session setup ok\n"));
251 /* here's the fun part....to support 'msdfs proxy' shares
252 (on Samba or windows) we have to issues a TRANS_GET_DFS_REFERRAL
253 here before trying to connect to the original share.
254 check_dfs_proxy() will fail if it is a normal share. */
256 if ((c
->capabilities
& CAP_DFS
) &&
257 cli_check_msdfs_proxy(ctx
, c
, sharename
,
258 &newserver
, &newshare
,
264 return do_connect(ctx
, newserver
,
266 force_encrypt
, max_protocol
);
269 /* must be a normal share */
271 if (!cli_send_tconX(c
, sharename
, "?????",
272 password
, strlen(password
)+1)) {
273 d_printf("tree connect failed: %s\n", cli_errstr(c
));
279 status
= cli_cm_force_encryption(c
,
284 if (!NT_STATUS_IS_OK(status
)) {
290 DEBUG(4,(" tconx ok\n"));
294 /****************************************************************************
295 ****************************************************************************/
297 static void cli_cm_set_mntpoint(struct cli_state
*c
, const char *mnt
)
299 struct client_connection
*p
;
302 for (p
=connections
,i
=0; p
; p
=p
->next
,i
++) {
303 if (strequal(p
->cli
->desthost
, c
->desthost
) &&
304 strequal(p
->cli
->share
, c
->share
)) {
310 char *name
= clean_name(NULL
, mnt
);
314 TALLOC_FREE(p
->mount
);
315 p
->mount
= talloc_strdup(p
, name
);
320 /****************************************************************************
321 ****************************************************************************/
323 const char *cli_cm_get_mntpoint(struct cli_state
*c
)
325 struct client_connection
*p
;
328 for (p
=connections
,i
=0; p
; p
=p
->next
,i
++) {
329 if (strequal(p
->cli
->desthost
, c
->desthost
) &&
330 strequal(p
->cli
->share
, c
->share
)) {
341 /********************************************************************
342 Add a new connection to the list
343 ********************************************************************/
345 static struct cli_state
*cli_cm_connect(TALLOC_CTX
*ctx
,
346 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
,
362 show_hdr
, force_encrypt
, max_protocol
);
369 DLIST_ADD( connections
, node
);
371 cli_cm_set_mntpoint(node
->cli
, "");
373 if (referring_cli
&& referring_cli
->posix_capabilities
) {
375 uint32 caplow
, caphigh
;
376 if (cli_unix_extensions_version(node
->cli
, &major
,
377 &minor
, &caplow
, &caphigh
)) {
378 cli_set_unix_extensions_capabilities(node
->cli
,
387 /********************************************************************
388 Return a connection to a server.
389 ********************************************************************/
391 static struct cli_state
*cli_cm_find(const char *server
, const char *share
)
393 struct client_connection
*p
;
395 for (p
=connections
; p
; p
=p
->next
) {
396 if ( strequal(server
, p
->cli
->desthost
) &&
397 strequal(share
,p
->cli
->share
)) {
405 /****************************************************************************
406 Open a client connection to a \\server\share. Set's the current *cli
407 global variable as a side-effect (but only if the connection is successful).
408 ****************************************************************************/
410 struct cli_state
*cli_cm_open(TALLOC_CTX
*ctx
,
411 struct cli_state
*referring_cli
,
420 /* try to reuse an existing connection */
422 c
= cli_cm_find(server
, share
);
424 c
= cli_cm_connect(ctx
, referring_cli
,
425 server
, share
, show_hdr
, force_encrypt
,
432 /****************************************************************************
433 ****************************************************************************/
435 void cli_cm_shutdown(void)
437 struct client_connection
*p
, *x
;
439 for (p
=connections
; p
;) {
440 cli_shutdown(p
->cli
);
451 /****************************************************************************
452 ****************************************************************************/
454 void cli_cm_display(void)
456 struct client_connection
*p
;
459 for ( p
=connections
,i
=0; p
; p
=p
->next
,i
++ ) {
460 d_printf("%d:\tserver=%s, share=%s\n",
461 i
, p
->cli
->desthost
, p
->cli
->share
);
465 /****************************************************************************
466 ****************************************************************************/
468 static void cm_set_password(const char *newpass
)
470 SAFE_FREE(cm_creds
.password
);
471 cm_creds
.password
= SMB_STRDUP(newpass
);
472 if (cm_creds
.password
) {
473 cm_creds
.got_pass
= true;
477 /****************************************************************************
478 ****************************************************************************/
480 void cli_cm_set_credentials(struct user_auth_info
*auth_info
)
482 SAFE_FREE(cm_creds
.username
);
483 cm_creds
.username
= SMB_STRDUP(get_cmdline_auth_info_username(
486 if (get_cmdline_auth_info_got_pass(auth_info
)) {
487 cm_set_password(get_cmdline_auth_info_password(auth_info
));
490 cm_creds
.use_kerberos
= get_cmdline_auth_info_use_kerberos(auth_info
);
491 cm_creds
.fallback_after_kerberos
= false;
492 cm_creds
.signing_state
= get_cmdline_auth_info_signing_state(auth_info
);
495 /****************************************************************************
496 ****************************************************************************/
498 void cli_cm_set_port(int port_number
)
503 /****************************************************************************
504 ****************************************************************************/
506 void cli_cm_set_dest_name_type(int type
)
511 /****************************************************************************
512 ****************************************************************************/
514 void cli_cm_set_signing_state(int state
)
516 cm_creds
.signing_state
= state
;
519 /****************************************************************************
520 ****************************************************************************/
522 void cli_cm_set_username(const char *username
)
524 SAFE_FREE(cm_creds
.username
);
525 cm_creds
.username
= SMB_STRDUP(username
);
528 /****************************************************************************
529 ****************************************************************************/
531 void cli_cm_set_password(const char *newpass
)
533 SAFE_FREE(cm_creds
.password
);
534 cm_creds
.password
= SMB_STRDUP(newpass
);
535 if (cm_creds
.password
) {
536 cm_creds
.got_pass
= true;
540 /****************************************************************************
541 ****************************************************************************/
543 void cli_cm_set_use_kerberos(void)
545 cm_creds
.use_kerberos
= true;
548 /****************************************************************************
549 ****************************************************************************/
551 void cli_cm_set_fallback_after_kerberos(void)
553 cm_creds
.fallback_after_kerberos
= true;
556 /**********************************************************************
557 split a dfs path into the server, share name, and extrapath components
558 **********************************************************************/
560 static void split_dfs_path(TALLOC_CTX
*ctx
,
561 const char *nodepath
,
571 *pp_extrapath
= NULL
;
573 path
= talloc_strdup(ctx
, nodepath
);
578 if ( path
[0] != '\\' ) {
582 p
= strchr_m( path
+ 1, '\\' );
590 /* Look for any extra/deep path */
591 q
= strchr_m(p
, '\\');
595 *pp_extrapath
= talloc_strdup(ctx
, q
);
597 *pp_extrapath
= talloc_strdup(ctx
, "");
600 *pp_share
= talloc_strdup(ctx
, p
);
601 *pp_server
= talloc_strdup(ctx
, &path
[1]);
604 /****************************************************************************
605 Return the original path truncated at the directory component before
606 the first wildcard character. Trust the caller to provide a NULL
608 ****************************************************************************/
610 static char *clean_path(TALLOC_CTX
*ctx
, const char *path
)
616 /* No absolute paths. */
617 while (IS_DIRECTORY_SEP(*path
)) {
621 path_out
= talloc_strdup(ctx
, path
);
626 p1
= strchr_m(path_out
, '*');
627 p2
= strchr_m(path_out
, '?');
639 /* Now go back to the start of this component. */
640 p1
= strrchr_m(path_out
, '/');
641 p2
= strrchr_m(path_out
, '\\');
648 /* Strip any trailing separator */
650 len
= strlen(path_out
);
651 if ( (len
> 0) && IS_DIRECTORY_SEP(path_out
[len
-1])) {
652 path_out
[len
-1] = '\0';
658 /****************************************************************************
659 ****************************************************************************/
661 static char *cli_dfs_make_full_path(TALLOC_CTX
*ctx
,
662 struct cli_state
*cli
,
665 /* Ensure the extrapath doesn't start with a separator. */
666 while (IS_DIRECTORY_SEP(*dir
)) {
670 return talloc_asprintf(ctx
, "\\%s\\%s\\%s",
671 cli
->desthost
, cli
->share
, dir
);
674 /********************************************************************
675 check for dfs referral
676 ********************************************************************/
678 static bool cli_dfs_check_error( struct cli_state
*cli
, NTSTATUS status
)
680 uint32 flgs2
= SVAL(cli
->inbuf
,smb_flg2
);
682 /* only deal with DS when we negotiated NT_STATUS codes and UNICODE */
684 if (!((flgs2
&FLAGS2_32_BIT_ERROR_CODES
) &&
685 (flgs2
&FLAGS2_UNICODE_STRINGS
)))
688 if (NT_STATUS_EQUAL(status
, NT_STATUS(IVAL(cli
->inbuf
,smb_rcls
))))
694 /********************************************************************
695 Get the dfs referral link.
696 ********************************************************************/
698 bool cli_dfs_get_referral(TALLOC_CTX
*ctx
,
699 struct cli_state
*cli
,
701 CLIENT_DFS_REFERRAL
**refs
,
705 unsigned int data_len
= 0;
706 unsigned int param_len
= 0;
707 uint16 setup
= TRANSACT2_GET_DFS_REFERRAL
;
709 char *rparam
=NULL
, *rdata
=NULL
;
712 size_t pathlen
= 2*(strlen(path
)+1);
713 uint16 num_referrals
;
714 CLIENT_DFS_REFERRAL
*referrals
= NULL
;
720 param
= SMB_MALLOC_ARRAY(char, 2+pathlen
+2);
724 SSVAL(param
, 0, 0x03); /* max referral level */
727 p
+= clistr_push(cli
, p
, path
, pathlen
, STR_TERMINATE
);
728 param_len
= PTR_DIFF(p
, param
);
730 if (!cli_send_trans(cli
, SMBtrans2
,
732 -1, 0, /* fid, flags */
733 &setup
, 1, 0, /* setup, length, max */
734 param
, param_len
, 2, /* param, length, max */
735 NULL
, 0, cli
->max_xmit
/* data, length, max */
743 if (!cli_receive_trans(cli
, SMBtrans2
,
745 &rdata
, &data_len
)) {
753 endp
= rdata
+ data_len
;
755 *consumed
= SVAL(rdata
, 0);
756 num_referrals
= SVAL(rdata
, 2);
758 if (num_referrals
!= 0) {
764 referrals
= TALLOC_ARRAY(ctx
, CLIENT_DFS_REFERRAL
,
770 /* start at the referrals array */
773 for (i
=0; i
<num_referrals
&& p
< endp
; i
++) {
777 ref_version
= SVAL(p
, 0);
778 ref_size
= SVAL(p
, 2);
779 node_offset
= SVAL(p
, 16);
781 if (ref_version
!= 3) {
786 referrals
[i
].proximity
= SVAL(p
, 8);
787 referrals
[i
].ttl
= SVAL(p
, 10);
789 if (p
+ node_offset
> endp
) {
792 clistr_pull_talloc(ctx
, cli
, &referrals
[i
].dfspath
,
794 STR_TERMINATE
|STR_UNICODE
);
796 if (!referrals
[i
].dfspath
) {
801 if (i
< num_referrals
) {
808 *num_refs
= num_referrals
;
818 /********************************************************************
819 ********************************************************************/
821 bool cli_resolve_path(TALLOC_CTX
*ctx
,
823 struct cli_state
*rootcli
,
825 struct cli_state
**targetcli
,
826 char **pp_targetpath
)
828 CLIENT_DFS_REFERRAL
*refs
= NULL
;
831 struct cli_state
*cli_ipc
= NULL
;
832 char *dfs_path
= NULL
;
833 char *cleanpath
= NULL
;
834 char *extrapath
= NULL
;
838 struct cli_state
*newcli
= NULL
;
839 char *newpath
= NULL
;
840 char *newmount
= NULL
;
842 SMB_STRUCT_STAT sbuf
;
845 if ( !rootcli
|| !path
|| !targetcli
) {
849 /* Don't do anything if this is not a DFS root. */
851 if ( !rootcli
->dfsroot
) {
852 *targetcli
= rootcli
;
853 *pp_targetpath
= talloc_strdup(ctx
, path
);
854 if (!*pp_targetpath
) {
862 /* Send a trans2_query_path_info to check for a referral. */
864 cleanpath
= clean_path(ctx
, path
);
869 dfs_path
= cli_dfs_make_full_path(ctx
, rootcli
, cleanpath
);
874 if (cli_qpathinfo_basic( rootcli
, dfs_path
, &sbuf
, &attributes
)) {
875 /* This is an ordinary path, just return it. */
876 *targetcli
= rootcli
;
877 *pp_targetpath
= talloc_strdup(ctx
, path
);
878 if (!*pp_targetpath
) {
884 /* Special case where client asked for a path that does not exist */
886 if (cli_dfs_check_error(rootcli
, NT_STATUS_OBJECT_NAME_NOT_FOUND
)) {
887 *targetcli
= rootcli
;
888 *pp_targetpath
= talloc_strdup(ctx
, path
);
889 if (!*pp_targetpath
) {
895 /* We got an error, check for DFS referral. */
897 if (!cli_dfs_check_error(rootcli
, NT_STATUS_PATH_NOT_COVERED
)) {
901 /* Check for the referral. */
903 if (!(cli_ipc
= cli_cm_open(ctx
, rootcli
,
906 (rootcli
->trans_enc_state
!= NULL
),
907 rootcli
->protocol
))) {
911 if (!cli_dfs_get_referral(ctx
, cli_ipc
, dfs_path
, &refs
,
912 &num_refs
, &consumed
) || !num_refs
) {
916 /* Just store the first referral for now. */
918 if (!refs
[0].dfspath
) {
921 split_dfs_path(ctx
, refs
[0].dfspath
, &server
, &share
, &extrapath
);
923 if (!server
|| !share
) {
927 /* Make sure to recreate the original string including any wildcards. */
929 dfs_path
= cli_dfs_make_full_path(ctx
, rootcli
, path
);
933 pathlen
= strlen(dfs_path
)*2;
934 consumed
= MIN(pathlen
, consumed
);
935 *pp_targetpath
= talloc_strdup(ctx
, &dfs_path
[consumed
/2]);
936 if (!*pp_targetpath
) {
939 dfs_path
[consumed
/2] = '\0';
942 * *pp_targetpath is now the unconsumed part of the path.
943 * dfs_path is now the consumed part of the path
944 * (in \server\share\path format).
947 /* Open the connection to the target server & share */
948 if ((*targetcli
= cli_cm_open(ctx
, rootcli
,
952 (rootcli
->trans_enc_state
!= NULL
),
953 rootcli
->protocol
)) == NULL
) {
954 d_printf("Unable to follow dfs referral [\\%s\\%s]\n",
959 if (extrapath
&& strlen(extrapath
) > 0) {
960 *pp_targetpath
= talloc_asprintf(ctx
,
964 if (!*pp_targetpath
) {
969 /* parse out the consumed mount path */
970 /* trim off the \server\share\ */
974 if (*ppath
!= '\\') {
975 d_printf("cli_resolve_path: "
976 "dfs_path (%s) not in correct format.\n",
981 ppath
++; /* Now pointing at start of server name. */
983 if ((ppath
= strchr_m( dfs_path
, '\\' )) == NULL
) {
987 ppath
++; /* Now pointing at start of share name. */
989 if ((ppath
= strchr_m( ppath
+1, '\\' )) == NULL
) {
993 ppath
++; /* Now pointing at path component. */
995 newmount
= talloc_asprintf(ctx
, "%s\\%s", mountpt
, ppath
);
1000 cli_cm_set_mntpoint(*targetcli
, newmount
);
1002 /* Check for another dfs referral, note that we are not
1003 checking for loops here. */
1005 if (!strequal(*pp_targetpath
, "\\") && !strequal(*pp_targetpath
, "/")) {
1006 if (cli_resolve_path(ctx
,
1013 * When cli_resolve_path returns true here it's always
1014 * returning the complete path in newpath, so we're done
1017 *targetcli
= newcli
;
1018 *pp_targetpath
= newpath
;
1025 /* If returning true ensure we return a dfs root full path. */
1026 if ((*targetcli
)->dfsroot
) {
1027 dfs_path
= talloc_strdup(ctx
, *pp_targetpath
);
1031 *pp_targetpath
= cli_dfs_make_full_path(ctx
, *targetcli
, dfs_path
);
1037 /********************************************************************
1038 ********************************************************************/
1040 static bool cli_check_msdfs_proxy(TALLOC_CTX
*ctx
,
1041 struct cli_state
*cli
,
1042 const char *sharename
,
1043 char **pp_newserver
,
1046 const char *username
,
1047 const char *password
,
1050 CLIENT_DFS_REFERRAL
*refs
= NULL
;
1051 size_t num_refs
= 0;
1053 char *fullpath
= NULL
;
1056 char *newextrapath
= NULL
;
1058 if (!cli
|| !sharename
) {
1064 /* special case. never check for a referral on the IPC$ share */
1066 if (strequal(sharename
, "IPC$")) {
1070 /* send a trans2_query_path_info to check for a referral */
1072 fullpath
= talloc_asprintf(ctx
, "\\%s\\%s", cli
->desthost
, sharename
);
1077 /* check for the referral */
1079 if (!cli_send_tconX(cli
, "IPC$", "IPC", NULL
, 0)) {
1083 if (force_encrypt
) {
1084 NTSTATUS status
= cli_cm_force_encryption(cli
,
1089 if (!NT_STATUS_IS_OK(status
)) {
1094 res
= cli_dfs_get_referral(ctx
, cli
, fullpath
, &refs
, &num_refs
, &consumed
);
1096 if (!cli_tdis(cli
)) {
1102 if (!res
|| !num_refs
) {
1106 if (!refs
[0].dfspath
) {
1110 split_dfs_path(ctx
, refs
[0].dfspath
, pp_newserver
,
1111 pp_newshare
, &newextrapath
);
1113 if ((*pp_newserver
== NULL
) || (*pp_newshare
== NULL
)) {
1117 /* check that this is not a self-referral */
1119 if (strequal(cli
->desthost
, *pp_newserver
) &&
1120 strequal(sharename
, *pp_newshare
)) {