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
;
260 if (server
[0] == 0) {
265 /* Look for a cached connection */
266 srv
= SMBC_find_server(ctx
, context
, server
, share
,
267 pp_workgroup
, pp_username
, pp_password
);
270 * If we found a connection and we're only allowed one share per
275 smbc_getOptionOneSharePerServer(context
)) {
278 * ... then if there's no current connection to the share,
279 * connect to it. SMBC_find_server(), or rather the function
280 * pointed to by context->get_cached_srv_fn which
281 * was called by SMBC_find_server(), will have issued a tree
282 * disconnect if the requested share is not the same as the
283 * one that was already connected.
287 * Use srv->cli->desthost and srv->cli->share instead of
288 * server and share below to connect to the actual share,
289 * i.e., a normal share or a referred share from
290 * 'msdfs proxy' share.
292 if (!cli_state_has_tcon(srv
->cli
)) {
293 /* Ensure we have accurate auth info */
294 SMBC_call_auth_fn(ctx
, context
,
301 if (!*pp_workgroup
|| !*pp_username
|| !*pp_password
) {
303 cli_shutdown(srv
->cli
);
305 smbc_getFunctionRemoveCachedServer(context
)(context
,
311 * We don't need to renegotiate encryption
312 * here as the encryption context is not per
316 status
= cli_tcon_andx(srv
->cli
, srv
->cli
->share
, "?????",
318 strlen(*pp_password
)+1);
319 if (!NT_STATUS_IS_OK(status
)) {
320 errno
= map_errno_from_nt_status(status
);
321 cli_shutdown(srv
->cli
);
323 smbc_getFunctionRemoveCachedServer(context
)(context
,
328 /* Determine if this share supports case sensitivity */
331 ("IPC$ so ignore case sensitivity\n"));
332 status
= NT_STATUS_OK
;
334 status
= cli_get_fs_attr_info(c
, &fs_attrs
);
337 if (!NT_STATUS_IS_OK(status
)) {
338 DEBUG(4, ("Could not retrieve "
339 "case sensitivity flag: %s.\n",
343 * We can't determine the case sensitivity of
344 * the share. We have no choice but to use the
345 * user-specified case sensitivity setting.
347 if (smbc_getOptionCaseSensitive(context
)) {
348 cli_set_case_sensitive(c
, True
);
350 cli_set_case_sensitive(c
, False
);
352 } else if (!is_ipc
) {
354 ("Case sensitive: %s\n",
355 (fs_attrs
& FILE_CASE_SENSITIVE_SEARCH
358 cli_set_case_sensitive(
360 (fs_attrs
& FILE_CASE_SENSITIVE_SEARCH
366 * Regenerate the dev value since it's based on both
370 srv
->dev
= (dev_t
)(str_checksum(srv
->cli
->desthost
) ^
371 str_checksum(srv
->cli
->share
));
376 /* If we have a connection... */
379 /* ... then we're done here. Give 'em what they came for. */
384 /* If we're not asked to connect when a connection doesn't exist... */
385 if (! connect_if_not_found
) {
386 /* ... then we're done here. */
390 if (!*pp_workgroup
|| !*pp_username
|| !*pp_password
) {
395 DEBUG(4,("SMBC_server: server_n=[%s] server=[%s]\n", server_n
, server
));
397 DEBUG(4,(" -> server_n=[%s] server=[%s]\n", server_n
, server
));
399 status
= NT_STATUS_UNSUCCESSFUL
;
401 if (share
== NULL
|| *share
== '\0' || is_ipc
) {
403 * Try 139 first for IPC$
405 status
= cli_connect_nb(server_n
, NULL
, 139, 0x20,
406 smbc_getNetbiosName(context
),
410 if (!NT_STATUS_IS_OK(status
)) {
412 * No IPC$ or 139 did not work
414 status
= cli_connect_nb(server_n
, NULL
, 0, 0x20,
415 smbc_getNetbiosName(context
),
419 if (!NT_STATUS_IS_OK(status
)) {
420 errno
= map_errno_from_nt_status(status
);
424 if (smbc_getOptionUseKerberos(context
)) {
425 c
->use_kerberos
= True
;
428 if (smbc_getOptionFallbackAfterKerberos(context
)) {
429 c
->fallback_after_kerberos
= True
;
432 if (smbc_getOptionUseCCache(context
)) {
433 c
->use_ccache
= True
;
436 c
->timeout
= smbc_getTimeout(context
);
438 status
= cli_negprot(c
);
440 if (!NT_STATUS_IS_OK(status
)) {
446 username_used
= *pp_username
;
448 if (!NT_STATUS_IS_OK(cli_session_setup(c
, username_used
,
450 strlen(*pp_password
),
452 strlen(*pp_password
),
455 /* Failed. Try an anonymous login, if allowed by flags. */
458 if (smbc_getOptionNoAutoAnonymousLogin(context
) ||
459 !NT_STATUS_IS_OK(cli_session_setup(c
, username_used
,
470 status
= cli_init_creds(c
, username_used
,
471 *pp_workgroup
, *pp_password
);
472 if (!NT_STATUS_IS_OK(status
)) {
473 errno
= map_errno_from_nt_status(status
);
478 DEBUG(4,(" session setup ok\n"));
480 /* here's the fun part....to support 'msdfs proxy' shares
481 (on Samba or windows) we have to issues a TRANS_GET_DFS_REFERRAL
482 here before trying to connect to the original share.
483 cli_check_msdfs_proxy() will fail if it is a normal share. */
485 if ((c
->capabilities
& CAP_DFS
) &&
486 cli_check_msdfs_proxy(ctx
, c
, share
,
487 &newserver
, &newshare
,
488 /* FIXME: cli_check_msdfs_proxy() does
489 not support smbc_smb_encrypt_level type */
490 context
->internal
->smb_encryption_level
?
496 srv
= SMBC_server_internal(ctx
, context
, connect_if_not_found
,
497 newserver
, newshare
, pp_workgroup
,
498 pp_username
, pp_password
, in_cache
);
499 TALLOC_FREE(newserver
);
500 TALLOC_FREE(newshare
);
504 /* must be a normal share */
506 status
= cli_tcon_andx(c
, share
, "?????", *pp_password
,
507 strlen(*pp_password
)+1);
508 if (!NT_STATUS_IS_OK(status
)) {
509 errno
= map_errno_from_nt_status(status
);
514 DEBUG(4,(" tconx ok\n"));
516 /* Determine if this share supports case sensitivity */
518 DEBUG(4, ("IPC$ so ignore case sensitivity\n"));
519 status
= NT_STATUS_OK
;
521 status
= cli_get_fs_attr_info(c
, &fs_attrs
);
524 if (!NT_STATUS_IS_OK(status
)) {
525 DEBUG(4, ("Could not retrieve case sensitivity flag: %s.\n",
529 * We can't determine the case sensitivity of the share. We
530 * have no choice but to use the user-specified case
531 * sensitivity setting.
533 if (smbc_getOptionCaseSensitive(context
)) {
534 cli_set_case_sensitive(c
, True
);
536 cli_set_case_sensitive(c
, False
);
538 } else if (!is_ipc
) {
539 DEBUG(4, ("Case sensitive: %s\n",
540 (fs_attrs
& FILE_CASE_SENSITIVE_SEARCH
543 cli_set_case_sensitive(c
,
544 (fs_attrs
& FILE_CASE_SENSITIVE_SEARCH
549 if (context
->internal
->smb_encryption_level
) {
550 /* Attempt UNIX smb encryption. */
551 if (!NT_STATUS_IS_OK(cli_force_encryption(c
,
557 * context->smb_encryption_level == 1
558 * means don't fail if encryption can't be negotiated,
559 * == 2 means fail if encryption can't be negotiated.
562 DEBUG(4,(" SMB encrypt failed\n"));
564 if (context
->internal
->smb_encryption_level
== 2) {
570 DEBUG(4,(" SMB encrypt ok\n"));
574 * Ok, we have got a nice connection
575 * Let's allocate a server structure.
578 srv
= SMB_MALLOC_P(SMBCSRV
);
587 srv
->dev
= (dev_t
)(str_checksum(server
) ^ str_checksum(share
));
588 srv
->no_pathinfo
= False
;
589 srv
->no_pathinfo2
= False
;
590 srv
->no_nt_session
= False
;
593 if (!pp_workgroup
|| !*pp_workgroup
|| !**pp_workgroup
) {
594 workgroup
= talloc_strdup(ctx
, smbc_getWorkgroup(context
));
596 workgroup
= *pp_workgroup
;
606 /* set the credentials to make DFS work */
607 smbc_set_credentials_with_fallback(context
,
616 SMBC_server(TALLOC_CTX
*ctx
,
618 bool connect_if_not_found
,
626 bool in_cache
= false;
628 srv
= SMBC_server_internal(ctx
, context
, connect_if_not_found
,
629 server
, share
, pp_workgroup
,
630 pp_username
, pp_password
, &in_cache
);
639 /* Now add it to the cache (internal or external) */
640 /* Let the cache function set errno if it wants to */
642 if (smbc_getFunctionAddCachedServer(context
)(context
, srv
,
646 int saved_errno
= errno
;
647 DEBUG(3, (" Failed to add server to cache\n"));
656 DEBUG(2, ("Server connect ok: //%s/%s: %p\n",
657 server
, share
, srv
));
659 DLIST_ADD(context
->internal
->servers
, srv
);
664 * Connect to a server for getting/setting attributes, possibly on an existing
665 * connection. This works similarly to SMBC_server().
668 SMBC_attr_server(TALLOC_CTX
*ctx
,
677 struct sockaddr_storage ss
;
678 struct cli_state
*ipc_cli
= NULL
;
679 struct rpc_pipe_client
*pipe_hnd
= NULL
;
682 SMBCSRV
*ipc_srv
=NULL
;
685 * Use srv->cli->desthost and srv->cli->share instead of
686 * server and share below to connect to the actual share,
687 * i.e., a normal share or a referred share from
688 * 'msdfs proxy' share.
690 srv
= SMBC_server(ctx
, context
, true, server
, share
,
691 pp_workgroup
, pp_username
, pp_password
);
695 server
= srv
->cli
->desthost
;
696 share
= srv
->cli
->share
;
699 * See if we've already created this special connection. Reference
700 * our "special" share name '*IPC$', which is an impossible real share
701 * name due to the leading asterisk.
703 ipc_srv
= SMBC_find_server(ctx
, context
, server
, "*IPC$",
704 pp_workgroup
, pp_username
, pp_password
);
707 /* We didn't find a cached connection. Get the password */
708 if (!*pp_password
|| (*pp_password
)[0] == '\0') {
709 /* ... then retrieve it now. */
710 SMBC_call_auth_fn(ctx
, context
, server
, share
,
714 if (!*pp_workgroup
|| !*pp_username
|| !*pp_password
) {
721 if (smbc_getOptionUseKerberos(context
)) {
722 flags
|= CLI_FULL_CONNECTION_USE_KERBEROS
;
724 if (smbc_getOptionUseCCache(context
)) {
725 flags
|= CLI_FULL_CONNECTION_USE_CCACHE
;
729 nt_status
= cli_full_connection(&ipc_cli
,
730 lp_netbios_name(), server
,
731 &ss
, 0, "IPC$", "?????",
737 if (! NT_STATUS_IS_OK(nt_status
)) {
738 DEBUG(1,("cli_full_connection failed! (%s)\n",
739 nt_errstr(nt_status
)));
744 if (context
->internal
->smb_encryption_level
) {
745 /* Attempt UNIX smb encryption. */
746 if (!NT_STATUS_IS_OK(cli_force_encryption(ipc_cli
,
752 * context->smb_encryption_level ==
753 * 1 means don't fail if encryption can't be
754 * negotiated, == 2 means fail if encryption
755 * can't be negotiated.
758 DEBUG(4,(" SMB encrypt failed on IPC$\n"));
760 if (context
->internal
->smb_encryption_level
== 2) {
761 cli_shutdown(ipc_cli
);
766 DEBUG(4,(" SMB encrypt ok on IPC$\n"));
769 ipc_srv
= SMB_MALLOC_P(SMBCSRV
);
772 cli_shutdown(ipc_cli
);
776 ZERO_STRUCTP(ipc_srv
);
777 ipc_srv
->cli
= ipc_cli
;
779 nt_status
= cli_rpc_pipe_open_noauth(
780 ipc_srv
->cli
, &ndr_table_lsarpc
.syntax_id
, &pipe_hnd
);
781 if (!NT_STATUS_IS_OK(nt_status
)) {
782 DEBUG(1, ("cli_nt_session_open fail!\n"));
784 cli_shutdown(ipc_srv
->cli
);
790 * Some systems don't support
791 * SEC_FLAG_MAXIMUM_ALLOWED, but NT sends 0x2000000
792 * so we might as well do it too.
795 nt_status
= rpccli_lsa_open_policy(
799 GENERIC_EXECUTE_ACCESS
,
802 if (!NT_STATUS_IS_OK(nt_status
)) {
803 errno
= SMBC_errno(context
, ipc_srv
->cli
);
804 cli_shutdown(ipc_srv
->cli
);
808 /* now add it to the cache (internal or external) */
810 errno
= 0; /* let cache function set errno if it likes */
811 if (smbc_getFunctionAddCachedServer(context
)(context
, ipc_srv
,
816 DEBUG(3, (" Failed to add server to cache\n"));
820 cli_shutdown(ipc_srv
->cli
);
825 DLIST_ADD(context
->internal
->servers
, ipc_srv
);