Add the ability to parse out the port to SMBC_parse_path().
[Samba/vl.git] / source3 / include / libsmb_internal.h
blobbd9143892cd29a2cc7b73f3f7956879f619303b1
1 /*
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/>.
25 #include "includes.h"
28 #ifndef _LIBSMB_INTERNAL_H_
29 #define _LIBSMB_INTERNAL_H_
31 #include "../include/libsmbclient.h"
32 #include "libsmb/clirap.h"
34 #define SMBC_MAX_NAME 1023
35 #define SMBC_FILE_MODE (S_IFREG | 0444)
36 #define SMBC_DIR_MODE (S_IFDIR | 0555)
39 * DOS Attribute values (used internally)
41 typedef struct DOS_ATTR_DESC {
42 int mode;
43 off_t size;
44 time_t create_time;
45 time_t access_time;
46 time_t write_time;
47 time_t change_time;
48 SMB_INO_T inode;
49 } DOS_ATTR_DESC;
52 * Extension of libsmbclient.h's #defines
54 #define SMB_CTX_FLAG_USE_NT_HASH (1 << 4)
57 * Internal flags for extended attributes
60 /* internal mode values */
61 #define SMBC_XATTR_MODE_ADD 1
62 #define SMBC_XATTR_MODE_REMOVE 2
63 #define SMBC_XATTR_MODE_REMOVE_ALL 3
64 #define SMBC_XATTR_MODE_SET 4
65 #define SMBC_XATTR_MODE_CHOWN 5
66 #define SMBC_XATTR_MODE_CHGRP 6
68 #define CREATE_ACCESS_READ READ_CONTROL_ACCESS
70 /*We should test for this in configure ... */
71 #ifndef ENOTSUP
72 #define ENOTSUP EOPNOTSUPP
73 #endif
76 struct _SMBCSRV {
77 struct cli_state *cli;
78 dev_t dev;
79 bool no_pathinfo;
80 bool no_pathinfo2;
81 bool no_nt_session;
82 struct policy_handle pol;
84 SMBCSRV *next, *prev;
88 /*
89 * Keep directory entries in a list
91 struct smbc_dir_list {
92 struct smbc_dir_list *next;
93 struct smbc_dirent *dirent;
98 * Structure for open file management
99 */
100 struct _SMBCFILE {
101 int cli_fd;
102 char *fname;
103 off_t offset;
104 struct _SMBCSRV *srv;
105 bool file;
106 struct smbc_dir_list *dir_list, *dir_end, *dir_next;
107 int dir_type, dir_error;
109 SMBCFILE *next, *prev;
114 * Context structure
116 struct SMBC_internal_data {
118 /* True when this handle is initialized */
119 bool initialized;
121 /* dirent pointer location */
122 struct smbc_dirent dirent;
124 * Leave room for any urlencoded filename and the comment field.
126 * We use (NAME_MAX * 3) plus whatever the max length of a comment is,
127 * plus a couple of null terminators (one after the filename,
128 * one after the comment).
130 * According to <linux/limits.h>, NAME_MAX is 255. Is it longer
131 * anyplace else?
133 char _dirent_name[1024];
136 * server connection list
138 SMBCSRV * servers;
141 * open file/dir list
143 SMBCFILE * files;
146 * Support "Create Time" in get/set with the *xattr() functions, if
147 * true. This replaces the dos attribute strings C_TIME, A_TIME and
148 * M_TIME with CHANGE_TIME, ACCESS_TIME and WRITE_TIME, and adds
149 * CREATE_TIME. Default is FALSE, i.e. to use the old-style shorter
150 * names and to not support CREATE time, for backward compatibility.
152 bool full_time_names;
155 * The share mode of a file being opened. To match POSIX semantics
156 * (and maintain backward compatibility), DENY_NONE is the default.
158 smbc_share_mode share_mode;
161 * Authentication function which includes the context. This will be
162 * used if set; otherwise context->callbacks.auth_fn() will be used.
164 smbc_get_auth_data_with_context_fn auth_fn_with_context;
167 * An opaque (to this library) user data handle which can be set
168 * and retrieved with smbc_option_set() and smbc_option_get().
170 void * user_data;
173 * Should we attempt UNIX smb encryption ?
174 * Set to 0 if we should never attempt, set to 1 if
175 * encryption requested, set to 2 if encryption required.
177 smbc_smb_encrypt_level smb_encryption_level;
180 * Should we request case sensitivity of file names?
182 bool case_sensitive;
185 * Auth info needed for DFS traversal.
188 struct user_auth_info *auth_info;
190 struct smbc_server_cache * server_cache;
192 /* POSIX emulation functions */
193 struct
195 #if 0 /* Left in libsmbclient.h for backward compatibility */
196 smbc_open_fn open_fn;
197 smbc_creat_fn creat_fn;
198 smbc_read_fn read_fn;
199 smbc_write_fn write_fn;
200 smbc_unlink_fn unlink_fn;
201 smbc_rename_fn rename_fn;
202 smbc_lseek_fn lseek_fn;
203 smbc_stat_fn stat_fn;
204 smbc_fstat_fn fstat_fn;
205 #endif
206 smbc_statvfs_fn statvfs_fn;
207 smbc_fstatvfs_fn fstatvfs_fn;
208 smbc_ftruncate_fn ftruncate_fn;
209 #if 0 /* Left in libsmbclient.h for backward compatibility */
210 smbc_close_fn close_fn;
211 smbc_opendir_fn opendir_fn;
212 smbc_closedir_fn closedir_fn;
213 smbc_readdir_fn readdir_fn;
214 smbc_getdents_fn getdents_fn;
215 smbc_mkdir_fn mkdir_fn;
216 smbc_rmdir_fn rmdir_fn;
217 smbc_telldir_fn telldir_fn;
218 smbc_lseekdir_fn lseekdir_fn;
219 smbc_fstatdir_fn fstatdir_fn;
220 smbc_chmod_fn chmod_fn;
221 smbc_utimes_fn utimes_fn;
222 smbc_setxattr_fn setxattr_fn;
223 smbc_getxattr_fn getxattr_fn;
224 smbc_removexattr_fn removexattr_fn;
225 smbc_listxattr_fn listxattr_fn;
226 #endif
227 } posix_emu;
229 #if 0 /* Left in libsmbclient.h for backward compatibility */
230 /* Printing-related functions */
231 struct
233 smbc_print_file_fn print_file_fn;
234 smbc_open_print_job_fn open_print_job_fn;
235 smbc_list_print_jobs_fn list_print_jobs_fn;
236 smbc_unlink_print_job_fn unlink_print_job_fn;
237 } printing;
238 #endif
240 #if 0 /* None available yet */
241 /* SMB high-level functions */
242 struct
244 } smb;
246 #endif
249 /* Functions in libsmb_cache.c */
251 SMBC_add_cached_server(SMBCCTX * context,
252 SMBCSRV * newsrv,
253 const char * server,
254 const char * share,
255 const char * workgroup,
256 const char * username);
258 SMBCSRV *
259 SMBC_get_cached_server(SMBCCTX * context,
260 const char * server,
261 const char * share,
262 const char * workgroup,
263 const char * user);
266 SMBC_remove_cached_server(SMBCCTX * context,
267 SMBCSRV * server);
270 SMBC_purge_cached_servers(SMBCCTX * context);
273 /* Functions in libsmb_dir.c */
275 SMBC_check_options(char *server,
276 char *share,
277 char *path,
278 char *options);
280 SMBCFILE *
281 SMBC_opendir_ctx(SMBCCTX *context,
282 const char *fname);
285 SMBC_closedir_ctx(SMBCCTX *context,
286 SMBCFILE *dir);
288 struct smbc_dirent *
289 SMBC_readdir_ctx(SMBCCTX *context,
290 SMBCFILE *dir);
293 SMBC_getdents_ctx(SMBCCTX *context,
294 SMBCFILE *dir,
295 struct smbc_dirent *dirp,
296 int count);
299 SMBC_mkdir_ctx(SMBCCTX *context,
300 const char *fname,
301 mode_t mode);
304 SMBC_rmdir_ctx(SMBCCTX *context,
305 const char *fname);
307 off_t
308 SMBC_telldir_ctx(SMBCCTX *context,
309 SMBCFILE *dir);
312 SMBC_lseekdir_ctx(SMBCCTX *context,
313 SMBCFILE *dir,
314 off_t offset);
317 SMBC_fstatdir_ctx(SMBCCTX *context,
318 SMBCFILE *dir,
319 struct stat *st);
322 SMBC_chmod_ctx(SMBCCTX *context,
323 const char *fname,
324 mode_t newmode);
327 SMBC_utimes_ctx(SMBCCTX *context,
328 const char *fname,
329 struct timeval *tbuf);
332 SMBC_unlink_ctx(SMBCCTX *context,
333 const char *fname);
336 SMBC_rename_ctx(SMBCCTX *ocontext,
337 const char *oname,
338 SMBCCTX *ncontext,
339 const char *nname);
342 /* Functions in libsmb_file.c */
343 SMBCFILE *
344 SMBC_open_ctx(SMBCCTX *context,
345 const char *fname,
346 int flags,
347 mode_t mode);
349 SMBCFILE *
350 SMBC_creat_ctx(SMBCCTX *context,
351 const char *path,
352 mode_t mode);
354 ssize_t
355 SMBC_read_ctx(SMBCCTX *context,
356 SMBCFILE *file,
357 void *buf,
358 size_t count);
360 ssize_t
361 SMBC_write_ctx(SMBCCTX *context,
362 SMBCFILE *file,
363 const void *buf,
364 size_t count);
367 SMBC_close_ctx(SMBCCTX *context,
368 SMBCFILE *file);
370 bool
371 SMBC_getatr(SMBCCTX * context,
372 SMBCSRV *srv,
373 const char *path,
374 uint16 *mode,
375 off_t *size,
376 struct timespec *create_time_ts,
377 struct timespec *access_time_ts,
378 struct timespec *write_time_ts,
379 struct timespec *change_time_ts,
380 SMB_INO_T *ino);
382 bool
383 SMBC_setatr(SMBCCTX * context, SMBCSRV *srv, char *path,
384 time_t create_time,
385 time_t access_time,
386 time_t write_time,
387 time_t change_time,
388 uint16 mode);
390 off_t
391 SMBC_lseek_ctx(SMBCCTX *context,
392 SMBCFILE *file,
393 off_t offset,
394 int whence);
397 SMBC_ftruncate_ctx(SMBCCTX *context,
398 SMBCFILE *file,
399 off_t length);
402 /* Functions in libsmb_misc.c */
404 SMBC_dlist_contains(SMBCFILE * list, SMBCFILE *p);
407 SMBC_errno(SMBCCTX *context,
408 struct cli_state *c);
411 /* Functions in libsmb_path.c */
413 SMBC_parse_path(TALLOC_CTX *ctx,
414 SMBCCTX *context,
415 const char *fname,
416 char **pp_workgroup,
417 char **pp_server,
418 uint16_t *p_port,
419 char **pp_share,
420 char **pp_path,
421 char **pp_user,
422 char **pp_password,
423 char **pp_options);
426 /* Functions in libsmb_printjob.c */
427 SMBCFILE *
428 SMBC_open_print_job_ctx(SMBCCTX *context,
429 const char *fname);
432 SMBC_print_file_ctx(SMBCCTX *c_file,
433 const char *fname,
434 SMBCCTX *c_print,
435 const char *printq);
438 SMBC_list_print_jobs_ctx(SMBCCTX *context,
439 const char *fname,
440 smbc_list_print_job_fn fn);
443 SMBC_unlink_print_job_ctx(SMBCCTX *context,
444 const char *fname,
445 int id);
448 /* Functions in libsmb_server.c */
450 SMBC_check_server(SMBCCTX * context,
451 SMBCSRV * server);
454 SMBC_remove_unused_server(SMBCCTX * context,
455 SMBCSRV * srv);
457 void
458 SMBC_get_auth_data(const char *server, const char *share,
459 char *workgroup_buf, int workgroup_buf_len,
460 char *username_buf, int username_buf_len,
461 char *password_buf, int password_buf_len);
463 SMBCSRV *
464 SMBC_find_server(TALLOC_CTX *ctx,
465 SMBCCTX *context,
466 const char *server,
467 const char *share,
468 char **pp_workgroup,
469 char **pp_username,
470 char **pp_password);
472 SMBCSRV *
473 SMBC_server(TALLOC_CTX *ctx,
474 SMBCCTX *context,
475 bool connect_if_not_found,
476 const char *server,
477 const char *share,
478 char **pp_workgroup,
479 char **pp_username,
480 char **pp_password);
482 SMBCSRV *
483 SMBC_attr_server(TALLOC_CTX *ctx,
484 SMBCCTX *context,
485 const char *server,
486 const char *share,
487 char **pp_workgroup,
488 char **pp_username,
489 char **pp_password);
492 /* Functions in libsmb_stat.c */
494 SMBC_stat_ctx(SMBCCTX *context,
495 const char *fname,
496 struct stat *st);
499 SMBC_fstat_ctx(SMBCCTX *context,
500 SMBCFILE *file,
501 struct stat *st);
505 SMBC_statvfs_ctx(SMBCCTX *context,
506 char *path,
507 struct statvfs *st);
511 SMBC_fstatvfs_ctx(SMBCCTX *context,
512 SMBCFILE *file,
513 struct statvfs *st);
516 /* Functions in libsmb_xattr.c */
518 SMBC_setxattr_ctx(SMBCCTX *context,
519 const char *fname,
520 const char *name,
521 const void *value,
522 size_t size,
523 int flags);
526 SMBC_getxattr_ctx(SMBCCTX *context,
527 const char *fname,
528 const char *name,
529 const void *value,
530 size_t size);
533 SMBC_removexattr_ctx(SMBCCTX *context,
534 const char *fname,
535 const char *name);
538 SMBC_listxattr_ctx(SMBCCTX *context,
539 const char *fname,
540 char *list,
541 size_t size);
544 #endif