LSM: fix documentation for the socket_getpeersec_dgram hook
authorDenis Efremov <efremov@ispras.ru>
Tue, 26 Feb 2019 20:49:06 +0000 (23:49 +0300)
committerJames Morris <james.morris@microsoft.com>
Tue, 26 Mar 2019 23:43:23 +0000 (16:43 -0700)
The socket_getpeersec_dgram hook was changed in the commit
"[AF_UNIX]: Kernel memory leak fix for af_unix datagram
getpeersec patch" (dc49c1f94e34). The arguments @secdata
and @seclen were changed to @sock and @secid. This patch
updates the documentation accordingly.

Signed-off-by: Denis Efremov <efremov@ispras.ru>
Acked-by: Kees Cook <keescook@chromium.org>
Acked-by: Casey Schaufler <casey@schaufler-ca.com>
Signed-off-by: James Morris <james.morris@microsoft.com>
include/linux/lsm_hooks.h

index 866aa62..69b1209 100644 (file)
  * @socket_getpeersec_dgram:
  *     This hook allows the security module to provide peer socket security
  *     state for udp sockets on a per-packet basis to userspace via
- *     getsockopt SO_GETPEERSEC.  The application must first have indicated
- *     the IP_PASSSEC option via getsockopt.  It can then retrieve the
+ *     getsockopt SO_GETPEERSEC. The application must first have indicated
+ *     the IP_PASSSEC option via getsockopt. It can then retrieve the
  *     security state returned by this hook for a packet via the SCM_SECURITY
  *     ancillary message type.
- *     @skb is the skbuff for the packet being queried
- *     @secdata is a pointer to a buffer in which to copy the security data
- *     @seclen is the maximum length for @secdata
+ *     @sock contains the peer socket. May be NULL.
+ *     @skb is the sk_buff for the packet being queried. May be NULL.
+ *     @secid pointer to store the secid of the packet.
  *     Return 0 on success, error on failure.
  * @sk_alloc_security:
  *     Allocate and attach a security structure to the sk->sk_security field,