blob: 0d04815e8d27503f79a5a2f5ece3d662ad371613 [file] [log] [blame]
Jayanth Othayoth70804dc2018-03-20 06:31:59 -05001#pragma once
Adriana Kobylak70ca2422018-09-06 14:23:38 -05002#include "utils.hpp"
Gunnar Millsf6ed5892018-09-07 17:08:02 -05003
Jayanth Othayoth70804dc2018-03-20 06:31:59 -05004#include <openssl/evp.h>
5#include <openssl/pem.h>
Gunnar Millsf6ed5892018-09-07 17:08:02 -05006#include <openssl/rsa.h>
7#include <sys/mman.h>
8#include <unistd.h>
9
Brad Bishop9f44c992020-11-06 14:48:46 -050010#include <filesystem>
Jayanth Othayoth70804dc2018-03-20 06:31:59 -050011#include <set>
Andrew Geisslerab139ce2020-05-16 13:22:09 -050012#include <string>
Jayanth Othayoth70804dc2018-03-20 06:31:59 -050013
14namespace openpower
15{
16namespace software
17{
18namespace image
19{
20
Jayanth Othayoth70804dc2018-03-20 06:31:59 -050021using Key_t = std::string;
22using Hash_t = std::string;
Brad Bishop9f44c992020-11-06 14:48:46 -050023using PublicKeyPath = std::filesystem::path;
24using HashFilePath = std::filesystem::path;
Jayanth Othayoth70804dc2018-03-20 06:31:59 -050025using KeyHashPathPair = std::pair<HashFilePath, PublicKeyPath>;
26using AvailableKeyTypes = std::set<Key_t>;
27
28// RAII support for openSSL functions.
29using BIO_MEM_Ptr = std::unique_ptr<BIO, decltype(&::BIO_free)>;
30using EVP_PKEY_Ptr = std::unique_ptr<EVP_PKEY, decltype(&::EVP_PKEY_free)>;
31using EVP_MD_CTX_Ptr =
Adriana Kobylak70ca2422018-09-06 14:23:38 -050032 std::unique_ptr<EVP_MD_CTX, decltype(&::EVP_MD_CTX_free)>;
Jayanth Othayoth70804dc2018-03-20 06:31:59 -050033
Jayanth Othayoth70804dc2018-03-20 06:31:59 -050034/** @struct CustomFd
35 *
36 * RAII wrapper for file descriptor.
37 */
38struct CustomFd
39{
40 public:
41 CustomFd() = delete;
42 CustomFd(const CustomFd&) = delete;
43 CustomFd& operator=(const CustomFd&) = delete;
44 CustomFd(CustomFd&&) = default;
45 CustomFd& operator=(CustomFd&&) = default;
46 /** @brief Saves File descriptor and uses it to do file operation
47 *
48 * @param[in] fd - File descriptor
49 */
Lei YU1db9adf2019-03-05 16:02:31 +080050 explicit CustomFd(int fd) : fd(fd)
Brad Bishop8facccf2020-11-04 09:44:58 -050051 {}
Jayanth Othayoth70804dc2018-03-20 06:31:59 -050052
53 ~CustomFd()
54 {
55 if (fd >= 0)
56 {
57 close(fd);
58 }
59 }
60
61 int operator()() const
62 {
63 return fd;
64 }
65
66 private:
67 /** @brief File descriptor */
68 int fd = -1;
69};
70
71/** @struct CustomMap
72 *
73 * RAII wrapper for mmap.
74 */
75struct CustomMap
76{
77 private:
78 /** @brief starting address of the map */
79 void* addr;
80
81 /** @brief length of the mapping */
82 size_t length;
83
84 public:
85 CustomMap() = delete;
86 CustomMap(const CustomMap&) = delete;
87 CustomMap& operator=(const CustomMap&) = delete;
88 CustomMap(CustomMap&&) = default;
89 CustomMap& operator=(CustomMap&&) = default;
90
91 /** @brief Saves starting address of the map and
92 * and length of the file.
93 * @param[in] addr - Starting address of the map
94 * @param[in] length - length of the map
95 */
96 CustomMap(void* addr, size_t length) : addr(addr), length(length)
Brad Bishop8facccf2020-11-04 09:44:58 -050097 {}
Jayanth Othayoth70804dc2018-03-20 06:31:59 -050098
99 ~CustomMap()
100 {
101 munmap(addr, length);
102 }
103
104 void* operator()() const
105 {
106 return addr;
107 }
108};
109
110/** @class Signature
111 * @brief Contains signature verification functions.
112 * @details The software image class that contains the signature
113 * verification functions for signed image.
114 */
115class Signature
116{
117 public:
118 Signature() = delete;
119 Signature(const Signature&) = delete;
120 Signature& operator=(const Signature&) = delete;
121 Signature(Signature&&) = default;
122 Signature& operator=(Signature&&) = default;
123 ~Signature() = default;
124
125 /**
126 * @brief Constructs Signature.
127 * @param[in] imageDirPath - image path
128 * @param[in] signedConfPath - Path of public key
129 * hash function files
130 */
Brad Bishop9f44c992020-11-06 14:48:46 -0500131 explicit Signature(const std::filesystem::path& imageDirPath,
Lei YU2b2d2292019-03-18 15:22:56 +0800132 const std::string& pnorFileName,
Brad Bishop9f44c992020-11-06 14:48:46 -0500133 const std::filesystem::path& signedConfPath);
Jayanth Othayoth70804dc2018-03-20 06:31:59 -0500134
135 /**
136 * @brief Image signature verification function.
137 * Verify the Manifest and public key file signature using the
138 * public keys available in the system first. After successful
139 * validation, continue the whole image files signature
140 * validation using the image specific public key and the
141 * hash function.
142 *
143 * @return true if signature verification was successful,
144 * false if not
145 */
146 bool verify();
147
148 private:
149 /**
150 * @brief Function used for system level file signature validation
151 * of image specific publickey file and manifest file
152 * using the available public keys and hash functions
153 * in the system.
154 * Refer code-update documentation for more details.
155 */
156 bool systemLevelVerify();
157
158 /**
159 * @brief Return all key types stored in the BMC based on the
160 * public key and hashfunc files stored in the BMC.
161 *
162 * @return list
163 */
164 AvailableKeyTypes getAvailableKeyTypesFromSystem() const;
165
166 /**
167 * @brief Return public key and hash function file names for the
168 * corresponding key type
169 *
170 * @param[in] key - key type
171 * @return Pair of hash and public key file names
172 */
173 inline KeyHashPathPair getKeyHashFileNames(const Key_t& key) const;
174
175 /**
176 * @brief Verify the file signature using public key and hash function
177 *
178 * @param[in] - Image file path
179 * @param[in] - Signature file path
180 * @param[in] - Public key
181 * @param[in] - Hash function name
182 * @return true if signature verification was successful, false if not
183 */
Brad Bishop9f44c992020-11-06 14:48:46 -0500184 bool verifyFile(const std::filesystem::path& file,
185 const std::filesystem::path& signature,
186 const std::filesystem::path& publicKey,
187 const std::string& hashFunc);
Jayanth Othayoth70804dc2018-03-20 06:31:59 -0500188
189 /**
190 * @brief Create RSA object from the public key
191 * @param[in] - publickey
192 * @param[out] - RSA Object.
193 */
Adriana Kobylak3ce1a4c2021-12-08 14:48:52 +0000194 inline EVP_PKEY_Ptr createPublicRSA(const std::filesystem::path& publicKey);
Jayanth Othayoth70804dc2018-03-20 06:31:59 -0500195
196 /**
197 * @brief Memory map the file
198 * @param[in] - file path
199 * @param[in] - file size
200 * @param[out] - Custom Mmap address
201 */
Brad Bishop9f44c992020-11-06 14:48:46 -0500202 CustomMap mapFile(const std::filesystem::path& path, size_t size);
Jayanth Othayoth70804dc2018-03-20 06:31:59 -0500203
204 /** @brief Directory where software images are placed*/
Brad Bishop9f44c992020-11-06 14:48:46 -0500205 std::filesystem::path imageDirPath;
Jayanth Othayoth70804dc2018-03-20 06:31:59 -0500206
Lei YU2b2d2292019-03-18 15:22:56 +0800207 /** @brief The PNOR file name in imageDirPath */
208 std::string pnorFileName;
209
Jayanth Othayoth70804dc2018-03-20 06:31:59 -0500210 /** @brief Path of public key and hash function files */
Brad Bishop9f44c992020-11-06 14:48:46 -0500211 std::filesystem::path signedConfPath;
Jayanth Othayoth70804dc2018-03-20 06:31:59 -0500212
213 /** @brief key type defined in mainfest file */
214 Key_t keyType;
215
216 /** @brief Hash type defined in mainfest file */
217 Hash_t hashType;
218};
219
220} // namespace image
221} // namespace software
222} // namespace openpower