David Howells | 2aa349f | 2005-10-30 15:02:42 -0800 | [diff] [blame] | 1 | /* user-type.h: User-defined key type |
| 2 | * |
| 3 | * Copyright (C) 2005 Red Hat, Inc. All Rights Reserved. |
| 4 | * Written by David Howells (dhowells@redhat.com) |
| 5 | * |
| 6 | * This program is free software; you can redistribute it and/or |
| 7 | * modify it under the terms of the GNU General Public License |
| 8 | * as published by the Free Software Foundation; either version |
| 9 | * 2 of the License, or (at your option) any later version. |
| 10 | */ |
| 11 | |
| 12 | #ifndef _KEYS_USER_TYPE_H |
| 13 | #define _KEYS_USER_TYPE_H |
| 14 | |
| 15 | #include <linux/key.h> |
| 16 | #include <linux/rcupdate.h> |
| 17 | |
David Howells | 146aa8b | 2015-10-21 14:04:48 +0100 | [diff] [blame] | 18 | #ifdef CONFIG_KEYS |
| 19 | |
David Howells | 2aa349f | 2005-10-30 15:02:42 -0800 | [diff] [blame] | 20 | /*****************************************************************************/ |
| 21 | /* |
Jeff Layton | 9f6ed2c | 2012-01-17 16:09:11 -0500 | [diff] [blame] | 22 | * the payload for a key of type "user" or "logon" |
David Howells | 2aa349f | 2005-10-30 15:02:42 -0800 | [diff] [blame] | 23 | * - once filled in and attached to a key: |
| 24 | * - the payload struct is invariant may not be changed, only replaced |
| 25 | * - the payload must be read with RCU procedures or with the key semaphore |
| 26 | * held |
| 27 | * - the payload may only be replaced with the key semaphore write-locked |
| 28 | * - the key's data length is the size of the actual data, not including the |
| 29 | * payload wrapper |
| 30 | */ |
| 31 | struct user_key_payload { |
| 32 | struct rcu_head rcu; /* RCU destructor */ |
| 33 | unsigned short datalen; /* length of this data */ |
Eric Biggers | acf476e | 2019-02-20 13:32:11 +0000 | [diff] [blame] | 34 | char data[0] __aligned(__alignof__(u64)); /* actual data */ |
David Howells | 2aa349f | 2005-10-30 15:02:42 -0800 | [diff] [blame] | 35 | }; |
| 36 | |
| 37 | extern struct key_type key_type_user; |
Jeff Layton | 9f6ed2c | 2012-01-17 16:09:11 -0500 | [diff] [blame] | 38 | extern struct key_type key_type_logon; |
David Howells | 2aa349f | 2005-10-30 15:02:42 -0800 | [diff] [blame] | 39 | |
David Howells | cf7f601 | 2012-09-13 13:06:29 +0100 | [diff] [blame] | 40 | struct key_preparsed_payload; |
| 41 | |
David Howells | f916778 | 2014-07-18 18:56:35 +0100 | [diff] [blame] | 42 | extern int user_preparse(struct key_preparsed_payload *prep); |
| 43 | extern void user_free_preparse(struct key_preparsed_payload *prep); |
David Howells | cf7f601 | 2012-09-13 13:06:29 +0100 | [diff] [blame] | 44 | extern int user_update(struct key *key, struct key_preparsed_payload *prep); |
David Howells | 31204ed | 2006-06-26 00:24:51 -0700 | [diff] [blame] | 45 | extern void user_revoke(struct key *key); |
David Howells | 2aa349f | 2005-10-30 15:02:42 -0800 | [diff] [blame] | 46 | extern void user_destroy(struct key *key); |
| 47 | extern void user_describe(const struct key *user, struct seq_file *m); |
| 48 | extern long user_read(const struct key *key, |
| 49 | char __user *buffer, size_t buflen); |
| 50 | |
Hyojun Kim | 63da420 | 2017-10-06 17:10:08 -0700 | [diff] [blame] | 51 | static inline const struct user_key_payload *user_key_payload_rcu(const struct key *key) |
David Howells | 146aa8b | 2015-10-21 14:04:48 +0100 | [diff] [blame] | 52 | { |
Hyojun Kim | 63da420 | 2017-10-06 17:10:08 -0700 | [diff] [blame] | 53 | return (struct user_key_payload *)dereference_key_rcu(key); |
| 54 | } |
| 55 | |
| 56 | static inline struct user_key_payload *user_key_payload_locked(const struct key *key) |
| 57 | { |
| 58 | return (struct user_key_payload *)dereference_key_locked((struct key *)key); |
David Howells | 146aa8b | 2015-10-21 14:04:48 +0100 | [diff] [blame] | 59 | } |
| 60 | |
| 61 | #endif /* CONFIG_KEYS */ |
David Howells | 2aa349f | 2005-10-30 15:02:42 -0800 | [diff] [blame] | 62 | |
| 63 | #endif /* _KEYS_USER_TYPE_H */ |