Skip to contentSkip to conversation

fs: hardlink creation restrictions

PATCH Superseded Kees Cook 3 participants 6 messages Feb 18, 2012 – Feb 20, 2012

Subsystems (3)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Kees Cook

author
#0 lore raw

PATCH 1/1 fs: hardlink creation restrictions

This is the other half of link restrictions, now that symlink restriction has landed in -mm.

On systems that have user-writable directories on the same partition as system files, a long-standing class of security issues is the hardlink-based time-of-check-time-of-use race, most commonly seen in world-writable directories like /tmp. The common method of exploitation of this flaw is to cross privilege boundaries when following a given hardlink (i.e. a root process follows a hardlink created by another user). Additionally, an issue exists where users can "pin" a potentially vulnerable setuid/setgid file so that an administrator will not actually upgrade a system fully.

The solution is to permit hardlinks to only be created when the user is already the existing file's owner, or if they already have read/write access to the existing file.

Many Linux users are surprised when they learn they can link to files they have no access to, so this change appears to follow the doctrine of "least surprise". Additionally, this change does not violate POSIX, which states "the implementation may require that the calling process has permission to access the existing file"[1].

This change is known to break some implementations of the "at" daemon, though the version used by Fedora and Ubuntu has been fixed[2] for a while. Otherwise, the change has been undisruptive while in use in Ubuntu for the last 1.5 years.

This patch is based on the patch in Openwall and grsecurity. I have added a sysctl to enable the protected behavior, documentation, and an audit notification.

[1] http://pubs.opengroup.org/onlinepubs/9699919799/functions/linkat.html
[2] http://anonscm.debian.org/gitweb/?p=collab-maint/at.git;a=commitdiff;h=f4114656c3a6c6f6070e315ffdf940a49eda3279

---
 Documentation/sysctl/fs.txt |   21 ++++++++++++
 fs/Kconfig                  |   46 ++++++++++++++++++++-------
 fs/namei.c                  |   72 ++++++++++++++++++++++++++++++++++++++++++-
 include/linux/fs.h          |    1 +
 kernel/sysctl.c             |   11 ++++++-
 5 files changed, 137 insertions(+), 14 deletions(-)
Documentation/sysctl/fs.txt +21 -0
index 4b47cd5..08458be 100644
@@ -32,6 +32,7 @@ Currently, these files are in /proc/sys/fs:
 - nr_open
 - overflowuid
 - overflowgid
+- protected_nonaccess_hardlinks
 - protected_sticky_symlinks
 - suid_dumpable
 - super-max
@@ -158,6 +159,26 @@ The default is 65534.
 
 ==============================================================
 
+protected_nonaccess_hardlinks:
+
+A long-standing class of security issues is the hardlink-based
+time-of-check-time-of-use race, most commonly seen in world-writable
+directories like /tmp. The common method of exploitation of this flaw
+is to cross privilege boundaries when following a given hardlink (i.e. a
+root process follows a hardlink created by another user). Additionally,
+on systems without separated partitions, this stops unauthorized users
+from "pinning" vulnerable setuid/setgid files against being upgraded by
+the administrator.
+
+When set to "0", hardlink creation behavior is unrestricted.
+
+When set to "1" hardlinks cannot be created by users if they do not
+already own the source file, or do not have read/write access to it.
+
+This protection is based on the restrictions in Openwall and grsecurity.
+
+==============================================================
+
 protected_sticky_symlinks:
 
 A long-standing class of security issues is the symlink-based
fs/Kconfig +34 -12

70 lines not on this page · raw message

fs/namei.c +71 -1

90 lines not on this page · raw message

include/linux/fs.h +1 -0
index e8474d8..feb0592 100644
@@ -423,6 +423,7 @@ extern int sysctl_nr_open;
 extern struct inodes_stat_t inodes_stat;
 extern int leases_enable, lease_break_time;
 extern int sysctl_protected_sticky_symlinks;
