[linux-block.git] / include / uapi / linux / keyctl.h

/* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
/* keyctl.h: keyctl command IDs
 *
 * Copyright (C) 2004, 2008 Red Hat, Inc. All Rights Reserved.
 * Written by David Howells (dhowells@redhat.com)
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version
 * 2 of the License, or (at your option) any later version.
 */

#ifndef _LINUX_KEYCTL_H
#define _LINUX_KEYCTL_H

#include <linux/types.h>

/* special process keyring shortcut IDs */
#define KEY_SPEC_THREAD_KEYRING		-1	/* - key ID for thread-specific keyring */
#define KEY_SPEC_PROCESS_KEYRING	-2	/* - key ID for process-specific keyring */
#define KEY_SPEC_SESSION_KEYRING	-3	/* - key ID for session-specific keyring */
#define KEY_SPEC_USER_KEYRING		-4	/* - key ID for UID-specific keyring */
#define KEY_SPEC_USER_SESSION_KEYRING	-5	/* - key ID for UID-session keyring */
#define KEY_SPEC_GROUP_KEYRING		-6	/* - key ID for GID-specific keyring */
#define KEY_SPEC_REQKEY_AUTH_KEY	-7	/* - key ID for assumed request_key auth key */
#define KEY_SPEC_REQUESTOR_KEYRING	-8	/* - key ID for request_key() dest keyring */

/* request-key default keyrings */
#define KEY_REQKEY_DEFL_NO_CHANGE		-1
#define KEY_REQKEY_DEFL_DEFAULT			0
#define KEY_REQKEY_DEFL_THREAD_KEYRING		1
#define KEY_REQKEY_DEFL_PROCESS_KEYRING		2
#define KEY_REQKEY_DEFL_SESSION_KEYRING		3
#define KEY_REQKEY_DEFL_USER_KEYRING		4
#define KEY_REQKEY_DEFL_USER_SESSION_KEYRING	5
#define KEY_REQKEY_DEFL_GROUP_KEYRING		6
#define KEY_REQKEY_DEFL_REQUESTOR_KEYRING	7

/* keyctl commands */
#define KEYCTL_GET_KEYRING_ID		0	/* ask for a keyring's ID */
#define KEYCTL_JOIN_SESSION_KEYRING	1	/* join or start named session keyring */
#define KEYCTL_UPDATE			2	/* update a key */
#define KEYCTL_REVOKE			3	/* revoke a key */
#define KEYCTL_CHOWN			4	/* set ownership of a key */
#define KEYCTL_SETPERM			5	/* set perms on a key */
#define KEYCTL_DESCRIBE			6	/* describe a key */
#define KEYCTL_CLEAR			7	/* clear contents of a keyring */
#define KEYCTL_LINK			8	/* link a key into a keyring */
#define KEYCTL_UNLINK			9	/* unlink a key from a keyring */
#define KEYCTL_SEARCH			10	/* search for a key in a keyring */
#define KEYCTL_READ			11	/* read a key or keyring's contents */
#define KEYCTL_INSTANTIATE		12	/* instantiate a partially constructed key */
#define KEYCTL_NEGATE			13	/* negate a partially constructed key */
#define KEYCTL_SET_REQKEY_KEYRING	14	/* set default request-key keyring */
#define KEYCTL_SET_TIMEOUT		15	/* set key timeout */
#define KEYCTL_ASSUME_AUTHORITY		16	/* assume request_key() authorisation */
#define KEYCTL_GET_SECURITY		17	/* get key security label */
#define KEYCTL_SESSION_TO_PARENT	18	/* apply session keyring to parent process */
#define KEYCTL_REJECT			19	/* reject a partially constructed key */
#define KEYCTL_INSTANTIATE_IOV		20	/* instantiate a partially constructed key */
#define KEYCTL_INVALIDATE		21	/* invalidate a key */
#define KEYCTL_GET_PERSISTENT		22	/* get a user's persistent keyring */
#define KEYCTL_DH_COMPUTE		23	/* Compute Diffie-Hellman values */
#define KEYCTL_PKEY_QUERY		24	/* Query public key parameters */
#define KEYCTL_PKEY_ENCRYPT		25	/* Encrypt a blob using a public key */
#define KEYCTL_PKEY_DECRYPT		26	/* Decrypt a blob using a public key */
#define KEYCTL_PKEY_SIGN		27	/* Create a public key signature */
#define KEYCTL_PKEY_VERIFY		28	/* Verify a public key signature */
#define KEYCTL_RESTRICT_KEYRING		29	/* Restrict keys allowed to link to a keyring */
#define KEYCTL_MOVE			30	/* Move keys between keyrings */
#define KEYCTL_CAPABILITIES		31	/* Find capabilities of keyrings subsystem */

