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
)) {
65 * Some NetApp servers return
66 * NT_STATUS_INVALID_PARAMETER.That's OK, they still
68 * BUG: https://bugzilla.samba.org/show_bug.cgi?id=13007
70 if (!NT_STATUS_EQUAL(status
,
71 NT_STATUS_INVALID_PARAMETER
)) {
75 server
->last_echo_time
= now
;
81 * Remove a server from the cached server list it's unused.
82 * On success, 0 is returned. 1 is returned if the server could not be removed.
84 * Also useable outside libsmbclient
87 SMBC_remove_unused_server(SMBCCTX
* context
,
92 /* are we being fooled ? */
93 if (!context
|| !context
->internal
->initialized
|| !srv
) {
97 /* Check all open files/directories for a relation with this server */
98 for (file
= context
->internal
->files
; file
; file
= file
->next
) {
99 if (file
->srv
== srv
) {
101 DEBUG(3, ("smbc_remove_usused_server: "
102 "%p still used by %p.\n",
108 DLIST_REMOVE(context
->internal
->servers
, srv
);
110 cli_shutdown(srv
->cli
);
113 DEBUG(3, ("smbc_remove_usused_server: %p removed.\n", srv
));
115 smbc_getFunctionRemoveCachedServer(context
)(context
, srv
);
121 /****************************************************************
122 * Call the auth_fn with fixed size (fstring) buffers.
123 ***************************************************************/
125 SMBC_call_auth_fn(TALLOC_CTX
*ctx
,
133 fstring workgroup
= { 0 };
134 fstring username
= { 0 };
135 fstring password
= { 0 };
136 smbc_get_auth_data_with_context_fn auth_with_context_fn
;
138 if (*pp_workgroup
!= NULL
) {
139 strlcpy(workgroup
, *pp_workgroup
, sizeof(workgroup
));
141 if (*pp_username
!= NULL
) {
142 strlcpy(username
, *pp_username
, sizeof(username
));
144 if (*pp_password
!= NULL
) {
145 strlcpy(password
, *pp_password
, sizeof(password
));
148 /* See if there's an authentication with context function provided */
149 auth_with_context_fn
= smbc_getFunctionAuthDataWithContext(context
);
150 if (auth_with_context_fn
)
152 (* auth_with_context_fn
)(context
,
154 workgroup
, sizeof(workgroup
),
155 username
, sizeof(username
),
156 password
, sizeof(password
));
160 smbc_getFunctionAuthData(context
)(server
, share
,
161 workgroup
, sizeof(workgroup
),
162 username
, sizeof(username
),
163 password
, sizeof(password
));
166 TALLOC_FREE(*pp_workgroup
);
167 TALLOC_FREE(*pp_username
);
168 TALLOC_FREE(*pp_password
);
170 *pp_workgroup
= talloc_strdup(ctx
, workgroup
);
171 *pp_username
= talloc_strdup(ctx
, username
);
172 *pp_password
= talloc_strdup(ctx
, password
);
177 SMBC_get_auth_data(const char *server
, const char *share
,
178 char *workgroup_buf
, int workgroup_buf_len
,
179 char *username_buf
, int username_buf_len
,
180 char *password_buf
, int password_buf_len
)
182 /* Default function just uses provided data. Nothing to do. */
188 SMBC_find_server(TALLOC_CTX
*ctx
,
199 if (!pp_workgroup
|| !pp_username
|| !pp_password
) {
205 srv
= smbc_getFunctionGetCachedServer(context
)(context
,
210 if (!auth_called
&& !srv
&& (!*pp_username
|| !(*pp_username
)[0] ||
211 !*pp_password
|| !(*pp_password
)[0])) {
212 SMBC_call_auth_fn(ctx
, context
, server
, share
,
213 pp_workgroup
, pp_username
, pp_password
);
216 * However, smbc_auth_fn may have picked up info relating to
217 * an existing connection, so try for an existing connection
221 goto check_server_cache
;
226 if (smbc_getFunctionCheckServer(context
)(context
, srv
)) {
228 * This server is no good anymore
229 * Try to remove it and check for more possible
230 * servers in the cache
232 if (smbc_getFunctionRemoveUnusedServer(context
)(context
,
235 * We could not remove the server completely,
236 * remove it from the cache so we will not get
237 * it again. It will be removed when the last
238 * file/dir is closed.
240 smbc_getFunctionRemoveCachedServer(context
)(context
,
245 * Maybe there are more cached connections to this
248 goto check_server_cache
;
257 static struct cli_credentials
*SMBC_auth_credentials(TALLOC_CTX
*mem_ctx
,
260 const char *username
,
261 const char *password
)
263 struct cli_credentials
*creds
= NULL
;
264 bool use_kerberos
= false;
265 bool fallback_after_kerberos
= false;
266 bool use_ccache
= false;
267 bool pw_nt_hash
= false;
269 use_kerberos
= smbc_getOptionUseKerberos(context
);
270 fallback_after_kerberos
= smbc_getOptionFallbackAfterKerberos(context
);
271 use_ccache
= smbc_getOptionUseCCache(context
);
272 pw_nt_hash
= smbc_getOptionUseNTHash(context
);
274 creds
= cli_session_creds_init(mem_ctx
,
280 fallback_after_kerberos
,
287 switch (context
->internal
->smb_encryption_level
) {
288 case SMBC_ENCRYPTLEVEL_DEFAULT
:
289 /* Use the config option */
291 case SMBC_ENCRYPTLEVEL_NONE
:
292 cli_credentials_set_smb_encryption(creds
,
296 case SMBC_ENCRYPTLEVEL_REQUEST
:
297 cli_credentials_set_smb_encryption(creds
,
298 SMB_ENCRYPTION_DESIRED
,
301 case SMBC_ENCRYPTLEVEL_REQUIRE
:
303 cli_credentials_set_smb_encryption(creds
,
304 SMB_ENCRYPTION_REQUIRED
,
314 * Connect to a server, possibly on an existing connection
316 * Here, what we want to do is: If the server and username
317 * match an existing connection, reuse that, otherwise, establish a
320 * If we have to create a new connection, call the auth_fn to get the
321 * info we need, unless the username and password were passed in.
325 SMBC_server_internal(TALLOC_CTX
*ctx
,
327 bool connect_if_not_found
,
337 char *workgroup
= NULL
;
338 struct cli_state
*c
= NULL
;
339 const char *server_n
= server
;
340 int is_ipc
= (share
!= NULL
&& strcmp(share
, "IPC$") == 0);
341 uint32_t fs_attrs
= 0;
342 const char *username_used
= NULL
;
343 const char *password_used
= NULL
;
345 char *newserver
, *newshare
;
347 struct smbXcli_tcon
*tcon
= NULL
;
348 int signing_state
= SMB_SIGNING_DEFAULT
;
349 struct cli_credentials
*creds
= NULL
;
353 if (server
[0] == 0) {
358 /* Look for a cached connection */
359 srv
= SMBC_find_server(ctx
, context
, server
, share
,
360 pp_workgroup
, pp_username
, pp_password
);
363 * If we found a connection and we're only allowed one share per
367 share
!= NULL
&& *share
!= '\0' &&
368 smbc_getOptionOneSharePerServer(context
)) {
371 * ... then if there's no current connection to the share,
372 * connect to it. SMBC_find_server(), or rather the function
373 * pointed to by context->get_cached_srv_fn which
374 * was called by SMBC_find_server(), will have issued a tree
375 * disconnect if the requested share is not the same as the
376 * one that was already connected.
380 * Use srv->cli->desthost and srv->cli->share instead of
381 * server and share below to connect to the actual share,
382 * i.e., a normal share or a referred share from
383 * 'msdfs proxy' share.
385 if (!cli_state_has_tcon(srv
->cli
)) {
386 /* Ensure we have accurate auth info */
387 SMBC_call_auth_fn(ctx
, context
,
388 smbXcli_conn_remote_name(srv
->cli
->conn
),
394 if (!*pp_workgroup
|| !*pp_username
|| !*pp_password
) {
396 cli_shutdown(srv
->cli
);
398 smbc_getFunctionRemoveCachedServer(context
)(context
,
404 * We don't need to renegotiate encryption
405 * here as the encryption context is not per
409 status
= cli_tree_connect(srv
->cli
,
413 if (!NT_STATUS_IS_OK(status
)) {
414 cli_shutdown(srv
->cli
);
415 errno
= map_errno_from_nt_status(status
);
417 smbc_getFunctionRemoveCachedServer(context
)(context
,
423 /* Determine if this share supports case sensitivity */
426 ("IPC$ so ignore case sensitivity\n"));
427 status
= NT_STATUS_OK
;
429 status
= cli_get_fs_attr_info(srv
->cli
, &fs_attrs
);
432 if (!NT_STATUS_IS_OK(status
)) {
433 DEBUG(4, ("Could not retrieve "
434 "case sensitivity flag: %s.\n",
438 * We can't determine the case sensitivity of
439 * the share. We have no choice but to use the
440 * user-specified case sensitivity setting.
442 if (smbc_getOptionCaseSensitive(context
)) {
443 cli_set_case_sensitive(srv
->cli
, true);
445 cli_set_case_sensitive(srv
->cli
, false);
447 } else if (!is_ipc
) {
449 ("Case sensitive: %s\n",
450 (fs_attrs
& FILE_CASE_SENSITIVE_SEARCH
453 cli_set_case_sensitive(
455 (fs_attrs
& FILE_CASE_SENSITIVE_SEARCH
461 * Regenerate the dev value since it's based on both
465 const char *remote_name
=
466 smbXcli_conn_remote_name(srv
->cli
->conn
);
468 srv
->dev
= (dev_t
)(str_checksum(remote_name
) ^
469 str_checksum(srv
->cli
->share
));
476 /* If we have a connection... */
479 /* ... then we're done here. Give 'em what they came for. */
484 /* If we're not asked to connect when a connection doesn't exist... */
485 if (! connect_if_not_found
) {
486 /* ... then we're done here. */
490 if (!*pp_workgroup
|| !*pp_username
|| !*pp_password
) {
495 DEBUG(4,("SMBC_server: server_n=[%s] server=[%s]\n", server_n
, server
));
497 DEBUG(4,(" -> server_n=[%s] server=[%s]\n", server_n
, server
));
499 status
= NT_STATUS_UNSUCCESSFUL
;
501 if (context
->internal
->smb_encryption_level
!= SMBC_ENCRYPTLEVEL_NONE
) {
502 signing_state
= SMB_SIGNING_REQUIRED
;
506 if (share
== NULL
|| *share
== '\0' || is_ipc
) {
508 * Try 139 first for IPC$
510 status
= cli_connect_nb(server_n
, NULL
, NBT_SMB_PORT
, 0x20,
511 smbc_getNetbiosName(context
),
512 signing_state
, flags
, &c
);
516 if (!NT_STATUS_IS_OK(status
)) {
518 * No IPC$ or 139 did not work
520 status
= cli_connect_nb(server_n
, NULL
, port
, 0x20,
521 smbc_getNetbiosName(context
),
522 signing_state
, flags
, &c
);
525 if (!NT_STATUS_IS_OK(status
)) {
526 if (NT_STATUS_EQUAL(status
, NT_STATUS_NOT_SUPPORTED
)) {
527 DBG_ERR("NetBIOS support disabled, unable to connect");
530 errno
= map_errno_from_nt_status(status
);
534 cli_set_timeout(c
, smbc_getTimeout(context
));
536 status
= smbXcli_negprot(c
->conn
, c
->timeout
,
537 lp_client_min_protocol(),
538 lp_client_max_protocol());
539 if (!NT_STATUS_IS_OK(status
)) {
541 errno
= map_errno_from_nt_status(status
);
545 if (smbXcli_conn_protocol(c
->conn
) >= PROTOCOL_SMB2_02
) {
546 /* Ensure we ask for some initial credits. */
547 smb2cli_conn_set_max_credits(c
->conn
, DEFAULT_SMB2_MAX_CREDITS
);
550 username_used
= *pp_username
;
551 password_used
= *pp_password
;
553 creds
= SMBC_auth_credentials(c
,
564 status
= cli_session_setup_creds(c
, creds
);
565 if (!NT_STATUS_IS_OK(status
)) {
567 /* Failed. Try an anonymous login, if allowed by flags. */
571 if (smbc_getOptionNoAutoAnonymousLogin(context
) ||
572 !NT_STATUS_IS_OK(cli_session_setup_anon(c
))) {
580 DEBUG(4,(" session setup ok\n"));
582 /* here's the fun part....to support 'msdfs proxy' shares
583 (on Samba or windows) we have to issues a TRANS_GET_DFS_REFERRAL
584 here before trying to connect to the original share.
585 cli_check_msdfs_proxy() will fail if it is a normal share. */
587 if (smbXcli_conn_dfs_supported(c
->conn
) &&
588 cli_check_msdfs_proxy(ctx
, c
, share
,
589 &newserver
, &newshare
,
592 srv
= SMBC_server_internal(ctx
, context
, connect_if_not_found
,
593 newserver
, port
, newshare
, pp_workgroup
,
594 pp_username
, pp_password
, in_cache
);
595 TALLOC_FREE(newserver
);
596 TALLOC_FREE(newshare
);
600 /* must be a normal share */
602 status
= cli_tree_connect_creds(c
, share
, "?????", creds
);
603 if (!NT_STATUS_IS_OK(status
)) {
605 errno
= map_errno_from_nt_status(status
);
609 DEBUG(4,(" tconx ok\n"));
611 if (smbXcli_conn_protocol(c
->conn
) >= PROTOCOL_SMB2_02
) {
617 /* Determine if this share supports case sensitivity */
619 DEBUG(4, ("IPC$ so ignore case sensitivity\n"));
620 status
= NT_STATUS_OK
;
622 status
= cli_get_fs_attr_info(c
, &fs_attrs
);
625 if (!NT_STATUS_IS_OK(status
)) {
626 DEBUG(4, ("Could not retrieve case sensitivity flag: %s.\n",
630 * We can't determine the case sensitivity of the share. We
631 * have no choice but to use the user-specified case
632 * sensitivity setting.
634 if (smbc_getOptionCaseSensitive(context
)) {
635 cli_set_case_sensitive(c
, True
);
637 cli_set_case_sensitive(c
, False
);
639 } else if (!is_ipc
) {
640 DEBUG(4, ("Case sensitive: %s\n",
641 (fs_attrs
& FILE_CASE_SENSITIVE_SEARCH
644 smbXcli_tcon_set_fs_attributes(tcon
, fs_attrs
);
648 * Ok, we have got a nice connection
649 * Let's allocate a server structure.
652 srv
= SMB_MALLOC_P(SMBCSRV
);
660 DLIST_ADD(srv
->cli
, c
);
661 srv
->dev
= (dev_t
)(str_checksum(server
) ^ str_checksum(share
));
662 srv
->no_pathinfo
= False
;
663 srv
->no_pathinfo2
= False
;
664 srv
->no_pathinfo3
= False
;
665 srv
->no_nt_session
= False
;
668 if (!pp_workgroup
|| !*pp_workgroup
|| !**pp_workgroup
) {
669 workgroup
= talloc_strdup(ctx
, smbc_getWorkgroup(context
));
671 workgroup
= *pp_workgroup
;
681 /* set the credentials to make DFS work */
682 smbc_set_credentials_with_fallback(context
,
691 SMBC_server(TALLOC_CTX
*ctx
,
693 bool connect_if_not_found
,
702 bool in_cache
= false;
704 srv
= SMBC_server_internal(ctx
, context
, connect_if_not_found
,
705 server
, port
, share
, pp_workgroup
,
706 pp_username
, pp_password
, &in_cache
);
715 /* Now add it to the cache (internal or external) */
716 /* Let the cache function set errno if it wants to */
718 if (smbc_getFunctionAddCachedServer(context
)(context
, srv
,
722 int saved_errno
= errno
;
723 DEBUG(3, (" Failed to add server to cache\n"));
732 DEBUG(2, ("Server connect ok: //%s/%s: %p\n",
733 server
, share
, srv
));
735 DLIST_ADD(context
->internal
->servers
, srv
);
740 * Connect to a server for getting/setting attributes, possibly on an existing
741 * connection. This works similarly to SMBC_server().
744 SMBC_attr_server(TALLOC_CTX
*ctx
,
754 struct cli_state
*ipc_cli
= NULL
;
755 struct rpc_pipe_client
*pipe_hnd
= NULL
;
758 SMBCSRV
*ipc_srv
=NULL
;
761 * Use srv->cli->desthost and srv->cli->share instead of
762 * server and share below to connect to the actual share,
763 * i.e., a normal share or a referred share from
764 * 'msdfs proxy' share.
766 srv
= SMBC_server(ctx
, context
, true, server
, port
, share
,
767 pp_workgroup
, pp_username
, pp_password
);
771 server
= smbXcli_conn_remote_name(srv
->cli
->conn
);
772 share
= srv
->cli
->share
;
775 * See if we've already created this special connection. Reference
776 * our "special" share name '*IPC$', which is an impossible real share
777 * name due to the leading asterisk.
779 ipc_srv
= SMBC_find_server(ctx
, context
, server
, "*IPC$",
780 pp_workgroup
, pp_username
, pp_password
);
782 struct cli_credentials
*creds
= NULL
;
784 /* We didn't find a cached connection. Get the password */
785 if (!*pp_password
|| (*pp_password
)[0] == '\0') {
786 /* ... then retrieve it now. */
787 SMBC_call_auth_fn(ctx
, context
, server
, share
,
791 if (!*pp_workgroup
|| !*pp_username
|| !*pp_password
) {
799 creds
= SMBC_auth_credentials(NULL
,
809 nt_status
= cli_full_connection_creds(&ipc_cli
,
810 lp_netbios_name(), server
,
811 NULL
, 0, "IPC$", "?????",
814 if (! NT_STATUS_IS_OK(nt_status
)) {
816 DEBUG(1,("cli_full_connection failed! (%s)\n",
817 nt_errstr(nt_status
)));
821 talloc_steal(ipc_cli
, creds
);
823 ipc_srv
= SMB_MALLOC_P(SMBCSRV
);
826 cli_shutdown(ipc_cli
);
830 ZERO_STRUCTP(ipc_srv
);
831 DLIST_ADD(ipc_srv
->cli
, ipc_cli
);
833 nt_status
= cli_rpc_pipe_open_noauth(
834 ipc_srv
->cli
, &ndr_table_lsarpc
, &pipe_hnd
);
835 if (!NT_STATUS_IS_OK(nt_status
)) {
836 DEBUG(1, ("cli_nt_session_open fail!\n"));
838 cli_shutdown(ipc_srv
->cli
);
844 * Some systems don't support
845 * SEC_FLAG_MAXIMUM_ALLOWED, but NT sends 0x2000000
846 * so we might as well do it too.
849 nt_status
= rpccli_lsa_open_policy(
853 GENERIC_EXECUTE_ACCESS
,
856 if (!NT_STATUS_IS_OK(nt_status
)) {
857 cli_shutdown(ipc_srv
->cli
);
859 errno
= cli_status_to_errno(nt_status
);
863 /* now add it to the cache (internal or external) */
865 errno
= 0; /* let cache function set errno if it likes */
866 if (smbc_getFunctionAddCachedServer(context
)(context
, ipc_srv
,
871 DEBUG(3, (" Failed to add server to cache\n"));
875 cli_shutdown(ipc_srv
->cli
);
880 DLIST_ADD(context
->internal
->servers
, ipc_srv
);