Loading...
1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/* Asymmetric public-key algorithm definitions
3 *
4 * See Documentation/crypto/asymmetric-keys.rst
5 *
6 * Copyright (C) 2012 Red Hat, Inc. All Rights Reserved.
7 * Written by David Howells (dhowells@redhat.com)
8 */
9
10#ifndef _LINUX_PUBLIC_KEY_H
11#define _LINUX_PUBLIC_KEY_H
12
13#include <linux/errno.h>
14#include <linux/keyctl.h>
15#include <linux/oid_registry.h>
16
17/*
18 * Cryptographic data for the public-key subtype of the asymmetric key type.
19 *
20 * Note that this may include private part of the key as well as the public
21 * part.
22 */
23struct public_key {
24 void *key;
25 u32 keylen;
26 enum OID algo;
27 void *params;
28 u32 paramlen;
29 bool key_is_private;
30 const char *id_type;
31 const char *pkey_algo;
32 unsigned long key_eflags; /* key extension flags */
33#define KEY_EFLAG_CA 0 /* set if the CA basic constraints is set */
34#define KEY_EFLAG_DIGITALSIG 1 /* set if the digitalSignature usage is set */
35#define KEY_EFLAG_KEYCERTSIGN 2 /* set if the keyCertSign usage is set */
36};
37
38extern void public_key_free(struct public_key *key);
39
40/*
41 * Public key cryptography signature data
42 */
43struct public_key_signature {
44 struct asymmetric_key_id *auth_ids[3];
45 u8 *s; /* Signature */
46 u8 *digest;
47 u32 s_size; /* Number of bytes in signature */
48 u32 digest_size; /* Number of bytes in digest */
49 const char *pkey_algo;
50 const char *hash_algo;
51 const char *encoding;
52};
53
54extern void public_key_signature_free(struct public_key_signature *sig);
55
56extern struct asymmetric_key_subtype public_key_subtype;
57
58struct key;
59struct key_type;
60union key_payload;
61
62extern int restrict_link_by_signature(struct key *dest_keyring,
63 const struct key_type *type,
64 const union key_payload *payload,
65 struct key *trust_keyring);
66
67extern int restrict_link_by_key_or_keyring(struct key *dest_keyring,
68 const struct key_type *type,
69 const union key_payload *payload,
70 struct key *trusted);
71
72extern int restrict_link_by_key_or_keyring_chain(struct key *trust_keyring,
73 const struct key_type *type,
74 const union key_payload *payload,
75 struct key *trusted);
76
77#if IS_REACHABLE(CONFIG_ASYMMETRIC_KEY_TYPE)
78extern int restrict_link_by_ca(struct key *dest_keyring,
79 const struct key_type *type,
80 const union key_payload *payload,
81 struct key *trust_keyring);
82int restrict_link_by_digsig(struct key *dest_keyring,
83 const struct key_type *type,
84 const union key_payload *payload,
85 struct key *trust_keyring);
86#else
87static inline int restrict_link_by_ca(struct key *dest_keyring,
88 const struct key_type *type,
89 const union key_payload *payload,
90 struct key *trust_keyring)
91{
92 return 0;
93}
94
95static inline int restrict_link_by_digsig(struct key *dest_keyring,
96 const struct key_type *type,
97 const union key_payload *payload,
98 struct key *trust_keyring)
99{
100 return 0;
101}
102#endif
103
104extern int query_asymmetric_key(const struct kernel_pkey_params *,
105 struct kernel_pkey_query *);
106
107extern int verify_signature(const struct key *,
108 const struct public_key_signature *);
109
110#if IS_REACHABLE(CONFIG_ASYMMETRIC_PUBLIC_KEY_SUBTYPE)
111int public_key_verify_signature(const struct public_key *pkey,
112 const struct public_key_signature *sig);
113#else
114static inline
115int public_key_verify_signature(const struct public_key *pkey,
116 const struct public_key_signature *sig)
117{
118 return -EINVAL;
119}
120#endif
121
122#endif /* _LINUX_PUBLIC_KEY_H */
1/* Asymmetric public-key algorithm definitions
2 *
3 * See Documentation/crypto/asymmetric-keys.txt
4 *
5 * Copyright (C) 2012 Red Hat, Inc. All Rights Reserved.
6 * Written by David Howells (dhowells@redhat.com)
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public Licence
10 * as published by the Free Software Foundation; either version
11 * 2 of the Licence, or (at your option) any later version.
12 */
13
14#ifndef _LINUX_PUBLIC_KEY_H
15#define _LINUX_PUBLIC_KEY_H
16
17#include <linux/mpi.h>
18#include <crypto/hash_info.h>
19
20enum pkey_algo {
21 PKEY_ALGO_DSA,
22 PKEY_ALGO_RSA,
23 PKEY_ALGO__LAST
24};
25
26extern const char *const pkey_algo_name[PKEY_ALGO__LAST];
27extern const struct public_key_algorithm *pkey_algo[PKEY_ALGO__LAST];
28
29/* asymmetric key implementation supports only up to SHA224 */
30#define PKEY_HASH__LAST (HASH_ALGO_SHA224 + 1)
31
32enum pkey_id_type {
33 PKEY_ID_PGP, /* OpenPGP generated key ID */
34 PKEY_ID_X509, /* X.509 arbitrary subjectKeyIdentifier */
35 PKEY_ID_TYPE__LAST
36};
37
38extern const char *const pkey_id_type_name[PKEY_ID_TYPE__LAST];
39
40/*
41 * Cryptographic data for the public-key subtype of the asymmetric key type.
42 *
43 * Note that this may include private part of the key as well as the public
44 * part.
45 */
46struct public_key {
47 const struct public_key_algorithm *algo;
48 u8 capabilities;
49#define PKEY_CAN_ENCRYPT 0x01
50#define PKEY_CAN_DECRYPT 0x02
51#define PKEY_CAN_SIGN 0x04
52#define PKEY_CAN_VERIFY 0x08
53 enum pkey_algo pkey_algo : 8;
54 enum pkey_id_type id_type : 8;
55 union {
56 MPI mpi[5];
57 struct {
58 MPI p; /* DSA prime */
59 MPI q; /* DSA group order */
60 MPI g; /* DSA group generator */
61 MPI y; /* DSA public-key value = g^x mod p */
62 MPI x; /* DSA secret exponent (if present) */
63 } dsa;
64 struct {
65 MPI n; /* RSA public modulus */
66 MPI e; /* RSA public encryption exponent */
67 MPI d; /* RSA secret encryption exponent (if present) */
68 MPI p; /* RSA secret prime (if present) */
69 MPI q; /* RSA secret prime (if present) */
70 } rsa;
71 };
72};
73
74extern void public_key_destroy(void *payload);
75
76/*
77 * Public key cryptography signature data
78 */
79struct public_key_signature {
80 u8 *digest;
81 u8 digest_size; /* Number of bytes in digest */
82 u8 nr_mpi; /* Occupancy of mpi[] */
83 enum pkey_algo pkey_algo : 8;
84 enum hash_algo pkey_hash_algo : 8;
85 union {
86 MPI mpi[2];
87 struct {
88 MPI s; /* m^d mod n */
89 } rsa;
90 struct {
91 MPI r;
92 MPI s;
93 } dsa;
94 };
95};
96
97struct key;
98extern int verify_signature(const struct key *key,
99 const struct public_key_signature *sig);
100
101#endif /* _LINUX_PUBLIC_KEY_H */