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
;
34 static unsigned int initialized_ctx_count
;
37 * Get a new empty handle to fill in with your own info
40 smbc_new_context(void)
45 * All newly added context fields should be placed in
46 * SMBC_internal_data, not directly in SMBCCTX.
48 context
= SMB_MALLOC_P(SMBCCTX
);
54 ZERO_STRUCTP(context
);
56 context
->internal
= SMB_MALLOC_P(struct SMBC_internal_data
);
57 if (!context
->internal
) {
63 /* Initialize the context and establish reasonable defaults */
64 ZERO_STRUCTP(context
->internal
);
66 smbc_setDebug(context
, 0);
67 smbc_setTimeout(context
, 20000);
69 smbc_setOptionFullTimeNames(context
, False
);
70 smbc_setOptionOpenShareMode(context
, SMBC_SHAREMODE_DENY_NONE
);
71 smbc_setOptionSmbEncryptionLevel(context
, SMBC_ENCRYPTLEVEL_NONE
);
72 smbc_setOptionCaseSensitive(context
, False
);
73 smbc_setOptionBrowseMaxLmbCount(context
, 3); /* # LMBs to query */
74 smbc_setOptionUrlEncodeReaddirEntries(context
, False
);
75 smbc_setOptionOneSharePerServer(context
, False
);
77 smbc_setFunctionAuthData(context
, SMBC_get_auth_data
);
78 smbc_setFunctionCheckServer(context
, SMBC_check_server
);
79 smbc_setFunctionRemoveUnusedServer(context
, SMBC_remove_unused_server
);
81 smbc_setOptionUserData(context
, NULL
);
82 smbc_setFunctionAddCachedServer(context
, SMBC_add_cached_server
);
83 smbc_setFunctionGetCachedServer(context
, SMBC_get_cached_server
);
84 smbc_setFunctionRemoveCachedServer(context
, SMBC_remove_cached_server
);
85 smbc_setFunctionPurgeCachedServers(context
, SMBC_purge_cached_servers
);
87 smbc_setFunctionOpen(context
, SMBC_open_ctx
);
88 smbc_setFunctionCreat(context
, SMBC_creat_ctx
);
89 smbc_setFunctionRead(context
, SMBC_read_ctx
);
90 smbc_setFunctionWrite(context
, SMBC_write_ctx
);
91 smbc_setFunctionClose(context
, SMBC_close_ctx
);
92 smbc_setFunctionUnlink(context
, SMBC_unlink_ctx
);
93 smbc_setFunctionRename(context
, SMBC_rename_ctx
);
94 smbc_setFunctionLseek(context
, SMBC_lseek_ctx
);
95 smbc_setFunctionFtruncate(context
, SMBC_ftruncate_ctx
);
96 smbc_setFunctionStat(context
, SMBC_stat_ctx
);
97 smbc_setFunctionStatVFS(context
, SMBC_statvfs_ctx
);
98 smbc_setFunctionFstatVFS(context
, SMBC_fstatvfs_ctx
);
99 smbc_setFunctionFstat(context
, SMBC_fstat_ctx
);
100 smbc_setFunctionOpendir(context
, SMBC_opendir_ctx
);
101 smbc_setFunctionClosedir(context
, SMBC_closedir_ctx
);
102 smbc_setFunctionReaddir(context
, SMBC_readdir_ctx
);
103 smbc_setFunctionGetdents(context
, SMBC_getdents_ctx
);
104 smbc_setFunctionMkdir(context
, SMBC_mkdir_ctx
);
105 smbc_setFunctionRmdir(context
, SMBC_rmdir_ctx
);
106 smbc_setFunctionTelldir(context
, SMBC_telldir_ctx
);
107 smbc_setFunctionLseekdir(context
, SMBC_lseekdir_ctx
);
108 smbc_setFunctionFstatdir(context
, SMBC_fstatdir_ctx
);
109 smbc_setFunctionChmod(context
, SMBC_chmod_ctx
);
110 smbc_setFunctionUtimes(context
, SMBC_utimes_ctx
);
111 smbc_setFunctionSetxattr(context
, SMBC_setxattr_ctx
);
112 smbc_setFunctionGetxattr(context
, SMBC_getxattr_ctx
);
113 smbc_setFunctionRemovexattr(context
, SMBC_removexattr_ctx
);
114 smbc_setFunctionListxattr(context
, SMBC_listxattr_ctx
);
116 smbc_setFunctionOpenPrintJob(context
, SMBC_open_print_job_ctx
);
117 smbc_setFunctionPrintFile(context
, SMBC_print_file_ctx
);
118 smbc_setFunctionListPrintJobs(context
, SMBC_list_print_jobs_ctx
);
119 smbc_setFunctionUnlinkPrintJob(context
, SMBC_unlink_print_job_ctx
);
127 * Returns 0 on success. Otherwise returns 1, the SMBCCTX is _not_ freed
128 * and thus you'll be leaking memory if not handled properly.
132 smbc_free_context(SMBCCTX
*context
,
142 DEBUG(1,("Performing aggressive shutdown.\n"));
144 f
= context
->internal
->files
;
146 smbc_getFunctionClose(context
)(context
, f
);
149 context
->internal
->files
= NULL
;
151 /* First try to remove the servers the nice way. */
152 if (smbc_getFunctionPurgeCachedServers(context
)(context
)) {
155 DEBUG(1, ("Could not purge all servers, "
156 "Nice way shutdown failed.\n"));
157 s
= context
->internal
->servers
;
159 DEBUG(1, ("Forced shutdown: %p (fd=%d)\n",
161 cli_shutdown(s
->cli
);
162 smbc_getFunctionRemoveCachedServer(context
)(context
,
165 DLIST_REMOVE(context
->internal
->servers
, s
);
169 context
->internal
->servers
= NULL
;
173 /* This is the polite way */
174 if (smbc_getFunctionPurgeCachedServers(context
)(context
)) {
175 DEBUG(1, ("Could not purge all servers, "
176 "free_context failed.\n"));
180 if (context
->internal
->servers
) {
181 DEBUG(1, ("Active servers in context, "
182 "free_context failed.\n"));
186 if (context
->internal
->files
) {
187 DEBUG(1, ("Active files in context, "
188 "free_context failed.\n"));
194 /* Things we have to clean up */
195 smbc_setWorkgroup(context
, NULL
);
196 smbc_setNetbiosName(context
, NULL
);
197 smbc_setUser(context
, NULL
);
199 DEBUG(3, ("Context %p successfully freed\n", context
));
201 /* Free any DFS auth context. */
202 TALLOC_FREE(context
->internal
->auth_info
);
204 SAFE_FREE(context
->internal
);
207 if (initialized_ctx_count
) {
208 initialized_ctx_count
--;
211 if (initialized_ctx_count
== 0 && SMBC_initialized
) {
215 SMBC_initialized
= false;
222 * Deprecated interface. Do not use. Instead, use the various
223 * smbc_setOption*() functions or smbc_setFunctionAuthDataWithContext().
226 smbc_option_set(SMBCCTX
*context
,
228 ... /* option_value */)
234 smbc_get_auth_data_with_context_fn auth_fn
;
239 va_start(ap
, option_name
);
241 if (strcmp(option_name
, "debug_to_stderr") == 0) {
242 option_value
.b
= (bool) va_arg(ap
, int);
243 smbc_setOptionDebugToStderr(context
, option_value
.b
);
245 } else if (strcmp(option_name
, "full_time_names") == 0) {
246 option_value
.b
= (bool) va_arg(ap
, int);
247 smbc_setOptionFullTimeNames(context
, option_value
.b
);
249 } else if (strcmp(option_name
, "open_share_mode") == 0) {
250 option_value
.i
= va_arg(ap
, int);
251 smbc_setOptionOpenShareMode(context
, option_value
.i
);
253 } else if (strcmp(option_name
, "auth_function") == 0) {
254 option_value
.auth_fn
=
255 va_arg(ap
, smbc_get_auth_data_with_context_fn
);
256 smbc_setFunctionAuthDataWithContext(context
, option_value
.auth_fn
);
258 } else if (strcmp(option_name
, "user_data") == 0) {
259 option_value
.v
= va_arg(ap
, void *);
260 smbc_setOptionUserData(context
, option_value
.v
);
262 } else if (strcmp(option_name
, "smb_encrypt_level") == 0) {
263 option_value
.s
= va_arg(ap
, const char *);
264 if (strcmp(option_value
.s
, "none") == 0) {
265 smbc_setOptionSmbEncryptionLevel(context
,
266 SMBC_ENCRYPTLEVEL_NONE
);
267 } else if (strcmp(option_value
.s
, "request") == 0) {
268 smbc_setOptionSmbEncryptionLevel(context
,
269 SMBC_ENCRYPTLEVEL_REQUEST
);
270 } else if (strcmp(option_value
.s
, "require") == 0) {
271 smbc_setOptionSmbEncryptionLevel(context
,
272 SMBC_ENCRYPTLEVEL_REQUIRE
);
275 } else if (strcmp(option_name
, "browse_max_lmb_count") == 0) {
276 option_value
.i
= va_arg(ap
, int);
277 smbc_setOptionBrowseMaxLmbCount(context
, option_value
.i
);
279 } else if (strcmp(option_name
, "urlencode_readdir_entries") == 0) {
280 option_value
.b
= (bool) va_arg(ap
, int);
281 smbc_setOptionUrlEncodeReaddirEntries(context
, option_value
.b
);
283 } else if (strcmp(option_name
, "one_share_per_server") == 0) {
284 option_value
.b
= (bool) va_arg(ap
, int);
285 smbc_setOptionOneSharePerServer(context
, option_value
.b
);
287 } else if (strcmp(option_name
, "use_kerberos") == 0) {
288 option_value
.b
= (bool) va_arg(ap
, int);
289 smbc_setOptionUseKerberos(context
, option_value
.b
);
291 } else if (strcmp(option_name
, "fallback_after_kerberos") == 0) {
292 option_value
.b
= (bool) va_arg(ap
, int);
293 smbc_setOptionFallbackAfterKerberos(context
, option_value
.b
);
295 } else if (strcmp(option_name
, "no_auto_anonymous_login") == 0) {
296 option_value
.b
= (bool) va_arg(ap
, int);
297 smbc_setOptionNoAutoAnonymousLogin(context
, option_value
.b
);
305 * Deprecated interface. Do not use. Instead, use the various
306 * smbc_getOption*() functions.
309 smbc_option_get(SMBCCTX
*context
,
312 if (strcmp(option_name
, "debug_stderr") == 0) {
313 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
314 return (void *) (intptr_t) smbc_getOptionDebugToStderr(context
);
316 return (void *) smbc_getOptionDebugToStderr(context
);
319 } else if (strcmp(option_name
, "full_time_names") == 0) {
320 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
321 return (void *) (intptr_t) smbc_getOptionFullTimeNames(context
);
323 return (void *) smbc_getOptionFullTimeNames(context
);
326 } else if (strcmp(option_name
, "open_share_mode") == 0) {
327 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
328 return (void *) (intptr_t) smbc_getOptionOpenShareMode(context
);
330 return (void *) smbc_getOptionOpenShareMode(context
);
333 } else if (strcmp(option_name
, "auth_function") == 0) {
334 return (void *) smbc_getFunctionAuthDataWithContext(context
);
336 } else if (strcmp(option_name
, "user_data") == 0) {
337 return smbc_getOptionUserData(context
);
339 } else if (strcmp(option_name
, "smb_encrypt_level") == 0) {
340 switch(smbc_getOptionSmbEncryptionLevel(context
))
343 return (void *) "none";
345 return (void *) "request";
347 return (void *) "require";
350 } else if (strcmp(option_name
, "smb_encrypt_on") == 0) {
352 unsigned int num_servers
= 0;
354 for (s
= context
->internal
->servers
; s
; s
= s
->next
) {
356 if (s
->cli
->trans_enc_state
== NULL
) {
357 return (void *)false;
360 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
361 return (void *) (intptr_t) (bool) (num_servers
> 0);
363 return (void *) (bool) (num_servers
> 0);
366 } else if (strcmp(option_name
, "browse_max_lmb_count") == 0) {
367 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
368 return (void *) (intptr_t) smbc_getOptionBrowseMaxLmbCount(context
);
370 return (void *) smbc_getOptionBrowseMaxLmbCount(context
);
373 } else if (strcmp(option_name
, "urlencode_readdir_entries") == 0) {
374 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
375 return (void *)(intptr_t) smbc_getOptionUrlEncodeReaddirEntries(context
);
377 return (void *) (bool) smbc_getOptionUrlEncodeReaddirEntries(context
);
380 } else if (strcmp(option_name
, "one_share_per_server") == 0) {
381 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
382 return (void *) (intptr_t) smbc_getOptionOneSharePerServer(context
);
384 return (void *) (bool) smbc_getOptionOneSharePerServer(context
);
387 } else if (strcmp(option_name
, "use_kerberos") == 0) {
388 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
389 return (void *) (intptr_t) smbc_getOptionUseKerberos(context
);
391 return (void *) (bool) smbc_getOptionUseKerberos(context
);
394 } else if (strcmp(option_name
, "fallback_after_kerberos") == 0) {
395 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
396 return (void *)(intptr_t) smbc_getOptionFallbackAfterKerberos(context
);
398 return (void *) (bool) smbc_getOptionFallbackAfterKerberos(context
);
401 } else if (strcmp(option_name
, "no_auto_anonymous_login") == 0) {
402 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
403 return (void *) (intptr_t) smbc_getOptionNoAutoAnonymousLogin(context
);
405 return (void *) (bool) smbc_getOptionNoAutoAnonymousLogin(context
);
414 * Initialize the library, etc.
416 * We accept a struct containing handle information.
417 * valid values for info->debug from 0 to 100,
418 * and insist that info->fn must be non-null.
421 smbc_init_context(SMBCCTX
*context
)
431 /* Do not initialise the same client twice */
432 if (context
->internal
->initialized
) {
436 if ((!smbc_getFunctionAuthData(context
) &&
437 !smbc_getFunctionAuthDataWithContext(context
)) ||
438 smbc_getDebug(context
) < 0 ||
439 smbc_getDebug(context
) > 100) {
446 if (!SMBC_initialized
) {
448 * Do some library-wide intializations the first time we get
451 bool conf_loaded
= False
;
452 TALLOC_CTX
*frame
= talloc_stackframe();
456 setup_logging("libsmbclient", True
);
457 if (context
->internal
->debug_stderr
) {
459 x_setbuf(x_stderr
, NULL
);
462 /* Here we would open the smb.conf file if needed ... */
464 lp_set_in_client(True
);
466 home
= getenv("HOME");
469 if (asprintf(&conf
, "%s/.smb/smb.conf", home
) > 0) {
470 if (lp_load(conf
, True
, False
, False
, True
)) {
473 DEBUG(5, ("Could not load config file: %s\n",
482 * Well, if that failed, try the get_dyn_CONFIGFILE
483 * Which points to the standard locn, and if that
484 * fails, silently ignore it and use the internal
488 if (!lp_load(get_dyn_CONFIGFILE(), True
, False
, False
, False
)) {
489 DEBUG(5, ("Could not load config file: %s\n",
490 get_dyn_CONFIGFILE()));
494 * We loaded the global config file. Now lets
495 * load user-specific modifications to the
499 "%s/.smb/smb.conf.append",
501 if (!lp_load(conf
, True
, False
, False
, False
)) {
503 ("Could not append config file: "
512 load_interfaces(); /* Load the list of interfaces ... */
514 reopen_logs(); /* Get logging working ... */
517 * Block SIGPIPE (from lib/util_sock.c: write())
518 * It is not needed and should not stop execution
520 BlockSignals(True
, SIGPIPE
);
522 /* Done with one-time initialisation */
523 SMBC_initialized
= true;
528 if (!smbc_getUser(context
)) {
530 * FIXME: Is this the best way to get the user info?
532 char *user
= getenv("USER");
533 /* walk around as "guest" if no username can be found */
535 user
= SMB_STRDUP("guest");
537 user
= SMB_STRDUP(user
);
545 smbc_setUser(context
, user
);
548 if (!smbc_getUser(context
)) {
554 if (!smbc_getNetbiosName(context
)) {
556 * We try to get our netbios name from the config. If that
557 * fails we fall back on constructing our netbios name from
561 if (global_myname()) {
562 netbios_name
= SMB_STRDUP(global_myname());
565 * Hmmm, I want to get hostname as well, but I am too
566 * lazy for the moment
569 netbios_name
= (char *)SMB_MALLOC(17);
574 slprintf(netbios_name
, 16,
575 "smbc%s%d", smbc_getUser(context
), pid
);
583 smbc_setNetbiosName(context
, netbios_name
);
584 SAFE_FREE(netbios_name
);
586 if (!smbc_getNetbiosName(context
)) {
592 DEBUG(1, ("Using netbios name %s.\n", smbc_getNetbiosName(context
)));
594 if (!smbc_getWorkgroup(context
)) {
597 if (lp_workgroup()) {
598 workgroup
= SMB_STRDUP(lp_workgroup());
601 /* TODO: Think about a decent default workgroup */
602 workgroup
= SMB_STRDUP("samba");
610 smbc_setWorkgroup(context
, workgroup
);
611 SAFE_FREE(workgroup
);
613 if (!smbc_getWorkgroup(context
)) {
619 DEBUG(1, ("Using workgroup %s.\n", smbc_getWorkgroup(context
)));
621 /* shortest timeout is 1 second */
622 if (smbc_getTimeout(context
) > 0 && smbc_getTimeout(context
) < 1000)
623 smbc_setTimeout(context
, 1000);
626 * FIXME: Should we check the function pointers here?
629 context
->internal
->initialized
= True
;
630 initialized_ctx_count
++;
636 /* Return the verion of samba, and thus libsmbclient */
640 return samba_version_string();
644 * Set the credentials so DFS will work when following referrals.
645 * This function is broken and must be removed. No SMBCCTX arg...
650 smbc_set_credentials(const char *workgroup
,
652 const char *password
,
653 smbc_bool use_kerberos
,
654 const char *signing_state
)
656 d_printf("smbc_set_credentials is obsolete. Replace with smbc_set_credentials_with_fallback().\n");
659 void smbc_set_credentials_with_fallback(SMBCCTX
*context
,
660 const char *workgroup
,
662 const char *password
)
664 smbc_bool use_kerberos
= false;
665 const char *signing_state
= "off";
666 struct user_auth_info
*auth_info
= NULL
;
673 if (! workgroup
|| ! *workgroup
) {
674 workgroup
= smbc_getWorkgroup(context
);
678 user
= smbc_getUser(context
);
685 auth_info
= user_auth_info_init(NULL
);
688 DEBUG(0, ("smbc_set_credentials_with_fallback: allocation fail\n"));
692 if (smbc_getOptionUseKerberos(context
)) {
696 if (lp_client_signing()) {
697 signing_state
= "on";
700 if (lp_client_signing() == Required
) {
701 signing_state
= "force";
704 set_cmdline_auth_info_username(auth_info
, user
);
705 set_cmdline_auth_info_password(auth_info
, password
);
706 set_cmdline_auth_info_use_kerberos(auth_info
, use_kerberos
);
707 set_cmdline_auth_info_signing_state(auth_info
, signing_state
);
708 set_cmdline_auth_info_fallback_after_kerberos(auth_info
,
709 smbc_getOptionFallbackAfterKerberos(context
));
710 set_global_myworkgroup(workgroup
);
712 TALLOC_FREE(context
->internal
->auth_info
);
714 context
->internal
->auth_info
= auth_info
;