+extern int sysctl_protected_nonaccess_hardlinks;
 
 struct buffer_head;
 typedef int (get_block_t)(struct inode *inode, sector_t iblock,
kernel/sysctl.c +10 -1
index b1d0cf2..fa8b3d3 100644
@@ -1503,7 +1503,7 @@ static struct ctl_table fs_table[] = {
 	},
 #endif
 #endif
-#ifdef CONFIG_PROTECTED_STICKY_SYMLINKS
+#ifdef CONFIG_PROTECTED_LINKS
 	{
 		.procname	= "protected_sticky_symlinks",
 		.data		= &sysctl_protected_sticky_symlinks,
@@ -1513,6 +1513,15 @@ static struct ctl_table fs_table[] = {
 		.extra1		= &zero,
 		.extra2		= &one,
 	},
+	{
+		.procname	= "protected_nonaccess_hardlinks",
+		.data		= &sysctl_protected_nonaccess_hardlinks,
+		.maxlen		= sizeof(int),
+		.mode		= 0600,
+		.proc_handler	= proc_dointvec_minmax,
+		.extra1		= &zero,
+		.extra2		= &one,
+	},
 #endif
 	{
 		.procname	= "suid_dumpable",
Signature · 1 line
1.7.0.4
#1 lore raw

fs/namei.c SYSCALL_DEFINE5(linkat, int, olddfd, const char __user *, oldname, · line 3127

Quoted 10 lines · Kees Cook
fs/namei.c +3 -0
@@ -3052,6 +3119,9 @@ SYSCALL_DEFINE5(linkat, int, olddfd, const char __user *, oldname,
 	error = mnt_want_write(new_path.mnt);
 	if (error)
 		goto out_dput;
+	error = may_linkat(&old_path);
+	if (error)
+		goto out_dput;
 	error = security_path_link(old_path.dentry, &new_path, new_dentry);
 	if (error)
 		goto out_drop_write;

You should give up write access after check failure (i.e. goto out_drop_write).

Marcin

author
#2 lore raw
Quoted 13 lines · Marcin Slusarz

fs/namei.c SYSCALL_DEFINE5(linkat, int, olddfd, const char __user *, oldname, · line 3127

Quoted 10 lines · Kees Cook
fs/namei.c +3 -0
@@ -3052,6 +3119,9 @@ SYSCALL_DEFINE5(linkat, int, olddfd, const char __user *, oldname,
       error = mnt_want_write(new_path.mnt);
       if (error)
               goto out_dput;
+     error = may_linkat(&old_path);
+     if (error)
+             goto out_dput;
       error = security_path_link(old_path.dentry, &new_path, new_dentry);
       if (error)
               goto out_drop_write;

You should give up write access after check failure (i.e. goto out_drop_write).

Ah! Thanks, yes, good catch. I will move the check before mnt_want_write().

-Kees

Signature · 2 lines
Kees Cook
ChromeOS Security
Acked-by on v1 1/1
#3 lore raw
In reply to Kees Cook
Quoted 2 lines · Kees Cook

This is the other half of link restrictions, now that symlink restriction has landed in -mm.

Nice features!

Quoted 140 lines

On systems that have user-writable directories on the same partition as system files, a long-standing class of security issues is the hardlink-based time-of-check-time-of-use race, most commonly seen in world-writable directories like /tmp. The common method of exploitation of this flaw is to cross privilege boundaries when following a given hardlink (i.e. a root process follows a hardlink created by another user). Additionally, an issue exists where users can "pin" a potentially vulnerable setuid/setgid file so that an administrator will not actually upgrade a system fully.

The solution is to permit hardlinks to only be created when the user is already the existing file's owner, or if they already have read/write access to the existing file.

Many Linux users are surprised when they learn they can link to files they have no access to, so this change appears to follow the doctrine of "least surprise". Additionally, this change does not violate POSIX, which states "the implementation may require that the calling process has permission to access the existing file"[1].

This change is known to break some implementations of the "at" daemon, though the version used by Fedora and Ubuntu has been fixed[2] for a while. Otherwise, the change has been undisruptive while in use in Ubuntu for the last 1.5 years.

This patch is based on the patch in Openwall and grsecurity. I have added a sysctl to enable the protected behavior, documentation, and an audit notification.

[1] http://pubs.opengroup.org/onlinepubs/9699919799/functions/linkat.html
[2] http://anonscm.debian.org/gitweb/?p=collab-maint/at.git;a=commitdiff;h=f4114656c3a6c6f6070e315ffdf940a49eda3279

---
 Documentation/sysctl/fs.txt |   21 ++++++++++++
 fs/Kconfig                  |   46 ++++++++++++++++++++-------
 fs/namei.c                  |   72 ++++++++++++++++++++++++++++++++++++++++++-
 include/linux/fs.h          |    1 +
 kernel/sysctl.c             |   11 ++++++-
 5 files changed, 137 insertions(+), 14 deletions(-)
Documentation/sysctl/fs.txt +21 -0
index 4b47cd5..08458be 100644
@@ -32,6 +32,7 @@ Currently, these files are in /proc/sys/fs:
 - nr_open
 - overflowuid
 - overflowgid
+- protected_nonaccess_hardlinks
 - protected_sticky_symlinks
 - suid_dumpable
 - super-max
@@ -158,6 +159,26 @@ The default is 65534.
 
 ==============================================================
 
+protected_nonaccess_hardlinks:
+
+A long-standing class of security issues is the hardlink-based
+time-of-check-time-of-use race, most commonly seen in world-writable
+directories like /tmp. The common method of exploitation of this flaw
+is to cross privilege boundaries when following a given hardlink (i.e. a
+root process follows a hardlink created by another user). Additionally,
+on systems without separated partitions, this stops unauthorized users
+from "pinning" vulnerable setuid/setgid files against being upgraded by
+the administrator.
+
+When set to "0", hardlink creation behavior is unrestricted.
+
+When set to "1" hardlinks cannot be created by users if they do not
+already own the source file, or do not have read/write access to it.
+
+This protection is based on the restrictions in Openwall and grsecurity.
+
+==============================================================
+
 protected_sticky_symlinks:
 
 A long-standing class of security issues is the symlink-based
fs/Kconfig +17 -12
index ca279b7..66f9334 100644
@@ -271,27 +271,29 @@ endif # NETWORK_FILESYSTEMS
 source "fs/nls/Kconfig"
 source "fs/dlm/Kconfig"
 
-config PROTECTED_STICKY_SYMLINKS
-	bool "Evaluate vulnerable symlink conditions"
-	default y
+config PROTECTED_LINKS
+	bool "Evaluate vulnerable link conditions"
+	default n
 	help
-	  A long-standing class of security issues is the symlink-based
+	  A long-standing class of security issues is the link-based
 	  time-of-check-time-of-use race, most commonly seen in
 	  world-writable directories like /tmp. The common method of
 	  exploitation of this flaw is to cross privilege boundaries
-	  when following a given symlink (i.e. a root process follows
-	  a malicious symlink belonging to another user).
+	  when following a given link (i.e. a root process follows
+	  a malicious symlink belonging to another user, or a hardlink
+	  created to a root-owned file).
 
-	  Enabling this adds the logic to examine these dangerous symlink
-	  conditions. Whether or not the dangerous symlink situations are
-	  allowed is controlled by PROTECTED_STICKY_SYMLINKS_ENABLED.
+	  Enabling this adds the logic to examine these dangerous link
+	  conditions. Whether or not the dangerous link situations are
+	  allowed is controlled by PROTECTED_NONACCESS_HARDLINKS_ENABLED and
+	  PROTECTED_STICKY_SYMLINKS_ENABLED.
 
 config PROTECTED_STICKY_SYMLINKS_ENABLED
-	depends on PROTECTED_STICKY_SYMLINKS
+	depends on PROTECTED_LINKS
 	bool "Disallow symlink following in sticky world-writable dirs"
 	default y
 	help
-	  Solve ToCToU symlink race vulnerablities by permitting symlinks
+	  Solve ToCToU symlink race vulnerabilities by permitting symlinks
 	  to be followed only when outside a sticky world-writable directory,
 	  or when the uid of the symlink and follower match, or when the
 	  directory and symlink owners match.
@@ -300,9 +302,29 @@ config PROTECTED_STICKY_SYMLINKS_ENABLED
 	  via /proc/sys/kernel/protected_sticky_symlinks.
 
 config PROTECTED_STICKY_SYMLINKS_ENABLED_SYSCTL
-	depends on PROTECTED_STICKY_SYMLINKS
+	depends on PROTECTED_LINKS
 	int
 	default "1" if PROTECTED_STICKY_SYMLINKS_ENABLED
 	default "0"
 
+config PROTECTED_NONACCESS_HARDLINKS_ENABLED
+	depends on PROTECTED_LINKS
+	bool "Disallow hardlink creation to non-accessible files"

fs/Kconfig config PROTECTED_STICKY_SYMLINKS_ENABLED · line 322

Quoted 10 lines
fs/Kconfig +10 -0
+	default y
+	help
+	  Solve ToCToU hardlink race vulnerabilities by permitting hardlinks
+	  to be created only when to a regular file that is owned by the user,
+	  or is readable and writable by the user. Also blocks users from
+	  "pinning" vulnerable setuid/setgid programs from being upgraded by
+	  the administrator.
+
+	  When PROC_SYSCTL is enabled, this setting can also be controlled
+	  via /proc/sys/kernel/protected_nonaccess_hardlinks.

I'd add a:

See Documentation/sysctl/fs.txt for details.

line as well.

fs/Kconfig config PROTECTED_STICKY_SYMLINKS_ENABLED · line 328

Quoted 5 lines
fs/Kconfig +5 -0
+config PROTECTED_NONACCESS_HARDLINKS_ENABLED_SYSCTL
+	depends on PROTECTED_LINKS
+	int
+	default "1" if PROTECTED_NONACCESS_HARDLINKS_ENABLED
+	default "0"

Naming nit: how about dropping the _NONACCESS/_nonaccess names complete and turn it into protected_hardlinks? The longer variant is not any better descriptive, and needlessly longer.

The PROTECTED_SYMLINKS/PROTECTED_HARDLINKS naming is thus also nicely symmetric.

Quoted 6 lines
fs/Kconfig +6 -0
+#ifdef CONFIG_AUDIT
+	if (error) {
+		struct audit_buffer *ab;
+
+		ab = audit_log_start(current->audit_context,
+				     GFP_KERNEL, AUDIT_AVC);

fs/Kconfig config PROTECTED_STICKY_SYMLINKS_ENABLED

Quoted 10 lines
fs/Kconfig +10 -0
+		audit_log_format(ab, "op=linkat action=denied");
+		audit_log_format(ab, " pid=%d comm=", current->pid);
+		audit_log_untrustedstring(ab, current->comm);
+		audit_log_d_path(ab, " path=", old_path);
+		audit_log_format(ab, " dev=");
+		audit_log_untrustedstring(ab, inode->i_sb->s_id);
+		audit_log_format(ab, " ino=%lu", inode->i_ino);
+		audit_log_end(ab);
+	}
+#endif

Small detail: don't these audit methods map to nothing on !CONFIG_AUDIT, allowing the #ifdef to be dropped? (if not then it should really be so.)

Otherwise:

Thanks,

Ingo

author
#4 lore raw
Quoted 7 lines · Ingo Molnar
Quoted 2 lines · Kees Cook

This is the other half of link restrictions, now that symlink restriction has landed in -mm.

Nice features!

Thanks!

Quoted 26 lines
Quoted 13 lines
(quoted diff) +0 -0
@@ -300,9 +302,29 @@ config PROTECTED_STICKY_SYMLINKS_ENABLED

        via /proc/sys/kernel/protected_sticky_symlinks.

 config PROTECTED_STICKY_SYMLINKS_ENABLED_SYSCTL
-     depends on PROTECTED_STICKY_SYMLINKS
+     depends on PROTECTED_LINKS
      int
      default "1" if PROTECTED_STICKY_SYMLINKS_ENABLED default "0"

fs/Kconfig +3 -0
+config PROTECTED_NONACCESS_HARDLINKS_ENABLED
+     depends on PROTECTED_LINKS
+     bool "Disallow hardlink creation to non-accessible files"

fs/Kconfig config PROTECTED_STICKY_SYMLINKS_ENABLED · line 322

Quoted 10 lines
fs/Kconfig +10 -0
+     default y
+     help
+       Solve ToCToU hardlink race vulnerabilities by permitting hardlinks
+       to be created only when to a regular file that is owned by the user,
+       or is readable and writable by the user. Also blocks users from
+       "pinning" vulnerable setuid/setgid programs from being upgraded by
+       the administrator.
+
+       When PROC_SYSCTL is enabled, this setting can also be controlled
+       via /proc/sys/kernel/protected_nonaccess_hardlinks.

I'd add a:

Quoted 3 lines

       See Documentation/sysctl/fs.txt for details.

line as well.

Good call.

Quoted 6 lines
Quoted 5 lines

+config PROTECTED_NONACCESS_HARDLINKS_ENABLED_SYSCTL
+     depends on PROTECTED_LINKS
+     int
+     default "1" if PROTECTED_NONACCESS_HARDLINKS_ENABLED
+     default "0"

Quoted 6 lines

Naming nit: how about dropping the _NONACCESS/_nonaccess names complete and turn it into protected_hardlinks? The longer variant is not any better descriptive, and needlessly longer.

The PROTECTED_SYMLINKS/PROTECTED_HARDLINKS naming is thus also nicely symmetric.

Yeah, this really does look much better. I had opted for extreme verbosity, but I would agree: it's not really called for here.

Quoted 12 lines
Quoted 12 lines
fs/namei.c +12 -0
+#ifdef CONFIG_AUDIT
+     if (error) {
+             struct audit_buffer *ab;
+
+             ab = audit_log_start(current->audit_context,
+                                  GFP_KERNEL, AUDIT_AVC);
+             audit_log_format(ab, "op=linkat action=denied");
+             audit_log_format(ab, " pid=%d comm=", current->pid);
+             audit_log_untrustedstring(ab, current->comm);
+             audit_log_d_path(ab, " path=", old_path);
+             audit_log_format(ab, " dev=");
+             audit_log_untrustedstring(ab, inode->i_sb->s_id);
Quoted 8 lines
Quoted 4 lines

+             audit_log_format(ab, " ino=%lu", inode->i_ino);
+             audit_log_end(ab);
+     }
+#endif

Small detail: don't these audit methods map to nothing on !CONFIG_AUDIT, allowing the #ifdef to be dropped? (if not then it should really be so.)

Ah-ha; a more careful look at audit.h agrees. :) I'll adjust this as well.

Quoted 1 line

Thanks for the review,

-Kees

Signature · 2 lines
Kees Cook
ChromeOS Security
#5 lore raw
Quoted 21 lines · Kees Cook
Quoted 12 lines
Quoted 12 lines
fs/namei.c +12 -0
+#ifdef CONFIG_AUDIT
+     if (error) {
+             struct audit_buffer *ab;
+
+             ab = audit_log_start(current->audit_context,
+                                  GFP_KERNEL, AUDIT_AVC);
+             audit_log_format(ab, "op=linkat action=denied");
+             audit_log_format(ab, " pid=%d comm=", current->pid);
+             audit_log_untrustedstring(ab, current->comm);
+             audit_log_d_path(ab, " path=", old_path);
+             audit_log_format(ab, " dev=");
+             audit_log_untrustedstring(ab, inode->i_sb->s_id);
Quoted 8 lines
Quoted 4 lines

+             audit_log_format(ab, " ino=%lu", inode->i_ino);
+             audit_log_end(ab);
+     }
+#endif

Small detail: don't these audit methods map to nothing on !CONFIG_AUDIT, allowing the #ifdef to be dropped? (if not then it should really be so.)

Quoted 2 lines

Ah-ha; a more careful look at audit.h agrees. :) I'll adjust this as well.

Another detail, I'd also stick those logging lines into a separate inline function right before the linkat function, so that the logging details do not obscure the main flow of VFS logic:

	if (error)
		audit_log_linkat_denied(current, old_path, inode);

... or so. People reading this function won't be interested in the logging details 99.9% of the time.

Thanks,

Ingo