Commit 7743c48e authored by David Howells's avatar David Howells
Browse files

keys: Cache result of request_key*() temporarily in task_struct 



If a filesystem uses keys to hold authentication tokens, then it needs a
token for each VFS operation that might perform an authentication check -
either by passing it to the server, or using to perform a check based on
authentication data cached locally.

For open files this isn't a problem, since the key should be cached in the
file struct since it represents the subject performing operations on that
file descriptor.

During pathwalk, however, there isn't anywhere to cache the key, except
perhaps in the nameidata struct - but that isn't exposed to the
filesystems.  Further, a pathwalk can incur a lot of operations, calling
one or more of the following, for instance:

	->lookup()
	->permission()
	->d_revalidate()
	->d_automount()
	->get_acl()
	->getxattr()

on each dentry/inode it encounters - and each one may need to call
request_key().  And then, at the end of pathwalk, it will call the actual
operation:

	->mkdir()
	->mknod()
	->getattr()
	->open()
	...

which may need to go and get the token again.

However, it is very likely that all of the operations on a single
dentry/inode - and quite possibly a sequence of them - will all want to use
the same authentication token, which suggests that caching it would be a
good idea.

To this end:

 (1) Make it so that a positive result of request_key() and co. that didn't
     require upcalling to userspace is cached temporarily in task_struct.

 (2) The cache is 1 deep, so a new result displaces the old one.

 (3) The key is released by exit and by notify-resume.

 (4) The cache is cleared in a newly forked process.

Signed-off-by: default avatarDavid Howells <dhowells@redhat.com>
parent 896f1950

Documentation/security/keys/request-key.rst

+6 −1
Original line number Diff line number Diff line
@@ -176,6 +176,9 @@ The process stops immediately a valid key is found with permission granted to 
use it.  Any error from a previous match attempt is discarded and the key is

returned.



When request_key() is invoked, if CONFIG_KEYS_REQUEST_CACHE=y, a per-task

one-key cache is first checked for a match.



When search_process_keyrings() is invoked, it performs the following searches

until one succeeds:
@@ -195,7 +198,9 @@ until one succeeds: 
      c) The calling process's session keyring is searched.



The moment one succeeds, all pending errors are discarded and the found key is

returned.

returned.  If CONFIG_KEYS_REQUEST_CACHE=y, then that key is placed in the

per-task cache, displacing the previous key.  The cache is cleared on exit or

just prior to resumption of userspace.



Only if all these fail does the whole thing fail with the highest priority

error.  Note that several errors may have come from LSM.

include/linux/sched.h

+5 −0
Original line number Diff line number Diff line
@@ -831,6 +831,11 @@ struct task_struct { 
	/* Effective (overridable) subjective task credentials (COW): */

	const struct cred __rcu		*cred;



#ifdef CONFIG_KEYS

	/* Cached requested key. */

	struct key			*cached_requested_key;

#endif



	/*

	 * executable name, excluding path.

	 *

include/linux/tracehook.h

+7 −0
Original line number Diff line number Diff line
@@ -187,6 +187,13 @@ static inline void tracehook_notify_resume(struct pt_regs *regs) 
	if (unlikely(current->task_works))

		task_work_run();



#ifdef CONFIG_KEYS_REQUEST_CACHE

	if (unlikely(current->cached_requested_key)) {

		key_put(current->cached_requested_key);

		current->cached_requested_key = NULL;

	}

#endif



	mem_cgroup_handle_over_high();

	blkcg_maybe_throttle_current();

}

kernel/cred.c

+9 −0
Original line number Diff line number Diff line
@@ -174,6 +174,11 @@ void exit_creds(struct task_struct *tsk) 
	validate_creds(cred);

	alter_cred_subscribers(cred, -1);

	put_cred(cred);



#ifdef CONFIG_KEYS_REQUEST_CACHE

	key_put(current->cached_requested_key);

	current->cached_requested_key = NULL;

#endif

}



/**
@@ -327,6 +332,10 @@ int copy_creds(struct task_struct *p, unsigned long clone_flags) 
	struct cred *new;

	int ret;



#ifdef CONFIG_KEYS_REQUEST_CACHE

	p->cached_requested_key = NULL;

#endif



	if (

#ifdef CONFIG_KEYS

		!p->cred->thread_keyring &&

security/keys/Kconfig

+18 −0
Original line number Diff line number Diff line
@@ -24,6 +24,24 @@ config KEYS_COMPAT 
	def_bool y

	depends on COMPAT && KEYS



config KEYS_REQUEST_CACHE

	bool "Enable temporary caching of the last request_key() result"

	depends on KEYS

	help

	  This option causes the result of the last successful request_key()

	  call that didn't upcall to the kernel to be cached temporarily in the

	  task_struct.  The cache is cleared by exit and just prior to the

	  resumption of userspace.



	  This allows the key used for multiple step processes where each step

	  wants to request a key that is likely the same as the one requested

	  by the last step to save on the searching.



	  An example of such a process is a pathwalk through a network

	  filesystem in which each method needs to request an authentication

	  key.  Pathwalk will call multiple methods for each dentry traversed

	  (permission, d_revalidate, lookup, getxattr, getacl, ...).



config PERSISTENT_KEYRINGS

	bool "Enable register of persistent per-UID keyrings"

	depends on KEYS

CRA Git | Maintained and supported by SUSTech CRA and CCSE