/* keyctl structures */
struct keyctl_dh_params {
	union {
#ifndef __cplusplus
		__s32 private;
#endif
		__s32 priv;
	};
	__s32 prime;
	__s32 base;
};

struct keyctl_kdf_params {
	char __user *hashname;
	char __user *otherinfo;
	__u32 otherinfolen;
	__u32 __spare[8];
};

#define KEYCTL_SUPPORTS_ENCRYPT		0x01
#define KEYCTL_SUPPORTS_DECRYPT		0x02
#define KEYCTL_SUPPORTS_SIGN		0x04
#define KEYCTL_SUPPORTS_VERIFY		0x08

struct keyctl_pkey_query {
	__u32		supported_ops;	/* Which ops are supported */
	__u32		key_size;	/* Size of the key in bits */
	__u16		max_data_size;	/* Maximum size of raw data to sign in bytes */
	__u16		max_sig_size;	/* Maximum size of signature in bytes */
	__u16		max_enc_size;	/* Maximum size of encrypted blob in bytes */
	__u16		max_dec_size;	/* Maximum size of decrypted blob in bytes */
	__u32		__spare[10];
};

struct keyctl_pkey_params {
	__s32		key_id;		/* Serial no. of public key to use */
	__u32		in_len;		/* Input data size */
	union {
		__u32		out_len;	/* Output buffer size (encrypt/decrypt/sign) */
		__u32		in2_len;	/* 2nd input data size (verify) */
	};
	__u32		__spare[7];
};

#define KEYCTL_MOVE_EXCL	0x00000001 /* Do not displace from the to-keyring */

/*
 * Capabilities flags.  The capabilities list is an array of 8-bit integers;
 * each integer can carry up to 8 flags.
 */
#define KEYCTL_CAPS0_CAPABILITIES	0x01 /* KEYCTL_CAPABILITIES supported */
#define KEYCTL_CAPS0_PERSISTENT_KEYRINGS 0x02 /* Persistent keyrings enabled */
#define KEYCTL_CAPS0_DIFFIE_HELLMAN	0x04 /* Diffie-Hellman computation enabled */
#define KEYCTL_CAPS0_PUBLIC_KEY		0x08 /* Public key ops enabled */
#define KEYCTL_CAPS0_BIG_KEY		0x10 /* big_key-type enabled */
#define KEYCTL_CAPS0_INVALIDATE		0x20 /* KEYCTL_INVALIDATE supported */
#define KEYCTL_CAPS0_RESTRICT_KEYRING	0x40 /* KEYCTL_RESTRICT_KEYRING supported */
#define KEYCTL_CAPS0_MOVE		0x80 /* KEYCTL_MOVE supported */
#define KEYCTL_CAPS1_NS_KEYRING_NAME	0x01 /* Keyring names are per-user_namespace */
#define KEYCTL_CAPS1_NS_KEY_TAG		0x02 /* Key indexing can include a namespace tag */

#endif /*  _LINUX_KEYCTL_H */
Commit	Line	Data
e2be04c7	1	/* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
1da177e4 LT	2	/* keyctl.h: keyctl command IDs
1da177e4 LT	3	*
8bbf4976	4	* Copyright (C) 2004, 2008 Red Hat, Inc. All Rights Reserved.
1da177e4 LT	5	* Written by David Howells (dhowells@redhat.com)
	6	*
	7	* This program is free software; you can redistribute it and/or
	8	* modify it under the terms of the GNU General Public License
	9	* as published by the Free Software Foundation; either version
	10	* 2 of the License, or (at your option) any later version.
	11	*/
	12
	13	#ifndef _LINUX_KEYCTL_H
	14	#define _LINUX_KEYCTL_H
	15
