summaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorEric Biggers <ebiggers@google.com>2017-11-15 16:38:44 +0000
committerDavid Howells <dhowells@redhat.com>2017-11-15 16:38:44 +0000
commitbe543dd626c0a23829e9cc1a28e1e3af4cd9ced6 (patch)
tree7d0a0f99d87697d67565fdf8daafe415a28b62a2 /Documentation
parent37cb8e1f8e10c6e9bd2a1b95cdda0620a21b0551 (diff)
downloadlinux-be543dd626c0a23829e9cc1a28e1e3af4cd9ced6.tar.gz
linux-be543dd626c0a23829e9cc1a28e1e3af4cd9ced6.tar.bz2
linux-be543dd626c0a23829e9cc1a28e1e3af4cd9ced6.zip
KEYS: fix in-kernel documentation for keyctl_read()
When keyctl_read() is passed a buffer that is too small, the behavior is inconsistent. Some key types will fill as much of the buffer as possible, while others won't copy anything. Moreover, the in-kernel documentation contradicted the man page on this point. Update the in-kernel documentation to say that this point is unspecified. Signed-off-by: Eric Biggers <ebiggers@google.com> Signed-off-by: David Howells <dhowells@redhat.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/security/keys/core.rst10
1 files changed, 5 insertions, 5 deletions
diff --git a/Documentation/security/keys/core.rst b/Documentation/security/keys/core.rst
index 1266eeae45f6..9ce7256c6edb 100644
--- a/Documentation/security/keys/core.rst
+++ b/Documentation/security/keys/core.rst
@@ -628,12 +628,12 @@ The keyctl syscall functions are:
defined key type will return its data as is. If a key type does not
implement this function, error EOPNOTSUPP will result.
- As much of the data as can be fitted into the buffer will be copied to
- userspace if the buffer pointer is not NULL.
-
- On a successful return, the function will always return the amount of data
- available rather than the amount copied.
+ If the specified buffer is too small, then the size of the buffer required
+ will be returned. Note that in this case, the contents of the buffer may
+ have been overwritten in some undefined way.
+ Otherwise, on success, the function will return the amount of data copied
+ into the buffer.
* Instantiate a partially constructed key::