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"
30 #include "../libcli/smb/smbXcli_base.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 home = getenv("HOME");
58 if (asprintf(&conf, "%s/.smb/smb.conf", home) > 0) {
59 if (lp_load_client(conf)) {
62 DEBUG(5, ("Could not load config file: %s\n",
71 * Well, if that failed, try the get_dyn_CONFIGFILE
72 * Which points to the standard locn, and if that
73 * fails, silently ignore it and use the internal
77 if (!lp_load_client(get_dyn_CONFIGFILE())) {
78 DEBUG(5, ("Could not load config file: %s\n",
79 get_dyn_CONFIGFILE()));
83 * We loaded the global config file. Now lets
84 * load user-specific modifications to the
88 "%s/.smb/smb.conf.append",
90 if (!lp_load_client_no_reinit(conf)) {
92 ("Could not append config file: "
101 load_interfaces(); /* Load the list of interfaces ... */
103 reopen_logs(); /* Get logging working ... */
106 * Block SIGPIPE (from lib/util_sock.c: write())
107 * It is not needed and should not stop execution
109 BlockSignals(True, SIGPIPE);
111 /* Create the mutex we'll use to protect initialized_ctx_count */
112 if (SMB_THREAD_CREATE_MUTEX("initialized_ctx_count_mutex",
113 initialized_ctx_count_mutex) != 0) {
114 smb_panic("SMBC_module_init: "
115 "failed to create 'initialized_ctx_count' mutex");
124 SMBC_module_terminate(void)
126 TALLOC_CTX *frame = talloc_stackframe();
129 SMBC_initialized = false;
135 * Get a new empty handle to fill in with your own info
138 smbc_new_context(void)
141 TALLOC_CTX *frame = talloc_stackframe();
143 /* The first call to this function should initialize the module */
144 SMB_THREAD_ONCE(&SMBC_initialized, SMBC_module_init, NULL);
147 * All newly added context fields should be placed in
148 * SMBC_internal_data, not directly in SMBCCTX.
150 context = SMB_MALLOC_P(SMBCCTX);
157 ZERO_STRUCTP(context);
159 context->internal = SMB_MALLOC_P(struct SMBC_internal_data);
160 if (!context->internal) {
167 /* Initialize the context and establish reasonable defaults */
168 ZERO_STRUCTP(context->internal);
170 smbc_setDebug(context, 0);
171 smbc_setTimeout(context, 20000);
173 smbc_setOptionFullTimeNames(context, False);
174 smbc_setOptionOpenShareMode(context, SMBC_SHAREMODE_DENY_NONE);
175 smbc_setOptionSmbEncryptionLevel(context, SMBC_ENCRYPTLEVEL_NONE);
176 smbc_setOptionUseCCache(context, True);
177 smbc_setOptionCaseSensitive(context, False);
178 smbc_setOptionBrowseMaxLmbCount(context, 3); /* # LMBs to query */
179 smbc_setOptionUrlEncodeReaddirEntries(context, False);
180 smbc_setOptionOneSharePerServer(context, False);
181 if (getenv("LIBSMBCLIENT_NO_CCACHE") == NULL) {
182 smbc_setOptionUseCCache(context, true);
185 smbc_setFunctionAuthData(context, SMBC_get_auth_data);
186 smbc_setFunctionCheckServer(context, SMBC_check_server);
187 smbc_setFunctionRemoveUnusedServer(context, SMBC_remove_unused_server);
189 smbc_setOptionUserData(context, NULL);
190 smbc_setFunctionAddCachedServer(context, SMBC_add_cached_server);
191 smbc_setFunctionGetCachedServer(context, SMBC_get_cached_server);
192 smbc_setFunctionRemoveCachedServer(context, SMBC_remove_cached_server);
193 smbc_setFunctionPurgeCachedServers(context, SMBC_purge_cached_servers);
195 smbc_setFunctionOpen(context, SMBC_open_ctx);
196 smbc_setFunctionCreat(context, SMBC_creat_ctx);
197 smbc_setFunctionRead(context, SMBC_read_ctx);
198 smbc_setFunctionWrite(context, SMBC_write_ctx);
199 smbc_setFunctionClose(context, SMBC_close_ctx);
200 smbc_setFunctionUnlink(context, SMBC_unlink_ctx);
201 smbc_setFunctionRename(context, SMBC_rename_ctx);
202 smbc_setFunctionLseek(context, SMBC_lseek_ctx);
203 smbc_setFunctionFtruncate(context, SMBC_ftruncate_ctx);
204 smbc_setFunctionStat(context, SMBC_stat_ctx);
205 smbc_setFunctionStatVFS(context, SMBC_statvfs_ctx);
206 smbc_setFunctionFstatVFS(context, SMBC_fstatvfs_ctx);
207 smbc_setFunctionFstat(context, SMBC_fstat_ctx);
208 smbc_setFunctionOpendir(context, SMBC_opendir_ctx);
209 smbc_setFunctionClosedir(context, SMBC_closedir_ctx);
210 smbc_setFunctionReaddir(context, SMBC_readdir_ctx);
211 smbc_setFunctionGetdents(context, SMBC_getdents_ctx);
212 smbc_setFunctionMkdir(context, SMBC_mkdir_ctx);
213 smbc_setFunctionRmdir(context, SMBC_rmdir_ctx);
214 smbc_setFunctionTelldir(context, SMBC_telldir_ctx);
215 smbc_setFunctionLseekdir(context, SMBC_lseekdir_ctx);
216 smbc_setFunctionFstatdir(context, SMBC_fstatdir_ctx);
217 smbc_setFunctionChmod(context, SMBC_chmod_ctx);
218 smbc_setFunctionUtimes(context, SMBC_utimes_ctx);
219 smbc_setFunctionSetxattr(context, SMBC_setxattr_ctx);
220 smbc_setFunctionGetxattr(context, SMBC_getxattr_ctx);
221 smbc_setFunctionRemovexattr(context, SMBC_removexattr_ctx);
222 smbc_setFunctionListxattr(context, SMBC_listxattr_ctx);
224 smbc_setFunctionOpenPrintJob(context, SMBC_open_print_job_ctx);
225 smbc_setFunctionPrintFile(context, SMBC_print_file_ctx);
226 smbc_setFunctionListPrintJobs(context, SMBC_list_print_jobs_ctx);
227 smbc_setFunctionUnlinkPrintJob(context, SMBC_unlink_print_job_ctx);
236 * Returns 0 on success. Otherwise returns 1, the SMBCCTX is _not_ freed
237 * and thus you'll be leaking memory if not handled properly.
241 smbc_free_context(SMBCCTX *context,
250 frame = talloc_stackframe();
254 DEBUG(1,("Performing aggressive shutdown.\n"));
256 f = context->internal->files;
258 smbc_getFunctionClose(context)(context, f);
261 context->internal->files = NULL;
263 /* First try to remove the servers the nice way. */
264 if (smbc_getFunctionPurgeCachedServers(context)(context)) {
267 DEBUG(1, ("Could not purge all servers, "
268 "Nice way shutdown failed.\n"));
269 s = context->internal->servers;
271 DEBUG(1, ("Forced shutdown: %p (cli=%p)\n",
273 cli_shutdown(s->cli);
274 smbc_getFunctionRemoveCachedServer(context)(context,
277 DLIST_REMOVE(context->internal->servers, s);
281 context->internal->servers = NULL;
285 /* This is the polite way */
286 if (smbc_getFunctionPurgeCachedServers(context)(context)) {
287 DEBUG(1, ("Could not purge all servers, "
288 "free_context failed.\n"));
293 if (context->internal->servers) {
294 DEBUG(1, ("Active servers in context, "
295 "free_context failed.\n"));
300 if (context->internal->files) {
301 DEBUG(1, ("Active files in context, "
302 "free_context failed.\n"));
309 /* Things we have to clean up */
310 smbc_setWorkgroup(context, NULL);
311 smbc_setNetbiosName(context, NULL);
312 smbc_setUser(context, NULL);
314 DEBUG(3, ("Context %p successfully freed\n", context));
316 /* Free any DFS auth context. */
317 TALLOC_FREE(context->internal->auth_info);
319 SAFE_FREE(context->internal);
322 /* Protect access to the count of contexts in use */
323 if (SMB_THREAD_LOCK(initialized_ctx_count_mutex) != 0) {
324 smb_panic("error locking 'initialized_ctx_count'");
327 if (initialized_ctx_count) {
328 initialized_ctx_count--;
331 if (initialized_ctx_count == 0) {
332 SMBC_module_terminate();
335 /* Unlock the mutex */
336 if (SMB_THREAD_UNLOCK(initialized_ctx_count_mutex) != 0) {
337 smb_panic("error unlocking 'initialized_ctx_count'");
346 * Deprecated interface. Do not use. Instead, use the various
347 * smbc_setOption*() functions or smbc_setFunctionAuthDataWithContext().
350 smbc_option_set(SMBCCTX *context,
352 ... /* option_value */)
358 smbc_get_auth_data_with_context_fn auth_fn;
363 TALLOC_CTX *frame = talloc_stackframe();
365 va_start(ap, option_name);
367 if (strcmp(option_name, "debug_to_stderr") == 0) {
368 option_value.b = (bool) va_arg(ap, int);
369 smbc_setOptionDebugToStderr(context, option_value.b);
371 } else if (strcmp(option_name, "full_time_names") == 0) {
372 option_value.b = (bool) va_arg(ap, int);
373 smbc_setOptionFullTimeNames(context, option_value.b);
375 } else if (strcmp(option_name, "open_share_mode") == 0) {
376 option_value.i = va_arg(ap, int);
377 smbc_setOptionOpenShareMode(context, option_value.i);
379 } else if (strcmp(option_name, "auth_function") == 0) {
380 option_value.auth_fn =
381 va_arg(ap, smbc_get_auth_data_with_context_fn);
382 smbc_setFunctionAuthDataWithContext(context, option_value.auth_fn);
384 } else if (strcmp(option_name, "user_data") == 0) {
385 option_value.v = va_arg(ap, void *);
386 smbc_setOptionUserData(context, option_value.v);
388 } else if (strcmp(option_name, "smb_encrypt_level") == 0) {
389 option_value.s = va_arg(ap, const char *);
390 if (strcmp(option_value.s, "none") == 0) {
391 smbc_setOptionSmbEncryptionLevel(context,
392 SMBC_ENCRYPTLEVEL_NONE);
393 } else if (strcmp(option_value.s, "request") == 0) {
394 smbc_setOptionSmbEncryptionLevel(context,
395 SMBC_ENCRYPTLEVEL_REQUEST);
396 } else if (strcmp(option_value.s, "require") == 0) {
397 smbc_setOptionSmbEncryptionLevel(context,
398 SMBC_ENCRYPTLEVEL_REQUIRE);
401 } else if (strcmp(option_name, "browse_max_lmb_count") == 0) {
402 option_value.i = va_arg(ap, int);
403 smbc_setOptionBrowseMaxLmbCount(context, option_value.i);
405 } else if (strcmp(option_name, "urlencode_readdir_entries") == 0) {
406 option_value.b = (bool) va_arg(ap, int);
407 smbc_setOptionUrlEncodeReaddirEntries(context, option_value.b);
409 } else if (strcmp(option_name, "one_share_per_server") == 0) {
410 option_value.b = (bool) va_arg(ap, int);
411 smbc_setOptionOneSharePerServer(context, option_value.b);
413 } else if (strcmp(option_name, "use_kerberos") == 0) {
414 option_value.b = (bool) va_arg(ap, int);
415 smbc_setOptionUseKerberos(context, option_value.b);
417 } else if (strcmp(option_name, "fallback_after_kerberos") == 0) {
418 option_value.b = (bool) va_arg(ap, int);
419 smbc_setOptionFallbackAfterKerberos(context, option_value.b);
421 } else if (strcmp(option_name, "use_ccache") == 0) {
422 option_value.b = (bool) va_arg(ap, int);
423 smbc_setOptionUseCCache(context, option_value.b);
425 } else if (strcmp(option_name, "no_auto_anonymous_login") == 0) {
426 option_value.b = (bool) va_arg(ap, int);
427 smbc_setOptionNoAutoAnonymousLogin(context, option_value.b);
436 * Deprecated interface. Do not use. Instead, use the various
437 * smbc_getOption*() functions.
440 smbc_option_get(SMBCCTX *context,
443 if (strcmp(option_name, "debug_stderr") == 0) {
444 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
445 return (void *) (intptr_t) smbc_getOptionDebugToStderr(context);
447 return (void *) smbc_getOptionDebugToStderr(context);
450 } else if (strcmp(option_name, "full_time_names") == 0) {
451 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
452 return (void *) (intptr_t) smbc_getOptionFullTimeNames(context);
454 return (void *) smbc_getOptionFullTimeNames(context);
457 } else if (strcmp(option_name, "open_share_mode") == 0) {
458 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
459 return (void *) (intptr_t) smbc_getOptionOpenShareMode(context);
461 return (void *) smbc_getOptionOpenShareMode(context);
464 } else if (strcmp(option_name, "auth_function") == 0) {
465 return (void *) smbc_getFunctionAuthDataWithContext(context);
467 } else if (strcmp(option_name, "user_data") == 0) {
468 return smbc_getOptionUserData(context);
470 } else if (strcmp(option_name, "smb_encrypt_level") == 0) {
471 switch(smbc_getOptionSmbEncryptionLevel(context))
474 return discard_const_p(void, "none");
476 return discard_const_p(void, "request");
478 return discard_const_p(void, "require");
481 } else if (strcmp(option_name, "smb_encrypt_on") == 0) {
483 unsigned int num_servers = 0;
485 for (s = context->internal->servers; s; s = s->next) {
487 if (!smb1cli_conn_encryption_on(s->cli->conn)) {
488 return (void *)false;
491 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
492 return (void *) (intptr_t) (bool) (num_servers > 0);
494 return (void *) (bool) (num_servers > 0);
497 } else if (strcmp(option_name, "browse_max_lmb_count") == 0) {
498 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
499 return (void *) (intptr_t) smbc_getOptionBrowseMaxLmbCount(context);
501 return (void *) smbc_getOptionBrowseMaxLmbCount(context);
504 } else if (strcmp(option_name, "urlencode_readdir_entries") == 0) {
505 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
506 return (void *)(intptr_t) smbc_getOptionUrlEncodeReaddirEntries(context);
508 return (void *) (bool) smbc_getOptionUrlEncodeReaddirEntries(context);
511 } else if (strcmp(option_name, "one_share_per_server") == 0) {
512 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
513 return (void *) (intptr_t) smbc_getOptionOneSharePerServer(context);
515 return (void *) (bool) smbc_getOptionOneSharePerServer(context);
518 } else if (strcmp(option_name, "use_kerberos") == 0) {
519 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
520 return (void *) (intptr_t) smbc_getOptionUseKerberos(context);
522 return (void *) (bool) smbc_getOptionUseKerberos(context);
525 } else if (strcmp(option_name, "fallback_after_kerberos") == 0) {
526 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
527 return (void *)(intptr_t) smbc_getOptionFallbackAfterKerberos(context);
529 return (void *) (bool) smbc_getOptionFallbackAfterKerberos(context);
532 } else if (strcmp(option_name, "use_ccache") == 0) {
533 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
534 return (void *) (intptr_t) smbc_getOptionUseCCache(context);
536 return (void *) (bool) smbc_getOptionUseCCache(context);
539 } else if (strcmp(option_name, "no_auto_anonymous_login") == 0) {
540 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
541 return (void *) (intptr_t) smbc_getOptionNoAutoAnonymousLogin(context);
543 return (void *) (bool) smbc_getOptionNoAutoAnonymousLogin(context);
552 * Initialize the library, etc.
554 * We accept a struct containing handle information.
555 * valid values for info->debug from 0 to 100,
556 * and insist that info->fn must be non-null.
559 smbc_init_context(SMBCCTX *context)
568 /* Do not initialise the same client twice */
569 if (context->internal->initialized) {
573 if ((!smbc_getFunctionAuthData(context) &&
574 !smbc_getFunctionAuthDataWithContext(context)) ||
575 smbc_getDebug(context) < 0 ||
576 smbc_getDebug(context) > 100) {
583 if (!smbc_getUser(context)) {
585 * FIXME: Is this the best way to get the user info?
587 char *user = getenv("USER");
588 /* walk around as "guest" if no username can be found */
590 user = SMB_STRDUP("guest");
592 user = SMB_STRDUP(user);
600 smbc_setUser(context, user);
603 if (!smbc_getUser(context)) {
609 if (!smbc_getNetbiosName(context)) {
611 * We try to get our netbios name from the config. If that
612 * fails we fall back on constructing our netbios name from
616 if (lp_netbios_name()) {
617 netbios_name = SMB_STRDUP(lp_netbios_name());
620 * Hmmm, I want to get hostname as well, but I am too
621 * lazy for the moment
624 netbios_name = (char *)SMB_MALLOC(17);
629 slprintf(netbios_name, 16,
630 "smbc%s%d", smbc_getUser(context), pid);
638 smbc_setNetbiosName(context, netbios_name);
639 SAFE_FREE(netbios_name);
641 if (!smbc_getNetbiosName(context)) {
647 DEBUG(1, ("Using netbios name %s.\n", smbc_getNetbiosName(context)));
649 if (!smbc_getWorkgroup(context)) {
652 if (lp_workgroup()) {
653 workgroup = SMB_STRDUP(lp_workgroup());
656 /* TODO: Think about a decent default workgroup */
657 workgroup = SMB_STRDUP("samba");
665 smbc_setWorkgroup(context, workgroup);
666 SAFE_FREE(workgroup);
668 if (!smbc_getWorkgroup(context)) {
674 DEBUG(1, ("Using workgroup %s.\n", smbc_getWorkgroup(context)));
676 /* shortest timeout is 1 second */
677 if (smbc_getTimeout(context) > 0 && smbc_getTimeout(context) < 1000)
678 smbc_setTimeout(context, 1000);
680 context->internal->initialized = True;
682 /* Protect access to the count of contexts in use */
683 if (SMB_THREAD_LOCK(initialized_ctx_count_mutex) != 0) {
684 smb_panic("error locking 'initialized_ctx_count'");
687 initialized_ctx_count++;
689 /* Unlock the mutex */
690 if (SMB_THREAD_UNLOCK(initialized_ctx_count_mutex) != 0) {
691 smb_panic("error unlocking 'initialized_ctx_count'");
698 /* Return the verion of samba, and thus libsmbclient */
702 return samba_version_string();
706 * Set the credentials so DFS will work when following referrals.
707 * This function is broken and must be removed. No SMBCCTX arg...
712 smbc_set_credentials(const char *workgroup,
714 const char *password,
715 smbc_bool use_kerberos,
716 const char *signing_state)
718 d_printf("smbc_set_credentials is obsolete. Replace with smbc_set_credentials_with_fallback().\n");
721 void smbc_set_credentials_with_fallback(SMBCCTX *context,
722 const char *workgroup,
724 const char *password)
726 smbc_bool use_kerberos = false;
727 const char *signing_state = "off";
728 struct user_auth_info *auth_info = NULL;
735 if (! workgroup || ! *workgroup) {
736 workgroup = smbc_getWorkgroup(context);
740 user = smbc_getUser(context);
747 auth_info = user_auth_info_init(NULL);
750 DEBUG(0, ("smbc_set_credentials_with_fallback: allocation fail\n"));
754 if (smbc_getOptionUseKerberos(context)) {
758 if (lp_client_signing() != SMB_SIGNING_OFF) {
759 signing_state = "if_required";
762 if (lp_client_signing() == SMB_SIGNING_REQUIRED) {
763 signing_state = "required";
766 set_cmdline_auth_info_username(auth_info, user);
767 set_cmdline_auth_info_domain(auth_info, workgroup);
768 set_cmdline_auth_info_password(auth_info, password);
769 set_cmdline_auth_info_use_kerberos(auth_info, use_kerberos);
770 set_cmdline_auth_info_signing_state(auth_info, signing_state);
771 set_cmdline_auth_info_fallback_after_kerberos(auth_info,
772 smbc_getOptionFallbackAfterKerberos(context));
773 set_cmdline_auth_info_use_ccache(
774 auth_info, smbc_getOptionUseCCache(context));
776 TALLOC_FREE(context->internal->auth_info);
778 context->internal->auth_info = auth_info;