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
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 3 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 GNU General Public License for more details.
21 You should have received a copy of the GNU General Public License
22 along with this program. If not, see <http://www.gnu.org/licenses/>.
26 #include "libsmb/libsmb.h"
27 #include "libsmbclient.h"
28 #include "libsmb_internal.h"
33 * Is the logging working / configfile read ?
35 static bool SMBC_initialized
= false;
36 static unsigned int initialized_ctx_count
= 0;
37 static void *initialized_ctx_count_mutex
= NULL
;
40 * Do some module- and library-wide intializations
43 SMBC_module_init(void * punused
)
45 bool conf_loaded
= False
;
47 TALLOC_CTX
*frame
= talloc_stackframe();
49 load_case_tables_library();
51 setup_logging("libsmbclient", DEBUG_STDOUT
);
53 /* Here we would open the smb.conf file if needed ... */
55 lp_set_in_client(True
);
57 home
= getenv("HOME");
60 if (asprintf(&conf
, "%s/.smb/smb.conf", home
) > 0) {
61 if (lp_load(conf
, True
, False
, False
, True
)) {
64 DEBUG(5, ("Could not load config file: %s\n",
73 * Well, if that failed, try the get_dyn_CONFIGFILE
74 * Which points to the standard locn, and if that
75 * fails, silently ignore it and use the internal
79 if (!lp_load(get_dyn_CONFIGFILE(), True
, False
, False
, True
)) {
80 DEBUG(5, ("Could not load config file: %s\n",
81 get_dyn_CONFIGFILE()));
85 * We loaded the global config file. Now lets
86 * load user-specific modifications to the
90 "%s/.smb/smb.conf.append",
92 if (!lp_load(conf
, True
, False
, False
, False
)) {
94 ("Could not append config file: "
103 load_interfaces(); /* Load the list of interfaces ... */
105 reopen_logs(); /* Get logging working ... */
108 * Block SIGPIPE (from lib/util_sock.c: write())
109 * It is not needed and should not stop execution
111 BlockSignals(True
, SIGPIPE
);
113 /* Create the mutex we'll use to protect initialized_ctx_count */
114 if (SMB_THREAD_CREATE_MUTEX("initialized_ctx_count_mutex",
115 initialized_ctx_count_mutex
) != 0) {
116 smb_panic("SMBC_module_init: "
117 "failed to create 'initialized_ctx_count' mutex");
126 SMBC_module_terminate(void)
130 SMBC_initialized
= false;
135 * Get a new empty handle to fill in with your own info
138 smbc_new_context(void)
142 /* The first call to this function should initialize the module */
143 SMB_THREAD_ONCE(&SMBC_initialized
, SMBC_module_init
, NULL
);
146 * All newly added context fields should be placed in
147 * SMBC_internal_data, not directly in SMBCCTX.
149 context
= SMB_MALLOC_P(SMBCCTX
);
155 ZERO_STRUCTP(context
);
157 context
->internal
= SMB_MALLOC_P(struct SMBC_internal_data
);
158 if (!context
->internal
) {
164 /* Initialize the context and establish reasonable defaults */
165 ZERO_STRUCTP(context
->internal
);
167 smbc_setDebug(context
, 0);
168 smbc_setTimeout(context
, 20000);
170 smbc_setOptionFullTimeNames(context
, False
);
171 smbc_setOptionOpenShareMode(context
, SMBC_SHAREMODE_DENY_NONE
);
172 smbc_setOptionSmbEncryptionLevel(context
, SMBC_ENCRYPTLEVEL_NONE
);
173 smbc_setOptionUseCCache(context
, True
);
174 smbc_setOptionCaseSensitive(context
, False
);
175 smbc_setOptionBrowseMaxLmbCount(context
, 3); /* # LMBs to query */
176 smbc_setOptionUrlEncodeReaddirEntries(context
, False
);
177 smbc_setOptionOneSharePerServer(context
, False
);
178 if (getenv("LIBSMBCLIENT_NO_CCACHE") == NULL
) {
179 smbc_setOptionUseCCache(context
, true);
182 smbc_setFunctionAuthData(context
, SMBC_get_auth_data
);
183 smbc_setFunctionCheckServer(context
, SMBC_check_server
);
184 smbc_setFunctionRemoveUnusedServer(context
, SMBC_remove_unused_server
);
186 smbc_setOptionUserData(context
, NULL
);
187 smbc_setFunctionAddCachedServer(context
, SMBC_add_cached_server
);
188 smbc_setFunctionGetCachedServer(context
, SMBC_get_cached_server
);
189 smbc_setFunctionRemoveCachedServer(context
, SMBC_remove_cached_server
);
190 smbc_setFunctionPurgeCachedServers(context
, SMBC_purge_cached_servers
);
192 smbc_setFunctionOpen(context
, SMBC_open_ctx
);
193 smbc_setFunctionCreat(context
, SMBC_creat_ctx
);
194 smbc_setFunctionRead(context
, SMBC_read_ctx
);
195 smbc_setFunctionWrite(context
, SMBC_write_ctx
);
196 smbc_setFunctionClose(context
, SMBC_close_ctx
);
197 smbc_setFunctionUnlink(context
, SMBC_unlink_ctx
);
198 smbc_setFunctionRename(context
, SMBC_rename_ctx
);
199 smbc_setFunctionLseek(context
, SMBC_lseek_ctx
);
200 smbc_setFunctionFtruncate(context
, SMBC_ftruncate_ctx
);
201 smbc_setFunctionStat(context
, SMBC_stat_ctx
);
202 smbc_setFunctionStatVFS(context
, SMBC_statvfs_ctx
);
203 smbc_setFunctionFstatVFS(context
, SMBC_fstatvfs_ctx
);
204 smbc_setFunctionFstat(context
, SMBC_fstat_ctx
);
205 smbc_setFunctionOpendir(context
, SMBC_opendir_ctx
);
206 smbc_setFunctionClosedir(context
, SMBC_closedir_ctx
);
207 smbc_setFunctionReaddir(context
, SMBC_readdir_ctx
);
208 smbc_setFunctionGetdents(context
, SMBC_getdents_ctx
);
209 smbc_setFunctionMkdir(context
, SMBC_mkdir_ctx
);
210 smbc_setFunctionRmdir(context
, SMBC_rmdir_ctx
);
211 smbc_setFunctionTelldir(context
, SMBC_telldir_ctx
);
212 smbc_setFunctionLseekdir(context
, SMBC_lseekdir_ctx
);
213 smbc_setFunctionFstatdir(context
, SMBC_fstatdir_ctx
);
214 smbc_setFunctionChmod(context
, SMBC_chmod_ctx
);
215 smbc_setFunctionUtimes(context
, SMBC_utimes_ctx
);
216 smbc_setFunctionSetxattr(context
, SMBC_setxattr_ctx
);
217 smbc_setFunctionGetxattr(context
, SMBC_getxattr_ctx
);
218 smbc_setFunctionRemovexattr(context
, SMBC_removexattr_ctx
);
219 smbc_setFunctionListxattr(context
, SMBC_listxattr_ctx
);
221 smbc_setFunctionOpenPrintJob(context
, SMBC_open_print_job_ctx
);
222 smbc_setFunctionPrintFile(context
, SMBC_print_file_ctx
);
223 smbc_setFunctionListPrintJobs(context
, SMBC_list_print_jobs_ctx
);
224 smbc_setFunctionUnlinkPrintJob(context
, SMBC_unlink_print_job_ctx
);
232 * Returns 0 on success. Otherwise returns 1, the SMBCCTX is _not_ freed
233 * and thus you'll be leaking memory if not handled properly.
237 smbc_free_context(SMBCCTX
*context
,
247 DEBUG(1,("Performing aggressive shutdown.\n"));
249 f
= context
->internal
->files
;
251 smbc_getFunctionClose(context
)(context
, f
);
254 context
->internal
->files
= NULL
;
256 /* First try to remove the servers the nice way. */
257 if (smbc_getFunctionPurgeCachedServers(context
)(context
)) {
260 DEBUG(1, ("Could not purge all servers, "
261 "Nice way shutdown failed.\n"));
262 s
= context
->internal
->servers
;
264 DEBUG(1, ("Forced shutdown: %p (cli=%p)\n",
266 cli_shutdown(s
->cli
);
267 smbc_getFunctionRemoveCachedServer(context
)(context
,
270 DLIST_REMOVE(context
->internal
->servers
, s
);
274 context
->internal
->servers
= NULL
;
278 /* This is the polite way */
279 if (smbc_getFunctionPurgeCachedServers(context
)(context
)) {
280 DEBUG(1, ("Could not purge all servers, "
281 "free_context failed.\n"));
285 if (context
->internal
->servers
) {
286 DEBUG(1, ("Active servers in context, "
287 "free_context failed.\n"));
291 if (context
->internal
->files
) {
292 DEBUG(1, ("Active files in context, "
293 "free_context failed.\n"));
299 /* Things we have to clean up */
300 smbc_setWorkgroup(context
, NULL
);
301 smbc_setNetbiosName(context
, NULL
);
302 smbc_setUser(context
, NULL
);
304 DEBUG(3, ("Context %p successfully freed\n", context
));
306 /* Free any DFS auth context. */
307 TALLOC_FREE(context
->internal
->auth_info
);
309 SAFE_FREE(context
->internal
);
312 /* Protect access to the count of contexts in use */
313 if (SMB_THREAD_LOCK(initialized_ctx_count_mutex
) != 0) {
314 smb_panic("error locking 'initialized_ctx_count'");
317 if (initialized_ctx_count
) {
318 initialized_ctx_count
--;
321 if (initialized_ctx_count
== 0) {
322 SMBC_module_terminate();
325 /* Unlock the mutex */
326 if (SMB_THREAD_UNLOCK(initialized_ctx_count_mutex
) != 0) {
327 smb_panic("error unlocking 'initialized_ctx_count'");
335 * Deprecated interface. Do not use. Instead, use the various
336 * smbc_setOption*() functions or smbc_setFunctionAuthDataWithContext().
339 smbc_option_set(SMBCCTX
*context
,
341 ... /* option_value */)
347 smbc_get_auth_data_with_context_fn auth_fn
;
352 va_start(ap
, option_name
);
354 if (strcmp(option_name
, "debug_to_stderr") == 0) {
355 option_value
.b
= (bool) va_arg(ap
, int);
356 smbc_setOptionDebugToStderr(context
, option_value
.b
);
358 } else if (strcmp(option_name
, "full_time_names") == 0) {
359 option_value
.b
= (bool) va_arg(ap
, int);
360 smbc_setOptionFullTimeNames(context
, option_value
.b
);
362 } else if (strcmp(option_name
, "open_share_mode") == 0) {
363 option_value
.i
= va_arg(ap
, int);
364 smbc_setOptionOpenShareMode(context
, option_value
.i
);
366 } else if (strcmp(option_name
, "auth_function") == 0) {
367 option_value
.auth_fn
=
368 va_arg(ap
, smbc_get_auth_data_with_context_fn
);
369 smbc_setFunctionAuthDataWithContext(context
, option_value
.auth_fn
);
371 } else if (strcmp(option_name
, "user_data") == 0) {
372 option_value
.v
= va_arg(ap
, void *);
373 smbc_setOptionUserData(context
, option_value
.v
);
375 } else if (strcmp(option_name
, "smb_encrypt_level") == 0) {
376 option_value
.s
= va_arg(ap
, const char *);
377 if (strcmp(option_value
.s
, "none") == 0) {
378 smbc_setOptionSmbEncryptionLevel(context
,
379 SMBC_ENCRYPTLEVEL_NONE
);
380 } else if (strcmp(option_value
.s
, "request") == 0) {
381 smbc_setOptionSmbEncryptionLevel(context
,
382 SMBC_ENCRYPTLEVEL_REQUEST
);
383 } else if (strcmp(option_value
.s
, "require") == 0) {
384 smbc_setOptionSmbEncryptionLevel(context
,
385 SMBC_ENCRYPTLEVEL_REQUIRE
);
388 } else if (strcmp(option_name
, "browse_max_lmb_count") == 0) {
389 option_value
.i
= va_arg(ap
, int);
390 smbc_setOptionBrowseMaxLmbCount(context
, option_value
.i
);
392 } else if (strcmp(option_name
, "urlencode_readdir_entries") == 0) {
393 option_value
.b
= (bool) va_arg(ap
, int);
394 smbc_setOptionUrlEncodeReaddirEntries(context
, option_value
.b
);
396 } else if (strcmp(option_name
, "one_share_per_server") == 0) {
397 option_value
.b
= (bool) va_arg(ap
, int);
398 smbc_setOptionOneSharePerServer(context
, option_value
.b
);
400 } else if (strcmp(option_name
, "use_kerberos") == 0) {
401 option_value
.b
= (bool) va_arg(ap
, int);
402 smbc_setOptionUseKerberos(context
, option_value
.b
);
404 } else if (strcmp(option_name
, "fallback_after_kerberos") == 0) {
405 option_value
.b
= (bool) va_arg(ap
, int);
406 smbc_setOptionFallbackAfterKerberos(context
, option_value
.b
);
408 } else if (strcmp(option_name
, "use_ccache") == 0) {
409 option_value
.b
= (bool) va_arg(ap
, int);
410 smbc_setOptionUseCCache(context
, option_value
.b
);
412 } else if (strcmp(option_name
, "no_auto_anonymous_login") == 0) {
413 option_value
.b
= (bool) va_arg(ap
, int);
414 smbc_setOptionNoAutoAnonymousLogin(context
, option_value
.b
);
422 * Deprecated interface. Do not use. Instead, use the various
423 * smbc_getOption*() functions.
426 smbc_option_get(SMBCCTX
*context
,
429 if (strcmp(option_name
, "debug_stderr") == 0) {
430 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
431 return (void *) (intptr_t) smbc_getOptionDebugToStderr(context
);
433 return (void *) smbc_getOptionDebugToStderr(context
);
436 } else if (strcmp(option_name
, "full_time_names") == 0) {
437 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
438 return (void *) (intptr_t) smbc_getOptionFullTimeNames(context
);
440 return (void *) smbc_getOptionFullTimeNames(context
);
443 } else if (strcmp(option_name
, "open_share_mode") == 0) {
444 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
445 return (void *) (intptr_t) smbc_getOptionOpenShareMode(context
);
447 return (void *) smbc_getOptionOpenShareMode(context
);
450 } else if (strcmp(option_name
, "auth_function") == 0) {
451 return (void *) smbc_getFunctionAuthDataWithContext(context
);
453 } else if (strcmp(option_name
, "user_data") == 0) {
454 return smbc_getOptionUserData(context
);
456 } else if (strcmp(option_name
, "smb_encrypt_level") == 0) {
457 switch(smbc_getOptionSmbEncryptionLevel(context
))
460 return discard_const_p(void, "none");
462 return discard_const_p(void, "request");
464 return discard_const_p(void, "require");
467 } else if (strcmp(option_name
, "smb_encrypt_on") == 0) {
469 unsigned int num_servers
= 0;
471 for (s
= context
->internal
->servers
; s
; s
= s
->next
) {
473 if (!cli_state_encryption_on(s
->cli
)) {
474 return (void *)false;
477 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
478 return (void *) (intptr_t) (bool) (num_servers
> 0);
480 return (void *) (bool) (num_servers
> 0);
483 } else if (strcmp(option_name
, "browse_max_lmb_count") == 0) {
484 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
485 return (void *) (intptr_t) smbc_getOptionBrowseMaxLmbCount(context
);
487 return (void *) smbc_getOptionBrowseMaxLmbCount(context
);
490 } else if (strcmp(option_name
, "urlencode_readdir_entries") == 0) {
491 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
492 return (void *)(intptr_t) smbc_getOptionUrlEncodeReaddirEntries(context
);
494 return (void *) (bool) smbc_getOptionUrlEncodeReaddirEntries(context
);
497 } else if (strcmp(option_name
, "one_share_per_server") == 0) {
498 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
499 return (void *) (intptr_t) smbc_getOptionOneSharePerServer(context
);
501 return (void *) (bool) smbc_getOptionOneSharePerServer(context
);
504 } else if (strcmp(option_name
, "use_kerberos") == 0) {
505 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
506 return (void *) (intptr_t) smbc_getOptionUseKerberos(context
);
508 return (void *) (bool) smbc_getOptionUseKerberos(context
);
511 } else if (strcmp(option_name
, "fallback_after_kerberos") == 0) {
512 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
513 return (void *)(intptr_t) smbc_getOptionFallbackAfterKerberos(context
);
515 return (void *) (bool) smbc_getOptionFallbackAfterKerberos(context
);
518 } else if (strcmp(option_name
, "use_ccache") == 0) {
519 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
520 return (void *) (intptr_t) smbc_getOptionUseCCache(context
);
522 return (void *) (bool) smbc_getOptionUseCCache(context
);
525 } else if (strcmp(option_name
, "no_auto_anonymous_login") == 0) {
526 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
527 return (void *) (intptr_t) smbc_getOptionNoAutoAnonymousLogin(context
);
529 return (void *) (bool) smbc_getOptionNoAutoAnonymousLogin(context
);
538 * Initialize the library, etc.
540 * We accept a struct containing handle information.
541 * valid values for info->debug from 0 to 100,
542 * and insist that info->fn must be non-null.
545 smbc_init_context(SMBCCTX
*context
)
554 /* Do not initialise the same client twice */
555 if (context
->internal
->initialized
) {
559 if ((!smbc_getFunctionAuthData(context
) &&
560 !smbc_getFunctionAuthDataWithContext(context
)) ||
561 smbc_getDebug(context
) < 0 ||
562 smbc_getDebug(context
) > 100) {
569 if (!smbc_getUser(context
)) {
571 * FIXME: Is this the best way to get the user info?
573 char *user
= getenv("USER");
574 /* walk around as "guest" if no username can be found */
576 user
= SMB_STRDUP("guest");
578 user
= SMB_STRDUP(user
);
586 smbc_setUser(context
, user
);
589 if (!smbc_getUser(context
)) {
595 if (!smbc_getNetbiosName(context
)) {
597 * We try to get our netbios name from the config. If that
598 * fails we fall back on constructing our netbios name from
602 if (lp_netbios_name()) {
603 netbios_name
= SMB_STRDUP(lp_netbios_name());
606 * Hmmm, I want to get hostname as well, but I am too
607 * lazy for the moment
610 netbios_name
= (char *)SMB_MALLOC(17);
615 slprintf(netbios_name
, 16,
616 "smbc%s%d", smbc_getUser(context
), pid
);
624 smbc_setNetbiosName(context
, netbios_name
);
625 SAFE_FREE(netbios_name
);
627 if (!smbc_getNetbiosName(context
)) {
633 DEBUG(1, ("Using netbios name %s.\n", smbc_getNetbiosName(context
)));
635 if (!smbc_getWorkgroup(context
)) {
638 if (lp_workgroup()) {
639 workgroup
= SMB_STRDUP(lp_workgroup());
642 /* TODO: Think about a decent default workgroup */
643 workgroup
= SMB_STRDUP("samba");
651 smbc_setWorkgroup(context
, workgroup
);
652 SAFE_FREE(workgroup
);
654 if (!smbc_getWorkgroup(context
)) {
660 DEBUG(1, ("Using workgroup %s.\n", smbc_getWorkgroup(context
)));
662 /* shortest timeout is 1 second */
663 if (smbc_getTimeout(context
) > 0 && smbc_getTimeout(context
) < 1000)
664 smbc_setTimeout(context
, 1000);
666 context
->internal
->initialized
= True
;
668 /* Protect access to the count of contexts in use */
669 if (SMB_THREAD_LOCK(initialized_ctx_count_mutex
) != 0) {
670 smb_panic("error locking 'initialized_ctx_count'");
673 initialized_ctx_count
++;
675 /* Unlock the mutex */
676 if (SMB_THREAD_UNLOCK(initialized_ctx_count_mutex
) != 0) {
677 smb_panic("error unlocking 'initialized_ctx_count'");
684 /* Return the verion of samba, and thus libsmbclient */
688 return samba_version_string();
692 * Set the credentials so DFS will work when following referrals.
693 * This function is broken and must be removed. No SMBCCTX arg...
698 smbc_set_credentials(const char *workgroup
,
700 const char *password
,
701 smbc_bool use_kerberos
,
702 const char *signing_state
)
704 d_printf("smbc_set_credentials is obsolete. Replace with smbc_set_credentials_with_fallback().\n");
707 void smbc_set_credentials_with_fallback(SMBCCTX
*context
,
708 const char *workgroup
,
710 const char *password
)
712 smbc_bool use_kerberos
= false;
713 const char *signing_state
= "off";
714 struct user_auth_info
*auth_info
= NULL
;
721 if (! workgroup
|| ! *workgroup
) {
722 workgroup
= smbc_getWorkgroup(context
);
726 user
= smbc_getUser(context
);
733 auth_info
= user_auth_info_init(NULL
);
736 DEBUG(0, ("smbc_set_credentials_with_fallback: allocation fail\n"));
740 if (smbc_getOptionUseKerberos(context
)) {
744 if (lp_client_signing()) {
745 signing_state
= "on";
748 if (lp_client_signing() == Required
) {
749 signing_state
= "force";
752 set_cmdline_auth_info_username(auth_info
, user
);
753 set_cmdline_auth_info_domain(auth_info
, workgroup
);
754 set_cmdline_auth_info_password(auth_info
, password
);
755 set_cmdline_auth_info_use_kerberos(auth_info
, use_kerberos
);
756 set_cmdline_auth_info_signing_state(auth_info
, signing_state
);
757 set_cmdline_auth_info_fallback_after_kerberos(auth_info
,
758 smbc_getOptionFallbackAfterKerberos(context
));
759 set_cmdline_auth_info_use_ccache(
760 auth_info
, smbc_getOptionUseCCache(context
));
762 TALLOC_FREE(context
->internal
->auth_info
);
764 context
->internal
->auth_info
= auth_info
;