Mercurial > repos > rliterman > csp2

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