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 int SMBC_initialized
= 0;
38 * Get a new empty handle to fill in with your own info
41 smbc_new_context(void)
46 * All newly added context fields should be placed in
47 * SMBC_internal_data, not directly in SMBCCTX.
49 context
= SMB_MALLOC_P(SMBCCTX
);
55 ZERO_STRUCTP(context
);
57 context
->internal
= SMB_MALLOC_P(struct SMBC_internal_data
);
58 if (!context
->internal
) {
64 /* Initialize the context and establish reasonable defaults */
65 ZERO_STRUCTP(context
->internal
);
67 smbc_setDebug(context
, 0);
68 smbc_setTimeout(context
, 20000);
70 smbc_setOptionFullTimeNames(context
, False
);
71 smbc_setOptionOpenShareMode(context
, SMBC_SHAREMODE_DENY_NONE
);
72 smbc_setOptionSmbEncryptionLevel(context
, SMBC_ENCRYPTLEVEL_NONE
);
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_setFunctionFstat(context
, SMBC_fstat_ctx
);
98 smbc_setFunctionOpendir(context
, SMBC_opendir_ctx
);
99 smbc_setFunctionClosedir(context
, SMBC_closedir_ctx
);
100 smbc_setFunctionReaddir(context
, SMBC_readdir_ctx
);
101 smbc_setFunctionGetdents(context
, SMBC_getdents_ctx
);
102 smbc_setFunctionMkdir(context
, SMBC_mkdir_ctx
);
103 smbc_setFunctionRmdir(context
, SMBC_rmdir_ctx
);
104 smbc_setFunctionTelldir(context
, SMBC_telldir_ctx
);
105 smbc_setFunctionLseekdir(context
, SMBC_lseekdir_ctx
);
106 smbc_setFunctionFstatdir(context
, SMBC_fstatdir_ctx
);
107 smbc_setFunctionChmod(context
, SMBC_chmod_ctx
);
108 smbc_setFunctionUtimes(context
, SMBC_utimes_ctx
);
109 smbc_setFunctionSetxattr(context
, SMBC_setxattr_ctx
);
110 smbc_setFunctionGetxattr(context
, SMBC_getxattr_ctx
);
111 smbc_setFunctionRemovexattr(context
, SMBC_removexattr_ctx
);
112 smbc_setFunctionListxattr(context
, SMBC_listxattr_ctx
);
114 smbc_setFunctionOpenPrintJob(context
, SMBC_open_print_job_ctx
);
115 smbc_setFunctionPrintFile(context
, SMBC_print_file_ctx
);
116 smbc_setFunctionListPrintJobs(context
, SMBC_list_print_jobs_ctx
);
117 smbc_setFunctionUnlinkPrintJob(context
, SMBC_unlink_print_job_ctx
);
125 * Returns 0 on success. Otherwise returns 1, the SMBCCTX is _not_ freed
126 * and thus you'll be leaking memory if not handled properly.
130 smbc_free_context(SMBCCTX
*context
,
140 DEBUG(1,("Performing aggressive shutdown.\n"));
142 f
= context
->internal
->files
;
144 smbc_getFunctionClose(context
)(context
, f
);
147 context
->internal
->files
= NULL
;
149 /* First try to remove the servers the nice way. */
150 if (smbc_getFunctionPurgeCachedServers(context
)(context
)) {
153 DEBUG(1, ("Could not purge all servers, "
154 "Nice way shutdown failed.\n"));
155 s
= context
->internal
->servers
;
157 DEBUG(1, ("Forced shutdown: %p (fd=%d)\n",
159 cli_shutdown(s
->cli
);
160 smbc_getFunctionRemoveCachedServer(context
)(context
,
163 DLIST_REMOVE(context
->internal
->servers
, s
);
167 context
->internal
->servers
= NULL
;
171 /* This is the polite way */
172 if (smbc_getFunctionPurgeCachedServers(context
)(context
)) {
173 DEBUG(1, ("Could not purge all servers, "
174 "free_context failed.\n"));
178 if (context
->internal
->servers
) {
179 DEBUG(1, ("Active servers in context, "
180 "free_context failed.\n"));
184 if (context
->internal
->files
) {
185 DEBUG(1, ("Active files in context, "
186 "free_context failed.\n"));
192 /* Things we have to clean up */
193 free(smbc_getWorkgroup(context
));
194 smbc_setWorkgroup(context
, NULL
);
196 free(smbc_getNetbiosName(context
));
197 smbc_setNetbiosName(context
, NULL
);
199 free(smbc_getUser(context
));
200 smbc_setUser(context
, NULL
);
202 DEBUG(3, ("Context %p successfully freed\n", context
));
209 * Deprecated interface. Do not use. Instead, use the various
210 * smbc_setOption*() functions or smbc_setFunctionAuthDataWithContext().
213 smbc_option_set(SMBCCTX
*context
,
215 ... /* option_value */)
221 smbc_get_auth_data_with_context_fn auth_fn
;
226 va_start(ap
, option_name
);
228 if (strcmp(option_name
, "debug_to_stderr") == 0) {
229 option_value
.b
= (bool) va_arg(ap
, int);
230 smbc_setOptionDebugToStderr(context
, option_value
.b
);
232 } else if (strcmp(option_name
, "full_time_names") == 0) {
233 option_value
.b
= (bool) va_arg(ap
, int);
234 smbc_setOptionFullTimeNames(context
, option_value
.b
);
236 } else if (strcmp(option_name
, "open_share_mode") == 0) {
237 option_value
.i
= va_arg(ap
, int);
238 smbc_setOptionOpenShareMode(context
, option_value
.i
);
240 } else if (strcmp(option_name
, "auth_function") == 0) {
241 option_value
.auth_fn
=
242 va_arg(ap
, smbc_get_auth_data_with_context_fn
);
243 smbc_setFunctionAuthDataWithContext(context
, option_value
.auth_fn
);
245 } else if (strcmp(option_name
, "user_data") == 0) {
246 option_value
.v
= va_arg(ap
, void *);
247 smbc_setOptionUserData(context
, option_value
.v
);
249 } else if (strcmp(option_name
, "smb_encrypt_level") == 0) {
250 option_value
.s
= va_arg(ap
, const char *);
251 if (strcmp(option_value
.s
, "none") == 0) {
252 smbc_setOptionSmbEncryptionLevel(context
,
253 SMBC_ENCRYPTLEVEL_NONE
);
254 } else if (strcmp(option_value
.s
, "request") == 0) {
255 smbc_setOptionSmbEncryptionLevel(context
,
256 SMBC_ENCRYPTLEVEL_REQUEST
);
257 } else if (strcmp(option_value
.s
, "require") == 0) {
258 smbc_setOptionSmbEncryptionLevel(context
,
259 SMBC_ENCRYPTLEVEL_REQUIRE
);
262 } else if (strcmp(option_name
, "browse_max_lmb_count") == 0) {
263 option_value
.i
= va_arg(ap
, int);
264 smbc_setOptionBrowseMaxLmbCount(context
, option_value
.i
);
266 } else if (strcmp(option_name
, "urlencode_readdir_entries") == 0) {
267 option_value
.b
= (bool) va_arg(ap
, int);
268 smbc_setOptionUrlEncodeReaddirEntries(context
, option_value
.b
);
270 } else if (strcmp(option_name
, "one_share_per_server") == 0) {
271 option_value
.b
= (bool) va_arg(ap
, int);
272 smbc_setOptionOneSharePerServer(context
, option_value
.b
);
274 } else if (strcmp(option_name
, "use_kerberos") == 0) {
275 option_value
.b
= (bool) va_arg(ap
, int);
276 smbc_setOptionUseKerberos(context
, option_value
.b
);
278 } else if (strcmp(option_name
, "fallback_after_kerberos") == 0) {
279 option_value
.b
= (bool) va_arg(ap
, int);
280 smbc_setOptionFallbackAfterKerberos(context
, option_value
.b
);
282 } else if (strcmp(option_name
, "no_auto_anonymous_login") == 0) {
283 option_value
.b
= (bool) va_arg(ap
, int);
284 smbc_setOptionNoAutoAnonymousLogin(context
, option_value
.b
);
292 * Deprecated interface. Do not use. Instead, use the various
293 * smbc_getOption*() functions.
296 smbc_option_get(SMBCCTX
*context
,
299 if (strcmp(option_name
, "debug_stderr") == 0) {
300 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
301 return (void *) (intptr_t) smbc_getOptionDebugToStderr(context
);
303 return (void *) smbc_getOptionDebugToStderr(context
);
306 } else if (strcmp(option_name
, "full_time_names") == 0) {
307 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
308 return (void *) (intptr_t) smbc_getOptionFullTimeNames(context
);
310 return (void *) smbc_getOptionFullTimeNames(context
);
313 } else if (strcmp(option_name
, "open_share_mode") == 0) {
314 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
315 return (void *) (intptr_t) smbc_getOptionOpenShareMode(context
);
317 return (void *) smbc_getOptionOpenShareMode(context
);
320 } else if (strcmp(option_name
, "auth_function") == 0) {
321 return (void *) smbc_getFunctionAuthDataWithContext(context
);
323 } else if (strcmp(option_name
, "user_data") == 0) {
324 return smbc_getOptionUserData(context
);
326 } else if (strcmp(option_name
, "smb_encrypt_level") == 0) {
327 switch(smbc_getOptionSmbEncryptionLevel(context
))
330 return (void *) "none";
332 return (void *) "request";
334 return (void *) "require";
337 } else if (strcmp(option_name
, "smb_encrypt_on") == 0) {
339 unsigned int num_servers
= 0;
341 for (s
= context
->internal
->servers
; s
; s
= s
->next
) {
343 if (s
->cli
->trans_enc_state
== NULL
) {
344 return (void *)false;
347 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
348 return (void *) (intptr_t) (bool) (num_servers
> 0);
350 return (void *) (bool) (num_servers
> 0);
353 } else if (strcmp(option_name
, "browse_max_lmb_count") == 0) {
354 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
355 return (void *) (intptr_t) smbc_getOptionBrowseMaxLmbCount(context
);
357 return (void *) smbc_getOptionBrowseMaxLmbCount(context
);
360 } else if (strcmp(option_name
, "urlencode_readdir_entries") == 0) {
361 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
362 return (void *)(intptr_t) smbc_getOptionUrlEncodeReaddirEntries(context
);
364 return (void *) (bool) smbc_getOptionUrlEncodeReaddirEntries(context
);
367 } else if (strcmp(option_name
, "one_share_per_server") == 0) {
368 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
369 return (void *) (intptr_t) smbc_getOptionOneSharePerServer(context
);
371 return (void *) (bool) smbc_getOptionOneSharePerServer(context
);
374 } else if (strcmp(option_name
, "use_kerberos") == 0) {
375 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
376 return (void *) (intptr_t) smbc_getOptionUseKerberos(context
);
378 return (void *) (bool) smbc_getOptionUseKerberos(context
);
381 } else if (strcmp(option_name
, "fallback_after_kerberos") == 0) {
382 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
383 return (void *)(intptr_t) smbc_getOptionFallbackAfterKerberos(context
);
385 return (void *) (bool) smbc_getOptionFallbackAfterKerberos(context
);
388 } else if (strcmp(option_name
, "no_auto_anonymous_login") == 0) {
389 #if defined(__intptr_t_defined) || defined(HAVE_INTPTR_T)
390 return (void *) (intptr_t) smbc_getOptionNoAutoAnonymousLogin(context
);
392 return (void *) (bool) smbc_getOptionNoAutoAnonymousLogin(context
);
401 * Initialize the library, etc.
403 * We accept a struct containing handle information.
404 * valid values for info->debug from 0 to 100,
405 * and insist that info->fn must be non-null.
408 smbc_init_context(SMBCCTX
*context
)
419 /* Do not initialise the same client twice */
420 if (context
->internal
->initialized
) {
424 if ((!smbc_getFunctionAuthData(context
) &&
425 !smbc_getFunctionAuthDataWithContext(context
)) ||
426 smbc_getDebug(context
) < 0 ||
427 smbc_getDebug(context
) > 100) {
434 if (!SMBC_initialized
) {
436 * Do some library-wide intializations the first time we get
439 bool conf_loaded
= False
;
440 TALLOC_CTX
*frame
= talloc_stackframe();
444 setup_logging("libsmbclient", True
);
445 if (context
->internal
->debug_stderr
) {
447 x_setbuf(x_stderr
, NULL
);
450 /* Here we would open the smb.conf file if needed ... */
452 lp_set_in_client(True
);
454 home
= getenv("HOME");
457 if (asprintf(&conf
, "%s/.smb/smb.conf", home
) > 0) {
458 if (lp_load(conf
, True
, False
, False
, True
)) {
461 DEBUG(5, ("Could not load config file: %s\n",
470 * Well, if that failed, try the get_dyn_CONFIGFILE
471 * Which points to the standard locn, and if that
472 * fails, silently ignore it and use the internal
476 if (!lp_load(get_dyn_CONFIGFILE(), True
, False
, False
, False
)) {
477 DEBUG(5, ("Could not load config file: %s\n",
478 get_dyn_CONFIGFILE()));
482 * We loaded the global config file. Now lets
483 * load user-specific modifications to the
487 "%s/.smb/smb.conf.append",
489 if (!lp_load(conf
, True
, False
, False
, False
)) {
491 ("Could not append config file: "
500 load_interfaces(); /* Load the list of interfaces ... */
502 reopen_logs(); /* Get logging working ... */
505 * Block SIGPIPE (from lib/util_sock.c: write())
506 * It is not needed and should not stop execution
508 BlockSignals(True
, SIGPIPE
);
510 /* Done with one-time initialisation */
511 SMBC_initialized
= 1;
516 if (!smbc_getUser(context
)) {
518 * FIXME: Is this the best way to get the user info?
520 user
= getenv("USER");
521 /* walk around as "guest" if no username can be found */
523 user
= SMB_STRDUP("guest");
525 user
= SMB_STRDUP(user
);
533 smbc_setUser(context
, user
);
536 if (!smbc_getNetbiosName(context
)) {
538 * We try to get our netbios name from the config. If that
539 * fails we fall back on constructing our netbios name from
543 if (global_myname()) {
544 netbios_name
= SMB_STRDUP(global_myname());
547 * Hmmm, I want to get hostname as well, but I am too
548 * lazy for the moment
551 netbios_name
= (char *)SMB_MALLOC(17);
556 slprintf(netbios_name
, 16,
557 "smbc%s%d", smbc_getUser(context
), pid
);
565 smbc_setNetbiosName(context
, netbios_name
);
568 DEBUG(1, ("Using netbios name %s.\n", smbc_getNetbiosName(context
)));
570 if (!smbc_getWorkgroup(context
)) {
573 if (lp_workgroup()) {
574 workgroup
= SMB_STRDUP(lp_workgroup());
577 /* TODO: Think about a decent default workgroup */
578 workgroup
= SMB_STRDUP("samba");
586 smbc_setWorkgroup(context
, workgroup
);
589 DEBUG(1, ("Using workgroup %s.\n", smbc_getWorkgroup(context
)));
591 /* shortest timeout is 1 second */
592 if (smbc_getTimeout(context
) > 0 && smbc_getTimeout(context
) < 1000)
593 smbc_setTimeout(context
, 1000);
596 * FIXME: Should we check the function pointers here?
599 context
->internal
->initialized
= True
;
605 /* Return the verion of samba, and thus libsmbclient */
609 return samba_version_string();