2 Unix SMB/Netbios implementation.
3 SMB client library implementation
4 Copyright (C) Andrew Tridgell 1998
5 Copyright (C) Richard Sharpe 2000, 2002
6 Copyright (C) John Terpstra 2000
7 Copyright (C) Tom Jansen (Ninja ISD) 2002
8 Copyright (C) Derrell Lipman 2003-2008
9 Copyright (C) Jeremy Allison 2007, 2008
10 Copyright (C) SATOH Fumiyasu <fumiyas@osstech.co.jp> 2009.
12 This program is free software; you can redistribute it and/or modify
13 it under the terms of the GNU General Public License as published by
14 the Free Software Foundation; either version 3 of the License, or
15 (at your option) any later version.
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 GNU General Public License for more details.
22 You should have received a copy of the GNU General Public License
23 along with this program. If not, see <http://www.gnu.org/licenses/>.
27 #include "libsmbclient.h"
28 #include "libsmb_internal.h"
29 #include "../librpc/gen_ndr/ndr_lsa.h"
30 #include "rpc_client/cli_lsarpc.h"
33 * Check a server for being alive and well.
34 * returns 0 if the server is in shape. Returns 1 on error
36 * Also useable outside libsmbclient to enable external cache
37 * to do some checks too.
40 SMBC_check_server(SMBCCTX * context,
47 return (getpeername(server->cli->fd, &addr, &size) == -1);
51 * Remove a server from the cached server list it's unused.
52 * On success, 0 is returned. 1 is returned if the server could not be removed.
54 * Also useable outside libsmbclient
57 SMBC_remove_unused_server(SMBCCTX * context,
62 /* are we being fooled ? */
63 if (!context || !context->internal->initialized || !srv) {
67 /* Check all open files/directories for a relation with this server */
68 for (file = context->internal->files; file; file = file->next) {
69 if (file->srv == srv) {
71 DEBUG(3, ("smbc_remove_usused_server: "
72 "%p still used by %p.\n",
78 DLIST_REMOVE(context->internal->servers, srv);
80 cli_shutdown(srv->cli);
83 DEBUG(3, ("smbc_remove_usused_server: %p removed.\n", srv));
85 smbc_getFunctionRemoveCachedServer(context)(context, srv);
91 /****************************************************************
92 * Call the auth_fn with fixed size (fstring) buffers.
93 ***************************************************************/
95 SMBC_call_auth_fn(TALLOC_CTX *ctx,
106 smbc_get_auth_data_with_context_fn auth_with_context_fn;
108 strlcpy(workgroup, *pp_workgroup, sizeof(workgroup));
109 strlcpy(username, *pp_username, sizeof(username));
110 strlcpy(password, *pp_password, sizeof(password));
112 /* See if there's an authentication with context function provided */
113 auth_with_context_fn = smbc_getFunctionAuthDataWithContext(context);
114 if (auth_with_context_fn)
116 (* auth_with_context_fn)(context,
118 workgroup, sizeof(workgroup),
119 username, sizeof(username),
120 password, sizeof(password));
124 smbc_getFunctionAuthData(context)(server, share,
125 workgroup, sizeof(workgroup),
126 username, sizeof(username),
127 password, sizeof(password));
130 TALLOC_FREE(*pp_workgroup);
131 TALLOC_FREE(*pp_username);
132 TALLOC_FREE(*pp_password);
134 *pp_workgroup = talloc_strdup(ctx, workgroup);
135 *pp_username = talloc_strdup(ctx, username);
136 *pp_password = talloc_strdup(ctx, password);
141 SMBC_get_auth_data(const char *server, const char *share,
142 char *workgroup_buf, int workgroup_buf_len,
143 char *username_buf, int username_buf_len,
144 char *password_buf, int password_buf_len)
146 /* Default function just uses provided data. Nothing to do. */
152 SMBC_find_server(TALLOC_CTX *ctx,
163 if (!pp_workgroup || !pp_username || !pp_password) {
169 srv = smbc_getFunctionGetCachedServer(context)(context,
174 if (!auth_called && !srv && (!*pp_username || !(*pp_username)[0] ||
175 !*pp_password || !(*pp_password)[0])) {
176 SMBC_call_auth_fn(ctx, context, server, share,
177 pp_workgroup, pp_username, pp_password);
180 * However, smbc_auth_fn may have picked up info relating to
181 * an existing connection, so try for an existing connection
185 goto check_server_cache;
190 if (smbc_getFunctionCheckServer(context)(context, srv)) {
192 * This server is no good anymore
193 * Try to remove it and check for more possible
194 * servers in the cache
196 if (smbc_getFunctionRemoveUnusedServer(context)(context,
199 * We could not remove the server completely,
200 * remove it from the cache so we will not get
201 * it again. It will be removed when the last
202 * file/dir is closed.
204 smbc_getFunctionRemoveCachedServer(context)(context,
209 * Maybe there are more cached connections to this
212 goto check_server_cache;
222 * Connect to a server, possibly on an existing connection
224 * Here, what we want to do is: If the server and username
225 * match an existing connection, reuse that, otherwise, establish a
228 * If we have to create a new connection, call the auth_fn to get the
229 * info we need, unless the username and password were passed in.
233 SMBC_server_internal(TALLOC_CTX *ctx,
235 bool connect_if_not_found,
244 char *workgroup = NULL;
246 struct nmb_name called, calling;
247 const char *server_n = server;
248 struct sockaddr_storage ss;
249 int tried_reverse = 0;
252 int is_ipc = (share != NULL && strcmp(share, "IPC$") == 0);
254 const char *username_used;
256 char *newserver, *newshare;
262 if (server[0] == 0) {
267 /* Look for a cached connection */
268 srv = SMBC_find_server(ctx, context, server, share,
269 pp_workgroup, pp_username, pp_password);
272 * If we found a connection and we're only allowed one share per
277 smbc_getOptionOneSharePerServer(context)) {
280 * ... then if there's no current connection to the share,
281 * connect to it. SMBC_find_server(), or rather the function
282 * pointed to by context->get_cached_srv_fn which
283 * was called by SMBC_find_server(), will have issued a tree
284 * disconnect if the requested share is not the same as the
285 * one that was already connected.
289 * Use srv->cli->desthost and srv->cli->share instead of
290 * server and share below to connect to the actual share,
291 * i.e., a normal share or a referred share from
292 * 'msdfs proxy' share.
294 if (srv->cli->cnum == (uint16) -1) {
295 /* Ensure we have accurate auth info */
296 SMBC_call_auth_fn(ctx, context,
303 if (!*pp_workgroup || !*pp_username || !*pp_password) {
305 cli_shutdown(srv->cli);
307 smbc_getFunctionRemoveCachedServer(context)(context,
313 * We don't need to renegotiate encryption
314 * here as the encryption context is not per
318 status = cli_tcon_andx(srv->cli, srv->cli->share, "?????",
320 strlen(*pp_password)+1);
321 if (!NT_STATUS_IS_OK(status)) {
322 errno = map_errno_from_nt_status(status);
323 cli_shutdown(srv->cli);
325 smbc_getFunctionRemoveCachedServer(context)(context,
330 /* Determine if this share supports case sensitivity */
333 ("IPC$ so ignore case sensitivity\n"));
334 } else if (!NT_STATUS_IS_OK(cli_get_fs_attr_info(c, &fs_attrs))) {
335 DEBUG(4, ("Could not retrieve "
336 "case sensitivity flag: %s.\n",
340 * We can't determine the case sensitivity of
341 * the share. We have no choice but to use the
342 * user-specified case sensitivity setting.
344 if (smbc_getOptionCaseSensitive(context)) {
345 cli_set_case_sensitive(c, True);
347 cli_set_case_sensitive(c, False);
351 ("Case sensitive: %s\n",
352 (fs_attrs & FILE_CASE_SENSITIVE_SEARCH
355 cli_set_case_sensitive(
357 (fs_attrs & FILE_CASE_SENSITIVE_SEARCH
363 * Regenerate the dev value since it's based on both
367 srv->dev = (dev_t)(str_checksum(srv->cli->desthost) ^
368 str_checksum(srv->cli->share));
373 /* If we have a connection... */
376 /* ... then we're done here. Give 'em what they came for. */
381 /* If we're not asked to connect when a connection doesn't exist... */
382 if (! connect_if_not_found) {
383 /* ... then we're done here. */
387 if (!*pp_workgroup || !*pp_username || !*pp_password) {
392 make_nmb_name(&calling, smbc_getNetbiosName(context), 0x0);
393 make_nmb_name(&called , server, 0x20);
395 DEBUG(4,("SMBC_server: server_n=[%s] server=[%s]\n", server_n, server));
397 DEBUG(4,(" -> server_n=[%s] server=[%s]\n", server_n, server));
403 /* have to open a new connection */
404 if ((c = cli_initialise()) == NULL) {
409 if (smbc_getOptionUseKerberos(context)) {
410 c->use_kerberos = True;
413 if (smbc_getOptionFallbackAfterKerberos(context)) {
414 c->fallback_after_kerberos = True;
417 if (smbc_getOptionUseCCache(context)) {
418 c->use_ccache = True;
421 c->timeout = smbc_getTimeout(context);
424 * Force use of port 139 for first try if share is $IPC, empty, or
425 * null, so browse lists can work
427 if (share == NULL || *share == '\0' || is_ipc) {
428 port_try_first = 139;
431 port_try_first = 445;
435 c->port = port_try_first;
437 status = cli_connect(c, server_n, &ss);
438 if (!NT_STATUS_IS_OK(status)) {
440 /* First connection attempt failed. Try alternate port. */
441 c->port = port_try_next;
443 status = cli_connect(c, server_n, &ss);
444 if (!NT_STATUS_IS_OK(status)) {
451 if (!cli_session_request(c, &calling, &called)) {
453 if (strcmp(called.name, "*SMBSERVER")) {
454 make_nmb_name(&called , "*SMBSERVER", 0x20);
456 } else { /* Try one more time, but ensure we don't loop */
458 /* Only try this if server is an IP address ... */
460 if (is_ipaddress(server) && !tried_reverse) {
462 struct sockaddr_storage rem_ss;
464 if (!interpret_string_addr(&rem_ss, server,
466 DEBUG(4, ("Could not convert IP address "
467 "%s to struct sockaddr_storage\n",
473 tried_reverse++; /* Yuck */
475 if (name_status_find("*", 0, 0,
476 &rem_ss, remote_name)) {
477 make_nmb_name(&called,
488 DEBUG(4,(" session request ok\n"));
490 status = cli_negprot(c);
492 if (!NT_STATUS_IS_OK(status)) {
498 username_used = *pp_username;
500 if (!NT_STATUS_IS_OK(cli_session_setup(c, username_used,
502 strlen(*pp_password),
504 strlen(*pp_password),
507 /* Failed. Try an anonymous login, if allowed by flags. */
510 if (smbc_getOptionNoAutoAnonymousLogin(context) ||
511 !NT_STATUS_IS_OK(cli_session_setup(c, username_used,
522 status = cli_init_creds(c, username_used,
523 *pp_workgroup, *pp_password);
524 if (!NT_STATUS_IS_OK(status)) {
525 errno = map_errno_from_nt_status(status);
530 DEBUG(4,(" session setup ok\n"));
532 /* here's the fun part....to support 'msdfs proxy' shares
533 (on Samba or windows) we have to issues a TRANS_GET_DFS_REFERRAL
534 here before trying to connect to the original share.
535 cli_check_msdfs_proxy() will fail if it is a normal share. */
537 if ((c->capabilities & CAP_DFS) &&
538 cli_check_msdfs_proxy(ctx, c, share,
539 &newserver, &newshare,
540 /* FIXME: cli_check_msdfs_proxy() does
541 not support smbc_smb_encrypt_level type */
542 context->internal->smb_encryption_level ?
548 srv = SMBC_server_internal(ctx, context, connect_if_not_found,
549 newserver, newshare, pp_workgroup,
550 pp_username, pp_password, in_cache);
551 TALLOC_FREE(newserver);
552 TALLOC_FREE(newshare);
556 /* must be a normal share */
558 status = cli_tcon_andx(c, share, "?????", *pp_password,
559 strlen(*pp_password)+1);
560 if (!NT_STATUS_IS_OK(status)) {
561 errno = map_errno_from_nt_status(status);
566 DEBUG(4,(" tconx ok\n"));
568 /* Determine if this share supports case sensitivity */
570 DEBUG(4, ("IPC$ so ignore case sensitivity\n"));
571 } else if (!NT_STATUS_IS_OK(cli_get_fs_attr_info(c, &fs_attrs))) {
572 DEBUG(4, ("Could not retrieve case sensitivity flag: %s.\n",
576 * We can't determine the case sensitivity of the share. We
577 * have no choice but to use the user-specified case
578 * sensitivity setting.
580 if (smbc_getOptionCaseSensitive(context)) {
581 cli_set_case_sensitive(c, True);
583 cli_set_case_sensitive(c, False);
586 DEBUG(4, ("Case sensitive: %s\n",
587 (fs_attrs & FILE_CASE_SENSITIVE_SEARCH
590 cli_set_case_sensitive(c,
591 (fs_attrs & FILE_CASE_SENSITIVE_SEARCH
596 if (context->internal->smb_encryption_level) {
597 /* Attempt UNIX smb encryption. */
598 if (!NT_STATUS_IS_OK(cli_force_encryption(c,
604 * context->smb_encryption_level == 1
605 * means don't fail if encryption can't be negotiated,
606 * == 2 means fail if encryption can't be negotiated.
609 DEBUG(4,(" SMB encrypt failed\n"));
611 if (context->internal->smb_encryption_level == 2) {
617 DEBUG(4,(" SMB encrypt ok\n"));
621 * Ok, we have got a nice connection
622 * Let's allocate a server structure.
625 srv = SMB_MALLOC_P(SMBCSRV);
634 srv->dev = (dev_t)(str_checksum(server) ^ str_checksum(share));
635 srv->no_pathinfo = False;
636 srv->no_pathinfo2 = False;
637 srv->no_nt_session = False;
640 if (!pp_workgroup || !*pp_workgroup || !**pp_workgroup) {
641 workgroup = talloc_strdup(ctx, smbc_getWorkgroup(context));
643 workgroup = *pp_workgroup;
649 /* set the credentials to make DFS work */
650 smbc_set_credentials_with_fallback(context,
659 SMBC_server(TALLOC_CTX *ctx,
661 bool connect_if_not_found,
669 bool in_cache = false;
671 srv = SMBC_server_internal(ctx, context, connect_if_not_found,
672 server, share, pp_workgroup,
673 pp_username, pp_password, &in_cache);
682 /* Now add it to the cache (internal or external) */
683 /* Let the cache function set errno if it wants to */
685 if (smbc_getFunctionAddCachedServer(context)(context, srv,
689 int saved_errno = errno;
690 DEBUG(3, (" Failed to add server to cache\n"));
699 DEBUG(2, ("Server connect ok: //%s/%s: %p\n",
700 server, share, srv));
702 DLIST_ADD(context->internal->servers, srv);
707 * Connect to a server for getting/setting attributes, possibly on an existing
708 * connection. This works similarly to SMBC_server().
711 SMBC_attr_server(TALLOC_CTX *ctx,
720 struct sockaddr_storage ss;
721 struct cli_state *ipc_cli = NULL;
722 struct rpc_pipe_client *pipe_hnd = NULL;
725 SMBCSRV *ipc_srv=NULL;
728 * Use srv->cli->desthost and srv->cli->share instead of
729 * server and share below to connect to the actual share,
730 * i.e., a normal share or a referred share from
731 * 'msdfs proxy' share.
733 srv = SMBC_server(ctx, context, true, server, share,
734 pp_workgroup, pp_username, pp_password);
738 server = srv->cli->desthost;
739 share = srv->cli->share;
742 * See if we've already created this special connection. Reference
743 * our "special" share name '*IPC$', which is an impossible real share
744 * name due to the leading asterisk.
746 ipc_srv = SMBC_find_server(ctx, context, server, "*IPC$",
747 pp_workgroup, pp_username, pp_password);
750 /* We didn't find a cached connection. Get the password */
751 if (!*pp_password || (*pp_password)[0] == '\0') {
752 /* ... then retrieve it now. */
753 SMBC_call_auth_fn(ctx, context, server, share,
757 if (!*pp_workgroup || !*pp_username || !*pp_password) {
764 if (smbc_getOptionUseKerberos(context)) {
765 flags |= CLI_FULL_CONNECTION_USE_KERBEROS;
767 if (smbc_getOptionUseCCache(context)) {
768 flags |= CLI_FULL_CONNECTION_USE_CCACHE;
772 nt_status = cli_full_connection(&ipc_cli,
773 global_myname(), server,
774 &ss, 0, "IPC$", "?????",
780 if (! NT_STATUS_IS_OK(nt_status)) {
781 DEBUG(1,("cli_full_connection failed! (%s)\n",
782 nt_errstr(nt_status)));
787 if (context->internal->smb_encryption_level) {
788 /* Attempt UNIX smb encryption. */
789 if (!NT_STATUS_IS_OK(cli_force_encryption(ipc_cli,
795 * context->smb_encryption_level ==
796 * 1 means don't fail if encryption can't be
797 * negotiated, == 2 means fail if encryption
798 * can't be negotiated.
801 DEBUG(4,(" SMB encrypt failed on IPC$\n"));
803 if (context->internal->smb_encryption_level == 2) {
804 cli_shutdown(ipc_cli);
809 DEBUG(4,(" SMB encrypt ok on IPC$\n"));
812 ipc_srv = SMB_MALLOC_P(SMBCSRV);
815 cli_shutdown(ipc_cli);
819 ZERO_STRUCTP(ipc_srv);
820 ipc_srv->cli = ipc_cli;
822 nt_status = cli_rpc_pipe_open_noauth(
823 ipc_srv->cli, &ndr_table_lsarpc.syntax_id, &pipe_hnd);
824 if (!NT_STATUS_IS_OK(nt_status)) {
825 DEBUG(1, ("cli_nt_session_open fail!\n"));
827 cli_shutdown(ipc_srv->cli);
833 * Some systems don't support
834 * SEC_FLAG_MAXIMUM_ALLOWED, but NT sends 0x2000000
835 * so we might as well do it too.
838 nt_status = rpccli_lsa_open_policy(
842 GENERIC_EXECUTE_ACCESS,
845 if (!NT_STATUS_IS_OK(nt_status)) {
846 errno = SMBC_errno(context, ipc_srv->cli);
847 cli_shutdown(ipc_srv->cli);
851 /* now add it to the cache (internal or external) */
853 errno = 0; /* let cache function set errno if it likes */
854 if (smbc_getFunctionAddCachedServer(context)(context, ipc_srv,
859 DEBUG(3, (" Failed to add server to cache\n"));
863 cli_shutdown(ipc_srv->cli);
868 DLIST_ADD(context->internal->servers, ipc_srv);