mirror of
git://git.sv.gnu.org/coreutils.git
synced 2026-02-23 15:45:00 +02:00
There have been various requests to add -h to avoid following symlinks for security reasons. This wasn't provided previously as chmod(1) already ignored symlinks unless specified on the command line. Note chmod defaults to -H mode rather than the chown default of -P, as usually chown can work directly on symlinks and so defaults to not traversing those specified on the command line. Note FreeBSD chmod does default to -P mode, but we retain the -H mode default also for compatibility with existing chmod behavior. Adding -HLP will allow chmod to disable traversing CLI symlinks to dirs. Adding -h will allow to disable following CLI symlinks to files/dirs, also operating on all symlinks on systems that support that. Adding --dereference will be significant with -H (the default). I.e. symlinks to dirs not recursed, but symlinks are dereferenced. Adding these options will also be consistent with chown(1), chgrp(1), and chmod(1) on other systems. Note since chmod(1) currently ignores symlinks by default, and -h is primarily a mechanism to avoid following symlinks, rather than for operating on the symlink itself, we make -h try to chmod a symlink, but ignore ENOTSUP. In that way we're consistent with chown(1) where it also ignores ENOTSUP for symlinks, and we don't fail when trying to be extra secure with command line params. * doc/coreutils.texi (chmod invocation): Reference the -H,-L,-P descriptions, and adjust the corresponding macros to say the default is -H or -P as appropriate. Add --dereference and -h,--no-dereference descriptions. * man/chmod.x: Adjust discussion of symlink handling. * src/chmod.c (main): Accept new options and set fts flags appropriately. (process_file): Process / dereference symlinks as necessary. * src/system.h (emit_symlink_recurse_options): A new function refactored from chown.c and chmod.c usage(). * tests/chmod/symlinks.sh: New test for the new options. * tests/local.mk: Reference the new test. * NEWS: Mention the new feature.
121 lines
4.7 KiB
Plaintext
121 lines
4.7 KiB
Plaintext
'\" Copyright (C) 1998-2024 Free Software Foundation, Inc.
|
|
'\"
|
|
'\" This is free software. You may redistribute copies of it under the terms
|
|
'\" of the GNU General Public License <https://www.gnu.org/licenses/gpl.html>.
|
|
'\" There is NO WARRANTY, to the extent permitted by law.
|
|
[NAME]
|
|
chmod \- change file mode bits
|
|
[DESCRIPTION]
|
|
This manual page
|
|
documents the GNU version of
|
|
.BR chmod .
|
|
.B chmod
|
|
changes the file mode bits of each given file according to
|
|
.IR mode ,
|
|
which can be either a symbolic representation of changes to make, or
|
|
an octal number representing the bit pattern for the new mode bits.
|
|
.PP
|
|
The format of a symbolic mode is [\c
|
|
\fBugoa\fP.\|.\|.][[\fB-+=\fP][\fIperms\fP.\|.\|.].\|.\|.],
|
|
where
|
|
.I "perms"
|
|
is either zero or more letters from the set
|
|
\fBrwxXst\fP, or a single letter from the set \fBugo\fP.
|
|
Multiple symbolic
|
|
modes can be given, separated by commas.
|
|
.PP
|
|
A combination of the letters \fBugoa\fP controls which users' access
|
|
to the file will be changed: the user who owns it (\fBu\fP), other
|
|
users in the file's group (\fBg\fP), other users not in the file's
|
|
group (\fBo\fP), or all users (\fBa\fP). If none of these are given,
|
|
the effect is as if (\fBa\fP) were
|
|
given, but bits that are set in the umask are not affected.
|
|
.PP
|
|
The operator \fB+\fP causes the selected file mode bits to be added to
|
|
the existing file mode bits of each file; \fB-\fP causes them to be
|
|
removed; and \fB=\fP causes them to be added and causes unmentioned
|
|
bits to be removed except that a directory's unmentioned set user and
|
|
group ID bits are not affected.
|
|
.PP
|
|
The letters \fBrwxXst\fP select file mode bits for the affected users:
|
|
read (\fBr\fP), write (\fBw\fP), execute (or search for directories)
|
|
(\fBx\fP), execute/search only if the file is a directory or already
|
|
has execute permission for some user (\fBX\fP), set user or group ID
|
|
on execution (\fBs\fP), restricted deletion flag or sticky bit
|
|
(\fBt\fP). Instead of one or more of these letters, you can specify
|
|
exactly one of the letters \fBugo\fP: the permissions granted to the
|
|
user who owns the file (\fBu\fP), the permissions granted to other
|
|
users who are members of the file's group (\fBg\fP),
|
|
and the permissions granted to users that are in neither of the two preceding
|
|
categories (\fBo\fP).
|
|
.PP
|
|
A numeric mode is from one to four octal digits (0\-7), derived by
|
|
adding up the bits with values 4, 2, and 1. Omitted digits are
|
|
assumed to be leading zeros.
|
|
The first digit selects the set user ID (4) and set group ID (2) and
|
|
restricted deletion or sticky (1) attributes. The second digit
|
|
selects permissions for the user who owns the file: read (4), write (2),
|
|
and execute (1); the third selects permissions for other users in the
|
|
file's group, with the same values; and the fourth for other users not
|
|
in the file's group, with the same values.
|
|
.PP
|
|
.B chmod
|
|
doesn't change the permissions of symbolic links; the
|
|
.B chmod
|
|
system call cannot change their permissions on most systems,
|
|
and most systems ignore permissions of symbolic links.
|
|
However, for each symbolic link listed on the command line,
|
|
.B chmod
|
|
changes the permissions of the pointed-to file.
|
|
In contrast,
|
|
.B chmod
|
|
ignores symbolic links encountered during recursive directory
|
|
traversals. Options that modify this behavior are described in the
|
|
.B OPTIONS
|
|
section.
|
|
.SH "SETUID AND SETGID BITS"
|
|
.B chmod
|
|
clears the set-group-ID bit of a
|
|
regular file if the file's group ID does not match the user's
|
|
effective group ID or one of the user's supplementary group IDs,
|
|
unless the user has appropriate privileges. Additional restrictions
|
|
may cause the set-user-ID and set-group-ID bits of
|
|
.I MODE
|
|
or
|
|
.I RFILE
|
|
to be ignored. This behavior depends on the policy and
|
|
functionality of the underlying
|
|
.B chmod
|
|
system call. When in
|
|
doubt, check the underlying system behavior.
|
|
.PP
|
|
For directories
|
|
.B chmod
|
|
preserves set-user-ID and set-group-ID bits unless you
|
|
explicitly specify otherwise. You can set or clear the bits with
|
|
symbolic modes like
|
|
.B u+s
|
|
and
|
|
.BR g\-s .
|
|
To clear these bits for directories with a numeric mode requires
|
|
an additional leading zero like
|
|
.BR 00755 ,
|
|
leading minus like
|
|
.BR \-6000 ,
|
|
or leading equals like
|
|
.BR =755 .
|
|
.SH "RESTRICTED DELETION FLAG OR STICKY BIT"
|
|
The restricted deletion flag or sticky bit is a single bit, whose
|
|
interpretation depends on the file type. For directories, it prevents
|
|
unprivileged users from removing or renaming a file in the directory
|
|
unless they own the file or the directory; this is called the
|
|
.I "restricted deletion flag"
|
|
for the directory, and is commonly found on world-writable directories
|
|
like \fB/tmp\fP. For regular files on some older systems, the bit
|
|
saves the program's text image on the swap device so it will load more
|
|
quickly when run; this is called the
|
|
.IR "sticky bit" .
|
|
.SH OPTIONS
|
|
[SEE ALSO]
|
|
chmod(2)
|