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"
31 * Is the logging working / configfile read ?
33 static bool SMBC_initialized = false;
34 static unsigned int initialized_ctx_count = 0;
35 static void *initialized_ctx_count_mutex = NULL;
38 * Do some module- and library-wide intializations
41 SMBC_module_init(void * punused)
43 bool conf_loaded = False;
45 TALLOC_CTX *frame = talloc_stackframe();
49 setup_logging("libsmbclient", True);
51 #if 0 /* need a place to put this (thread local storage) */
52 if (context->internal->debug_stderr) {
54 x_setbuf(x_stderr, NULL);
58 /* Here we would open the smb.conf file if needed ... */
60 lp_set_in_client(True);
62 home = getenv("HOME");
65 if (asprintf(&conf, "%s/.smb/smb.conf", home) > 0) {
66 if (lp_load(conf, True, False, False, True)) {
69 DEBUG(5, ("Could not load config file: %s\n",
78 * Well, if that failed, try the get_dyn_CONFIGFILE
79 * Which points to the standard locn, and if that
80 * fails, silently ignore it and use the internal
84 if (!lp_load(get_dyn_CONFIGFILE(), True, False, False, False)) {
85 DEBUG(5, ("Could not load config file: %s\n",
86 get_dyn_CONFIGFILE()));
90 * We loaded the global config file. Now lets
91 * load user-specific modifications to the
95 "%s/.smb/smb.conf.append",
97 if (!lp_load(conf, True, False, False, False)) {
99 ("Could not append config file: "
108 load_interfaces(); /* Load the list of interfaces ... */
110 reopen_logs(); /* Get logging working ... */
113 * Block SIGPIPE (from lib/util_sock.c: write())
114 * It is not needed and should not stop execution
116 BlockSignals(True, SIGPIPE);
118 /* Create the mutex we'll use to protect initialized_ctx_count */
119 if (SMB_THREAD_CREATE_MUTEX("initialized_ctx_count_mutex",
120 initialized_ctx_count_mutex) != 0) {
121 smb_panic("SMBC_module_init: "
122 "failed to create 'initialized_ctx_count' mutex");
131 SMBC_module_terminate(void)
136 SMBC_initialized = false;
141 * Get a new empty handle to fill in with your own info
144 smbc_new_context(void)
148 /* The first call to this function should initialize the module */
149 SMB_THREAD_ONCE(&SMBC_initialized, SMBC_module_init, NULL);
152 * All newly added context fields should be placed in
153 * SMBC_internal_data, not directly in SMBCCTX.
155 context = SMB_MALLOC_P(SMBCCTX);
161 ZERO_STRUCTP(context);
163 context->internal = SMB_MALLOC_P(struct SMBC_internal_data);
164 if (!context->internal) {
170 /* Initialize the context and establish reasonable defaults */
171 ZERO_STRUCTP(context->internal);
173 smbc_setDebug(context, 0);
174 smbc_setTimeout(context, 20000);
176 smbc_setOptionFullTimeNames(context, False);
177 smbc_setOptionOpenShareMode(context, SMBC_SHAREMODE_DENY_NONE);
178 smbc_setOptionSmbEncryptionLevel(context, SMBC_ENCRYPTLEVEL_NONE);
179 smbc_setOptionCaseSensitive(context, False);
180 smbc_setOptionBrowseMaxLmbCount(context, 3); /* # LMBs to query */
181 smbc_setOptionUrlEncodeReaddirEntries(context, False);
182 smbc_setOptionOneSharePerServer(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_setFunctionWrite(context, SMBC_write_ctx);
198 smbc_setFunctionClose(context, SMBC_close_ctx);
199 smbc_setFunctionUnlink(context, SMBC_unlink_ctx);
200 smbc_setFunctionRename(context, SMBC_rename_ctx);
201 smbc_setFunctionLseek(context, SMBC_lseek_ctx);
202 smbc_setFunctionFtruncate(context, SMBC_ftruncate_ctx);
203 smbc_setFunctionStat(context, SMBC_stat_ctx);
204 smbc_setFunctionStatVFS(context, SMBC_statvfs_ctx);
205 smbc_setFunctionFstatVFS(context, SMBC_fstatvfs_ctx);
206 smbc_setFunctionFstat(context, SMBC_fstat_ctx);
207 smbc_setFunctionOpendir(context, SMBC_opendir_ctx);
208 smbc_setFunctionClosedir(context, SMBC_closedir_ctx);
209 smbc_setFunctionReaddir(context, SMBC_readdir_ctx);
210 smbc_setFunctionGetdents(context, SMBC_getdents_ctx);
211 smbc_setFunctionMkdir(context, SMBC_mkdir_ctx);
212 smbc_setFunctionRmdir(context, SMBC_rmdir_ctx);
213 smbc_setFunctionTelldir(context, SMBC_telldir_ctx);
214 smbc_setFunctionLseekdir(context, SMBC_lseekdir_ctx);
215 smbc_setFunctionFstatdir(context, SMBC_fstatdir_ctx);
216 smbc_setFunctionChmod(context, SMBC_chmod_ctx);
217 smbc_setFunctionUtimes(context, SMBC_utimes_ctx);
218 smbc_setFunctionSetxattr(context, SMBC_setxattr_ctx);
219 smbc_setFunctionGetxattr(context, SMBC_getxattr_ctx);
220 smbc_setFunctionRemovexattr(context, SMBC_removexattr_ctx);
221 smbc_setFunctionListxattr(context, SMBC_listxattr_ctx);
223 smbc_setFunctionOpenPrintJob(context, SMBC_open_print_job_ctx);
224 smbc_setFunctionPrintFile(context, SMBC_print_file_ctx);
225 smbc_setFunctionListPrintJobs(context, SMBC_list_print_jobs_ctx);
226 smbc_setFunctionUnlinkPrintJob(context, SMBC_unlink_print_job_ctx);
234 * Returns 0 on success. Otherwise returns 1, the SMBCCTX is _not_ freed
235 * and thus you'll be leaking memory if not handled properly.
239 smbc_free_context(SMBCCTX *context,
249 DEBUG(1,("Performing aggressive shutdown.\n"));
251 f = context->internal->files;
253 smbc_getFunctionClose(context)(context, f);
256 context->internal->files = NULL;
258 /* First try to remove the servers the nice way. */
259 if (smbc_getFunctionPurgeCachedServers(context)(context)) {
262 DEBUG(1, ("Could not purge all servers, "
263 "Nice way shutdown failed.\n"));
264 s = context->internal->servers;
266 DEBUG(1, ("Forced shutdown: %p (fd=%d)\n",
268 cli_shutdown(s->cli);
269 smbc_getFunctionRemoveCachedServer(context)(context,
272 DLIST_REMOVE(context->internal->servers, s);
276 context->internal->servers = NULL;
280 /* This is the polite way */
281 if (smbc_getFunctionPurgeCachedServers(context)(context)) {
282 DEBUG(1, ("Could not purge all servers, "
283 "free_context failed.\n"));
287 if (context->internal->servers) {
288 DEBUG(1, ("Active servers in context, "
289 "free_context failed.\n"));
293 if (context->internal->files) {
294 DEBUG(1, ("Active files in context, "
295 "free_context failed.\n"));
301 /* Things we have to clean up */
302 free(smbc_getWorkgroup(context));
303 smbc_setWorkgroup(context, NULL);
305 free(smbc_getNetbiosName(context));
306 smbc_setNetbiosName(context, NULL);
308 free(smbc_getUser(context));
309 smbc_setUser(context, NULL);
311 DEBUG(3, ("Context %p successfully freed\n", context));
313 /* Free any DFS auth context. */
314 TALLOC_FREE(context->internal->auth_info);
316 SAFE_FREE(context->internal);
319 /* Protect access to the count of contexts in use */
320 if (SMB_THREAD_LOCK(initialized_ctx_count_mutex) != 0) {
321 smb_panic("error locking 'initialized_ctx_count'");
324 if (initialized_ctx_count) {
325 initialized_ctx_count--;
328 if (initialized_ctx_count == 0) {
329 SMBC_module_terminate();
332 /* Unlock the mutex */
333 if (SMB_THREAD_UNLOCK(initialized_ctx_count_mutex) != 0) {
334 smb_panic("error unlocking 'initialized_ctx_count'");
342 * Deprecated interface. Do not use. Instead, use the various
343 * smbc_setOption*() functions or smbc_setFunctionAuthDataWithContext().
346 smbc_option_set(SMBCCTX *context,
348 ... /* option_value */)
354 smbc_get_auth_data_with_context_fn auth_fn;
359 va_start(ap, option_name);
361 if (strcmp(option_name, "debug_to_stderr") == 0) {
362 option_value.b = (bool) va_arg(ap, int);
363 smbc_setOptionDebugToStderr(context, option_value.b);
365 } else if (strcmp(option_name, "full_time_names") == 0) {
366 option_value.b = (bool) va_arg(ap, int);
367 smbc_setOptionFullTimeNames(context, option_value.b);
369 } else if (strcmp(option_name, "open_share_mode") == 0) {
370 option_value.i = va_arg(ap, int);
371 smbc_setOptionOpenShareMode(context, option_value.i);
373 } else if (strcmp(option_name, "auth_function") == 0) {
374 option_value.auth_fn =
375 va_arg(ap, smbc_get_auth_data_with_context_fn);
376 smbc_setFunctionAuthDataWithContext(context, option_value.auth_fn);
378 } else if (strcmp(option_name, "user_data") == 0) {
379 option_value.v = va_arg(ap, void *);
380 smbc_setOptionUserData(context, option_value.v);
382 } else if (strcmp(option_name, "smb_encrypt_level") == 0) {
383 option_value.s = va_arg(ap, const char *);
384 if (strcmp(option_value.s, "none") == 0) {
385 smbc_setOptionSmbEncryptionLevel(context,
386 SMBC_ENCRYPTLEVEL_NONE);
387 } else if (strcmp(option_value.s, "request") == 0) {
388 smbc_setOptionSmbEncryptionLevel(context,
389 SMBC_ENCRYPTLEVEL_REQUEST);
390 } else if (strcmp(option_value.s, "require") == 0) {
391 smbc_setOptionSmbEncryptionLevel(context,
392 SMBC_ENCRYPTLEVEL_REQUIRE);
395 } else if (strcmp(option_name, "browse_max_lmb_count") == 0) {
396 option_value.i = va_arg(ap, int);
397 smbc_setOptionBrowseMaxLmbCount(context, option_value.i);
399 } else if (strcmp(option_name, "urlencode_readdir_entries") == 0) {
400 option_value.b = (bool) va_arg(ap, int);
401 smbc_setOptionUrlEncodeReaddirEntries(context, option_value.b);
403 } else if (strcmp(option_name, "one_share_per_server") == 0) {
404 option_value.b = (bool) va_arg(ap, int);
405 smbc_setOptionOneSharePerServer(context, option_value.b);
407 } else if (strcmp(option_name, "use_kerberos") == 0) {
408 option_value.b = (bool) va_arg(ap, int);
409 smbc_setOptionUseKerberos(context, option_value.b);
411 } else if (strcmp(option_name, "fallback_after_kerberos") == 0) {
412 option_value.b = (bool) va_arg(ap, int);
413 smbc_setOptionFallbackAfterKerberos(context, option_value.b);
415 } else if (strcmp(option_name, "no_auto_anonymous_login") == 0) {
416 option_value.b = (bool) va_arg(ap, int);
417 smbc_setOptionNoAutoAnonymousLogin(context, option_value.b);
425 * Deprecated interface. Do not use. Instead, use the various
426 * smbc_getOption*() functions.
429 smbc_option_get(SMBCCTX *context,
432 if (strcmp(option_name, "debug_stderr") == 0) {
433 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
434 return (void *) (intptr_t) smbc_getOptionDebugToStderr(context);
436 return (void *) smbc_getOptionDebugToStderr(context);
439 } else if (strcmp(option_name, "full_time_names") == 0) {
440 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
441 return (void *) (intptr_t) smbc_getOptionFullTimeNames(context);
443 return (void *) smbc_getOptionFullTimeNames(context);
446 } else if (strcmp(option_name, "open_share_mode") == 0) {
447 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
448 return (void *) (intptr_t) smbc_getOptionOpenShareMode(context);
450 return (void *) smbc_getOptionOpenShareMode(context);
453 } else if (strcmp(option_name, "auth_function") == 0) {
454 return (void *) smbc_getFunctionAuthDataWithContext(context);
456 } else if (strcmp(option_name, "user_data") == 0) {
457 return smbc_getOptionUserData(context);
459 } else if (strcmp(option_name, "smb_encrypt_level") == 0) {
460 switch(smbc_getOptionSmbEncryptionLevel(context))
463 return (void *) "none";
465 return (void *) "request";
467 return (void *) "require";
470 } else if (strcmp(option_name, "smb_encrypt_on") == 0) {
472 unsigned int num_servers = 0;
474 for (s = context->internal->servers; s; s = s->next) {
476 if (s->cli->trans_enc_state == NULL) {
477 return (void *)false;
480 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
481 return (void *) (intptr_t) (bool) (num_servers > 0);
483 return (void *) (bool) (num_servers > 0);
486 } else if (strcmp(option_name, "browse_max_lmb_count") == 0) {
487 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
488 return (void *) (intptr_t) smbc_getOptionBrowseMaxLmbCount(context);
490 return (void *) smbc_getOptionBrowseMaxLmbCount(context);
493 } else if (strcmp(option_name, "urlencode_readdir_entries") == 0) {
494 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
495 return (void *)(intptr_t) smbc_getOptionUrlEncodeReaddirEntries(context);
497 return (void *) (bool) smbc_getOptionUrlEncodeReaddirEntries(context);
500 } else if (strcmp(option_name, "one_share_per_server") == 0) {
501 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
502 return (void *) (intptr_t) smbc_getOptionOneSharePerServer(context);
504 return (void *) (bool) smbc_getOptionOneSharePerServer(context);
507 } else if (strcmp(option_name, "use_kerberos") == 0) {
508 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
509 return (void *) (intptr_t) smbc_getOptionUseKerberos(context);
511 return (void *) (bool) smbc_getOptionUseKerberos(context);
514 } else if (strcmp(option_name, "fallback_after_kerberos") == 0) {
515 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
516 return (void *)(intptr_t) smbc_getOptionFallbackAfterKerberos(context);
518 return (void *) (bool) smbc_getOptionFallbackAfterKerberos(context);
521 } else if (strcmp(option_name, "no_auto_anonymous_login") == 0) {
522 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
523 return (void *) (intptr_t) smbc_getOptionNoAutoAnonymousLogin(context);
525 return (void *) (bool) smbc_getOptionNoAutoAnonymousLogin(context);
534 * Initialize the library, etc.
536 * We accept a struct containing handle information.
537 * valid values for info->debug from 0 to 100,
538 * and insist that info->fn must be non-null.
541 smbc_init_context(SMBCCTX *context)
551 /* Do not initialise the same client twice */
552 if (context->internal->initialized) {
556 if ((!smbc_getFunctionAuthData(context) &&
557 !smbc_getFunctionAuthDataWithContext(context)) ||
558 smbc_getDebug(context) < 0 ||
559 smbc_getDebug(context) > 100) {
566 if (!smbc_getUser(context)) {
568 * FIXME: Is this the best way to get the user info?
570 user = getenv("USER");
571 /* walk around as "guest" if no username can be found */
573 user = SMB_STRDUP("guest");
575 user = SMB_STRDUP(user);
583 smbc_setUser(context, user);
586 if (!smbc_getNetbiosName(context)) {
588 * We try to get our netbios name from the config. If that
589 * fails we fall back on constructing our netbios name from
593 if (global_myname()) {
594 netbios_name = SMB_STRDUP(global_myname());
597 * Hmmm, I want to get hostname as well, but I am too
598 * lazy for the moment
601 netbios_name = (char *)SMB_MALLOC(17);
606 slprintf(netbios_name, 16,
607 "smbc%s%d", smbc_getUser(context), pid);
615 smbc_setNetbiosName(context, netbios_name);
618 DEBUG(1, ("Using netbios name %s.\n", smbc_getNetbiosName(context)));
620 if (!smbc_getWorkgroup(context)) {
623 if (lp_workgroup()) {
624 workgroup = SMB_STRDUP(lp_workgroup());
627 /* TODO: Think about a decent default workgroup */
628 workgroup = SMB_STRDUP("samba");
636 smbc_setWorkgroup(context, workgroup);
639 DEBUG(1, ("Using workgroup %s.\n", smbc_getWorkgroup(context)));
641 /* shortest timeout is 1 second */
642 if (smbc_getTimeout(context) > 0 && smbc_getTimeout(context) < 1000)
643 smbc_setTimeout(context, 1000);
645 context->internal->initialized = True;
647 /* Protect access to the count of contexts in use */
648 if (SMB_THREAD_LOCK(initialized_ctx_count_mutex) != 0) {
649 smb_panic("error locking 'initialized_ctx_count'");
652 initialized_ctx_count++;
654 /* Unlock the mutex */
655 if (SMB_THREAD_UNLOCK(initialized_ctx_count_mutex) != 0) {
656 smb_panic("error unlocking 'initialized_ctx_count'");
663 /* Return the verion of samba, and thus libsmbclient */
667 return samba_version_string();
671 * Set the credentials so DFS will work when following referrals.
672 * This function is broken and must be removed. No SMBCCTX arg...
677 smbc_set_credentials(const char *workgroup,
679 const char *password,
680 smbc_bool use_kerberos,
681 const char *signing_state)
683 d_printf("smbc_set_credentials is obsolete. Replace with smbc_set_credentials_with_fallback().\n");
686 void smbc_set_credentials_with_fallback(SMBCCTX *context,
687 const char *workgroup,
689 const char *password)
691 smbc_bool use_kerberos = false;
692 const char *signing_state = "off";
693 struct user_auth_info *auth_info = user_auth_info_init(NULL);
699 ! workgroup || ! *workgroup ||
701 ! password || ! *password) {
706 auth_info = user_auth_info_init(NULL);
709 DEBUG(0, ("smbc_set_credentials_with_fallback: allocation fail\n"));
713 if (smbc_getOptionUseKerberos(context)) {
717 if (lp_client_signing()) {
718 signing_state = "on";
721 if (lp_client_signing() == Required) {
722 signing_state = "force";
725 set_cmdline_auth_info_username(auth_info, user);
726 set_cmdline_auth_info_password(auth_info, password);
727 set_cmdline_auth_info_use_kerberos(auth_info, use_kerberos);
728 set_cmdline_auth_info_signing_state(auth_info, signing_state);
729 set_cmdline_auth_info_fallback_after_kerberos(auth_info,
730 smbc_getOptionFallbackAfterKerberos(context));
731 set_global_myworkgroup(workgroup);
733 TALLOC_FREE(context->internal->auth_info);
735 context->internal->auth_info = auth_info;