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 "libsmb/libsmb.h"
28 #include "libsmbclient.h"
29 #include "libsmb_internal.h"
30 #include "../librpc/gen_ndr/ndr_lsa.h"
31 #include "rpc_client/cli_pipe.h"
32 #include "rpc_client/cli_lsarpc.h"
33 #include "libcli/security/security.h"
34 #include "libsmb/nmblib.h"
37 * Check a server for being alive and well.
38 * returns 0 if the server is in shape. Returns 1 on error
40 * Also useable outside libsmbclient to enable external cache
41 * to do some checks too.
44 SMBC_check_server(SMBCCTX * context,
47 if (!cli_state_is_connected(server->cli)) {
55 * Remove a server from the cached server list it's unused.
56 * On success, 0 is returned. 1 is returned if the server could not be removed.
58 * Also useable outside libsmbclient
61 SMBC_remove_unused_server(SMBCCTX * context,
66 /* are we being fooled ? */
67 if (!context || !context->internal->initialized || !srv) {
71 /* Check all open files/directories for a relation with this server */
72 for (file = context->internal->files; file; file = file->next) {
73 if (file->srv == srv) {
75 DEBUG(3, ("smbc_remove_usused_server: "
76 "%p still used by %p.\n",
82 DLIST_REMOVE(context->internal->servers, srv);
84 cli_shutdown(srv->cli);
87 DEBUG(3, ("smbc_remove_usused_server: %p removed.\n", srv));
89 smbc_getFunctionRemoveCachedServer(context)(context, srv);
95 /****************************************************************
96 * Call the auth_fn with fixed size (fstring) buffers.
97 ***************************************************************/
99 SMBC_call_auth_fn(TALLOC_CTX *ctx,
110 smbc_get_auth_data_with_context_fn auth_with_context_fn;
112 strlcpy(workgroup, *pp_workgroup, sizeof(workgroup));
113 strlcpy(username, *pp_username, sizeof(username));
114 strlcpy(password, *pp_password, sizeof(password));
116 /* See if there's an authentication with context function provided */
117 auth_with_context_fn = smbc_getFunctionAuthDataWithContext(context);
118 if (auth_with_context_fn)
120 (* auth_with_context_fn)(context,
122 workgroup, sizeof(workgroup),
123 username, sizeof(username),
124 password, sizeof(password));
128 smbc_getFunctionAuthData(context)(server, share,
129 workgroup, sizeof(workgroup),
130 username, sizeof(username),
131 password, sizeof(password));
134 TALLOC_FREE(*pp_workgroup);
135 TALLOC_FREE(*pp_username);
136 TALLOC_FREE(*pp_password);
138 *pp_workgroup = talloc_strdup(ctx, workgroup);
139 *pp_username = talloc_strdup(ctx, username);
140 *pp_password = talloc_strdup(ctx, password);
145 SMBC_get_auth_data(const char *server, const char *share,
146 char *workgroup_buf, int workgroup_buf_len,
147 char *username_buf, int username_buf_len,
148 char *password_buf, int password_buf_len)
150 /* Default function just uses provided data. Nothing to do. */
156 SMBC_find_server(TALLOC_CTX *ctx,
167 if (!pp_workgroup || !pp_username || !pp_password) {
173 srv = smbc_getFunctionGetCachedServer(context)(context,
178 if (!auth_called && !srv && (!*pp_username || !(*pp_username)[0] ||
179 !*pp_password || !(*pp_password)[0])) {
180 SMBC_call_auth_fn(ctx, context, server, share,
181 pp_workgroup, pp_username, pp_password);
184 * However, smbc_auth_fn may have picked up info relating to
185 * an existing connection, so try for an existing connection
189 goto check_server_cache;
194 if (smbc_getFunctionCheckServer(context)(context, srv)) {
196 * This server is no good anymore
197 * Try to remove it and check for more possible
198 * servers in the cache
200 if (smbc_getFunctionRemoveUnusedServer(context)(context,
203 * We could not remove the server completely,
204 * remove it from the cache so we will not get
205 * it again. It will be removed when the last
206 * file/dir is closed.
208 smbc_getFunctionRemoveCachedServer(context)(context,
213 * Maybe there are more cached connections to this
216 goto check_server_cache;
226 * Connect to a server, possibly on an existing connection
228 * Here, what we want to do is: If the server and username
229 * match an existing connection, reuse that, otherwise, establish a
232 * If we have to create a new connection, call the auth_fn to get the
233 * info we need, unless the username and password were passed in.
237 SMBC_server_internal(TALLOC_CTX *ctx,
239 bool connect_if_not_found,
248 char *workgroup = NULL;
249 struct cli_state *c = NULL;
250 const char *server_n = server;
251 int is_ipc = (share != NULL && strcmp(share, "IPC$") == 0);
253 const char *username_used;
255 char *newserver, *newshare;
261 if (server[0] == 0) {
266 /* Look for a cached connection */
267 srv = SMBC_find_server(ctx, context, server, share,
268 pp_workgroup, pp_username, pp_password);
271 * If we found a connection and we're only allowed one share per
276 smbc_getOptionOneSharePerServer(context)) {
279 * ... then if there's no current connection to the share,
280 * connect to it. SMBC_find_server(), or rather the function
281 * pointed to by context->get_cached_srv_fn which
282 * was called by SMBC_find_server(), will have issued a tree
283 * disconnect if the requested share is not the same as the
284 * one that was already connected.
288 * Use srv->cli->desthost and srv->cli->share instead of
289 * server and share below to connect to the actual share,
290 * i.e., a normal share or a referred share from
291 * 'msdfs proxy' share.
293 if (!cli_state_has_tcon(srv->cli)) {
294 /* Ensure we have accurate auth info */
295 SMBC_call_auth_fn(ctx, context,
296 cli_state_remote_name(srv->cli),
302 if (!*pp_workgroup || !*pp_username || !*pp_password) {
304 cli_shutdown(srv->cli);
306 smbc_getFunctionRemoveCachedServer(context)(context,
312 * We don't need to renegotiate encryption
313 * here as the encryption context is not per
317 status = cli_tree_connect(srv->cli,
321 strlen(*pp_password)+1);
322 if (!NT_STATUS_IS_OK(status)) {
323 errno = map_errno_from_nt_status(status);
324 cli_shutdown(srv->cli);
326 smbc_getFunctionRemoveCachedServer(context)(context,
331 /* Determine if this share supports case sensitivity */
334 ("IPC$ so ignore case sensitivity\n"));
335 status = NT_STATUS_OK;
337 status = cli_get_fs_attr_info(c, &fs_attrs);
340 if (!NT_STATUS_IS_OK(status)) {
341 DEBUG(4, ("Could not retrieve "
342 "case sensitivity flag: %s.\n",
346 * We can't determine the case sensitivity of
347 * the share. We have no choice but to use the
348 * user-specified case sensitivity setting.
350 if (smbc_getOptionCaseSensitive(context)) {
351 cli_set_case_sensitive(c, True);
353 cli_set_case_sensitive(c, False);
355 } else if (!is_ipc) {
357 ("Case sensitive: %s\n",
358 (fs_attrs & FILE_CASE_SENSITIVE_SEARCH
361 cli_set_case_sensitive(
363 (fs_attrs & FILE_CASE_SENSITIVE_SEARCH
369 * Regenerate the dev value since it's based on both
373 const char *remote_name =
374 cli_state_remote_name(srv->cli);
376 srv->dev = (dev_t)(str_checksum(remote_name) ^
377 str_checksum(srv->cli->share));
382 /* If we have a connection... */
385 /* ... then we're done here. Give 'em what they came for. */
390 /* If we're not asked to connect when a connection doesn't exist... */
391 if (! connect_if_not_found) {
392 /* ... then we're done here. */
396 if (!*pp_workgroup || !*pp_username || !*pp_password) {
401 DEBUG(4,("SMBC_server: server_n=[%s] server=[%s]\n", server_n, server));
403 DEBUG(4,(" -> server_n=[%s] server=[%s]\n", server_n, server));
405 status = NT_STATUS_UNSUCCESSFUL;
407 if (smbc_getOptionUseKerberos(context)) {
408 flags |= CLI_FULL_CONNECTION_USE_KERBEROS;
411 if (smbc_getOptionFallbackAfterKerberos(context)) {
412 flags |= CLI_FULL_CONNECTION_FALLBACK_AFTER_KERBEROS;
415 if (smbc_getOptionUseCCache(context)) {
416 flags |= CLI_FULL_CONNECTION_USE_CCACHE;
419 if (share == NULL || *share == '\0' || is_ipc) {
421 * Try 139 first for IPC$
423 status = cli_connect_nb(server_n, NULL, 139, 0x20,
424 smbc_getNetbiosName(context),
425 SMB_SIGNING_DEFAULT, flags, &c);
428 if (!NT_STATUS_IS_OK(status)) {
430 * No IPC$ or 139 did not work
432 status = cli_connect_nb(server_n, NULL, 0, 0x20,
433 smbc_getNetbiosName(context),
434 SMB_SIGNING_DEFAULT, flags, &c);
437 if (!NT_STATUS_IS_OK(status)) {
438 errno = map_errno_from_nt_status(status);
442 cli_set_timeout(c, smbc_getTimeout(context));
444 status = cli_negprot(c, PROTOCOL_NT1);
446 if (!NT_STATUS_IS_OK(status)) {
452 username_used = *pp_username;
454 if (!NT_STATUS_IS_OK(cli_session_setup(c, username_used,
456 strlen(*pp_password),
458 strlen(*pp_password),
461 /* Failed. Try an anonymous login, if allowed by flags. */
464 if (smbc_getOptionNoAutoAnonymousLogin(context) ||
465 !NT_STATUS_IS_OK(cli_session_setup(c, username_used,
476 status = cli_init_creds(c, username_used,
477 *pp_workgroup, *pp_password);
478 if (!NT_STATUS_IS_OK(status)) {
479 errno = map_errno_from_nt_status(status);
484 DEBUG(4,(" session setup ok\n"));
486 /* here's the fun part....to support 'msdfs proxy' shares
487 (on Samba or windows) we have to issues a TRANS_GET_DFS_REFERRAL
488 here before trying to connect to the original share.
489 cli_check_msdfs_proxy() will fail if it is a normal share. */
491 if ((cli_state_capabilities(c) & CAP_DFS) &&
492 cli_check_msdfs_proxy(ctx, c, share,
493 &newserver, &newshare,
494 /* FIXME: cli_check_msdfs_proxy() does
495 not support smbc_smb_encrypt_level type */
496 context->internal->smb_encryption_level ?
502 srv = SMBC_server_internal(ctx, context, connect_if_not_found,
503 newserver, newshare, pp_workgroup,
504 pp_username, pp_password, in_cache);
505 TALLOC_FREE(newserver);
506 TALLOC_FREE(newshare);
510 /* must be a normal share */
512 status = cli_tree_connect(c, share, "?????", *pp_password,
513 strlen(*pp_password)+1);
514 if (!NT_STATUS_IS_OK(status)) {
515 errno = map_errno_from_nt_status(status);
520 DEBUG(4,(" tconx ok\n"));
522 /* Determine if this share supports case sensitivity */
524 DEBUG(4, ("IPC$ so ignore case sensitivity\n"));
525 status = NT_STATUS_OK;
527 status = cli_get_fs_attr_info(c, &fs_attrs);
530 if (!NT_STATUS_IS_OK(status)) {
531 DEBUG(4, ("Could not retrieve case sensitivity flag: %s.\n",
535 * We can't determine the case sensitivity of the share. We
536 * have no choice but to use the user-specified case
537 * sensitivity setting.
539 if (smbc_getOptionCaseSensitive(context)) {
540 cli_set_case_sensitive(c, True);
542 cli_set_case_sensitive(c, False);
544 } else if (!is_ipc) {
545 DEBUG(4, ("Case sensitive: %s\n",
546 (fs_attrs & FILE_CASE_SENSITIVE_SEARCH
549 cli_set_case_sensitive(c,
550 (fs_attrs & FILE_CASE_SENSITIVE_SEARCH
555 if (context->internal->smb_encryption_level) {
556 /* Attempt UNIX smb encryption. */
557 if (!NT_STATUS_IS_OK(cli_force_encryption(c,
563 * context->smb_encryption_level == 1
564 * means don't fail if encryption can't be negotiated,
565 * == 2 means fail if encryption can't be negotiated.
568 DEBUG(4,(" SMB encrypt failed\n"));
570 if (context->internal->smb_encryption_level == 2) {
576 DEBUG(4,(" SMB encrypt ok\n"));
580 * Ok, we have got a nice connection
581 * Let's allocate a server structure.
584 srv = SMB_MALLOC_P(SMBCSRV);
593 srv->dev = (dev_t)(str_checksum(server) ^ str_checksum(share));
594 srv->no_pathinfo = False;
595 srv->no_pathinfo2 = False;
596 srv->no_nt_session = False;
599 if (!pp_workgroup || !*pp_workgroup || !**pp_workgroup) {
600 workgroup = talloc_strdup(ctx, smbc_getWorkgroup(context));
602 workgroup = *pp_workgroup;
612 /* set the credentials to make DFS work */
613 smbc_set_credentials_with_fallback(context,
622 SMBC_server(TALLOC_CTX *ctx,
624 bool connect_if_not_found,
632 bool in_cache = false;
634 srv = SMBC_server_internal(ctx, context, connect_if_not_found,
635 server, share, pp_workgroup,
636 pp_username, pp_password, &in_cache);
645 /* Now add it to the cache (internal or external) */
646 /* Let the cache function set errno if it wants to */
648 if (smbc_getFunctionAddCachedServer(context)(context, srv,
652 int saved_errno = errno;
653 DEBUG(3, (" Failed to add server to cache\n"));
662 DEBUG(2, ("Server connect ok: //%s/%s: %p\n",
663 server, share, srv));
665 DLIST_ADD(context->internal->servers, srv);
670 * Connect to a server for getting/setting attributes, possibly on an existing
671 * connection. This works similarly to SMBC_server().
674 SMBC_attr_server(TALLOC_CTX *ctx,
683 struct cli_state *ipc_cli = NULL;
684 struct rpc_pipe_client *pipe_hnd = NULL;
687 SMBCSRV *ipc_srv=NULL;
690 * Use srv->cli->desthost and srv->cli->share instead of
691 * server and share below to connect to the actual share,
692 * i.e., a normal share or a referred share from
693 * 'msdfs proxy' share.
695 srv = SMBC_server(ctx, context, true, server, share,
696 pp_workgroup, pp_username, pp_password);
700 server = cli_state_remote_name(srv->cli);
701 share = srv->cli->share;
704 * See if we've already created this special connection. Reference
705 * our "special" share name '*IPC$', which is an impossible real share
706 * name due to the leading asterisk.
708 ipc_srv = SMBC_find_server(ctx, context, server, "*IPC$",
709 pp_workgroup, pp_username, pp_password);
712 /* We didn't find a cached connection. Get the password */
713 if (!*pp_password || (*pp_password)[0] == '\0') {
714 /* ... then retrieve it now. */
715 SMBC_call_auth_fn(ctx, context, server, share,
719 if (!*pp_workgroup || !*pp_username || !*pp_password) {
726 if (smbc_getOptionUseKerberos(context)) {
727 flags |= CLI_FULL_CONNECTION_USE_KERBEROS;
729 if (smbc_getOptionUseCCache(context)) {
730 flags |= CLI_FULL_CONNECTION_USE_CCACHE;
733 nt_status = cli_full_connection(&ipc_cli,
734 lp_netbios_name(), server,
735 NULL, 0, "IPC$", "?????",
740 SMB_SIGNING_DEFAULT);
741 if (! NT_STATUS_IS_OK(nt_status)) {
742 DEBUG(1,("cli_full_connection failed! (%s)\n",
743 nt_errstr(nt_status)));
748 if (context->internal->smb_encryption_level) {
749 /* Attempt UNIX smb encryption. */
750 if (!NT_STATUS_IS_OK(cli_force_encryption(ipc_cli,
756 * context->smb_encryption_level ==
757 * 1 means don't fail if encryption can't be
758 * negotiated, == 2 means fail if encryption
759 * can't be negotiated.
762 DEBUG(4,(" SMB encrypt failed on IPC$\n"));
764 if (context->internal->smb_encryption_level == 2) {
765 cli_shutdown(ipc_cli);
770 DEBUG(4,(" SMB encrypt ok on IPC$\n"));
773 ipc_srv = SMB_MALLOC_P(SMBCSRV);
776 cli_shutdown(ipc_cli);
780 ZERO_STRUCTP(ipc_srv);
781 ipc_srv->cli = ipc_cli;
783 nt_status = cli_rpc_pipe_open_noauth(
784 ipc_srv->cli, &ndr_table_lsarpc.syntax_id, &pipe_hnd);
785 if (!NT_STATUS_IS_OK(nt_status)) {
786 DEBUG(1, ("cli_nt_session_open fail!\n"));
788 cli_shutdown(ipc_srv->cli);
794 * Some systems don't support
795 * SEC_FLAG_MAXIMUM_ALLOWED, but NT sends 0x2000000
796 * so we might as well do it too.
799 nt_status = rpccli_lsa_open_policy(
803 GENERIC_EXECUTE_ACCESS,
806 if (!NT_STATUS_IS_OK(nt_status)) {
807 errno = SMBC_errno(context, ipc_srv->cli);
808 cli_shutdown(ipc_srv->cli);
812 /* now add it to the cache (internal or external) */
814 errno = 0; /* let cache function set errno if it likes */
815 if (smbc_getFunctionAddCachedServer(context)(context, ipc_srv,
820 DEBUG(3, (" Failed to add server to cache\n"));
824 cli_shutdown(ipc_srv->cli);
829 DLIST_ADD(context->internal->servers, ipc_srv);