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 setup_logging("libsmbclient", DEBUG_STDOUT);
51 /* Here we would open the smb.conf file if needed ... */
53 home = getenv("HOME");
56 if (asprintf(&conf, "%s/.smb/smb.conf", home) > 0) {
57 if (lp_load_client(conf)) {
60 DEBUG(5, ("Could not load config file: %s\n",
69 * Well, if that failed, try the get_dyn_CONFIGFILE
70 * Which points to the standard locn, and if that
71 * fails, silently ignore it and use the internal
75 if (!lp_load_client(get_dyn_CONFIGFILE())) {
76 DEBUG(5, ("Could not load config file: %s\n",
77 get_dyn_CONFIGFILE()));
81 * We loaded the global config file. Now lets
82 * load user-specific modifications to the
86 "%s/.smb/smb.conf.append",
88 if (!lp_load_client_no_reinit(conf)) {
90 ("Could not append config file: "
99 load_interfaces(); /* Load the list of interfaces ... */
101 reopen_logs(); /* Get logging working ... */
104 * Block SIGPIPE (from lib/util_sock.c: write())
105 * It is not needed and should not stop execution
107 BlockSignals(True, SIGPIPE);
109 /* Create the mutex we'll use to protect initialized_ctx_count */
110 if (SMB_THREAD_CREATE_MUTEX("initialized_ctx_count_mutex",
111 initialized_ctx_count_mutex) != 0) {
112 smb_panic("SMBC_module_init: "
113 "failed to create 'initialized_ctx_count' mutex");
122 SMBC_module_terminate(void)
124 TALLOC_CTX *frame = talloc_stackframe();
127 SMBC_initialized = false;
133 * Get a new empty handle to fill in with your own info
136 smbc_new_context(void)
139 TALLOC_CTX *frame = talloc_stackframe();
141 /* The first call to this function should initialize the module */
142 SMB_THREAD_ONCE(&SMBC_initialized, SMBC_module_init, NULL);
145 * All newly added context fields should be placed in
146 * SMBC_internal_data, not directly in SMBCCTX.
148 context = SMB_MALLOC_P(SMBCCTX);
155 ZERO_STRUCTP(context);
157 context->internal = SMB_MALLOC_P(struct SMBC_internal_data);
158 if (!context->internal) {
165 /* Initialize the context and establish reasonable defaults */
166 ZERO_STRUCTP(context->internal);
168 smbc_setDebug(context, 0);
169 smbc_setTimeout(context, 20000);
170 smbc_setPort(context, 0);
172 smbc_setOptionFullTimeNames(context, False);
173 smbc_setOptionOpenShareMode(context, SMBC_SHAREMODE_DENY_NONE);
174 smbc_setOptionSmbEncryptionLevel(context, SMBC_ENCRYPTLEVEL_NONE);
175 smbc_setOptionUseCCache(context, True);
176 smbc_setOptionCaseSensitive(context, False);
177 smbc_setOptionBrowseMaxLmbCount(context, 3); /* # LMBs to query */
178 smbc_setOptionUrlEncodeReaddirEntries(context, False);
179 smbc_setOptionOneSharePerServer(context, False);
180 if (getenv("LIBSMBCLIENT_NO_CCACHE") != NULL) {
181 smbc_setOptionUseCCache(context, false);
184 smbc_setFunctionAuthData(context, SMBC_get_auth_data);
185 smbc_setFunctionCheckServer(context, SMBC_check_server);
186 smbc_setFunctionRemoveUnusedServer(context, SMBC_remove_unused_server);
188 smbc_setOptionUserData(context, NULL);
189 smbc_setFunctionAddCachedServer(context, SMBC_add_cached_server);
190 smbc_setFunctionGetCachedServer(context, SMBC_get_cached_server);
191 smbc_setFunctionRemoveCachedServer(context, SMBC_remove_cached_server);
192 smbc_setFunctionPurgeCachedServers(context, SMBC_purge_cached_servers);
194 smbc_setFunctionOpen(context, SMBC_open_ctx);
195 smbc_setFunctionCreat(context, SMBC_creat_ctx);
196 smbc_setFunctionRead(context, SMBC_read_ctx);
197 smbc_setFunctionSplice(context, SMBC_splice_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_setFunctionReaddirPlus(context, SMBC_readdirplus_ctx);
212 smbc_setFunctionReaddirPlus2(context, SMBC_readdirplus2_ctx);
213 smbc_setFunctionGetdents(context, SMBC_getdents_ctx);
214 smbc_setFunctionMkdir(context, SMBC_mkdir_ctx);
215 smbc_setFunctionRmdir(context, SMBC_rmdir_ctx);
216 smbc_setFunctionTelldir(context, SMBC_telldir_ctx);
217 smbc_setFunctionLseekdir(context, SMBC_lseekdir_ctx);
218 smbc_setFunctionFstatdir(context, SMBC_fstatdir_ctx);
219 smbc_setFunctionNotify(context, SMBC_notify_ctx);
220 smbc_setFunctionChmod(context, SMBC_chmod_ctx);
221 smbc_setFunctionUtimes(context, SMBC_utimes_ctx);
222 smbc_setFunctionSetxattr(context, SMBC_setxattr_ctx);
223 smbc_setFunctionGetxattr(context, SMBC_getxattr_ctx);
224 smbc_setFunctionRemovexattr(context, SMBC_removexattr_ctx);
225 smbc_setFunctionListxattr(context, SMBC_listxattr_ctx);
227 smbc_setFunctionOpenPrintJob(context, SMBC_open_print_job_ctx);
228 smbc_setFunctionPrintFile(context, SMBC_print_file_ctx);
229 smbc_setFunctionListPrintJobs(context, SMBC_list_print_jobs_ctx);
230 smbc_setFunctionUnlinkPrintJob(context, SMBC_unlink_print_job_ctx);
239 * Returns 0 on success. Otherwise returns 1, the SMBCCTX is _not_ freed
240 * and thus you'll be leaking memory if not handled properly.
244 smbc_free_context(SMBCCTX *context,
253 frame = talloc_stackframe();
257 DEBUG(1,("Performing aggressive shutdown.\n"));
259 f = context->internal->files;
261 SMBCFILE *next = f->next;
262 smbc_getFunctionClose(context)(context, f);
265 context->internal->files = NULL;
267 /* First try to remove the servers the nice way. */
268 if (smbc_getFunctionPurgeCachedServers(context)(context)) {
271 DEBUG(1, ("Could not purge all servers, "
272 "Nice way shutdown failed.\n"));
273 s = context->internal->servers;
275 DEBUG(1, ("Forced shutdown: %p (cli=%p)\n",
277 cli_shutdown(s->cli);
278 smbc_getFunctionRemoveCachedServer(context)(context,
281 DLIST_REMOVE(context->internal->servers, s);
285 context->internal->servers = NULL;
289 /* This is the polite way */
290 if (smbc_getFunctionPurgeCachedServers(context)(context)) {
291 DEBUG(1, ("Could not purge all servers, "
292 "free_context failed.\n"));
297 if (context->internal->servers) {
298 DEBUG(1, ("Active servers in context, "
299 "free_context failed.\n"));
304 if (context->internal->files) {
305 DEBUG(1, ("Active files in context, "
306 "free_context failed.\n"));
313 /* Things we have to clean up */
314 smbc_setWorkgroup(context, NULL);
315 smbc_setNetbiosName(context, NULL);
316 smbc_setUser(context, NULL);
318 DEBUG(3, ("Context %p successfully freed\n", context));
320 /* Free any DFS auth context. */
321 TALLOC_FREE(context->internal->auth_info);
323 SAFE_FREE(context->internal);
326 /* Protect access to the count of contexts in use */
327 if (SMB_THREAD_LOCK(initialized_ctx_count_mutex) != 0) {
328 smb_panic("error locking 'initialized_ctx_count'");
331 if (initialized_ctx_count) {
332 initialized_ctx_count--;
335 if (initialized_ctx_count == 0) {
336 SMBC_module_terminate();
339 /* Unlock the mutex */
340 if (SMB_THREAD_UNLOCK(initialized_ctx_count_mutex) != 0) {
341 smb_panic("error unlocking 'initialized_ctx_count'");
350 * Deprecated interface. Do not use. Instead, use the various
351 * smbc_setOption*() functions or smbc_setFunctionAuthDataWithContext().
354 smbc_option_set(SMBCCTX *context,
356 ... /* option_value */)
362 smbc_get_auth_data_with_context_fn auth_fn;
367 TALLOC_CTX *frame = talloc_stackframe();
369 va_start(ap, option_name);
371 if (strcmp(option_name, "debug_to_stderr") == 0) {
372 option_value.b = (bool) va_arg(ap, int);
373 smbc_setOptionDebugToStderr(context, option_value.b);
375 } else if (strcmp(option_name, "full_time_names") == 0) {
376 option_value.b = (bool) va_arg(ap, int);
377 smbc_setOptionFullTimeNames(context, option_value.b);
379 } else if (strcmp(option_name, "open_share_mode") == 0) {
380 option_value.i = va_arg(ap, int);
381 smbc_setOptionOpenShareMode(context, option_value.i);
383 } else if (strcmp(option_name, "auth_function") == 0) {
384 option_value.auth_fn =
385 va_arg(ap, smbc_get_auth_data_with_context_fn);
386 smbc_setFunctionAuthDataWithContext(context, option_value.auth_fn);
388 } else if (strcmp(option_name, "user_data") == 0) {
389 option_value.v = va_arg(ap, void *);
390 smbc_setOptionUserData(context, option_value.v);
392 } else if (strcmp(option_name, "smb_encrypt_level") == 0) {
393 option_value.s = va_arg(ap, const char *);
394 if (strcmp(option_value.s, "none") == 0) {
395 smbc_setOptionSmbEncryptionLevel(context,
396 SMBC_ENCRYPTLEVEL_NONE);
397 } else if (strcmp(option_value.s, "request") == 0) {
398 smbc_setOptionSmbEncryptionLevel(context,
399 SMBC_ENCRYPTLEVEL_REQUEST);
400 } else if (strcmp(option_value.s, "require") == 0) {
401 smbc_setOptionSmbEncryptionLevel(context,
402 SMBC_ENCRYPTLEVEL_REQUIRE);
405 } else if (strcmp(option_name, "browse_max_lmb_count") == 0) {
406 option_value.i = va_arg(ap, int);
407 smbc_setOptionBrowseMaxLmbCount(context, option_value.i);
409 } else if (strcmp(option_name, "urlencode_readdir_entries") == 0) {
410 option_value.b = (bool) va_arg(ap, int);
411 smbc_setOptionUrlEncodeReaddirEntries(context, option_value.b);
413 } else if (strcmp(option_name, "one_share_per_server") == 0) {
414 option_value.b = (bool) va_arg(ap, int);
415 smbc_setOptionOneSharePerServer(context, option_value.b);
417 } else if (strcmp(option_name, "use_kerberos") == 0) {
418 option_value.b = (bool) va_arg(ap, int);
419 smbc_setOptionUseKerberos(context, option_value.b);
421 } else if (strcmp(option_name, "fallback_after_kerberos") == 0) {
422 option_value.b = (bool) va_arg(ap, int);
423 smbc_setOptionFallbackAfterKerberos(context, option_value.b);
425 } else if (strcmp(option_name, "use_ccache") == 0) {
426 option_value.b = (bool) va_arg(ap, int);
427 smbc_setOptionUseCCache(context, option_value.b);
429 } else if (strcmp(option_name, "no_auto_anonymous_login") == 0) {
430 option_value.b = (bool) va_arg(ap, int);
431 smbc_setOptionNoAutoAnonymousLogin(context, option_value.b);
440 * Deprecated interface. Do not use. Instead, use the various
441 * smbc_getOption*() functions.
444 smbc_option_get(SMBCCTX *context,
447 if (strcmp(option_name, "debug_stderr") == 0) {
448 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
449 return (void *) (intptr_t) smbc_getOptionDebugToStderr(context);
451 return (void *) smbc_getOptionDebugToStderr(context);
454 } else if (strcmp(option_name, "full_time_names") == 0) {
455 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
456 return (void *) (intptr_t) smbc_getOptionFullTimeNames(context);
458 return (void *) smbc_getOptionFullTimeNames(context);
461 } else if (strcmp(option_name, "open_share_mode") == 0) {
462 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
463 return (void *) (intptr_t) smbc_getOptionOpenShareMode(context);
465 return (void *) smbc_getOptionOpenShareMode(context);
468 } else if (strcmp(option_name, "auth_function") == 0) {
469 return (void *) smbc_getFunctionAuthDataWithContext(context);
471 } else if (strcmp(option_name, "user_data") == 0) {
472 return smbc_getOptionUserData(context);
474 } else if (strcmp(option_name, "smb_encrypt_level") == 0) {
475 switch(smbc_getOptionSmbEncryptionLevel(context))
478 return discard_const_p(void, "none");
480 return discard_const_p(void, "request");
482 return discard_const_p(void, "require");
485 } else if (strcmp(option_name, "smb_encrypt_on") == 0) {
487 unsigned int num_servers = 0;
489 for (s = context->internal->servers; s; s = s->next) {
491 if (!cli_state_is_encryption_on(s->cli)) {
492 return (void *)false;
495 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
496 return (void *) (intptr_t) (bool) (num_servers > 0);
498 return (void *) (bool) (num_servers > 0);
501 } else if (strcmp(option_name, "browse_max_lmb_count") == 0) {
502 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
503 return (void *) (intptr_t) smbc_getOptionBrowseMaxLmbCount(context);
505 return (void *) smbc_getOptionBrowseMaxLmbCount(context);
508 } else if (strcmp(option_name, "urlencode_readdir_entries") == 0) {
509 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
510 return (void *)(intptr_t) smbc_getOptionUrlEncodeReaddirEntries(context);
512 return (void *) (bool) smbc_getOptionUrlEncodeReaddirEntries(context);
515 } else if (strcmp(option_name, "one_share_per_server") == 0) {
516 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
517 return (void *) (intptr_t) smbc_getOptionOneSharePerServer(context);
519 return (void *) (bool) smbc_getOptionOneSharePerServer(context);
522 } else if (strcmp(option_name, "use_kerberos") == 0) {
523 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
524 return (void *) (intptr_t) smbc_getOptionUseKerberos(context);
526 return (void *) (bool) smbc_getOptionUseKerberos(context);
529 } else if (strcmp(option_name, "fallback_after_kerberos") == 0) {
530 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
531 return (void *)(intptr_t) smbc_getOptionFallbackAfterKerberos(context);
533 return (void *) (bool) smbc_getOptionFallbackAfterKerberos(context);
536 } else if (strcmp(option_name, "use_ccache") == 0) {
537 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
538 return (void *) (intptr_t) smbc_getOptionUseCCache(context);
540 return (void *) (bool) smbc_getOptionUseCCache(context);
543 } else if (strcmp(option_name, "no_auto_anonymous_login") == 0) {
544 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
545 return (void *) (intptr_t) smbc_getOptionNoAutoAnonymousLogin(context);
547 return (void *) (bool) smbc_getOptionNoAutoAnonymousLogin(context);
556 * Initialize the library, etc.
558 * We accept a struct containing handle information.
559 * valid values for info->debug from 0 to 100,
560 * and insist that info->fn must be non-null.
563 smbc_init_context(SMBCCTX *context)
573 /* Do not initialise the same client twice */
574 if (context->internal->initialized) {
578 frame = talloc_stackframe();
580 if ((!smbc_getFunctionAuthData(context) &&
581 !smbc_getFunctionAuthDataWithContext(context)) ||
582 smbc_getDebug(context) < 0 ||
583 smbc_getDebug(context) > 100) {
591 if (!smbc_getUser(context)) {
593 * FIXME: Is this the best way to get the user info?
595 char *user = getenv("USER");
596 /* walk around as "guest" if no username can be found */
598 user = SMB_STRDUP("guest");
600 user = SMB_STRDUP(user);
609 smbc_setUser(context, user);
612 if (!smbc_getUser(context)) {
619 if (!smbc_getNetbiosName(context)) {
621 * We try to get our netbios name from the config. If that
622 * fails we fall back on constructing our netbios name from
626 if (lp_netbios_name()) {
627 netbios_name = SMB_STRDUP(lp_netbios_name());
630 * Hmmm, I want to get hostname as well, but I am too
631 * lazy for the moment
634 netbios_name = (char *)SMB_MALLOC(17);
640 slprintf(netbios_name, 16,
641 "smbc%s%d", smbc_getUser(context), pid);
650 smbc_setNetbiosName(context, netbios_name);
651 SAFE_FREE(netbios_name);
653 if (!smbc_getNetbiosName(context)) {
660 DEBUG(1, ("Using netbios name %s.\n", smbc_getNetbiosName(context)));
662 if (!smbc_getWorkgroup(context)) {
663 const char *workgroup;
665 if (lp_workgroup()) {
666 workgroup = lp_workgroup();
668 /* TODO: Think about a decent default workgroup */
672 smbc_setWorkgroup(context, workgroup);
674 if (!smbc_getWorkgroup(context)) {
681 DEBUG(1, ("Using workgroup %s.\n", smbc_getWorkgroup(context)));
683 /* shortest timeout is 1 second */
684 if (smbc_getTimeout(context) > 0 && smbc_getTimeout(context) < 1000)
685 smbc_setTimeout(context, 1000);
687 context->internal->initialized = True;
689 /* Protect access to the count of contexts in use */
690 if (SMB_THREAD_LOCK(initialized_ctx_count_mutex) != 0) {
691 smb_panic("error locking 'initialized_ctx_count'");
694 initialized_ctx_count++;
696 /* Unlock the mutex */
697 if (SMB_THREAD_UNLOCK(initialized_ctx_count_mutex) != 0) {
698 smb_panic("error unlocking 'initialized_ctx_count'");
706 /* Return the version of samba, and thus libsmbclient */
710 return samba_version_string();
714 * Set the credentials so DFS will work when following referrals.
715 * This function is broken and must be removed. No SMBCCTX arg...
720 smbc_set_credentials(const char *workgroup,
722 const char *password,
723 smbc_bool use_kerberos,
724 const char *signing_state)
726 d_printf("smbc_set_credentials is obsolete. Replace with smbc_set_credentials_with_fallback().\n");
729 void smbc_set_credentials_with_fallback(SMBCCTX *context,
730 const char *workgroup,
732 const char *password)
734 smbc_bool use_kerberos = false;
735 const char *signing_state = "off";
736 struct user_auth_info *auth_info = NULL;
744 frame = talloc_stackframe();
746 if (! workgroup || ! *workgroup) {
747 workgroup = smbc_getWorkgroup(context);
751 user = smbc_getUser(context);
758 auth_info = user_auth_info_init(NULL);
761 DEBUG(0, ("smbc_set_credentials_with_fallback: allocation fail\n"));
766 if (smbc_getOptionUseKerberos(context)) {
770 if (lp_client_signing() != SMB_SIGNING_OFF) {
771 signing_state = "if_required";
774 if (lp_client_signing() == SMB_SIGNING_REQUIRED) {
775 signing_state = "required";
778 set_cmdline_auth_info_username(auth_info, user);
779 set_cmdline_auth_info_domain(auth_info, workgroup);
780 set_cmdline_auth_info_password(auth_info, password);
781 set_cmdline_auth_info_use_kerberos(auth_info, use_kerberos);
782 set_cmdline_auth_info_signing_state(auth_info, signing_state);
783 set_cmdline_auth_info_fallback_after_kerberos(auth_info,
784 smbc_getOptionFallbackAfterKerberos(context));
785 set_cmdline_auth_info_use_ccache(
786 auth_info, smbc_getOptionUseCCache(context));
788 TALLOC_FREE(context->internal->auth_info);
790 context->internal->auth_info = auth_info;