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 {
52 static void cm_set_password(const char *newpass);
55 static int name_type = 0x20;
57 static struct sockaddr_storage dest_ss;
59 static struct client_connection *connections;
61 static bool cli_check_msdfs_proxy(TALLOC_CTX *ctx,
62 struct cli_state *cli,
63 const char *sharename,
71 /********************************************************************
72 Ensure a connection is encrypted.
73 ********************************************************************/
75 NTSTATUS cli_cm_force_encryption(struct cli_state *c,
79 const char *sharename)
81 NTSTATUS status = cli_force_encryption(c,
86 if (NT_STATUS_EQUAL(status,NT_STATUS_NOT_SUPPORTED)) {
87 d_printf("Encryption required and "
88 "server that doesn't support "
89 "UNIX extensions - failing connect\n");
90 } else if (NT_STATUS_EQUAL(status,NT_STATUS_UNKNOWN_REVISION)) {
91 d_printf("Encryption required and "
92 "can't get UNIX CIFS extensions "
93 "version from server.\n");
94 } else if (NT_STATUS_EQUAL(status,NT_STATUS_UNSUPPORTED_COMPRESSION)) {
95 d_printf("Encryption required and "
96 "share %s doesn't support "
97 "encryption.\n", sharename);
98 } else if (!NT_STATUS_IS_OK(status)) {
99 d_printf("Encryption required and "
100 "setup failed with error %s.\n",
107 /********************************************************************
108 Return a connection to a server.
109 ********************************************************************/
111 static struct cli_state *do_connect(TALLOC_CTX *ctx,
117 struct cli_state *c = NULL;
118 struct nmb_name called, calling;
119 const char *server_n;
120 struct sockaddr_storage ss;
123 char *newserver, *newshare;
124 const char *username;
125 const char *password;
128 /* make a copy so we don't modify the global string 'service' */
129 servicename = talloc_strdup(ctx,share);
133 sharename = servicename;
134 if (*sharename == '\\') {
135 server = sharename+2;
136 sharename = strchr_m(server,'\\');
148 make_nmb_name(&calling, global_myname(), 0x0);
149 make_nmb_name(&called , server, name_type);
156 /* have to open a new connection */
157 if (!(c=cli_initialise()) || (cli_set_port(c, port) != port)) {
158 d_printf("Connection to %s failed\n", server_n);
161 status = cli_connect(c, server_n, &ss);
162 if (!NT_STATUS_IS_OK(status)) {
163 d_printf("Connection to %s failed (Error %s)\n",
169 c->protocol = max_protocol;
170 c->use_kerberos = cm_creds.use_kerberos;
171 cli_setup_signing_state(c, cm_creds.signing_state);
173 if (!cli_session_request(c, &calling, &called)) {
175 d_printf("session request to %s failed (%s)\n",
176 called.name, cli_errstr(c));
179 if ((p=strchr_m(called.name, '.'))) {
183 if (strcmp(called.name, "*SMBSERVER")) {
184 make_nmb_name(&called , "*SMBSERVER", 0x20);
190 DEBUG(4,(" session request ok\n"));
192 if (!cli_negprot(c)) {
193 d_printf("protocol negotiation failed\n");
198 if (!cm_creds.got_pass) {
199 char *pass = getpass("Password: ");
201 cm_set_password(pass);
205 username = cm_creds.username ? cm_creds.username : "";
206 password = cm_creds.password ? cm_creds.password : "";
208 if (!NT_STATUS_IS_OK(cli_session_setup(c, username,
209 password, strlen(password),
210 password, strlen(password),
212 /* If a password was not supplied then
213 * try again with a null username. */
214 if (password[0] || !username[0] || cm_creds.use_kerberos ||
215 !NT_STATUS_IS_OK(cli_session_setup(c, "",
219 d_printf("session setup failed: %s\n", cli_errstr(c));
220 if (NT_STATUS_V(cli_nt_error(c)) ==
221 NT_STATUS_V(NT_STATUS_MORE_PROCESSING_REQUIRED))
222 d_printf("did you forget to run kinit?\n");
226 d_printf("Anonymous login successful\n");
229 if ( show_sessetup ) {
230 if (*c->server_domain) {
231 DEBUG(0,("Domain=[%s] OS=[%s] Server=[%s]\n",
232 c->server_domain,c->server_os,c->server_type));
233 } else if (*c->server_os || *c->server_type) {
234 DEBUG(0,("OS=[%s] Server=[%s]\n",
235 c->server_os,c->server_type));
238 DEBUG(4,(" session setup ok\n"));
240 /* here's the fun part....to support 'msdfs proxy' shares
241 (on Samba or windows) we have to issues a TRANS_GET_DFS_REFERRAL
242 here before trying to connect to the original share.
243 check_dfs_proxy() will fail if it is a normal share. */
245 if ((c->capabilities & CAP_DFS) &&
246 cli_check_msdfs_proxy(ctx, c, sharename,
247 &newserver, &newshare,
253 return do_connect(ctx, newserver,
254 newshare, false, force_encrypt);
257 /* must be a normal share */
259 if (!cli_send_tconX(c, sharename, "?????",
260 password, strlen(password)+1)) {
261 d_printf("tree connect failed: %s\n", cli_errstr(c));
267 status = cli_cm_force_encryption(c,
272 if (!NT_STATUS_IS_OK(status)) {
278 DEBUG(4,(" tconx ok\n"));
282 /****************************************************************************
283 ****************************************************************************/
285 static void cli_cm_set_mntpoint(struct cli_state *c, const char *mnt)
287 struct client_connection *p;
290 for (p=connections,i=0; p; p=p->next,i++) {
291 if (strequal(p->cli->desthost, c->desthost) &&
292 strequal(p->cli->share, c->share)) {
298 char *name = clean_name(NULL, p->mount);
302 p->mount = talloc_strdup(p, name);
307 /****************************************************************************
308 ****************************************************************************/
310 const char *cli_cm_get_mntpoint(struct cli_state *c)
312 struct client_connection *p;
315 for (p=connections,i=0; p; p=p->next,i++) {
316 if (strequal(p->cli->desthost, c->desthost) &&
317 strequal(p->cli->share, c->share)) {
328 /********************************************************************
329 Add a new connection to the list
330 ********************************************************************/
332 static struct cli_state *cli_cm_connect(TALLOC_CTX *ctx,
333 struct cli_state *referring_cli,
339 struct client_connection *node;
341 /* NB This must be the null context here... JRA. */
342 node = TALLOC_ZERO_ARRAY(NULL, struct client_connection, 1);
347 node->cli = do_connect(ctx, server, share, show_hdr, force_encrypt);
354 DLIST_ADD( connections, node );
356 cli_cm_set_mntpoint(node->cli, "");
358 if (referring_cli && referring_cli->posix_capabilities) {
360 uint32 caplow, caphigh;
361 if (cli_unix_extensions_version(node->cli, &major,
362 &minor, &caplow, &caphigh)) {
363 cli_set_unix_extensions_capabilities(node->cli,
372 /********************************************************************
373 Return a connection to a server.
374 ********************************************************************/
376 static struct cli_state *cli_cm_find(const char *server, const char *share)
378 struct client_connection *p;
380 for (p=connections; p; p=p->next) {
381 if ( strequal(server, p->cli->desthost) &&
382 strequal(share,p->cli->share)) {
390 /****************************************************************************
391 Open a client connection to a \\server\share. Set's the current *cli
392 global variable as a side-effect (but only if the connection is successful).
393 ****************************************************************************/
395 struct cli_state *cli_cm_open(TALLOC_CTX *ctx,
396 struct cli_state *referring_cli,
404 /* try to reuse an existing connection */
406 c = cli_cm_find(server, share);
408 c = cli_cm_connect(ctx, referring_cli,
409 server, share, show_hdr, force_encrypt);
415 /****************************************************************************
416 ****************************************************************************/
418 void cli_cm_shutdown(void)
420 struct client_connection *p, *x;
422 for (p=connections; p;) {
423 cli_shutdown(p->cli);
434 /****************************************************************************
435 ****************************************************************************/
437 void cli_cm_display(void)
439 struct client_connection *p;
442 for ( p=connections,i=0; p; p=p->next,i++ ) {
443 d_printf("%d:\tserver=%s, share=%s\n",
444 i, p->cli->desthost, p->cli->share );
448 /****************************************************************************
449 ****************************************************************************/
451 static void cm_set_password(const char *newpass)
453 SAFE_FREE(cm_creds.password);
454 cm_creds.password = SMB_STRDUP(newpass);
455 if (cm_creds.password) {
456 cm_creds.got_pass = true;
460 void cli_cm_set_credentials(void)
462 SAFE_FREE(cm_creds.username);
463 cm_creds.username = SMB_STRDUP(get_cmdline_auth_info_username());
465 if (get_cmdline_auth_info_got_pass()) {
466 cm_set_password(get_cmdline_auth_info_password());
469 cm_creds.use_kerberos = get_cmdline_auth_info_use_kerberos();
470 cm_creds.signing_state = get_cmdline_auth_info_signing_state();
473 /****************************************************************************
474 ****************************************************************************/
476 void cli_cm_set_port(int port_number)
481 /****************************************************************************
482 ****************************************************************************/
484 void cli_cm_set_dest_name_type(int type)
489 /****************************************************************************
490 ****************************************************************************/
492 void cli_cm_set_dest_ss(struct sockaddr_storage *pss)
498 /**********************************************************************
499 split a dfs path into the server, share name, and extrapath components
500 **********************************************************************/
502 static void split_dfs_path(TALLOC_CTX *ctx,
503 const char *nodepath,
513 *pp_extrapath = NULL;
515 path = talloc_strdup(ctx, nodepath);
520 if ( path[0] != '\\' ) {
524 p = strchr_m( path + 1, '\\' );
532 /* Look for any extra/deep path */
533 q = strchr_m(p, '\\');
537 *pp_extrapath = talloc_strdup(ctx, q);
539 *pp_extrapath = talloc_strdup(ctx, "");
542 *pp_share = talloc_strdup(ctx, p);
543 *pp_server = talloc_strdup(ctx, &path[1]);
546 /****************************************************************************
547 Return the original path truncated at the directory component before
548 the first wildcard character. Trust the caller to provide a NULL
550 ****************************************************************************/
552 static char *clean_path(TALLOC_CTX *ctx, const char *path)
558 /* No absolute paths. */
559 while (IS_DIRECTORY_SEP(*path)) {
563 path_out = talloc_strdup(ctx, path);
568 p1 = strchr_m(path_out, '*');
569 p2 = strchr_m(path_out, '?');
581 /* Now go back to the start of this component. */
582 p1 = strrchr_m(path_out, '/');
583 p2 = strrchr_m(path_out, '\\');
590 /* Strip any trailing separator */
592 len = strlen(path_out);
593 if ( (len > 0) && IS_DIRECTORY_SEP(path_out[len-1])) {
594 path_out[len-1] = '\0';
600 /****************************************************************************
601 ****************************************************************************/
603 static char *cli_dfs_make_full_path(TALLOC_CTX *ctx,
604 struct cli_state *cli,
607 /* Ensure the extrapath doesn't start with a separator. */
608 while (IS_DIRECTORY_SEP(*dir)) {
612 return talloc_asprintf(ctx, "\\%s\\%s\\%s",
613 cli->desthost, cli->share, dir);
616 /********************************************************************
617 check for dfs referral
618 ********************************************************************/
620 static bool cli_dfs_check_error( struct cli_state *cli, NTSTATUS status )
622 uint32 flgs2 = SVAL(cli->inbuf,smb_flg2);
624 /* only deal with DS when we negotiated NT_STATUS codes and UNICODE */
626 if (!((flgs2&FLAGS2_32_BIT_ERROR_CODES) &&
627 (flgs2&FLAGS2_UNICODE_STRINGS)))
630 if (NT_STATUS_EQUAL(status, NT_STATUS(IVAL(cli->inbuf,smb_rcls))))
636 /********************************************************************
637 Get the dfs referral link.
638 ********************************************************************/
640 bool cli_dfs_get_referral(TALLOC_CTX *ctx,
641 struct cli_state *cli,
643 CLIENT_DFS_REFERRAL**refs,
647 unsigned int data_len = 0;
648 unsigned int param_len = 0;
649 uint16 setup = TRANSACT2_GET_DFS_REFERRAL;
651 char *rparam=NULL, *rdata=NULL;
654 size_t pathlen = 2*(strlen(path)+1);
655 uint16 num_referrals;
656 CLIENT_DFS_REFERRAL *referrals = NULL;
662 param = SMB_MALLOC_ARRAY(char, 2+pathlen+2);
666 SSVAL(param, 0, 0x03); /* max referral level */
669 p += clistr_push(cli, p, path, pathlen, STR_TERMINATE);
670 param_len = PTR_DIFF(p, param);
672 if (!cli_send_trans(cli, SMBtrans2,
674 -1, 0, /* fid, flags */
675 &setup, 1, 0, /* setup, length, max */
676 param, param_len, 2, /* param, length, max */
677 NULL, 0, cli->max_xmit /* data, length, max */
685 if (!cli_receive_trans(cli, SMBtrans2,
687 &rdata, &data_len)) {
695 endp = rdata + data_len;
697 *consumed = SVAL(rdata, 0);
698 num_referrals = SVAL(rdata, 2);
700 if (num_referrals != 0) {
706 referrals = TALLOC_ARRAY(ctx, CLIENT_DFS_REFERRAL,
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) {
734 clistr_pull_talloc(ctx, cli, &referrals[i].dfspath,
736 STR_TERMINATE|STR_UNICODE );
738 if (!referrals[i].dfspath) {
743 if (i < num_referrals) {
750 *num_refs = num_referrals;
760 /********************************************************************
761 ********************************************************************/
763 bool cli_resolve_path(TALLOC_CTX *ctx,
765 struct cli_state *rootcli,
767 struct cli_state **targetcli,
768 char **pp_targetpath)
770 CLIENT_DFS_REFERRAL *refs = NULL;
773 struct cli_state *cli_ipc = NULL;
774 char *dfs_path = NULL;
775 char *cleanpath = NULL;
776 char *extrapath = NULL;
780 struct cli_state *newcli = NULL;
781 char *newpath = NULL;
782 char *newmount = NULL;
784 SMB_STRUCT_STAT sbuf;
787 if ( !rootcli || !path || !targetcli ) {
791 /* Don't do anything if this is not a DFS root. */
793 if ( !rootcli->dfsroot) {
794 *targetcli = rootcli;
795 *pp_targetpath = talloc_strdup(ctx, path);
796 if (!*pp_targetpath) {
804 /* Send a trans2_query_path_info to check for a referral. */
806 cleanpath = clean_path(ctx, path);
811 dfs_path = cli_dfs_make_full_path(ctx, rootcli, cleanpath);
816 if (cli_qpathinfo_basic( rootcli, dfs_path, &sbuf, &attributes)) {
817 /* This is an ordinary path, just return it. */
818 *targetcli = rootcli;
819 *pp_targetpath = talloc_strdup(ctx, path);
820 if (!*pp_targetpath) {
826 /* Special case where client asked for a path that does not exist */
828 if (cli_dfs_check_error(rootcli, NT_STATUS_OBJECT_NAME_NOT_FOUND)) {
829 *targetcli = rootcli;
830 *pp_targetpath = talloc_strdup(ctx, path);
831 if (!*pp_targetpath) {
837 /* We got an error, check for DFS referral. */
839 if (!cli_dfs_check_error(rootcli, NT_STATUS_PATH_NOT_COVERED)) {
843 /* Check for the referral. */
845 if (!(cli_ipc = cli_cm_open(ctx, rootcli,
848 (rootcli->trans_enc_state != NULL)))) {
852 if (!cli_dfs_get_referral(ctx, cli_ipc, dfs_path, &refs,
853 &num_refs, &consumed) || !num_refs) {
857 /* Just store the first referral for now. */
859 if (!refs[0].dfspath) {
862 split_dfs_path(ctx, refs[0].dfspath, &server, &share, &extrapath );
864 if (!server || !share) {
868 /* Make sure to recreate the original string including any wildcards. */
870 dfs_path = cli_dfs_make_full_path(ctx, rootcli, path);
874 pathlen = strlen(dfs_path)*2;
875 consumed = MIN(pathlen, consumed);
876 *pp_targetpath = talloc_strdup(ctx, &dfs_path[consumed/2]);
877 if (!*pp_targetpath) {
880 dfs_path[consumed/2] = '\0';
883 * *pp_targetpath is now the unconsumed part of the path.
884 * dfs_path is now the consumed part of the path
885 * (in \server\share\path format).
888 /* Open the connection to the target server & share */
889 if ((*targetcli = cli_cm_open(ctx, rootcli,
893 (rootcli->trans_enc_state != NULL))) == NULL) {
894 d_printf("Unable to follow dfs referral [\\%s\\%s]\n",
899 if (extrapath && strlen(extrapath) > 0) {
900 *pp_targetpath = talloc_asprintf(ctx,
904 if (!*pp_targetpath) {
909 /* parse out the consumed mount path */
910 /* trim off the \server\share\ */
914 if (*ppath != '\\') {
915 d_printf("cli_resolve_path: "
916 "dfs_path (%s) not in correct format.\n",
921 ppath++; /* Now pointing at start of server name. */
923 if ((ppath = strchr_m( dfs_path, '\\' )) == NULL) {
927 ppath++; /* Now pointing at start of share name. */
929 if ((ppath = strchr_m( ppath+1, '\\' )) == NULL) {
933 ppath++; /* Now pointing at path component. */
935 newmount = talloc_asprintf(ctx, "%s\\%s", mountpt, ppath );
940 cli_cm_set_mntpoint(*targetcli, newmount);
942 /* Check for another dfs referral, note that we are not
943 checking for loops here. */
945 if (!strequal(*pp_targetpath, "\\") && !strequal(*pp_targetpath, "/")) {
946 if (cli_resolve_path(ctx,
953 * When cli_resolve_path returns true here it's always
954 * returning the complete path in newpath, so we're done
958 *pp_targetpath = newpath;
965 /* If returning true ensure we return a dfs root full path. */
966 if ((*targetcli)->dfsroot) {
967 dfs_path = talloc_strdup(ctx, *pp_targetpath);
971 *pp_targetpath = cli_dfs_make_full_path(ctx, *targetcli, dfs_path);
977 /********************************************************************
978 ********************************************************************/
980 static bool cli_check_msdfs_proxy(TALLOC_CTX *ctx,
981 struct cli_state *cli,
982 const char *sharename,
986 const char *username,
987 const char *password,
990 CLIENT_DFS_REFERRAL *refs = NULL;
993 char *fullpath = NULL;
996 char *newextrapath = NULL;
998 if (!cli || !sharename) {
1004 /* special case. never check for a referral on the IPC$ share */
1006 if (strequal(sharename, "IPC$")) {
1010 /* send a trans2_query_path_info to check for a referral */
1012 fullpath = talloc_asprintf(ctx, "\\%s\\%s", cli->desthost, sharename );
1017 /* check for the referral */
1019 if (!cli_send_tconX(cli, "IPC$", "IPC", NULL, 0)) {
1023 if (force_encrypt) {
1024 NTSTATUS status = cli_cm_force_encryption(cli,
1029 if (!NT_STATUS_IS_OK(status)) {
1034 res = cli_dfs_get_referral(ctx, cli, fullpath, &refs, &num_refs, &consumed);
1036 if (!cli_tdis(cli)) {
1042 if (!res || !num_refs) {
1046 if (!refs[0].dfspath) {
1050 split_dfs_path(ctx, refs[0].dfspath, pp_newserver,
1051 pp_newshare, &newextrapath );
1053 if (!pp_newserver || !pp_newshare) {
1057 /* check that this is not a self-referral */
1059 if (strequal(cli->desthost, *pp_newserver) &&
1060 strequal(sharename, *pp_newshare)) {