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 "flags.hpp"
20 #include "handler.hpp"
21 #include "status.hpp"
22 #include "tool_errors.hpp"
23 #include "util.hpp"
24 
25 #include <ipmiblob/blob_errors.hpp>
26 
27 #include <algorithm>
28 #include <cstring>
29 #include <memory>
30 #include <string>
31 #include <thread>
32 #include <unordered_map>
33 #include <vector>
34 
35 namespace host_tool
36 {
37 
38 void updaterMain(UpdateHandlerInterface* updater, ipmiblob::BlobInterface* blob,
39                  const std::string& imagePath, const std::string& signaturePath,
40                  const std::string& layoutType, bool ignoreUpdate)
41 {
42     /* TODO: validate the layoutType isn't a special value such as: 'update',
43      * 'verify', or 'hash'
44      */
45     std::string layout = "/flash/" + layoutType;
46 
47     bool goalSupported = updater->checkAvailable(layout);
48     if (!goalSupported)
49     {
50         throw ToolException("Goal firmware not supported");
51     }
52 
53     // Clean all active blobs to support multiple stages
54     // Check for any active blobs and delete the first one found to reset the
55     // BMC's phosphor-ipmi-flash state machine then clean any leftover artifacts
56     const auto blobList = blob->getBlobList();
57     for (const auto& activeBlob : blobList)
58     {
59         // Prefix is /flash/active/
60         if (activeBlob.starts_with("/flash/active/"))
61         {
62             std::fprintf(stderr, "Found an active blob, deleting %s\n",
63                          activeBlob.c_str());
64             blob->deleteBlob(activeBlob);
65             updater->cleanArtifacts();
66             break;
67         }
68     }
69 
70     /* Yay, our layout type is supported. */
71     try
72     {
73         /* Send over the firmware image. */
74         std::fprintf(stderr, "Sending over the firmware image.\n");
75         updater->sendFile(layout, imagePath);
76 
77         /* Send over the hash contents. */
78         std::fprintf(stderr, "Sending over the hash file.\n");
79         updater->sendFile(ipmi_flash::hashBlobId, signaturePath);
80 
81         /* Trigger the verification by opening and committing the verify file.
82          */
83         std::fprintf(stderr, "Opening the verification file\n");
84         if (updater->verifyFile(ipmi_flash::verifyBlobId, false))
85         {
86             std::fprintf(stderr, "succeeded\n");
87         }
88         else
89         {
90             std::fprintf(stderr, "failed\n");
91             throw ToolException("Verification failed");
92         }
93 
94         /* Trigger the update by opening and committing the update file. */
95         std::fprintf(stderr, "Opening the update file\n");
96         if (updater->verifyFile(ipmi_flash::updateBlobId, ignoreUpdate))
97         {
98             std::fprintf(stderr, "succeeded\n");
99         }
100         else
101         {
102             /* Depending on the update mechanism used, this may be
103              * uninteresting. For instance, for the static layout, we use the
104              * reboot update mechanism.  Which doesn't always lead to a
105              * successful return before the BMC starts shutting down services.
106              */
107             std::fprintf(stderr, "failed\n");
108             throw ToolException("Update failed");
109         }
110     }
111     catch (...)
112     {
113         updater->cleanArtifacts();
114         throw;
115     }
116 }
117 
118 } // namespace host_tool
119