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 "libsmbclient.h"
28 #include "libsmb_internal.h"
29 #include "../librpc/gen_ndr/ndr_lsa.h"
30 #include "rpc_client/cli_lsarpc.h"
31 #include "libcli/security/security.h"
34 * Check a server for being alive and well.
35 * returns 0 if the server is in shape. Returns 1 on error
37 * Also useable outside libsmbclient to enable external cache
38 * to do some checks too.
41 SMBC_check_server(SMBCCTX
* context
,
48 return (getpeername(server
->cli
->fd
, &addr
, &size
) == -1);
52 * Remove a server from the cached server list it's unused.
53 * On success, 0 is returned. 1 is returned if the server could not be removed.
55 * Also useable outside libsmbclient
58 SMBC_remove_unused_server(SMBCCTX
* context
,
63 /* are we being fooled ? */
64 if (!context
|| !context
->internal
->initialized
|| !srv
) {
68 /* Check all open files/directories for a relation with this server */
69 for (file
= context
->internal
->files
; file
; file
= file
->next
) {
70 if (file
->srv
== srv
) {
72 DEBUG(3, ("smbc_remove_usused_server: "
73 "%p still used by %p.\n",
79 DLIST_REMOVE(context
->internal
->servers
, srv
);
81 cli_shutdown(srv
->cli
);
84 DEBUG(3, ("smbc_remove_usused_server: %p removed.\n", srv
));
86 smbc_getFunctionRemoveCachedServer(context
)(context
, srv
);
92 /****************************************************************
93 * Call the auth_fn with fixed size (fstring) buffers.
94 ***************************************************************/
96 SMBC_call_auth_fn(TALLOC_CTX
*ctx
,
107 smbc_get_auth_data_with_context_fn auth_with_context_fn
;
109 strlcpy(workgroup
, *pp_workgroup
, sizeof(workgroup
));
110 strlcpy(username
, *pp_username
, sizeof(username
));
111 strlcpy(password
, *pp_password
, sizeof(password
));
113 /* See if there's an authentication with context function provided */
114 auth_with_context_fn
= smbc_getFunctionAuthDataWithContext(context
);
115 if (auth_with_context_fn
)
117 (* auth_with_context_fn
)(context
,
119 workgroup
, sizeof(workgroup
),
120 username
, sizeof(username
),
121 password
, sizeof(password
));
125 smbc_getFunctionAuthData(context
)(server
, share
,
126 workgroup
, sizeof(workgroup
),
127 username
, sizeof(username
),
128 password
, sizeof(password
));
131 TALLOC_FREE(*pp_workgroup
);
132 TALLOC_FREE(*pp_username
);
133 TALLOC_FREE(*pp_password
);
135 *pp_workgroup
= talloc_strdup(ctx
, workgroup
);
136 *pp_username
= talloc_strdup(ctx
, username
);
137 *pp_password
= talloc_strdup(ctx
, password
);
142 SMBC_get_auth_data(const char *server
, const char *share
,
143 char *workgroup_buf
, int workgroup_buf_len
,
144 char *username_buf
, int username_buf_len
,
145 char *password_buf
, int password_buf_len
)
147 /* Default function just uses provided data. Nothing to do. */
153 SMBC_find_server(TALLOC_CTX
*ctx
,
164 if (!pp_workgroup
|| !pp_username
|| !pp_password
) {
170 srv
= smbc_getFunctionGetCachedServer(context
)(context
,
175 if (!auth_called
&& !srv
&& (!*pp_username
|| !(*pp_username
)[0] ||
176 !*pp_password
|| !(*pp_password
)[0])) {
177 SMBC_call_auth_fn(ctx
, context
, server
, share
,
178 pp_workgroup
, pp_username
, pp_password
);
181 * However, smbc_auth_fn may have picked up info relating to
182 * an existing connection, so try for an existing connection
186 goto check_server_cache
;
191 if (smbc_getFunctionCheckServer(context
)(context
, srv
)) {
193 * This server is no good anymore
194 * Try to remove it and check for more possible
195 * servers in the cache
197 if (smbc_getFunctionRemoveUnusedServer(context
)(context
,
200 * We could not remove the server completely,
201 * remove it from the cache so we will not get
202 * it again. It will be removed when the last
203 * file/dir is closed.
205 smbc_getFunctionRemoveCachedServer(context
)(context
,
210 * Maybe there are more cached connections to this
213 goto check_server_cache
;
223 * Connect to a server, possibly on an existing connection
225 * Here, what we want to do is: If the server and username
226 * match an existing connection, reuse that, otherwise, establish a
229 * If we have to create a new connection, call the auth_fn to get the
230 * info we need, unless the username and password were passed in.
234 SMBC_server_internal(TALLOC_CTX
*ctx
,
236 bool connect_if_not_found
,
245 char *workgroup
= NULL
;
247 struct nmb_name called
, calling
;
248 const char *server_n
= server
;
249 struct sockaddr_storage ss
;
250 int tried_reverse
= 0;
253 int is_ipc
= (share
!= NULL
&& strcmp(share
, "IPC$") == 0);
255 const char *username_used
;
257 char *newserver
, *newshare
;
263 if (server
[0] == 0) {
268 /* Look for a cached connection */
269 srv
= SMBC_find_server(ctx
, context
, server
, share
,
270 pp_workgroup
, pp_username
, pp_password
);
273 * If we found a connection and we're only allowed one share per
278 smbc_getOptionOneSharePerServer(context
)) {
281 * ... then if there's no current connection to the share,
282 * connect to it. SMBC_find_server(), or rather the function
283 * pointed to by context->get_cached_srv_fn which
284 * was called by SMBC_find_server(), will have issued a tree
285 * disconnect if the requested share is not the same as the
286 * one that was already connected.
290 * Use srv->cli->desthost and srv->cli->share instead of
291 * server and share below to connect to the actual share,
292 * i.e., a normal share or a referred share from
293 * 'msdfs proxy' share.
295 if (srv
->cli
->cnum
== (uint16
) -1) {
296 /* Ensure we have accurate auth info */
297 SMBC_call_auth_fn(ctx
, context
,
304 if (!*pp_workgroup
|| !*pp_username
|| !*pp_password
) {
306 cli_shutdown(srv
->cli
);
308 smbc_getFunctionRemoveCachedServer(context
)(context
,
314 * We don't need to renegotiate encryption
315 * here as the encryption context is not per
319 status
= cli_tcon_andx(srv
->cli
, srv
->cli
->share
, "?????",
321 strlen(*pp_password
)+1);
322 if (!NT_STATUS_IS_OK(status
)) {
323 errno
= map_errno_from_nt_status(status
);
324 cli_shutdown(srv
->cli
);
326 smbc_getFunctionRemoveCachedServer(context
)(context
,
331 /* Determine if this share supports case sensitivity */
334 ("IPC$ so ignore case sensitivity\n"));
335 } else if (!NT_STATUS_IS_OK(cli_get_fs_attr_info(c
, &fs_attrs
))) {
336 DEBUG(4, ("Could not retrieve "
337 "case sensitivity flag: %s.\n",
341 * We can't determine the case sensitivity of
342 * the share. We have no choice but to use the
343 * user-specified case sensitivity setting.
345 if (smbc_getOptionCaseSensitive(context
)) {
346 cli_set_case_sensitive(c
, True
);
348 cli_set_case_sensitive(c
, False
);
352 ("Case sensitive: %s\n",
353 (fs_attrs
& FILE_CASE_SENSITIVE_SEARCH
356 cli_set_case_sensitive(
358 (fs_attrs
& FILE_CASE_SENSITIVE_SEARCH
364 * Regenerate the dev value since it's based on both
368 srv
->dev
= (dev_t
)(str_checksum(srv
->cli
->desthost
) ^
369 str_checksum(srv
->cli
->share
));
374 /* If we have a connection... */
377 /* ... then we're done here. Give 'em what they came for. */
382 /* If we're not asked to connect when a connection doesn't exist... */
383 if (! connect_if_not_found
) {
384 /* ... then we're done here. */
388 if (!*pp_workgroup
|| !*pp_username
|| !*pp_password
) {
393 make_nmb_name(&calling
, smbc_getNetbiosName(context
), 0x0);
394 make_nmb_name(&called
, server
, 0x20);
396 DEBUG(4,("SMBC_server: server_n=[%s] server=[%s]\n", server_n
, server
));
398 DEBUG(4,(" -> server_n=[%s] server=[%s]\n", server_n
, server
));
404 /* have to open a new connection */
405 if ((c
= cli_initialise()) == NULL
) {
410 if (smbc_getOptionUseKerberos(context
)) {
411 c
->use_kerberos
= True
;
414 if (smbc_getOptionFallbackAfterKerberos(context
)) {
415 c
->fallback_after_kerberos
= True
;
418 if (smbc_getOptionUseCCache(context
)) {
419 c
->use_ccache
= True
;
422 c
->timeout
= smbc_getTimeout(context
);
425 * Force use of port 139 for first try if share is $IPC, empty, or
426 * null, so browse lists can work
428 if (share
== NULL
|| *share
== '\0' || is_ipc
) {
429 port_try_first
= 139;
432 port_try_first
= 445;
436 c
->port
= port_try_first
;
438 status
= cli_connect(c
, server_n
, &ss
);
439 if (!NT_STATUS_IS_OK(status
)) {
441 /* First connection attempt failed. Try alternate port. */
442 c
->port
= port_try_next
;
444 status
= cli_connect(c
, server_n
, &ss
);
445 if (!NT_STATUS_IS_OK(status
)) {
452 if (!cli_session_request(c
, &calling
, &called
)) {
454 if (strcmp(called
.name
, "*SMBSERVER")) {
455 make_nmb_name(&called
, "*SMBSERVER", 0x20);
457 } else { /* Try one more time, but ensure we don't loop */
459 /* Only try this if server is an IP address ... */
461 if (is_ipaddress(server
) && !tried_reverse
) {
463 struct sockaddr_storage rem_ss
;
465 if (!interpret_string_addr(&rem_ss
, server
,
467 DEBUG(4, ("Could not convert IP address "
468 "%s to struct sockaddr_storage\n",
474 tried_reverse
++; /* Yuck */
476 if (name_status_find("*", 0, 0,
477 &rem_ss
, remote_name
)) {
478 make_nmb_name(&called
,
489 DEBUG(4,(" session request ok\n"));
491 status
= cli_negprot(c
);
493 if (!NT_STATUS_IS_OK(status
)) {
499 username_used
= *pp_username
;
501 if (!NT_STATUS_IS_OK(cli_session_setup(c
, username_used
,
503 strlen(*pp_password
),
505 strlen(*pp_password
),
508 /* Failed. Try an anonymous login, if allowed by flags. */
511 if (smbc_getOptionNoAutoAnonymousLogin(context
) ||
512 !NT_STATUS_IS_OK(cli_session_setup(c
, username_used
,
523 status
= cli_init_creds(c
, username_used
,
524 *pp_workgroup
, *pp_password
);
525 if (!NT_STATUS_IS_OK(status
)) {
526 errno
= map_errno_from_nt_status(status
);
531 DEBUG(4,(" session setup ok\n"));
533 /* here's the fun part....to support 'msdfs proxy' shares
534 (on Samba or windows) we have to issues a TRANS_GET_DFS_REFERRAL
535 here before trying to connect to the original share.
536 cli_check_msdfs_proxy() will fail if it is a normal share. */
538 if ((c
->capabilities
& CAP_DFS
) &&
539 cli_check_msdfs_proxy(ctx
, c
, share
,
540 &newserver
, &newshare
,
541 /* FIXME: cli_check_msdfs_proxy() does
542 not support smbc_smb_encrypt_level type */
543 context
->internal
->smb_encryption_level
?
549 srv
= SMBC_server_internal(ctx
, context
, connect_if_not_found
,
550 newserver
, newshare
, pp_workgroup
,
551 pp_username
, pp_password
, in_cache
);
552 TALLOC_FREE(newserver
);
553 TALLOC_FREE(newshare
);
557 /* must be a normal share */
559 status
= cli_tcon_andx(c
, share
, "?????", *pp_password
,
560 strlen(*pp_password
)+1);
561 if (!NT_STATUS_IS_OK(status
)) {
562 errno
= map_errno_from_nt_status(status
);
567 DEBUG(4,(" tconx ok\n"));
569 /* Determine if this share supports case sensitivity */
571 DEBUG(4, ("IPC$ so ignore case sensitivity\n"));
572 } else if (!NT_STATUS_IS_OK(cli_get_fs_attr_info(c
, &fs_attrs
))) {
573 DEBUG(4, ("Could not retrieve case sensitivity flag: %s.\n",
577 * We can't determine the case sensitivity of the share. We
578 * have no choice but to use the user-specified case
579 * sensitivity setting.
581 if (smbc_getOptionCaseSensitive(context
)) {
582 cli_set_case_sensitive(c
, True
);
584 cli_set_case_sensitive(c
, False
);
587 DEBUG(4, ("Case sensitive: %s\n",
588 (fs_attrs
& FILE_CASE_SENSITIVE_SEARCH
591 cli_set_case_sensitive(c
,
592 (fs_attrs
& FILE_CASE_SENSITIVE_SEARCH
597 if (context
->internal
->smb_encryption_level
) {
598 /* Attempt UNIX smb encryption. */
599 if (!NT_STATUS_IS_OK(cli_force_encryption(c
,
605 * context->smb_encryption_level == 1
606 * means don't fail if encryption can't be negotiated,
607 * == 2 means fail if encryption can't be negotiated.
610 DEBUG(4,(" SMB encrypt failed\n"));
612 if (context
->internal
->smb_encryption_level
== 2) {
618 DEBUG(4,(" SMB encrypt ok\n"));
622 * Ok, we have got a nice connection
623 * Let's allocate a server structure.
626 srv
= SMB_MALLOC_P(SMBCSRV
);
635 srv
->dev
= (dev_t
)(str_checksum(server
) ^ str_checksum(share
));
636 srv
->no_pathinfo
= False
;
637 srv
->no_pathinfo2
= False
;
638 srv
->no_nt_session
= False
;
641 if (!pp_workgroup
|| !*pp_workgroup
|| !**pp_workgroup
) {
642 workgroup
= talloc_strdup(ctx
, smbc_getWorkgroup(context
));
644 workgroup
= *pp_workgroup
;
650 /* set the credentials to make DFS work */
651 smbc_set_credentials_with_fallback(context
,
660 SMBC_server(TALLOC_CTX
*ctx
,
662 bool connect_if_not_found
,
670 bool in_cache
= false;
672 srv
= SMBC_server_internal(ctx
, context
, connect_if_not_found
,
673 server
, share
, pp_workgroup
,
674 pp_username
, pp_password
, &in_cache
);
683 /* Now add it to the cache (internal or external) */
684 /* Let the cache function set errno if it wants to */
686 if (smbc_getFunctionAddCachedServer(context
)(context
, srv
,
690 int saved_errno
= errno
;
691 DEBUG(3, (" Failed to add server to cache\n"));
700 DEBUG(2, ("Server connect ok: //%s/%s: %p\n",
701 server
, share
, srv
));
703 DLIST_ADD(context
->internal
->servers
, srv
);
708 * Connect to a server for getting/setting attributes, possibly on an existing
709 * connection. This works similarly to SMBC_server().
712 SMBC_attr_server(TALLOC_CTX
*ctx
,
721 struct sockaddr_storage ss
;
722 struct cli_state
*ipc_cli
= NULL
;
723 struct rpc_pipe_client
*pipe_hnd
= NULL
;
726 SMBCSRV
*ipc_srv
=NULL
;
729 * Use srv->cli->desthost and srv->cli->share instead of
730 * server and share below to connect to the actual share,
731 * i.e., a normal share or a referred share from
732 * 'msdfs proxy' share.
734 srv
= SMBC_server(ctx
, context
, true, server
, share
,
735 pp_workgroup
, pp_username
, pp_password
);
739 server
= srv
->cli
->desthost
;
740 share
= srv
->cli
->share
;
743 * See if we've already created this special connection. Reference
744 * our "special" share name '*IPC$', which is an impossible real share
745 * name due to the leading asterisk.
747 ipc_srv
= SMBC_find_server(ctx
, context
, server
, "*IPC$",
748 pp_workgroup
, pp_username
, pp_password
);
751 /* We didn't find a cached connection. Get the password */
752 if (!*pp_password
|| (*pp_password
)[0] == '\0') {
753 /* ... then retrieve it now. */
754 SMBC_call_auth_fn(ctx
, context
, server
, share
,
758 if (!*pp_workgroup
|| !*pp_username
|| !*pp_password
) {
765 if (smbc_getOptionUseKerberos(context
)) {
766 flags
|= CLI_FULL_CONNECTION_USE_KERBEROS
;
768 if (smbc_getOptionUseCCache(context
)) {
769 flags
|= CLI_FULL_CONNECTION_USE_CCACHE
;
773 nt_status
= cli_full_connection(&ipc_cli
,
774 global_myname(), server
,
775 &ss
, 0, "IPC$", "?????",
781 if (! NT_STATUS_IS_OK(nt_status
)) {
782 DEBUG(1,("cli_full_connection failed! (%s)\n",
783 nt_errstr(nt_status
)));
788 if (context
->internal
->smb_encryption_level
) {
789 /* Attempt UNIX smb encryption. */
790 if (!NT_STATUS_IS_OK(cli_force_encryption(ipc_cli
,
796 * context->smb_encryption_level ==
797 * 1 means don't fail if encryption can't be
798 * negotiated, == 2 means fail if encryption
799 * can't be negotiated.
802 DEBUG(4,(" SMB encrypt failed on IPC$\n"));
804 if (context
->internal
->smb_encryption_level
== 2) {
805 cli_shutdown(ipc_cli
);
810 DEBUG(4,(" SMB encrypt ok on IPC$\n"));
813 ipc_srv
= SMB_MALLOC_P(SMBCSRV
);
816 cli_shutdown(ipc_cli
);
820 ZERO_STRUCTP(ipc_srv
);
821 ipc_srv
->cli
= ipc_cli
;
823 nt_status
= cli_rpc_pipe_open_noauth(
824 ipc_srv
->cli
, &ndr_table_lsarpc
.syntax_id
, &pipe_hnd
);
825 if (!NT_STATUS_IS_OK(nt_status
)) {
826 DEBUG(1, ("cli_nt_session_open fail!\n"));
828 cli_shutdown(ipc_srv
->cli
);
834 * Some systems don't support
835 * SEC_FLAG_MAXIMUM_ALLOWED, but NT sends 0x2000000
836 * so we might as well do it too.
839 nt_status
= rpccli_lsa_open_policy(
843 GENERIC_EXECUTE_ACCESS
,
846 if (!NT_STATUS_IS_OK(nt_status
)) {
847 errno
= SMBC_errno(context
, ipc_srv
->cli
);
848 cli_shutdown(ipc_srv
->cli
);
852 /* now add it to the cache (internal or external) */
854 errno
= 0; /* let cache function set errno if it likes */
855 if (smbc_getFunctionAddCachedServer(context
)(context
, ipc_srv
,
860 DEBUG(3, (" Failed to add server to cache\n"));
864 cli_shutdown(ipc_srv
->cli
);
869 DLIST_ADD(context
->internal
->servers
, ipc_srv
);