1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
|
/*
* meta.cc - Implementation of the Key classes for system metadata
* libhscript, the HorizonScript library for
* Project Horizon
*
* Copyright (c) 2019 Adélie Linux and contributors. All rights reserved.
* This code is licensed under the AGPL 3.0 license, as noted in the
* LICENSE-code file in the root directory of this repository.
*
* SPDX-License-Identifier: AGPL-3.0-only
*/
#include <assert.h>
#include <fstream>
#include <regex>
#include <set>
#include <sstream>
#ifdef HAS_INSTALL_ENV
# include <boost/filesystem.hpp>
#endif /* HAS_INSTALL_ENV */
#include <unistd.h> /* access - used by tz code even in RT env */
#include "meta.hh"
#include "util/output.hh"
using namespace Horizon::Keys;
namespace fs = boost::filesystem;
using boost::system::error_code;
Key *Hostname::parseFromData(const std::string &data, int lineno, int *errors,
int *) {
std::regex valid_re("[A-Za-z0-9-_.]*");
if(!std::regex_match(data, valid_re)) {
if(errors) *errors += 1;
output_error("installfile:" + std::to_string(lineno),
"hostname: expected machine or DNS name",
"'" + data + "' is not a valid hostname");
return nullptr;
}
return new Hostname(lineno, data);
}
bool Hostname::validate(ScriptOptions) const {
/* Validate that the name is a valid machine or DNS name */
bool any_failure = false;
std::string::size_type last_dot = 0, next_dot = 0;
if(!isalpha(this->_value[0])) {
any_failure = true;
output_error("installfile:" + std::to_string(this->lineno()),
"hostname: must start with alphabetical character");
}
if(this->_value.size() > 320) {
any_failure = true;
output_error("installfile:" + std::to_string(this->lineno()),
"hostname: value too long",
"valid host names must be less than 320 characters");
}
do {
next_dot = this->_value.find_first_of('.', next_dot + 1);
if(next_dot == std::string::npos) {
next_dot = this->_value.size();
}
if(next_dot - last_dot > 64) {
any_failure = true;
output_error("installfile:" + std::to_string(this->lineno()),
"hostname: component too long",
"each component must be less than 64 characters");
}
last_dot = next_dot;
} while(next_dot != this->_value.size());
return !any_failure;
}
bool Hostname::execute(ScriptOptions opts) const {
/* Set the hostname of the target computer */
std::string actual;
std::string::size_type dot = this->_value.find_first_of('.');
if(this->_value.size() > 64) {
/* Linux has a nodename limit of 64 characters.
* That's fine, because we have a limit of 64 chars per segment.
* Assuming a dot is present, just chop at the first dot. */
assert(dot <= 64);
actual = this->_value.substr(0, dot);
} else {
actual = this->_value;
}
/* Runner.Execute.hostname. */
output_info("installfile:" + std::to_string(this->lineno()),
"hostname: set hostname to '" + actual + "'");
if(opts.test(Simulate)) {
std::cout << "hostname " << actual << std::endl;
}
#ifdef HAS_INSTALL_ENV
else {
if(sethostname(actual.c_str(), actual.size()) == -1) {
output_error("installfile:" + std::to_string(this->lineno()),
"hostname: failed to set host name",
std::string(strerror(errno)));
return false;
}
}
#endif /* HAS_INSTALL_ENV */
/* Runner.Execute.hostname.Write. */
output_info("installfile:" + std::to_string(this->lineno()),
"hostname: write '" + actual + "' to /etc/hostname");
if(opts.test(Simulate)) {
std::cout << "printf '%s' " << actual << " > /target/etc/hostname"
<< std::endl;
}
#ifdef HAS_INSTALL_ENV
else {
std::ofstream hostname_f("/target/etc/hostname", std::ios_base::trunc);
if(!hostname_f) {
output_error("installfile:" + std::to_string(this->lineno()),
"hostname: could not open /etc/hostname for writing");
return false;
}
hostname_f << actual;
}
#endif /* HAS_INSTALL_ENV */
/* The second condition ensures that it isn't a single dot that simply
* terminates the nodename. */
if(dot != std::string::npos && this->_value.length() > dot + 1) {
const std::string domain(this->_value.substr(dot + 1));
output_info("installfile:" + std::to_string(this->lineno()),
"hostname: set domain name '" + domain + "'");
if(opts.test(Simulate)) {
std::cout << "printf 'dns_domain_lo=\"" << domain
<< "\"\\" << "n' >> /target/etc/conf.d/net" << std::endl;
}
#ifdef HAS_INSTALL_ENV
else {
std::ofstream net_conf_f("/target/etc/conf.d/net",
std::ios_base::app);
if(!net_conf_f) {
output_error("installfile:" + std::to_string(this->lineno()),
"hostname: could not open /etc/conf.d/net for "
"writing");
return false;
}
net_conf_f << "dns_domain_lo\"" << domain << "\"" << std::endl;
}
#endif /* HAS_INSTALL_ENV */
}
return true;
}
static std::regex valid_pkg("[0-9A-Za-z+_.-]*((>?<|[<>]?=|[~>])[0-9A-Za-z-_.]+)?");
Key *PkgInstall::parseFromData(const std::string &data, int lineno, int *errors,
int *warnings) {
std::string next_pkg;
std::istringstream stream(data);
std::set<std::string> all_pkgs;
while(stream >> next_pkg) {
if(!std::regex_match(next_pkg, valid_pkg)) {
if(errors) *errors += 1;
output_error("installfile:" + std::to_string(lineno),
"pkginstall: expected package name",
"'" + next_pkg + "' is not a valid package or atom");
return nullptr;
}
if(all_pkgs.find(next_pkg) != all_pkgs.end()) {
if(warnings) *warnings += 1;
output_warning("installfile:" + std::to_string(lineno),
"pkginstall: package '" + next_pkg +
"' is already in the target package set");
continue;
}
all_pkgs.insert(next_pkg);
}
return new PkgInstall(lineno, all_pkgs);
}
/* LCOV_EXCL_START */
bool PkgInstall::validate(ScriptOptions) const {
/* Any validation errors would have occurred above. */
return true;
}
bool PkgInstall::execute(ScriptOptions) const {
/* Package installation is handled in Script::execute. */
return true;
}
/* LCOV_EXCL_STOP */
/* All ISO 639-1 language codes.
* Source: https://www.loc.gov/standards/iso639-2/ISO-639-2_utf-8.txt
* Python to construct table:
* >>> f = open('ISO-639-2_utf-8.txt')
* >>> x = csv.reader(f, delimiter='|')
* >>> langs = [lang[2] for lang in iter(x) if lang != '']
* >>> print('"' + '", "'.join(langs) + '", "C."')
*/
const std::set<std::string> valid_langs = {
"aa", "ab", "af", "ak", "sq", "am", "ar", "an", "hy", "as", "av", "ae",
"ay", "az", "ba", "bm", "eu", "be", "bn", "bh", "bi", "bs", "br", "bg",
"my", "ca", "ch", "ce", "zh", "cu", "cv", "kw", "co", "cr", "cs", "da",
"dv", "nl", "dz", "en", "eo", "et", "ee", "fo", "fj", "fi", "fr", "fy",
"ff", "ka", "de", "gd", "ga", "gl", "gv", "el", "gn", "gu", "ht", "ha",
"he", "hz", "hi", "ho", "hr", "hu", "ig", "is", "io", "ii", "iu", "ie",
"ia", "id", "ik", "it", "jv", "ja", "kl", "kn", "ks", "kr", "kk", "km",
"ki", "rw", "ky", "kv", "kg", "ko", "kj", "ku", "lo", "la", "lv", "li",
"ln", "lt", "lb", "lu", "lg", "mk", "mh", "ml", "mi", "mr", "ms", "mg",
"mt", "mn", "na", "nv", "nr", "nd", "ng", "ne", "nn", "nb", "no", "ny",
"oc", "oj", "or", "om", "os", "pa", "fa", "pi", "pl", "pt", "ps", "qu",
"rm", "ro", "rn", "ru", "sg", "sa", "si", "sk", "sl", "se", "sm", "sn",
"sd", "so", "st", "es", "sc", "sr", "ss", "su", "sw", "sv", "ty", "ta",
"tt", "te", "tg", "tl", "th", "bo", "ti", "to", "tn", "ts", "tk", "tr",
"tw", "ug", "uk", "ur", "uz", "ve", "vi", "vo", "cy", "wa", "wo", "xh",
"yi", "yo", "za", "zu", "C."
};
Key *Language::parseFromData(const std::string &data, int lineno, int *errors,
int *) {
if(data.length() < 2 ||
valid_langs.find(data.substr(0, 2)) == valid_langs.end()) {
if(errors) *errors += 1;
output_error("installfile:" + std::to_string(lineno),
"language: invalid language specified",
"language must be a valid ISO 639-1 language code");
return nullptr;
}
/* We know a valid language appears, but is it real? */
if(data.length() > 2) {
/* data[1] is . if language is C.UTF-8 */
if(data[2] != '_' && data[1] != '.') {
if(errors) *errors += 1;
output_error("installfile:" + std::to_string(lineno),
"language: invalid language specified",
"language must be a valid ISO 639-1 language code, "
"optionally followed by '_' and a country code");
return nullptr;
}
/* we don't really care about the country code, but we do care about
* codeset - we (via musl) *only* support UTF-8. */
std::string::size_type dot = data.find_first_of('.');
if(dot != std::string::npos && data.substr(dot+1, 5) != "UTF-8") {
if(errors) *errors += 1;
output_error("installfile:" + std::to_string(lineno),
"language: invalid language specified",
"you cannot specify a non-UTF-8 codeset");
return nullptr;
}
}
return new Language(lineno, data);
}
bool Language::execute(ScriptOptions opts) const {
output_info("installfile:" + std::to_string(this->lineno()),
"language: setting default system language to " +
this->value());
if(opts.test(Simulate)) {
std::cout << "printf '#!/bin/sh\\" << "nexport LANG=\"%s\"\\" << "n'"
<< this->value() << " > /target/etc/profile.d/language.sh"
<< std::endl
<< "chmod a+x /target/etc/profile.d/language.sh"
<< std::endl;
return true;
}
#ifdef HAS_INSTALL_ENV
const char *lang_path = "/target/etc/profile.d/language.sh";
std::ofstream lang_f(lang_path, std::ios_base::trunc);
error_code ec;
if(!lang_f) {
output_error("installfile:" + std::to_string(this->lineno()),
"language: could not open /etc/profile.d/language.sh "
"for writing");
return false;
}
lang_f << "#!/bin/sh" << std::endl << "export LANG=\""
<< this->value() << "\"" << std::endl;
lang_f.close();
fs::permissions(lang_path,
fs::perms::owner_all |
fs::perms::group_read | fs::perms::group_exe |
fs::perms::others_read | fs::perms::others_exe, ec);
if(ec.failed()) {
output_error("installfile:" + std::to_string(this->lineno()),
"language: could not set /etc/profile.d/language.sh "
"as executable", ec.message());
return false;
}
#endif /* HAS_INSTALL_ENV */
return true;
}
Key *Firmware::parseFromData(const std::string &data, int lineno, int *errors,
int *warnings) {
bool value;
if(!BooleanKey::parse(data, "installfile:" + std::to_string(lineno),
"firmware", &value)) {
if(errors) *errors += 1;
return nullptr;
}
if(value) {
#ifdef NON_LIBRE_FIRMWARE
output_warning("installfile:" + std::to_string(lineno),
"firmware: You have requested non-libre firmware. "
"This may cause security issues, system instability, "
"and many other issues. You should not enable this "
"option unless your system absolutely requires it.");
#else
if(errors) *errors += 1;
output_error("installfile:" + std::to_string(lineno),
"firmware: You have requested non-libre firmware, "
"but this version of Horizon does not support "
"non-libre firmware.", "Installation cannot proceed.");
return nullptr;
#endif
}
return new Firmware(lineno, value);
}
bool Firmware::execute(ScriptOptions) const {
/* By itself, this does nothing. */
return true;
}
Key *Timezone::parseFromData(const std::string &data, int lineno, int *errors,
int *warnings) {
if(data.find_first_of(" .\\") != std::string::npos || data[0] == '/') {
if(errors) *errors += 1;
output_error("installfile:" + std::to_string(lineno),
"timezone: invalid timezone name");
return nullptr;
}
if(access("/usr/share/zoneinfo", X_OK) != 0) {
if(warnings) *warnings += 1;
output_warning("installfile:" + std::to_string(lineno),
"timezone: can't determine validity of timezone",
"zoneinfo data is missing or inaccessible");
} else {
std::string zi_path = "/usr/share/zoneinfo/" + data;
if(access(zi_path.c_str(), F_OK) != 0) {
if(errors) *errors += 1;
output_error("installfile:" + std::to_string(lineno),
"timezone: unknown timezone '" + data + "'");
return nullptr;
}
}
return new Timezone(lineno, data);
}
bool Timezone::execute(ScriptOptions opts) const {
output_info("installfile:" + std::to_string(this->lineno()),
"timezone: setting system timezone to " + this->value());
if(opts.test(Simulate)) {
/* If the target doesn't have tzdata installed, copy the zoneinfo from
* the Horizon environment. */
std::cout << "([ -f /target/usr/share/zoneinfo/" << this->value()
<< " ] && ln -s /usr/share/zoneinfo/" << this->value()
<< " /target/etc/localtime) || cp /usr/share/zoneinfo/"
<< this->value() << " /target/etc/localtime" << std::endl;
return true;
}
#ifdef HAS_INSTALL_ENV
std::string zi_path = "/usr/share/zoneinfo/" + this->value();
std::string target_zi = "/target" + zi_path;
error_code ec;
if(fs::exists(target_zi, ec)) {
fs::create_symlink(zi_path, "/target/etc/localtime", ec);
if(ec.failed()) {
output_error("installfile:" + std::to_string(this->lineno()),
"timezone: failed to create symbolic link",
ec.message());
return false;
}
return true;
} else {
/* The target doesn't have tzdata installed. We copy the zoneinfo
* file from the Horizon environment to the target. */
fs::copy_file(zi_path, "/target/etc/localtime", ec);
if(ec.failed()) {
output_error("installfile:" + std::to_string(this->lineno()),
"timezone: failed to prepare target environment",
ec.message());
return false;
}
return true;
}
#else
return false;
#endif
}
Key *Repository::parseFromData(const std::string &data, int lineno, int *errors,
int *) {
if(data.empty() || (data[0] != '/' && data.compare(0, 4, "http"))) {
if(errors) *errors += 1;
output_error("installfile:" + std::to_string(lineno),
"repository: must be absolute path or HTTP(S) URL");
return nullptr;
}
return new Repository(lineno, data);
}
bool Repository::validate(ScriptOptions) const {
/* TODO XXX: Ensure URL is accessible if networking is available */
return true;
}
bool Repository::execute(ScriptOptions opts) const {
/* Runner.Execute.repository. */
output_info("installfile:" + std::to_string(this->lineno()),
"repository: write '" + this->value() +
"' to /etc/apk/repositories");
if(opts.test(Simulate)) {
std::cout << "echo '" << this->value() <<
"' >> /target/etc/apk/repositories" << std::endl;
return true;
}
#ifdef HAS_INSTALL_ENV
std::ofstream repo_f("/target/etc/apk/repositories",
std::ios_base::ate);
if(!repo_f) {
output_error("installfile:" + std::to_string(this->lineno()),
"repository: could not open /etc/apk/repositories "
"for writing");
return false;
}
repo_f << this->value() << std::endl;
return true;
#else
return false;
#endif /* HAS_INSTALL_ENV */
}
|