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 c->netbios_name = netbios_name;
45 /** Get the workgroup used for making connections */
47 smbc_getWorkgroup(SMBCCTX *c)
52 /** Set the workgroup used for making connections */
54 smbc_setWorkgroup(SMBCCTX *c, char * workgroup)
56 c->workgroup = workgroup;
59 /** Get the username used for making connections */
61 smbc_getUser(SMBCCTX *c)
66 /** Set the username used for making connections */
68 smbc_setUser(SMBCCTX *c, char * user)
73 /** Get the debug level */
75 smbc_getDebug(SMBCCTX *c)
80 /** Set the debug level */
82 smbc_setDebug(SMBCCTX *c, int debug)
89 * Get the timeout used for waiting on connections and response data
93 smbc_getTimeout(SMBCCTX *c)
99 * Set the timeout used for waiting on connections and response data
103 smbc_setTimeout(SMBCCTX *c, int timeout)
105 c->timeout = timeout;
108 /** Get whether to log to standard error instead of standard output */
110 smbc_getOptionDebugToStderr(SMBCCTX *c)
112 return c->internal->debug_stderr;
115 /** Set whether to log to standard error instead of standard output */
117 smbc_setOptionDebugToStderr(SMBCCTX *c, smbc_bool b)
119 c->internal->debug_stderr = b;
123 * Get whether to use new-style time attribute names, e.g. WRITE_TIME rather
124 * than the old-style names such as M_TIME. This allows also setting/getting
125 * CREATE_TIME which was previously unimplemented. (Note that the old C_TIME
126 * was supposed to be CHANGE_TIME but was confused and sometimes referred to
130 smbc_getOptionFullTimeNames(SMBCCTX *c)
132 return c->internal->full_time_names;
136 * Set whether to use new-style time attribute names, e.g. WRITE_TIME rather
137 * than the old-style names such as M_TIME. This allows also setting/getting
138 * CREATE_TIME which was previously unimplemented. (Note that the old C_TIME
139 * was supposed to be CHANGE_TIME but was confused and sometimes referred to
143 smbc_setOptionFullTimeNames(SMBCCTX *c, smbc_bool b)
145 c->internal->full_time_names = b;
149 * Get the share mode to use for files opened with SMBC_open_ctx(). The
150 * default is SMBC_SHAREMODE_DENY_NONE.
153 smbc_getOptionOpenShareMode(SMBCCTX *c)
155 return c->internal->share_mode;
159 * Set the share mode to use for files opened with SMBC_open_ctx(). The
160 * default is SMBC_SHAREMODE_DENY_NONE.
163 smbc_setOptionOpenShareMode(SMBCCTX *c, smbc_share_mode share_mode)
165 c->internal->share_mode = share_mode;
168 /** Retrieve a previously set user data handle */
170 smbc_getOptionUserData(SMBCCTX *c)
172 return c->internal->user_data;
175 /** Save a user data handle */
177 smbc_setOptionUserData(SMBCCTX *c, void *user_data)
179 c->internal->user_data = user_data;
182 /** Get the encoded value for encryption level. */
183 smbc_smb_encrypt_level
184 smbc_getOptionSmbEncryptionLevel(SMBCCTX *c)
186 return c->internal->smb_encryption_level;
189 /** Set the encoded value for encryption level. */
191 smbc_setOptionSmbEncryptionLevel(SMBCCTX *c, smbc_smb_encrypt_level level)
193 c->internal->smb_encryption_level = level;
197 * Get whether to treat file names as case-sensitive if we can't determine
198 * when connecting to the remote share whether the file system is case
199 * sensitive. This defaults to FALSE since it's most likely that if we can't
200 * retrieve the file system attributes, it's a very old file system that does
201 * not support case sensitivity.
204 smbc_getOptionCaseSensitive(SMBCCTX *c)
206 return c->internal->case_sensitive;
210 * Set whether to treat file names as case-sensitive if we can't determine
211 * when connecting to the remote share whether the file system is case
212 * sensitive. This defaults to FALSE since it's most likely that if we can't
213 * retrieve the file system attributes, it's a very old file system that does
214 * not support case sensitivity.
217 smbc_setOptionCaseSensitive(SMBCCTX *c, smbc_bool b)
219 c->internal->case_sensitive = b;
223 * Get from how many local master browsers should the list of workgroups be
224 * retrieved. It can take up to 12 minutes or longer after a server becomes a
225 * local master browser, for it to have the entire browse list (the list of
226 * workgroups/domains) from an entire network. Since a client never knows
227 * which local master browser will be found first, the one which is found
228 * first and used to retrieve a browse list may have an incomplete or empty
229 * browse list. By requesting the browse list from multiple local master
230 * browsers, a more complete list can be generated. For small networks (few
231 * workgroups), it is recommended that this value be set to 0, causing the
232 * browse lists from all found local master browsers to be retrieved and
233 * merged. For networks with many workgroups, a suitable value for this
234 * variable is probably somewhere around 3. (Default: 3).
237 smbc_getOptionBrowseMaxLmbCount(SMBCCTX *c)
239 return c->options.browse_max_lmb_count;
243 * Set from how many local master browsers should the list of workgroups be
244 * retrieved. It can take up to 12 minutes or longer after a server becomes a
245 * local master browser, for it to have the entire browse list (the list of
246 * workgroups/domains) from an entire network. Since a client never knows
247 * which local master browser will be found first, the one which is found
248 * first and used to retrieve a browse list may have an incomplete or empty
249 * browse list. By requesting the browse list from multiple local master
250 * browsers, a more complete list can be generated. For small networks (few
251 * workgroups), it is recommended that this value be set to 0, causing the
252 * browse lists from all found local master browsers to be retrieved and
253 * merged. For networks with many workgroups, a suitable value for this
254 * variable is probably somewhere around 3. (Default: 3).
257 smbc_setOptionBrowseMaxLmbCount(SMBCCTX *c, int count)
259 c->options.browse_max_lmb_count = count;
263 * Get whether to url-encode readdir entries.
265 * There is a difference in the desired return strings from
266 * smbc_readdir() depending upon whether the filenames are to
267 * be displayed to the user, or whether they are to be
268 * appended to the path name passed to smbc_opendir() to call
269 * a further smbc_ function (e.g. open the file with
270 * smbc_open()). In the former case, the filename should be
271 * in "human readable" form. In the latter case, the smbc_
272 * functions expect a URL which must be url-encoded. Those
273 * functions decode the URL. If, for example, smbc_readdir()
274 * returned a file name of "abc%20def.txt", passing a path
275 * with this file name attached to smbc_open() would cause
276 * smbc_open to attempt to open the file "abc def.txt" since
277 * the %20 is decoded into a space.
279 * Set this option to True if the names returned by
280 * smbc_readdir() should be url-encoded such that they can be
281 * passed back to another smbc_ call. Set it to False if the
282 * names returned by smbc_readdir() are to be presented to the
285 * For backwards compatibility, this option defaults to False.
288 smbc_getOptionUrlEncodeReaddirEntries(SMBCCTX *c)
290 return c->options.urlencode_readdir_entries;
294 * Set whether to url-encode readdir entries.
296 * There is a difference in the desired return strings from
297 * smbc_readdir() depending upon whether the filenames are to
298 * be displayed to the user, or whether they are to be
299 * appended to the path name passed to smbc_opendir() to call
300 * a further smbc_ function (e.g. open the file with
301 * smbc_open()). In the former case, the filename should be
302 * in "human readable" form. In the latter case, the smbc_
303 * functions expect a URL which must be url-encoded. Those
304 * functions decode the URL. If, for example, smbc_readdir()
305 * returned a file name of "abc%20def.txt", passing a path
306 * with this file name attached to smbc_open() would cause
307 * smbc_open to attempt to open the file "abc def.txt" since
308 * the %20 is decoded into a space.
310 * Set this option to True if the names returned by
311 * smbc_readdir() should be url-encoded such that they can be
312 * passed back to another smbc_ call. Set it to False if the
313 * names returned by smbc_readdir() are to be presented to the
316 * For backwards compatibility, this option defaults to False.
319 smbc_setOptionUrlEncodeReaddirEntries(SMBCCTX *c, smbc_bool b)
321 c->options.urlencode_readdir_entries = b;
325 * Get whether to use the same connection for all shares on a server.
327 * Some Windows versions appear to have a limit to the number
328 * of concurrent SESSIONs and/or TREE CONNECTions. In
329 * one-shot programs (i.e. the program runs and then quickly
330 * ends, thereby shutting down all connections), it is
331 * probably reasonable to establish a new connection for each
332 * share. In long-running applications, the limitation can be
333 * avoided by using only a single connection to each server,
334 * and issuing a new TREE CONNECT when the share is accessed.
337 smbc_getOptionOneSharePerServer(SMBCCTX *c)
339 return c->options.one_share_per_server;
343 * Set whether to use the same connection for all shares on a server.
345 * Some Windows versions appear to have a limit to the number
346 * of concurrent SESSIONs and/or TREE CONNECTions. In
347 * one-shot programs (i.e. the program runs and then quickly
348 * ends, thereby shutting down all connections), it is
349 * probably reasonable to establish a new connection for each
350 * share. In long-running applications, the limitation can be
351 * avoided by using only a single connection to each server,
352 * and issuing a new TREE CONNECT when the share is accessed.
355 smbc_setOptionOneSharePerServer(SMBCCTX *c, smbc_bool b)
357 c->options.one_share_per_server = b;
360 /** Get whether to enable use of kerberos */
362 smbc_getOptionUseKerberos(SMBCCTX *c)
364 return c->flags & SMB_CTX_FLAG_USE_KERBEROS ? True : False;
367 /** Set whether to enable use of kerberos */
369 smbc_setOptionUseKerberos(SMBCCTX *c, smbc_bool b)
372 c->flags |= SMB_CTX_FLAG_USE_KERBEROS;
374 c->flags &= ~SMB_CTX_FLAG_USE_KERBEROS;
378 /** Get whether to fallback after kerberos */
380 smbc_getOptionFallbackAfterKerberos(SMBCCTX *c)
382 return c->flags & SMB_CTX_FLAG_FALLBACK_AFTER_KERBEROS ? True : False;
385 /** Set whether to fallback after kerberos */
387 smbc_setOptionFallbackAfterKerberos(SMBCCTX *c, smbc_bool b)
390 c->flags |= SMB_CTX_FLAG_FALLBACK_AFTER_KERBEROS;
392 c->flags &= ~SMB_CTX_FLAG_FALLBACK_AFTER_KERBEROS;
396 /** Get whether to automatically select anonymous login */
398 smbc_getOptionNoAutoAnonymousLogin(SMBCCTX *c)
400 return c->flags & SMBCCTX_FLAG_NO_AUTO_ANONYMOUS_LOGON ? True : False;
403 /** Set whether to automatically select anonymous login */
405 smbc_setOptionNoAutoAnonymousLogin(SMBCCTX *c, smbc_bool b)
408 c->flags |= SMBCCTX_FLAG_NO_AUTO_ANONYMOUS_LOGON;
410 c->flags &= ~SMBCCTX_FLAG_NO_AUTO_ANONYMOUS_LOGON;
414 /** Get the function for obtaining authentication data */
415 smbc_get_auth_data_fn
416 smbc_getFunctionAuthData(SMBCCTX *c)
418 return c->callbacks.auth_fn;
421 /** Set the function for obtaining authentication data */
423 smbc_setFunctionAuthData(SMBCCTX *c, smbc_get_auth_data_fn fn)
425 c->internal->auth_fn_with_context = NULL;
426 c->callbacks.auth_fn = fn;
429 /** Get the new-style authentication function which includes the context. */
430 smbc_get_auth_data_with_context_fn
431 smbc_getFunctionAuthDataWithContext(SMBCCTX *c)
433 return c->internal->auth_fn_with_context;
436 /** Set the new-style authentication function which includes the context. */
438 smbc_setFunctionAuthDataWithContext(SMBCCTX *c,
439 smbc_get_auth_data_with_context_fn fn)
441 c->callbacks.auth_fn = NULL;
442 c->internal->auth_fn_with_context = fn;
445 /** Get the function for checking if a server is still good */
447 smbc_getFunctionCheckServer(SMBCCTX *c)
449 return c->callbacks.check_server_fn;
452 /** Set the function for checking if a server is still good */
454 smbc_setFunctionCheckServer(SMBCCTX *c, smbc_check_server_fn fn)
456 c->callbacks.check_server_fn = fn;
459 /** Get the function for removing a server if unused */
460 smbc_remove_unused_server_fn
461 smbc_getFunctionRemoveUnusedServer(SMBCCTX *c)
463 return c->callbacks.remove_unused_server_fn;
466 /** Set the function for removing a server if unused */
468 smbc_setFunctionRemoveUnusedServer(SMBCCTX *c,
469 smbc_remove_unused_server_fn fn)
471 c->callbacks.remove_unused_server_fn = fn;
474 /** Get the function for adding a cached server */
475 smbc_add_cached_srv_fn
476 smbc_getFunctionAddCachedServer(SMBCCTX *c)
478 return c->callbacks.add_cached_srv_fn;
481 /** Set the function for adding a cached server */
483 smbc_setFunctionAddCachedServer(SMBCCTX *c, smbc_add_cached_srv_fn fn)
485 c->callbacks.add_cached_srv_fn = fn;
488 /** Get the function for server cache lookup */
489 smbc_get_cached_srv_fn
490 smbc_getFunctionGetCachedServer(SMBCCTX *c)
492 return c->callbacks.get_cached_srv_fn;
495 /** Set the function for server cache lookup */
497 smbc_setFunctionGetCachedServer(SMBCCTX *c, smbc_get_cached_srv_fn fn)
499 c->callbacks.get_cached_srv_fn = fn;
502 /** Get the function for server cache removal */
503 smbc_remove_cached_srv_fn
504 smbc_getFunctionRemoveCachedServer(SMBCCTX *c)
506 return c->callbacks.remove_cached_srv_fn;
509 /** Set the function for server cache removal */
511 smbc_setFunctionRemoveCachedServer(SMBCCTX *c,
512 smbc_remove_cached_srv_fn fn)
514 c->callbacks.remove_cached_srv_fn = fn;
518 * Get the function for server cache purging. This function tries to
519 * remove all cached servers (e.g. on disconnect)
522 smbc_getFunctionPurgeCachedServers(SMBCCTX *c)
524 return c->callbacks.purge_cached_fn;
527 /** Set the function to store private data of the server cache */
528 void smbc_setServerCacheData(SMBCCTX *c, struct smbc_server_cache * cache)
530 c->internal->server_cache = cache;
533 /** Get the function to store private data of the server cache */
534 struct smbc_server_cache * smbc_getServerCacheData(SMBCCTX *c)
536 return c->internal->server_cache;
541 * Set the function for server cache purging. This function tries to
542 * remove all cached servers (e.g. on disconnect)
545 smbc_setFunctionPurgeCachedServers(SMBCCTX *c, smbc_purge_cached_fn fn)
547 c->callbacks.purge_cached_fn = fn;
551 * Callable functions for files.
555 smbc_getFunctionOpen(SMBCCTX *c)
561 smbc_setFunctionOpen(SMBCCTX *c, smbc_open_fn fn)
567 smbc_getFunctionCreat(SMBCCTX *c)
573 smbc_setFunctionCreat(SMBCCTX *c, smbc_creat_fn fn)
579 smbc_getFunctionRead(SMBCCTX *c)
585 smbc_setFunctionRead(SMBCCTX *c, smbc_read_fn fn)
591 smbc_getFunctionWrite(SMBCCTX *c)
597 smbc_setFunctionWrite(SMBCCTX *c, smbc_write_fn fn)
603 smbc_getFunctionUnlink(SMBCCTX *c)
609 smbc_setFunctionUnlink(SMBCCTX *c, smbc_unlink_fn fn)
615 smbc_getFunctionRename(SMBCCTX *c)
621 smbc_setFunctionRename(SMBCCTX *c, smbc_rename_fn fn)
627 smbc_getFunctionLseek(SMBCCTX *c)
633 smbc_setFunctionLseek(SMBCCTX *c, smbc_lseek_fn fn)
639 smbc_getFunctionStat(SMBCCTX *c)
645 smbc_setFunctionStat(SMBCCTX *c, smbc_stat_fn fn)
651 smbc_getFunctionFstat(SMBCCTX *c)
657 smbc_setFunctionFstat(SMBCCTX *c, smbc_fstat_fn fn)
663 smbc_getFunctionStatVFS(SMBCCTX *c)
665 return c->internal->posix_emu.statvfs_fn;
669 smbc_setFunctionStatVFS(SMBCCTX *c, smbc_statvfs_fn fn)
671 c->internal->posix_emu.statvfs_fn = fn;
675 smbc_getFunctionFstatVFS(SMBCCTX *c)
677 return c->internal->posix_emu.fstatvfs_fn;
681 smbc_setFunctionFstatVFS(SMBCCTX *c, smbc_fstatvfs_fn fn)
683 c->internal->posix_emu.fstatvfs_fn = fn;
687 smbc_getFunctionFtruncate(SMBCCTX *c)
689 return c->internal->posix_emu.ftruncate_fn;
693 smbc_setFunctionFtruncate(SMBCCTX *c, smbc_ftruncate_fn fn)
695 c->internal->posix_emu.ftruncate_fn = fn;
699 smbc_getFunctionClose(SMBCCTX *c)
705 smbc_setFunctionClose(SMBCCTX *c, smbc_close_fn fn)
712 * Callable functions for directories.
716 smbc_getFunctionOpendir(SMBCCTX *c)
722 smbc_setFunctionOpendir(SMBCCTX *c, smbc_opendir_fn fn)
728 smbc_getFunctionClosedir(SMBCCTX *c)
734 smbc_setFunctionClosedir(SMBCCTX *c, smbc_closedir_fn fn)
740 smbc_getFunctionReaddir(SMBCCTX *c)
746 smbc_setFunctionReaddir(SMBCCTX *c, smbc_readdir_fn fn)
752 smbc_getFunctionGetdents(SMBCCTX *c)
758 smbc_setFunctionGetdents(SMBCCTX *c, smbc_getdents_fn fn)
764 smbc_getFunctionMkdir(SMBCCTX *c)
770 smbc_setFunctionMkdir(SMBCCTX *c, smbc_mkdir_fn fn)
776 smbc_getFunctionRmdir(SMBCCTX *c)
782 smbc_setFunctionRmdir(SMBCCTX *c, smbc_rmdir_fn fn)
788 smbc_getFunctionTelldir(SMBCCTX *c)
794 smbc_setFunctionTelldir(SMBCCTX *c, smbc_telldir_fn fn)
800 smbc_getFunctionLseekdir(SMBCCTX *c)
806 smbc_setFunctionLseekdir(SMBCCTX *c, smbc_lseekdir_fn fn)
812 smbc_getFunctionFstatdir(SMBCCTX *c)
818 smbc_setFunctionFstatdir(SMBCCTX *c, smbc_fstatdir_fn fn)
825 * Callable functions applicable to both files and directories.
829 smbc_getFunctionChmod(SMBCCTX *c)
835 smbc_setFunctionChmod(SMBCCTX *c, smbc_chmod_fn fn)
841 smbc_getFunctionUtimes(SMBCCTX *c)
847 smbc_setFunctionUtimes(SMBCCTX *c, smbc_utimes_fn fn)
853 smbc_getFunctionSetxattr(SMBCCTX *c)
859 smbc_setFunctionSetxattr(SMBCCTX *c, smbc_setxattr_fn fn)
865 smbc_getFunctionGetxattr(SMBCCTX *c)
871 smbc_setFunctionGetxattr(SMBCCTX *c, smbc_getxattr_fn fn)
877 smbc_getFunctionRemovexattr(SMBCCTX *c)
879 return c->removexattr;
883 smbc_setFunctionRemovexattr(SMBCCTX *c, smbc_removexattr_fn fn)
889 smbc_getFunctionListxattr(SMBCCTX *c)
895 smbc_setFunctionListxattr(SMBCCTX *c, smbc_listxattr_fn fn)
902 * Callable functions related to printing
906 smbc_getFunctionPrintFile(SMBCCTX *c)
908 return c->print_file;
912 smbc_setFunctionPrintFile(SMBCCTX *c, smbc_print_file_fn fn)
917 smbc_open_print_job_fn
918 smbc_getFunctionOpenPrintJob(SMBCCTX *c)
920 return c->open_print_job;
924 smbc_setFunctionOpenPrintJob(SMBCCTX *c,
925 smbc_open_print_job_fn fn)
927 c->open_print_job = fn;
930 smbc_list_print_jobs_fn
931 smbc_getFunctionListPrintJobs(SMBCCTX *c)
933 return c->list_print_jobs;
937 smbc_setFunctionListPrintJobs(SMBCCTX *c,
938 smbc_list_print_jobs_fn fn)
940 c->list_print_jobs = fn;
943 smbc_unlink_print_job_fn
944 smbc_getFunctionUnlinkPrintJob(SMBCCTX *c)
946 return c->unlink_print_job;
950 smbc_setFunctionUnlinkPrintJob(SMBCCTX *c,
951 smbc_unlink_print_job_fn fn)
953 c->unlink_print_job = fn;