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 /* Here we would open the smb.conf file if needed ... */
53 lp_set_in_client(True);
55 home = getenv("HOME");
58 if (asprintf(&conf, "%s/.smb/smb.conf", home) > 0) {
59 if (lp_load(conf, True, False, False, True)) {
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(get_dyn_CONFIGFILE(), True, False, False, False)) {
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(conf, True, False, False, False)) {
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)
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_setOptionCaseSensitive(context, False);
173 smbc_setOptionBrowseMaxLmbCount(context, 3); /* # LMBs to query */
174 smbc_setOptionUrlEncodeReaddirEntries(context, False);
175 smbc_setOptionOneSharePerServer(context, False);
177 smbc_setFunctionAuthData(context, SMBC_get_auth_data);
178 smbc_setFunctionCheckServer(context, SMBC_check_server);
179 smbc_setFunctionRemoveUnusedServer(context, SMBC_remove_unused_server);
181 smbc_setOptionUserData(context, NULL);
182 smbc_setFunctionAddCachedServer(context, SMBC_add_cached_server);
183 smbc_setFunctionGetCachedServer(context, SMBC_get_cached_server);
184 smbc_setFunctionRemoveCachedServer(context, SMBC_remove_cached_server);
185 smbc_setFunctionPurgeCachedServers(context, SMBC_purge_cached_servers);
187 smbc_setFunctionOpen(context, SMBC_open_ctx);
188 smbc_setFunctionCreat(context, SMBC_creat_ctx);
189 smbc_setFunctionRead(context, SMBC_read_ctx);
190 smbc_setFunctionWrite(context, SMBC_write_ctx);
191 smbc_setFunctionClose(context, SMBC_close_ctx);
192 smbc_setFunctionUnlink(context, SMBC_unlink_ctx);
193 smbc_setFunctionRename(context, SMBC_rename_ctx);
194 smbc_setFunctionLseek(context, SMBC_lseek_ctx);
195 smbc_setFunctionFtruncate(context, SMBC_ftruncate_ctx);
196 smbc_setFunctionStat(context, SMBC_stat_ctx);
197 smbc_setFunctionStatVFS(context, SMBC_statvfs_ctx);
198 smbc_setFunctionFstatVFS(context, SMBC_fstatvfs_ctx);
199 smbc_setFunctionFstat(context, SMBC_fstat_ctx);
200 smbc_setFunctionOpendir(context, SMBC_opendir_ctx);
201 smbc_setFunctionClosedir(context, SMBC_closedir_ctx);
202 smbc_setFunctionReaddir(context, SMBC_readdir_ctx);
203 smbc_setFunctionGetdents(context, SMBC_getdents_ctx);
204 smbc_setFunctionMkdir(context, SMBC_mkdir_ctx);
205 smbc_setFunctionRmdir(context, SMBC_rmdir_ctx);
206 smbc_setFunctionTelldir(context, SMBC_telldir_ctx);
207 smbc_setFunctionLseekdir(context, SMBC_lseekdir_ctx);
208 smbc_setFunctionFstatdir(context, SMBC_fstatdir_ctx);
209 smbc_setFunctionChmod(context, SMBC_chmod_ctx);
210 smbc_setFunctionUtimes(context, SMBC_utimes_ctx);
211 smbc_setFunctionSetxattr(context, SMBC_setxattr_ctx);
212 smbc_setFunctionGetxattr(context, SMBC_getxattr_ctx);
213 smbc_setFunctionRemovexattr(context, SMBC_removexattr_ctx);
214 smbc_setFunctionListxattr(context, SMBC_listxattr_ctx);
216 smbc_setFunctionOpenPrintJob(context, SMBC_open_print_job_ctx);
217 smbc_setFunctionPrintFile(context, SMBC_print_file_ctx);
218 smbc_setFunctionListPrintJobs(context, SMBC_list_print_jobs_ctx);
219 smbc_setFunctionUnlinkPrintJob(context, SMBC_unlink_print_job_ctx);
227 * Returns 0 on success. Otherwise returns 1, the SMBCCTX is _not_ freed
228 * and thus you'll be leaking memory if not handled properly.
232 smbc_free_context(SMBCCTX *context,
242 DEBUG(1,("Performing aggressive shutdown.\n"));
244 f = context->internal->files;
246 smbc_getFunctionClose(context)(context, f);
249 context->internal->files = NULL;
251 /* First try to remove the servers the nice way. */
252 if (smbc_getFunctionPurgeCachedServers(context)(context)) {
255 DEBUG(1, ("Could not purge all servers, "
256 "Nice way shutdown failed.\n"));
257 s = context->internal->servers;
259 DEBUG(1, ("Forced shutdown: %p (fd=%d)\n",
261 cli_shutdown(s->cli);
262 smbc_getFunctionRemoveCachedServer(context)(context,
265 DLIST_REMOVE(context->internal->servers, s);
269 context->internal->servers = NULL;
273 /* This is the polite way */
274 if (smbc_getFunctionPurgeCachedServers(context)(context)) {
275 DEBUG(1, ("Could not purge all servers, "
276 "free_context failed.\n"));
280 if (context->internal->servers) {
281 DEBUG(1, ("Active servers in context, "
282 "free_context failed.\n"));
286 if (context->internal->files) {
287 DEBUG(1, ("Active files in context, "
288 "free_context failed.\n"));
294 /* Things we have to clean up */
295 free(smbc_getWorkgroup(context));
296 smbc_setWorkgroup(context, NULL);
298 free(smbc_getNetbiosName(context));
299 smbc_setNetbiosName(context, NULL);
301 free(smbc_getUser(context));
302 smbc_setUser(context, NULL);
304 DEBUG(3, ("Context %p successfully freed\n", context));
306 /* Free any DFS auth context. */
307 TALLOC_FREE(context->internal->auth_info);
309 SAFE_FREE(context->internal);
312 /* Protect access to the count of contexts in use */
313 if (SMB_THREAD_LOCK(initialized_ctx_count_mutex) != 0) {
314 smb_panic("error locking 'initialized_ctx_count'");
317 if (initialized_ctx_count) {
318 initialized_ctx_count--;
321 if (initialized_ctx_count == 0) {
322 SMBC_module_terminate();
325 /* Unlock the mutex */
326 if (SMB_THREAD_UNLOCK(initialized_ctx_count_mutex) != 0) {
327 smb_panic("error unlocking 'initialized_ctx_count'");
335 * Deprecated interface. Do not use. Instead, use the various
336 * smbc_setOption*() functions or smbc_setFunctionAuthDataWithContext().
339 smbc_option_set(SMBCCTX *context,
341 ... /* option_value */)
347 smbc_get_auth_data_with_context_fn auth_fn;
352 va_start(ap, option_name);
354 if (strcmp(option_name, "debug_to_stderr") == 0) {
355 option_value.b = (bool) va_arg(ap, int);
356 smbc_setOptionDebugToStderr(context, option_value.b);
358 } else if (strcmp(option_name, "full_time_names") == 0) {
359 option_value.b = (bool) va_arg(ap, int);
360 smbc_setOptionFullTimeNames(context, option_value.b);
362 } else if (strcmp(option_name, "open_share_mode") == 0) {
363 option_value.i = va_arg(ap, int);
364 smbc_setOptionOpenShareMode(context, option_value.i);
366 } else if (strcmp(option_name, "auth_function") == 0) {
367 option_value.auth_fn =
368 va_arg(ap, smbc_get_auth_data_with_context_fn);
369 smbc_setFunctionAuthDataWithContext(context, option_value.auth_fn);
371 } else if (strcmp(option_name, "user_data") == 0) {
372 option_value.v = va_arg(ap, void *);
373 smbc_setOptionUserData(context, option_value.v);
375 } else if (strcmp(option_name, "smb_encrypt_level") == 0) {
376 option_value.s = va_arg(ap, const char *);
377 if (strcmp(option_value.s, "none") == 0) {
378 smbc_setOptionSmbEncryptionLevel(context,
379 SMBC_ENCRYPTLEVEL_NONE);
380 } else if (strcmp(option_value.s, "request") == 0) {
381 smbc_setOptionSmbEncryptionLevel(context,
382 SMBC_ENCRYPTLEVEL_REQUEST);
383 } else if (strcmp(option_value.s, "require") == 0) {
384 smbc_setOptionSmbEncryptionLevel(context,
385 SMBC_ENCRYPTLEVEL_REQUIRE);
388 } else if (strcmp(option_name, "browse_max_lmb_count") == 0) {
389 option_value.i = va_arg(ap, int);
390 smbc_setOptionBrowseMaxLmbCount(context, option_value.i);
392 } else if (strcmp(option_name, "urlencode_readdir_entries") == 0) {
393 option_value.b = (bool) va_arg(ap, int);
394 smbc_setOptionUrlEncodeReaddirEntries(context, option_value.b);
396 } else if (strcmp(option_name, "one_share_per_server") == 0) {
397 option_value.b = (bool) va_arg(ap, int);
398 smbc_setOptionOneSharePerServer(context, option_value.b);
400 } else if (strcmp(option_name, "use_kerberos") == 0) {
401 option_value.b = (bool) va_arg(ap, int);
402 smbc_setOptionUseKerberos(context, option_value.b);
404 } else if (strcmp(option_name, "fallback_after_kerberos") == 0) {
405 option_value.b = (bool) va_arg(ap, int);
406 smbc_setOptionFallbackAfterKerberos(context, option_value.b);
408 } else if (strcmp(option_name, "no_auto_anonymous_login") == 0) {
409 option_value.b = (bool) va_arg(ap, int);
410 smbc_setOptionNoAutoAnonymousLogin(context, option_value.b);
418 * Deprecated interface. Do not use. Instead, use the various
419 * smbc_getOption*() functions.
422 smbc_option_get(SMBCCTX *context,
425 if (strcmp(option_name, "debug_stderr") == 0) {
426 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
427 return (void *) (intptr_t) smbc_getOptionDebugToStderr(context);
429 return (void *) smbc_getOptionDebugToStderr(context);
432 } else if (strcmp(option_name, "full_time_names") == 0) {
433 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
434 return (void *) (intptr_t) smbc_getOptionFullTimeNames(context);
436 return (void *) smbc_getOptionFullTimeNames(context);
439 } else if (strcmp(option_name, "open_share_mode") == 0) {
440 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
441 return (void *) (intptr_t) smbc_getOptionOpenShareMode(context);
443 return (void *) smbc_getOptionOpenShareMode(context);
446 } else if (strcmp(option_name, "auth_function") == 0) {
447 return (void *) smbc_getFunctionAuthDataWithContext(context);
449 } else if (strcmp(option_name, "user_data") == 0) {
450 return smbc_getOptionUserData(context);
452 } else if (strcmp(option_name, "smb_encrypt_level") == 0) {
453 switch(smbc_getOptionSmbEncryptionLevel(context))
456 return (void *) "none";
458 return (void *) "request";
460 return (void *) "require";
463 } else if (strcmp(option_name, "smb_encrypt_on") == 0) {
465 unsigned int num_servers = 0;
467 for (s = context->internal->servers; s; s = s->next) {
469 if (s->cli->trans_enc_state == NULL) {
470 return (void *)false;
473 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
474 return (void *) (intptr_t) (bool) (num_servers > 0);
476 return (void *) (bool) (num_servers > 0);
479 } else if (strcmp(option_name, "browse_max_lmb_count") == 0) {
480 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
481 return (void *) (intptr_t) smbc_getOptionBrowseMaxLmbCount(context);
483 return (void *) smbc_getOptionBrowseMaxLmbCount(context);
486 } else if (strcmp(option_name, "urlencode_readdir_entries") == 0) {
487 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
488 return (void *)(intptr_t) smbc_getOptionUrlEncodeReaddirEntries(context);
490 return (void *) (bool) smbc_getOptionUrlEncodeReaddirEntries(context);
493 } else if (strcmp(option_name, "one_share_per_server") == 0) {
494 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
495 return (void *) (intptr_t) smbc_getOptionOneSharePerServer(context);
497 return (void *) (bool) smbc_getOptionOneSharePerServer(context);
500 } else if (strcmp(option_name, "use_kerberos") == 0) {
501 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
502 return (void *) (intptr_t) smbc_getOptionUseKerberos(context);
504 return (void *) (bool) smbc_getOptionUseKerberos(context);
507 } else if (strcmp(option_name, "fallback_after_kerberos") == 0) {
508 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
509 return (void *)(intptr_t) smbc_getOptionFallbackAfterKerberos(context);
511 return (void *) (bool) smbc_getOptionFallbackAfterKerberos(context);
514 } else if (strcmp(option_name, "no_auto_anonymous_login") == 0) {
515 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
516 return (void *) (intptr_t) smbc_getOptionNoAutoAnonymousLogin(context);
518 return (void *) (bool) smbc_getOptionNoAutoAnonymousLogin(context);
527 * Initialize the library, etc.
529 * We accept a struct containing handle information.
530 * valid values for info->debug from 0 to 100,
531 * and insist that info->fn must be non-null.
534 smbc_init_context(SMBCCTX *context)
544 /* Do not initialise the same client twice */
545 if (context->internal->initialized) {
549 if (context->internal->debug_stderr) {
551 * Hmmm... Do we want a unique dbf per-thread? For now, we'll just
552 * leave it up to the user. If any one context spefies debug to
553 * stderr then all will be.
556 x_setbuf(x_stderr, NULL);
559 if ((!smbc_getFunctionAuthData(context) &&
560 !smbc_getFunctionAuthDataWithContext(context)) ||
561 smbc_getDebug(context) < 0 ||
562 smbc_getDebug(context) > 100) {
569 if (!smbc_getUser(context)) {
571 * FIXME: Is this the best way to get the user info?
573 user = getenv("USER");
574 /* walk around as "guest" if no username can be found */
576 user = SMB_STRDUP("guest");
578 user = SMB_STRDUP(user);
586 smbc_setUser(context, user);
589 if (!smbc_getNetbiosName(context)) {
591 * We try to get our netbios name from the config. If that
592 * fails we fall back on constructing our netbios name from
596 if (global_myname()) {
597 netbios_name = SMB_STRDUP(global_myname());
600 * Hmmm, I want to get hostname as well, but I am too
601 * lazy for the moment
604 netbios_name = (char *)SMB_MALLOC(17);
609 slprintf(netbios_name, 16,
610 "smbc%s%d", smbc_getUser(context), pid);
618 smbc_setNetbiosName(context, netbios_name);
621 DEBUG(1, ("Using netbios name %s.\n", smbc_getNetbiosName(context)));
623 if (!smbc_getWorkgroup(context)) {
626 if (lp_workgroup()) {
627 workgroup = SMB_STRDUP(lp_workgroup());
630 /* TODO: Think about a decent default workgroup */
631 workgroup = SMB_STRDUP("samba");
639 smbc_setWorkgroup(context, workgroup);
642 DEBUG(1, ("Using workgroup %s.\n", smbc_getWorkgroup(context)));
644 /* shortest timeout is 1 second */
645 if (smbc_getTimeout(context) > 0 && smbc_getTimeout(context) < 1000)
646 smbc_setTimeout(context, 1000);
648 context->internal->initialized = True;
650 /* Protect access to the count of contexts in use */
651 if (SMB_THREAD_LOCK(initialized_ctx_count_mutex) != 0) {
652 smb_panic("error locking 'initialized_ctx_count'");
655 initialized_ctx_count++;
657 /* Unlock the mutex */
658 if (SMB_THREAD_UNLOCK(initialized_ctx_count_mutex) != 0) {
659 smb_panic("error unlocking 'initialized_ctx_count'");
666 /* Return the verion of samba, and thus libsmbclient */
670 return samba_version_string();
674 * Set the credentials so DFS will work when following referrals.
675 * This function is broken and must be removed. No SMBCCTX arg...
680 smbc_set_credentials(const char *workgroup,
682 const char *password,
683 smbc_bool use_kerberos,
684 const char *signing_state)
686 d_printf("smbc_set_credentials is obsolete. Replace with smbc_set_credentials_with_fallback().\n");
689 void smbc_set_credentials_with_fallback(SMBCCTX *context,
690 const char *workgroup,
692 const char *password)
694 smbc_bool use_kerberos = false;
695 const char *signing_state = "off";
696 struct user_auth_info *auth_info = user_auth_info_init(NULL);
702 ! workgroup || ! *workgroup ||
704 ! password || ! *password) {
709 auth_info = user_auth_info_init(NULL);
712 DEBUG(0, ("smbc_set_credentials_with_fallback: allocation fail\n"));
716 if (smbc_getOptionUseKerberos(context)) {
720 if (lp_client_signing()) {
721 signing_state = "on";
724 if (lp_client_signing() == Required) {
725 signing_state = "force";
728 set_cmdline_auth_info_username(auth_info, user);
729 set_cmdline_auth_info_password(auth_info, password);
730 set_cmdline_auth_info_use_kerberos(auth_info, use_kerberos);
731 set_cmdline_auth_info_signing_state(auth_info, signing_state);
732 set_cmdline_auth_info_fallback_after_kerberos(auth_info,
733 smbc_getOptionFallbackAfterKerberos(context));
734 set_global_myworkgroup(workgroup);
736 TALLOC_FREE(context->internal->auth_info);
738 context->internal->auth_info = auth_info;