ddbb4114 MM	16	#include <linux/types.h>
ddbb4114 MM	17
1da177e4 LT	18	/* special process keyring shortcut IDs */
	19	#define KEY_SPEC_THREAD_KEYRING -1 /* - key ID for thread-specific keyring */
	20	#define KEY_SPEC_PROCESS_KEYRING -2 /* - key ID for process-specific keyring */
	21	#define KEY_SPEC_SESSION_KEYRING -3 /* - key ID for session-specific keyring */
	22	#define KEY_SPEC_USER_KEYRING -4 /* - key ID for UID-specific keyring */
	23	#define KEY_SPEC_USER_SESSION_KEYRING -5 /* - key ID for UID-session keyring */
	24	#define KEY_SPEC_GROUP_KEYRING -6 /* - key ID for GID-specific keyring */
b5f545c8	25	#define KEY_SPEC_REQKEY_AUTH_KEY -7 /* - key ID for assumed request_key auth key */
8bbf4976	26	#define KEY_SPEC_REQUESTOR_KEYRING -8 /* - key ID for request_key() dest keyring */
1da177e4	27
3e30148c DH	28	/* request-key default keyrings */
	29	#define KEY_REQKEY_DEFL_NO_CHANGE -1
	30	#define KEY_REQKEY_DEFL_DEFAULT 0
	31	#define KEY_REQKEY_DEFL_THREAD_KEYRING 1
	32	#define KEY_REQKEY_DEFL_PROCESS_KEYRING 2
	33	#define KEY_REQKEY_DEFL_SESSION_KEYRING 3
	34	#define KEY_REQKEY_DEFL_USER_KEYRING 4
	35	#define KEY_REQKEY_DEFL_USER_SESSION_KEYRING 5
	36	#define KEY_REQKEY_DEFL_GROUP_KEYRING 6
8bbf4976	37	#define KEY_REQKEY_DEFL_REQUESTOR_KEYRING 7
3e30148c	38
1da177e4 LT	39	/* keyctl commands */
	40	#define KEYCTL_GET_KEYRING_ID 0 /* ask for a keyring's ID */
	41	#define KEYCTL_JOIN_SESSION_KEYRING 1 /* join or start named session keyring */
	42	#define KEYCTL_UPDATE 2 /* update a key */
	43	#define KEYCTL_REVOKE 3 /* revoke a key */
	44	#define KEYCTL_CHOWN 4 /* set ownership of a key */
	45	#define KEYCTL_SETPERM 5 /* set perms on a key */
	46	#define KEYCTL_DESCRIBE 6 /* describe a key */
	47	#define KEYCTL_CLEAR 7 /* clear contents of a keyring */
	48	#define KEYCTL_LINK 8 /* link a key into a keyring */
	49	#define KEYCTL_UNLINK 9 /* unlink a key from a keyring */
	50	#define KEYCTL_SEARCH 10 /* search for a key in a keyring */
	51	#define KEYCTL_READ 11 /* read a key or keyring's contents */
	52	#define KEYCTL_INSTANTIATE 12 /* instantiate a partially constructed key */
	53	#define KEYCTL_NEGATE 13 /* negate a partially constructed key */
3e30148c	54	#define KEYCTL_SET_REQKEY_KEYRING 14 /* set default request-key keyring */
017679c4	55	#define KEYCTL_SET_TIMEOUT 15 /* set key timeout */
b5f545c8	56	#define KEYCTL_ASSUME_AUTHORITY 16 /* assume request_key() authorisation */
70a5bb72	57	#define KEYCTL_GET_SECURITY 17 /* get key security label */
ee18d64c	58	#define KEYCTL_SESSION_TO_PARENT 18 /* apply session keyring to parent process */
fdd1b945	59	#define KEYCTL_REJECT 19 /* reject a partially constructed key */
ee009e4a	60	#define KEYCTL_INSTANTIATE_IOV 20 /* instantiate a partially constructed key */
fd75815f	61	#define KEYCTL_INVALIDATE 21 /* invalidate a key */
f36f8c75	62	#define KEYCTL_GET_PERSISTENT 22 /* get a user's persistent keyring */
ddbb4114	63	#define KEYCTL_DH_COMPUTE 23 /* Compute Diffie-Hellman values */
00d60fd3 DH	64	#define KEYCTL_PKEY_QUERY 24 /* Query public key parameters */
	65	#define KEYCTL_PKEY_ENCRYPT 25 /* Encrypt a blob using a public key */
	66	#define KEYCTL_PKEY_DECRYPT 26 /* Decrypt a blob using a public key */
	67	#define KEYCTL_PKEY_SIGN 27 /* Create a public key signature */
	68	#define KEYCTL_PKEY_VERIFY 28 /* Verify a public key signature */
