1 /*
2  * Copyright 2018 Google Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #include "updater.hpp"
18 
19 #include "firmware_handler.hpp"
20 #include "status.hpp"
21 #include "tool_errors.hpp"
22 #include "util.hpp"
23 
24 #include <algorithm>
25 #include <blobs-ipmid/blobs.hpp>
26 #include <cstring>
27 #include <ipmiblob/blob_errors.hpp>
28 #include <memory>
29 #include <string>
30 #include <thread>
31 #include <vector>
32 
33 namespace host_tool
34 {
35 
36 bool UpdateHandler::checkAvailable(const std::string& goalFirmware)
37 {
38     std::vector<std::string> blobs = blob->getBlobList();
39 
40     auto blobInst = std::find_if(
41         blobs.begin(), blobs.end(), [&goalFirmware](const std::string& iter) {
42             /* Running into weird scenarios where the string comparison doesn't
43              * work.  TODO: revisit.
44              */
45             return (0 == std::memcmp(goalFirmware.c_str(), iter.c_str(),
46                                      goalFirmware.length()));
47             // return (goalFirmware.compare(iter));
48         });
49     if (blobInst == blobs.end())
50     {
51         std::fprintf(stderr, "%s not found\n", goalFirmware.c_str());
52         return false;
53     }
54 
55     /* Call stat on /flash/image (or /flash/tarball) and check if data interface
56      * is supported.
57      */
58     ipmiblob::StatResponse stat;
59 
60     try
61     {
62         stat = blob->getStat(goalFirmware);
63     }
64     catch (const ipmiblob::BlobException& b)
65     {
66         std::fprintf(stderr, "Received exception '%s' on getStat\n", b.what());
67         return false;
68     }
69 
70     auto supported = handler->supportedType();
71     if ((stat.blob_state & supported) == 0)
72     {
73         std::fprintf(stderr, "data interface selected not supported.\n");
74         return false;
75     }
76 
77     return true;
78 }
79 
80 void UpdateHandler::sendFile(const std::string& target, const std::string& path)
81 {
82     std::uint16_t session;
83     auto supported = handler->supportedType();
84 
85     try
86     {
87         session = blob->openBlob(
88             target, static_cast<std::uint16_t>(supported) |
89                         static_cast<std::uint16_t>(blobs::OpenFlags::write));
90     }
91     catch (const ipmiblob::BlobException& b)
92     {
93         throw ToolException("blob exception received: " +
94                             std::string(b.what()));
95     }
96 
97     if (!handler->sendContents(path, session))
98     {
99         /* Need to close the session on failure, or it's stuck open (until the
100          * blob handler timeout is implemented, and even then, why make it wait.
101          */
102         blob->closeBlob(session);
103         throw ToolException("Failed to send contents of " + path);
104     }
105 
106     blob->closeBlob(session);
107 }
108 
109 /* Poll an open verification session.  Handling closing the session is not yet
110  * owned by this method. */
111 bool pollVerificationStatus(std::uint16_t session,
112                             ipmiblob::BlobInterface* blob)
113 {
114     using namespace std::chrono_literals;
115 
116     static constexpr auto verificationSleep = 5s;
117     static constexpr int commandAttempts = 20;
118     int attempts = 0;
119     bool exitLoop = false;
120     ipmi_flash::VerifyCheckResponses result =
121         ipmi_flash::VerifyCheckResponses::other;
122 
123     try
124     {
125         /* Reach back the current status from the verification service output.
126          */
127         while (attempts++ < commandAttempts)
128         {
129             ipmiblob::StatResponse resp = blob->getStat(session);
130 
131             if (resp.metadata.size() != sizeof(std::uint8_t))
132             {
133                 /* TODO: How do we want to handle the verification failures,
134                  * because closing the session to the verify blob has a special
135                  * as-of-yet not fully defined behavior.
136                  */
137                 std::fprintf(stderr, "Received invalid metadata response!!!\n");
138             }
139 
140             result =
141                 static_cast<ipmi_flash::VerifyCheckResponses>(resp.metadata[0]);
142 
143             switch (result)
144             {
145                 case ipmi_flash::VerifyCheckResponses::failed:
146                     std::fprintf(stderr, "failed\n");
147                     exitLoop = true;
148                     break;
149                 case ipmi_flash::VerifyCheckResponses::other:
150                     std::fprintf(stderr, "other\n");
151                     break;
152                 case ipmi_flash::VerifyCheckResponses::running:
153                     std::fprintf(stderr, "running\n");
154                     break;
155                 case ipmi_flash::VerifyCheckResponses::success:
156                     std::fprintf(stderr, "success\n");
157                     exitLoop = true;
158                     break;
159                 default:
160                     std::fprintf(stderr, "wat\n");
161             }
162 
163             if (exitLoop)
164             {
165                 break;
166             }
167             std::this_thread::sleep_for(verificationSleep);
168         }
169     }
170     catch (const ipmiblob::BlobException& b)
171     {
172         throw ToolException("blob exception received: " +
173                             std::string(b.what()));
174     }
175 
176     /* TODO: If this is reached and it's not success, it may be worth just
177      * throwing a ToolException with a timeout message specifying the final
178      * read's value.
179      *
180      * TODO: Given that excepting from certain points leaves the BMC update
181      * state machine in an inconsistent state, we need to carefully evaluate
182      * which exceptions from the lower layers allow one to try and delete the
183      * blobs to rollback the state and progress.
184      */
185     return (result == ipmi_flash::VerifyCheckResponses::success);
186 }
187 
188 bool UpdateHandler::verifyFile(const std::string& target)
189 {
190     std::uint16_t session;
191     bool success = false;
192 
193     try
194     {
195         session = blob->openBlob(
196             target, static_cast<std::uint16_t>(blobs::OpenFlags::write));
197     }
198     catch (const ipmiblob::BlobException& b)
199     {
200         throw ToolException("blob exception received: " +
201                             std::string(b.what()));
202     }
203 
204     std::fprintf(
205         stderr,
206         "Committing to verification file to trigger verification service\n");
207 
208     try
209     {
210         blob->commit(session, {});
211     }
212     catch (const ipmiblob::BlobException& b)
213     {
214         throw ToolException("blob exception received: " +
215                             std::string(b.what()));
216     }
217 
218     std::fprintf(stderr,
219                  "Calling stat on verification session to check status\n");
220 
221     if (pollVerificationStatus(session, blob))
222     {
223         std::fprintf(stderr, "Verification returned success\n");
224         success = true;
225     }
226     else
227     {
228         std::fprintf(stderr, "Verification returned non-success (could still "
229                              "be running (unlikely))\n");
230     }
231 
232     blob->closeBlob(session);
233     return (success == true);
234 }
235 
236 void updaterMain(UpdateHandler* updater, const std::string& imagePath,
237                  const std::string& signaturePath)
238 {
239     /* TODO(venture): Add optional parameter to specify the flash type, default
240      * to legacy for now.
241      */
242     bool goalSupported =
243         updater->checkAvailable(ipmi_flash::staticLayoutBlobId);
244     if (!goalSupported)
245     {
246         throw ToolException("Goal firmware or interface not supported");
247     }
248 
249     /* Yay, our data handler is supported. */
250 
251     /* Send over the firmware image. */
252     std::fprintf(stderr, "Sending over the firmware image.\n");
253     updater->sendFile(ipmi_flash::staticLayoutBlobId, imagePath);
254 
255     /* Send over the hash contents. */
256     std::fprintf(stderr, "Sending over the hash file.\n");
257     updater->sendFile(ipmi_flash::hashBlobId, signaturePath);
258 
259     /* Trigger the verification by opening the verify file. */
260     std::fprintf(stderr, "Opening the verification file\n");
261     if (updater->verifyFile(ipmi_flash::verifyBlobId))
262     {
263         std::fprintf(stderr, "succeeded\n");
264     }
265     else
266     {
267         std::fprintf(stderr, "failed\n");
268     }
269 }
270 
271 } // namespace host_tool
272