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_setFunctionGetdents(context, SMBC_getdents_ctx);
213 smbc_setFunctionMkdir(context, SMBC_mkdir_ctx);
214 smbc_setFunctionRmdir(context, SMBC_rmdir_ctx);
215 smbc_setFunctionTelldir(context, SMBC_telldir_ctx);
216 smbc_setFunctionLseekdir(context, SMBC_lseekdir_ctx);
217 smbc_setFunctionFstatdir(context, SMBC_fstatdir_ctx);
218 smbc_setFunctionNotify(context, SMBC_notify_ctx);
219 smbc_setFunctionChmod(context, SMBC_chmod_ctx);
220 smbc_setFunctionUtimes(context, SMBC_utimes_ctx);
221 smbc_setFunctionSetxattr(context, SMBC_setxattr_ctx);
222 smbc_setFunctionGetxattr(context, SMBC_getxattr_ctx);
223 smbc_setFunctionRemovexattr(context, SMBC_removexattr_ctx);
224 smbc_setFunctionListxattr(context, SMBC_listxattr_ctx);
226 smbc_setFunctionOpenPrintJob(context, SMBC_open_print_job_ctx);
227 smbc_setFunctionPrintFile(context, SMBC_print_file_ctx);
228 smbc_setFunctionListPrintJobs(context, SMBC_list_print_jobs_ctx);
229 smbc_setFunctionUnlinkPrintJob(context, SMBC_unlink_print_job_ctx);
238 * Returns 0 on success. Otherwise returns 1, the SMBCCTX is _not_ freed
239 * and thus you'll be leaking memory if not handled properly.
243 smbc_free_context(SMBCCTX *context,
252 frame = talloc_stackframe();
256 DEBUG(1,("Performing aggressive shutdown.\n"));
258 f = context->internal->files;
260 SMBCFILE *next = f->next;
261 smbc_getFunctionClose(context)(context, f);
264 context->internal->files = NULL;
266 /* First try to remove the servers the nice way. */
267 if (smbc_getFunctionPurgeCachedServers(context)(context)) {
270 DEBUG(1, ("Could not purge all servers, "
271 "Nice way shutdown failed.\n"));
272 s = context->internal->servers;
274 DEBUG(1, ("Forced shutdown: %p (cli=%p)\n",
276 cli_shutdown(s->cli);
277 smbc_getFunctionRemoveCachedServer(context)(context,
280 DLIST_REMOVE(context->internal->servers, s);
284 context->internal->servers = NULL;
288 /* This is the polite way */
289 if (smbc_getFunctionPurgeCachedServers(context)(context)) {
290 DEBUG(1, ("Could not purge all servers, "
291 "free_context failed.\n"));
296 if (context->internal->servers) {
297 DEBUG(1, ("Active servers in context, "
298 "free_context failed.\n"));
303 if (context->internal->files) {
304 DEBUG(1, ("Active files in context, "
305 "free_context failed.\n"));
312 /* Things we have to clean up */
313 smbc_setWorkgroup(context, NULL);
314 smbc_setNetbiosName(context, NULL);
315 smbc_setUser(context, NULL);
317 DEBUG(3, ("Context %p successfully freed\n", context));
319 /* Free any DFS auth context. */
320 TALLOC_FREE(context->internal->auth_info);
322 SAFE_FREE(context->internal);
325 /* Protect access to the count of contexts in use */
326 if (SMB_THREAD_LOCK(initialized_ctx_count_mutex) != 0) {
327 smb_panic("error locking 'initialized_ctx_count'");
330 if (initialized_ctx_count) {
331 initialized_ctx_count--;
334 if (initialized_ctx_count == 0) {
335 SMBC_module_terminate();
338 /* Unlock the mutex */
339 if (SMB_THREAD_UNLOCK(initialized_ctx_count_mutex) != 0) {
340 smb_panic("error unlocking 'initialized_ctx_count'");
349 * Deprecated interface. Do not use. Instead, use the various
350 * smbc_setOption*() functions or smbc_setFunctionAuthDataWithContext().
353 smbc_option_set(SMBCCTX *context,
355 ... /* option_value */)
361 smbc_get_auth_data_with_context_fn auth_fn;
366 TALLOC_CTX *frame = talloc_stackframe();
368 va_start(ap, option_name);
370 if (strcmp(option_name, "debug_to_stderr") == 0) {
371 option_value.b = (bool) va_arg(ap, int);
372 smbc_setOptionDebugToStderr(context, option_value.b);
374 } else if (strcmp(option_name, "full_time_names") == 0) {
375 option_value.b = (bool) va_arg(ap, int);
376 smbc_setOptionFullTimeNames(context, option_value.b);
378 } else if (strcmp(option_name, "open_share_mode") == 0) {
379 option_value.i = va_arg(ap, int);
380 smbc_setOptionOpenShareMode(context, option_value.i);
382 } else if (strcmp(option_name, "auth_function") == 0) {
383 option_value.auth_fn =
384 va_arg(ap, smbc_get_auth_data_with_context_fn);
385 smbc_setFunctionAuthDataWithContext(context, option_value.auth_fn);
387 } else if (strcmp(option_name, "user_data") == 0) {
388 option_value.v = va_arg(ap, void *);
389 smbc_setOptionUserData(context, option_value.v);
391 } else if (strcmp(option_name, "smb_encrypt_level") == 0) {
392 option_value.s = va_arg(ap, const char *);
393 if (strcmp(option_value.s, "none") == 0) {
394 smbc_setOptionSmbEncryptionLevel(context,
395 SMBC_ENCRYPTLEVEL_NONE);
396 } else if (strcmp(option_value.s, "request") == 0) {
397 smbc_setOptionSmbEncryptionLevel(context,
398 SMBC_ENCRYPTLEVEL_REQUEST);
399 } else if (strcmp(option_value.s, "require") == 0) {
400 smbc_setOptionSmbEncryptionLevel(context,
401 SMBC_ENCRYPTLEVEL_REQUIRE);
404 } else if (strcmp(option_name, "browse_max_lmb_count") == 0) {
405 option_value.i = va_arg(ap, int);
406 smbc_setOptionBrowseMaxLmbCount(context, option_value.i);
408 } else if (strcmp(option_name, "urlencode_readdir_entries") == 0) {
409 option_value.b = (bool) va_arg(ap, int);
410 smbc_setOptionUrlEncodeReaddirEntries(context, option_value.b);
412 } else if (strcmp(option_name, "one_share_per_server") == 0) {
413 option_value.b = (bool) va_arg(ap, int);
414 smbc_setOptionOneSharePerServer(context, option_value.b);
416 } else if (strcmp(option_name, "use_kerberos") == 0) {
417 option_value.b = (bool) va_arg(ap, int);
418 smbc_setOptionUseKerberos(context, option_value.b);
420 } else if (strcmp(option_name, "fallback_after_kerberos") == 0) {
421 option_value.b = (bool) va_arg(ap, int);
422 smbc_setOptionFallbackAfterKerberos(context, option_value.b);
424 } else if (strcmp(option_name, "use_ccache") == 0) {
425 option_value.b = (bool) va_arg(ap, int);
426 smbc_setOptionUseCCache(context, option_value.b);
428 } else if (strcmp(option_name, "no_auto_anonymous_login") == 0) {
429 option_value.b = (bool) va_arg(ap, int);
430 smbc_setOptionNoAutoAnonymousLogin(context, option_value.b);
439 * Deprecated interface. Do not use. Instead, use the various
440 * smbc_getOption*() functions.
443 smbc_option_get(SMBCCTX *context,
446 if (strcmp(option_name, "debug_stderr") == 0) {
447 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
448 return (void *) (intptr_t) smbc_getOptionDebugToStderr(context);
450 return (void *) smbc_getOptionDebugToStderr(context);
453 } else if (strcmp(option_name, "full_time_names") == 0) {
454 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
455 return (void *) (intptr_t) smbc_getOptionFullTimeNames(context);
457 return (void *) smbc_getOptionFullTimeNames(context);
460 } else if (strcmp(option_name, "open_share_mode") == 0) {
461 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
462 return (void *) (intptr_t) smbc_getOptionOpenShareMode(context);
464 return (void *) smbc_getOptionOpenShareMode(context);
467 } else if (strcmp(option_name, "auth_function") == 0) {
468 return (void *) smbc_getFunctionAuthDataWithContext(context);
470 } else if (strcmp(option_name, "user_data") == 0) {
471 return smbc_getOptionUserData(context);
473 } else if (strcmp(option_name, "smb_encrypt_level") == 0) {
474 switch(smbc_getOptionSmbEncryptionLevel(context))
477 return discard_const_p(void, "none");
479 return discard_const_p(void, "request");
481 return discard_const_p(void, "require");
484 } else if (strcmp(option_name, "smb_encrypt_on") == 0) {
486 unsigned int num_servers = 0;
488 for (s = context->internal->servers; s; s = s->next) {
490 if (!cli_state_is_encryption_on(s->cli)) {
491 return (void *)false;
494 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
495 return (void *) (intptr_t) (bool) (num_servers > 0);
497 return (void *) (bool) (num_servers > 0);
500 } else if (strcmp(option_name, "browse_max_lmb_count") == 0) {
501 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
502 return (void *) (intptr_t) smbc_getOptionBrowseMaxLmbCount(context);
504 return (void *) smbc_getOptionBrowseMaxLmbCount(context);
507 } else if (strcmp(option_name, "urlencode_readdir_entries") == 0) {
508 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
509 return (void *)(intptr_t) smbc_getOptionUrlEncodeReaddirEntries(context);
511 return (void *) (bool) smbc_getOptionUrlEncodeReaddirEntries(context);
514 } else if (strcmp(option_name, "one_share_per_server") == 0) {
515 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
516 return (void *) (intptr_t) smbc_getOptionOneSharePerServer(context);
518 return (void *) (bool) smbc_getOptionOneSharePerServer(context);
521 } else if (strcmp(option_name, "use_kerberos") == 0) {
522 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
523 return (void *) (intptr_t) smbc_getOptionUseKerberos(context);
525 return (void *) (bool) smbc_getOptionUseKerberos(context);
528 } else if (strcmp(option_name, "fallback_after_kerberos") == 0) {
529 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
530 return (void *)(intptr_t) smbc_getOptionFallbackAfterKerberos(context);
532 return (void *) (bool) smbc_getOptionFallbackAfterKerberos(context);
535 } else if (strcmp(option_name, "use_ccache") == 0) {
536 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
537 return (void *) (intptr_t) smbc_getOptionUseCCache(context);
539 return (void *) (bool) smbc_getOptionUseCCache(context);
542 } else if (strcmp(option_name, "no_auto_anonymous_login") == 0) {
543 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
544 return (void *) (intptr_t) smbc_getOptionNoAutoAnonymousLogin(context);
546 return (void *) (bool) smbc_getOptionNoAutoAnonymousLogin(context);
555 * Initialize the library, etc.
557 * We accept a struct containing handle information.
558 * valid values for info->debug from 0 to 100,
559 * and insist that info->fn must be non-null.
562 smbc_init_context(SMBCCTX *context)
572 /* Do not initialise the same client twice */
573 if (context->internal->initialized) {
577 frame = talloc_stackframe();
579 if ((!smbc_getFunctionAuthData(context) &&
580 !smbc_getFunctionAuthDataWithContext(context)) ||
581 smbc_getDebug(context) < 0 ||
582 smbc_getDebug(context) > 100) {
590 if (!smbc_getUser(context)) {
592 * FIXME: Is this the best way to get the user info?
594 char *user = getenv("USER");
595 /* walk around as "guest" if no username can be found */
597 user = SMB_STRDUP("guest");
599 user = SMB_STRDUP(user);
608 smbc_setUser(context, user);
611 if (!smbc_getUser(context)) {
618 if (!smbc_getNetbiosName(context)) {
620 * We try to get our netbios name from the config. If that
621 * fails we fall back on constructing our netbios name from
625 if (lp_netbios_name()) {
626 netbios_name = SMB_STRDUP(lp_netbios_name());
629 * Hmmm, I want to get hostname as well, but I am too
630 * lazy for the moment
633 netbios_name = (char *)SMB_MALLOC(17);
639 slprintf(netbios_name, 16,
640 "smbc%s%d", smbc_getUser(context), pid);
649 smbc_setNetbiosName(context, netbios_name);
650 SAFE_FREE(netbios_name);
652 if (!smbc_getNetbiosName(context)) {
659 DEBUG(1, ("Using netbios name %s.\n", smbc_getNetbiosName(context)));
661 if (!smbc_getWorkgroup(context)) {
664 if (lp_workgroup()) {
665 workgroup = SMB_STRDUP(lp_workgroup());
668 /* TODO: Think about a decent default workgroup */
669 workgroup = SMB_STRDUP("samba");
678 smbc_setWorkgroup(context, workgroup);
679 SAFE_FREE(workgroup);
681 if (!smbc_getWorkgroup(context)) {
688 DEBUG(1, ("Using workgroup %s.\n", smbc_getWorkgroup(context)));
690 /* shortest timeout is 1 second */
691 if (smbc_getTimeout(context) > 0 && smbc_getTimeout(context) < 1000)
692 smbc_setTimeout(context, 1000);
694 context->internal->initialized = True;
696 /* Protect access to the count of contexts in use */
697 if (SMB_THREAD_LOCK(initialized_ctx_count_mutex) != 0) {
698 smb_panic("error locking 'initialized_ctx_count'");
701 initialized_ctx_count++;
703 /* Unlock the mutex */
704 if (SMB_THREAD_UNLOCK(initialized_ctx_count_mutex) != 0) {
705 smb_panic("error unlocking 'initialized_ctx_count'");
713 /* Return the verion of samba, and thus libsmbclient */
717 return samba_version_string();
721 * Set the credentials so DFS will work when following referrals.
722 * This function is broken and must be removed. No SMBCCTX arg...
727 smbc_set_credentials(const char *workgroup,
729 const char *password,
730 smbc_bool use_kerberos,
731 const char *signing_state)
733 d_printf("smbc_set_credentials is obsolete. Replace with smbc_set_credentials_with_fallback().\n");
736 void smbc_set_credentials_with_fallback(SMBCCTX *context,
737 const char *workgroup,
739 const char *password)
741 smbc_bool use_kerberos = false;
742 const char *signing_state = "off";
743 struct user_auth_info *auth_info = NULL;
751 frame = talloc_stackframe();
753 if (! workgroup || ! *workgroup) {
754 workgroup = smbc_getWorkgroup(context);
758 user = smbc_getUser(context);
765 auth_info = user_auth_info_init(NULL);
768 DEBUG(0, ("smbc_set_credentials_with_fallback: allocation fail\n"));
773 if (smbc_getOptionUseKerberos(context)) {
777 if (lp_client_signing() != SMB_SIGNING_OFF) {
778 signing_state = "if_required";
781 if (lp_client_signing() == SMB_SIGNING_REQUIRED) {
782 signing_state = "required";
785 set_cmdline_auth_info_username(auth_info, user);
786 set_cmdline_auth_info_domain(auth_info, workgroup);
787 set_cmdline_auth_info_password(auth_info, password);
788 set_cmdline_auth_info_use_kerberos(auth_info, use_kerberos);
789 set_cmdline_auth_info_signing_state(auth_info, signing_state);
790 set_cmdline_auth_info_fallback_after_kerberos(auth_info,
791 smbc_getOptionFallbackAfterKerberos(context));
792 set_cmdline_auth_info_use_ccache(
793 auth_info, smbc_getOptionUseCCache(context));
795 TALLOC_FREE(context->internal->auth_info);
797 context->internal->auth_info = auth_info;