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
,
48 if (!cli_state_is_connected(server
->cli
)) {
56 * Remove a server from the cached server list it's unused.
57 * On success, 0 is returned. 1 is returned if the server could not be removed.
59 * Also useable outside libsmbclient
62 SMBC_remove_unused_server(SMBCCTX
* context
,
67 /* are we being fooled ? */
68 if (!context
|| !context
->internal
->initialized
|| !srv
) {
72 /* Check all open files/directories for a relation with this server */
73 for (file
= context
->internal
->files
; file
; file
= file
->next
) {
74 if (file
->srv
== srv
) {
76 DEBUG(3, ("smbc_remove_usused_server: "
77 "%p still used by %p.\n",
83 DLIST_REMOVE(context
->internal
->servers
, srv
);
85 cli_shutdown(srv
->cli
);
88 DEBUG(3, ("smbc_remove_usused_server: %p removed.\n", srv
));
90 smbc_getFunctionRemoveCachedServer(context
)(context
, srv
);
96 /****************************************************************
97 * Call the auth_fn with fixed size (fstring) buffers.
98 ***************************************************************/
100 SMBC_call_auth_fn(TALLOC_CTX
*ctx
,
111 smbc_get_auth_data_with_context_fn auth_with_context_fn
;
113 strlcpy(workgroup
, *pp_workgroup
, sizeof(workgroup
));
114 strlcpy(username
, *pp_username
, sizeof(username
));
115 strlcpy(password
, *pp_password
, sizeof(password
));
117 /* See if there's an authentication with context function provided */
118 auth_with_context_fn
= smbc_getFunctionAuthDataWithContext(context
);
119 if (auth_with_context_fn
)
121 (* auth_with_context_fn
)(context
,
123 workgroup
, sizeof(workgroup
),
124 username
, sizeof(username
),
125 password
, sizeof(password
));
129 smbc_getFunctionAuthData(context
)(server
, share
,
130 workgroup
, sizeof(workgroup
),
131 username
, sizeof(username
),
132 password
, sizeof(password
));
135 TALLOC_FREE(*pp_workgroup
);
136 TALLOC_FREE(*pp_username
);
137 TALLOC_FREE(*pp_password
);
139 *pp_workgroup
= talloc_strdup(ctx
, workgroup
);
140 *pp_username
= talloc_strdup(ctx
, username
);
141 *pp_password
= talloc_strdup(ctx
, password
);
146 SMBC_get_auth_data(const char *server
, const char *share
,
147 char *workgroup_buf
, int workgroup_buf_len
,
148 char *username_buf
, int username_buf_len
,
149 char *password_buf
, int password_buf_len
)
151 /* Default function just uses provided data. Nothing to do. */
157 SMBC_find_server(TALLOC_CTX
*ctx
,
168 if (!pp_workgroup
|| !pp_username
|| !pp_password
) {
174 srv
= smbc_getFunctionGetCachedServer(context
)(context
,
179 if (!auth_called
&& !srv
&& (!*pp_username
|| !(*pp_username
)[0] ||
180 !*pp_password
|| !(*pp_password
)[0])) {
181 SMBC_call_auth_fn(ctx
, context
, server
, share
,
182 pp_workgroup
, pp_username
, pp_password
);
185 * However, smbc_auth_fn may have picked up info relating to
186 * an existing connection, so try for an existing connection
190 goto check_server_cache
;
195 if (smbc_getFunctionCheckServer(context
)(context
, srv
)) {
197 * This server is no good anymore
198 * Try to remove it and check for more possible
199 * servers in the cache
201 if (smbc_getFunctionRemoveUnusedServer(context
)(context
,
204 * We could not remove the server completely,
205 * remove it from the cache so we will not get
206 * it again. It will be removed when the last
207 * file/dir is closed.
209 smbc_getFunctionRemoveCachedServer(context
)(context
,
214 * Maybe there are more cached connections to this
217 goto check_server_cache
;
227 * Connect to a server, possibly on an existing connection
229 * Here, what we want to do is: If the server and username
230 * match an existing connection, reuse that, otherwise, establish a
233 * If we have to create a new connection, call the auth_fn to get the
234 * info we need, unless the username and password were passed in.
238 SMBC_server_internal(TALLOC_CTX
*ctx
,
240 bool connect_if_not_found
,
250 char *workgroup
= NULL
;
251 struct cli_state
*c
= NULL
;
252 const char *server_n
= server
;
253 int is_ipc
= (share
!= NULL
&& strcmp(share
, "IPC$") == 0);
255 const char *username_used
;
257 char *newserver
, *newshare
;
259 struct smbXcli_tcon
*tcon
= NULL
;
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
278 share
!= NULL
&& *share
!= '\0' &&
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 (!cli_state_has_tcon(srv
->cli
)) {
297 /* Ensure we have accurate auth info */
298 SMBC_call_auth_fn(ctx
, context
,
299 smbXcli_conn_remote_name(srv
->cli
->conn
),
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_tree_connect(srv
->cli
,
324 strlen(*pp_password
)+1);
325 if (!NT_STATUS_IS_OK(status
)) {
326 errno
= map_errno_from_nt_status(status
);
327 cli_shutdown(srv
->cli
);
329 smbc_getFunctionRemoveCachedServer(context
)(context
,
334 /* Determine if this share supports case sensitivity */
337 ("IPC$ so ignore case sensitivity\n"));
338 status
= NT_STATUS_OK
;
340 status
= cli_get_fs_attr_info(c
, &fs_attrs
);
343 if (!NT_STATUS_IS_OK(status
)) {
344 DEBUG(4, ("Could not retrieve "
345 "case sensitivity flag: %s.\n",
349 * We can't determine the case sensitivity of
350 * the share. We have no choice but to use the
351 * user-specified case sensitivity setting.
353 if (smbc_getOptionCaseSensitive(context
)) {
354 cli_set_case_sensitive(c
, True
);
356 cli_set_case_sensitive(c
, False
);
358 } else if (!is_ipc
) {
360 ("Case sensitive: %s\n",
361 (fs_attrs
& FILE_CASE_SENSITIVE_SEARCH
364 cli_set_case_sensitive(
366 (fs_attrs
& FILE_CASE_SENSITIVE_SEARCH
372 * Regenerate the dev value since it's based on both
376 const char *remote_name
=
377 smbXcli_conn_remote_name(srv
->cli
->conn
);
379 srv
->dev
= (dev_t
)(str_checksum(remote_name
) ^
380 str_checksum(srv
->cli
->share
));
385 /* If we have a connection... */
388 /* ... then we're done here. Give 'em what they came for. */
393 /* If we're not asked to connect when a connection doesn't exist... */
394 if (! connect_if_not_found
) {
395 /* ... then we're done here. */
399 if (!*pp_workgroup
|| !*pp_username
|| !*pp_password
) {
404 DEBUG(4,("SMBC_server: server_n=[%s] server=[%s]\n", server_n
, server
));
406 DEBUG(4,(" -> server_n=[%s] server=[%s]\n", server_n
, server
));
408 status
= NT_STATUS_UNSUCCESSFUL
;
410 if (smbc_getOptionUseKerberos(context
)) {
411 flags
|= CLI_FULL_CONNECTION_USE_KERBEROS
;
414 if (smbc_getOptionFallbackAfterKerberos(context
)) {
415 flags
|= CLI_FULL_CONNECTION_FALLBACK_AFTER_KERBEROS
;
418 if (smbc_getOptionUseCCache(context
)) {
419 flags
|= CLI_FULL_CONNECTION_USE_CCACHE
;
422 if (smbc_getOptionUseNTHash(context
)) {
423 flags
|= CLI_FULL_CONNECTION_USE_NT_HASH
;
427 if (share
== NULL
|| *share
== '\0' || is_ipc
) {
429 * Try 139 first for IPC$
431 status
= cli_connect_nb(server_n
, NULL
, NBT_SMB_PORT
, 0x20,
432 smbc_getNetbiosName(context
),
433 SMB_SIGNING_DEFAULT
, flags
, &c
);
437 if (!NT_STATUS_IS_OK(status
)) {
439 * No IPC$ or 139 did not work
441 status
= cli_connect_nb(server_n
, NULL
, port
, 0x20,
442 smbc_getNetbiosName(context
),
443 SMB_SIGNING_DEFAULT
, flags
, &c
);
446 if (!NT_STATUS_IS_OK(status
)) {
447 errno
= map_errno_from_nt_status(status
);
451 cli_set_timeout(c
, smbc_getTimeout(context
));
453 status
= smbXcli_negprot(c
->conn
, c
->timeout
,
454 lp_client_min_protocol(),
455 lp_client_max_protocol());
456 if (!NT_STATUS_IS_OK(status
)) {
462 username_used
= *pp_username
;
464 if (!NT_STATUS_IS_OK(cli_session_setup(c
, username_used
,
466 strlen(*pp_password
),
468 strlen(*pp_password
),
471 /* Failed. Try an anonymous login, if allowed by flags. */
474 if (smbc_getOptionNoAutoAnonymousLogin(context
) ||
475 !NT_STATUS_IS_OK(cli_session_setup(c
, username_used
,
486 status
= cli_init_creds(c
, username_used
,
487 *pp_workgroup
, *pp_password
);
488 if (!NT_STATUS_IS_OK(status
)) {
489 errno
= map_errno_from_nt_status(status
);
494 DEBUG(4,(" session setup ok\n"));
496 /* here's the fun part....to support 'msdfs proxy' shares
497 (on Samba or windows) we have to issues a TRANS_GET_DFS_REFERRAL
498 here before trying to connect to the original share.
499 cli_check_msdfs_proxy() will fail if it is a normal share. */
501 if (smbXcli_conn_dfs_supported(c
->conn
) &&
502 cli_check_msdfs_proxy(ctx
, c
, share
,
503 &newserver
, &newshare
,
504 /* FIXME: cli_check_msdfs_proxy() does
505 not support smbc_smb_encrypt_level type */
506 context
->internal
->smb_encryption_level
?
512 srv
= SMBC_server_internal(ctx
, context
, connect_if_not_found
,
513 newserver
, port
, newshare
, pp_workgroup
,
514 pp_username
, pp_password
, in_cache
);
515 TALLOC_FREE(newserver
);
516 TALLOC_FREE(newshare
);
520 /* must be a normal share */
522 status
= cli_tree_connect(c
, share
, "?????", *pp_password
,
523 strlen(*pp_password
)+1);
524 if (!NT_STATUS_IS_OK(status
)) {
525 errno
= map_errno_from_nt_status(status
);
530 DEBUG(4,(" tconx ok\n"));
532 if (smbXcli_conn_protocol(c
->conn
) >= PROTOCOL_SMB2_02
) {
538 /* Determine if this share supports case sensitivity */
540 DEBUG(4, ("IPC$ so ignore case sensitivity\n"));
541 status
= NT_STATUS_OK
;
543 status
= cli_get_fs_attr_info(c
, &fs_attrs
);
546 if (!NT_STATUS_IS_OK(status
)) {
547 DEBUG(4, ("Could not retrieve case sensitivity flag: %s.\n",
551 * We can't determine the case sensitivity of the share. We
552 * have no choice but to use the user-specified case
553 * sensitivity setting.
555 if (smbc_getOptionCaseSensitive(context
)) {
556 cli_set_case_sensitive(c
, True
);
558 cli_set_case_sensitive(c
, False
);
560 } else if (!is_ipc
) {
561 DEBUG(4, ("Case sensitive: %s\n",
562 (fs_attrs
& FILE_CASE_SENSITIVE_SEARCH
565 smbXcli_tcon_set_fs_attributes(tcon
, fs_attrs
);
568 if (context
->internal
->smb_encryption_level
) {
569 /* Attempt UNIX smb encryption. */
570 if (!NT_STATUS_IS_OK(cli_force_encryption(c
,
576 * context->smb_encryption_level == 1
577 * means don't fail if encryption can't be negotiated,
578 * == 2 means fail if encryption can't be negotiated.
581 DEBUG(4,(" SMB encrypt failed\n"));
583 if (context
->internal
->smb_encryption_level
== 2) {
589 DEBUG(4,(" SMB encrypt ok\n"));
593 * Ok, we have got a nice connection
594 * Let's allocate a server structure.
597 srv
= SMB_MALLOC_P(SMBCSRV
);
606 srv
->dev
= (dev_t
)(str_checksum(server
) ^ str_checksum(share
));
607 srv
->no_pathinfo
= False
;
608 srv
->no_pathinfo2
= False
;
609 srv
->no_pathinfo3
= False
;
610 srv
->no_nt_session
= False
;
613 if (!pp_workgroup
|| !*pp_workgroup
|| !**pp_workgroup
) {
614 workgroup
= talloc_strdup(ctx
, smbc_getWorkgroup(context
));
616 workgroup
= *pp_workgroup
;
626 /* set the credentials to make DFS work */
627 smbc_set_credentials_with_fallback(context
,
636 SMBC_server(TALLOC_CTX
*ctx
,
638 bool connect_if_not_found
,
647 bool in_cache
= false;
649 srv
= SMBC_server_internal(ctx
, context
, connect_if_not_found
,
650 server
, port
, share
, pp_workgroup
,
651 pp_username
, pp_password
, &in_cache
);
660 /* Now add it to the cache (internal or external) */
661 /* Let the cache function set errno if it wants to */
663 if (smbc_getFunctionAddCachedServer(context
)(context
, srv
,
667 int saved_errno
= errno
;
668 DEBUG(3, (" Failed to add server to cache\n"));
677 DEBUG(2, ("Server connect ok: //%s/%s: %p\n",
678 server
, share
, srv
));
680 DLIST_ADD(context
->internal
->servers
, srv
);
685 * Connect to a server for getting/setting attributes, possibly on an existing
686 * connection. This works similarly to SMBC_server().
689 SMBC_attr_server(TALLOC_CTX
*ctx
,
699 struct cli_state
*ipc_cli
= NULL
;
700 struct rpc_pipe_client
*pipe_hnd
= NULL
;
703 SMBCSRV
*ipc_srv
=NULL
;
706 * Use srv->cli->desthost and srv->cli->share instead of
707 * server and share below to connect to the actual share,
708 * i.e., a normal share or a referred share from
709 * 'msdfs proxy' share.
711 srv
= SMBC_server(ctx
, context
, true, server
, port
, share
,
712 pp_workgroup
, pp_username
, pp_password
);
716 server
= smbXcli_conn_remote_name(srv
->cli
->conn
);
717 share
= srv
->cli
->share
;
720 * See if we've already created this special connection. Reference
721 * our "special" share name '*IPC$', which is an impossible real share
722 * name due to the leading asterisk.
724 ipc_srv
= SMBC_find_server(ctx
, context
, server
, "*IPC$",
725 pp_workgroup
, pp_username
, pp_password
);
728 /* We didn't find a cached connection. Get the password */
729 if (!*pp_password
|| (*pp_password
)[0] == '\0') {
730 /* ... then retrieve it now. */
731 SMBC_call_auth_fn(ctx
, context
, server
, share
,
735 if (!*pp_workgroup
|| !*pp_username
|| !*pp_password
) {
742 if (smbc_getOptionUseKerberos(context
)) {
743 flags
|= CLI_FULL_CONNECTION_USE_KERBEROS
;
745 if (smbc_getOptionUseCCache(context
)) {
746 flags
|= CLI_FULL_CONNECTION_USE_CCACHE
;
749 nt_status
= cli_full_connection(&ipc_cli
,
750 lp_netbios_name(), server
,
751 NULL
, 0, "IPC$", "?????",
756 SMB_SIGNING_DEFAULT
);
757 if (! NT_STATUS_IS_OK(nt_status
)) {
758 DEBUG(1,("cli_full_connection failed! (%s)\n",
759 nt_errstr(nt_status
)));
764 if (context
->internal
->smb_encryption_level
) {
765 /* Attempt UNIX smb encryption. */
766 if (!NT_STATUS_IS_OK(cli_force_encryption(ipc_cli
,
772 * context->smb_encryption_level ==
773 * 1 means don't fail if encryption can't be
774 * negotiated, == 2 means fail if encryption
775 * can't be negotiated.
778 DEBUG(4,(" SMB encrypt failed on IPC$\n"));
780 if (context
->internal
->smb_encryption_level
== 2) {
781 cli_shutdown(ipc_cli
);
786 DEBUG(4,(" SMB encrypt ok on IPC$\n"));
789 ipc_srv
= SMB_MALLOC_P(SMBCSRV
);
792 cli_shutdown(ipc_cli
);
796 ZERO_STRUCTP(ipc_srv
);
797 ipc_srv
->cli
= ipc_cli
;
799 nt_status
= cli_rpc_pipe_open_noauth(
800 ipc_srv
->cli
, &ndr_table_lsarpc
, &pipe_hnd
);
801 if (!NT_STATUS_IS_OK(nt_status
)) {
802 DEBUG(1, ("cli_nt_session_open fail!\n"));
804 cli_shutdown(ipc_srv
->cli
);
810 * Some systems don't support
811 * SEC_FLAG_MAXIMUM_ALLOWED, but NT sends 0x2000000
812 * so we might as well do it too.
815 nt_status
= rpccli_lsa_open_policy(
819 GENERIC_EXECUTE_ACCESS
,
822 if (!NT_STATUS_IS_OK(nt_status
)) {
823 errno
= SMBC_errno(context
, ipc_srv
->cli
);
824 cli_shutdown(ipc_srv
->cli
);
829 /* now add it to the cache (internal or external) */
831 errno
= 0; /* let cache function set errno if it likes */
832 if (smbc_getFunctionAddCachedServer(context
)(context
, ipc_srv
,
837 DEBUG(3, (" Failed to add server to cache\n"));
841 cli_shutdown(ipc_srv
->cli
);
846 DLIST_ADD(context
->internal
->servers
, ipc_srv
);