source3/include/libsmb_internal.h

   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
  10
  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.
  15
  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.
  20
  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/>.
  23 */
  24
  25 #include "includes.h"
  26
  27
  28 #ifndef _LIBSMB_INTERNAL_H_
  29 #define _LIBSMB_INTERNAL_H_
  30
  31 #include "../include/libsmbclient.h"
  32
  33 #define SMBC_MAX_NAME  1023
  34 #define SMBC_FILE_MODE (S_IFREG | 0444)
  35 #define SMBC_DIR_MODE  (S_IFDIR | 0555)
  36
  37 /*
  38  * DOS Attribute values (used internally)
  39  */
  40 typedef struct DOS_ATTR_DESC {
  41         int mode;
  42         SMB_OFF_T size;
  43         time_t create_time;
  44         time_t access_time;
  45         time_t write_time;
  46         time_t change_time;
  47         SMB_INO_T inode;
  48 } DOS_ATTR_DESC;
  49
  50
  51 /*
  52  * Internal flags for extended attributes
  53  */
  54
  55 /* internal mode values */
  56 #define SMBC_XATTR_MODE_ADD          1
  57 #define SMBC_XATTR_MODE_REMOVE       2
  58 #define SMBC_XATTR_MODE_REMOVE_ALL   3
  59 #define SMBC_XATTR_MODE_SET          4
  60 #define SMBC_XATTR_MODE_CHOWN        5
  61 #define SMBC_XATTR_MODE_CHGRP        6
  62
  63 #define CREATE_ACCESS_READ      READ_CONTROL_ACCESS
  64
  65 /*We should test for this in configure ... */
  66 #ifndef ENOTSUP
  67 #define ENOTSUP EOPNOTSUPP
  68 #endif
  69
  70
  71 struct _SMBCSRV {
  72         struct cli_state *cli;
  73         dev_t dev;
  74         bool no_pathinfo;
  75         bool no_pathinfo2;
  76         bool no_nt_session;
  77         POLICY_HND pol;
  78
  79         SMBCSRV *next, *prev;
  80
  81 };
  82
  83 /*
  84  * Keep directory entries in a list
  85  */
  86 struct smbc_dir_list {
  87         struct smbc_dir_list *next;
  88         struct smbc_dirent *dirent;
  89 };
  90
  91
  92 /*
  93  * Structure for open file management
  94  */
  95 struct _SMBCFILE {
  96         int cli_fd;
  97         char *fname;
  98         SMB_OFF_T offset;
  99         struct _SMBCSRV *srv;
 100         bool file;
 101         struct smbc_dir_list *dir_list, *dir_end, *dir_next;
 102         int dir_type, dir_error;
 103
 104         SMBCFILE *next, *prev;
 105 };
 106
 107
 108 /*
 109  * Context structure
 110  */
 111 struct SMBC_internal_data {
 112
 113         /* True when this handle is initialized */
 114         bool                                    initialized;
 115
 116         /* dirent pointer location */
 117         struct smbc_dirent                      dirent;
 118         /*
 119          * Leave room for any urlencoded filename and the comment field.
 120          *
 121          * We use (NAME_MAX * 3) plus whatever the max length of a comment is,
 122          * plus a couple of null terminators (one after the filename,
 123          * one after the comment).
 124          *
 125          * According to <linux/limits.h>, NAME_MAX is 255.  Is it longer
 126          * anyplace else?
 127          */
 128         char                                    _dirent_name[1024];
 129
 130         /*
 131          * server connection list
 132          */
 133         SMBCSRV *                               servers;
 134
 135         /*
 136          * open file/dir list
 137          */
 138         SMBCFILE *                              files;
 139
 140         /*
 141          * Log to standard error instead of the more typical standard output
 142          */
 143         bool                                    debug_stderr;
 144
 145         /*
 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.
 151          */
 152         bool                                    full_time_names;
 153
 154         /*
 155          * The share mode of a file being opened.  To match POSIX semantics
 156          * (and maintain backward compatibility), DENY_NONE is the default.
 157          */
 158         smbc_share_mode                         share_mode;
 159
 160         /*
 161          * Authentication function which includes the context.  This will be
 162          * used if set; otherwise context->callbacks.auth_fn() will be used.
 163          */
 164         smbc_get_auth_data_with_context_fn      auth_fn_with_context;
 165
 166         /*
 167          * An opaque (to this library) user data handle which can be set
 168          * and retrieved with smbc_option_set() and smbc_option_get().
 169          */
 170         void *                                  user_data;
 171
 172         /*
 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.
 176          */
 177         smbc_smb_encrypt_level                  smb_encryption_level;
 178
 179         /*
 180          * Should we request case sensitivity of file names?
 181          */
 182         bool                                    case_sensitive;
 183
 184         struct smbc_server_cache * server_cache;
 185
 186         /* POSIX emulation functions */
 187         struct
 188         {
 189 #if 0 /* Left in libsmbclient.h for backward compatibility */
 190                 smbc_open_fn                    open_fn;
 191                 smbc_creat_fn                   creat_fn;
 192                 smbc_read_fn                    read_fn;
 193                 smbc_write_fn                   write_fn;
 194                 smbc_unlink_fn                  unlink_fn;
 195                 smbc_rename_fn                  rename_fn;
 196                 smbc_lseek_fn                   lseek_fn;
 197                 smbc_stat_fn                    stat_fn;
 198                 smbc_fstat_fn                   fstat_fn;
 199 #endif
 200                 smbc_ftruncate_fn               ftruncate_fn;
 201 #if 0 /* Left in libsmbclient.h for backward compatibility */
 202                 smbc_close_fn                   close_fn;
 203                 smbc_opendir_fn                 opendir_fn;
 204                 smbc_closedir_fn                closedir_fn;
 205                 smbc_readdir_fn                 readdir_fn;
 206                 smbc_getdents_fn                getdents_fn;
 207                 smbc_mkdir_fn                   mkdir_fn;
 208                 smbc_rmdir_fn                   rmdir_fn;
 209                 smbc_telldir_fn                 telldir_fn;
 210                 smbc_lseekdir_fn                lseekdir_fn;
 211                 smbc_fstatdir_fn                fstatdir_fn;
 212                 smbc_chmod_fn                   chmod_fn;
 213                 smbc_utimes_fn                  utimes_fn;
 214                 smbc_setxattr_fn                setxattr_fn;
 215                 smbc_getxattr_fn                getxattr_fn;
 216                 smbc_removexattr_fn             removexattr_fn;
 217                 smbc_listxattr_fn               listxattr_fn;
 218 #endif
 219         }               posix_emu;
 220
 221 #if 0 /* Left in libsmbclient.h for backward compatibility */
 222         /* Printing-related functions */
 223         struct
 224         {
 225                 smbc_print_file_fn              print_file_fn;
 226                 smbc_open_print_job_fn          open_print_job_fn;
 227                 smbc_list_print_jobs_fn         list_print_jobs_fn;
 228                 smbc_unlink_print_job_fn        unlink_print_job_fn;
 229         }               printing;
 230 #endif
 231
 232 #if 0 /* None available yet */
 233         /* SMB high-level functions */
 234         struct
 235         {
 236         }               smb;
 237
 238 #endif
 239 };
 240
 241 /* Functions in libsmb_cache.c */
 242 int
 243 SMBC_add_cached_server(SMBCCTX * context,
 244                        SMBCSRV * newsrv,
 245                        const char * server,
 246                        const char * share,
 247                        const char * workgroup,
 248                        const char * username);
 249
 250 SMBCSRV *
 251 SMBC_get_cached_server(SMBCCTX * context,
 252                        const char * server,
 253                        const char * share,
 254                        const char * workgroup,
 255                        const char * user);
 256
 257 int
 258 SMBC_remove_cached_server(SMBCCTX * context,
 259                           SMBCSRV * server);
 260
 261 int
 262 SMBC_purge_cached_servers(SMBCCTX * context);
 263
 264
 265 /* Functions in libsmb_dir.c */
 266 int
 267 SMBC_check_options(char *server,
 268                    char *share,
 269                    char *path,
 270                    char *options);
 271
 272 SMBCFILE *
 273 SMBC_opendir_ctx(SMBCCTX *context,
 274                  const char *fname);
 275
 276 int
 277 SMBC_closedir_ctx(SMBCCTX *context,
 278                   SMBCFILE *dir);
 279
 280 struct smbc_dirent *
 281 SMBC_readdir_ctx(SMBCCTX *context,
 282                  SMBCFILE *dir);
 283
 284 int
 285 SMBC_getdents_ctx(SMBCCTX *context,
 286                   SMBCFILE *dir,
 287                   struct smbc_dirent *dirp,
 288                   int count);
 289
 290 int
 291 SMBC_mkdir_ctx(SMBCCTX *context,
 292                const char *fname,
 293                mode_t mode);
 294
 295 int
 296 SMBC_rmdir_ctx(SMBCCTX *context,
 297                const char *fname);
 298
 299 off_t
 300 SMBC_telldir_ctx(SMBCCTX *context,
 301                  SMBCFILE *dir);
 302
 303 int
 304 SMBC_lseekdir_ctx(SMBCCTX *context,
 305                   SMBCFILE *dir,
 306                   off_t offset);
 307
 308 int
 309 SMBC_fstatdir_ctx(SMBCCTX *context,
 310                   SMBCFILE *dir,
 311                   struct stat *st);
 312
 313 int
 314 SMBC_chmod_ctx(SMBCCTX *context,
 315                const char *fname,
 316                mode_t newmode);
 317
 318 int
 319 SMBC_utimes_ctx(SMBCCTX *context,
 320                 const char *fname,
 321                 struct timeval *tbuf);
 322
 323 int
 324 SMBC_unlink_ctx(SMBCCTX *context,
 325                 const char *fname);
 326
 327 int
 328 SMBC_rename_ctx(SMBCCTX *ocontext,
 329                 const char *oname,
 330                 SMBCCTX *ncontext,
 331                 const char *nname);
 332
 333
 334 /* Functions in libsmb_file.c */
 335 SMBCFILE *
 336 SMBC_open_ctx(SMBCCTX *context,
 337               const char *fname,
 338               int flags,
 339               mode_t mode);
 340
 341 SMBCFILE *
 342 SMBC_creat_ctx(SMBCCTX *context,
 343                const char *path,
 344                mode_t mode);
 345
 346 ssize_t
 347 SMBC_read_ctx(SMBCCTX *context,
 348               SMBCFILE *file,
 349               void *buf,
 350               size_t count);
 351
 352 ssize_t
 353 SMBC_write_ctx(SMBCCTX *context,
 354                SMBCFILE *file,
 355                const void *buf,
 356                size_t count);
 357
 358 int
 359 SMBC_close_ctx(SMBCCTX *context,
 360                SMBCFILE *file);
 361
 362 bool
 363 SMBC_getatr(SMBCCTX * context,
 364             SMBCSRV *srv,
 365             char *path,
 366             uint16 *mode,
 367             SMB_OFF_T *size,
 368             struct timespec *create_time_ts,
 369             struct timespec *access_time_ts,
 370             struct timespec *write_time_ts,
 371             struct timespec *change_time_ts,
 372             SMB_INO_T *ino);
 373
 374 bool
 375 SMBC_setatr(SMBCCTX * context, SMBCSRV *srv, char *path,
 376             time_t create_time,
 377             time_t access_time,
 378             time_t write_time,
 379             time_t change_time,
 380             uint16 mode);
 381
 382 off_t
 383 SMBC_lseek_ctx(SMBCCTX *context,
 384                SMBCFILE *file,
 385                off_t offset,
 386                int whence);
 387
 388 int
 389 SMBC_ftruncate_ctx(SMBCCTX *context,
 390                    SMBCFILE *file,
 391                    off_t length);
 392
 393
 394 /* Functions in libsmb_misc.c */
 395 int
 396 SMBC_dlist_contains(SMBCFILE * list, SMBCFILE *p);
 397
 398 int
 399 SMBC_errno(SMBCCTX *context,
 400            struct cli_state *c);
 401
 402
 403 /* Functions in libsmb_path.c */
 404 int
 405 SMBC_urldecode(char *dest,
 406                char *src,
 407                size_t max_dest_len);
 408
 409 int
 410 SMBC_urlencode(char *dest,
 411                char *src,
 412                int max_dest_len);
 413
 414 int
 415 SMBC_parse_path(TALLOC_CTX *ctx,
 416                 SMBCCTX *context,
 417                 const char *fname,
 418                 char **pp_workgroup,
 419                 char **pp_server,
 420                 char **pp_share,
 421                 char **pp_path,
 422                 char **pp_user,
 423                 char **pp_password,
 424                 char **pp_options);
 425
 426
 427 /* Functions in libsmb_printjob.c */
 428 SMBCFILE *
 429 SMBC_open_print_job_ctx(SMBCCTX *context,
 430                         const char *fname);
 431
 432 int
 433 SMBC_print_file_ctx(SMBCCTX *c_file,
 434                     const char *fname,
 435                     SMBCCTX *c_print,
 436                     const char *printq);
 437
 438 int
 439 SMBC_list_print_jobs_ctx(SMBCCTX *context,
 440                          const char *fname,
 441                          smbc_list_print_job_fn fn);
 442
 443 int
 444 SMBC_unlink_print_job_ctx(SMBCCTX *context,
 445                           const char *fname,
 446                           int id);
 447
 448
 449 /* Functions in libsmb_server.c */
 450 int
 451 SMBC_check_server(SMBCCTX * context,
 452                   SMBCSRV * server);
 453
 454 int
 455 SMBC_remove_unused_server(SMBCCTX * context,
 456                           SMBCSRV * srv);
 457
 458 void
 459 SMBC_call_auth_fn(TALLOC_CTX *ctx,
 460                   SMBCCTX *context,
 461                   const char *server,
 462                   const char *share,
 463                   char **pp_workgroup,
 464                   char **pp_username,
 465                   char **pp_password);
 466
 467 void
 468 SMBC_get_auth_data(const char *server, const char *share,
 469                    char *workgroup_buf, int workgroup_buf_len,
 470                    char *username_buf, int username_buf_len,
 471                    char *password_buf, int password_buf_len);
 472
 473 SMBCSRV *
 474 SMBC_find_server(TALLOC_CTX *ctx,
 475                  SMBCCTX *context,
 476                  const char *server,
 477                  const char *share,
 478                  char **pp_workgroup,
 479                  char **pp_username,
 480                  char **pp_password);
 481
 482 SMBCSRV *
 483 SMBC_server(TALLOC_CTX *ctx,
 484             SMBCCTX *context,
 485             bool connect_if_not_found,
 486             const char *server,
 487             const char *share,
 488             char **pp_workgroup,
 489             char **pp_username,
 490             char **pp_password);
 491
 492 SMBCSRV *
 493 SMBC_attr_server(TALLOC_CTX *ctx,
 494                  SMBCCTX *context,
 495                  const char *server,
 496                  const char *share,
 497                  char **pp_workgroup,
 498                  char **pp_username,
 499                  char **pp_password);
 500
 501
 502 /* Functions in libsmb_stat.c */
 503 int
 504 SMBC_stat_ctx(SMBCCTX *context,
 505               const char *fname,
 506               struct stat *st);
 507
 508 int
 509 SMBC_fstat_ctx(SMBCCTX *context,
 510                SMBCFILE *file,
 511                struct stat *st);
 512
 513
 514 /* Functions in libsmb_xattr.c */
 515 int
 516 SMBC_setxattr_ctx(SMBCCTX *context,
 517                   const char *fname,
 518                   const char *name,
 519                   const void *value,
 520                   size_t size,
 521                   int flags);
 522
 523 int
 524 SMBC_getxattr_ctx(SMBCCTX *context,
 525                   const char *fname,
 526                   const char *name,
 527                   const void *value,
 528                   size_t size);
 529
 530 int
 531 SMBC_removexattr_ctx(SMBCCTX *context,
 532                      const char *fname,
 533                      const char *name);
 534
 535 int
 536 SMBC_listxattr_ctx(SMBCCTX *context,
 537                    const char *fname,
 538                    char *list,
 539                    size_t size);
 540
 541
 542 #endif