source3/libsmb/smb_share_modes.c

   1 /*
   2    Samba share mode database library external interface library.
   3    Used by non-Samba products needing access to the Samba share mode db.
   4
   5    Copyright (C) Jeremy Allison 2005 - 2006
   6
   7    sharemodes_procid functions (C) Copyright (C) Volker Lendecke 2005
   8
   9      ** NOTE! The following LGPL license applies to this module only.
  10      ** This does NOT imply that all of Samba is released
  11      ** under the LGPL
  12
  13    This library is free software; you can redistribute it and/or
  14    modify it under the terms of the GNU Lesser General Public
  15    License as published by the Free Software Foundation; either
  16    version 2 of the License, or (at your option) any later version.
  17
  18    This library is distributed in the hope that it will be useful,
  19    but WITHOUT ANY WARRANTY; without even the implied warranty of
  20    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21    Lesser General Public License for more details.
  22
  23    You should have received a copy of the GNU Lesser General Public
  24    License along with this library; if not, write to the Free Software
  25    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  26 */
  27
  28 #include "includes.h"
  29 #include "smb_share_modes.h"
  30
  31 /* Remove the paranoid malloc checker. */
  32 #ifdef malloc
  33 #undef malloc
  34 #endif
  35
  36 int smb_create_share_mode_entry_ex(struct smbdb_ctx *db_ctx, uint64_t dev,
  37                                 uint64_t ino, const struct smb_share_mode_entry *new_entry,
  38                                 const char *sharepath, const char *filename);
  39
  40 static BOOL sharemodes_procid_equal(const struct process_id *p1, const struct process_id *p2)
  41 {
  42         return (p1->pid == p2->pid);
  43 }
  44
  45 static pid_t sharemodes_procid_to_pid(const struct process_id *proc)
  46 {
  47         return proc->pid;
  48 }
  49
  50 /*
  51  * open/close sharemode database.
  52  */
  53
  54 struct smbdb_ctx *smb_share_mode_db_open(const char *db_path)
  55 {
  56         struct smbdb_ctx *smb_db = (struct smbdb_ctx *)malloc(sizeof(struct smbdb_ctx));
  57
  58         if (!smb_db) {
  59                 return NULL;
  60         }
  61
  62         memset(smb_db, '\0', sizeof(struct smbdb_ctx));
  63
  64         smb_db->smb_tdb = tdb_open(db_path,
  65                                 0, TDB_DEFAULT|TDB_CLEAR_IF_FIRST,
  66                                 O_RDWR|O_CREAT,
  67                                 0644);
  68
  69         if (!smb_db->smb_tdb) {
  70                 free(smb_db);
  71                 return NULL;
  72         }
  73
  74         /* Should check that this is the correct version.... */
  75         return smb_db;
  76 }
  77
  78 /* key and data records in the tdb locking database */
  79 struct locking_key {
  80         SMB_DEV_T dev;
  81         SMB_INO_T inode;
  82 };
  83
  84 int smb_share_mode_db_close(struct smbdb_ctx *db_ctx)
  85 {
  86         int ret = tdb_close(db_ctx->smb_tdb);
  87         free(db_ctx);
  88         return ret;
  89 }
  90
  91 static TDB_DATA get_locking_key(uint64_t dev, uint64_t ino)
  92 {
  93         static struct locking_key lk;
  94         TDB_DATA ld;
  95
  96         memset(&lk, '\0', sizeof(struct locking_key));
  97         lk.dev = (SMB_DEV_T)dev;
  98         lk.inode = (SMB_INO_T)ino;
  99         ld.dptr = (char *)&lk;
 100         ld.dsize = sizeof(lk);
 101         return ld;
 102 }
 103
 104 /*
 105  * lock/unlock entry in sharemode database.
 106  */
 107
 108 int smb_lock_share_mode_entry(struct smbdb_ctx *db_ctx,
 109                                 uint64_t dev,
 110                                 uint64_t ino)
 111 {
 112         return tdb_chainlock(db_ctx->smb_tdb, get_locking_key(dev, ino));
 113 }
 114
 115 int smb_unlock_share_mode_entry(struct smbdb_ctx *db_ctx,
 116                                 uint64_t dev,
 117                                 uint64_t ino)
 118 {
 119         return tdb_chainunlock(db_ctx->smb_tdb, get_locking_key(dev, ino));
 120 }
 121
 122 /*
 123  * Check if an external smb_share_mode_entry and an internal share_mode entry match.
 124  */
 125
 126 static int share_mode_entry_equal(const struct smb_share_mode_entry *e_entry,
 127                                 const struct share_mode_entry *entry)
 128 {
 129         return (sharemodes_procid_equal(&e_entry->pid, &entry->pid) &&
 130                 e_entry->file_id == (uint32_t)entry->share_file_id &&
 131                 e_entry->open_time.tv_sec == entry->time.tv_sec &&
 132                 e_entry->open_time.tv_usec == entry->time.tv_usec &&
 133                 e_entry->share_access == (uint32_t)entry->share_access &&
 134                 e_entry->access_mask == (uint32_t)entry->access_mask &&
 135                 e_entry->dev == (uint64_t)entry->dev &&
 136                 e_entry->ino == (uint64_t)entry->inode);
 137 }
 138
 139 /*
 140  * Create an internal Samba share_mode entry from an external smb_share_mode_entry.
 141  */
 142
 143 static void create_share_mode_entry(struct share_mode_entry *out,
 144                                 const struct smb_share_mode_entry *in)
 145 {
 146         memset(out, '\0', sizeof(struct share_mode_entry));
 147
 148         out->pid = in->pid;
 149         out->share_file_id = (unsigned long)in->file_id;
 150         out->time.tv_sec = in->open_time.tv_sec;
 151         out->time.tv_usec = in->open_time.tv_usec;
 152         out->share_access = in->share_access;
 153         out->access_mask = in->access_mask;
 154         out->dev = (SMB_DEV_T)in->dev;
 155         out->inode = (SMB_INO_T)in->ino;
 156         out->uid = (uint32)geteuid();
 157         out->flags = 0;
 158 }
 159
 160 /*
 161  * Return the current share mode list for an open file.
 162  * This uses similar (but simplified) logic to locking/locking.c
 163  */
 164
 165 int smb_get_share_mode_entries(struct smbdb_ctx *db_ctx,
 166                                 uint64_t dev,
 167                                 uint64_t ino,
 168                                 struct smb_share_mode_entry **pp_list,
 169                                 unsigned char *p_delete_on_close)
 170 {
 171         TDB_DATA db_data;
 172         struct smb_share_mode_entry *list = NULL;
 173         int num_share_modes = 0;
 174         struct locking_data *ld = NULL; /* internal samba db state. */
 175         struct share_mode_entry *shares = NULL;
 176         size_t i;
 177         int list_num;
 178
 179         *pp_list = NULL;
 180         *p_delete_on_close = 0;
 181
 182         db_data = tdb_fetch(db_ctx->smb_tdb, get_locking_key(dev, ino));
 183         if (!db_data.dptr) {
 184                 return 0;
 185         }
 186
 187         ld = (struct locking_data *)db_data.dptr;
 188         num_share_modes = ld->u.s.num_share_mode_entries;
 189
 190         if (!num_share_modes) {
 191                 free(db_data.dptr);
 192                 return 0;
 193         }
 194
 195         list = (struct smb_share_mode_entry *)malloc(sizeof(struct smb_share_mode_entry)*num_share_modes);
 196         if (!list) {
 197                 free(db_data.dptr);
 198                 return -1;
 199         }
 200
 201         memset(list, '\0', num_share_modes * sizeof(struct smb_share_mode_entry));
 202
 203         shares = (struct share_mode_entry *)(db_data.dptr + sizeof(struct share_mode_entry));
 204
 205         list_num = 0;
 206         for (i = 0; i < num_share_modes; i++) {
 207                 struct share_mode_entry *share = &shares[i];
 208                 struct smb_share_mode_entry *sme = &list[list_num];
 209                 struct process_id pid = share->pid;
 210
 211                 /* Check this process really exists. */
 212                 if (kill(sharemodes_procid_to_pid(&pid), 0) == -1 && (errno == ESRCH)) {
 213                         continue; /* No longer exists. */
 214                 }
 215
 216                 /* Ignore deferred open entries. */
 217                 if (share->op_type == DEFERRED_OPEN_ENTRY) {
 218                         continue;
 219                 }
 220
 221                 /* Copy into the external list. */
 222                 sme->dev = (uint64_t)share->dev;
 223                 sme->ino = (uint64_t)share->inode;
 224                 sme->share_access = (uint32_t)share->share_access;
 225                 sme->access_mask = (uint32_t)share->access_mask;
 226                 sme->open_time.tv_sec = share->time.tv_sec;
 227                 sme->open_time.tv_usec = share->time.tv_usec;
 228                 sme->file_id = (uint32_t)share->share_file_id;
 229                 sme->pid = share->pid;
 230                 list_num++;
 231         }
 232
 233         if (list_num == 0) {
 234                 free(db_data.dptr);
 235                 free(list);
 236                 return 0;
 237         }
 238
 239         *p_delete_on_close = ld->u.s.delete_on_close;
 240         *pp_list = list;
 241         free(db_data.dptr);
 242         return list_num;
 243 }
 244
 245 /*
 246  * Create an entry in the Samba share mode db.
 247  */
 248
 249 int smb_create_share_mode_entry_ex(struct smbdb_ctx *db_ctx,
 250                                 uint64_t dev,
 251                                 uint64_t ino,
 252                                 const struct smb_share_mode_entry *new_entry,
 253                                 const char *sharepath, /* Must be absolute utf8 path. */
 254                                 const char *filename) /* Must be relative utf8 path. */
 255 {
 256         TDB_DATA db_data;
 257         TDB_DATA locking_key =  get_locking_key(dev, ino);
 258         int orig_num_share_modes = 0;
 259         struct locking_data *ld = NULL; /* internal samba db state. */
 260         struct share_mode_entry *shares = NULL;
 261         char *new_data_p = NULL;
 262         size_t new_data_size = 0;
 263
 264         db_data = tdb_fetch(db_ctx->smb_tdb, locking_key);
 265         if (!db_data.dptr) {
 266                 /* We must create the entry. */
 267                 db_data.dptr = (char *)malloc(
 268                         (2*sizeof(struct share_mode_entry)) +
 269                         strlen(sharepath) + 1 +
 270                         strlen(filename) + 1);
 271                 if (!db_data.dptr) {
 272                         return -1;
 273                 }
 274                 ld = (struct locking_data *)db_data.dptr;
 275                 memset(ld, '\0', sizeof(struct locking_data));
 276                 ld->u.s.num_share_mode_entries = 1;
 277                 ld->u.s.delete_on_close = 0;
 278                 ld->u.s.delete_token_size = 0;
 279                 shares = (struct share_mode_entry *)(db_data.dptr + sizeof(struct share_mode_entry));
 280                 create_share_mode_entry(shares, new_entry);
 281
 282                 memcpy(db_data.dptr + 2*sizeof(struct share_mode_entry),
 283                         sharepath,
 284                         strlen(sharepath) + 1);
 285                 memcpy(db_data.dptr + 2*sizeof(struct share_mode_entry) +
 286                         strlen(sharepath) + 1,
 287                         filename,
 288                         strlen(filename) + 1);
 289
 290                 db_data.dsize = 2*sizeof(struct share_mode_entry) +
 291                                         strlen(sharepath) + 1 +
 292                                         strlen(filename) + 1;
 293                 if (tdb_store(db_ctx->smb_tdb, locking_key, db_data, TDB_INSERT) == -1) {
 294                         free(db_data.dptr);
 295                         return -1;
 296                 }
 297                 free(db_data.dptr);
 298                 return 0;
 299         }
 300
 301         /* Entry exists, we must add a new entry. */
 302         new_data_p = (char *)malloc(
 303                 db_data.dsize + sizeof(struct share_mode_entry));
 304         if (!new_data_p) {
 305                 free(db_data.dptr);
 306                 return -1;
 307         }
 308
 309         ld = (struct locking_data *)db_data.dptr;
 310         orig_num_share_modes = ld->u.s.num_share_mode_entries;
 311
 312         /* Copy the original data. */
 313         memcpy(new_data_p, db_data.dptr, (orig_num_share_modes+1)*sizeof(struct share_mode_entry));
 314
 315         /* Add in the new share mode */
 316         shares = (struct share_mode_entry *)(new_data_p +
 317                         ((orig_num_share_modes+1)*sizeof(struct share_mode_entry)));
 318
 319         create_share_mode_entry(shares, new_entry);
 320
 321         ld = (struct locking_data *)new_data_p;
 322         ld->u.s.num_share_mode_entries++;
 323
 324         /* Append the original delete_token and filenames. */
 325         memcpy(new_data_p + ((ld->u.s.num_share_mode_entries+1)*sizeof(struct share_mode_entry)),
 326                 db_data.dptr + ((orig_num_share_modes+1)*sizeof(struct share_mode_entry)),
 327                 db_data.dsize - ((orig_num_share_modes+1) * sizeof(struct share_mode_entry)));
 328
 329         new_data_size = db_data.dsize + sizeof(struct share_mode_entry);
 330
 331         free(db_data.dptr);
 332
 333         db_data.dptr = new_data_p;
 334         db_data.dsize = new_data_size;
 335
 336         if (tdb_store(db_ctx->smb_tdb, locking_key, db_data, TDB_REPLACE) == -1) {
 337                 free(db_data.dptr);
 338                 return -1;
 339         }
 340         free(db_data.dptr);
 341         return 0;
 342 }
 343
 344 /*
 345  * Create an entry in the Samba share mode db. Original interface - doesn't
 346  * Distinguish between share path and filename. Fudge this by using a
 347  * sharepath of / and a relative filename of (filename+1).
 348  */
 349
 350 int smb_create_share_mode_entry(struct smbdb_ctx *db_ctx,
 351                                 uint64_t dev,
 352                                 uint64_t ino,
 353                                 const struct smb_share_mode_entry *new_entry,
 354                                 const char *filename) /* Must be absolute utf8 path. */
 355 {
 356         if (*filename != '/') {
 357                 abort();
 358         }
 359         return smb_create_share_mode_entry_ex(db_ctx, dev, ino, new_entry,
 360                                                 "/", &filename[1]);
 361 }
 362
 363 int smb_delete_share_mode_entry(struct smbdb_ctx *db_ctx,
 364                                 uint64_t dev,
 365                                 uint64_t ino,
 366                                 const struct smb_share_mode_entry *del_entry)
 367 {
 368         TDB_DATA db_data;
 369         TDB_DATA locking_key =  get_locking_key(dev, ino);
 370         int orig_num_share_modes = 0;
 371         struct locking_data *ld = NULL; /* internal samba db state. */
 372         struct share_mode_entry *shares = NULL;
 373         char *new_data_p = NULL;
 374         size_t remaining_size = 0;
 375         size_t i, num_share_modes;
 376         const char *remaining_ptr = NULL;
 377
 378         db_data = tdb_fetch(db_ctx->smb_tdb, locking_key);
 379         if (!db_data.dptr) {
 380                 return -1; /* Error - missing entry ! */
 381         }
 382
 383         ld = (struct locking_data *)db_data.dptr;
 384         orig_num_share_modes = ld->u.s.num_share_mode_entries;
 385         shares = (struct share_mode_entry *)(db_data.dptr + sizeof(struct share_mode_entry));
 386
 387         if (orig_num_share_modes == 1) {
 388                 /* Only one entry - better be ours... */
 389                 if (!share_mode_entry_equal(del_entry, shares)) {
 390                         /* Error ! We can't delete someone else's entry ! */
 391                         free(db_data.dptr);
 392                         return -1;
 393                 }
 394                 /* It's ours - just remove the entire record. */
 395                 free(db_data.dptr);
 396                 return tdb_delete(db_ctx->smb_tdb, locking_key);
 397         }
 398
 399         /* More than one - allocate a new record minus the one we'll delete. */
 400         new_data_p = (char *)malloc(
 401                 db_data.dsize - sizeof(struct share_mode_entry));
 402         if (!new_data_p) {
 403                 free(db_data.dptr);
 404                 return -1;
 405         }
 406
 407         /* Copy the header. */
 408         memcpy(new_data_p, db_data.dptr, sizeof(struct share_mode_entry));
 409
 410         num_share_modes = 0;
 411         for (i = 0; i < orig_num_share_modes; i++) {
 412                 struct share_mode_entry *share = &shares[i];
 413                 struct process_id pid = share->pid;
 414
 415                 /* Check this process really exists. */
 416                 if (kill(sharemodes_procid_to_pid(&pid), 0) == -1 && (errno == ESRCH)) {
 417                         continue; /* No longer exists. */
 418                 }
 419
 420                 if (share_mode_entry_equal(del_entry, share)) {
 421                         continue; /* This is our delete taget. */
 422                 }
 423
 424                 memcpy(new_data_p + ((num_share_modes+1)*sizeof(struct share_mode_entry)),
 425                         share, sizeof(struct share_mode_entry) );
 426
 427                 num_share_modes++;
 428         }
 429
 430         if (num_share_modes == 0) {
 431                 /* None left after pruning. Delete record. */
 432                 free(db_data.dptr);
 433                 free(new_data_p);
 434                 return tdb_delete(db_ctx->smb_tdb, locking_key);
 435         }
 436
 437         /* Copy any delete token plus the terminating filenames. */
 438         remaining_ptr = db_data.dptr + ((orig_num_share_modes+1) * sizeof(struct share_mode_entry));
 439         remaining_size = db_data.dsize - (remaining_ptr - db_data.dptr);
 440
 441         memcpy(new_data_p + ((num_share_modes+1)*sizeof(struct share_mode_entry)),
 442                 remaining_ptr,
 443                 remaining_size);
 444
 445         free(db_data.dptr);
 446
 447         db_data.dptr = new_data_p;
 448
 449         /* Re-save smaller record. */
 450         ld = (struct locking_data *)db_data.dptr;
 451         ld->u.s.num_share_mode_entries = num_share_modes;
 452
 453         db_data.dsize = ((num_share_modes+1)*sizeof(struct share_mode_entry)) + remaining_size;
 454
 455         if (tdb_store(db_ctx->smb_tdb, locking_key, db_data, TDB_REPLACE) == -1) {
 456                 free(db_data.dptr);
 457                 return -1;
 458         }
 459         free(db_data.dptr);
 460         return 0;
 461 }
 462
 463 int smb_change_share_mode_entry(struct smbdb_ctx *db_ctx,
 464                                 uint64_t dev,
 465                                 uint64_t ino,
 466                                 const struct smb_share_mode_entry *set_entry,
 467                                 const struct smb_share_mode_entry *new_entry)
 468 {
 469         TDB_DATA db_data;
 470         TDB_DATA locking_key =  get_locking_key(dev, ino);
 471         int num_share_modes = 0;
 472         struct locking_data *ld = NULL; /* internal samba db state. */
 473         struct share_mode_entry *shares = NULL;
 474         size_t i;
 475         int found_entry = 0;
 476
 477         db_data = tdb_fetch(db_ctx->smb_tdb, locking_key);
 478         if (!db_data.dptr) {
 479                 return -1; /* Error - missing entry ! */
 480         }
 481
 482         ld = (struct locking_data *)db_data.dptr;
 483         num_share_modes = ld->u.s.num_share_mode_entries;
 484         shares = (struct share_mode_entry *)(db_data.dptr + sizeof(struct share_mode_entry));
 485
 486         for (i = 0; i < num_share_modes; i++) {
 487                 struct share_mode_entry *share = &shares[i];
 488                 struct process_id pid = share->pid;
 489
 490                 /* Check this process really exists. */
 491                 if (kill(sharemodes_procid_to_pid(&pid), 0) == -1 && (errno == ESRCH)) {
 492                         continue; /* No longer exists. */
 493                 }
 494
 495                 if (share_mode_entry_equal(set_entry, share)) {
 496                         create_share_mode_entry(share, new_entry);
 497                         found_entry = 1;
 498                         break;
 499                 }
 500         }
 501
 502         if (!found_entry) {
 503                 free(db_data.dptr);
 504                 return -1;
 505         }
 506
 507         /* Save modified data. */
 508         if (tdb_store(db_ctx->smb_tdb, locking_key, db_data, TDB_REPLACE) == -1) {
 509                 free(db_data.dptr);
 510                 return -1;
 511         }
 512         free(db_data.dptr);
 513         return 0;
 514 }