source3/utils/status.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    status reporting
   4    Copyright (C) Andrew Tridgell 1994-1998
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18
  19    Revision History:
  20
  21    12 aug 96: Erik.Devriendt@te6.siemens.be
  22    added support for shared memory implementation of share mode locking
  23
  24    21-Jul-1998: rsharpe@ns.aus.com (Richard Sharpe)
  25    Added -L (locks only) -S (shares only) flags and code
  26
  27 */
  28
  29 /*
  30  * This program reports current SMB connections
  31  */
  32
  33 #include "includes.h"
  34 #include "system/filesys.h"
  35 #include "popt_common.h"
  36 #include "dbwrap/dbwrap.h"
  37 #include "dbwrap/dbwrap_open.h"
  38 #include "../libcli/security/security.h"
  39 #include "session.h"
  40 #include "locking/proto.h"
  41 #include "messages.h"
  42 #include "librpc/gen_ndr/open_files.h"
  43 #include "smbd/smbd.h"
  44 #include "librpc/gen_ndr/notify.h"
  45 #include "lib/conn_tdb.h"
  46 #include "serverid.h"
  47 #include "status_profile.h"
  48 #include "smbd/notifyd/notifyd.h"
  49
  50 #define SMB_MAXPIDS             2048
  51 static uid_t            Ucrit_uid = 0;               /* added by OH */
  52 static struct server_id Ucrit_pid[SMB_MAXPIDS];  /* Ugly !!! */   /* added by OH */
  53 static int              Ucrit_MaxPid=0;                    /* added by OH */
  54 static unsigned int     Ucrit_IsActive = 0;                /* added by OH */
  55
  56 static bool verbose, brief;
  57 static bool shares_only;            /* Added by RJS */
  58 static bool locks_only;            /* Added by RJS */
  59 static bool processes_only;
  60 static bool show_brl;
  61 static bool numeric_only;
  62 static bool do_checks = true;
  63
  64 const char *username = NULL;
  65
  66 /* added by OH */
  67 static void Ucrit_addUid(uid_t uid)
  68 {
  69         Ucrit_uid = uid;
  70         Ucrit_IsActive = 1;
  71 }
  72
  73 static unsigned int Ucrit_checkUid(uid_t uid)
  74 {
  75         if ( !Ucrit_IsActive )
  76                 return 1;
  77
  78         if ( uid == Ucrit_uid )
  79                 return 1;
  80
  81         return 0;
  82 }
  83
  84 static unsigned int Ucrit_checkPid(struct server_id pid)
  85 {
  86         int i;
  87
  88         if ( !Ucrit_IsActive )
  89                 return 1;
  90
  91         for (i=0;i<Ucrit_MaxPid;i++) {
  92                 if (serverid_equal(&pid, &Ucrit_pid[i])) {
  93                         return 1;
  94                 }
  95         }
  96
  97         return 0;
  98 }
  99
 100 static bool Ucrit_addPid( struct server_id pid )
 101 {
 102         if ( !Ucrit_IsActive )
 103                 return True;
 104
 105         if ( Ucrit_MaxPid >= SMB_MAXPIDS ) {
 106                 d_printf("ERROR: More than %d pids for user %s!\n",
 107                          SMB_MAXPIDS, uidtoname(Ucrit_uid));
 108
 109                 return False;
 110         }
 111
 112         Ucrit_pid[Ucrit_MaxPid++] = pid;
 113
 114         return True;
 115 }
 116
 117 static int print_share_mode(const struct share_mode_entry *e,
 118                             const char *sharepath,
 119                             const char *fname,
 120                             const char *sname,
 121                             void *dummy)
 122 {
 123         static int count;
 124
 125         if (do_checks && !is_valid_share_mode_entry(e)) {
 126                 return 0;
 127         }
 128
 129         if (count==0) {
 130                 d_printf("Locked files:\n");
 131                 d_printf("Pid          Uid        DenyMode   Access      R/W        Oplock           SharePath   Name   Time\n");
 132                 d_printf("--------------------------------------------------------------------------------------------------\n");
 133         }
 134         count++;
 135
 136         if (do_checks && !serverid_exists(&e->pid)) {
 137                 /* the process for this entry does not exist any more */
 138                 return 0;
 139         }
 140
 141         if (Ucrit_checkPid(e->pid)) {
 142                 struct server_id_buf tmp;
 143                 d_printf("%-11s  ", server_id_str_buf(e->pid, &tmp));
 144                 d_printf("%-9u  ", (unsigned int)e->uid);
 145                 switch (map_share_mode_to_deny_mode(e->share_access,
 146                                                     e->private_options)) {
 147                         case DENY_NONE: d_printf("DENY_NONE  "); break;
 148                         case DENY_ALL:  d_printf("DENY_ALL   "); break;
 149                         case DENY_DOS:  d_printf("DENY_DOS   "); break;
 150                         case DENY_READ: d_printf("DENY_READ  "); break;
 151                         case DENY_WRITE:printf("DENY_WRITE "); break;
 152                         case DENY_FCB:  d_printf("DENY_FCB "); break;
 153                         default: {
 154                                 d_printf("unknown-please report ! "
 155                                          "e->share_access = 0x%x, "
 156                                          "e->private_options = 0x%x\n",
 157                                          (unsigned int)e->share_access,
 158                                          (unsigned int)e->private_options );
 159                                 break;
 160                         }
 161                 }
 162                 d_printf("0x%-8x  ",(unsigned int)e->access_mask);
 163                 if ((e->access_mask & (FILE_READ_DATA|FILE_WRITE_DATA))==
 164                                 (FILE_READ_DATA|FILE_WRITE_DATA)) {
 165                         d_printf("RDWR       ");
 166                 } else if (e->access_mask & FILE_WRITE_DATA) {
 167                         d_printf("WRONLY     ");
 168                 } else {
 169                         d_printf("RDONLY     ");
 170                 }
 171
 172                 if((e->op_type & (EXCLUSIVE_OPLOCK|BATCH_OPLOCK)) ==
 173                                         (EXCLUSIVE_OPLOCK|BATCH_OPLOCK)) {
 174                         d_printf("EXCLUSIVE+BATCH ");
 175                 } else if (e->op_type & EXCLUSIVE_OPLOCK) {
 176                         d_printf("EXCLUSIVE       ");
 177                 } else if (e->op_type & BATCH_OPLOCK) {
 178                         d_printf("BATCH           ");
 179                 } else if (e->op_type & LEVEL_II_OPLOCK) {
 180                         d_printf("LEVEL_II        ");
 181                 } else if (e->op_type == LEASE_OPLOCK) {
 182                         uint32_t lstate = e->lease->current_state;
 183                         d_printf("LEASE(%s%s%s)%s%s%s      ",
 184                                  (lstate & SMB2_LEASE_READ)?"R":"",
 185                                  (lstate & SMB2_LEASE_WRITE)?"W":"",
 186                                  (lstate & SMB2_LEASE_HANDLE)?"H":"",
 187                                  (lstate & SMB2_LEASE_READ)?"":" ",
 188                                  (lstate & SMB2_LEASE_WRITE)?"":" ",
 189                                  (lstate & SMB2_LEASE_HANDLE)?"":" ");
 190                 } else {
 191                         d_printf("NONE            ");
 192                 }
 193
 194                 d_printf(" %s   %s%s   %s",
 195                          sharepath, fname,
 196                          sname ? sname : "",
 197                          time_to_asc((time_t)e->time.tv_sec));
 198         }
 199
 200         return 0;
 201 }
 202
 203 static void print_brl(struct file_id id,
 204                         struct server_id pid,
 205                         enum brl_type lock_type,
 206                         enum brl_flavour lock_flav,
 207                         br_off start,
 208                         br_off size,
 209                         void *private_data)
 210 {
 211         static int count;
 212         unsigned int i;
 213         static const struct {
 214                 enum brl_type lock_type;
 215                 const char *desc;
 216         } lock_types[] = {
 217                 { READ_LOCK, "R" },
 218                 { WRITE_LOCK, "W" },
 219                 { PENDING_READ_LOCK, "PR" },
 220                 { PENDING_WRITE_LOCK, "PW" },
 221                 { UNLOCK_LOCK, "U" }
 222         };
 223         const char *desc="X";
 224         const char *sharepath = "";
 225         char *fname = NULL;
 226         struct share_mode_lock *share_mode;
 227         struct server_id_buf tmp;
 228
 229         if (count==0) {
 230                 d_printf("Byte range locks:\n");
 231                 d_printf("Pid        dev:inode       R/W  start     size      SharePath               Name\n");
 232                 d_printf("--------------------------------------------------------------------------------\n");
 233         }
 234         count++;
 235
 236         share_mode = fetch_share_mode_unlocked(NULL, id);
 237         if (share_mode) {
 238                 bool has_stream = share_mode->data->stream_name != NULL;
 239
 240                 fname = talloc_asprintf(NULL, "%s%s%s",
 241                                         share_mode->data->base_name,
 242                                         has_stream ? ":" : "",
 243                                         has_stream ?
 244                                         share_mode->data->stream_name :
 245                                         "");
 246         } else {
 247                 fname = talloc_strdup(NULL, "");
 248                 if (fname == NULL) {
 249                         return;
 250                 }
 251         }
 252
 253         for (i=0;i<ARRAY_SIZE(lock_types);i++) {
 254                 if (lock_type == lock_types[i].lock_type) {
 255                         desc = lock_types[i].desc;
 256                 }
 257         }
 258
 259         d_printf("%-10s %-15s %-4s %-9jd %-9jd %-24s %-24s\n",
 260                  server_id_str_buf(pid, &tmp), file_id_string_tos(&id),
 261                  desc,
 262                  (intmax_t)start, (intmax_t)size,
 263                  sharepath, fname);
 264
 265         TALLOC_FREE(fname);
 266         TALLOC_FREE(share_mode);
 267 }
 268
 269 static const char *session_dialect_str(uint16_t dialect)
 270 {
 271         static fstring unkown_dialect;
 272
 273         switch(dialect){
 274         case SMB2_DIALECT_REVISION_000:
 275                 return "NT1";
 276         case SMB2_DIALECT_REVISION_202:
 277                 return "SMB2_02";
 278         case SMB2_DIALECT_REVISION_210:
 279                 return "SMB2_10";
 280         case SMB2_DIALECT_REVISION_222:
 281                 return "SMB2_22";
 282         case SMB2_DIALECT_REVISION_224:
 283                 return "SMB2_24";
 284         case SMB3_DIALECT_REVISION_300:
 285                 return "SMB3_00";
 286         case SMB3_DIALECT_REVISION_302:
 287                 return "SMB3_02";
 288         case SMB3_DIALECT_REVISION_310:
 289                 return "SMB3_10";
 290         case SMB3_DIALECT_REVISION_311:
 291                 return "SMB3_11";
 292         }
 293
 294         fstr_sprintf(unkown_dialect, "Unknown (0x%04x)", dialect);
 295         return unkown_dialect;
 296 }
 297
 298 static int traverse_connections(const struct connections_key *key,
 299                                 const struct connections_data *crec,
 300                                 void *private_data)
 301 {
 302         TALLOC_CTX *mem_ctx = (TALLOC_CTX *)private_data;
 303         struct server_id_buf tmp;
 304
 305         if (crec->cnum == TID_FIELD_INVALID)
 306                 return 0;
 307
 308         if (do_checks &&
 309             (!process_exists(crec->pid) || !Ucrit_checkUid(crec->uid))) {
 310                 return 0;
 311         }
 312
 313         d_printf("%-10s   %s   %-12s  %s",
 314                  crec->servicename, server_id_str_buf(crec->pid, &tmp),
 315                  crec->machine,
 316                  time_to_asc(crec->start));
 317
 318         return 0;
 319 }
 320
 321 static int traverse_sessionid(const char *key, struct sessionid *session,
 322                               void *private_data)
 323 {
 324         TALLOC_CTX *mem_ctx = (TALLOC_CTX *)private_data;
 325         fstring uid_str, gid_str;
 326         struct server_id_buf tmp;
 327         char *machine_hostname = NULL;
 328
 329         if (do_checks &&
 330             (!process_exists(session->pid) ||
 331              !Ucrit_checkUid(session->uid))) {
 332                 return 0;
 333         }
 334
 335         Ucrit_addPid(session->pid);
 336
 337         fstrcpy(uid_str, "-1");
 338
 339         if (session->uid != -1) {
 340                 if (numeric_only) {
 341                         fstr_sprintf(uid_str, "%u", (unsigned int)session->uid);
 342                 } else {
 343                         fstrcpy(uid_str, uidtoname(session->uid));
 344                 }
 345         }
 346
 347         fstrcpy(gid_str, "-1");
 348
 349         if (session->gid != -1) {
 350                 if (numeric_only) {
 351                         fstr_sprintf(gid_str, "%u", (unsigned int)session->gid);
 352                 } else {
 353                         fstrcpy(gid_str, gidtoname(session->gid));
 354                 }
 355         }
 356
 357         machine_hostname = talloc_asprintf(mem_ctx, "%s (%s)",
 358                                            session->remote_machine,
 359                                            session->hostname);
 360         if (machine_hostname == NULL) {
 361                 return -1;
 362         }
 363
 364         d_printf("%-7s %-12s %-12s %-41s %-17s\n",
 365                  server_id_str_buf(session->pid, &tmp),
 366                  uid_str, gid_str,
 367                  machine_hostname,
 368                  session_dialect_str(session->connection_dialect));
 369
 370         TALLOC_FREE(machine_hostname);
 371
 372         return 0;
 373 }
 374
 375
 376 static bool print_notify_rec(const char *path, struct server_id server,
 377                              const struct notify_instance *instance,
 378                              void *private_data)
 379 {
 380         struct server_id_buf idbuf;
 381
 382         d_printf("%s\\%s\\%x\\%x\n", path, server_id_str_buf(server, &idbuf),
 383                  (unsigned)instance->filter,
 384                  (unsigned)instance->subdir_filter);
 385
 386         return true;
 387 }
 388
 389 int main(int argc, const char *argv[])
 390 {
 391         int c;
 392         int profile_only = 0;
 393         bool show_processes, show_locks, show_shares;
 394         bool show_notify = false;
 395         poptContext pc;
 396         struct poptOption long_options[] = {
 397                 POPT_AUTOHELP
 398                 {"processes",   'p', POPT_ARG_NONE,     NULL, 'p', "Show processes only" },
 399                 {"verbose",     'v', POPT_ARG_NONE,     NULL, 'v', "Be verbose" },
 400                 {"locks",       'L', POPT_ARG_NONE,     NULL, 'L', "Show locks only" },
 401                 {"shares",      'S', POPT_ARG_NONE,     NULL, 'S', "Show shares only" },
 402                 {"notify",      'N', POPT_ARG_NONE,     NULL, 'N', "Show notifies" },
 403                 {"user",        'u', POPT_ARG_STRING,   &username, 'u', "Switch to user" },
 404                 {"brief",       'b', POPT_ARG_NONE,     NULL, 'b', "Be brief" },
 405                 {"profile",     'P', POPT_ARG_NONE, NULL, 'P', "Do profiling" },
 406                 {"profile-rates", 'R', POPT_ARG_NONE, NULL, 'R', "Show call rates" },
 407                 {"byterange",   'B', POPT_ARG_NONE,     NULL, 'B', "Include byte range locks"},
 408                 {"numeric",     'n', POPT_ARG_NONE,     NULL, 'n', "Numeric uid/gid"},
 409                 {"fast",        'f', POPT_ARG_NONE,     NULL, 'f', "Skip checks if processes still exist"},
 410                 POPT_COMMON_SAMBA
 411                 POPT_TABLEEND
 412         };
 413         TALLOC_CTX *frame = talloc_stackframe();
 414         int ret = 0;
 415         struct messaging_context *msg_ctx = NULL;
 416         char *db_path;
 417         bool ok;
 418
 419         sec_init();
 420         smb_init_locale();
 421
 422         setup_logging(argv[0], DEBUG_STDERR);
 423         lp_set_cmdline("log level", "0");
 424
 425         if (getuid() != geteuid()) {
 426                 d_printf("smbstatus should not be run setuid\n");
 427                 ret = 1;
 428                 goto done;
 429         }
 430
 431         if (getuid() != 0) {
 432                 d_printf("smbstatus only works as root!\n");
 433                 ret = 1;
 434                 goto done;
 435         }
 436
 437
 438         pc = poptGetContext(NULL, argc, argv, long_options,
 439                             POPT_CONTEXT_KEEP_FIRST);
 440
 441         while ((c = poptGetNextOpt(pc)) != -1) {
 442                 switch (c) {
 443                 case 'p':
 444                         processes_only = true;
 445                         break;
 446                 case 'v':
 447                         verbose = true;
 448                         break;
 449                 case 'L':
 450                         locks_only = true;
 451                         break;
 452                 case 'S':
 453                         shares_only = true;
 454                         break;
 455                 case 'N':
 456                         show_notify = true;
 457                         break;
 458                 case 'b':
 459                         brief = true;
 460                         break;
 461                 case 'u':
 462                         Ucrit_addUid(nametouid(poptGetOptArg(pc)));
 463                         break;
 464                 case 'P':
 465                 case 'R':
 466                         profile_only = c;
 467                         break;
 468                 case 'B':
 469                         show_brl = true;
 470                         break;
 471                 case 'n':
 472                         numeric_only = true;
 473                         break;
 474                 case 'f':
 475                         do_checks = false;
 476                         break;
 477                 }
 478         }
 479
 480         /* setup the flags based on the possible combincations */
 481
 482         show_processes = !(shares_only || locks_only || profile_only) || processes_only;
 483         show_locks     = !(shares_only || processes_only || profile_only) || locks_only;
 484         show_shares    = !(processes_only || locks_only || profile_only) || shares_only;
 485
 486         if ( username )
 487                 Ucrit_addUid( nametouid(username) );
 488
 489         if (verbose) {
 490                 d_printf("using configfile = %s\n", get_dyn_CONFIGFILE());
 491         }
 492
 493         if (!lp_load_initial_only(get_dyn_CONFIGFILE())) {
 494                 fprintf(stderr, "Can't load %s - run testparm to debug it\n",
 495                         get_dyn_CONFIGFILE());
 496                 ret = -1;
 497                 goto done;
 498         }
 499
 500
 501         /*
 502          * This implicitly initializes the global ctdbd connection,
 503          * usable by the db_open() calls further down.
 504          */
 505         msg_ctx = messaging_init(NULL, samba_tevent_context_init(NULL));
 506         if (msg_ctx == NULL) {
 507                 fprintf(stderr, "messaging_init failed\n");
 508                 ret = -1;
 509                 goto done;
 510         }
 511
 512         if (!lp_load_global(get_dyn_CONFIGFILE())) {
 513                 fprintf(stderr, "Can't load %s - run testparm to debug it\n",
 514                         get_dyn_CONFIGFILE());
 515                 ret = -1;
 516                 goto done;
 517         }
 518
 519         switch (profile_only) {
 520                 case 'P':
 521                         /* Dump profile data */
 522                         ok = status_profile_dump(verbose);
 523                         return ok ? 0 : 1;
 524                 case 'R':
 525                         /* Continuously display rate-converted data */
 526                         ok = status_profile_rates(verbose);
 527                         return ok ? 0 : 1;
 528                 default:
 529                         break;
 530         }
 531
 532         if ( show_processes ) {
 533                 d_printf("\nSamba version %s\n",samba_version_string());
 534                 d_printf("%-7s %-12s %-12s %-41s %-17s\n", "PID", "Username", "Group", "Machine", "Protocol Version");
 535                 d_printf("--------------------------------------------------------------------------------------------\n");
 536
 537                 sessionid_traverse_read(traverse_sessionid, frame);
 538
 539                 if (processes_only) {
 540                         goto done;
 541                 }
 542         }
 543
 544         if ( show_shares ) {
 545                 if (brief) {
 546                         goto done;
 547                 }
 548
 549                 d_printf("\nService      pid     machine       Connected at\n");
 550                 d_printf("-------------------------------------------------------\n");
 551
 552                 connections_forall_read(traverse_connections, frame);
 553
 554                 d_printf("\n");
 555
 556                 if ( shares_only ) {
 557                         goto done;
 558                 }
 559         }
 560
 561         if ( show_locks ) {
 562                 int result;
 563                 struct db_context *db;
 564
 565                 db_path = lock_path("locking.tdb");
 566                 if (db_path == NULL) {
 567                         d_printf("Out of memory - exiting\n");
 568                         ret = -1;
 569                         goto done;
 570                 }
 571
 572                 db = db_open(NULL, db_path, 0,
 573                              TDB_CLEAR_IF_FIRST|TDB_INCOMPATIBLE_HASH, O_RDONLY, 0,
 574                              DBWRAP_LOCK_ORDER_1, DBWRAP_FLAG_NONE);
 575
 576                 if (!db) {
 577                         d_printf("%s not initialised\n", db_path);
 578                         d_printf("This is normal if an SMB client has never "
 579                                  "connected to your server.\n");
 580                         TALLOC_FREE(db_path);
 581                         exit(0);
 582                 } else {
 583                         TALLOC_FREE(db);
 584                         TALLOC_FREE(db_path);
 585                 }
 586
 587                 if (!locking_init_readonly()) {
 588                         d_printf("Can't initialise locking module - exiting\n");
 589                         ret = 1;
 590                         goto done;
 591                 }
 592
 593                 result = share_entry_forall(print_share_mode, NULL);
 594
 595                 if (result == 0) {
 596                         d_printf("No locked files\n");
 597                 } else if (result < 0) {
 598                         d_printf("locked file list truncated\n");
 599                 }
 600
 601                 d_printf("\n");
 602
 603                 if (show_brl) {
 604                         brl_forall(print_brl, NULL);
 605                 }
 606
 607                 locking_end();
 608         }
 609
 610         if (show_notify) {
 611                 struct notify_context *n;
 612
 613                 n = notify_init(talloc_tos(), msg_ctx,
 614                                 messaging_tevent_context(msg_ctx));
 615                 if (n == NULL) {
 616                         goto done;
 617                 }
 618                 notify_walk(n, print_notify_rec, NULL);
 619                 TALLOC_FREE(n);
 620         }
 621
 622 done:
 623         TALLOC_FREE(frame);
 624         return ret;
 625 }