rsa.h
Go to the documentation of this file.
1 /**
2  * @file rsa.h
3  * @brief RSA public-key cryptography standard
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2025 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneCRYPTO Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 2.5.4
29  **/
30 
31 #ifndef _RSA_H
32 #define _RSA_H
33 
34 //Dependencies
35 #include "core/crypto.h"
36 #include "hash/hash_algorithms.h"
37 #include "mpi/mpi.h"
38 
39 //Maximum acceptable size for RSA modulus
40 #ifndef RSA_MAX_MODULUS_SIZE
41  #define RSA_MAX_MODULUS_SIZE 4096
42 #elif (RSA_MAX_MODULUS_SIZE < 0)
43  #error RSA_MAX_MODULUS_SIZE parameter is not valid
44 #endif
45 
46 //C++ guard
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50 
51 
52 /**
53  * @brief RSA public key
54  **/
55 
56 typedef struct
57 {
58  Mpi n; ///<Modulus
59  Mpi e; ///<Public exponent
60 } RsaPublicKey;
61 
62 
63 /**
64  * @brief RSA private key
65  **/
66 
67 typedef struct
68 {
69  Mpi n; ///<Modulus
70  Mpi e; ///<Public exponent
71  Mpi d; ///<Private exponent
72  Mpi p; ///<First factor
73  Mpi q; ///<Second factor
74  Mpi dp; ///<First factor's CRT exponent
75  Mpi dq; ///<Second factor's CRT exponent
76  Mpi qinv; ///<CRT coefficient
77  int_t slot; ///<Private key slot
78 } RsaPrivateKey;
79 
80 
81 //RSA related constants
82 extern const uint8_t PKCS1_OID[8];
83 extern const uint8_t RSA_ENCRYPTION_OID[9];
84 extern const uint8_t MD2_WITH_RSA_ENCRYPTION_OID[9];
85 extern const uint8_t MD5_WITH_RSA_ENCRYPTION_OID[9];
86 extern const uint8_t SHA1_WITH_RSA_ENCRYPTION_OID[9];
87 extern const uint8_t SHA224_WITH_RSA_ENCRYPTION_OID[9];
88 extern const uint8_t SHA256_WITH_RSA_ENCRYPTION_OID[9];
89 extern const uint8_t SHA384_WITH_RSA_ENCRYPTION_OID[9];
90 extern const uint8_t SHA512_WITH_RSA_ENCRYPTION_OID[9];
91 extern const uint8_t SHA512_256_WITH_RSA_ENCRYPTION_OID[9];
92 extern const uint8_t SHA512_224_WITH_RSA_ENCRYPTION_OID[9];
93 extern const uint8_t RSASSA_PKCS1_V1_5_WITH_SHA3_224_OID[9];
94 extern const uint8_t RSASSA_PKCS1_V1_5_WITH_SHA3_256_OID[9];
95 extern const uint8_t RSASSA_PKCS1_V1_5_WITH_SHA3_384_OID[9];
96 extern const uint8_t RSASSA_PKCS1_V1_5_WITH_SHA3_512_OID[9];
97 extern const uint8_t RSASSA_PSS_OID[9];
98 extern const uint8_t RSASSA_PSS_SHAKE128_OID[8];
99 extern const uint8_t RSASSA_PSS_SHAKE256_OID[8];
100 extern const uint8_t MGF1_OID[9];
101 
102 //RSA related functions
103 void rsaInitPublicKey(RsaPublicKey *key);
104 void rsaFreePublicKey(RsaPublicKey *key);
105 void rsaInitPrivateKey(RsaPrivateKey *key);
106 void rsaFreePrivateKey(RsaPrivateKey *key);
107 
108 error_t rsaGenerateKeyPair(const PrngAlgo *prngAlgo, void *prngContext,
109  size_t k, uint_t e, RsaPrivateKey *privateKey, RsaPublicKey *publicKey);
110 
111 error_t rsaGeneratePrivateKey(const PrngAlgo *prngAlgo, void *prngContext,
112  size_t k, uint_t e, RsaPrivateKey *privateKey);
113 
114 error_t rsaGeneratePublicKey(const RsaPrivateKey *privateKey,
115  RsaPublicKey *publicKey);
116 
117 error_t rsaesPkcs1v15Encrypt(const PrngAlgo *prngAlgo, void *prngContext,
118  const RsaPublicKey *key, const uint8_t *message, size_t messageLen,
119  uint8_t *ciphertext, size_t *ciphertextLen);
120 
121 error_t rsaesPkcs1v15Decrypt(const RsaPrivateKey *key,
122  const uint8_t *ciphertext, size_t ciphertextLen, uint8_t *message,
123  size_t messageSize, size_t *messageLen);
124 
125 error_t rsaesOaepEncrypt(const PrngAlgo *prngAlgo, void *prngContext,
126  const RsaPublicKey *key, const HashAlgo *hash, const char_t *label,
127  const uint8_t *message, size_t messageLen, uint8_t *ciphertext,
128  size_t *ciphertextLen);
129 
130 error_t rsaesOaepDecrypt(const RsaPrivateKey *key, const HashAlgo *hash,
131  const char_t *label, const uint8_t *ciphertext, size_t ciphertextLen,
132  uint8_t *message, size_t messageSize, size_t *messageLen);
133 
134 error_t rsassaPkcs1v15Sign(const RsaPrivateKey *key, const HashAlgo *hash,
135  const uint8_t *digest, uint8_t *signature, size_t *signatureLen);
136 
137 error_t rsassaPkcs1v15Verify(const RsaPublicKey *key, const HashAlgo *hash,
138  const uint8_t *digest, const uint8_t *signature, size_t signatureLen);
139 
140 error_t rsassaPssSign(const PrngAlgo *prngAlgo, void *prngContext,
141  const RsaPrivateKey *key, const HashAlgo *hash, size_t saltLen,
142  const uint8_t *digest, uint8_t *signature, size_t *signatureLen);
143 
144 error_t rsassaPssVerify(const RsaPublicKey *key, const HashAlgo *hash,
145  size_t saltLen, const uint8_t *digest, const uint8_t *signature,
146  size_t signatureLen);
147 
148 //C++ guard
149 #ifdef __cplusplus
150 }
151 #endif
152 
153 #endif
RSASSA_PSS_OID
const uint8_t RSASSA_PSS_OID[9]
Definition: rsa.c:85
MD5_WITH_RSA_ENCRYPTION_OID
const uint8_t MD5_WITH_RSA_ENCRYPTION_OID[9]
Definition: rsa.c:59
MGF1_OID
const uint8_t MGF1_OID[9]
Definition: rsa.c:92
RsaPrivateKey::p
Mpi p
First factor.
Definition: rsa.h:72
Mpi
Arbitrary precision integer.
Definition: mpi.h:102
int_t
signed int int_t
Definition: compiler_port.h:56
RSASSA_PKCS1_V1_5_WITH_SHA3_512_OID
const uint8_t RSASSA_PKCS1_V1_5_WITH_SHA3_512_OID[9]
Definition: rsa.c:82
SHA384_WITH_RSA_ENCRYPTION_OID
const uint8_t SHA384_WITH_RSA_ENCRYPTION_OID[9]
Definition: rsa.c:67
PrngAlgo
#define PrngAlgo
Definition: crypto.h:1008
rsaesPkcs1v15Decrypt
error_t rsaesPkcs1v15Decrypt(const RsaPrivateKey *key, const uint8_t *ciphertext, size_t ciphertextLen, uint8_t *message, size_t messageSize, size_t *messageLen)
RSAES-PKCS1-v1_5 decryption operation.
Definition: mimxrt1180_crypto_pkc.c:293
message
uint8_t message[]
Definition: chap.h:154
RSASSA_PSS_SHAKE256_OID
const uint8_t RSASSA_PSS_SHAKE256_OID[8]
Definition: rsa.c:89
PKCS1_OID
const uint8_t PKCS1_OID[8]
Definition: rsa.c:52
RsaPrivateKey::n
Mpi n
Modulus.
Definition: rsa.h:69
RSASSA_PKCS1_V1_5_WITH_SHA3_224_OID
const uint8_t RSASSA_PKCS1_V1_5_WITH_SHA3_224_OID[9]
Definition: rsa.c:76
RsaPublicKey::e
Mpi e
Public exponent.
Definition: rsa.h:59
RSASSA_PKCS1_V1_5_WITH_SHA3_256_OID
const uint8_t RSASSA_PKCS1_V1_5_WITH_SHA3_256_OID[9]
Definition: rsa.c:78
RsaPrivateKey::d
Mpi d
Private exponent.
Definition: rsa.h:71
rsaFreePublicKey
void rsaFreePublicKey(RsaPublicKey *key)
Release an RSA public key.
Definition: rsa.c:113
RsaPublicKey::n
Mpi n
Modulus.
Definition: rsa.h:58
rsaGeneratePublicKey
error_t rsaGeneratePublicKey(const RsaPrivateKey *privateKey, RsaPublicKey *publicKey)
Derive the public key from an RSA private key.
Definition: rsa.c:364
RsaPrivateKey::slot
int_t slot
Private key slot.
Definition: rsa.h:77
rsaesPkcs1v15Encrypt
error_t rsaesPkcs1v15Encrypt(const PrngAlgo *prngAlgo, void *prngContext, const RsaPublicKey *key, const uint8_t *message, size_t messageLen, uint8_t *ciphertext, size_t *ciphertextLen)
RSAES-PKCS1-v1_5 encryption operation.
Definition: mimxrt1180_crypto_pkc.c:198
rsaInitPublicKey
void rsaInitPublicKey(RsaPublicKey *key)
Initialize an RSA public key.
Definition: rsa.c:100
error_t
error_t
Error codes.
Definition: error.h:43
SHA512_224_WITH_RSA_ENCRYPTION_OID
const uint8_t SHA512_224_WITH_RSA_ENCRYPTION_OID[9]
Definition: rsa.c:71
rsaGenerateKeyPair
error_t rsaGenerateKeyPair(const PrngAlgo *prngAlgo, void *prngContext, size_t k, uint_t e, RsaPrivateKey *privateKey, RsaPublicKey *publicKey)
RSA key pair generation.
Definition: rsa.c:173
RsaPrivateKey::q
Mpi q
Second factor.
Definition: rsa.h:73
RsaPublicKey
RSA public key.
Definition: rsa.h:57
mpi.h
MPI (Multiple Precision Integer Arithmetic)
rsaesOaepDecrypt
error_t rsaesOaepDecrypt(const RsaPrivateKey *key, const HashAlgo *hash, const char_t *label, const uint8_t *ciphertext, size_t ciphertextLen, uint8_t *message, size_t messageSize, size_t *messageLen)
RSAES-OAEP decryption operation.
Definition: mimxrt1180_crypto_pkc.c:537
rsaGeneratePrivateKey
error_t rsaGeneratePrivateKey(const PrngAlgo *prngAlgo, void *prngContext, size_t k, uint_t e, RsaPrivateKey *privateKey)
RSA private key generation.
Definition: mimxrt1180_crypto_pkc.c:62
crypto.h
General definitions for cryptographic algorithms.
rsaInitPrivateKey
void rsaInitPrivateKey(RsaPrivateKey *key)
Initialize an RSA private key.
Definition: rsa.c:126
RsaPrivateKey::e
Mpi e
Public exponent.
Definition: rsa.h:70
SHA512_256_WITH_RSA_ENCRYPTION_OID
const uint8_t SHA512_256_WITH_RSA_ENCRYPTION_OID[9]
Definition: rsa.c:73
rsassaPssVerify
error_t rsassaPssVerify(const RsaPublicKey *key, const HashAlgo *hash, size_t saltLen, const uint8_t *digest, const uint8_t *signature, size_t signatureLen)
RSASSA-PSS signature verification operation.
Definition: mimxrt1180_crypto_pkc.c:1032
rsassaPkcs1v15Verify
error_t rsassaPkcs1v15Verify(const RsaPublicKey *key, const HashAlgo *hash, const uint8_t *digest, const uint8_t *signature, size_t signatureLen)
RSASSA-PKCS1-v1_5 signature verification operation.
Definition: mimxrt1180_crypto_pkc.c:793
RsaPrivateKey::qinv
Mpi qinv
CRT coefficient.
Definition: rsa.h:76
RsaPrivateKey::dq
Mpi dq
Second factor's CRT exponent.
Definition: rsa.h:75
hash_algorithms.h
Collection of hash algorithms.
SHA256_WITH_RSA_ENCRYPTION_OID
const uint8_t SHA256_WITH_RSA_ENCRYPTION_OID[9]
Definition: rsa.c:65
char_t
char char_t
Definition: compiler_port.h:55
rsaesOaepEncrypt
error_t rsaesOaepEncrypt(const PrngAlgo *prngAlgo, void *prngContext, const RsaPublicKey *key, const HashAlgo *hash, const char_t *label, const uint8_t *message, size_t messageLen, uint8_t *ciphertext, size_t *ciphertextLen)
RSAES-OAEP encryption operation.
Definition: mimxrt1180_crypto_pkc.c:398
RsaPrivateKey
RSA private key.
Definition: rsa.h:68
RSASSA_PSS_SHAKE128_OID
const uint8_t RSASSA_PSS_SHAKE128_OID[8]
Definition: rsa.c:87
SHA224_WITH_RSA_ENCRYPTION_OID
const uint8_t SHA224_WITH_RSA_ENCRYPTION_OID[9]
Definition: rsa.c:63
rsaFreePrivateKey
void rsaFreePrivateKey(RsaPrivateKey *key)
Release an RSA private key.
Definition: rsa.c:148
SHA1_WITH_RSA_ENCRYPTION_OID
const uint8_t SHA1_WITH_RSA_ENCRYPTION_OID[9]
Definition: rsa.c:61
HashAlgo
Common interface for hash algorithms.
Definition: crypto.h:1124
RSA_ENCRYPTION_OID
const uint8_t RSA_ENCRYPTION_OID[9]
Definition: rsa.c:54
SHA512_WITH_RSA_ENCRYPTION_OID
const uint8_t SHA512_WITH_RSA_ENCRYPTION_OID[9]
Definition: rsa.c:69
rsassaPssSign
error_t rsassaPssSign(const PrngAlgo *prngAlgo, void *prngContext, const RsaPrivateKey *key, const HashAlgo *hash, size_t saltLen, const uint8_t *digest, uint8_t *signature, size_t *signatureLen)
RSASSA-PSS signature generation operation.
Definition: mimxrt1180_crypto_pkc.c:916
RsaPrivateKey::dp
Mpi dp
First factor's CRT exponent.
Definition: rsa.h:74
RSASSA_PKCS1_V1_5_WITH_SHA3_384_OID
const uint8_t RSASSA_PKCS1_V1_5_WITH_SHA3_384_OID[9]
Definition: rsa.c:80
MD2_WITH_RSA_ENCRYPTION_OID
const uint8_t MD2_WITH_RSA_ENCRYPTION_OID[9]
Definition: rsa.c:57
uint_t
unsigned int uint_t
Definition: compiler_port.h:57
rsassaPkcs1v15Sign
error_t rsassaPkcs1v15Sign(const RsaPrivateKey *key, const HashAlgo *hash, const uint8_t *digest, uint8_t *signature, size_t *signatureLen)
RSASSA-PKCS1-v1_5 signature generation operation.
Definition: mimxrt1180_crypto_pkc.c:679