Viewing: checkstat.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 * Copyright (c) 2002, 2010, Oracle and/or its affiliates. All rights reserved.
 * Use is subject to license terms.
 *
 * Copyright (c) 2011, Intel Corporation.
 */
/*
 * Test program to compare the attributes of a files to verify that it
 * desired file attributes are present.  This file predates availability
 * of the stat(3) utility and is deprecated.  Either test(3) ([ ]) or
 * stat(3) should be used in all new tests.
 *
 * This file is part of Lustre, http://www.lustre.org/
 */

#include <stdio.h>
#include <stdlib.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/ioctl.h>
#include <fcntl.h>
#include <unistd.h>
#include <errno.h>
#include <string.h>
#include <pwd.h>
#include <grp.h>
#include <linux/fs.h>

static void
usage(char *argv0, int help)
{
	char *progname = strrchr(argv0, '/');

	if (!progname)
		progname = argv0;

	fprintf(help ? stdout : stderr,
		"Usage: %s [flags] file[s]\n",
		progname);

	if (!help) {
		fprintf(stderr, "   or try '-h' for help\n");
		exit(1);
	}

	printf("Check given files have...\n");
	printf(" -p    permission       file must have required permissions\n");
	printf(" -t    dir|file|link    file must be of the specified type\n");
	printf(" -l    link_name        file must be a link to the given name\n");
	printf(" -s    size             file must have the given size\n");
	printf(" -u    user             file must be owned by given user\n");
	printf(" -g    group            file must be owned by given group\n");
	printf(" -j    projid           file must have the given project ID\n");
	printf(" -f                     follow symlinks\n");
	printf(" -a                     file must be absent\n");
	printf(" -v                     increase verbosity\n");
	printf(" -h                     print help\n");
	printf(" Exit status is 0 on success, 1 on failure\n");
}

/* using realpath() implies the paths must be resolved/exist
 * so this will fail for dangling links
 */
static int check_canonical(char *lname, char *checklink, int verbose)
{
	char *lname_canon;
	char *checklink_canon;

	lname_canon = realpath(lname, NULL);
	if (lname_canon == NULL) {
		if (verbose)
			printf("%s: can't canonicalize: %s\n",
			       lname, strerror(errno));
		return 1;
	}

	checklink_canon = realpath(checklink, NULL);
	if (checklink_canon == NULL) {
		if (verbose)
			printf("%s: can't canonicalize: %s\n",
			       checklink, strerror(errno));
		return 1;
	}

	if (strcmp(checklink_canon, lname_canon)) {
		free(lname_canon);
		free(checklink_canon);
		return 1;
	}
	free(lname_canon);
	free(checklink_canon);
	return 0;
}

