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