6563c91f	69	#define KEYCTL_RESTRICT_KEYRING 29 /* Restrict keys allowed to link to a keyring */
ed0ac5c7	70	#define KEYCTL_MOVE 30 /* Move keys between keyrings */
45e0f30c	71	#define KEYCTL_CAPABILITIES 31 /* Find capabilities of keyrings subsystem */
ddbb4114 MM	72
	73	/* keyctl structures */
	74	struct keyctl_dh_params {
2ecefa0a DH	75	union {
	76	#ifndef __cplusplus
	77	__s32 private;
	78	#endif
	79	__s32 priv;
	80	};
ddbb4114 MM	81	__s32 prime;
	82	__s32 base;
	83	};
1da177e4	84
f1c316a3	85	struct keyctl_kdf_params {
a7739544 EB	86	char __user *hashname;
a7739544 EB	87	char __user *otherinfo;
f1c316a3 SM	88	__u32 otherinfolen;
	89	__u32 __spare[8];
	90	};
	91
70025f84 DH	92	#define KEYCTL_SUPPORTS_ENCRYPT 0x01
	93	#define KEYCTL_SUPPORTS_DECRYPT 0x02
	94	#define KEYCTL_SUPPORTS_SIGN 0x04
	95	#define KEYCTL_SUPPORTS_VERIFY 0x08
	96
00d60fd3 DH	97	struct keyctl_pkey_query {
	98	__u32 supported_ops; /* Which ops are supported */
	99	__u32 key_size; /* Size of the key in bits */
	100	__u16 max_data_size; /* Maximum size of raw data to sign in bytes */
	101	__u16 max_sig_size; /* Maximum size of signature in bytes */
	102	__u16 max_enc_size; /* Maximum size of encrypted blob in bytes */
	103	__u16 max_dec_size; /* Maximum size of decrypted blob in bytes */
	104	__u32 __spare[10];
	105	};
	106
	107	struct keyctl_pkey_params {
	108	__s32 key_id; /* Serial no. of public key to use */
	109	__u32 in_len; /* Input data size */
	110	union {
	111	__u32 out_len; /* Output buffer size (encrypt/decrypt/sign) */
	112	__u32 in2_len; /* 2nd input data size (verify) */
	113	};
	114	__u32 __spare[7];
	115	};
	116
ed0ac5c7 DH	117	#define KEYCTL_MOVE_EXCL 0x00000001 /* Do not displace from the to-keyring */
ed0ac5c7 DH	118
45e0f30c DH	119	/*
	120	* Capabilities flags. The capabilities list is an array of 8-bit integers;
	121	* each integer can carry up to 8 flags.
	122	*/
	123	#define KEYCTL_CAPS0_CAPABILITIES 0x01 /* KEYCTL_CAPABILITIES supported */
	124	#define KEYCTL_CAPS0_PERSISTENT_KEYRINGS 0x02 /* Persistent keyrings enabled */
	125	#define KEYCTL_CAPS0_DIFFIE_HELLMAN 0x04 /* Diffie-Hellman computation enabled */
	126	#define KEYCTL_CAPS0_PUBLIC_KEY 0x08 /* Public key ops enabled */
	127	#define KEYCTL_CAPS0_BIG_KEY 0x10 /* big_key-type enabled */
	128	#define KEYCTL_CAPS0_INVALIDATE 0x20 /* KEYCTL_INVALIDATE supported */
	129	#define KEYCTL_CAPS0_RESTRICT_KEYRING 0x40 /* KEYCTL_RESTRICT_KEYRING supported */
	130	#define KEYCTL_CAPS0_MOVE 0x80 /* KEYCTL_MOVE supported */
b206f281	131	#define KEYCTL_CAPS1_NS_KEYRING_NAME 0x01 /* Keyring names are per-user_namespace */
3b6e4de0	132	#define KEYCTL_CAPS1_NS_KEY_TAG 0x02 /* Key indexing can include a namespace tag */
45e0f30c	133
1da177e4	134	#endif /* _LINUX_KEYCTL_H */