int
main(int argc, char **argv)
{
	int c;
	struct stat64 buf;
	int perms = -1;
	uid_t uid = (uid_t)-1;
	gid_t gid = (gid_t)-1;
	long long projid = -1;
	char *type = NULL;
	long absent = 0;
	char *checklink = NULL;
	int verbose = 0;
	long long size = -1;
	int follow = 0;
	char *term;

	while ((c = getopt(argc, argv, "p:t:l:s:u:g:j:avfh")) != -1)
		switch (c) {
		case 'p':
			perms = (int)strtol(optarg, &term, 0);
			if (term == optarg) {
				fprintf(stderr, "Can't parse permission %s\n",
					optarg);
				return 1;
			}
			break;

		case 'l':
			checklink = optarg;
			break;

		case 's':
			size = strtoll(optarg, &term, 0);
			if (term == optarg) {
				fprintf(stderr, "Can't parse size %s\n",
					optarg);
				return 1;
			}
			break;

		case 'u':
			if (*optarg == '#') {
				uid = (uid_t)strtol(optarg + 1, &term, 0);

				if (term == optarg + 1) {
					fprintf(stderr,
						"Can't parse numeric uid %s\n",
						optarg);
					return 1;
				}
			} else {
				struct passwd *pw = getpwnam(optarg);

				if (!pw) {
					fprintf(stderr, "Can't find user %s\n",
						optarg);
					return 1;
				}
				uid = pw->pw_uid;
			}
			break;

		case 'g':
			if (*optarg == '#') {
				gid = (gid_t)strtol(optarg + 1, &term, 0);

				if (term == optarg + 1) {
					fprintf(stderr,
						"Can't parse numeric gid %s\n",
						optarg);
					return 1;
				}
			} else {
				struct group *gr = getgrnam(optarg);

				if (!gr) {
					fprintf(stderr,
						"Can't find group %s\n",
						optarg);
					return 1;
				}
				uid = gr->gr_gid;
			}
			break;

		case 'j':
			projid = strtoll(optarg, &term, 0);
			if (term == optarg || projid < 0) {
				fprintf(stderr, "Can't parse projid %s\n",
					optarg);
				return 1;
			}
			break;

		case 't':
			type = optarg;
			break;

		case 'a':
			absent = 1;
			break;

		case 'v':
			verbose++;
			break;

		case 'f':
			follow++;
			break;

		case 'h':
			usage(argv[0], 1);
			return 0;

		default:
			usage(argv[0], 0);
		}

	if (optind == argc)
		usage(argv[0], 0);

	do {
		char *fname = argv[optind];
		int rc = follow ? stat64(fname, &buf) : lstat64(fname, &buf);

		if (rc != 0) {
			if (!(absent && errno == ENOENT)) {
				if (verbose)
					printf("Can't %sstat %s: %s\n",
					       follow ? "" : "l",
					       fname, strerror(errno));
				return 1;
			}

			if (verbose)
				printf("%s: absent OK\n", fname);
			continue;
		}

		if (absent) {
			if (verbose)
				printf("%s exists\n", fname);
			return 1;
		}

		if (type) {
			if (!strcmp(type, "d") ||
			    !strcmp(type, "dir")) {
				if (!S_ISDIR(buf.st_mode)) {
					if (verbose)
						printf("%s is not a directory\n",
						       fname);
					return 1;
				}
			} else if (!strcmp(type, "f") ||
				 !strcmp(type, "file")) {
				if (!S_ISREG(buf.st_mode)) {
					if (verbose)
						printf("%s is not a regular file\n",
						       fname);
					return 1;
				}
			} else if (!strcmp(type, "l") ||
				 !strcmp(type, "link")) {
				if (!S_ISLNK(buf.st_mode)) {
					if (verbose)
						printf("%s is not a link\n",
						       fname);
					return 1;
				}
			} else {
				fprintf(stderr, "Can't parse file type %s\n",
					type);
				return 1;
			}

			if (verbose)
				printf("%s has type %s OK\n", fname, type);
		}

		if (perms != -1) {
			if ((buf.st_mode & ~S_IFMT) != perms) {
				if (verbose)
					printf("%s has perms 0%o, not 0%o\n",
					       fname, (buf.st_mode & ~S_IFMT),
					       perms);
				return 1;
			}

			if (verbose)
				printf("%s has perms 0%o OK\n",
				       fname, perms);
		}

		if (size != -1) {
			if (buf.st_size != size) {
				if (verbose)
					printf("%s has size %lld, not %lld\n",
					       fname, (long long)buf.st_size,
					       size);
				return 1;
			}

			if (verbose)
				printf("%s has size %lld OK\n", fname, size);
		}

		if (checklink) {
			static char lname[4 << 10];

			rc = readlink(fname, lname, sizeof(lname) - 1);

			if (rc < 0) {
				if (verbose)
					printf("%s: can't read link: %s\n",
					       fname, strerror(errno));
				return 1;
			}

			lname[rc] = 0;

			/* just in case, try to also match the canonicalized
			 * paths
			 */
			if (strcmp(checklink, lname) &&
			    check_canonical(lname, checklink, verbose)) {
				if (verbose)
					printf("%s is a link to %s and not %s\n",
					       fname, lname, checklink);
				return 1;
			}

			if (verbose)
				printf("%s links to %s OK\n", fname, checklink);
		}

		if (uid != (uid_t)-1) {
			if (buf.st_uid != uid) {
				if (verbose)
					printf("%s is owned by user #%ld and not #%ld\n",
					       fname, (long)buf.st_uid, (long)uid);
				return 1;
			}

			if (verbose)
				printf("%s is owned by user #%ld OK\n",
				       fname, (long)uid);
		}

		if (gid != (gid_t)-1) {
			if (buf.st_gid != gid) {
				if (verbose)
					printf("%s is owned by group #%ld and not #%ld\n",
					       fname, (long)buf.st_gid, (long)gid);
				return 1;
			}

			if (verbose)
				printf("%s is owned by group #%ld OK\n",
				       fname, (long)gid);
		}

		if (projid != -1) {
			struct fsxattr fsx = { 0 };
			int fd = open(fname, O_RDONLY | O_NOCTTY | O_NDELAY);

			if (fd < 0) {
				if (verbose)
					printf("%s: can't open to read projid: %s\n",
					       fname, strerror(errno));
				return 1;
			}
			rc = ioctl(fd, FS_IOC_FSGETXATTR, &fsx);
			close(fd);
			if (rc != 0) {
				if (verbose)
					printf("%s: can't get projid: %s\n",
					       fname, strerror(errno));
				return 1;
			}
			if ((long long)fsx.fsx_projid != projid) {
				if (verbose)
					printf("%s has projid %u, not %lld\n",
					       fname, fsx.fsx_projid, projid);
				return 1;
			}

			if (verbose)
				printf("%s has projid %lld OK\n",
				       fname, projid);
		}
	} while (++optind < argc);

	return 0;
}