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 useable 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 server
->last_echo_time
= now
;
72 * Remove a server from the cached server list it's unused.
73 * On success, 0 is returned. 1 is returned if the server could not be removed.
75 * Also useable outside libsmbclient
78 SMBC_remove_unused_server(SMBCCTX
* context
,
83 /* are we being fooled ? */
84 if (!context
|| !context
->internal
->initialized
|| !srv
) {
88 /* Check all open files/directories for a relation with this server */
89 for (file
= context
->internal
->files
; file
; file
= file
->next
) {
90 if (file
->srv
== srv
) {
92 DEBUG(3, ("smbc_remove_usused_server: "
93 "%p still used by %p.\n",
99 DLIST_REMOVE(context
->internal
->servers
, srv
);
101 cli_shutdown(srv
->cli
);
104 DEBUG(3, ("smbc_remove_usused_server: %p removed.\n", srv
));
106 smbc_getFunctionRemoveCachedServer(context
)(context
, srv
);
112 /****************************************************************
113 * Call the auth_fn with fixed size (fstring) buffers.
114 ***************************************************************/
116 SMBC_call_auth_fn(TALLOC_CTX
*ctx
,
124 fstring workgroup
= { 0 };
125 fstring username
= { 0 };
126 fstring password
= { 0 };
127 smbc_get_auth_data_with_context_fn auth_with_context_fn
;
129 if (*pp_workgroup
!= NULL
) {
130 strlcpy(workgroup
, *pp_workgroup
, sizeof(workgroup
));
132 if (*pp_username
!= NULL
) {
133 strlcpy(username
, *pp_username
, sizeof(username
));
135 if (*pp_password
!= NULL
) {
136 strlcpy(password
, *pp_password
, sizeof(password
));
139 /* See if there's an authentication with context function provided */
140 auth_with_context_fn
= smbc_getFunctionAuthDataWithContext(context
);
141 if (auth_with_context_fn
)
143 (* auth_with_context_fn
)(context
,
145 workgroup
, sizeof(workgroup
),
146 username
, sizeof(username
),
147 password
, sizeof(password
));
151 smbc_getFunctionAuthData(context
)(server
, share
,
152 workgroup
, sizeof(workgroup
),
153 username
, sizeof(username
),
154 password
, sizeof(password
));
157 TALLOC_FREE(*pp_workgroup
);
158 TALLOC_FREE(*pp_username
);
159 TALLOC_FREE(*pp_password
);
161 *pp_workgroup
= talloc_strdup(ctx
, workgroup
);
162 *pp_username
= talloc_strdup(ctx
, username
);
163 *pp_password
= talloc_strdup(ctx
, password
);
168 SMBC_get_auth_data(const char *server
, const char *share
,
169 char *workgroup_buf
, int workgroup_buf_len
,
170 char *username_buf
, int username_buf_len
,
171 char *password_buf
, int password_buf_len
)
173 /* Default function just uses provided data. Nothing to do. */
179 SMBC_find_server(TALLOC_CTX
*ctx
,
190 if (!pp_workgroup
|| !pp_username
|| !pp_password
) {
196 srv
= smbc_getFunctionGetCachedServer(context
)(context
,
201 if (!auth_called
&& !srv
&& (!*pp_username
|| !(*pp_username
)[0] ||
202 !*pp_password
|| !(*pp_password
)[0])) {
203 SMBC_call_auth_fn(ctx
, context
, server
, share
,
204 pp_workgroup
, pp_username
, pp_password
);
207 * However, smbc_auth_fn may have picked up info relating to
208 * an existing connection, so try for an existing connection
212 goto check_server_cache
;
217 if (smbc_getFunctionCheckServer(context
)(context
, srv
)) {
219 * This server is no good anymore
220 * Try to remove it and check for more possible
221 * servers in the cache
223 if (smbc_getFunctionRemoveUnusedServer(context
)(context
,
226 * We could not remove the server completely,
227 * remove it from the cache so we will not get
228 * it again. It will be removed when the last
229 * file/dir is closed.
231 smbc_getFunctionRemoveCachedServer(context
)(context
,
236 * Maybe there are more cached connections to this
239 goto check_server_cache
;
249 * Connect to a server, possibly on an existing connection
251 * Here, what we want to do is: If the server and username
252 * match an existing connection, reuse that, otherwise, establish a
255 * If we have to create a new connection, call the auth_fn to get the
256 * info we need, unless the username and password were passed in.
260 SMBC_server_internal(TALLOC_CTX
*ctx
,
262 bool connect_if_not_found
,
272 char *workgroup
= NULL
;
273 struct cli_state
*c
= NULL
;
274 const char *server_n
= server
;
275 int is_ipc
= (share
!= NULL
&& strcmp(share
, "IPC$") == 0);
276 uint32_t fs_attrs
= 0;
277 const char *username_used
= NULL
;
278 const char *password_used
= NULL
;
280 char *newserver
, *newshare
;
282 struct smbXcli_tcon
*tcon
= NULL
;
283 int signing_state
= SMB_SIGNING_DEFAULT
;
284 struct cli_credentials
*creds
= NULL
;
285 bool use_kerberos
= false;
286 bool fallback_after_kerberos
= false;
287 bool use_ccache
= false;
288 bool pw_nt_hash
= false;
293 if (server
[0] == 0) {
298 /* Look for a cached connection */
299 srv
= SMBC_find_server(ctx
, context
, server
, share
,
300 pp_workgroup
, pp_username
, pp_password
);
303 * If we found a connection and we're only allowed one share per
307 share
!= NULL
&& *share
!= '\0' &&
308 smbc_getOptionOneSharePerServer(context
)) {
311 * ... then if there's no current connection to the share,
312 * connect to it. SMBC_find_server(), or rather the function
313 * pointed to by context->get_cached_srv_fn which
314 * was called by SMBC_find_server(), will have issued a tree
315 * disconnect if the requested share is not the same as the
316 * one that was already connected.
320 * Use srv->cli->desthost and srv->cli->share instead of
321 * server and share below to connect to the actual share,
322 * i.e., a normal share or a referred share from
323 * 'msdfs proxy' share.
325 if (!cli_state_has_tcon(srv
->cli
)) {
326 /* Ensure we have accurate auth info */
327 SMBC_call_auth_fn(ctx
, context
,
328 smbXcli_conn_remote_name(srv
->cli
->conn
),
334 if (!*pp_workgroup
|| !*pp_username
|| !*pp_password
) {
336 cli_shutdown(srv
->cli
);
338 smbc_getFunctionRemoveCachedServer(context
)(context
,
344 * We don't need to renegotiate encryption
345 * here as the encryption context is not per
349 status
= cli_tree_connect(srv
->cli
,
353 if (!NT_STATUS_IS_OK(status
)) {
354 errno
= map_errno_from_nt_status(status
);
355 cli_shutdown(srv
->cli
);
357 smbc_getFunctionRemoveCachedServer(context
)(context
,
362 /* Determine if this share supports case sensitivity */
365 ("IPC$ so ignore case sensitivity\n"));
366 status
= NT_STATUS_OK
;
368 status
= cli_get_fs_attr_info(c
, &fs_attrs
);
371 if (!NT_STATUS_IS_OK(status
)) {
372 DEBUG(4, ("Could not retrieve "
373 "case sensitivity flag: %s.\n",
377 * We can't determine the case sensitivity of
378 * the share. We have no choice but to use the
379 * user-specified case sensitivity setting.
381 if (smbc_getOptionCaseSensitive(context
)) {
382 cli_set_case_sensitive(c
, True
);
384 cli_set_case_sensitive(c
, False
);
386 } else if (!is_ipc
) {
388 ("Case sensitive: %s\n",
389 (fs_attrs
& FILE_CASE_SENSITIVE_SEARCH
392 cli_set_case_sensitive(
394 (fs_attrs
& FILE_CASE_SENSITIVE_SEARCH
400 * Regenerate the dev value since it's based on both
404 const char *remote_name
=
405 smbXcli_conn_remote_name(srv
->cli
->conn
);
407 srv
->dev
= (dev_t
)(str_checksum(remote_name
) ^
408 str_checksum(srv
->cli
->share
));
413 /* If we have a connection... */
416 /* ... then we're done here. Give 'em what they came for. */
421 /* If we're not asked to connect when a connection doesn't exist... */
422 if (! connect_if_not_found
) {
423 /* ... then we're done here. */
427 if (!*pp_workgroup
|| !*pp_username
|| !*pp_password
) {
432 DEBUG(4,("SMBC_server: server_n=[%s] server=[%s]\n", server_n
, server
));
434 DEBUG(4,(" -> server_n=[%s] server=[%s]\n", server_n
, server
));
436 status
= NT_STATUS_UNSUCCESSFUL
;
438 if (smbc_getOptionUseKerberos(context
)) {
439 flags
|= CLI_FULL_CONNECTION_USE_KERBEROS
;
443 if (smbc_getOptionFallbackAfterKerberos(context
)) {
444 flags
|= CLI_FULL_CONNECTION_FALLBACK_AFTER_KERBEROS
;
445 fallback_after_kerberos
= true;
448 if (smbc_getOptionUseCCache(context
)) {
449 flags
|= CLI_FULL_CONNECTION_USE_CCACHE
;
453 if (smbc_getOptionUseNTHash(context
)) {
454 flags
|= CLI_FULL_CONNECTION_USE_NT_HASH
;
458 if (context
->internal
->smb_encryption_level
!= SMBC_ENCRYPTLEVEL_NONE
) {
459 signing_state
= SMB_SIGNING_REQUIRED
;
463 if (share
== NULL
|| *share
== '\0' || is_ipc
) {
465 * Try 139 first for IPC$
467 status
= cli_connect_nb(server_n
, NULL
, NBT_SMB_PORT
, 0x20,
468 smbc_getNetbiosName(context
),
469 signing_state
, flags
, &c
);
473 if (!NT_STATUS_IS_OK(status
)) {
475 * No IPC$ or 139 did not work
477 status
= cli_connect_nb(server_n
, NULL
, port
, 0x20,
478 smbc_getNetbiosName(context
),
479 signing_state
, flags
, &c
);
482 if (!NT_STATUS_IS_OK(status
)) {
483 errno
= map_errno_from_nt_status(status
);
487 cli_set_timeout(c
, smbc_getTimeout(context
));
489 status
= smbXcli_negprot(c
->conn
, c
->timeout
,
490 lp_client_min_protocol(),
491 lp_client_max_protocol());
492 if (!NT_STATUS_IS_OK(status
)) {
498 if (smbXcli_conn_protocol(c
->conn
) >= PROTOCOL_SMB2_02
) {
499 /* Ensure we ask for some initial credits. */
500 smb2cli_conn_set_max_credits(c
->conn
, DEFAULT_SMB2_MAX_CREDITS
);
503 username_used
= *pp_username
;
504 password_used
= *pp_password
;
506 creds
= cli_session_creds_init(c
,
512 fallback_after_kerberos
,
521 status
= cli_session_setup_creds(c
, creds
);
522 if (!NT_STATUS_IS_OK(status
)) {
524 /* Failed. Try an anonymous login, if allowed by flags. */
528 if (smbc_getOptionNoAutoAnonymousLogin(context
) ||
529 !NT_STATUS_IS_OK(cli_session_setup_anon(c
))) {
537 DEBUG(4,(" session setup ok\n"));
539 /* here's the fun part....to support 'msdfs proxy' shares
540 (on Samba or windows) we have to issues a TRANS_GET_DFS_REFERRAL
541 here before trying to connect to the original share.
542 cli_check_msdfs_proxy() will fail if it is a normal share. */
544 if (smbXcli_conn_dfs_supported(c
->conn
) &&
545 cli_check_msdfs_proxy(ctx
, c
, share
,
546 &newserver
, &newshare
,
547 /* FIXME: cli_check_msdfs_proxy() does
548 not support smbc_smb_encrypt_level type */
549 context
->internal
->smb_encryption_level
?
553 srv
= SMBC_server_internal(ctx
, context
, connect_if_not_found
,
554 newserver
, port
, newshare
, pp_workgroup
,
555 pp_username
, pp_password
, in_cache
);
556 TALLOC_FREE(newserver
);
557 TALLOC_FREE(newshare
);
561 /* must be a normal share */
563 status
= cli_tree_connect_creds(c
, share
, "?????", creds
);
564 if (!NT_STATUS_IS_OK(status
)) {
565 errno
= map_errno_from_nt_status(status
);
570 DEBUG(4,(" tconx ok\n"));
572 if (smbXcli_conn_protocol(c
->conn
) >= PROTOCOL_SMB2_02
) {
578 /* Determine if this share supports case sensitivity */
580 DEBUG(4, ("IPC$ so ignore case sensitivity\n"));
581 status
= NT_STATUS_OK
;
583 status
= cli_get_fs_attr_info(c
, &fs_attrs
);
586 if (!NT_STATUS_IS_OK(status
)) {
587 DEBUG(4, ("Could not retrieve case sensitivity flag: %s.\n",
591 * We can't determine the case sensitivity of the share. We
592 * have no choice but to use the user-specified case
593 * sensitivity setting.
595 if (smbc_getOptionCaseSensitive(context
)) {
596 cli_set_case_sensitive(c
, True
);
598 cli_set_case_sensitive(c
, False
);
600 } else if (!is_ipc
) {
601 DEBUG(4, ("Case sensitive: %s\n",
602 (fs_attrs
& FILE_CASE_SENSITIVE_SEARCH
605 smbXcli_tcon_set_fs_attributes(tcon
, fs_attrs
);
608 if (context
->internal
->smb_encryption_level
) {
609 /* Attempt encryption. */
610 status
= cli_cm_force_encryption_creds(c
,
613 if (!NT_STATUS_IS_OK(status
)) {
616 * context->smb_encryption_level == 1
617 * means don't fail if encryption can't be negotiated,
618 * == 2 means fail if encryption can't be negotiated.
621 DEBUG(4,(" SMB encrypt failed\n"));
623 if (context
->internal
->smb_encryption_level
== 2) {
629 DEBUG(4,(" SMB encrypt ok\n"));
633 * Ok, we have got a nice connection
634 * Let's allocate a server structure.
637 srv
= SMB_MALLOC_P(SMBCSRV
);
645 DLIST_ADD(srv
->cli
, c
);
646 srv
->dev
= (dev_t
)(str_checksum(server
) ^ str_checksum(share
));
647 srv
->no_pathinfo
= False
;
648 srv
->no_pathinfo2
= False
;
649 srv
->no_pathinfo3
= False
;
650 srv
->no_nt_session
= False
;
653 if (!pp_workgroup
|| !*pp_workgroup
|| !**pp_workgroup
) {
654 workgroup
= talloc_strdup(ctx
, smbc_getWorkgroup(context
));
656 workgroup
= *pp_workgroup
;
666 /* set the credentials to make DFS work */
667 smbc_set_credentials_with_fallback(context
,
676 SMBC_server(TALLOC_CTX
*ctx
,
678 bool connect_if_not_found
,
687 bool in_cache
= false;
689 srv
= SMBC_server_internal(ctx
, context
, connect_if_not_found
,
690 server
, port
, share
, pp_workgroup
,
691 pp_username
, pp_password
, &in_cache
);
700 /* Now add it to the cache (internal or external) */
701 /* Let the cache function set errno if it wants to */
703 if (smbc_getFunctionAddCachedServer(context
)(context
, srv
,
707 int saved_errno
= errno
;
708 DEBUG(3, (" Failed to add server to cache\n"));
717 DEBUG(2, ("Server connect ok: //%s/%s: %p\n",
718 server
, share
, srv
));
720 DLIST_ADD(context
->internal
->servers
, srv
);
725 * Connect to a server for getting/setting attributes, possibly on an existing
726 * connection. This works similarly to SMBC_server().
729 SMBC_attr_server(TALLOC_CTX
*ctx
,
739 struct cli_state
*ipc_cli
= NULL
;
740 struct rpc_pipe_client
*pipe_hnd
= NULL
;
743 SMBCSRV
*ipc_srv
=NULL
;
746 * Use srv->cli->desthost and srv->cli->share instead of
747 * server and share below to connect to the actual share,
748 * i.e., a normal share or a referred share from
749 * 'msdfs proxy' share.
751 srv
= SMBC_server(ctx
, context
, true, server
, port
, share
,
752 pp_workgroup
, pp_username
, pp_password
);
756 server
= smbXcli_conn_remote_name(srv
->cli
->conn
);
757 share
= srv
->cli
->share
;
760 * See if we've already created this special connection. Reference
761 * our "special" share name '*IPC$', which is an impossible real share
762 * name due to the leading asterisk.
764 ipc_srv
= SMBC_find_server(ctx
, context
, server
, "*IPC$",
765 pp_workgroup
, pp_username
, pp_password
);
767 int signing_state
= SMB_SIGNING_DEFAULT
;
769 /* We didn't find a cached connection. Get the password */
770 if (!*pp_password
|| (*pp_password
)[0] == '\0') {
771 /* ... then retrieve it now. */
772 SMBC_call_auth_fn(ctx
, context
, server
, share
,
776 if (!*pp_workgroup
|| !*pp_username
|| !*pp_password
) {
783 if (smbc_getOptionUseKerberos(context
)) {
784 flags
|= CLI_FULL_CONNECTION_USE_KERBEROS
;
786 if (smbc_getOptionUseCCache(context
)) {
787 flags
|= CLI_FULL_CONNECTION_USE_CCACHE
;
789 if (context
->internal
->smb_encryption_level
!= SMBC_ENCRYPTLEVEL_NONE
) {
790 signing_state
= SMB_SIGNING_REQUIRED
;
793 nt_status
= cli_full_connection(&ipc_cli
,
794 lp_netbios_name(), server
,
795 NULL
, 0, "IPC$", "?????",
801 if (! NT_STATUS_IS_OK(nt_status
)) {
802 DEBUG(1,("cli_full_connection failed! (%s)\n",
803 nt_errstr(nt_status
)));
808 if (context
->internal
->smb_encryption_level
) {
809 /* Attempt encryption. */
810 nt_status
= cli_cm_force_encryption(ipc_cli
,
815 if (!NT_STATUS_IS_OK(nt_status
)) {
818 * context->smb_encryption_level ==
819 * 1 means don't fail if encryption can't be
820 * negotiated, == 2 means fail if encryption
821 * can't be negotiated.
824 DEBUG(4,(" SMB encrypt failed on IPC$\n"));
826 if (context
->internal
->smb_encryption_level
== 2) {
827 cli_shutdown(ipc_cli
);
832 DEBUG(4,(" SMB encrypt ok on IPC$\n"));
835 ipc_srv
= SMB_MALLOC_P(SMBCSRV
);
838 cli_shutdown(ipc_cli
);
842 ZERO_STRUCTP(ipc_srv
);
843 DLIST_ADD(ipc_srv
->cli
, ipc_cli
);
845 nt_status
= cli_rpc_pipe_open_noauth(
846 ipc_srv
->cli
, &ndr_table_lsarpc
, &pipe_hnd
);
847 if (!NT_STATUS_IS_OK(nt_status
)) {
848 DEBUG(1, ("cli_nt_session_open fail!\n"));
850 cli_shutdown(ipc_srv
->cli
);
856 * Some systems don't support
857 * SEC_FLAG_MAXIMUM_ALLOWED, but NT sends 0x2000000
858 * so we might as well do it too.
861 nt_status
= rpccli_lsa_open_policy(
865 GENERIC_EXECUTE_ACCESS
,
868 if (!NT_STATUS_IS_OK(nt_status
)) {
869 errno
= SMBC_errno(context
, ipc_srv
->cli
);
870 cli_shutdown(ipc_srv
->cli
);
875 /* now add it to the cache (internal or external) */
877 errno
= 0; /* let cache function set errno if it likes */
878 if (smbc_getFunctionAddCachedServer(context
)(context
, ipc_srv
,
883 DEBUG(3, (" Failed to add server to cache\n"));
887 cli_shutdown(ipc_srv
->cli
);
892 DLIST_ADD(context
->internal
->servers
, ipc_srv
);