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_pipe.h"
31 #include "rpc_client/cli_lsarpc.h"
32 #include "libcli/security/security.h"
35 * Check a server for being alive and well.
36 * returns 0 if the server is in shape. Returns 1 on error
38 * Also useable outside libsmbclient to enable external cache
39 * to do some checks too.
42 SMBC_check_server(SMBCCTX * context,
49 return (getpeername(server->cli->fd, &addr, &size) == -1);
53 * Remove a server from the cached server list it's unused.
54 * On success, 0 is returned. 1 is returned if the server could not be removed.
56 * Also useable outside libsmbclient
59 SMBC_remove_unused_server(SMBCCTX * context,
64 /* are we being fooled ? */
65 if (!context || !context->internal->initialized || !srv) {
69 /* Check all open files/directories for a relation with this server */
70 for (file = context->internal->files; file; file = file->next) {
71 if (file->srv == srv) {
73 DEBUG(3, ("smbc_remove_usused_server: "
74 "%p still used by %p.\n",
80 DLIST_REMOVE(context->internal->servers, srv);
82 cli_shutdown(srv->cli);
85 DEBUG(3, ("smbc_remove_usused_server: %p removed.\n", srv));
87 smbc_getFunctionRemoveCachedServer(context)(context, srv);
93 /****************************************************************
94 * Call the auth_fn with fixed size (fstring) buffers.
95 ***************************************************************/
97 SMBC_call_auth_fn(TALLOC_CTX *ctx,
108 smbc_get_auth_data_with_context_fn auth_with_context_fn;
110 strlcpy(workgroup, *pp_workgroup, sizeof(workgroup));
111 strlcpy(username, *pp_username, sizeof(username));
112 strlcpy(password, *pp_password, sizeof(password));
114 /* See if there's an authentication with context function provided */
115 auth_with_context_fn = smbc_getFunctionAuthDataWithContext(context);
116 if (auth_with_context_fn)
118 (* auth_with_context_fn)(context,
120 workgroup, sizeof(workgroup),
121 username, sizeof(username),
122 password, sizeof(password));
126 smbc_getFunctionAuthData(context)(server, share,
127 workgroup, sizeof(workgroup),
128 username, sizeof(username),
129 password, sizeof(password));
132 TALLOC_FREE(*pp_workgroup);
133 TALLOC_FREE(*pp_username);
134 TALLOC_FREE(*pp_password);
136 *pp_workgroup = talloc_strdup(ctx, workgroup);
137 *pp_username = talloc_strdup(ctx, username);
138 *pp_password = talloc_strdup(ctx, password);
143 SMBC_get_auth_data(const char *server, const char *share,
144 char *workgroup_buf, int workgroup_buf_len,
145 char *username_buf, int username_buf_len,
146 char *password_buf, int password_buf_len)
148 /* Default function just uses provided data. Nothing to do. */
154 SMBC_find_server(TALLOC_CTX *ctx,
165 if (!pp_workgroup || !pp_username || !pp_password) {
171 srv = smbc_getFunctionGetCachedServer(context)(context,
176 if (!auth_called && !srv && (!*pp_username || !(*pp_username)[0] ||
177 !*pp_password || !(*pp_password)[0])) {
178 SMBC_call_auth_fn(ctx, context, server, share,
179 pp_workgroup, pp_username, pp_password);
182 * However, smbc_auth_fn may have picked up info relating to
183 * an existing connection, so try for an existing connection
187 goto check_server_cache;
192 if (smbc_getFunctionCheckServer(context)(context, srv)) {
194 * This server is no good anymore
195 * Try to remove it and check for more possible
196 * servers in the cache
198 if (smbc_getFunctionRemoveUnusedServer(context)(context,
201 * We could not remove the server completely,
202 * remove it from the cache so we will not get
203 * it again. It will be removed when the last
204 * file/dir is closed.
206 smbc_getFunctionRemoveCachedServer(context)(context,
211 * Maybe there are more cached connections to this
214 goto check_server_cache;
224 * Connect to a server, possibly on an existing connection
226 * Here, what we want to do is: If the server and username
227 * match an existing connection, reuse that, otherwise, establish a
230 * If we have to create a new connection, call the auth_fn to get the
231 * info we need, unless the username and password were passed in.
235 SMBC_server_internal(TALLOC_CTX *ctx,
237 bool connect_if_not_found,
246 char *workgroup = NULL;
248 struct nmb_name called, calling;
249 const char *server_n = server;
250 struct sockaddr_storage ss;
251 int tried_reverse = 0;
254 int is_ipc = (share != NULL && strcmp(share, "IPC$") == 0);
256 const char *username_used;
258 char *newserver, *newshare;
264 if (server[0] == 0) {
269 /* Look for a cached connection */
270 srv = SMBC_find_server(ctx, context, server, share,
271 pp_workgroup, pp_username, pp_password);
274 * If we found a connection and we're only allowed one share per
279 smbc_getOptionOneSharePerServer(context)) {
282 * ... then if there's no current connection to the share,
283 * connect to it. SMBC_find_server(), or rather the function
284 * pointed to by context->get_cached_srv_fn which
285 * was called by SMBC_find_server(), will have issued a tree
286 * disconnect if the requested share is not the same as the
287 * one that was already connected.
291 * Use srv->cli->desthost and srv->cli->share instead of
292 * server and share below to connect to the actual share,
293 * i.e., a normal share or a referred share from
294 * 'msdfs proxy' share.
296 if (srv->cli->cnum == (uint16) -1) {
297 /* Ensure we have accurate auth info */
298 SMBC_call_auth_fn(ctx, context,
305 if (!*pp_workgroup || !*pp_username || !*pp_password) {
307 cli_shutdown(srv->cli);
309 smbc_getFunctionRemoveCachedServer(context)(context,
315 * We don't need to renegotiate encryption
316 * here as the encryption context is not per
320 status = cli_tcon_andx(srv->cli, srv->cli->share, "?????",
322 strlen(*pp_password)+1);
323 if (!NT_STATUS_IS_OK(status)) {
324 errno = map_errno_from_nt_status(status);
325 cli_shutdown(srv->cli);
327 smbc_getFunctionRemoveCachedServer(context)(context,
332 /* Determine if this share supports case sensitivity */
335 ("IPC$ so ignore case sensitivity\n"));
336 } else if (!NT_STATUS_IS_OK(cli_get_fs_attr_info(c, &fs_attrs))) {
337 DEBUG(4, ("Could not retrieve "
338 "case sensitivity flag: %s.\n",
342 * We can't determine the case sensitivity of
343 * the share. We have no choice but to use the
344 * user-specified case sensitivity setting.
346 if (smbc_getOptionCaseSensitive(context)) {
347 cli_set_case_sensitive(c, True);
349 cli_set_case_sensitive(c, False);
353 ("Case sensitive: %s\n",
354 (fs_attrs & FILE_CASE_SENSITIVE_SEARCH
357 cli_set_case_sensitive(
359 (fs_attrs & FILE_CASE_SENSITIVE_SEARCH
365 * Regenerate the dev value since it's based on both
369 srv->dev = (dev_t)(str_checksum(srv->cli->desthost) ^
370 str_checksum(srv->cli->share));
375 /* If we have a connection... */
378 /* ... then we're done here. Give 'em what they came for. */
383 /* If we're not asked to connect when a connection doesn't exist... */
384 if (! connect_if_not_found) {
385 /* ... then we're done here. */
389 if (!*pp_workgroup || !*pp_username || !*pp_password) {
394 make_nmb_name(&calling, smbc_getNetbiosName(context), 0x0);
395 make_nmb_name(&called , server, 0x20);
397 DEBUG(4,("SMBC_server: server_n=[%s] server=[%s]\n", server_n, server));
399 DEBUG(4,(" -> server_n=[%s] server=[%s]\n", server_n, server));
405 /* have to open a new connection */
406 if ((c = cli_initialise()) == NULL) {
411 if (smbc_getOptionUseKerberos(context)) {
412 c->use_kerberos = True;
415 if (smbc_getOptionFallbackAfterKerberos(context)) {
416 c->fallback_after_kerberos = True;
419 if (smbc_getOptionUseCCache(context)) {
420 c->use_ccache = True;
423 c->timeout = smbc_getTimeout(context);
426 * Force use of port 139 for first try if share is $IPC, empty, or
427 * null, so browse lists can work
429 if (share == NULL || *share == '\0' || is_ipc) {
430 port_try_first = 139;
433 port_try_first = 445;
437 c->port = port_try_first;
439 status = cli_connect(c, server_n, &ss);
440 if (!NT_STATUS_IS_OK(status)) {
442 /* First connection attempt failed. Try alternate port. */
443 c->port = port_try_next;
445 status = cli_connect(c, server_n, &ss);
446 if (!NT_STATUS_IS_OK(status)) {
453 if (!cli_session_request(c, &calling, &called)) {
455 if (strcmp(called.name, "*SMBSERVER")) {
456 make_nmb_name(&called , "*SMBSERVER", 0x20);
458 } else { /* Try one more time, but ensure we don't loop */
460 /* Only try this if server is an IP address ... */
462 if (is_ipaddress(server) && !tried_reverse) {
464 struct sockaddr_storage rem_ss;
466 if (!interpret_string_addr(&rem_ss, server,
468 DEBUG(4, ("Could not convert IP address "
469 "%s to struct sockaddr_storage\n",
475 tried_reverse++; /* Yuck */
477 if (name_status_find("*", 0, 0,
478 &rem_ss, remote_name)) {
479 make_nmb_name(&called,
490 DEBUG(4,(" session request ok\n"));
492 status = cli_negprot(c);
494 if (!NT_STATUS_IS_OK(status)) {
500 username_used = *pp_username;
502 if (!NT_STATUS_IS_OK(cli_session_setup(c, username_used,
504 strlen(*pp_password),
506 strlen(*pp_password),
509 /* Failed. Try an anonymous login, if allowed by flags. */
512 if (smbc_getOptionNoAutoAnonymousLogin(context) ||
513 !NT_STATUS_IS_OK(cli_session_setup(c, username_used,
524 status = cli_init_creds(c, username_used,
525 *pp_workgroup, *pp_password);
526 if (!NT_STATUS_IS_OK(status)) {
527 errno = map_errno_from_nt_status(status);
532 DEBUG(4,(" session setup ok\n"));
534 /* here's the fun part....to support 'msdfs proxy' shares
535 (on Samba or windows) we have to issues a TRANS_GET_DFS_REFERRAL
536 here before trying to connect to the original share.
537 cli_check_msdfs_proxy() will fail if it is a normal share. */
539 if ((c->capabilities & CAP_DFS) &&
540 cli_check_msdfs_proxy(ctx, c, share,
541 &newserver, &newshare,
542 /* FIXME: cli_check_msdfs_proxy() does
543 not support smbc_smb_encrypt_level type */
544 context->internal->smb_encryption_level ?
550 srv = SMBC_server_internal(ctx, context, connect_if_not_found,
551 newserver, newshare, pp_workgroup,
552 pp_username, pp_password, in_cache);
553 TALLOC_FREE(newserver);
554 TALLOC_FREE(newshare);
558 /* must be a normal share */
560 status = cli_tcon_andx(c, share, "?????", *pp_password,
561 strlen(*pp_password)+1);
562 if (!NT_STATUS_IS_OK(status)) {
563 errno = map_errno_from_nt_status(status);
568 DEBUG(4,(" tconx ok\n"));
570 /* Determine if this share supports case sensitivity */
572 DEBUG(4, ("IPC$ so ignore case sensitivity\n"));
573 } else if (!NT_STATUS_IS_OK(cli_get_fs_attr_info(c, &fs_attrs))) {
574 DEBUG(4, ("Could not retrieve case sensitivity flag: %s.\n",
578 * We can't determine the case sensitivity of the share. We
579 * have no choice but to use the user-specified case
580 * sensitivity setting.
582 if (smbc_getOptionCaseSensitive(context)) {
583 cli_set_case_sensitive(c, True);
585 cli_set_case_sensitive(c, False);
588 DEBUG(4, ("Case sensitive: %s\n",
589 (fs_attrs & FILE_CASE_SENSITIVE_SEARCH
592 cli_set_case_sensitive(c,
593 (fs_attrs & FILE_CASE_SENSITIVE_SEARCH
598 if (context->internal->smb_encryption_level) {
599 /* Attempt UNIX smb encryption. */
600 if (!NT_STATUS_IS_OK(cli_force_encryption(c,
606 * context->smb_encryption_level == 1
607 * means don't fail if encryption can't be negotiated,
608 * == 2 means fail if encryption can't be negotiated.
611 DEBUG(4,(" SMB encrypt failed\n"));
613 if (context->internal->smb_encryption_level == 2) {
619 DEBUG(4,(" SMB encrypt ok\n"));
623 * Ok, we have got a nice connection
624 * Let's allocate a server structure.
627 srv = SMB_MALLOC_P(SMBCSRV);
636 srv->dev = (dev_t)(str_checksum(server) ^ str_checksum(share));
637 srv->no_pathinfo = False;
638 srv->no_pathinfo2 = False;
639 srv->no_nt_session = False;
642 if (!pp_workgroup || !*pp_workgroup || !**pp_workgroup) {
643 workgroup = talloc_strdup(ctx, smbc_getWorkgroup(context));
645 workgroup = *pp_workgroup;
651 /* set the credentials to make DFS work */
652 smbc_set_credentials_with_fallback(context,
661 SMBC_server(TALLOC_CTX *ctx,
663 bool connect_if_not_found,
671 bool in_cache = false;
673 srv = SMBC_server_internal(ctx, context, connect_if_not_found,
674 server, share, pp_workgroup,
675 pp_username, pp_password, &in_cache);
684 /* Now add it to the cache (internal or external) */
685 /* Let the cache function set errno if it wants to */
687 if (smbc_getFunctionAddCachedServer(context)(context, srv,
691 int saved_errno = errno;
692 DEBUG(3, (" Failed to add server to cache\n"));
701 DEBUG(2, ("Server connect ok: //%s/%s: %p\n",
702 server, share, srv));
704 DLIST_ADD(context->internal->servers, srv);
709 * Connect to a server for getting/setting attributes, possibly on an existing
710 * connection. This works similarly to SMBC_server().
713 SMBC_attr_server(TALLOC_CTX *ctx,
722 struct sockaddr_storage ss;
723 struct cli_state *ipc_cli = NULL;
724 struct rpc_pipe_client *pipe_hnd = NULL;
727 SMBCSRV *ipc_srv=NULL;
730 * Use srv->cli->desthost and srv->cli->share instead of
731 * server and share below to connect to the actual share,
732 * i.e., a normal share or a referred share from
733 * 'msdfs proxy' share.
735 srv = SMBC_server(ctx, context, true, server, share,
736 pp_workgroup, pp_username, pp_password);
740 server = srv->cli->desthost;
741 share = srv->cli->share;
744 * See if we've already created this special connection. Reference
745 * our "special" share name '*IPC$', which is an impossible real share
746 * name due to the leading asterisk.
748 ipc_srv = SMBC_find_server(ctx, context, server, "*IPC$",
749 pp_workgroup, pp_username, pp_password);
752 /* We didn't find a cached connection. Get the password */
753 if (!*pp_password || (*pp_password)[0] == '\0') {
754 /* ... then retrieve it now. */
755 SMBC_call_auth_fn(ctx, context, server, share,
759 if (!*pp_workgroup || !*pp_username || !*pp_password) {
766 if (smbc_getOptionUseKerberos(context)) {
767 flags |= CLI_FULL_CONNECTION_USE_KERBEROS;
769 if (smbc_getOptionUseCCache(context)) {
770 flags |= CLI_FULL_CONNECTION_USE_CCACHE;
774 nt_status = cli_full_connection(&ipc_cli,
775 global_myname(), server,
776 &ss, 0, "IPC$", "?????",
782 if (! NT_STATUS_IS_OK(nt_status)) {
783 DEBUG(1,("cli_full_connection failed! (%s)\n",
784 nt_errstr(nt_status)));
789 if (context->internal->smb_encryption_level) {
790 /* Attempt UNIX smb encryption. */
791 if (!NT_STATUS_IS_OK(cli_force_encryption(ipc_cli,
797 * context->smb_encryption_level ==
798 * 1 means don't fail if encryption can't be
799 * negotiated, == 2 means fail if encryption
800 * can't be negotiated.
803 DEBUG(4,(" SMB encrypt failed on IPC$\n"));
805 if (context->internal->smb_encryption_level == 2) {
806 cli_shutdown(ipc_cli);
811 DEBUG(4,(" SMB encrypt ok on IPC$\n"));
814 ipc_srv = SMB_MALLOC_P(SMBCSRV);
817 cli_shutdown(ipc_cli);
821 ZERO_STRUCTP(ipc_srv);
822 ipc_srv->cli = ipc_cli;
824 nt_status = cli_rpc_pipe_open_noauth(
825 ipc_srv->cli, &ndr_table_lsarpc.syntax_id, &pipe_hnd);
826 if (!NT_STATUS_IS_OK(nt_status)) {
827 DEBUG(1, ("cli_nt_session_open fail!\n"));
829 cli_shutdown(ipc_srv->cli);
835 * Some systems don't support
836 * SEC_FLAG_MAXIMUM_ALLOWED, but NT sends 0x2000000
837 * so we might as well do it too.
840 nt_status = rpccli_lsa_open_policy(
844 GENERIC_EXECUTE_ACCESS,
847 if (!NT_STATUS_IS_OK(nt_status)) {
848 errno = SMBC_errno(context, ipc_srv->cli);
849 cli_shutdown(ipc_srv->cli);
853 /* now add it to the cache (internal or external) */
855 errno = 0; /* let cache function set errno if it likes */
856 if (smbc_getFunctionAddCachedServer(context)(context, ipc_srv,
861 DEBUG(3, (" Failed to add server to cache\n"));
865 cli_shutdown(ipc_srv->cli);
870 DLIST_ADD(context->internal->servers, ipc_srv);