Aktualizr
C++ SOTA Client
All Classes Namespaces Files Functions Variables Enumerations Enumerator Pages
aktualizr.cc
1 #include "aktualizr.h"
2 
3 #include <chrono>
4 
5 #include <sodium.h>
6 
7 #include "libaktualizr/events.h"
8 #include "utilities/timer.h"
9 
10 using std::make_shared;
11 using std::shared_ptr;
12 
14  : Aktualizr(config, INvStorage::newStorage(config.storage), std::make_shared<HttpClient>()) {}
15 
16 Aktualizr::Aktualizr(Config config, std::shared_ptr<INvStorage> storage_in,
17  const std::shared_ptr<HttpInterface> &http_in)
18  : config_{std::move(config)}, sig_{new event::Channel()} {
19  if (sodium_init() == -1) { // Note that sodium_init doesn't require a matching 'sodium_deinit'
20  throw std::runtime_error("Unable to initialize libsodium");
21  }
22 
23  storage_ = std::move(storage_in);
24  storage_->importData(config_.import);
25 
26  uptane_client_ = std::make_shared<SotaUptaneClient>(config_, storage_, http_in, sig_);
27 }
28 
30  uptane_client_->initialize();
31  api_queue_.run();
32 }
33 
35  result::UpdateCheck update_result = CheckUpdates().get();
36  if (update_result.updates.empty()) {
37  if (update_result.status == result::UpdateStatus::kError) {
38  // If the metadata verification failed, inform the backend immediately.
39  SendManifest().get();
40  }
41  return true;
42  }
43 
44  result::Download download_result = Download(update_result.updates).get();
45  if (download_result.status != result::DownloadStatus::kSuccess || download_result.updates.empty()) {
46  if (download_result.status != result::DownloadStatus::kNothingToDownload) {
47  // If the download failed, inform the backend immediately.
48  SendManifest().get();
49  }
50  return true;
51  }
52 
53  Install(download_result.updates).get();
54 
55  if (uptane_client_->isInstallCompletionRequired()) {
56  // If there are some pending updates then effectively either reboot (OSTree) or aktualizr restart (fake pack mngr)
57  // is required to apply the update(s)
58  LOG_INFO << "Exiting aktualizr so that pending updates can be applied after reboot";
59  return false;
60  }
61 
62  if (!uptane_client_->hasPendingUpdates()) {
63  // If updates were applied and no any reboot/finalization is required then send/put manifest
64  // as soon as possible, don't wait for config_.uptane.polling_sec
65  SendManifest().get();
66  }
67 
68  return true;
69 }
70 
71 std::future<void> Aktualizr::RunForever(const Json::Value &custom_hwinfo) {
72  std::future<void> future = std::async(std::launch::async, [this, custom_hwinfo]() {
73  SendDeviceData(custom_hwinfo).get();
74 
75  std::unique_lock<std::mutex> l(exit_cond_.m);
76  while (true) {
77  if (!UptaneCycle()) {
78  break;
79  }
80 
81  if (exit_cond_.cv.wait_for(l, std::chrono::seconds(config_.uptane.polling_sec),
82  [this] { return exit_cond_.flag; })) {
83  break;
84  }
85  }
86  uptane_client_->completeInstall();
87  });
88  return future;
89 }
90 
92  {
93  std::lock_guard<std::mutex> g(exit_cond_.m);
94  exit_cond_.flag = true;
95  }
96  exit_cond_.cv.notify_all();
97 }
98 
99 void Aktualizr::AddSecondary(const std::shared_ptr<SecondaryInterface> &secondary) {
100  uptane_client_->addSecondary(secondary);
101 }
102 
103 void Aktualizr::SetSecondaryData(const Uptane::EcuSerial &ecu, const std::string &data) {
104  storage_->saveSecondaryData(ecu, data);
105 }
106 
107 std::vector<SecondaryInfo> Aktualizr::GetSecondaries() const {
108  std::vector<SecondaryInfo> info;
109  storage_->loadSecondariesInfo(&info);
110 
111  return info;
112 }
113 
114 std::future<result::CampaignCheck> Aktualizr::CampaignCheck() {
115  std::function<result::CampaignCheck()> task([this] { return uptane_client_->campaignCheck(); });
116  return api_queue_.enqueue(task);
117 }
118 
119 std::future<void> Aktualizr::CampaignControl(const std::string &campaign_id, campaign::Cmd cmd) {
120  std::function<void()> task([this, campaign_id, cmd] {
121  switch (cmd) {
122  case campaign::Cmd::Accept:
123  uptane_client_->campaignAccept(campaign_id);
124  break;
125  case campaign::Cmd::Decline:
126  uptane_client_->campaignDecline(campaign_id);
127  break;
128  case campaign::Cmd::Postpone:
129  uptane_client_->campaignPostpone(campaign_id);
130  break;
131  default:
132  break;
133  }
134  });
135  return api_queue_.enqueue(task);
136 }
137 
138 std::future<void> Aktualizr::SendDeviceData(const Json::Value &custom_hwinfo) {
139  std::function<void()> task([this, custom_hwinfo] { uptane_client_->sendDeviceData(custom_hwinfo); });
140  return api_queue_.enqueue(task);
141 }
142 
143 std::future<result::UpdateCheck> Aktualizr::CheckUpdates() {
144  std::function<result::UpdateCheck()> task([this] { return uptane_client_->fetchMeta(); });
145  return api_queue_.enqueue(task);
146 }
147 
148 std::future<result::Download> Aktualizr::Download(const std::vector<Uptane::Target> &updates) {
149  std::function<result::Download(const api::FlowControlToken *)> task(
150  [this, updates](const api::FlowControlToken *token) { return uptane_client_->downloadImages(updates, token); });
151  return api_queue_.enqueue(task);
152 }
153 
154 std::future<result::Install> Aktualizr::Install(const std::vector<Uptane::Target> &updates) {
155  std::function<result::Install()> task([this, updates] { return uptane_client_->uptaneInstall(updates); });
156  return api_queue_.enqueue(task);
157 }
158 
159 bool Aktualizr::SetInstallationRawReport(const std::string &custom_raw_report) {
160  return storage_->storeDeviceInstallationRawReport(custom_raw_report);
161 }
162 
163 std::future<bool> Aktualizr::SendManifest(const Json::Value &custom) {
164  std::function<bool()> task([this, custom]() { return uptane_client_->putManifest(custom); });
165  return api_queue_.enqueue(task);
166 }
167 
169  if (api_queue_.pause(true)) {
170  uptane_client_->reportPause();
171  return result::PauseStatus::kSuccess;
172  } else {
173  return result::PauseStatus::kAlreadyPaused;
174  }
175 }
176 
178  if (api_queue_.pause(false)) {
179  uptane_client_->reportResume();
180  return result::PauseStatus::kSuccess;
181  } else {
182  return result::PauseStatus::kAlreadyRunning;
183  }
184 }
185 
186 void Aktualizr::Abort() { api_queue_.abort(); }
187 
188 boost::signals2::connection Aktualizr::SetSignalHandler(
189  const std::function<void(shared_ptr<event::BaseEvent>)> &handler) {
190  return sig_->connect(handler);
191 }
192 
193 Aktualizr::InstallationLog Aktualizr::GetInstallationLog() {
194  std::vector<Aktualizr::InstallationLogEntry> ilog;
195 
196  EcuSerials serials;
197  if (!storage_->loadEcuSerials(&serials)) {
198  throw std::runtime_error("Could not load ECU serials");
199  }
200 
201  ilog.reserve(serials.size());
202  for (const auto &s : serials) {
203  Uptane::EcuSerial serial = s.first;
204  std::vector<Uptane::Target> installs;
205 
206  std::vector<Uptane::Target> log;
207  storage_->loadInstallationLog(serial.ToString(), &log, true);
208 
209  ilog.emplace_back(Aktualizr::InstallationLogEntry{serial, std::move(log)});
210  }
211 
212  return ilog;
213 }
214 
215 std::vector<Uptane::Target> Aktualizr::GetStoredTargets() { return uptane_client_->getStoredTargets(); }
216 
217 void Aktualizr::DeleteStoredTarget(const Uptane::Target &target) { uptane_client_->deleteStoredTarget(target); }
218 
219 std::ifstream Aktualizr::OpenStoredTarget(const Uptane::Target &target) {
220  return uptane_client_->openStoredTarget(target);
221 }
Provides a thread-safe way to pause and terminate task execution.
Definition: apiqueue.h:19
void AddSecondary(const std::shared_ptr< SecondaryInterface > &secondary)
Add new Secondary to aktualizr.
Definition: aktualizr.cc:99
General data structures.
Definition: types.h:215
Container for information about downloading an update.
Definition: results.h:116
void Abort()
Aborts the currently running command, if it can be aborted, or waits for it to finish; then removes a...
Definition: aktualizr.cc:186
STL namespace.
std::vector< Uptane::Target > GetStoredTargets()
Get list of targets currently in storage.
Definition: aktualizr.cc:215
bool UptaneCycle()
Synchronously run an Uptane cycle: check for updates, download any new targets, install them...
Definition: aktualizr.cc:34
result::Pause Resume()
Resume the library operations.
Definition: aktualizr.cc:177
std::vector< SecondaryInfo > GetSecondaries() const
Returns a list of the registered Secondaries, along with some associated metadata.
Definition: aktualizr.cc:107
Aktualizr(const Config &config)
Aktualizr requires a configuration object.
Definition: aktualizr.cc:13
Configuration object for an aktualizr instance running on a Primary ECU.
Definition: config.h:210
std::future< void > RunForever(const Json::Value &custom_hwinfo=Json::nullValue)
Asynchronously run aktualizr indefinitely until Shutdown is called.
Definition: aktualizr.cc:71
void DeleteStoredTarget(const Uptane::Target &target)
Delete a stored target from storage.
Definition: aktualizr.cc:217
void Shutdown()
Shuts down currently running RunForever() method.
Definition: aktualizr.cc:91
std::future< result::Download > Download(const std::vector< Uptane::Target > &updates)
Download targets.
Definition: aktualizr.cc:148
std::future< result::UpdateCheck > CheckUpdates()
Fetch Uptane metadata and check for updates.
Definition: aktualizr.cc:143
void SetSecondaryData(const Uptane::EcuSerial &ecu, const std::string &data)
Store some free-form data to be associated with a particular Secondary, to be retrieved later through...
Definition: aktualizr.cc:103
bool SetInstallationRawReport(const std::string &custom_raw_report)
SetInstallationRawReport allows setting a custom raw report field in the device installation result...
Definition: aktualizr.cc:159
result::Pause Pause()
Pause the library operations.
Definition: aktualizr.cc:168
std::future< result::Install > Install(const std::vector< Uptane::Target > &updates)
Install targets.
Definition: aktualizr.cc:154
std::future< result::CampaignCheck > CampaignCheck()
Check for campaigns.
Definition: aktualizr.cc:114
std::ifstream OpenStoredTarget(const Uptane::Target &target)
Get target downloaded in Download call.
Definition: aktualizr.cc:219
Container for information about available updates.
Definition: results.h:37
std::future< void > SendDeviceData(const Json::Value &custom_hwinfo=Json::nullValue)
Send local device data to the server.
Definition: aktualizr.cc:138
boost::signals2::connection SetSignalHandler(const SigHandler &handler)
Provide a function to receive event notifications.
Definition: aktualizr.cc:188
std::future< bool > SendManifest(const Json::Value &custom=Json::nullValue)
Send installation report to the backend.
Definition: aktualizr.cc:163
This class provides the main APIs necessary for launching and controlling libaktualizr.
Definition: aktualizr.h:20
void Initialize()
Initialize aktualizr.
Definition: aktualizr.cc:29
std::future< void > CampaignControl(const std::string &campaign_id, campaign::Cmd cmd)
Act on campaign: accept, decline or postpone.
Definition: aktualizr.cc:119
Get log of installations.
Definition: aktualizr.h:97