Mercurial > repos > rliterman > csp2

comparison CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/include/keyutils.h @ 69:33d812a61356

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload commit 2e9511a184a1ca667c7be0c6321a36dc4e3d116d
author jpayne
date Tue, 18 Mar 2025 17:55:14 -0400
parents
children
comparison
equal deleted inserted replaced
67:0e9998148a16 69:33d812a61356
1 /* keyutils.h: key utility library interface
2 *
3 * Copyright (C) 2005,2011 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 Lesser 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 KEYUTILS_H
13 #define KEYUTILS_H
14
15 #include <sys/types.h>
16 #include <stdint.h>
17
18 extern const char keyutils_version_string[];
19 extern const char keyutils_build_string[];
20
21 /* key serial number */
22 typedef int32_t key_serial_t;
23
24 /* special process keyring shortcut IDs */
25 #define KEY_SPEC_THREAD_KEYRING -1 /* - key ID for thread-specific keyring */
26 #define KEY_SPEC_PROCESS_KEYRING -2 /* - key ID for process-specific keyring */
27 #define KEY_SPEC_SESSION_KEYRING -3 /* - key ID for session-specific keyring */
28 #define KEY_SPEC_USER_KEYRING -4 /* - key ID for UID-specific keyring */
29 #define KEY_SPEC_USER_SESSION_KEYRING -5 /* - key ID for UID-session keyring */
30 #define KEY_SPEC_GROUP_KEYRING -6 /* - key ID for GID-specific keyring */
31 #define KEY_SPEC_REQKEY_AUTH_KEY -7 /* - key ID for assumed request_key auth key */
32
33 /* request-key default keyrings */
34 #define KEY_REQKEY_DEFL_NO_CHANGE -1
35 #define KEY_REQKEY_DEFL_DEFAULT 0
36 #define KEY_REQKEY_DEFL_THREAD_KEYRING 1
37 #define KEY_REQKEY_DEFL_PROCESS_KEYRING 2
38 #define KEY_REQKEY_DEFL_SESSION_KEYRING 3
39 #define KEY_REQKEY_DEFL_USER_KEYRING 4
40 #define KEY_REQKEY_DEFL_USER_SESSION_KEYRING 5
41 #define KEY_REQKEY_DEFL_GROUP_KEYRING 6
42
43 /* key handle permissions mask */
44 typedef uint32_t key_perm_t;
45
46 #define KEY_POS_VIEW 0x01000000 /* possessor can view a key's attributes */
47 #define KEY_POS_READ 0x02000000 /* possessor can read key payload / view keyring */
48 #define KEY_POS_WRITE 0x04000000 /* possessor can update key payload / add link to keyring */
49 #define KEY_POS_SEARCH 0x08000000 /* possessor can find a key in search / search a keyring */
50 #define KEY_POS_LINK 0x10000000 /* possessor can create a link to a key/keyring */
51 #define KEY_POS_SETATTR 0x20000000 /* possessor can set key attributes */
52 #define KEY_POS_ALL 0x3f000000
53
54 #define KEY_USR_VIEW 0x00010000 /* user permissions... */
55 #define KEY_USR_READ 0x00020000
56 #define KEY_USR_WRITE 0x00040000
57 #define KEY_USR_SEARCH 0x00080000
58 #define KEY_USR_LINK 0x00100000
59 #define KEY_USR_SETATTR 0x00200000
60 #define KEY_USR_ALL 0x003f0000
61
62 #define KEY_GRP_VIEW 0x00000100 /* group permissions... */
63 #define KEY_GRP_READ 0x00000200
64 #define KEY_GRP_WRITE 0x00000400
65 #define KEY_GRP_SEARCH 0x00000800
66 #define KEY_GRP_LINK 0x00001000
67 #define KEY_GRP_SETATTR 0x00002000
68 #define KEY_GRP_ALL 0x00003f00
69
70 #define KEY_OTH_VIEW 0x00000001 /* third party permissions... */
71 #define KEY_OTH_READ 0x00000002
72 #define KEY_OTH_WRITE 0x00000004
73 #define KEY_OTH_SEARCH 0x00000008
74 #define KEY_OTH_LINK 0x00000010
75 #define KEY_OTH_SETATTR 0x00000020
76 #define KEY_OTH_ALL 0x0000003f
77
78 /* keyctl commands */
79 #define KEYCTL_GET_KEYRING_ID 0 /* ask for a keyring's ID */
80 #define KEYCTL_JOIN_SESSION_KEYRING 1 /* join or start named session keyring */
81 #define KEYCTL_UPDATE 2 /* update a key */
82 #define KEYCTL_REVOKE 3 /* revoke a key */
83 #define KEYCTL_CHOWN 4 /* set ownership of a key */
84 #define KEYCTL_SETPERM 5 /* set perms on a key */
85 #define KEYCTL_DESCRIBE 6 /* describe a key */
86 #define KEYCTL_CLEAR 7 /* clear contents of a keyring */
87 #define KEYCTL_LINK 8 /* link a key into a keyring */
88 #define KEYCTL_UNLINK 9 /* unlink a key from a keyring */
89 #define KEYCTL_SEARCH 10 /* search for a key in a keyring */
90 #define KEYCTL_READ 11 /* read a key or keyring's contents */
91 #define KEYCTL_INSTANTIATE 12 /* instantiate a partially constructed key */
92 #define KEYCTL_NEGATE 13 /* negate a partially constructed key */
93 #define KEYCTL_SET_REQKEY_KEYRING 14 /* set default request-key keyring */
94 #define KEYCTL_SET_TIMEOUT 15 /* set timeout on a key */
95 #define KEYCTL_ASSUME_AUTHORITY 16 /* assume authority to instantiate key */
96 #define KEYCTL_GET_SECURITY 17 /* get key security label */
97 #define KEYCTL_SESSION_TO_PARENT 18 /* set my session keyring on my parent process */
98 #define KEYCTL_REJECT 19 /* reject a partially constructed key */
99 #define KEYCTL_INSTANTIATE_IOV 20 /* instantiate a partially constructed key */
100 #define KEYCTL_INVALIDATE 21 /* invalidate a key */
101 #define KEYCTL_GET_PERSISTENT 22 /* get a user's persistent keyring */
102 #define KEYCTL_DH_COMPUTE 23 /* Compute Diffie-Hellman values */
103 #define KEYCTL_PKEY_QUERY 24 /* Query public key parameters */
104 #define KEYCTL_PKEY_ENCRYPT 25 /* Encrypt a blob using a public key */
105 #define KEYCTL_PKEY_DECRYPT 26 /* Decrypt a blob using a public key */
106 #define KEYCTL_PKEY_SIGN 27 /* Create a public key signature */
107 #define KEYCTL_PKEY_VERIFY 28 /* Verify a public key signature */
108 #define KEYCTL_RESTRICT_KEYRING 29 /* Restrict keys allowed to link to a keyring */
109 #define KEYCTL_MOVE 30 /* Move keys between keyrings */
110 #define KEYCTL_CAPABILITIES 31 /* Find capabilities of keyrings subsystem */
111
112 /* keyctl structures */
113 struct keyctl_dh_params {
114 key_serial_t priv;
115 key_serial_t prime;
116 key_serial_t base;
117 };
118
119 struct keyctl_kdf_params {
120 char *hashname;
121 char *otherinfo;
122 uint32_t otherinfolen;
123 uint32_t __spare[8];
124 };
125
126 #define KEYCTL_SUPPORTS_ENCRYPT 0x01
127 #define KEYCTL_SUPPORTS_DECRYPT 0x02
128 #define KEYCTL_SUPPORTS_SIGN 0x04
129 #define KEYCTL_SUPPORTS_VERIFY 0x08
130
131 struct keyctl_pkey_query {
132 unsigned int supported_ops; /* Which ops are supported */
133 unsigned int key_size; /* Size of the key in bits */
134 unsigned short max_data_size; /* Maximum size of raw data to sign in bytes */
135 unsigned short max_sig_size; /* Maximum size of signature in bytes */
136 unsigned short max_enc_size; /* Maximum size of encrypted blob in bytes */
137 unsigned short max_dec_size; /* Maximum size of decrypted blob in bytes */
138 unsigned int __spare[10];
139 };
140
141 struct keyctl_pkey_params {
142 key_serial_t key_id; /* Serial no. of public key to use */
143 unsigned int in_len; /* Input data size */
144 union {
145 unsigned int out_len; /* Output buffer size (encrypt/decrypt/sign) */
146 unsigned int in2_len; /* Second input data size (verify) */
147 };
148 unsigned int __spare[7];
149 };
150
151 #define KEYCTL_MOVE_EXCL 0x00000001 /* Do not displace from the to-keyring */
152
153 /*
154 * Capabilities flags. The capabilities list is an array of 8-bit integers;
155 * each integer can carry up to 8 flags.
156 */
157 #define KEYCTL_CAPS0_CAPABILITIES 0x01 /* KEYCTL_CAPABILITIES supported */
158 #define KEYCTL_CAPS0_PERSISTENT_KEYRINGS 0x02 /* Persistent keyrings enabled */
159 #define KEYCTL_CAPS0_DIFFIE_HELLMAN 0x04 /* Diffie-Hellman ops enabled */
160 #define KEYCTL_CAPS0_PUBLIC_KEY 0x08 /* Public key ops enabled */
161 #define KEYCTL_CAPS0_BIG_KEY 0x10 /* big_key-type enabled */
162 #define KEYCTL_CAPS0_INVALIDATE 0x20 /* KEYCTL_INVALIDATE supported */
163 #define KEYCTL_CAPS0_RESTRICT_KEYRING 0x40 /* KEYCTL_RESTRICT_KEYRING supported */
164 #define KEYCTL_CAPS0_MOVE 0x80 /* KEYCTL_MOVE supported */
165
166 /*
167 * syscall wrappers
168 */
169 extern key_serial_t add_key(const char *type,
170 const char *description,
171 const void *payload,
172 size_t plen,
173 key_serial_t ringid);
174
175 extern key_serial_t request_key(const char *type,
176 const char *description,
177 const char *callout_info,
178 key_serial_t destringid);
179
180 extern long keyctl(int cmd, ...);
181
182 /*
183 * keyctl function wrappers
184 */
185 extern key_serial_t keyctl_get_keyring_ID(key_serial_t id, int create);
186 extern key_serial_t keyctl_join_session_keyring(const char *name);
187 extern long keyctl_update(key_serial_t id, const void *payload, size_t plen);
188 extern long keyctl_revoke(key_serial_t id);
189 extern long keyctl_chown(key_serial_t id, uid_t uid, gid_t gid);
190 extern long keyctl_setperm(key_serial_t id, key_perm_t perm);
191 extern long keyctl_describe(key_serial_t id, char *buffer, size_t buflen);
192 extern long keyctl_clear(key_serial_t ringid);
193 extern long keyctl_link(key_serial_t id, key_serial_t ringid);
194 extern long keyctl_unlink(key_serial_t id, key_serial_t ringid);
195 extern long keyctl_search(key_serial_t ringid,
196 const char *type,
197 const char *description,
198 key_serial_t destringid);
199 extern long keyctl_read(key_serial_t id, char *buffer, size_t buflen);
200 extern long keyctl_instantiate(key_serial_t id,
201 const void *payload,
202 size_t plen,
203 key_serial_t ringid);
204 extern long keyctl_negate(key_serial_t id, unsigned timeout, key_serial_t ringid);
205 extern long keyctl_set_reqkey_keyring(int reqkey_defl);
206 extern long keyctl_set_timeout(key_serial_t key, unsigned timeout);
207 extern long keyctl_assume_authority(key_serial_t key);
208 extern long keyctl_get_security(key_serial_t key, char *buffer, size_t buflen);
209 extern long keyctl_session_to_parent(void);
210 extern long keyctl_reject(key_serial_t id, unsigned timeout, unsigned error,
211 key_serial_t ringid);
212 struct iovec;
213 extern long keyctl_instantiate_iov(key_serial_t id,
214 const struct iovec *payload_iov,
215 unsigned ioc,
216 key_serial_t ringid);
217 extern long keyctl_invalidate(key_serial_t id);
218 extern long keyctl_get_persistent(uid_t uid, key_serial_t id);
219 extern long keyctl_dh_compute(key_serial_t priv, key_serial_t prime,
220 key_serial_t base, char *buffer, size_t buflen);
221 extern long keyctl_dh_compute_kdf(key_serial_t private, key_serial_t prime,
222 key_serial_t base, char *hashname,
223 char *otherinfo, size_t otherinfolen,
224 char *buffer, size_t buflen);
225 extern long keyctl_restrict_keyring(key_serial_t keyring, const char *type,
226 const char *restriction);
227
228 extern long keyctl_pkey_query(key_serial_t key_id,
229 const char *info,
230 struct keyctl_pkey_query *result);
231 extern long keyctl_pkey_encrypt(key_serial_t key_id,
232 const char *info,
233 const void *data, size_t data_len,
234 void *enc, size_t enc_len);
235 extern long keyctl_pkey_decrypt(key_serial_t key_id,
236 const char *info,
237 const void *enc, size_t enc_len,
238 void *data, size_t data_len);
239 extern long keyctl_pkey_sign(key_serial_t key_id,
240 const char *info,
241 const void *data, size_t data_len,
242 void *sig, size_t sig_len);
243 extern long keyctl_pkey_verify(key_serial_t key_id,
244 const char *info,
245 const void *data, size_t data_len,
246 const void *sig, size_t sig_len);
247 extern long keyctl_move(key_serial_t id,
248 key_serial_t from_ringid,
249 key_serial_t to_ringid,
250 unsigned int flags);
251 extern long keyctl_capabilities(unsigned char *buffer, size_t buflen);
252
253 /*
254 * utilities
255 */
256 extern int keyctl_describe_alloc(key_serial_t id, char **_buffer);
257 extern int keyctl_read_alloc(key_serial_t id, void **_buffer);
258 extern int keyctl_get_security_alloc(key_serial_t id, char **_buffer);
259 extern int keyctl_dh_compute_alloc(key_serial_t priv, key_serial_t prime,
260 key_serial_t base, void **_buffer);
261
262 typedef int (*recursive_key_scanner_t)(key_serial_t parent, key_serial_t key,
263 char *desc, int desc_len, void *data);
264 extern int recursive_key_scan(key_serial_t key, recursive_key_scanner_t func, void *data);
265 extern int recursive_session_key_scan(recursive_key_scanner_t func, void *data);
266 extern key_serial_t find_key_by_type_and_desc(const char *type, const char *desc,
267 key_serial_t destringid);
268
269 #endif /* KEYUTILS_H */