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 #define __LIBSMBCLIENT_INTERNAL__
27 #include "libsmbclient.h"
28 #include "libsmb_internal.h"
31 /** Get the netbios name used for making connections */
33 smbc_getNetbiosName(SMBCCTX *c)
35 return c->netbios_name;
38 /** Set the netbios name used for making connections */
40 smbc_setNetbiosName(SMBCCTX *c, char * netbios_name)
42 SAFE_FREE(c->netbios_name);
43 c->netbios_name = SMB_STRDUP(netbios_name);
46 /** Get the workgroup used for making connections */
48 smbc_getWorkgroup(SMBCCTX *c)
53 /** Set the workgroup used for making connections */
55 smbc_setWorkgroup(SMBCCTX *c, char * workgroup)
57 SAFE_FREE(c->workgroup);
58 c->workgroup = SMB_STRDUP(workgroup);
61 /** Get the username used for making connections */
63 smbc_getUser(SMBCCTX *c)
68 /** Set the username used for making connections */
70 smbc_setUser(SMBCCTX *c, char * user)
73 c->user = SMB_STRDUP(user);
76 /** Get the debug level */
78 smbc_getDebug(SMBCCTX *c)
83 /** Set the debug level */
85 smbc_setDebug(SMBCCTX *c, int debug)
92 * Get the timeout used for waiting on connections and response data
96 smbc_getTimeout(SMBCCTX *c)
102 * Set the timeout used for waiting on connections and response data
106 smbc_setTimeout(SMBCCTX *c, int timeout)
108 c->timeout = timeout;
111 /** Get whether to log to standard error instead of standard output */
113 smbc_getOptionDebugToStderr(SMBCCTX *c)
115 return c->internal->debug_stderr;
118 /** Set whether to log to standard error instead of standard output */
120 smbc_setOptionDebugToStderr(SMBCCTX *c, smbc_bool b)
122 c->internal->debug_stderr = b;
126 * Get whether to use new-style time attribute names, e.g. WRITE_TIME rather
127 * than the old-style names such as M_TIME. This allows also setting/getting
128 * CREATE_TIME which was previously unimplemented. (Note that the old C_TIME
129 * was supposed to be CHANGE_TIME but was confused and sometimes referred to
133 smbc_getOptionFullTimeNames(SMBCCTX *c)
135 return c->internal->full_time_names;
139 * Set whether to use new-style time attribute names, e.g. WRITE_TIME rather
140 * than the old-style names such as M_TIME. This allows also setting/getting
141 * CREATE_TIME which was previously unimplemented. (Note that the old C_TIME
142 * was supposed to be CHANGE_TIME but was confused and sometimes referred to
146 smbc_setOptionFullTimeNames(SMBCCTX *c, smbc_bool b)
148 c->internal->full_time_names = b;
152 * Get the share mode to use for files opened with SMBC_open_ctx(). The
153 * default is SMBC_SHAREMODE_DENY_NONE.
156 smbc_getOptionOpenShareMode(SMBCCTX *c)
158 return c->internal->share_mode;
162 * Set the share mode to use for files opened with SMBC_open_ctx(). The
163 * default is SMBC_SHAREMODE_DENY_NONE.
166 smbc_setOptionOpenShareMode(SMBCCTX *c, smbc_share_mode share_mode)
168 c->internal->share_mode = share_mode;
171 /** Retrieve a previously set user data handle */
173 smbc_getOptionUserData(SMBCCTX *c)
175 return c->internal->user_data;
178 /** Save a user data handle */
180 smbc_setOptionUserData(SMBCCTX *c, void *user_data)
182 c->internal->user_data = user_data;
185 /** Get the encoded value for encryption level. */
186 smbc_smb_encrypt_level
187 smbc_getOptionSmbEncryptionLevel(SMBCCTX *c)
189 return c->internal->smb_encryption_level;
192 /** Set the encoded value for encryption level. */
194 smbc_setOptionSmbEncryptionLevel(SMBCCTX *c, smbc_smb_encrypt_level level)
196 c->internal->smb_encryption_level = level;
200 * Get whether to treat file names as case-sensitive if we can't determine
201 * when connecting to the remote share whether the file system is case
202 * sensitive. This defaults to FALSE since it's most likely that if we can't
203 * retrieve the file system attributes, it's a very old file system that does
204 * not support case sensitivity.
207 smbc_getOptionCaseSensitive(SMBCCTX *c)
209 return c->internal->case_sensitive;
213 * Set whether to treat file names as case-sensitive if we can't determine
214 * when connecting to the remote share whether the file system is case
215 * sensitive. This defaults to FALSE since it's most likely that if we can't
216 * retrieve the file system attributes, it's a very old file system that does
217 * not support case sensitivity.
220 smbc_setOptionCaseSensitive(SMBCCTX *c, smbc_bool b)
222 c->internal->case_sensitive = b;
226 * Get from how many local master browsers should the list of workgroups be
227 * retrieved. It can take up to 12 minutes or longer after a server becomes a
228 * local master browser, for it to have the entire browse list (the list of
229 * workgroups/domains) from an entire network. Since a client never knows
230 * which local master browser will be found first, the one which is found
231 * first and used to retrieve a browse list may have an incomplete or empty
232 * browse list. By requesting the browse list from multiple local master
233 * browsers, a more complete list can be generated. For small networks (few
234 * workgroups), it is recommended that this value be set to 0, causing the
235 * browse lists from all found local master browsers to be retrieved and
236 * merged. For networks with many workgroups, a suitable value for this
237 * variable is probably somewhere around 3. (Default: 3).
240 smbc_getOptionBrowseMaxLmbCount(SMBCCTX *c)
242 return c->options.browse_max_lmb_count;
246 * Set from how many local master browsers should the list of workgroups be
247 * retrieved. It can take up to 12 minutes or longer after a server becomes a
248 * local master browser, for it to have the entire browse list (the list of
249 * workgroups/domains) from an entire network. Since a client never knows
250 * which local master browser will be found first, the one which is found
251 * first and used to retrieve a browse list may have an incomplete or empty
252 * browse list. By requesting the browse list from multiple local master
253 * browsers, a more complete list can be generated. For small networks (few
254 * workgroups), it is recommended that this value be set to 0, causing the
255 * browse lists from all found local master browsers to be retrieved and
256 * merged. For networks with many workgroups, a suitable value for this
257 * variable is probably somewhere around 3. (Default: 3).
260 smbc_setOptionBrowseMaxLmbCount(SMBCCTX *c, int count)
262 c->options.browse_max_lmb_count = count;
266 * Get whether to url-encode readdir entries.
268 * There is a difference in the desired return strings from
269 * smbc_readdir() depending upon whether the filenames are to
270 * be displayed to the user, or whether they are to be
271 * appended to the path name passed to smbc_opendir() to call
272 * a further smbc_ function (e.g. open the file with
273 * smbc_open()). In the former case, the filename should be
274 * in "human readable" form. In the latter case, the smbc_
275 * functions expect a URL which must be url-encoded. Those
276 * functions decode the URL. If, for example, smbc_readdir()
277 * returned a file name of "abc%20def.txt", passing a path
278 * with this file name attached to smbc_open() would cause
279 * smbc_open to attempt to open the file "abc def.txt" since
280 * the %20 is decoded into a space.
282 * Set this option to True if the names returned by
283 * smbc_readdir() should be url-encoded such that they can be
284 * passed back to another smbc_ call. Set it to False if the
285 * names returned by smbc_readdir() are to be presented to the
288 * For backwards compatibility, this option defaults to False.
291 smbc_getOptionUrlEncodeReaddirEntries(SMBCCTX *c)
293 return c->options.urlencode_readdir_entries;
297 * Set whether to url-encode readdir entries.
299 * There is a difference in the desired return strings from
300 * smbc_readdir() depending upon whether the filenames are to
301 * be displayed to the user, or whether they are to be
302 * appended to the path name passed to smbc_opendir() to call
303 * a further smbc_ function (e.g. open the file with
304 * smbc_open()). In the former case, the filename should be
305 * in "human readable" form. In the latter case, the smbc_
306 * functions expect a URL which must be url-encoded. Those
307 * functions decode the URL. If, for example, smbc_readdir()
308 * returned a file name of "abc%20def.txt", passing a path
309 * with this file name attached to smbc_open() would cause
310 * smbc_open to attempt to open the file "abc def.txt" since
311 * the %20 is decoded into a space.
313 * Set this option to True if the names returned by
314 * smbc_readdir() should be url-encoded such that they can be
315 * passed back to another smbc_ call. Set it to False if the
316 * names returned by smbc_readdir() are to be presented to the
319 * For backwards compatibility, this option defaults to False.
322 smbc_setOptionUrlEncodeReaddirEntries(SMBCCTX *c, smbc_bool b)
324 c->options.urlencode_readdir_entries = b;
328 * Get whether to use the same connection for all shares on a server.
330 * Some Windows versions appear to have a limit to the number
331 * of concurrent SESSIONs and/or TREE CONNECTions. In
332 * one-shot programs (i.e. the program runs and then quickly
333 * ends, thereby shutting down all connections), it is
334 * probably reasonable to establish a new connection for each
335 * share. In long-running applications, the limitation can be
336 * avoided by using only a single connection to each server,
337 * and issuing a new TREE CONNECT when the share is accessed.
340 smbc_getOptionOneSharePerServer(SMBCCTX *c)
342 return c->options.one_share_per_server;
346 * Set whether to use the same connection for all shares on a server.
348 * Some Windows versions appear to have a limit to the number
349 * of concurrent SESSIONs and/or TREE CONNECTions. In
350 * one-shot programs (i.e. the program runs and then quickly
351 * ends, thereby shutting down all connections), it is
352 * probably reasonable to establish a new connection for each
353 * share. In long-running applications, the limitation can be
354 * avoided by using only a single connection to each server,
355 * and issuing a new TREE CONNECT when the share is accessed.
358 smbc_setOptionOneSharePerServer(SMBCCTX *c, smbc_bool b)
360 c->options.one_share_per_server = b;
363 /** Get whether to enable use of kerberos */
365 smbc_getOptionUseKerberos(SMBCCTX *c)
367 return c->flags & SMB_CTX_FLAG_USE_KERBEROS ? True : False;
370 /** Set whether to enable use of kerberos */
372 smbc_setOptionUseKerberos(SMBCCTX *c, smbc_bool b)
375 c->flags |= SMB_CTX_FLAG_USE_KERBEROS;
377 c->flags &= ~SMB_CTX_FLAG_USE_KERBEROS;
381 /** Get whether to fallback after kerberos */
383 smbc_getOptionFallbackAfterKerberos(SMBCCTX *c)
385 return c->flags & SMB_CTX_FLAG_FALLBACK_AFTER_KERBEROS ? True : False;
388 /** Set whether to fallback after kerberos */
390 smbc_setOptionFallbackAfterKerberos(SMBCCTX *c, smbc_bool b)
393 c->flags |= SMB_CTX_FLAG_FALLBACK_AFTER_KERBEROS;
395 c->flags &= ~SMB_CTX_FLAG_FALLBACK_AFTER_KERBEROS;
399 /** Get whether to automatically select anonymous login */
401 smbc_getOptionNoAutoAnonymousLogin(SMBCCTX *c)
403 return c->flags & SMBCCTX_FLAG_NO_AUTO_ANONYMOUS_LOGON ? True : False;
406 /** Set whether to automatically select anonymous login */
408 smbc_setOptionNoAutoAnonymousLogin(SMBCCTX *c, smbc_bool b)
411 c->flags |= SMBCCTX_FLAG_NO_AUTO_ANONYMOUS_LOGON;
413 c->flags &= ~SMBCCTX_FLAG_NO_AUTO_ANONYMOUS_LOGON;
417 /** Get the function for obtaining authentication data */
418 smbc_get_auth_data_fn
419 smbc_getFunctionAuthData(SMBCCTX *c)
421 return c->callbacks.auth_fn;
424 /** Set the function for obtaining authentication data */
426 smbc_setFunctionAuthData(SMBCCTX *c, smbc_get_auth_data_fn fn)
428 c->internal->auth_fn_with_context = NULL;
429 c->callbacks.auth_fn = fn;
432 /** Get the new-style authentication function which includes the context. */
433 smbc_get_auth_data_with_context_fn
434 smbc_getFunctionAuthDataWithContext(SMBCCTX *c)
436 return c->internal->auth_fn_with_context;
439 /** Set the new-style authentication function which includes the context. */
441 smbc_setFunctionAuthDataWithContext(SMBCCTX *c,
442 smbc_get_auth_data_with_context_fn fn)
444 c->callbacks.auth_fn = NULL;
445 c->internal->auth_fn_with_context = fn;
448 /** Get the function for checking if a server is still good */
450 smbc_getFunctionCheckServer(SMBCCTX *c)
452 return c->callbacks.check_server_fn;
455 /** Set the function for checking if a server is still good */
457 smbc_setFunctionCheckServer(SMBCCTX *c, smbc_check_server_fn fn)
459 c->callbacks.check_server_fn = fn;
462 /** Get the function for removing a server if unused */
463 smbc_remove_unused_server_fn
464 smbc_getFunctionRemoveUnusedServer(SMBCCTX *c)
466 return c->callbacks.remove_unused_server_fn;
469 /** Set the function for removing a server if unused */
471 smbc_setFunctionRemoveUnusedServer(SMBCCTX *c,
472 smbc_remove_unused_server_fn fn)
474 c->callbacks.remove_unused_server_fn = fn;
477 /** Get the function for adding a cached server */
478 smbc_add_cached_srv_fn
479 smbc_getFunctionAddCachedServer(SMBCCTX *c)
481 return c->callbacks.add_cached_srv_fn;
484 /** Set the function for adding a cached server */
486 smbc_setFunctionAddCachedServer(SMBCCTX *c, smbc_add_cached_srv_fn fn)
488 c->callbacks.add_cached_srv_fn = fn;
491 /** Get the function for server cache lookup */
492 smbc_get_cached_srv_fn
493 smbc_getFunctionGetCachedServer(SMBCCTX *c)
495 return c->callbacks.get_cached_srv_fn;
498 /** Set the function for server cache lookup */
500 smbc_setFunctionGetCachedServer(SMBCCTX *c, smbc_get_cached_srv_fn fn)
502 c->callbacks.get_cached_srv_fn = fn;
505 /** Get the function for server cache removal */
506 smbc_remove_cached_srv_fn
507 smbc_getFunctionRemoveCachedServer(SMBCCTX *c)
509 return c->callbacks.remove_cached_srv_fn;
512 /** Set the function for server cache removal */
514 smbc_setFunctionRemoveCachedServer(SMBCCTX *c,
515 smbc_remove_cached_srv_fn fn)
517 c->callbacks.remove_cached_srv_fn = fn;
521 * Get the function for server cache purging. This function tries to
522 * remove all cached servers (e.g. on disconnect)
525 smbc_getFunctionPurgeCachedServers(SMBCCTX *c)
527 return c->callbacks.purge_cached_fn;
530 /** Set the function to store private data of the server cache */
531 void smbc_setServerCacheData(SMBCCTX *c, struct smbc_server_cache * cache)
533 c->internal->server_cache = cache;
536 /** Get the function to store private data of the server cache */
537 struct smbc_server_cache * smbc_getServerCacheData(SMBCCTX *c)
539 return c->internal->server_cache;
544 * Set the function for server cache purging. This function tries to
545 * remove all cached servers (e.g. on disconnect)
548 smbc_setFunctionPurgeCachedServers(SMBCCTX *c, smbc_purge_cached_fn fn)
550 c->callbacks.purge_cached_fn = fn;
554 * Callable functions for files.
558 smbc_getFunctionOpen(SMBCCTX *c)
564 smbc_setFunctionOpen(SMBCCTX *c, smbc_open_fn fn)
570 smbc_getFunctionCreat(SMBCCTX *c)
576 smbc_setFunctionCreat(SMBCCTX *c, smbc_creat_fn fn)
582 smbc_getFunctionRead(SMBCCTX *c)
588 smbc_setFunctionRead(SMBCCTX *c, smbc_read_fn fn)
594 smbc_getFunctionWrite(SMBCCTX *c)
600 smbc_setFunctionWrite(SMBCCTX *c, smbc_write_fn fn)
606 smbc_getFunctionUnlink(SMBCCTX *c)
612 smbc_setFunctionUnlink(SMBCCTX *c, smbc_unlink_fn fn)
618 smbc_getFunctionRename(SMBCCTX *c)
624 smbc_setFunctionRename(SMBCCTX *c, smbc_rename_fn fn)
630 smbc_getFunctionLseek(SMBCCTX *c)
636 smbc_setFunctionLseek(SMBCCTX *c, smbc_lseek_fn fn)
642 smbc_getFunctionStat(SMBCCTX *c)
648 smbc_setFunctionStat(SMBCCTX *c, smbc_stat_fn fn)
654 smbc_getFunctionFstat(SMBCCTX *c)
660 smbc_setFunctionFstat(SMBCCTX *c, smbc_fstat_fn fn)
666 smbc_getFunctionStatVFS(SMBCCTX *c)
668 return c->internal->posix_emu.statvfs_fn;
672 smbc_setFunctionStatVFS(SMBCCTX *c, smbc_statvfs_fn fn)
674 c->internal->posix_emu.statvfs_fn = fn;
678 smbc_getFunctionFstatVFS(SMBCCTX *c)
680 return c->internal->posix_emu.fstatvfs_fn;
684 smbc_setFunctionFstatVFS(SMBCCTX *c, smbc_fstatvfs_fn fn)
686 c->internal->posix_emu.fstatvfs_fn = fn;
690 smbc_getFunctionFtruncate(SMBCCTX *c)
692 return c->internal->posix_emu.ftruncate_fn;
696 smbc_setFunctionFtruncate(SMBCCTX *c, smbc_ftruncate_fn fn)
698 c->internal->posix_emu.ftruncate_fn = fn;
702 smbc_getFunctionClose(SMBCCTX *c)
708 smbc_setFunctionClose(SMBCCTX *c, smbc_close_fn fn)
715 * Callable functions for directories.
719 smbc_getFunctionOpendir(SMBCCTX *c)
725 smbc_setFunctionOpendir(SMBCCTX *c, smbc_opendir_fn fn)
731 smbc_getFunctionClosedir(SMBCCTX *c)
737 smbc_setFunctionClosedir(SMBCCTX *c, smbc_closedir_fn fn)
743 smbc_getFunctionReaddir(SMBCCTX *c)
749 smbc_setFunctionReaddir(SMBCCTX *c, smbc_readdir_fn fn)
755 smbc_getFunctionGetdents(SMBCCTX *c)
761 smbc_setFunctionGetdents(SMBCCTX *c, smbc_getdents_fn fn)
767 smbc_getFunctionMkdir(SMBCCTX *c)
773 smbc_setFunctionMkdir(SMBCCTX *c, smbc_mkdir_fn fn)
779 smbc_getFunctionRmdir(SMBCCTX *c)
785 smbc_setFunctionRmdir(SMBCCTX *c, smbc_rmdir_fn fn)
791 smbc_getFunctionTelldir(SMBCCTX *c)
797 smbc_setFunctionTelldir(SMBCCTX *c, smbc_telldir_fn fn)
803 smbc_getFunctionLseekdir(SMBCCTX *c)
809 smbc_setFunctionLseekdir(SMBCCTX *c, smbc_lseekdir_fn fn)
815 smbc_getFunctionFstatdir(SMBCCTX *c)
821 smbc_setFunctionFstatdir(SMBCCTX *c, smbc_fstatdir_fn fn)
828 * Callable functions applicable to both files and directories.
832 smbc_getFunctionChmod(SMBCCTX *c)
838 smbc_setFunctionChmod(SMBCCTX *c, smbc_chmod_fn fn)
844 smbc_getFunctionUtimes(SMBCCTX *c)
850 smbc_setFunctionUtimes(SMBCCTX *c, smbc_utimes_fn fn)
856 smbc_getFunctionSetxattr(SMBCCTX *c)
862 smbc_setFunctionSetxattr(SMBCCTX *c, smbc_setxattr_fn fn)
868 smbc_getFunctionGetxattr(SMBCCTX *c)
874 smbc_setFunctionGetxattr(SMBCCTX *c, smbc_getxattr_fn fn)
880 smbc_getFunctionRemovexattr(SMBCCTX *c)
882 return c->removexattr;
886 smbc_setFunctionRemovexattr(SMBCCTX *c, smbc_removexattr_fn fn)
892 smbc_getFunctionListxattr(SMBCCTX *c)
898 smbc_setFunctionListxattr(SMBCCTX *c, smbc_listxattr_fn fn)
905 * Callable functions related to printing
909 smbc_getFunctionPrintFile(SMBCCTX *c)
911 return c->print_file;
915 smbc_setFunctionPrintFile(SMBCCTX *c, smbc_print_file_fn fn)
920 smbc_open_print_job_fn
921 smbc_getFunctionOpenPrintJob(SMBCCTX *c)
923 return c->open_print_job;
927 smbc_setFunctionOpenPrintJob(SMBCCTX *c,
928 smbc_open_print_job_fn fn)
930 c->open_print_job = fn;
933 smbc_list_print_jobs_fn
934 smbc_getFunctionListPrintJobs(SMBCCTX *c)
936 return c->list_print_jobs;
940 smbc_setFunctionListPrintJobs(SMBCCTX *c,
941 smbc_list_print_jobs_fn fn)
943 c->list_print_jobs = fn;
946 smbc_unlink_print_job_fn
947 smbc_getFunctionUnlinkPrintJob(SMBCCTX *c)
949 return c->unlink_print_job;
953 smbc_setFunctionUnlinkPrintJob(SMBCCTX *c,
954 smbc_unlink_print_job_fn fn)
956 c->unlink_print_job = fn;