├── .github └── workflows │ └── rust.yml ├── .gitignore ├── Cargo.lock ├── Cargo.toml ├── LICENSE ├── README.md └── src ├── main.rs ├── test.rs └── utils.rs /.github/workflows/rust.yml: -------------------------------------------------------------------------------- 1 | name: Rust 2 | 3 | on: 4 | push: 5 | pull_request: 6 | 7 | env: 8 | CARGO_TERM_COLOR: always 9 | 10 | jobs: 11 | build: 12 | 13 | runs-on: ubuntu-latest 14 | 15 | steps: 16 | - uses: actions/checkout@v3 17 | - name: Coding style 18 | run: cargo fmt -- --check 19 | - name: Build 20 | run: cargo build --verbose 21 | - name: Run tests 22 | run: cargo test --verbose 23 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | -------------------------------------------------------------------------------- /Cargo.lock: -------------------------------------------------------------------------------- 1 | # This file is automatically @generated by Cargo. 2 | # It is not intended for manual editing. 3 | version = 3 4 | 5 | [[package]] 6 | name = "autocfg" 7 | version = "1.1.0" 8 | source = "registry+https://github.com/rust-lang/crates.io-index" 9 | checksum = "d468802bab17cbc0cc575e9b053f41e72aa36bfa6b7f55e3529ffa43161b97fa" 10 | 11 | [[package]] 12 | name = "base64" 13 | version = "0.21.7" 14 | source = "registry+https://github.com/rust-lang/crates.io-index" 15 | checksum = "9d297deb1925b89f2ccc13d7635fa0714f12c87adce1c75356b39ca9b7178567" 16 | 17 | [[package]] 18 | name = "bitflags" 19 | version = "1.3.2" 20 | source = "registry+https://github.com/rust-lang/crates.io-index" 21 | checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a" 22 | 23 | [[package]] 24 | name = "cfg-if" 25 | version = "1.0.0" 26 | source = "registry+https://github.com/rust-lang/crates.io-index" 27 | checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd" 28 | 29 | [[package]] 30 | name = "libc" 31 | version = "0.2.153" 32 | source = "registry+https://github.com/rust-lang/crates.io-index" 33 | checksum = "9c198f91728a82281a64e1f4f9eeb25d82cb32a5de251c6bd1b5154d63a8e7bd" 34 | 35 | [[package]] 36 | name = "log" 37 | version = "0.4.21" 38 | source = "registry+https://github.com/rust-lang/crates.io-index" 39 | checksum = "90ed8c1e510134f979dbc4f070f87d4313098b704861a105fe34231c70a3901c" 40 | 41 | [[package]] 42 | name = "memoffset" 43 | version = "0.7.1" 44 | source = "registry+https://github.com/rust-lang/crates.io-index" 45 | checksum = "5de893c32cde5f383baa4c04c5d6dbdd735cfd4a794b0debdb2bb1b421da5ff4" 46 | dependencies = [ 47 | "autocfg", 48 | ] 49 | 50 | [[package]] 51 | name = "nix" 52 | version = "0.26.4" 53 | source = "registry+https://github.com/rust-lang/crates.io-index" 54 | checksum = "598beaf3cc6fdd9a5dfb1630c2800c7acd31df7aaf0f565796fba2b53ca1af1b" 55 | dependencies = [ 56 | "bitflags", 57 | "cfg-if", 58 | "libc", 59 | "memoffset", 60 | "pin-utils", 61 | ] 62 | 63 | [[package]] 64 | name = "pin-utils" 65 | version = "0.1.0" 66 | source = "registry+https://github.com/rust-lang/crates.io-index" 67 | checksum = "8b870d8c151b6f2fb93e84a13146138f05d02ed11c7e7c54f8826aaaf7c9f184" 68 | 69 | [[package]] 70 | name = "users" 71 | version = "0.11.0" 72 | source = "registry+https://github.com/rust-lang/crates.io-index" 73 | checksum = "24cc0f6d6f267b73e5a2cadf007ba8f9bc39c6a6f9666f8cf25ea809a153b032" 74 | dependencies = [ 75 | "libc", 76 | "log", 77 | ] 78 | 79 | [[package]] 80 | name = "virtme-ng-init" 81 | version = "0.1.0" 82 | dependencies = [ 83 | "base64", 84 | "nix", 85 | "users", 86 | ] 87 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "virtme-ng-init" 3 | version = "0.1.0" 4 | edition = "2021" 5 | 6 | # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html 7 | 8 | [dependencies] 9 | nix = "0.26" 10 | users = "0.11" 11 | base64 = "0.21" 12 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # !!! WARNING !!! 2 | 3 | This project is now merged in: 4 | https://github.com/arighi/virtme-ng 5 | 6 | From now on all the development activity will continue in virtme-ng. 7 | 8 | # virtme-ng-init: fast init process for virtme-ng 9 | 10 | virtme-ng-init is an extremely lightweight init process for virtme-ng [1] 11 | implemented in Rust. 12 | 13 | Its primary goal is to speed up the boot time of virtme-ng instances. 14 | 15 | virtme-ng-init is able to perform any necessary initialization in the 16 | virtualized environment, such as mounting filesystems, starting essential 17 | services, and configuring the system before handing over control to the main 18 | user-space processes (typicall a shell session). 19 | 20 | [1] https://github.com/arighi/virtme-ng 21 | 22 | # Result 23 | 24 | - virtme-init (bash implementation): 25 | ``` 26 | $ time virtme-ng --exec 'uname -r' 27 | 6.4.0-rc3-virtme 28 | 29 | real 0m1.146s 30 | user 0m0.829s 31 | sys 0m1.048s 32 | 33 | $ time virtme-ng --net user --exec 'ip addr show dev eth0' 34 | 2: eth0: mtu 1500 qdisc pfifo_fast state DOWN group default qlen 1000 35 | link/ether 52:54:00:12:34:56 brd ff:ff:ff:ff:ff:ff 36 | inet 10.0.2.15/24 scope global eth0 37 | valid_lft forever preferred_lft forever 38 | 39 | real 0m1.282s 40 | user 0m0.930s 41 | sys 0m1.219s 42 | ``` 43 | 44 | - virtme-ng-init (Rust implementation): 45 | ``` 46 | $ time virtme-ng --exec 'uname -r' 47 | 6.4.0-rc3-virtme 48 | 49 | real 0m0.906s 50 | user 0m0.654s 51 | sys 0m0.684s 52 | 53 | $ time virtme-ng --net user --exec 'ip addr show dev eth0' 54 | 2: eth0: mtu 1500 qdisc pfifo_fast state DOWN group default qlen 1000 55 | link/ether 52:54:00:12:34:56 brd ff:ff:ff:ff:ff:ff 56 | inet 10.0.2.15/24 scope global eth0 57 | valid_lft forever preferred_lft forever 58 | 59 | real 0m0.972s 60 | user 0m0.736s 61 | sys 0m0.795s 62 | ``` 63 | 64 | # Building 65 | 66 | Static building is necessary as this binary is going to be executed 67 | before the file system is up and running. 68 | 69 | ``` 70 | RUSTFLAGS='-C target-feature=+crt-static' cargo build -r 71 | ``` 72 | 73 | # Local installation 74 | 75 | Put the binary into virtme/guest/bin/. 76 | e.g. when used as a submodule: 77 | ``` 78 | cp target/release/virtme-ng-init ../virtme/guest/bin 79 | ``` 80 | 81 | # Credits 82 | 83 | Author: Andrea Righi 84 | -------------------------------------------------------------------------------- /src/main.rs: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: GPL-3.0 2 | 3 | //! virtme-ng-init 4 | //! 5 | //! This program serves as an extremely lightweight init process for `virtme-ng` in order to speed 6 | //! up boot time. 7 | //! 8 | //! Its primary purpose is to perform any necessary initialization in the virtualized environment, 9 | //! such as mounting filesystems, starting essential services, and configuring the system before 10 | //! handing over control to the main user-space processes (typicall a shell session). 11 | //! 12 | //! Author: Andrea Righi 13 | 14 | use base64::engine::general_purpose::STANDARD as BASE64; 15 | use base64::engine::Engine as _; 16 | 17 | use nix::fcntl::{open, OFlag}; 18 | use nix::libc; 19 | use nix::sys::reboot; 20 | use nix::sys::stat::Mode; 21 | use nix::sys::utsname::uname; 22 | use nix::unistd::sethostname; 23 | use std::env; 24 | use std::fs::{File, OpenOptions}; 25 | use std::io::{self, BufRead, BufReader, BufWriter, Write}; 26 | use std::os::fd::{AsRawFd, IntoRawFd}; 27 | use std::os::unix::process::CommandExt; 28 | use std::path::{Path, PathBuf}; 29 | use std::process::{exit, id, Command, Stdio}; 30 | use std::thread; 31 | use std::time::Duration; 32 | 33 | #[macro_use] 34 | mod utils; 35 | 36 | #[cfg(test)] 37 | mod test; 38 | 39 | struct MountInfo { 40 | source: &'static str, 41 | target: &'static str, 42 | fs_type: &'static str, 43 | flags: usize, 44 | fsdata: &'static str, 45 | } 46 | 47 | const KERNEL_MOUNTS: &[MountInfo] = &[ 48 | MountInfo { 49 | source: "proc", 50 | target: "/proc", 51 | fs_type: "proc", 52 | flags: (libc::MS_NOSUID | libc::MS_NOEXEC | libc::MS_NODEV) as usize, 53 | fsdata: "", 54 | }, 55 | MountInfo { 56 | source: "sys", 57 | target: "/sys", 58 | fs_type: "sysfs", 59 | flags: (libc::MS_NOSUID | libc::MS_NOEXEC | libc::MS_NODEV) as usize, 60 | fsdata: "", 61 | }, 62 | MountInfo { 63 | source: "run", 64 | target: "/run", 65 | fs_type: "tmpfs", 66 | flags: 0, 67 | fsdata: "", 68 | }, 69 | MountInfo { 70 | source: "devtmpfs", 71 | target: "/dev", 72 | fs_type: "devtmpfs", 73 | flags: (libc::MS_NOSUID | libc::MS_NOEXEC) as usize, 74 | fsdata: "", 75 | }, 76 | MountInfo { 77 | source: "configfs", 78 | target: "/sys/kernel/config", 79 | fs_type: "configfs", 80 | flags: 0, 81 | fsdata: "", 82 | }, 83 | MountInfo { 84 | source: "debugfs", 85 | target: "/sys/kernel/debug", 86 | fs_type: "debugfs", 87 | flags: 0, 88 | fsdata: "", 89 | }, 90 | MountInfo { 91 | source: "tracefs", 92 | target: "/sys/kernel/tracing", 93 | fs_type: "tracefs", 94 | flags: 0, 95 | fsdata: "", 96 | }, 97 | MountInfo { 98 | source: "securityfs", 99 | target: "/sys/kernel/security", 100 | fs_type: "securityfs", 101 | flags: 0, 102 | fsdata: "", 103 | }, 104 | ]; 105 | 106 | const SYSTEM_MOUNTS: &[MountInfo] = &[ 107 | MountInfo { 108 | source: "devpts", 109 | target: "/dev/pts", 110 | fs_type: "devpts", 111 | flags: (libc::MS_NOSUID | libc::MS_NOEXEC) as usize, 112 | fsdata: "", 113 | }, 114 | MountInfo { 115 | source: "tmpfs", 116 | target: "/dev/shm", 117 | fs_type: "tmpfs", 118 | flags: (libc::MS_NOSUID | libc::MS_NODEV) as usize, 119 | fsdata: "", 120 | }, 121 | MountInfo { 122 | source: "tmpfs", 123 | target: "/var/log", 124 | fs_type: "tmpfs", 125 | flags: (libc::MS_NOSUID | libc::MS_NODEV) as usize, 126 | fsdata: "", 127 | }, 128 | MountInfo { 129 | source: "tmpfs", 130 | target: "/var/tmp", 131 | fs_type: "tmpfs", 132 | flags: (libc::MS_NOSUID | libc::MS_NODEV) as usize, 133 | fsdata: "", 134 | }, 135 | MountInfo { 136 | source: "tmpfs", 137 | target: "/var/spool/rsyslog", 138 | fs_type: "tmpfs", 139 | flags: (libc::MS_NOSUID | libc::MS_NODEV) as usize, 140 | fsdata: "", 141 | }, 142 | MountInfo { 143 | source: "tmpfs", 144 | target: "/var/lib/portables", 145 | fs_type: "tmpfs", 146 | flags: (libc::MS_NOSUID | libc::MS_NODEV) as usize, 147 | fsdata: "", 148 | }, 149 | MountInfo { 150 | source: "tmpfs", 151 | target: "/var/lib/machines", 152 | fs_type: "tmpfs", 153 | flags: (libc::MS_NOSUID | libc::MS_NODEV) as usize, 154 | fsdata: "", 155 | }, 156 | MountInfo { 157 | source: "tmpfs", 158 | target: "/var/lib/private", 159 | fs_type: "tmpfs", 160 | flags: (libc::MS_NOSUID | libc::MS_NODEV) as usize, 161 | fsdata: "", 162 | }, 163 | MountInfo { 164 | source: "tmpfs", 165 | target: "/var/lib/sudo", 166 | fs_type: "tmpfs", 167 | flags: (libc::MS_NOSUID | libc::MS_NODEV) as usize, 168 | fsdata: "", 169 | }, 170 | MountInfo { 171 | source: "tmpfs", 172 | target: "/var/lib/apt", 173 | fs_type: "tmpfs", 174 | flags: (libc::MS_NOSUID | libc::MS_NODEV) as usize, 175 | fsdata: "", 176 | }, 177 | MountInfo { 178 | source: "tmpfs", 179 | target: "/var/cache", 180 | fs_type: "tmpfs", 181 | flags: (libc::MS_NOSUID | libc::MS_NODEV) as usize, 182 | fsdata: "", 183 | }, 184 | MountInfo { 185 | source: "tmpfs", 186 | target: "/var/lib/snapd/cookie", 187 | fs_type: "tmpfs", 188 | flags: (libc::MS_NOSUID | libc::MS_NODEV) as usize, 189 | fsdata: "", 190 | }, 191 | ]; 192 | 193 | const USER_SCRIPT: &str = "/run/tmp/.virtme-script"; 194 | 195 | fn check_init_pid() { 196 | if id() != 1 { 197 | log!("must be run as PID 1"); 198 | exit(1); 199 | } 200 | } 201 | 202 | fn poweroff() { 203 | unsafe { 204 | libc::sync(); 205 | } 206 | match reboot::reboot(reboot::RebootMode::RB_POWER_OFF) { 207 | Ok(_) => exit(0), 208 | Err(err) => { 209 | log!("error powering off: {}", err); 210 | exit(1); 211 | } 212 | } 213 | } 214 | 215 | fn configure_environment() { 216 | env::set_var("PATH", "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin"); 217 | } 218 | 219 | fn get_kernel_version(show_machine: bool) -> String { 220 | let utsname = match uname() { 221 | Ok(utsname) => utsname, 222 | Err(_) => return "None".to_string(), 223 | }; 224 | let release = utsname.release().to_string_lossy(); 225 | if show_machine { 226 | let machine = utsname.machine().to_string_lossy(); 227 | format!("{} {}", release, machine) 228 | } else { 229 | release.into_owned() 230 | } 231 | } 232 | 233 | fn get_legacy_active_console() -> Option { 234 | // See Documentation/filesystems/proc.rst for /proc/consoles documentation. 235 | match File::open("/proc/consoles") { 236 | Ok(file) => { 237 | let reader = BufReader::new(file); 238 | 239 | // .flatten() ignores lines with reading errors 240 | for line in reader.lines().flatten() { 241 | if line.chars().nth(27) == Some('C') { 242 | let console = line.split(' ').next()?; 243 | return Some(format!("/dev/{}", console)); 244 | } 245 | } 246 | None 247 | } 248 | Err(error) => { 249 | log!("failed to open /proc/consoles: {}", error); 250 | None 251 | } 252 | } 253 | } 254 | 255 | fn get_active_console() -> Option { 256 | if let Ok(console) = env::var("virtme_console") { 257 | Some(format!("/dev/{}", console)) 258 | } else { 259 | get_legacy_active_console() 260 | } 261 | } 262 | 263 | fn configure_limits() { 264 | if let Ok(nr_open) = env::var("nr_open") { 265 | if let Ok(mut file) = OpenOptions::new().write(true).open("/proc/sys/fs/nr_open") { 266 | file.write_all(nr_open.as_bytes()) 267 | .expect("Failed to write nr_open"); 268 | } 269 | } 270 | } 271 | 272 | fn configure_hostname() { 273 | if let Ok(hostname) = env::var("virtme_hostname") { 274 | if let Err(err) = sethostname(hostname) { 275 | log!("failed to change hostname: {}", err); 276 | } 277 | } else { 278 | log!("virtme_hostname is not defined"); 279 | } 280 | } 281 | 282 | fn run_systemd_tmpfiles() { 283 | if !Path::new("/etc/systemd").exists() { 284 | return; 285 | } 286 | let args: &[&str] = &[ 287 | "--create", 288 | "--boot", 289 | "--exclude-prefix=/dev", 290 | "--exclude-prefix=/root", 291 | ]; 292 | utils::run_cmd("systemd-tmpfiles", args); 293 | } 294 | 295 | fn generate_fstab() -> io::Result<()> { 296 | utils::create_file("/run/tmp/fstab", 0o0664, "").ok(); 297 | utils::do_mount( 298 | "/run/tmp/fstab", 299 | "/etc/fstab", 300 | "", 301 | libc::MS_BIND as usize, 302 | "", 303 | ); 304 | Ok(()) 305 | } 306 | 307 | fn generate_shadow() -> io::Result<()> { 308 | utils::create_file("/run/tmp/shadow", 0o0644, "").ok(); 309 | 310 | let input_file = File::open("/etc/passwd")?; 311 | let output_file = File::create("/run/tmp/shadow")?; 312 | 313 | let reader = BufReader::new(input_file); 314 | let mut writer = BufWriter::new(output_file); 315 | 316 | for line in reader.lines() { 317 | if let Some((username, _)) = line?.split_once(':') { 318 | writeln!(writer, "{}::::::::", username)?; 319 | } 320 | } 321 | utils::do_mount( 322 | "/run/tmp/shadow", 323 | "/etc/shadow", 324 | "", 325 | libc::MS_BIND as usize, 326 | "", 327 | ); 328 | 329 | Ok(()) 330 | } 331 | 332 | fn generate_sudoers() -> io::Result<()> { 333 | let fname = "/run/tmp/sudoers"; 334 | let mut content = "Defaults secure_path=\"/usr/sbin:/usr/bin:/sbin:/bin\"\n".to_string(); 335 | content += "root ALL = (ALL) NOPASSWD: ALL\n"; 336 | if let Ok(user) = env::var("virtme_user") { 337 | content += &format!("{} ALL = (ALL) NOPASSWD: ALL\n", user); 338 | } 339 | if !Path::new("/etc/sudoers").exists() { 340 | utils::create_file("/etc/sudoers", 0o0440, "").unwrap_or_else(|_| {}); 341 | } 342 | utils::create_file(fname, 0o0440, &content).ok(); 343 | utils::do_mount(fname, "/etc/sudoers", "", libc::MS_BIND as usize, ""); 344 | Ok(()) 345 | } 346 | 347 | // The /etc/lvm is usually only read/write by root. In order to allow commands like pvcreate to be 348 | // run on rootless users just create a dummy directory and bind mount it in the same place. 349 | fn generate_lvm() -> io::Result<()> { 350 | utils::do_mkdir("/run/tmp/lvm"); 351 | utils::do_mount("/run/tmp/lvm", "/etc/lvm/", "", libc::MS_BIND as usize, ""); 352 | Ok(()) 353 | } 354 | 355 | fn generate_hosts() -> io::Result<()> { 356 | if let Ok(hostname) = env::var("virtme_hostname") { 357 | std::fs::copy("/etc/hosts", "/run/tmp/hosts")?; 358 | let mut h = OpenOptions::new() 359 | .write(true) 360 | .append(true) 361 | .open("/run/tmp/hosts")?; 362 | writeln!(h, "\n127.0.0.1 {}\n::1 {}", hostname, hostname)?; 363 | utils::do_mount( 364 | "/run/tmp/hosts", 365 | "/etc/hosts", 366 | "", 367 | libc::MS_BIND as usize, 368 | "", 369 | ); 370 | } 371 | Ok(()) 372 | } 373 | 374 | fn override_system_files() { 375 | generate_fstab().ok(); 376 | generate_shadow().ok(); 377 | generate_sudoers().ok(); 378 | generate_hosts().ok(); 379 | generate_lvm().ok(); 380 | } 381 | 382 | fn set_cwd() { 383 | if let Ok(dir) = env::var("virtme_chdir") { 384 | if let Err(err) = env::set_current_dir(dir) { 385 | log!("error changing directory: {}", err); 386 | } 387 | } 388 | } 389 | 390 | fn symlink_fds() { 391 | let fd_links = [ 392 | ("/proc/self/fd", "/dev/fd"), 393 | ("/proc/self/fd/0", "/dev/stdin"), 394 | ("/proc/self/fd/1", "/dev/stdout"), 395 | ("/proc/self/fd/2", "/dev/stderr"), 396 | ]; 397 | 398 | // Install /proc/self/fd symlinks into /dev if not already present. 399 | for (src, dst) in fd_links.iter() { 400 | if !std::path::Path::new(dst).exists() { 401 | utils::do_symlink(src, dst); 402 | } 403 | } 404 | } 405 | 406 | fn mount_kernel_filesystems() { 407 | for mount_info in KERNEL_MOUNTS { 408 | // In the case where a rootfs is specified when launching virtme-ng, it 409 | // mounts /run and /run/virtme/guesttools prior to executing 410 | // virtme-ng-init. We do not want to re-mount /run, as we will lose 411 | // access to guesttools, which is required for network setup. 412 | // 413 | // Note, get_test_tools_dir() relies on /proc, so that must be mounted 414 | // prior to /run. 415 | if mount_info.target == "/run" { 416 | if let Some(guest_tools_dir) = get_guest_tools_dir() { 417 | if guest_tools_dir.starts_with("/run") { 418 | log!("/run previously mounted, skipping"); 419 | continue; 420 | } 421 | } 422 | } 423 | utils::do_mount( 424 | mount_info.source, 425 | mount_info.target, 426 | mount_info.fs_type, 427 | mount_info.flags, 428 | mount_info.fsdata, 429 | ) 430 | } 431 | } 432 | 433 | fn mount_cgroupfs() { 434 | // If SYSTEMD_CGROUP_ENABLE_LEGACY_FORCE=1 is passed we can mimic systemd's behavior and mount 435 | // the legacy cgroup v1 layout. 436 | let cmdline = std::fs::read_to_string("/proc/cmdline").unwrap(); 437 | if cmdline.contains("SYSTEMD_CGROUP_ENABLE_LEGACY_FORCE=1") { 438 | utils::do_mount("cgroup", "/sys/fs/cgroup", "tmpfs", 0, ""); 439 | let subsystems = vec!["cpu", "cpuacct", "blkio", "memory", "devices", "pids"]; 440 | for subsys in &subsystems { 441 | let target = format!("/sys/fs/cgroup/{}", subsys); 442 | utils::do_mkdir(&target); 443 | // Don't treat failure as critical here, since the kernel may not 444 | // support all the legacy cgroups. 445 | utils::do_mount(subsys, &target, "cgroup", 0, subsys); 446 | } 447 | } else { 448 | utils::do_mount("cgroup2", "/sys/fs/cgroup", "cgroup2", 0, ""); 449 | } 450 | } 451 | 452 | fn mount_virtme_overlays() { 453 | utils::do_mkdir("/run/tmp/"); 454 | for (key, path) in env::vars() { 455 | if key.starts_with("virtme_rw_overlay") { 456 | let dir = &format!("/run/tmp/{}", key); 457 | let upperdir = &format!("{}/upper", dir); 458 | let workdir = &format!("{}/work", dir); 459 | let mnt_opts = &format!( 460 | "xino=off,lowerdir={},upperdir={},workdir={}", 461 | path, upperdir, workdir 462 | ); 463 | utils::do_mkdir(dir); 464 | utils::do_mkdir(upperdir); 465 | utils::do_mkdir(workdir); 466 | let result = utils::do_mount_check(&key, &path, "overlay", 0, mnt_opts); 467 | if let Err(_) = result { 468 | // Old kernels don't support xino=on|off, re-try without this option. 469 | let mnt_opts = &format!( 470 | "lowerdir={},upperdir={},workdir={}", 471 | path, upperdir, workdir 472 | ); 473 | utils::do_mount(&key, &path, "overlay", 0, mnt_opts); 474 | } 475 | } 476 | } 477 | } 478 | 479 | fn mount_virtme_initmounts() { 480 | for (key, path) in env::vars() { 481 | if key.starts_with("virtme_initmount") { 482 | utils::do_mkdir(&path); 483 | utils::do_mount( 484 | &key.replace('_', "."), 485 | &path, 486 | "9p", 487 | 0, 488 | "version=9p2000.L,trans=virtio,access=any", 489 | ); 490 | } 491 | } 492 | } 493 | 494 | fn mount_kernel_modules() { 495 | let kver = get_kernel_version(false); 496 | let mod_dir = format!("/lib/modules/{}", kver); 497 | 498 | // Make sure to always have /lib/modules, otherwise we won't be able to configure kmod support 499 | // properly (this can happen in some container environments, such as docker). 500 | if !Path::new(&mod_dir).exists() { 501 | utils::do_mkdir("/lib/modules"); 502 | } 503 | 504 | if env::var("virtme_root_mods").is_ok() { 505 | // /lib/modules is already set up. 506 | } else if let Ok(dir) = env::var("virtme_link_mods") { 507 | utils::do_mount("none", "/lib/modules/", "tmpfs", 0, ""); 508 | utils::do_symlink(&dir, &mod_dir); 509 | } else if Path::new(&mod_dir).exists() { 510 | // We have mismatched modules. Mask them off. 511 | utils::do_mount("disallow_kmod", &mod_dir, "tmpfs", 0, "ro,mode=0000"); 512 | } 513 | } 514 | 515 | fn mount_sys_filesystems() { 516 | utils::do_mkdir("/dev/pts"); 517 | utils::do_mkdir("/dev/shm"); 518 | utils::do_mkdir("/run/dbus"); 519 | 520 | for mount_info in SYSTEM_MOUNTS { 521 | utils::do_mount( 522 | mount_info.source, 523 | mount_info.target, 524 | mount_info.fs_type, 525 | mount_info.flags, 526 | mount_info.fsdata, 527 | ) 528 | } 529 | } 530 | 531 | fn fix_dpkg_locks() { 532 | if !Path::new("/var/lib/dpkg").exists() { 533 | return; 534 | } 535 | let lock_files = [ 536 | "/var/lib/dpkg/lock", 537 | "/var/lib/dpkg/lock-frontend", 538 | "/var/lib/dpkg/triggers/Lock", 539 | ]; 540 | for path in lock_files { 541 | let fname = Path::new(path) 542 | .file_name() 543 | .and_then(|name| name.to_str()) 544 | .unwrap_or(""); 545 | if fname.is_empty() { 546 | continue; 547 | } 548 | let src_file = format!("/run/tmp/{}", fname); 549 | utils::create_file(&src_file, 0o0640, "").ok(); 550 | utils::do_mount(&src_file, path, "", libc::MS_BIND as usize, ""); 551 | } 552 | } 553 | 554 | fn fix_packaging_files() { 555 | fix_dpkg_locks(); 556 | } 557 | 558 | fn disable_uevent_helper() { 559 | let uevent_helper_path = "/sys/kernel/uevent_helper"; 560 | 561 | if Path::new(uevent_helper_path).exists() { 562 | // This kills boot performance. 563 | log!("you have CONFIG_UEVENT_HELPER on, turn it off"); 564 | let mut file = OpenOptions::new().write(true).open(uevent_helper_path).ok(); 565 | match &mut file { 566 | Some(file) => { 567 | write!(file, "").ok(); 568 | } 569 | None => { 570 | log!("error opening {}", uevent_helper_path); 571 | } 572 | } 573 | } 574 | } 575 | 576 | fn find_udevd() -> Option { 577 | let static_candidates = [ 578 | PathBuf::from("/usr/lib/systemd/systemd-udevd"), 579 | PathBuf::from("/lib/systemd/systemd-udevd"), 580 | ]; 581 | let path = env::var("PATH").unwrap_or_else(|_| String::new()); 582 | let path_candidates = path.split(':').map(|dir| Path::new(dir).join("udevd")); 583 | 584 | static_candidates 585 | .into_iter() 586 | .chain(path_candidates) 587 | .find(|path| path.exists()) 588 | } 589 | 590 | fn run_udevd() -> Option> { 591 | if let Some(udevd_path) = find_udevd() { 592 | let handle = thread::spawn(move || { 593 | disable_uevent_helper(); 594 | let args: &[&str] = &["--daemon", "--resolve-names=never"]; 595 | utils::run_cmd(udevd_path, args); 596 | log!("triggering udev coldplug"); 597 | utils::run_cmd("udevadm", &["trigger", "--type=subsystems", "--action=add"]); 598 | utils::run_cmd("udevadm", &["trigger", "--type=devices", "--action=add"]); 599 | log!("waiting for udev to settle"); 600 | utils::run_cmd("udevadm", &["settle"]); 601 | log!("udev is done"); 602 | }); 603 | Some(handle) 604 | } else { 605 | log!("unable to find udevd, skip udev."); 606 | None 607 | } 608 | } 609 | 610 | fn get_guest_tools_dir() -> Option { 611 | Some( 612 | env::current_exe() 613 | .ok()? 614 | .parent()? 615 | .parent()? 616 | .to_str()? 617 | .to_string(), 618 | ) 619 | } 620 | 621 | fn _get_network_devices_from_entries(entries: std::fs::ReadDir) -> Vec> { 622 | let mut vec = Vec::new(); 623 | 624 | // .flatten() ignores lines with reading errors 625 | for entry in entries.flatten() { 626 | let path = entry.path(); 627 | if !path.is_dir() { 628 | continue; 629 | } 630 | if let Ok(net_entries) = std::fs::read_dir(path.join("net")) { 631 | // .flatten() ignores lines with reading errors 632 | if let Some(entry) = net_entries.flatten().next() { 633 | if let Some(fname) = entry.path().file_name() { 634 | vec.push(Some(fname.to_string_lossy().to_string())); 635 | } 636 | } 637 | } 638 | } 639 | vec 640 | } 641 | 642 | fn get_network_devices() -> Vec> { 643 | let virtio_net_dir = "/sys/bus/virtio/drivers/virtio_net"; 644 | loop { 645 | match std::fs::read_dir(virtio_net_dir) { 646 | Ok(entries) => { 647 | return _get_network_devices_from_entries(entries); 648 | } 649 | Err(_) => { 650 | // Wait a bit to make sure virtio-net is properly registered in the system. 651 | thread::sleep(Duration::from_secs_f32(0.25)); 652 | } 653 | } 654 | } 655 | } 656 | 657 | fn get_network_handle( 658 | network_dev: Option, 659 | guest_tools_dir: Option, 660 | ) -> Option> { 661 | let network_dev_str = network_dev.unwrap(); 662 | log!("setting up network device {}", network_dev_str); 663 | return Some(thread::spawn(move || { 664 | let args = [ 665 | "udhcpc", 666 | "-i", 667 | &network_dev_str, 668 | "-n", 669 | "-q", 670 | "-f", 671 | "-s", 672 | &format!("{}/virtme-udhcpc-script", guest_tools_dir.unwrap()), 673 | ]; 674 | utils::run_cmd("busybox", &args); 675 | })); 676 | } 677 | 678 | fn setup_network_lo() -> Option> { 679 | return Some(thread::spawn(move || { 680 | utils::run_cmd("ip", &["link", "set", "dev", "lo", "up"]); 681 | })); 682 | } 683 | 684 | fn setup_network() -> Vec>> { 685 | let mut vec = vec![setup_network_lo()]; 686 | 687 | let cmdline = std::fs::read_to_string("/proc/cmdline").unwrap(); 688 | if cmdline.contains("virtme.dhcp") { 689 | if let Some(guest_tools_dir) = get_guest_tools_dir() { 690 | get_network_devices().into_iter().for_each(|network_dev| { 691 | vec.push(get_network_handle( 692 | network_dev, 693 | Some(guest_tools_dir.to_owned()), 694 | )); 695 | }); 696 | } 697 | } 698 | vec 699 | } 700 | 701 | fn extract_user_script(virtme_script: &str) -> Option { 702 | let start_marker = "virtme.exec=`"; 703 | let end_marker = '`'; 704 | 705 | let (_before, remaining) = virtme_script.split_once(start_marker)?; 706 | let (encoded_cmd, _after) = remaining.split_once(end_marker)?; 707 | String::from_utf8(BASE64.decode(encoded_cmd).ok()?).ok() 708 | } 709 | 710 | fn run_user_script(uid: u32) { 711 | if !std::path::Path::new("/dev/virtio-ports/virtme.stdin").exists() 712 | || !std::path::Path::new("/dev/virtio-ports/virtme.stdout").exists() 713 | || !std::path::Path::new("/dev/virtio-ports/virtme.stderr").exists() 714 | || !std::path::Path::new("/dev/virtio-ports/virtme.dev_stdout").exists() 715 | || !std::path::Path::new("/dev/virtio-ports/virtme.dev_stderr").exists() 716 | { 717 | log!("virtme-init: cannot find script I/O ports; make sure virtio-serial is available",); 718 | } else { 719 | // Re-create stdout/stderr to connect to the virtio-serial ports. 720 | let io_files = [ 721 | ("/dev/virtio-ports/virtme.ret", "/dev/virtme.ret"), 722 | ("/dev/virtio-ports/virtme.dev_stdin", "/dev/stdin"), 723 | ("/dev/virtio-ports/virtme.dev_stdout", "/dev/stdout"), 724 | ("/dev/virtio-ports/virtme.dev_stderr", "/dev/stderr"), 725 | ]; 726 | for (src, dst) in io_files.iter() { 727 | if !std::path::Path::new(src).exists() { 728 | continue; 729 | } 730 | if std::path::Path::new(dst).exists() { 731 | utils::do_unlink(dst); 732 | } 733 | utils::do_chown(src, uid, None).ok(); 734 | utils::do_symlink(src, dst); 735 | } 736 | 737 | // Detach the process from the controlling terminal 738 | let open_tty = 739 | |path| open(path, OFlag::O_RDWR, Mode::empty()).expect("failed to open console."); 740 | let tty_in = open_tty("/dev/virtio-ports/virtme.stdin"); 741 | let tty_out = open_tty("/dev/virtio-ports/virtme.stdout"); 742 | let tty_err = open_tty("/dev/virtio-ports/virtme.stderr"); 743 | 744 | // Determine if we need to switch to a different user, or if we can run the script as root. 745 | let user = env::var("virtme_user").unwrap_or_else(|_| String::new()); 746 | let (cmd, args) = if !user.is_empty() { 747 | ("su", vec![user.as_str(), "-c", USER_SCRIPT]) 748 | } else { 749 | ("/bin/sh", vec![USER_SCRIPT]) 750 | }; 751 | clear_virtme_envs(); 752 | unsafe { 753 | let ret = Command::new(cmd) 754 | .args(&args) 755 | .pre_exec(move || { 756 | nix::libc::setsid(); 757 | libc::close(libc::STDIN_FILENO); 758 | libc::close(libc::STDOUT_FILENO); 759 | libc::close(libc::STDERR_FILENO); 760 | // Make stdin a controlling tty. 761 | let stdin_fd = libc::dup2(tty_in, libc::STDIN_FILENO); 762 | nix::libc::ioctl(stdin_fd, libc::TIOCSCTTY, 1); 763 | libc::dup2(tty_out, libc::STDOUT_FILENO); 764 | libc::dup2(tty_err, libc::STDERR_FILENO); 765 | Ok(()) 766 | }) 767 | .output() 768 | .expect("Failed to execute script"); 769 | 770 | // Channel the return code to the host via /dev/virtme.ret 771 | if let Ok(mut file) = OpenOptions::new().write(true).open("/dev/virtme.ret") { 772 | // Write the value of output.status.code() to the file 773 | if let Some(code) = ret.status.code() { 774 | file.write_all(code.to_string().as_bytes()) 775 | .expect("Failed to write to file"); 776 | } else { 777 | // Handle the case where output.status.code() is None 778 | file.write_all(b"-1").expect("Failed to write to file"); 779 | } 780 | } 781 | } 782 | poweroff(); 783 | } 784 | } 785 | 786 | fn create_user_script(cmd: &str) { 787 | utils::create_file(USER_SCRIPT, 0o0755, cmd).expect("Failed to create virtme-script file"); 788 | } 789 | 790 | fn setup_user_script(uid: u32) { 791 | if let Ok(cmdline) = std::fs::read_to_string("/proc/cmdline") { 792 | if let Some(cmd) = extract_user_script(&cmdline) { 793 | create_user_script(&cmd); 794 | if env::var("virtme_graphics").is_err() { 795 | run_user_script(uid); 796 | } 797 | } 798 | } 799 | } 800 | 801 | fn setup_root_home() { 802 | // Set up a basic environment (unless virtme-ng is running as root on the host) 803 | if let Err(_) = env::var("virtme_root_user") { 804 | utils::do_mkdir("/run/tmp/roothome"); 805 | utils::do_mount("/run/tmp/roothome", "/root", "", libc::MS_BIND as usize, ""); 806 | env::set_var("HOME", "/run/tmp/roothome"); 807 | } else { 808 | env::set_var("HOME", "/root"); 809 | } 810 | } 811 | 812 | fn clear_virtme_envs() { 813 | // Parameters that start with virtme_* shouldn't pollute the environment. 814 | for (key, _) in env::vars() { 815 | if key.starts_with("virtme_") { 816 | env::remove_var(key); 817 | } 818 | } 819 | } 820 | 821 | // Redirect a file descriptor to another. 822 | fn redirect_fd(src_fd: i32, dst_fd: i32) { 823 | unsafe { 824 | libc::dup2(src_fd, dst_fd); 825 | } 826 | } 827 | 828 | // Redirect stdout/stderr to a new console device. 829 | fn redirect_console(consdev: &str) { 830 | let file = OpenOptions::new() 831 | .write(true) 832 | .open(consdev) 833 | .expect("Failed to open console device"); 834 | 835 | let fd = file.into_raw_fd(); 836 | 837 | let stdout = std::io::stdout(); 838 | let handle = stdout.lock(); 839 | let stdout_fd = handle.as_raw_fd(); 840 | redirect_fd(fd, stdout_fd); 841 | 842 | let stderr = std::io::stderr(); 843 | let handle = stderr.lock(); 844 | let stderr_fd = handle.as_raw_fd(); 845 | redirect_fd(fd, stderr_fd); 846 | } 847 | 848 | fn configure_terminal(consdev: &str, uid: u32) { 849 | // Set proper user ownership on the default console device 850 | utils::do_chown(&consdev, uid, None).ok(); 851 | 852 | // Redirect stdout/stderr to the new console device. 853 | redirect_console(&consdev); 854 | 855 | if let Ok(params) = env::var("virtme_stty_con") { 856 | let output = Command::new("stty") 857 | .args(params.split_whitespace()) 858 | .stdin(std::fs::File::open(consdev).unwrap()) 859 | .stdout(Stdio::inherit()) 860 | .stderr(Stdio::inherit()) 861 | // Replace the current init process with a shell session. 862 | .output(); 863 | log!("{}", String::from_utf8_lossy(&output.unwrap().stderr)); 864 | } 865 | } 866 | 867 | fn detach_from_terminal(tty_fd: libc::c_int) { 868 | // Detach the process from the controlling terminal 869 | unsafe { 870 | nix::libc::setsid(); 871 | libc::close(libc::STDIN_FILENO); 872 | libc::close(libc::STDOUT_FILENO); 873 | libc::close(libc::STDERR_FILENO); 874 | let stdin_fd = libc::dup2(tty_fd, libc::STDIN_FILENO); 875 | nix::libc::ioctl(stdin_fd, libc::TIOCSCTTY, 1); 876 | libc::dup2(tty_fd, libc::STDOUT_FILENO); 877 | libc::dup2(tty_fd, libc::STDERR_FILENO); 878 | } 879 | } 880 | 881 | fn run_shell(tty_fd: libc::c_int, args: &[&str]) { 882 | unsafe { 883 | Command::new("bash") 884 | .args(args) 885 | .pre_exec(move || { 886 | detach_from_terminal(tty_fd); 887 | Ok(()) 888 | }) 889 | .output() 890 | .expect("Failed to start shell session"); 891 | } 892 | } 893 | 894 | fn run_user_gui(tty_fd: libc::c_int) { 895 | // Generate a bare minimum xinitrc 896 | let xinitrc = "/run/tmp/.xinitrc"; 897 | 898 | // Check if we need to start the sound system. 899 | let mut pre_exec_cmd: String = String::new(); 900 | if let Ok(cmdline) = std::fs::read_to_string("/proc/cmdline") { 901 | if cmdline.contains("virtme.sound") { 902 | if let Some(guest_tools_dir) = get_guest_tools_dir() { 903 | pre_exec_cmd = format!("{}/virtme-sound-script", guest_tools_dir); 904 | } 905 | } 906 | } 907 | if let Err(err) = utils::create_file( 908 | xinitrc, 909 | 0o0644, 910 | &format!("{}\n/bin/bash {}", pre_exec_cmd, USER_SCRIPT), 911 | ) { 912 | log!("failed to generate {}: {}", xinitrc, err); 913 | return; 914 | } 915 | 916 | // Run graphical app using xinit directly 917 | let mut args = vec!["-l", "-c"]; 918 | let storage; 919 | if let Ok(user) = env::var("virtme_user") { 920 | // Try to fix permissions on the virtual consoles, we are starting X 921 | // directly here so we may need extra permissions on the tty devices. 922 | utils::run_cmd("bash", &["-c", &format!("chown {} /dev/char/*", user)]); 923 | 924 | // Start xinit directly. 925 | storage = format!("su {} -c 'xinit /run/tmp/.xinitrc'", user); 926 | args.push(&storage); 927 | } else { 928 | args.push("xinit /run/tmp/.xinitrc"); 929 | } 930 | run_shell(tty_fd, &args); 931 | } 932 | 933 | fn init_xdg_runtime_dir(uid: u32) { 934 | // $XDG_RUNTIME_DIR defines the base directory relative to which user-specific non-essential 935 | // runtime files and other file objects (such as sockets, named pipes, ...) should be stored. 936 | let dir = format!("/run/user/{}", uid); 937 | utils::do_mkdir(&dir); 938 | utils::do_chown(&dir, uid, None).ok(); 939 | env::set_var("XDG_RUNTIME_DIR", dir); 940 | } 941 | 942 | fn run_user_shell(tty_fd: libc::c_int) { 943 | let mut args = vec!["-l"]; 944 | let storage; 945 | if let Ok(user) = env::var("virtme_user") { 946 | args.push("-c"); 947 | storage = format!("su {}", user); 948 | args.push(&storage); 949 | } 950 | print_logo(); 951 | run_shell(tty_fd, &args); 952 | } 953 | 954 | fn run_user_session(consdev: &str, uid: u32) { 955 | let flags = OFlag::O_RDWR | OFlag::O_NONBLOCK; 956 | let mode = Mode::empty(); 957 | let tty_fd = open(consdev, flags, mode).expect("failed to open console"); 958 | 959 | setup_user_script(uid); 960 | 961 | if env::var("virtme_graphics").is_ok() { 962 | run_user_gui(tty_fd); 963 | } else { 964 | run_user_shell(tty_fd); 965 | } 966 | } 967 | 968 | fn setup_user_session() { 969 | let uid = env::var("virtme_user") 970 | .ok() 971 | .and_then(|user| utils::get_user_id(&user)) 972 | .unwrap_or(0); 973 | 974 | let consdev = match get_active_console() { 975 | Some(console) => console, 976 | None => { 977 | log!("failed to determine console"); 978 | Command::new("bash").arg("-l").exec(); 979 | return; 980 | } 981 | }; 982 | configure_terminal(consdev.as_str(), uid); 983 | init_xdg_runtime_dir(uid); 984 | setup_root_home(); 985 | 986 | log!("initialization done"); 987 | 988 | run_user_session(consdev.as_str(), uid); 989 | } 990 | 991 | fn run_sshd() { 992 | if let Ok(cmdline) = std::fs::read_to_string("/proc/cmdline") { 993 | if cmdline.contains("virtme.ssh") { 994 | if let Some(guest_tools_dir) = get_guest_tools_dir() { 995 | utils::run_cmd(format!("{}/virtme-sshd-script", guest_tools_dir), &[]); 996 | } 997 | } 998 | } 999 | } 1000 | 1001 | fn run_snapd() { 1002 | if let Ok(cmdline) = std::fs::read_to_string("/proc/cmdline") { 1003 | if cmdline.contains("virtme.snapd") { 1004 | // If snapd is present in the system try to start it, to properly support snaps. 1005 | let snapd_bin = "/usr/lib/snapd/snapd"; 1006 | if !Path::new(snapd_bin).exists() { 1007 | return; 1008 | } 1009 | let snapd_state = "/var/lib/snapd/state.json"; 1010 | if !Path::new(snapd_state).exists() { 1011 | return; 1012 | } 1013 | if let Some(guest_tools_dir) = get_guest_tools_dir() { 1014 | utils::run_cmd(format!("{}/virtme-snapd-script", guest_tools_dir), &[]); 1015 | } 1016 | Command::new(snapd_bin) 1017 | .stdin(Stdio::null()) 1018 | .stdout(Stdio::null()) 1019 | .stderr(Stdio::null()) 1020 | .spawn() 1021 | .ok(); 1022 | let snapd_apparmor_bin = "/usr/lib/snapd/snapd-apparmor"; 1023 | if Path::new(snapd_apparmor_bin).exists() { 1024 | Command::new(snapd_apparmor_bin) 1025 | .arg("start") 1026 | .stdin(Stdio::null()) 1027 | .stdout(Stdio::null()) 1028 | .stderr(Stdio::null()) 1029 | .output() 1030 | .ok(); 1031 | } 1032 | } 1033 | } 1034 | } 1035 | 1036 | fn extract_vsock_exec(cmdline: &str) -> Option { 1037 | let start_marker = "virtme.vsockexec=`"; 1038 | let end_marker = '`'; 1039 | 1040 | let (_before, remaining) = cmdline.split_once(start_marker)?; 1041 | let (encoded_cmd, _after) = remaining.split_once(end_marker)?; 1042 | Some(encoded_cmd.to_string()) 1043 | } 1044 | 1045 | fn setup_socat_console() { 1046 | if let Ok(cmdline) = std::fs::read_to_string("/proc/cmdline") { 1047 | if let Some(exec) = extract_vsock_exec(&cmdline) { 1048 | thread::spawn(move || { 1049 | log!("setting up vsock proxy executing {}", exec); 1050 | let key = "virtme_vsockmount"; 1051 | if let Ok(path) = env::var(&key) { 1052 | utils::do_mkdir(&path); 1053 | utils::do_mount( 1054 | &key.replace('_', "."), 1055 | &path, 1056 | "9p", 1057 | 0, 1058 | "version=9p2000.L,trans=virtio,access=any", 1059 | ); 1060 | } 1061 | 1062 | let from = "VSOCK-LISTEN:1024,reuseaddr,fork"; 1063 | let to = format!("EXEC:\"{}\",pty,stderr,setsid,sigint,sane,echo=0", exec); 1064 | let args = vec![from, &to]; 1065 | utils::run_cmd("socat", &args); 1066 | }); 1067 | } 1068 | } 1069 | } 1070 | 1071 | fn run_misc_services() -> thread::JoinHandle<()> { 1072 | thread::spawn(|| { 1073 | symlink_fds(); 1074 | mount_virtme_initmounts(); 1075 | fix_packaging_files(); 1076 | override_system_files(); 1077 | run_sshd(); 1078 | run_snapd(); 1079 | }) 1080 | } 1081 | 1082 | fn print_logo() { 1083 | let logo = r#" 1084 | _ _ 1085 | __ _(_)_ __| |_ _ __ ___ ___ _ __ __ _ 1086 | \ \ / / | __| __| _ _ \ / _ \_____| _ \ / _ | 1087 | \ V /| | | | |_| | | | | | __/_____| | | | (_| | 1088 | \_/ |_|_| \__|_| |_| |_|\___| |_| |_|\__ | 1089 | |___/"#; 1090 | println!("{}", logo.trim_start_matches('\n')); 1091 | println!(" kernel version: {}", get_kernel_version(true)); 1092 | println!(" (CTRL+d to exit)\n"); 1093 | } 1094 | 1095 | fn main() { 1096 | // Make sure to always run as PID 1. 1097 | check_init_pid(); 1098 | 1099 | // Basic system initialization (order is important here). 1100 | configure_environment(); 1101 | configure_hostname(); 1102 | mount_kernel_filesystems(); 1103 | mount_cgroupfs(); 1104 | configure_limits(); 1105 | mount_virtme_overlays(); 1106 | mount_sys_filesystems(); 1107 | mount_kernel_modules(); 1108 | run_systemd_tmpfiles(); 1109 | 1110 | // Service running in the background for later 1111 | setup_socat_console(); 1112 | 1113 | // Service initialization (some services can be parallelized here). 1114 | let mut handles = vec![run_udevd(), Some(run_misc_services())]; 1115 | handles.append(&mut setup_network()); 1116 | 1117 | // Wait for the completion of the detached services. 1118 | for handle in handles.into_iter().flatten() { 1119 | handle.join().unwrap(); 1120 | } 1121 | 1122 | // Start user session (batch or interactive). 1123 | set_cwd(); 1124 | setup_user_session(); 1125 | 1126 | // Shutdown the system. 1127 | poweroff(); 1128 | } 1129 | -------------------------------------------------------------------------------- /src/test.rs: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: GPL-3.0 2 | 3 | #[test] 4 | fn test_extract_user_script() { 5 | let input = "other=stuff virtme.exec=`SGVsbG8K` is=ignored"; 6 | assert_eq!( 7 | super::extract_user_script(input), 8 | Some("Hello\n".to_string()) 9 | ); 10 | } 11 | -------------------------------------------------------------------------------- /src/utils.rs: -------------------------------------------------------------------------------- 1 | // SPDX-License-Identifier: GPL-3.0 2 | 3 | //! virtme-ng-init: generic helper functions 4 | //! 5 | //! Author: Andrea Righi 6 | 7 | use nix::mount::{mount, MsFlags}; 8 | use nix::sys::stat::Mode; 9 | use nix::unistd::{chown, Gid, Uid}; 10 | use std::ffi::{CString, OsStr}; 11 | use std::fmt::Arguments; 12 | use std::fs::{File, OpenOptions}; 13 | use std::io::{self, Write}; 14 | use std::os::unix::fs; 15 | use std::os::unix::fs::PermissionsExt; 16 | use std::process::{Command, Stdio}; 17 | use users::get_user_by_name; 18 | 19 | macro_rules! log { 20 | ($($arg:tt)*) => { 21 | $crate::utils::log_impl(std::format_args!($($arg)*)) 22 | }; 23 | } 24 | 25 | pub fn log_impl(msg: Arguments<'_>) { 26 | static PREFIX: &str = "<6>virtme-ng-init: "; 27 | static LOG_LEVEL: &str = "<6>"; 28 | 29 | let mut msg = format!("{}{}", PREFIX, msg); 30 | 31 | // Remove all trailing \n 32 | while msg.ends_with('\n') { 33 | msg.pop(); 34 | } 35 | 36 | // Was the message empty? If so, do not log anything 37 | if PREFIX == msg { 38 | return; 39 | } 40 | 41 | match OpenOptions::new().write(true).open("/dev/kmsg") { 42 | Ok(mut file) => { 43 | msg.push('\n'); 44 | file.write_all(msg.as_bytes()).ok(); 45 | } 46 | Err(_) => { 47 | println!( 48 | "{}", 49 | msg.strip_prefix(LOG_LEVEL) 50 | .expect("The message should always start with the log level") 51 | ); 52 | } 53 | } 54 | } 55 | 56 | pub fn get_user_id(username: &str) -> Option { 57 | Some(get_user_by_name(username)?.uid()) 58 | } 59 | 60 | pub fn do_chown(path: &str, uid: u32, gid: Option) -> std::io::Result<()> { 61 | let gid_option = gid.map(|gid| Gid::from_raw(gid)); 62 | 63 | chown(path, Some(Uid::from_raw(uid)), gid_option) 64 | .map_err(|err| io::Error::new(std::io::ErrorKind::Other, err))?; 65 | 66 | Ok(()) 67 | } 68 | 69 | pub fn do_mkdir(path: &str) { 70 | let dmask = Mode::S_IRWXU | Mode::S_IRGRP | Mode::S_IXGRP | Mode::S_IROTH | Mode::S_IXOTH; 71 | nix::unistd::mkdir(path, dmask).ok(); 72 | } 73 | 74 | pub fn do_unlink(path: &str) { 75 | match std::fs::remove_file(path) { 76 | Ok(_) => (), 77 | Err(err) => { 78 | log!("failed to unlink file {}: {}", path, err); 79 | } 80 | } 81 | } 82 | 83 | fn do_touch(path: &str, mode: u32) { 84 | fn _do_touch(path: &str, mode: u32) -> std::io::Result<()> { 85 | let file = File::create(path)?; 86 | let permissions = std::fs::Permissions::from_mode(mode); 87 | file.set_permissions(permissions)?; 88 | 89 | Ok(()) 90 | } 91 | if let Err(err) = _do_touch(path, mode) { 92 | log!("error creating file: {}", err); 93 | } 94 | } 95 | 96 | pub fn create_file(fname: &str, mode: u32, content: &str) -> io::Result<()> { 97 | do_touch(fname, mode); 98 | if !content.is_empty() { 99 | let mut file = File::create(fname)?; 100 | file.write_all(content.as_bytes())?; 101 | } 102 | 103 | Ok(()) 104 | } 105 | 106 | pub fn do_symlink(src: &str, dst: &str) { 107 | match fs::symlink(src, dst) { 108 | Ok(_) => (), 109 | Err(err) => { 110 | log!("failed to create symlink {} -> {}: {}", src, dst, err); 111 | } 112 | } 113 | } 114 | 115 | pub fn do_mount_check( 116 | source: &str, 117 | target: &str, 118 | fstype: &str, 119 | flags: usize, 120 | fsdata: &str, 121 | ) -> Result<(), nix::Error> { 122 | let source_cstr = CString::new(source).expect("CString::new failed"); 123 | let fstype_cstr = CString::new(fstype).expect("CString::new failed"); 124 | let fsdata_cstr = CString::new(fsdata).expect("CString::new failed"); 125 | 126 | let result = mount( 127 | Some(source_cstr.as_ref()), 128 | target, 129 | Some(fstype_cstr.as_ref()), 130 | MsFlags::from_bits_truncate(flags.try_into().unwrap()), 131 | Some(fsdata_cstr.as_ref()), 132 | ); 133 | 134 | result 135 | } 136 | 137 | pub fn do_mount(source: &str, target: &str, fstype: &str, flags: usize, fsdata: &str) { 138 | let result = do_mount_check(source, target, fstype, flags, fsdata); 139 | if let Err(err) = result { 140 | if err != nix::errno::Errno::ENOENT { 141 | log!("mount {} -> {}: {}", source, target, err); 142 | } 143 | } 144 | } 145 | 146 | pub fn run_cmd(cmd: impl AsRef, args: &[&str]) { 147 | let output = Command::new(&cmd) 148 | .args(args) 149 | .stdin(Stdio::null()) 150 | .stdout(Stdio::piped()) 151 | .stderr(Stdio::piped()) 152 | .output(); 153 | 154 | match output { 155 | Ok(output) => { 156 | if !output.stderr.is_empty() { 157 | log!( 158 | "{}", 159 | String::from_utf8_lossy(&output.stderr).trim_end_matches('\n') 160 | ); 161 | } 162 | } 163 | Err(_) => { 164 | log!( 165 | "WARNING: failed to run: {:?} {}", 166 | cmd.as_ref(), 167 | args.join(" ") 168 | ); 169 | } 170 | } 171 | } 172 | --------------------------------------------------------------------------------