Linux 4.6-rc6
[cris-mirror.git] / include / keys / user-type.h
blobc56fef40f53efa474a57303f46f773863e2fa4b9
1 /* user-type.h: User-defined key type
3 * Copyright (C) 2005 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
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.
12 #ifndef _KEYS_USER_TYPE_H
13 #define _KEYS_USER_TYPE_H
15 #include <linux/key.h>
16 #include <linux/rcupdate.h>
18 #ifdef CONFIG_KEYS
20 /*****************************************************************************/
22 * the payload for a key of type "user" or "logon"
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
31 struct user_key_payload {
32 struct rcu_head rcu; /* RCU destructor */
33 unsigned short datalen; /* length of this data */
34 char data[0]; /* actual data */
37 extern struct key_type key_type_user;
38 extern struct key_type key_type_logon;
40 struct key_preparsed_payload;
42 extern int user_preparse(struct key_preparsed_payload *prep);
43 extern void user_free_preparse(struct key_preparsed_payload *prep);
44 extern int user_update(struct key *key, struct key_preparsed_payload *prep);
45 extern void user_revoke(struct key *key);
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);
51 static inline const struct user_key_payload *user_key_payload(const struct key *key)
53 return (struct user_key_payload *)rcu_dereference_key(key);
56 #endif /* CONFIG_KEYS */
58 #endif /* _KEYS_USER_TYPE_H */