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
);
52 static struct client_connection
*connections
;
54 static bool cli_check_msdfs_proxy(TALLOC_CTX
*ctx
,
55 struct cli_state
*cli
,
56 const char *sharename
,
64 /********************************************************************
65 Ensure a connection is encrypted.
66 ********************************************************************/
68 NTSTATUS
cli_cm_force_encryption(struct cli_state
*c
,
72 const char *sharename
)
74 NTSTATUS status
= cli_force_encryption(c
,
79 if (NT_STATUS_EQUAL(status
,NT_STATUS_NOT_SUPPORTED
)) {
80 d_printf("Encryption required and "
81 "server that doesn't support "
82 "UNIX extensions - failing connect\n");
83 } else if (NT_STATUS_EQUAL(status
,NT_STATUS_UNKNOWN_REVISION
)) {
84 d_printf("Encryption required and "
85 "can't get UNIX CIFS extensions "
86 "version from server.\n");
87 } else if (NT_STATUS_EQUAL(status
,NT_STATUS_UNSUPPORTED_COMPRESSION
)) {
88 d_printf("Encryption required and "
89 "share %s doesn't support "
90 "encryption.\n", sharename
);
91 } else if (!NT_STATUS_IS_OK(status
)) {
92 d_printf("Encryption required and "
93 "setup failed with error %s.\n",
100 /********************************************************************
101 Return a connection to a server.
102 ********************************************************************/
104 static struct cli_state
*do_connect(TALLOC_CTX
*ctx
,
113 struct cli_state
*c
= NULL
;
114 struct nmb_name called
, calling
;
115 const char *server_n
;
116 struct sockaddr_storage ss
;
119 char *newserver
, *newshare
;
120 const char *username
;
121 const char *password
;
124 /* make a copy so we don't modify the global string 'service' */
125 servicename
= talloc_strdup(ctx
,share
);
129 sharename
= servicename
;
130 if (*sharename
== '\\') {
132 if (server
== NULL
) {
135 sharename
= strchr_m(sharename
,'\\');
147 make_nmb_name(&calling
, global_myname(), 0x0);
148 make_nmb_name(&called
, server
, name_type
);
153 /* have to open a new connection */
154 if (!(c
=cli_initialise())) {
155 d_printf("Connection to %s failed\n", server_n
);
162 cli_set_port(c
, port
);
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 if (max_protocol
== 0) {
175 max_protocol
= PROTOCOL_NT1
;
177 c
->protocol
= max_protocol
;
178 c
->use_kerberos
= cm_creds
.use_kerberos
;
179 c
->fallback_after_kerberos
= cm_creds
.fallback_after_kerberos
;
180 cli_setup_signing_state(c
, cm_creds
.signing_state
);
182 if (!cli_session_request(c
, &calling
, &called
)) {
184 d_printf("session request to %s failed (%s)\n",
185 called
.name
, cli_errstr(c
));
188 if ((p
=strchr_m(called
.name
, '.'))) {
192 if (strcmp(called
.name
, "*SMBSERVER")) {
193 make_nmb_name(&called
, "*SMBSERVER", 0x20);
199 DEBUG(4,(" session request ok\n"));
201 status
= cli_negprot(c
);
203 if (!NT_STATUS_IS_OK(status
)) {
204 d_printf("protocol negotiation failed: %s\n",
210 if (!cm_creds
.got_pass
&& !cm_creds
.use_kerberos
) {
213 label
= talloc_asprintf(ctx
, "Enter %s's password: ",
215 pass
= getpass(label
);
217 cm_set_password(pass
);
222 username
= cm_creds
.username
? cm_creds
.username
: "";
223 password
= cm_creds
.password
? cm_creds
.password
: "";
225 if (!NT_STATUS_IS_OK(cli_session_setup(c
, username
,
226 password
, strlen(password
),
227 password
, strlen(password
),
229 /* If a password was not supplied then
230 * try again with a null username. */
231 if (password
[0] || !username
[0] || cm_creds
.use_kerberos
||
232 !NT_STATUS_IS_OK(cli_session_setup(c
, "",
236 d_printf("session setup failed: %s\n", cli_errstr(c
));
237 if (NT_STATUS_V(cli_nt_error(c
)) ==
238 NT_STATUS_V(NT_STATUS_MORE_PROCESSING_REQUIRED
))
239 d_printf("did you forget to run kinit?\n");
243 d_printf("Anonymous login successful\n");
246 if ( show_sessetup
) {
247 if (*c
->server_domain
) {
248 DEBUG(0,("Domain=[%s] OS=[%s] Server=[%s]\n",
249 c
->server_domain
,c
->server_os
,c
->server_type
));
250 } else if (*c
->server_os
|| *c
->server_type
) {
251 DEBUG(0,("OS=[%s] Server=[%s]\n",
252 c
->server_os
,c
->server_type
));
255 DEBUG(4,(" session setup ok\n"));
257 /* here's the fun part....to support 'msdfs proxy' shares
258 (on Samba or windows) we have to issues a TRANS_GET_DFS_REFERRAL
259 here before trying to connect to the original share.
260 check_dfs_proxy() will fail if it is a normal share. */
262 if ((c
->capabilities
& CAP_DFS
) &&
263 cli_check_msdfs_proxy(ctx
, c
, sharename
,
264 &newserver
, &newshare
,
270 return do_connect(ctx
, newserver
,
272 force_encrypt
, max_protocol
,
276 /* must be a normal share */
278 status
= cli_tcon_andx(c
, sharename
, "?????",
279 password
, strlen(password
)+1);
280 if (!NT_STATUS_IS_OK(status
)) {
281 d_printf("tree connect failed: %s\n", nt_errstr(status
));
287 status
= cli_cm_force_encryption(c
,
292 if (!NT_STATUS_IS_OK(status
)) {
298 DEBUG(4,(" tconx ok\n"));
302 /****************************************************************************
303 ****************************************************************************/
305 static void cli_cm_set_mntpoint(struct cli_state
*c
, const char *mnt
)
307 struct client_connection
*p
;
310 for (p
=connections
,i
=0; p
; p
=p
->next
,i
++) {
311 if (strequal(p
->cli
->desthost
, c
->desthost
) &&
312 strequal(p
->cli
->share
, c
->share
)) {
318 char *name
= clean_name(NULL
, mnt
);
322 TALLOC_FREE(p
->mount
);
323 p
->mount
= talloc_strdup(p
, name
);
328 /****************************************************************************
329 ****************************************************************************/
331 const char *cli_cm_get_mntpoint(struct cli_state
*c
)
333 struct client_connection
*p
;
336 for (p
=connections
,i
=0; p
; p
=p
->next
,i
++) {
337 if (strequal(p
->cli
->desthost
, c
->desthost
) &&
338 strequal(p
->cli
->share
, c
->share
)) {
349 /********************************************************************
350 Add a new connection to the list
351 ********************************************************************/
353 static struct cli_state
*cli_cm_connect(TALLOC_CTX
*ctx
,
354 struct cli_state
*referring_cli
,
363 struct client_connection
*node
;
365 /* NB This must be the null context here... JRA. */
366 node
= TALLOC_ZERO_ARRAY(NULL
, struct client_connection
, 1);
371 node
->cli
= do_connect(ctx
, server
, share
,
372 show_hdr
, force_encrypt
, max_protocol
,
380 DLIST_ADD( connections
, node
);
382 cli_cm_set_mntpoint(node
->cli
, "");
384 if (referring_cli
&& referring_cli
->posix_capabilities
) {
386 uint32 caplow
, caphigh
;
387 if (cli_unix_extensions_version(node
->cli
, &major
,
388 &minor
, &caplow
, &caphigh
)) {
389 cli_set_unix_extensions_capabilities(node
->cli
,
398 /********************************************************************
399 Return a connection to a server.
400 ********************************************************************/
402 static struct cli_state
*cli_cm_find(const char *server
, const char *share
)
404 struct client_connection
*p
;
406 for (p
=connections
; p
; p
=p
->next
) {
407 if ( strequal(server
, p
->cli
->desthost
) &&
408 strequal(share
,p
->cli
->share
)) {
416 /****************************************************************************
417 Open a client connection to a \\server\share. Set's the current *cli
418 global variable as a side-effect (but only if the connection is successful).
419 ****************************************************************************/
421 struct cli_state
*cli_cm_open(TALLOC_CTX
*ctx
,
422 struct cli_state
*referring_cli
,
433 /* try to reuse an existing connection */
435 c
= cli_cm_find(server
, share
);
437 c
= cli_cm_connect(ctx
, referring_cli
,
438 server
, share
, show_hdr
, force_encrypt
,
439 max_protocol
, port
, name_type
);
445 /****************************************************************************
446 ****************************************************************************/
448 void cli_cm_shutdown(void)
450 struct client_connection
*p
, *x
;
452 for (p
=connections
; p
;) {
453 cli_shutdown(p
->cli
);
464 /****************************************************************************
465 ****************************************************************************/
467 void cli_cm_display(void)
469 struct client_connection
*p
;
472 for ( p
=connections
,i
=0; p
; p
=p
->next
,i
++ ) {
473 d_printf("%d:\tserver=%s, share=%s\n",
474 i
, p
->cli
->desthost
, p
->cli
->share
);
478 /****************************************************************************
479 ****************************************************************************/
481 static void cm_set_password(const char *newpass
)
483 SAFE_FREE(cm_creds
.password
);
484 cm_creds
.password
= SMB_STRDUP(newpass
);
485 if (cm_creds
.password
) {
486 cm_creds
.got_pass
= true;
490 /****************************************************************************
491 ****************************************************************************/
493 void cli_cm_set_credentials(struct user_auth_info
*auth_info
)
495 SAFE_FREE(cm_creds
.username
);
496 cm_creds
.username
= SMB_STRDUP(get_cmdline_auth_info_username(
499 if (get_cmdline_auth_info_got_pass(auth_info
)) {
500 cm_set_password(get_cmdline_auth_info_password(auth_info
));
503 cm_creds
.use_kerberos
= get_cmdline_auth_info_use_kerberos(auth_info
);
504 cm_creds
.fallback_after_kerberos
= false;
505 cm_creds
.signing_state
= get_cmdline_auth_info_signing_state(auth_info
);
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
->inbuf
,
790 &referrals
[i
].dfspath
,
792 STR_TERMINATE
|STR_UNICODE
);
794 if (!referrals
[i
].dfspath
) {
799 if (i
< num_referrals
) {
806 *num_refs
= num_referrals
;
816 /********************************************************************
817 ********************************************************************/
819 bool cli_resolve_path(TALLOC_CTX
*ctx
,
821 struct cli_state
*rootcli
,
823 struct cli_state
**targetcli
,
824 char **pp_targetpath
)
826 CLIENT_DFS_REFERRAL
*refs
= NULL
;
829 struct cli_state
*cli_ipc
= NULL
;
830 char *dfs_path
= NULL
;
831 char *cleanpath
= NULL
;
832 char *extrapath
= NULL
;
836 struct cli_state
*newcli
= NULL
;
837 char *newpath
= NULL
;
838 char *newmount
= NULL
;
840 SMB_STRUCT_STAT sbuf
;
843 if ( !rootcli
|| !path
|| !targetcli
) {
847 /* Don't do anything if this is not a DFS root. */
849 if ( !rootcli
->dfsroot
) {
850 *targetcli
= rootcli
;
851 *pp_targetpath
= talloc_strdup(ctx
, path
);
852 if (!*pp_targetpath
) {
860 /* Send a trans2_query_path_info to check for a referral. */
862 cleanpath
= clean_path(ctx
, path
);
867 dfs_path
= cli_dfs_make_full_path(ctx
, rootcli
, cleanpath
);
872 if (cli_qpathinfo_basic( rootcli
, dfs_path
, &sbuf
, &attributes
)) {
873 /* This is an ordinary path, just return it. */
874 *targetcli
= rootcli
;
875 *pp_targetpath
= talloc_strdup(ctx
, path
);
876 if (!*pp_targetpath
) {
882 /* Special case where client asked for a path that does not exist */
884 if (cli_dfs_check_error(rootcli
, NT_STATUS_OBJECT_NAME_NOT_FOUND
)) {
885 *targetcli
= rootcli
;
886 *pp_targetpath
= talloc_strdup(ctx
, path
);
887 if (!*pp_targetpath
) {
893 /* We got an error, check for DFS referral. */
895 if (!cli_dfs_check_error(rootcli
, NT_STATUS_PATH_NOT_COVERED
)) {
899 /* Check for the referral. */
901 if (!(cli_ipc
= cli_cm_open(ctx
, rootcli
,
904 (rootcli
->trans_enc_state
!= NULL
),
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
),
956 d_printf("Unable to follow dfs referral [\\%s\\%s]\n",
961 if (extrapath
&& strlen(extrapath
) > 0) {
962 *pp_targetpath
= talloc_asprintf(ctx
,
966 if (!*pp_targetpath
) {
971 /* parse out the consumed mount path */
972 /* trim off the \server\share\ */
976 if (*ppath
!= '\\') {
977 d_printf("cli_resolve_path: "
978 "dfs_path (%s) not in correct format.\n",
983 ppath
++; /* Now pointing at start of server name. */
985 if ((ppath
= strchr_m( dfs_path
, '\\' )) == NULL
) {
989 ppath
++; /* Now pointing at start of share name. */
991 if ((ppath
= strchr_m( ppath
+1, '\\' )) == NULL
) {
995 ppath
++; /* Now pointing at path component. */
997 newmount
= talloc_asprintf(ctx
, "%s\\%s", mountpt
, ppath
);
1002 cli_cm_set_mntpoint(*targetcli
, newmount
);
1004 /* Check for another dfs referral, note that we are not
1005 checking for loops here. */
1007 if (!strequal(*pp_targetpath
, "\\") && !strequal(*pp_targetpath
, "/")) {
1008 if (cli_resolve_path(ctx
,
1015 * When cli_resolve_path returns true here it's always
1016 * returning the complete path in newpath, so we're done
1019 *targetcli
= newcli
;
1020 *pp_targetpath
= newpath
;
1027 /* If returning true ensure we return a dfs root full path. */
1028 if ((*targetcli
)->dfsroot
) {
1029 dfs_path
= talloc_strdup(ctx
, *pp_targetpath
);
1033 *pp_targetpath
= cli_dfs_make_full_path(ctx
, *targetcli
, dfs_path
);
1039 /********************************************************************
1040 ********************************************************************/
1042 static bool cli_check_msdfs_proxy(TALLOC_CTX
*ctx
,
1043 struct cli_state
*cli
,
1044 const char *sharename
,
1045 char **pp_newserver
,
1048 const char *username
,
1049 const char *password
,
1052 CLIENT_DFS_REFERRAL
*refs
= NULL
;
1053 size_t num_refs
= 0;
1055 char *fullpath
= NULL
;
1058 char *newextrapath
= NULL
;
1060 if (!cli
|| !sharename
) {
1066 /* special case. never check for a referral on the IPC$ share */
1068 if (strequal(sharename
, "IPC$")) {
1072 /* send a trans2_query_path_info to check for a referral */
1074 fullpath
= talloc_asprintf(ctx
, "\\%s\\%s", cli
->desthost
, sharename
);
1079 /* check for the referral */
1081 if (!NT_STATUS_IS_OK(cli_tcon_andx(cli
, "IPC$", "IPC", NULL
, 0))) {
1085 if (force_encrypt
) {
1086 NTSTATUS status
= cli_cm_force_encryption(cli
,
1091 if (!NT_STATUS_IS_OK(status
)) {
1096 res
= cli_dfs_get_referral(ctx
, cli
, fullpath
, &refs
, &num_refs
, &consumed
);
1098 if (!cli_tdis(cli
)) {
1104 if (!res
|| !num_refs
) {
1108 if (!refs
[0].dfspath
) {
1112 split_dfs_path(ctx
, refs
[0].dfspath
, pp_newserver
,
1113 pp_newshare
, &newextrapath
);
1115 if ((*pp_newserver
== NULL
) || (*pp_newshare
== NULL
)) {
1119 /* check that this is not a self-referral */
1121 if (strequal(cli
->desthost
, *pp_newserver
) &&
1122 strequal(sharename
, *pp_newshare
)) {