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"
35 #include "../libcli/smb/smbXcli_base.h"
38 * Check a server for being alive and well.
39 * returns 0 if the server is in shape. Returns 1 on error
41 * Also usable outside libsmbclient to enable external cache
42 * to do some checks too.
45 SMBC_check_server(SMBCCTX
* context
,
50 if (!cli_state_is_connected(server
->cli
)) {
54 now
= time_mono(NULL
);
56 if (server
->last_echo_time
== (time_t)0 ||
57 now
> server
->last_echo_time
+
58 (server
->cli
->timeout
/1000)) {
59 unsigned char data
[16] = {0};
60 NTSTATUS status
= cli_echo(server
->cli
,
62 data_blob_const(data
, sizeof(data
)));
63 if (!NT_STATUS_IS_OK(status
)) {
66 * Some SMB2 servers (not Samba or Windows)
67 * check the session status on SMB2_ECHO and return
68 * NT_STATUS_USER_SESSION_DELETED
69 * if the session was not set. That's OK, they still
71 * BUG: https://bugzilla.samba.org/show_bug.cgi?id=13218
73 if (smbXcli_conn_protocol(server
->cli
->conn
) >=
75 if (NT_STATUS_EQUAL(status
,
76 NT_STATUS_USER_SESSION_DELETED
)) {
81 * Some NetApp servers return
82 * NT_STATUS_INVALID_PARAMETER.That's OK, they still
84 * BUG: https://bugzilla.samba.org/show_bug.cgi?id=13007
86 if (NT_STATUS_EQUAL(status
,
87 NT_STATUS_INVALID_PARAMETER
)) {
94 server
->last_echo_time
= now
;
100 * Remove a server from the cached server list it's unused.
101 * On success, 0 is returned. 1 is returned if the server could not be removed.
103 * Also usable outside libsmbclient
106 SMBC_remove_unused_server(SMBCCTX
* context
,
111 /* are we being fooled ? */
112 if (!context
|| !context
->internal
->initialized
|| !srv
) {
116 /* Check all open files/directories for a relation with this server */
117 for (file
= context
->internal
->files
; file
; file
= file
->next
) {
118 if (file
->srv
== srv
) {
120 DEBUG(3, ("smbc_remove_usused_server: "
121 "%p still used by %p.\n",
127 DLIST_REMOVE(context
->internal
->servers
, srv
);
129 cli_shutdown(srv
->cli
);
132 DEBUG(3, ("smbc_remove_usused_server: %p removed.\n", srv
));
134 smbc_getFunctionRemoveCachedServer(context
)(context
, srv
);
140 /****************************************************************
141 * Call the auth_fn with fixed size (fstring) buffers.
142 ***************************************************************/
144 SMBC_call_auth_fn(TALLOC_CTX
*ctx
,
152 fstring workgroup
= { 0 };
153 fstring username
= { 0 };
154 fstring password
= { 0 };
155 smbc_get_auth_data_with_context_fn auth_with_context_fn
;
157 if (*pp_workgroup
!= NULL
) {
158 strlcpy(workgroup
, *pp_workgroup
, sizeof(workgroup
));
160 if (*pp_username
!= NULL
) {
161 strlcpy(username
, *pp_username
, sizeof(username
));
163 if (*pp_password
!= NULL
) {
164 strlcpy(password
, *pp_password
, sizeof(password
));
167 /* See if there's an authentication with context function provided */
168 auth_with_context_fn
= smbc_getFunctionAuthDataWithContext(context
);
169 if (auth_with_context_fn
)
171 (* auth_with_context_fn
)(context
,
173 workgroup
, sizeof(workgroup
),
174 username
, sizeof(username
),
175 password
, sizeof(password
));
179 smbc_getFunctionAuthData(context
)(server
, share
,
180 workgroup
, sizeof(workgroup
),
181 username
, sizeof(username
),
182 password
, sizeof(password
));
185 TALLOC_FREE(*pp_workgroup
);
186 TALLOC_FREE(*pp_username
);
187 TALLOC_FREE(*pp_password
);
189 *pp_workgroup
= talloc_strdup(ctx
, workgroup
);
190 *pp_username
= talloc_strdup(ctx
, username
);
191 *pp_password
= talloc_strdup(ctx
, password
);
196 SMBC_get_auth_data(const char *server
, const char *share
,
197 char *workgroup_buf
, int workgroup_buf_len
,
198 char *username_buf
, int username_buf_len
,
199 char *password_buf
, int password_buf_len
)
201 /* Default function just uses provided data. Nothing to do. */
207 SMBC_find_server(TALLOC_CTX
*ctx
,
218 if (!pp_workgroup
|| !pp_username
|| !pp_password
) {
224 srv
= smbc_getFunctionGetCachedServer(context
)(context
,
229 if (!auth_called
&& !srv
&& (!*pp_username
|| !(*pp_username
)[0] ||
230 !*pp_password
|| !(*pp_password
)[0])) {
231 SMBC_call_auth_fn(ctx
, context
, server
, share
,
232 pp_workgroup
, pp_username
, pp_password
);
235 * However, smbc_auth_fn may have picked up info relating to
236 * an existing connection, so try for an existing connection
240 goto check_server_cache
;
245 if (smbc_getFunctionCheckServer(context
)(context
, srv
)) {
247 * This server is no good anymore
248 * Try to remove it and check for more possible
249 * servers in the cache
251 if (smbc_getFunctionRemoveUnusedServer(context
)(context
,
254 * We could not remove the server completely,
255 * remove it from the cache so we will not get
256 * it again. It will be removed when the last
257 * file/dir is closed.
259 smbc_getFunctionRemoveCachedServer(context
)(context
,
264 * Maybe there are more cached connections to this
267 goto check_server_cache
;
276 static struct cli_credentials
*SMBC_auth_credentials(TALLOC_CTX
*mem_ctx
,
279 const char *username
,
280 const char *password
)
282 struct cli_credentials
*creds
= NULL
;
283 bool use_kerberos
= false;
284 bool fallback_after_kerberos
= false;
285 bool use_ccache
= false;
286 bool pw_nt_hash
= false;
288 use_kerberos
= smbc_getOptionUseKerberos(context
);
289 fallback_after_kerberos
= smbc_getOptionFallbackAfterKerberos(context
);
290 use_ccache
= smbc_getOptionUseCCache(context
);
291 pw_nt_hash
= smbc_getOptionUseNTHash(context
);
293 creds
= cli_session_creds_init(mem_ctx
,
299 fallback_after_kerberos
,
306 switch (context
->internal
->smb_encryption_level
) {
307 case SMBC_ENCRYPTLEVEL_DEFAULT
:
308 /* Use the config option */
310 case SMBC_ENCRYPTLEVEL_NONE
:
311 (void)cli_credentials_set_smb_encryption(
316 case SMBC_ENCRYPTLEVEL_REQUEST
:
317 (void)cli_credentials_set_smb_encryption(
319 SMB_ENCRYPTION_DESIRED
,
322 case SMBC_ENCRYPTLEVEL_REQUIRE
:
324 (void)cli_credentials_set_smb_encryption(
326 SMB_ENCRYPTION_REQUIRED
,
336 * Connect to a server, possibly on an existing connection
338 * Here, what we want to do is: If the server and username
339 * match an existing connection, reuse that, otherwise, establish a
342 * If we have to create a new connection, call the auth_fn to get the
343 * info we need, unless the username and password were passed in.
347 SMBC_server_internal(TALLOC_CTX
*ctx
,
349 bool connect_if_not_found
,
359 char *workgroup
= NULL
;
360 struct cli_state
*c
= NULL
;
361 const char *server_n
= server
;
362 int is_ipc
= (share
!= NULL
&& strcmp(share
, "IPC$") == 0);
363 uint32_t fs_attrs
= 0;
364 const char *username_used
= NULL
;
365 const char *password_used
= NULL
;
367 char *newserver
, *newshare
;
369 struct smbXcli_tcon
*tcon
= NULL
;
370 int signing_state
= SMB_SIGNING_DEFAULT
;
371 struct cli_credentials
*creds
= NULL
;
375 if (server
[0] == 0) {
380 /* Look for a cached connection */
381 srv
= SMBC_find_server(ctx
, context
, server
, share
,
382 pp_workgroup
, pp_username
, pp_password
);
385 * If we found a connection and we're only allowed one share per
389 share
!= NULL
&& *share
!= '\0' &&
390 smbc_getOptionOneSharePerServer(context
)) {
393 * ... then if there's no current connection to the share,
394 * connect to it. SMBC_find_server(), or rather the function
395 * pointed to by context->get_cached_srv_fn which
396 * was called by SMBC_find_server(), will have issued a tree
397 * disconnect if the requested share is not the same as the
398 * one that was already connected.
402 * Use srv->cli->desthost and srv->cli->share instead of
403 * server and share below to connect to the actual share,
404 * i.e., a normal share or a referred share from
405 * 'msdfs proxy' share.
407 if (!cli_state_has_tcon(srv
->cli
)) {
408 /* Ensure we have accurate auth info */
409 SMBC_call_auth_fn(ctx
, context
,
410 smbXcli_conn_remote_name(srv
->cli
->conn
),
416 if (!*pp_workgroup
|| !*pp_username
|| !*pp_password
) {
418 cli_shutdown(srv
->cli
);
420 smbc_getFunctionRemoveCachedServer(context
)(context
,
426 * We don't need to renegotiate encryption
427 * here as the encryption context is not per
431 status
= cli_tree_connect(srv
->cli
,
435 if (!NT_STATUS_IS_OK(status
)) {
436 cli_shutdown(srv
->cli
);
437 errno
= map_errno_from_nt_status(status
);
439 smbc_getFunctionRemoveCachedServer(context
)(context
,
445 /* Determine if this share supports case sensitivity */
448 ("IPC$ so ignore case sensitivity\n"));
449 status
= NT_STATUS_OK
;
451 status
= cli_get_fs_attr_info(srv
->cli
, &fs_attrs
);
454 if (!NT_STATUS_IS_OK(status
)) {
455 DEBUG(4, ("Could not retrieve "
456 "case sensitivity flag: %s.\n",
460 * We can't determine the case sensitivity of
461 * the share. We have no choice but to use the
462 * user-specified case sensitivity setting.
464 if (smbc_getOptionCaseSensitive(context
)) {
465 cli_set_case_sensitive(srv
->cli
, true);
467 cli_set_case_sensitive(srv
->cli
, false);
469 } else if (!is_ipc
) {
471 ("Case sensitive: %s\n",
472 (fs_attrs
& FILE_CASE_SENSITIVE_SEARCH
475 cli_set_case_sensitive(
477 (fs_attrs
& FILE_CASE_SENSITIVE_SEARCH
483 * Regenerate the dev value since it's based on both
487 const char *remote_name
=
488 smbXcli_conn_remote_name(srv
->cli
->conn
);
490 srv
->dev
= (dev_t
)(str_checksum(remote_name
) ^
491 str_checksum(srv
->cli
->share
));
498 /* If we have a connection... */
501 /* ... then we're done here. Give 'em what they came for. */
506 /* If we're not asked to connect when a connection doesn't exist... */
507 if (! connect_if_not_found
) {
508 /* ... then we're done here. */
512 if (!*pp_workgroup
|| !*pp_username
|| !*pp_password
) {
517 DEBUG(4,("SMBC_server: server_n=[%s] server=[%s]\n", server_n
, server
));
519 DEBUG(4,(" -> server_n=[%s] server=[%s]\n", server_n
, server
));
521 status
= NT_STATUS_UNSUCCESSFUL
;
523 if (context
->internal
->smb_encryption_level
> SMBC_ENCRYPTLEVEL_NONE
) {
524 signing_state
= SMB_SIGNING_REQUIRED
;
528 if (share
== NULL
|| *share
== '\0' || is_ipc
) {
530 * Try 139 first for IPC$
532 status
= cli_connect_nb(NULL
,
537 smbc_getNetbiosName(context
),
544 if (!NT_STATUS_IS_OK(status
)) {
546 * No IPC$ or 139 did not work
548 status
= cli_connect_nb(NULL
,
553 smbc_getNetbiosName(context
),
559 if (!NT_STATUS_IS_OK(status
)) {
560 if (NT_STATUS_EQUAL(status
, NT_STATUS_NOT_SUPPORTED
)) {
561 DBG_ERR("NetBIOS support disabled, unable to connect\n");
564 errno
= map_errno_from_nt_status(status
);
568 cli_set_timeout(c
, smbc_getTimeout(context
));
570 status
= smbXcli_negprot(c
->conn
,
572 lp_client_min_protocol(),
573 lp_client_max_protocol(),
577 if (!NT_STATUS_IS_OK(status
)) {
579 errno
= map_errno_from_nt_status(status
);
583 if (smbXcli_conn_protocol(c
->conn
) >= PROTOCOL_SMB2_02
) {
584 /* Ensure we ask for some initial credits. */
585 smb2cli_conn_set_max_credits(c
->conn
, DEFAULT_SMB2_MAX_CREDITS
);
588 username_used
= *pp_username
;
589 password_used
= *pp_password
;
591 creds
= SMBC_auth_credentials(c
,
602 status
= cli_session_setup_creds(c
, creds
);
603 if (!NT_STATUS_IS_OK(status
)) {
605 /* Failed. Try an anonymous login, if allowed by flags. */
609 if (smbc_getOptionNoAutoAnonymousLogin(context
) ||
610 !NT_STATUS_IS_OK(cli_session_setup_anon(c
))) {
613 errno
= map_errno_from_nt_status(status
);
618 DEBUG(4,(" session setup ok\n"));
620 /* here's the fun part....to support 'msdfs proxy' shares
621 (on Samba or windows) we have to issues a TRANS_GET_DFS_REFERRAL
622 here before trying to connect to the original share.
623 cli_check_msdfs_proxy() will fail if it is a normal share. */
625 if (smbXcli_conn_dfs_supported(c
->conn
) &&
626 cli_check_msdfs_proxy(ctx
, c
, share
,
627 &newserver
, &newshare
,
630 srv
= SMBC_server_internal(ctx
, context
, connect_if_not_found
,
631 newserver
, port
, newshare
, pp_workgroup
,
632 pp_username
, pp_password
, in_cache
);
633 TALLOC_FREE(newserver
);
634 TALLOC_FREE(newshare
);
638 /* must be a normal share */
640 status
= cli_tree_connect_creds(c
, share
, "?????", creds
);
641 if (!NT_STATUS_IS_OK(status
)) {
643 errno
= map_errno_from_nt_status(status
);
647 DEBUG(4,(" tconx ok\n"));
649 if (smbXcli_conn_protocol(c
->conn
) >= PROTOCOL_SMB2_02
) {
655 /* Determine if this share supports case sensitivity */
657 DEBUG(4, ("IPC$ so ignore case sensitivity\n"));
658 status
= NT_STATUS_OK
;
660 status
= cli_get_fs_attr_info(c
, &fs_attrs
);
663 if (!NT_STATUS_IS_OK(status
)) {
664 DEBUG(4, ("Could not retrieve case sensitivity flag: %s.\n",
668 * We can't determine the case sensitivity of the share. We
669 * have no choice but to use the user-specified case
670 * sensitivity setting.
672 if (smbc_getOptionCaseSensitive(context
)) {
673 cli_set_case_sensitive(c
, True
);
675 cli_set_case_sensitive(c
, False
);
677 } else if (!is_ipc
) {
678 DEBUG(4, ("Case sensitive: %s\n",
679 (fs_attrs
& FILE_CASE_SENSITIVE_SEARCH
682 smbXcli_tcon_set_fs_attributes(tcon
, fs_attrs
);
686 * Ok, we have got a nice connection
687 * Let's allocate a server structure.
690 srv
= SMB_MALLOC_P(SMBCSRV
);
698 DLIST_ADD(srv
->cli
, c
);
699 srv
->dev
= (dev_t
)(str_checksum(server
) ^ str_checksum(share
));
700 srv
->no_pathinfo
= False
;
701 srv
->no_pathinfo2
= False
;
702 srv
->no_pathinfo3
= False
;
703 srv
->no_nt_session
= False
;
706 if (!pp_workgroup
|| !*pp_workgroup
|| !**pp_workgroup
) {
707 workgroup
= talloc_strdup(ctx
, smbc_getWorkgroup(context
));
709 workgroup
= *pp_workgroup
;
719 /* set the credentials to make DFS work */
720 smbc_set_credentials_with_fallback(context
,
729 SMBC_server(TALLOC_CTX
*ctx
,
731 bool connect_if_not_found
,
740 bool in_cache
= false;
742 srv
= SMBC_server_internal(ctx
, context
, connect_if_not_found
,
743 server
, port
, share
, pp_workgroup
,
744 pp_username
, pp_password
, &in_cache
);
753 /* Now add it to the cache (internal or external) */
754 /* Let the cache function set errno if it wants to */
756 if (smbc_getFunctionAddCachedServer(context
)(context
, srv
,
760 int saved_errno
= errno
;
761 DEBUG(3, (" Failed to add server to cache\n"));
770 DEBUG(2, ("Server connect ok: //%s/%s: %p\n",
771 server
, share
, srv
));
773 DLIST_ADD(context
->internal
->servers
, srv
);
778 * Connect to a server for getting/setting attributes, possibly on an existing
779 * connection. This works similarly to SMBC_server().
782 SMBC_attr_server(TALLOC_CTX
*ctx
,
792 struct cli_state
*ipc_cli
= NULL
;
793 struct rpc_pipe_client
*pipe_hnd
= NULL
;
796 SMBCSRV
*ipc_srv
=NULL
;
799 * Use srv->cli->desthost and srv->cli->share instead of
800 * server and share below to connect to the actual share,
801 * i.e., a normal share or a referred share from
802 * 'msdfs proxy' share.
804 srv
= SMBC_server(ctx
, context
, true, server
, port
, share
,
805 pp_workgroup
, pp_username
, pp_password
);
809 server
= smbXcli_conn_remote_name(srv
->cli
->conn
);
810 share
= srv
->cli
->share
;
813 * See if we've already created this special connection. Reference
814 * our "special" share name '*IPC$', which is an impossible real share
815 * name due to the leading asterisk.
817 ipc_srv
= SMBC_find_server(ctx
, context
, server
, "*IPC$",
818 pp_workgroup
, pp_username
, pp_password
);
820 struct cli_credentials
*creds
= NULL
;
822 /* We didn't find a cached connection. Get the password */
823 if (!*pp_password
|| (*pp_password
)[0] == '\0') {
824 /* ... then retrieve it now. */
825 SMBC_call_auth_fn(ctx
, context
, server
, share
,
829 if (!*pp_workgroup
|| !*pp_username
|| !*pp_password
) {
837 creds
= SMBC_auth_credentials(NULL
,
847 nt_status
= cli_full_connection_creds(NULL
,
857 if (! NT_STATUS_IS_OK(nt_status
)) {
859 DEBUG(1,("cli_full_connection failed! (%s)\n",
860 nt_errstr(nt_status
)));
864 talloc_steal(ipc_cli
, creds
);
866 ipc_srv
= SMB_MALLOC_P(SMBCSRV
);
869 cli_shutdown(ipc_cli
);
873 ZERO_STRUCTP(ipc_srv
);
874 DLIST_ADD(ipc_srv
->cli
, ipc_cli
);
876 nt_status
= cli_rpc_pipe_open_noauth(
877 ipc_srv
->cli
, &ndr_table_lsarpc
, &pipe_hnd
);
878 if (!NT_STATUS_IS_OK(nt_status
)) {
879 DEBUG(1, ("cli_nt_session_open fail!\n"));
881 cli_shutdown(ipc_srv
->cli
);
887 * Some systems don't support
888 * SEC_FLAG_MAXIMUM_ALLOWED, but NT sends 0x2000000
889 * so we might as well do it too.
892 nt_status
= rpccli_lsa_open_policy(
896 GENERIC_EXECUTE_ACCESS
,
899 if (!NT_STATUS_IS_OK(nt_status
)) {
900 cli_shutdown(ipc_srv
->cli
);
902 errno
= cli_status_to_errno(nt_status
);
906 /* now add it to the cache (internal or external) */
908 errno
= 0; /* let cache function set errno if it likes */
909 if (smbc_getFunctionAddCachedServer(context
)(context
, ipc_srv
,
914 DEBUG(3, (" Failed to add server to cache\n"));
918 cli_shutdown(ipc_srv
->cli
);
923 DLIST_ADD(context
->internal
->servers
, ipc_srv
);