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 "libsmbclient.h"
27 #include "libsmb_internal.h"
32 * Is the logging working / configfile read ?
34 static bool SMBC_initialized = false;
35 static unsigned int initialized_ctx_count = 0;
36 static void *initialized_ctx_count_mutex = NULL;
39 * Do some module- and library-wide intializations
42 SMBC_module_init(void * punused)
44 bool conf_loaded = False;
46 TALLOC_CTX *frame = talloc_stackframe();
48 load_case_tables_library();
50 setup_logging("libsmbclient", DEBUG_STDOUT);
52 /* Here we would open the smb.conf file if needed ... */
54 lp_set_in_client(True);
56 home = getenv("HOME");
59 if (asprintf(&conf, "%s/.smb/smb.conf", home) > 0) {
60 if (lp_load(conf, True, False, False, True)) {
63 DEBUG(5, ("Could not load config file: %s\n",
72 * Well, if that failed, try the get_dyn_CONFIGFILE
73 * Which points to the standard locn, and if that
74 * fails, silently ignore it and use the internal
78 if (!lp_load(get_dyn_CONFIGFILE(), True, False, False, False)) {
79 DEBUG(5, ("Could not load config file: %s\n",
80 get_dyn_CONFIGFILE()));
84 * We loaded the global config file. Now lets
85 * load user-specific modifications to the
89 "%s/.smb/smb.conf.append",
91 if (!lp_load(conf, True, False, False, False)) {
93 ("Could not append config file: "
102 load_interfaces(); /* Load the list of interfaces ... */
104 reopen_logs(); /* Get logging working ... */
107 * Block SIGPIPE (from lib/util_sock.c: write())
108 * It is not needed and should not stop execution
110 BlockSignals(True, SIGPIPE);
112 /* Create the mutex we'll use to protect initialized_ctx_count */
113 if (SMB_THREAD_CREATE_MUTEX("initialized_ctx_count_mutex",
114 initialized_ctx_count_mutex) != 0) {
115 smb_panic("SMBC_module_init: "
116 "failed to create 'initialized_ctx_count' mutex");
125 SMBC_module_terminate(void)
129 SMBC_initialized = false;
134 * Get a new empty handle to fill in with your own info
137 smbc_new_context(void)
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);
154 ZERO_STRUCTP(context);
156 context->internal = SMB_MALLOC_P(struct SMBC_internal_data);
157 if (!context->internal) {
163 /* Initialize the context and establish reasonable defaults */
164 ZERO_STRUCTP(context->internal);
166 smbc_setDebug(context, 0);
167 smbc_setTimeout(context, 20000);
169 smbc_setOptionFullTimeNames(context, False);
170 smbc_setOptionOpenShareMode(context, SMBC_SHAREMODE_DENY_NONE);
171 smbc_setOptionSmbEncryptionLevel(context, SMBC_ENCRYPTLEVEL_NONE);
172 smbc_setOptionUseCCache(context, True);
173 smbc_setOptionCaseSensitive(context, False);
174 smbc_setOptionBrowseMaxLmbCount(context, 3); /* # LMBs to query */
175 smbc_setOptionUrlEncodeReaddirEntries(context, False);
176 smbc_setOptionOneSharePerServer(context, False);
177 if (getenv("LIBSMBCLIENT_NO_CCACHE") == NULL) {
178 smbc_setOptionUseCCache(context, true);
181 smbc_setFunctionAuthData(context, SMBC_get_auth_data);
182 smbc_setFunctionCheckServer(context, SMBC_check_server);
183 smbc_setFunctionRemoveUnusedServer(context, SMBC_remove_unused_server);
185 smbc_setOptionUserData(context, NULL);
186 smbc_setFunctionAddCachedServer(context, SMBC_add_cached_server);
187 smbc_setFunctionGetCachedServer(context, SMBC_get_cached_server);
188 smbc_setFunctionRemoveCachedServer(context, SMBC_remove_cached_server);
189 smbc_setFunctionPurgeCachedServers(context, SMBC_purge_cached_servers);
191 smbc_setFunctionOpen(context, SMBC_open_ctx);
192 smbc_setFunctionCreat(context, SMBC_creat_ctx);
193 smbc_setFunctionRead(context, SMBC_read_ctx);
194 smbc_setFunctionWrite(context, SMBC_write_ctx);
195 smbc_setFunctionClose(context, SMBC_close_ctx);
196 smbc_setFunctionUnlink(context, SMBC_unlink_ctx);
197 smbc_setFunctionRename(context, SMBC_rename_ctx);
198 smbc_setFunctionLseek(context, SMBC_lseek_ctx);
199 smbc_setFunctionFtruncate(context, SMBC_ftruncate_ctx);
200 smbc_setFunctionStat(context, SMBC_stat_ctx);
201 smbc_setFunctionStatVFS(context, SMBC_statvfs_ctx);
202 smbc_setFunctionFstatVFS(context, SMBC_fstatvfs_ctx);
203 smbc_setFunctionFstat(context, SMBC_fstat_ctx);
204 smbc_setFunctionOpendir(context, SMBC_opendir_ctx);
205 smbc_setFunctionClosedir(context, SMBC_closedir_ctx);
206 smbc_setFunctionReaddir(context, SMBC_readdir_ctx);
207 smbc_setFunctionGetdents(context, SMBC_getdents_ctx);
208 smbc_setFunctionMkdir(context, SMBC_mkdir_ctx);
209 smbc_setFunctionRmdir(context, SMBC_rmdir_ctx);
210 smbc_setFunctionTelldir(context, SMBC_telldir_ctx);
211 smbc_setFunctionLseekdir(context, SMBC_lseekdir_ctx);
212 smbc_setFunctionFstatdir(context, SMBC_fstatdir_ctx);
213 smbc_setFunctionChmod(context, SMBC_chmod_ctx);
214 smbc_setFunctionUtimes(context, SMBC_utimes_ctx);
215 smbc_setFunctionSetxattr(context, SMBC_setxattr_ctx);
216 smbc_setFunctionGetxattr(context, SMBC_getxattr_ctx);
217 smbc_setFunctionRemovexattr(context, SMBC_removexattr_ctx);
218 smbc_setFunctionListxattr(context, SMBC_listxattr_ctx);
220 smbc_setFunctionOpenPrintJob(context, SMBC_open_print_job_ctx);
221 smbc_setFunctionPrintFile(context, SMBC_print_file_ctx);
222 smbc_setFunctionListPrintJobs(context, SMBC_list_print_jobs_ctx);
223 smbc_setFunctionUnlinkPrintJob(context, SMBC_unlink_print_job_ctx);
231 * Returns 0 on success. Otherwise returns 1, the SMBCCTX is _not_ freed
232 * and thus you'll be leaking memory if not handled properly.
236 smbc_free_context(SMBCCTX *context,
246 DEBUG(1,("Performing aggressive shutdown.\n"));
248 f = context->internal->files;
250 smbc_getFunctionClose(context)(context, f);
253 context->internal->files = NULL;
255 /* First try to remove the servers the nice way. */
256 if (smbc_getFunctionPurgeCachedServers(context)(context)) {
259 DEBUG(1, ("Could not purge all servers, "
260 "Nice way shutdown failed.\n"));
261 s = context->internal->servers;
263 DEBUG(1, ("Forced shutdown: %p (fd=%d)\n",
265 cli_shutdown(s->cli);
266 smbc_getFunctionRemoveCachedServer(context)(context,
269 DLIST_REMOVE(context->internal->servers, s);
273 context->internal->servers = NULL;
277 /* This is the polite way */
278 if (smbc_getFunctionPurgeCachedServers(context)(context)) {
279 DEBUG(1, ("Could not purge all servers, "
280 "free_context failed.\n"));
284 if (context->internal->servers) {
285 DEBUG(1, ("Active servers in context, "
286 "free_context failed.\n"));
290 if (context->internal->files) {
291 DEBUG(1, ("Active files in context, "
292 "free_context failed.\n"));
298 /* Things we have to clean up */
299 smbc_setWorkgroup(context, NULL);
300 smbc_setNetbiosName(context, NULL);
301 smbc_setUser(context, NULL);
303 DEBUG(3, ("Context %p successfully freed\n", context));
305 /* Free any DFS auth context. */
306 TALLOC_FREE(context->internal->auth_info);
308 SAFE_FREE(context->internal);
311 /* Protect access to the count of contexts in use */
312 if (SMB_THREAD_LOCK(initialized_ctx_count_mutex) != 0) {
313 smb_panic("error locking 'initialized_ctx_count'");
316 if (initialized_ctx_count) {
317 initialized_ctx_count--;
320 if (initialized_ctx_count == 0) {
321 SMBC_module_terminate();
324 /* Unlock the mutex */
325 if (SMB_THREAD_UNLOCK(initialized_ctx_count_mutex) != 0) {
326 smb_panic("error unlocking 'initialized_ctx_count'");
334 * Deprecated interface. Do not use. Instead, use the various
335 * smbc_setOption*() functions or smbc_setFunctionAuthDataWithContext().
338 smbc_option_set(SMBCCTX *context,
340 ... /* option_value */)
346 smbc_get_auth_data_with_context_fn auth_fn;
351 va_start(ap, option_name);
353 if (strcmp(option_name, "debug_to_stderr") == 0) {
354 option_value.b = (bool) va_arg(ap, int);
355 smbc_setOptionDebugToStderr(context, option_value.b);
357 } else if (strcmp(option_name, "full_time_names") == 0) {
358 option_value.b = (bool) va_arg(ap, int);
359 smbc_setOptionFullTimeNames(context, option_value.b);
361 } else if (strcmp(option_name, "open_share_mode") == 0) {
362 option_value.i = va_arg(ap, int);
363 smbc_setOptionOpenShareMode(context, option_value.i);
365 } else if (strcmp(option_name, "auth_function") == 0) {
366 option_value.auth_fn =
367 va_arg(ap, smbc_get_auth_data_with_context_fn);
368 smbc_setFunctionAuthDataWithContext(context, option_value.auth_fn);
370 } else if (strcmp(option_name, "user_data") == 0) {
371 option_value.v = va_arg(ap, void *);
372 smbc_setOptionUserData(context, option_value.v);
374 } else if (strcmp(option_name, "smb_encrypt_level") == 0) {
375 option_value.s = va_arg(ap, const char *);
376 if (strcmp(option_value.s, "none") == 0) {
377 smbc_setOptionSmbEncryptionLevel(context,
378 SMBC_ENCRYPTLEVEL_NONE);
379 } else if (strcmp(option_value.s, "request") == 0) {
380 smbc_setOptionSmbEncryptionLevel(context,
381 SMBC_ENCRYPTLEVEL_REQUEST);
382 } else if (strcmp(option_value.s, "require") == 0) {
383 smbc_setOptionSmbEncryptionLevel(context,
384 SMBC_ENCRYPTLEVEL_REQUIRE);
387 } else if (strcmp(option_name, "browse_max_lmb_count") == 0) {
388 option_value.i = va_arg(ap, int);
389 smbc_setOptionBrowseMaxLmbCount(context, option_value.i);
391 } else if (strcmp(option_name, "urlencode_readdir_entries") == 0) {
392 option_value.b = (bool) va_arg(ap, int);
393 smbc_setOptionUrlEncodeReaddirEntries(context, option_value.b);
395 } else if (strcmp(option_name, "one_share_per_server") == 0) {
396 option_value.b = (bool) va_arg(ap, int);
397 smbc_setOptionOneSharePerServer(context, option_value.b);
399 } else if (strcmp(option_name, "use_kerberos") == 0) {
400 option_value.b = (bool) va_arg(ap, int);
401 smbc_setOptionUseKerberos(context, option_value.b);
403 } else if (strcmp(option_name, "fallback_after_kerberos") == 0) {
404 option_value.b = (bool) va_arg(ap, int);
405 smbc_setOptionFallbackAfterKerberos(context, option_value.b);
407 } else if (strcmp(option_name, "use_ccache") == 0) {
408 option_value.b = (bool) va_arg(ap, int);
409 smbc_setOptionUseCCache(context, option_value.b);
411 } else if (strcmp(option_name, "no_auto_anonymous_login") == 0) {
412 option_value.b = (bool) va_arg(ap, int);
413 smbc_setOptionNoAutoAnonymousLogin(context, option_value.b);
421 * Deprecated interface. Do not use. Instead, use the various
422 * smbc_getOption*() functions.
425 smbc_option_get(SMBCCTX *context,
428 if (strcmp(option_name, "debug_stderr") == 0) {
429 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
430 return (void *) (intptr_t) smbc_getOptionDebugToStderr(context);
432 return (void *) smbc_getOptionDebugToStderr(context);
435 } else if (strcmp(option_name, "full_time_names") == 0) {
436 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
437 return (void *) (intptr_t) smbc_getOptionFullTimeNames(context);
439 return (void *) smbc_getOptionFullTimeNames(context);
442 } else if (strcmp(option_name, "open_share_mode") == 0) {
443 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
444 return (void *) (intptr_t) smbc_getOptionOpenShareMode(context);
446 return (void *) smbc_getOptionOpenShareMode(context);
449 } else if (strcmp(option_name, "auth_function") == 0) {
450 return (void *) smbc_getFunctionAuthDataWithContext(context);
452 } else if (strcmp(option_name, "user_data") == 0) {
453 return smbc_getOptionUserData(context);
455 } else if (strcmp(option_name, "smb_encrypt_level") == 0) {
456 switch(smbc_getOptionSmbEncryptionLevel(context))
459 return (void *) "none";
461 return (void *) "request";
463 return (void *) "require";
466 } else if (strcmp(option_name, "smb_encrypt_on") == 0) {
468 unsigned int num_servers = 0;
470 for (s = context->internal->servers; s; s = s->next) {
472 if (s->cli->trans_enc_state == NULL) {
473 return (void *)false;
476 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
477 return (void *) (intptr_t) (bool) (num_servers > 0);
479 return (void *) (bool) (num_servers > 0);
482 } else if (strcmp(option_name, "browse_max_lmb_count") == 0) {
483 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
484 return (void *) (intptr_t) smbc_getOptionBrowseMaxLmbCount(context);
486 return (void *) smbc_getOptionBrowseMaxLmbCount(context);
489 } else if (strcmp(option_name, "urlencode_readdir_entries") == 0) {
490 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
491 return (void *)(intptr_t) smbc_getOptionUrlEncodeReaddirEntries(context);
493 return (void *) (bool) smbc_getOptionUrlEncodeReaddirEntries(context);
496 } else if (strcmp(option_name, "one_share_per_server") == 0) {
497 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
498 return (void *) (intptr_t) smbc_getOptionOneSharePerServer(context);
500 return (void *) (bool) smbc_getOptionOneSharePerServer(context);
503 } else if (strcmp(option_name, "use_kerberos") == 0) {
504 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
505 return (void *) (intptr_t) smbc_getOptionUseKerberos(context);
507 return (void *) (bool) smbc_getOptionUseKerberos(context);
510 } else if (strcmp(option_name, "fallback_after_kerberos") == 0) {
511 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
512 return (void *)(intptr_t) smbc_getOptionFallbackAfterKerberos(context);
514 return (void *) (bool) smbc_getOptionFallbackAfterKerberos(context);
517 } else if (strcmp(option_name, "use_ccache") == 0) {
518 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
519 return (void *) (intptr_t) smbc_getOptionUseCCache(context);
521 return (void *) (bool) smbc_getOptionUseCCache(context);
524 } else if (strcmp(option_name, "no_auto_anonymous_login") == 0) {
525 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
526 return (void *) (intptr_t) smbc_getOptionNoAutoAnonymousLogin(context);
528 return (void *) (bool) smbc_getOptionNoAutoAnonymousLogin(context);
537 * Initialize the library, etc.
539 * We accept a struct containing handle information.
540 * valid values for info->debug from 0 to 100,
541 * and insist that info->fn must be non-null.
544 smbc_init_context(SMBCCTX *context)
553 /* Do not initialise the same client twice */
554 if (context->internal->initialized) {
558 if ((!smbc_getFunctionAuthData(context) &&
559 !smbc_getFunctionAuthDataWithContext(context)) ||
560 smbc_getDebug(context) < 0 ||
561 smbc_getDebug(context) > 100) {
568 if (!smbc_getUser(context)) {
570 * FIXME: Is this the best way to get the user info?
572 char *user = getenv("USER");
573 /* walk around as "guest" if no username can be found */
575 user = SMB_STRDUP("guest");
577 user = SMB_STRDUP(user);
585 smbc_setUser(context, user);
588 if (!smbc_getUser(context)) {
594 if (!smbc_getNetbiosName(context)) {
596 * We try to get our netbios name from the config. If that
597 * fails we fall back on constructing our netbios name from
601 if (global_myname()) {
602 netbios_name = SMB_STRDUP(global_myname());
605 * Hmmm, I want to get hostname as well, but I am too
606 * lazy for the moment
609 netbios_name = (char *)SMB_MALLOC(17);
614 slprintf(netbios_name, 16,
615 "smbc%s%d", smbc_getUser(context), pid);
623 smbc_setNetbiosName(context, netbios_name);
624 SAFE_FREE(netbios_name);
626 if (!smbc_getNetbiosName(context)) {
632 DEBUG(1, ("Using netbios name %s.\n", smbc_getNetbiosName(context)));
634 if (!smbc_getWorkgroup(context)) {
637 if (lp_workgroup()) {
638 workgroup = SMB_STRDUP(lp_workgroup());
641 /* TODO: Think about a decent default workgroup */
642 workgroup = SMB_STRDUP("samba");
650 smbc_setWorkgroup(context, workgroup);
651 SAFE_FREE(workgroup);
653 if (!smbc_getWorkgroup(context)) {
659 DEBUG(1, ("Using workgroup %s.\n", smbc_getWorkgroup(context)));
661 /* shortest timeout is 1 second */
662 if (smbc_getTimeout(context) > 0 && smbc_getTimeout(context) < 1000)
663 smbc_setTimeout(context, 1000);
665 context->internal->initialized = True;
667 /* Protect access to the count of contexts in use */
668 if (SMB_THREAD_LOCK(initialized_ctx_count_mutex) != 0) {
669 smb_panic("error locking 'initialized_ctx_count'");
672 initialized_ctx_count++;
674 /* Unlock the mutex */
675 if (SMB_THREAD_UNLOCK(initialized_ctx_count_mutex) != 0) {
676 smb_panic("error unlocking 'initialized_ctx_count'");
683 /* Return the verion of samba, and thus libsmbclient */
687 return samba_version_string();
691 * Set the credentials so DFS will work when following referrals.
692 * This function is broken and must be removed. No SMBCCTX arg...
697 smbc_set_credentials(const char *workgroup,
699 const char *password,
700 smbc_bool use_kerberos,
701 const char *signing_state)
703 d_printf("smbc_set_credentials is obsolete. Replace with smbc_set_credentials_with_fallback().\n");
706 void smbc_set_credentials_with_fallback(SMBCCTX *context,
707 const char *workgroup,
709 const char *password)
711 smbc_bool use_kerberos = false;
712 const char *signing_state = "off";
713 struct user_auth_info *auth_info = NULL;
720 if (! workgroup || ! *workgroup) {
721 workgroup = smbc_getWorkgroup(context);
725 user = smbc_getUser(context);
732 auth_info = user_auth_info_init(NULL);
735 DEBUG(0, ("smbc_set_credentials_with_fallback: allocation fail\n"));
739 if (smbc_getOptionUseKerberos(context)) {
743 if (lp_client_signing()) {
744 signing_state = "on";
747 if (lp_client_signing() == Required) {
748 signing_state = "force";
751 set_cmdline_auth_info_username(auth_info, user);
752 set_cmdline_auth_info_password(auth_info, password);
753 set_cmdline_auth_info_use_kerberos(auth_info, use_kerberos);
754 set_cmdline_auth_info_signing_state(auth_info, signing_state);
755 set_cmdline_auth_info_fallback_after_kerberos(auth_info,
756 smbc_getOptionFallbackAfterKerberos(context));
757 set_cmdline_auth_info_use_ccache(
758 auth_info, smbc_getOptionUseCCache(context));
759 set_global_myworkgroup(workgroup);
761 TALLOC_FREE(context->internal->auth_info);
763 context->internal->auth_info = auth_info;