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 if (!cli_negprot(c)) {
199 d_printf("protocol negotiation failed\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,
265 newshare, false, force_encrypt);
268 /* must be a normal share */
270 if (!cli_send_tconX(c, sharename, "?????",
271 password, strlen(password)+1)) {
272 d_printf("tree connect failed: %s\n", cli_errstr(c));
278 status = cli_cm_force_encryption(c,
283 if (!NT_STATUS_IS_OK(status)) {
289 DEBUG(4,(" tconx ok\n"));
293 /****************************************************************************
294 ****************************************************************************/
296 static void cli_cm_set_mntpoint(struct cli_state *c, const char *mnt)
298 struct client_connection *p;
301 for (p=connections,i=0; p; p=p->next,i++) {
302 if (strequal(p->cli->desthost, c->desthost) &&
303 strequal(p->cli->share, c->share)) {
309 char *name = clean_name(NULL, p->mount);
313 p->mount = talloc_strdup(p, name);
318 /****************************************************************************
319 ****************************************************************************/
321 const char *cli_cm_get_mntpoint(struct cli_state *c)
323 struct client_connection *p;
326 for (p=connections,i=0; p; p=p->next,i++) {
327 if (strequal(p->cli->desthost, c->desthost) &&
328 strequal(p->cli->share, c->share)) {
339 /********************************************************************
340 Add a new connection to the list
341 ********************************************************************/
343 static struct cli_state *cli_cm_connect(TALLOC_CTX *ctx,
344 struct cli_state *referring_cli,
350 struct client_connection *node;
352 /* NB This must be the null context here... JRA. */
353 node = TALLOC_ZERO_ARRAY(NULL, struct client_connection, 1);
358 node->cli = do_connect(ctx, server, share, show_hdr, force_encrypt);
365 DLIST_ADD( connections, node );
367 cli_cm_set_mntpoint(node->cli, "");
369 if (referring_cli && referring_cli->posix_capabilities) {
371 uint32 caplow, caphigh;
372 if (cli_unix_extensions_version(node->cli, &major,
373 &minor, &caplow, &caphigh)) {
374 cli_set_unix_extensions_capabilities(node->cli,
383 /********************************************************************
384 Return a connection to a server.
385 ********************************************************************/
387 static struct cli_state *cli_cm_find(const char *server, const char *share)
389 struct client_connection *p;
391 for (p=connections; p; p=p->next) {
392 if ( strequal(server, p->cli->desthost) &&
393 strequal(share,p->cli->share)) {
401 /****************************************************************************
402 Open a client connection to a \\server\share. Set's the current *cli
403 global variable as a side-effect (but only if the connection is successful).
404 ****************************************************************************/
406 struct cli_state *cli_cm_open(TALLOC_CTX *ctx,
407 struct cli_state *referring_cli,
415 /* try to reuse an existing connection */
417 c = cli_cm_find(server, share);
419 c = cli_cm_connect(ctx, referring_cli,
420 server, share, show_hdr, force_encrypt);
426 /****************************************************************************
427 ****************************************************************************/
429 void cli_cm_shutdown(void)
431 struct client_connection *p, *x;
433 for (p=connections; p;) {
434 cli_shutdown(p->cli);
445 /****************************************************************************
446 ****************************************************************************/
448 void cli_cm_display(void)
450 struct client_connection *p;
453 for ( p=connections,i=0; p; p=p->next,i++ ) {
454 d_printf("%d:\tserver=%s, share=%s\n",
455 i, p->cli->desthost, p->cli->share );
459 /****************************************************************************
460 ****************************************************************************/
462 static void cm_set_password(const char *newpass)
464 SAFE_FREE(cm_creds.password);
465 cm_creds.password = SMB_STRDUP(newpass);
466 if (cm_creds.password) {
467 cm_creds.got_pass = true;
471 /****************************************************************************
472 ****************************************************************************/
474 void cli_cm_set_credentials(void)
476 SAFE_FREE(cm_creds.username);
477 cm_creds.username = SMB_STRDUP(get_cmdline_auth_info_username());
479 if (get_cmdline_auth_info_got_pass()) {
480 cm_set_password(get_cmdline_auth_info_password());
483 cm_creds.use_kerberos = get_cmdline_auth_info_use_kerberos();
484 cm_creds.fallback_after_kerberos = false;
485 cm_creds.signing_state = get_cmdline_auth_info_signing_state();
488 /****************************************************************************
489 ****************************************************************************/
491 void cli_cm_set_port(int port_number)
496 /****************************************************************************
497 ****************************************************************************/
499 void cli_cm_set_dest_name_type(int type)
504 /****************************************************************************
505 ****************************************************************************/
507 void cli_cm_set_signing_state(int state)
509 cm_creds.signing_state = state;
512 /****************************************************************************
513 ****************************************************************************/
515 void cli_cm_set_username(const char *username)
517 SAFE_FREE(cm_creds.username);
518 cm_creds.username = SMB_STRDUP(username);
521 /****************************************************************************
522 ****************************************************************************/
524 void cli_cm_set_password(const char *newpass)
526 SAFE_FREE(cm_creds.password);
527 cm_creds.password = SMB_STRDUP(newpass);
528 if (cm_creds.password) {
529 cm_creds.got_pass = true;
533 /****************************************************************************
534 ****************************************************************************/
536 void cli_cm_set_use_kerberos(void)
538 cm_creds.use_kerberos = true;
541 /****************************************************************************
542 ****************************************************************************/
544 void cli_cm_set_fallback_after_kerberos(void)
546 cm_creds.fallback_after_kerberos = true;
549 /****************************************************************************
550 ****************************************************************************/
552 void cli_cm_set_dest_ss(struct sockaddr_storage *pss)
558 /**********************************************************************
559 split a dfs path into the server, share name, and extrapath components
560 **********************************************************************/
562 static void split_dfs_path(TALLOC_CTX *ctx,
563 const char *nodepath,
573 *pp_extrapath = NULL;
575 path = talloc_strdup(ctx, nodepath);
580 if ( path[0] != '\\' ) {
584 p = strchr_m( path + 1, '\\' );
592 /* Look for any extra/deep path */
593 q = strchr_m(p, '\\');
597 *pp_extrapath = talloc_strdup(ctx, q);
599 *pp_extrapath = talloc_strdup(ctx, "");
602 *pp_share = talloc_strdup(ctx, p);
603 *pp_server = talloc_strdup(ctx, &path[1]);
606 /****************************************************************************
607 Return the original path truncated at the directory component before
608 the first wildcard character. Trust the caller to provide a NULL
610 ****************************************************************************/
612 static char *clean_path(TALLOC_CTX *ctx, const char *path)
618 /* No absolute paths. */
619 while (IS_DIRECTORY_SEP(*path)) {
623 path_out = talloc_strdup(ctx, path);
628 p1 = strchr_m(path_out, '*');
629 p2 = strchr_m(path_out, '?');
641 /* Now go back to the start of this component. */
642 p1 = strrchr_m(path_out, '/');
643 p2 = strrchr_m(path_out, '\\');
650 /* Strip any trailing separator */
652 len = strlen(path_out);
653 if ( (len > 0) && IS_DIRECTORY_SEP(path_out[len-1])) {
654 path_out[len-1] = '\0';
660 /****************************************************************************
661 ****************************************************************************/
663 static char *cli_dfs_make_full_path(TALLOC_CTX *ctx,
664 struct cli_state *cli,
667 /* Ensure the extrapath doesn't start with a separator. */
668 while (IS_DIRECTORY_SEP(*dir)) {
672 return talloc_asprintf(ctx, "\\%s\\%s\\%s",
673 cli->desthost, cli->share, dir);
676 /********************************************************************
677 check for dfs referral
678 ********************************************************************/
680 static bool cli_dfs_check_error( struct cli_state *cli, NTSTATUS status )
682 uint32 flgs2 = SVAL(cli->inbuf,smb_flg2);
684 /* only deal with DS when we negotiated NT_STATUS codes and UNICODE */
686 if (!((flgs2&FLAGS2_32_BIT_ERROR_CODES) &&
687 (flgs2&FLAGS2_UNICODE_STRINGS)))
690 if (NT_STATUS_EQUAL(status, NT_STATUS(IVAL(cli->inbuf,smb_rcls))))
696 /********************************************************************
697 Get the dfs referral link.
698 ********************************************************************/
700 bool cli_dfs_get_referral(TALLOC_CTX *ctx,
701 struct cli_state *cli,
703 CLIENT_DFS_REFERRAL**refs,
707 unsigned int data_len = 0;
708 unsigned int param_len = 0;
709 uint16 setup = TRANSACT2_GET_DFS_REFERRAL;
711 char *rparam=NULL, *rdata=NULL;
714 size_t pathlen = 2*(strlen(path)+1);
715 uint16 num_referrals;
716 CLIENT_DFS_REFERRAL *referrals = NULL;
722 param = SMB_MALLOC_ARRAY(char, 2+pathlen+2);
726 SSVAL(param, 0, 0x03); /* max referral level */
729 p += clistr_push(cli, p, path, pathlen, STR_TERMINATE);
730 param_len = PTR_DIFF(p, param);
732 if (!cli_send_trans(cli, SMBtrans2,
734 -1, 0, /* fid, flags */
735 &setup, 1, 0, /* setup, length, max */
736 param, param_len, 2, /* param, length, max */
737 NULL, 0, cli->max_xmit /* data, length, max */
745 if (!cli_receive_trans(cli, SMBtrans2,
747 &rdata, &data_len)) {
755 endp = rdata + data_len;
757 *consumed = SVAL(rdata, 0);
758 num_referrals = SVAL(rdata, 2);
760 if (num_referrals != 0) {
766 referrals = TALLOC_ARRAY(ctx, CLIENT_DFS_REFERRAL,
772 /* start at the referrals array */
775 for (i=0; i<num_referrals && p < endp; i++) {
779 ref_version = SVAL(p, 0);
780 ref_size = SVAL(p, 2);
781 node_offset = SVAL(p, 16);
783 if (ref_version != 3) {
788 referrals[i].proximity = SVAL(p, 8);
789 referrals[i].ttl = SVAL(p, 10);
791 if (p + node_offset > endp) {
794 clistr_pull_talloc(ctx, cli, &referrals[i].dfspath,
796 STR_TERMINATE|STR_UNICODE );
798 if (!referrals[i].dfspath) {
803 if (i < num_referrals) {
810 *num_refs = num_referrals;
820 /********************************************************************
821 ********************************************************************/
823 bool cli_resolve_path(TALLOC_CTX *ctx,
825 struct cli_state *rootcli,
827 struct cli_state **targetcli,
828 char **pp_targetpath)
830 CLIENT_DFS_REFERRAL *refs = NULL;
833 struct cli_state *cli_ipc = NULL;
834 char *dfs_path = NULL;
835 char *cleanpath = NULL;
836 char *extrapath = NULL;
840 struct cli_state *newcli = NULL;
841 char *newpath = NULL;
842 char *newmount = NULL;
844 SMB_STRUCT_STAT sbuf;
847 if ( !rootcli || !path || !targetcli ) {
851 /* Don't do anything if this is not a DFS root. */
853 if ( !rootcli->dfsroot) {
854 *targetcli = rootcli;
855 *pp_targetpath = talloc_strdup(ctx, path);
856 if (!*pp_targetpath) {
864 /* Send a trans2_query_path_info to check for a referral. */
866 cleanpath = clean_path(ctx, path);
871 dfs_path = cli_dfs_make_full_path(ctx, rootcli, cleanpath);
876 if (cli_qpathinfo_basic( rootcli, dfs_path, &sbuf, &attributes)) {
877 /* This is an ordinary path, just return it. */
878 *targetcli = rootcli;
879 *pp_targetpath = talloc_strdup(ctx, path);
880 if (!*pp_targetpath) {
886 /* Special case where client asked for a path that does not exist */
888 if (cli_dfs_check_error(rootcli, NT_STATUS_OBJECT_NAME_NOT_FOUND)) {
889 *targetcli = rootcli;
890 *pp_targetpath = talloc_strdup(ctx, path);
891 if (!*pp_targetpath) {
897 /* We got an error, check for DFS referral. */
899 if (!cli_dfs_check_error(rootcli, NT_STATUS_PATH_NOT_COVERED)) {
903 /* Check for the referral. */
905 if (!(cli_ipc = cli_cm_open(ctx, rootcli,
908 (rootcli->trans_enc_state != NULL)))) {
912 if (!cli_dfs_get_referral(ctx, cli_ipc, dfs_path, &refs,
913 &num_refs, &consumed) || !num_refs) {
917 /* Just store the first referral for now. */
919 if (!refs[0].dfspath) {
922 split_dfs_path(ctx, refs[0].dfspath, &server, &share, &extrapath );
924 if (!server || !share) {
928 /* Make sure to recreate the original string including any wildcards. */
930 dfs_path = cli_dfs_make_full_path(ctx, rootcli, path);
934 pathlen = strlen(dfs_path)*2;
935 consumed = MIN(pathlen, consumed);
936 *pp_targetpath = talloc_strdup(ctx, &dfs_path[consumed/2]);
937 if (!*pp_targetpath) {
940 dfs_path[consumed/2] = '\0';
943 * *pp_targetpath is now the unconsumed part of the path.
944 * dfs_path is now the consumed part of the path
945 * (in \server\share\path format).
948 /* Open the connection to the target server & share */
949 if ((*targetcli = cli_cm_open(ctx, rootcli,
953 (rootcli->trans_enc_state != NULL))) == 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)) {