Şahan Yılmaz Romtal Sistem Dondurma

This commit is contained in:
Şahan Yılmaz 2025-03-29 23:00:00 +03:00
commit b66615c654
55 changed files with 4888 additions and 0 deletions

676
COPYING Normal file
View file

@ -0,0 +1,676 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.

51
Makefile Normal file
View file

@ -0,0 +1,51 @@
MODULES =romtal-sistem-dondurma
INITRAMFS_D = /usr/share/initramfs-tools
IRD = $(DESTDIR)/$(INITRAMFS_D)
build:
install:
mkdir -p "$(IRD)/hooks" "$(IRD)/scripts" "$(DESTDIR)/etc"
set -e; for d in $(MODULES); do \
[ -d "$$d/hooks" ] || continue ; \
install "$$d/hooks"/* "$(IRD)/hooks" ; \
done
set -e ; for d in $(MODULES); do \
for sd in $$d/scripts/*; do \
[ -d $$sd ] || continue; \
td="$(IRD)/scripts/$${sd##*/}"; \
mkdir -p "$$td" ; \
install "$$sd"/* "$$td"; \
done; done
set -e ; for d in $(MODULES); do \
[ -d $$d/conf-hooks.d/ ] || continue; \
mkdir -p "$(IRD)/conf-hooks.d"; \
install -m 644 "$$d/conf-hooks.d"/* "$(IRD)/conf-hooks.d/" ; \
done
set -e; for d in $(MODULES); do \
[ -d "$$d/etc" ] || continue ; \
for f in $$d/etc/*; do \
if [ -d "$$f" ];then \
install -m 755 -d "$(DESTDIR)/etc/$${f##*/}" ; \
install "$$f"/* "$(DESTDIR)/etc/$${f##*/}" ; \
continue ; \
fi ;\
install -m 644 -t "$(DESTDIR)/etc" "$$f" ;\
done; done
set -e; for d in $(MODULES); do \
[ -d "$$d/tools" ] || continue ; \
mkdir -p "$(ULIB_PRE)$$d/" && \
install "$$d/tools"/* "$(ULIB_PRE)$$d/" ; \
done
mkdir -p "$(DESTDIR)/usr/sbin" "$(DESTDIR)/bin" "$(DESTDIR)/usr/share/man/man8"
install -m 755 "romtal-sistem-dondurma/usr/sbin/overlayroot-chroot" "$(DESTDIR)/usr/sbin"
install -m 755 "romtal-sistem-dondurma/bin/romtalsd" "$(DESTDIR)/bin/"
install -m 644 "romtal-sistem-dondurma/usr/share/man/man8/overlayroot-chroot.8" "$(DESTDIR)/usr/share/man/man8"
#
# Fedora/EPEL
#
# vi: ts=4 noexpandtab syntax=make

111
README.md Normal file
View file

@ -0,0 +1,111 @@
# Romtal Sistem Dondurma
**Romtal Sistem Dondurma**, overlayroot tabanlı sistem dondurma işlemini yönetmek için geliştirilmiş, GTK destekli grafik arayüz sunan bir araçtır. Bu proje, özellikle sistemde istenmeyen kalıcı değişikliklerin önüne geçmek amacıyla tasarlanmıştır. Kurulum, .deb paketi aracılığıyla gerçekleştirilir ve sistem entegrasyonu bu yöntemle sağlanır.
---
## Özellikler
- **GTK Tabanlı GUI:** Modern ve kullanıcı dostu arayüz ile sistem dondurma işlemleri.
- **Overlayroot Entegrasyonu:** Sistemin kök dosya sistemini geçici hale getirerek yapılan değişikliklerin silinmesini sağlar.
- **Kurulum Sihirbazı:** İlk çalıştırmada, güvenlik açısından nonroot (önerilen: "ogrenci") kullanıcı oluşturulması önerilir.
- **Root Yetkilendirme:** pkexec ile gerekli sistem komutlarını güvenli bir şekilde çalıştırır.
---
## Gereksinimler
- Debian tabanlı Linux dağıtımları (Debian, Pardus, Ubuntu vb.)
- Root erişimi (pkexec kullanımı nedeniyle)
- GTK 3 kütüphanesi
---
## Kurulum
### Paket Kurulumu
1. **.deb Dosyasını İndirin:**
[romtal-sistem-dondurma_1.0.0-pardus_all.deb](https://codeberg.org/shaanylmz/romtal-sistem-dondurma/src/branch/main/build/romtal-sistem-dondurma_1.0.0-pardus_all.deb)
2. **Paketi Yükleyin:**
Terminali açın ve aşağıdaki komutu çalıştırın (dosya yolunu sisteminizdeki konuma göre düzenleyin):
```bash
sudo dpkg -i /path/to/romtal-sistem-dondurma_1.0.0-pardus_all.deb
```
3. **Bağımlılık Hatalarını Giderin:**
Eğer paket kurulumu sırasında eksik bağımlılık uyarısı alırsanız:
```bash
sudo apt-get install -f
```
> **Not:** .deb paketi, gerekli konfigürasyon dosyalarını ve sistem entegrasyonunu otomatik olarak yapar. Binary dosya tek başına çalıştırıldığında istenen entegrasyon sağlanamaz, bu yüzden paket kurulumu tercih edilmelidir.
---
## Kullanım
1. **Programı Başlatın:**
Paket kurulumu tamamlandıktan sonra, programı root yetkileriyle çalıştırmak için terminalden:
```bash
sudo romtalsd
```
2. **Kurulum Sihirbazı:**
- İlk çalıştırmada, henüz kurulum bayrağı oluşturulmamışsa (örneğin `~/.setup_tamam`), kurulum sihirbazıılır.
- Sihirbaz, sistemde güvenliği artırmak amacıyla nonroot kullanıcı (önerilen: "ogrenci") oluşturulmasını içerir.
- İlgili adımları takip ederek veya sihirbazı atlayarak ana arayüze geçiş yapabilirsiniz.
3. **Ana Arayüz İşlevleri:**
Ana GUI penceresinde sunulan seçenekler:
- **Sistem Dondurma Aktif Et:** Overlayroot konfigürasyonunu ayarlayarak sistemi dondurur.
(Değişikliklerin geçerli olabilmesi için yeniden başlatma gerekebilir.)
- **Sistem Dondurma Devre Dışı:** Overlayroot ayarlarını temizleyerek dondurma işlemini sonlandırır.
(Sistem yeniden başlatılmalıdır.)
4. **Geri Bildirim:**
Her işlem, GTK diyalog pencereleri ile kullanıcıya bilgi veya hata mesajları sunar.
---
## Geliştirici ve Destek
**Geliştiriciler:**
- **R.O.M.T.A.L**
[https://rasimoneltml.meb.k12.tr/](https://rasimoneltml.meb.k12.tr/)
- **Şahan Yılmaz**
(sahan@chrona.org.tr)
*Bu bir okul projesidir.*
---
## Katkıda Bulunma
Proje ile ilgili katkı ve geri bildirimler için:
- **Issue Açın:** Proje sayfasındaki issue bölümünü kullanarak hata raporu veya önerilerinizi paylaşın.
- **Pull Request Gönderin:** Geliştirme yapıyorsanız, forkladığınız projede yaptığınız değişiklikleri pull request olarak gönderin.
---
## Lisans
Bu proje, **GNU GENERAL PUBLIC LICENSE Version 3** kapsamında lisanslanmıştır. Detaylı lisans bilgileri için lütfen proje dizinindeki **COPYING** dosyasına bakınız.
---
## İletişim
Her türlü soru, öneri veya katkı için Codeberg üzerindeki proje sayfası üzerinden iletişime geçebilirsiniz.

Binary file not shown.

View file

@ -0,0 +1,8 @@
debian/tmp/etc/overlayroot.conf
debian/tmp/etc/update-motd.d
debian/tmp/usr/sbin/overlayroot-chroot
debian/tmp/bin/romtalsd
debian/tmp/usr/share/initramfs-tools/hooks/overlayroot
debian/tmp/usr/share/initramfs-tools/scripts/init-bottom/overlayroot
debian/tmp/usr/share/initramfs-tools/conf-hooks.d/overlayroot
debian/tmp/usr/share/man/man8/overlayroot-chroot.8

View file

@ -0,0 +1 @@
./README

View file

@ -0,0 +1,2 @@
# Triggers added by dh_installinitramfs/13.6ubuntu1
activate-noawait update-initramfs

5
debian/changelog vendored Normal file
View file

@ -0,0 +1,5 @@
romtal-sistem-dondurma (1.0.0-pardus) yirmiuc; urgency=medium
* Initial release for PPA.
-- Şahan Yılmaz <sahan@chrona.org.tr> Sat, 22 Feb 2025 01:05:12 +0300

1
debian/compat vendored Normal file
View file

@ -0,0 +1 @@
13

29
debian/control vendored Normal file
View file

@ -0,0 +1,29 @@
Source: romtal-sistem-dondurma
Section: admin
Priority: optional
Maintainer: Şahan Yılmaz <sahan@chrona.org.tr>
Uploaders: Şahan Yılmaz <sahan@chrona.org.tr>
Build-Depends: debhelper (>= 9)
Standards-Version: 1.0.0
Homepage: https://www.launchpad.net/romtal-sistem-dondurma
Package: romtal-sistem-dondurma
Architecture: all
Depends: cryptsetup,
cryptsetup-bin,
initramfs-tools,
python3,
${misc:Depends},
${shlibs:Depends}
Suggests: haveged
Description: use an overlayfs on top of a read-only root filesystem
This package adds functionality to an initramfs built by initramfs-tools.
When installed and configured, the initramfs will mount an overlayfs
filesystem on top of a read-only root volume.
.
The changes can be written to a in-memory temporary filesystem, a
filesystem on an existing block device, or a dmcrypt encrypted block
device.
R.O.M.T.A.L DeepFreeze, Linux sistemlerde sistem yapılandırmasının kalıcı olarak değişmesini önlemek ve geçici çalıştırma ortamları oluşturmak için tasarlanmış bir güvenlik ve kararlılık aracıdır. Bu paket, sistem dosyalarının veya yapılandırmaların yapılan değişikliklerle kalıcı hale gelmesini engellemek amacıyla “overlay” tekniğini kullanır. İşleyiş biçimi, sistemin gerçek dosya sistemi üzerine geçici bir katman (genellikle tmpfs tabanlı) ekleyerek, yapılan değişikliklerin sistem yeniden başlatıldığında otomatik olarak sıfırlanmasını sağlar. https://rasimoneltml.meb.k12.tr/

31
debian/copyright vendored Normal file
View file

@ -0,0 +1,31 @@
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Upstream-Name: cloud-initramfs-tools
Files: *
Copyright: 2011 Scott Moser <scott.moser@canonical.com>
License: GPL-3.0+
Files: debian/*
Copyright:
2011 Scott Moser <smoser@ubuntu.com>
2012 Dustin Kirkland <kirkland@ubuntu.com>
2012 Axel Heider
2024 Canonical Ltd.
License: GPL-3.0+
License: GPL-3.0+
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
.
This package is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
.
On Debian systems, the complete text of the GNU General
Public License version 3 can be found in "/usr/share/common-licenses/GPL-3".

1
debian/debhelper-build-stamp vendored Normal file
View file

@ -0,0 +1 @@
romtal-sistem-dondurma

1
debian/docs vendored Normal file
View file

@ -0,0 +1 @@
README

2
debian/files vendored Normal file
View file

@ -0,0 +1,2 @@
romtal-sistem-dondurma_1.0.0-pardus_all.deb admin optional
romtal-sistem-dondurma_1.0.0-pardus_amd64.buildinfo admin optional

View file

@ -0,0 +1 @@
dh_auto_install

8
debian/romtal-sistem-dondurma.install vendored Normal file
View file

@ -0,0 +1,8 @@
etc/overlayroot.conf
etc/update-motd.d
usr/sbin/overlayroot-chroot
bin/romtalsd
usr/share/initramfs-tools/hooks/overlayroot
usr/share/initramfs-tools/scripts/*/overlayroot
usr/share/initramfs-tools/conf-hooks.d/overlayroot
usr/share/man/man8/overlayroot-chroot.8

13
debian/romtal-sistem-dondurma.postinst vendored Normal file
View file

@ -0,0 +1,13 @@
#!/bin/sh
set -e
case "$1" in
configure)
dpkg-trigger update-initramfs;;
*) exit 0;;
esac
#DEBHELPER#
exit 0
# vi: ts=4 noexpandtab

14
debian/romtal-sistem-dondurma.postrm vendored Normal file
View file

@ -0,0 +1,14 @@
#!/bin/sh
set -e
case "$1" in
remove|purge)
dpkg-trigger update-initramfs;;
*) exit 0;;
esac
#DEBHELPER#
exit 0
# vi: ts=4 noexpandtab

View file

@ -0,0 +1,2 @@
misc:Depends=
misc:Pre-Depends=

View file

@ -0,0 +1,2 @@
/etc/overlayroot.conf
/etc/update-motd.d/97-overlayroot

View file

@ -0,0 +1,19 @@
Package: romtal-sistem-dondurma
Version: 1.0.0-pardus
Architecture: all
Maintainer: Şahan Yılmaz <sahan@chrona.org.tr>
Installed-Size: 68
Depends: cryptsetup, cryptsetup-bin, initramfs-tools, python3
Suggests: haveged
Section: admin
Priority: optional
Homepage: https://www.launchpad.net/romtal-sistem-dondurma
Description: use an overlayfs on top of a read-only root filesystem
This package adds functionality to an initramfs built by initramfs-tools.
When installed and configured, the initramfs will mount an overlayfs
filesystem on top of a read-only root volume.
.
The changes can be written to a in-memory temporary filesystem, a
filesystem on an existing block device, or a dmcrypt encrypted block
device.
R.O.M.T.A.L DeepFreeze, Linux sistemlerde sistem yapılandırmasının kalıcı olarak değişmesini önlemek ve geçici çalıştırma ortamları oluşturmak için tasarlanmış bir güvenlik ve kararlılık aracıdır. Bu paket, sistem dosyalarının veya yapılandırmaların yapılan değişikliklerle kalıcı hale gelmesini engellemek amacıyla “overlay” tekniğini kullanır. İşleyiş biçimi, sistemin gerçek dosya sistemi üzerine geçici bir katman (genellikle tmpfs tabanlı) ekleyerek, yapılan değişikliklerin sistem yeniden başlatıldığında otomatik olarak sıfırlanmasını sağlar. https://rasimoneltml.meb.k12.tr/

View file

@ -0,0 +1,9 @@
0f9f9c2689c58c758bc4b576c91d07a6 bin/romtalsd
78db8ba50efd0e523fe4b06083b67dcd usr/sbin/overlayroot-chroot
213f7cda911239a108c2c9eb87c9cc8d usr/share/doc/romtal-sistem-dondurma/README
829285930029ae87f0be17ff6ad6b765 usr/share/doc/romtal-sistem-dondurma/changelog.Debian.gz
d83c42e522a362610b374c35ca056cf8 usr/share/doc/romtal-sistem-dondurma/copyright
94661160a717bcc5639fef40546a7e14 usr/share/initramfs-tools/conf-hooks.d/overlayroot
349725f825813b1ca87b785ce13c09ee usr/share/initramfs-tools/hooks/overlayroot
1ed8aabdf65f9f565fbb26a193a25826 usr/share/initramfs-tools/scripts/init-bottom/overlayroot
e80e667ae504860007cd71006f05e999 usr/share/man/man8/overlayroot-chroot.8.gz

13
debian/romtal-sistem-dondurma/DEBIAN/postinst vendored Executable file
View file

@ -0,0 +1,13 @@
#!/bin/sh
set -e
case "$1" in
configure)
dpkg-trigger update-initramfs;;
*) exit 0;;
esac
exit 0
# vi: ts=4 noexpandtab

14
debian/romtal-sistem-dondurma/DEBIAN/postrm vendored Executable file
View file

@ -0,0 +1,14 @@
#!/bin/sh
set -e
case "$1" in
remove|purge)
dpkg-trigger update-initramfs;;
*) exit 0;;
esac
exit 0
# vi: ts=4 noexpandtab

View file

@ -0,0 +1,2 @@
# Triggers added by dh_installinitramfs/13.6ubuntu1
activate-noawait update-initramfs

172
debian/romtal-sistem-dondurma/bin/romtalsd vendored Executable file
View file

@ -0,0 +1,172 @@
#!/usr/bin/env python3
import os
import subprocess
import sys
import gi
gi.require_version('Gtk', '3.0')
from gi.repository import Gtk, Gdk
def run_as_root(cmd_list):
"""
Verilen komut listesini pkexec ile root olarak çalıştırır.
"""
try:
subprocess.run(["pkexec"] + cmd_list, check=True)
except subprocess.CalledProcessError as e:
raise RuntimeError(f"Komut hatası: {e.cmd}, Çıkış kodu: {e.returncode}")
def get_mount_device(mount_point):
"""
/proc/mounts dosyasını okuyarak, verilen mount noktasının bağlı olduğu cihazı döner.
Args:
mount_point (str): İncelenecek mount noktası, örneğin "/media/root-ro".
Returns:
str veya None: Mount edilmiş aygıtın adı (örneğin, "/dev/sda1")
veya belirtilen mount noktası bulunamazsa None.
"""
try:
with open("/proc/mounts", "r") as f:
for line in f:
parts = line.split()
if parts[1] == mount_point:
return parts[0]
except Exception:
pass
return None
def overlay_status():
"""
/etc/overlayroot.conf dosyasını ve /media/root-rw mount noktasını kontrol eder:
- Eğer /media/root-rw mount edilmişse, overlay aktif kabul edilir.
- Aksi halde, /etc/overlayroot.conf dosyasını açar; içeriğinde "tmpfs" ifadesi varsa overlay aktif,
yoksa overlay pasif olarak belirlenir.
"""
# İlk olarak /media/root-rw mount edilip edilmediğini kontrol et
if get_mount_device("/media/root-rw"):
return True
# /etc/overlayroot.conf kontrolü
conf_path = "/etc/overlayroot.conf"
if os.path.exists(conf_path):
try:
with open(conf_path, "r") as f:
content = f.read()
return "tmpfs" in content
except Exception:
return False
else:
# Dosya yoksa paket kontrolü yapılabilir
try:
result = subprocess.run(["dpkg", "-l", "romtal-sistem-dondurma"], capture_output=True, text=True)
return "overlayroot" in result.stdout
except Exception:
return False
class OverlayrootGUI(Gtk.Window):
def __init__(self):
super().__init__(title="R.O.M.T.A.L Sistem Dondurma")
self.set_default_size(400, 250)
self.set_border_width(20)
# Stil ayarları
css = b"""
button {
font: 15px Arial;
padding: 10px;
margin: 5px;
}
"""
style_provider = Gtk.CssProvider()
style_provider.load_from_data(css)
Gtk.StyleContext.add_provider_for_screen(
Gdk.Screen.get_default(),
style_provider,
Gtk.STYLE_PROVIDER_PRIORITY_APPLICATION
)
self.overlay_enabled = overlay_status()
self.create_ui()
def create_ui(self):
grid = Gtk.Grid(column_spacing=10, row_spacing=10)
self.enable_btn = Gtk.Button(label="Sistem Dondurma Aktif Et")
self.disable_btn = Gtk.Button(label="Sistem Dondurma Devre Dışı Bırak")
self.enable_btn.connect("clicked", self.enable_overlayroot)
self.disable_btn.connect("clicked", self.disable_overlayroot)
self.status_label = Gtk.Label()
self.update_status()
# Footer label ekliyoruz
self.footer_label = Gtk.Label(label="Made By R.O.M.T.A.L | https://rasimoneltml.meb.k12.tr/")
grid.attach(self.status_label, 0, 0, 2, 1)
grid.attach(self.enable_btn, 0, 1, 1, 1)
grid.attach(self.disable_btn, 1, 1, 1, 1)
grid.attach(self.footer_label, 0, 2, 2, 1)
self.add(grid)
def update_status(self):
status_text = "Şuanki Durum: " + ("Aktif" if self.overlay_enabled else "Devre Dışı")
self.status_label.set_markup(f"<b>{status_text}</b>")
self.enable_btn.set_sensitive(not self.overlay_enabled)
self.disable_btn.set_sensitive(self.overlay_enabled)
def show_dialog(self, message, is_error=False):
dialog = Gtk.MessageDialog(
parent=self,
flags=0,
message_type=Gtk.MessageType.ERROR if is_error else Gtk.MessageType.INFO,
buttons=Gtk.ButtonsType.OK,
text=message
)
dialog.run()
dialog.destroy()
def enable_overlayroot(self, widget):
try:
cmd = [
"sh", "-c",
("rm -f /etc/overlayroot.conf && "
"echo 'overlayroot_cfgdisk=\"disable\"' > /etc/overlayroot.conf && "
"echo 'overlayroot=\"tmpfs\"' >> /etc/overlayroot.conf")
]
run_as_root(cmd)
self.overlay_enabled = True
self.update_status()
self.show_dialog("Overlayroot aktif edildi!\nDeğişikliklerin geçerli olması için yeniden başlatın.")
except Exception as e:
self.show_dialog(f"Hata oluştu: {str(e)}", is_error=True)
def disable_overlayroot(self, widget):
try:
device = get_mount_device("/media/root-ro")
if not device:
raise RuntimeError("'/media/root-ro' mount edilen cihaz bulunamadı.")
cmd = [
"sh", "-c",
(f"mount -o remount,rw {device} && "
"rm -f /media/root-ro/etc/overlayroot.conf && "
"echo 'overlayroot_cfgdisk=\"disable\"' > /media/root-ro/etc/overlayroot.conf && "
"echo 'overlayroot=\"\"' >> /media/root-ro/etc/overlayroot.conf")
]
run_as_root(cmd)
self.overlay_enabled = False
self.update_status()
self.show_dialog("Overlayroot devre dışı bırakıldı!\nDeğişikliklerin geçerli olması için yeniden başlatın.")
except Exception as e:
self.show_dialog(f"Hata oluştu: {str(e)}", is_error=True)
if __name__ == "__main__":
win = OverlayrootGUI()
win.connect("destroy", Gtk.main_quit)
win.show_all()
Gtk.main()

View file

@ -0,0 +1,2 @@
overlayroot_cfgdisk="disabled"
overlayroot=""

View file

@ -0,0 +1,4 @@
#!/bin/sh
(egrep "overlayroot|/media/root-ro|/media/root-rw" /proc/mounts 2>/dev/null | sort -r) || true
echo

View file

@ -0,0 +1,93 @@
#!/bin/sh
#
# overlayroot-chroot - chroot wrapper script for overlayroot
# Copyright (C) 2012 Dustin Kirkland <kirkland@ubuntu.com>
#
# Authors: Dustin Kirkland <kirkland@ubuntu.com>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, version 3 of the License.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
set -e
set -f # disable path expansion
REMOUNTS=""
error() {
printf "ERROR: $@\n" 1>&2
}
fail() { [ $# -eq 0 ] || error "$@"; exit 1; }
info() {
printf "INFO: $@\n" 1>&2
}
get_lowerdir() {
local overlay=""
overlay=$(awk \
'$1 == "overlayroot" && $2 == "/" { print $0 }' /proc/mounts)
if [ -n "${overlay}" ]; then
lowerdir=${overlay##*lowerdir=}
lowerdir=${lowerdir%%,*}
if mountpoint "${lowerdir}" >/dev/null; then
_RET="${lowerdir}"
else
fail "Unable to find the overlayroot lowerdir"
fi
else
fail "Unable to find an overlayroot filesystem"
fi
}
clean_exit() {
local mounts="$1" rc=0 d="" lowerdir="" mp=""
for d in ${mounts}; do
if mountpoint ${d} >/dev/null; then
umount ${d} || rc=1
fi
done
for mp in $REMOUNTS; do
mount -o remount,ro "${mp}" ||
error "Note that [${mp}] is still mounted read/write"
done
[ "$2" = "return" ] && return ${rc} || exit ${rc}
}
# Try to find the overlayroot filesystem
get_lowerdir
lowerdir=${_RET}
recurse_mps=$(awk '$1 ~ /^\/dev\// && $2 ~ starts { print $2 }' \
starts="^$lowerdir/" /proc/mounts)
mounts=
for d in proc run sys; do
if ! mountpoint "${lowerdir}/${d}" >/dev/null; then
mount -o bind "/${d}" "${lowerdir}/${d}" || fail "Unable to bind /${d}"
mounts="$mounts $lowerdir/$d"
trap "clean_exit \"${mounts}\" || true" EXIT HUP INT QUIT TERM
fi
done
# Remount with read/write
for mp in "$lowerdir" $recurse_mps; do
mount -o remount,rw "${mp}" &&
REMOUNTS="$mp $REMOUNTS" ||
fail "Unable to remount [$mp] writable"
done
info "Chrooting into [${lowerdir}]"
chroot ${lowerdir} "$@"
# Clean up mounts on exit
clean_exit "${mounts}" "return"
trap "" EXIT HUP INT QUIT TERM
# vi: ts=4 noexpandtab

View file

@ -0,0 +1,55 @@
This source repository builds packages that work with initramfs-tools
to add function to an initramfs that is likely cloud specific.
Most likely, you do not want to install these packages unless you know
what you're doing.
== growroot ==
This initramfs module will re-write the partition table of a disk
so that the root partition has as much space as possible, bumping it
up to the edge of the disk, or the edge of the next partition.
This is valueable in an environment where a volume can be grown past
its original size. It addresses the following situation:
* The initial [virtual] disk has a partition table on it
* The provisioning system creates a volume with additional space
at the end of the disk (after the root partition)
* the system boots, but cannot use the additional space without a reboot
because the kernel will not re-read the partition table information
of a disk that is in use.
The way this is addressed is:
* in the initramfs unmount the root filesystem
* rewrite the partition table
* tell the kernel to re-read
* remount the root filesystem
== rescuevol ==
When installed the initramfs will check to see if any partitions
with a label of 'RESCUE_VOL' are attached. If such a volume is attached,
it will boot off that volume rather than the root volume.
This is useful in a cloud environment, when the user is able to attach
and detach volumes to a running system, but has no other mechanism
for interupting of fixing a failed boot. It is analogous to inserting
a rescue CD into a system to recover from failure.
It may be helpful in the case where the kernel and ramdisk can be loaded
from the instance, but the system is unusable. This could occur if
an error left ssh access broken or the system didn't come all the way up.
The user could attach a correctly labeled volume, reboot the instance
and access the system to fix it.
If the volume contains a file '/etc/rescuevol-ignore' it will be ignored.
This allows you to fix your instance, create that volume and *not* boot the
rescue volume on next boot
== overlayroot ==
Configure overlayfs filesystems over the root device based on
configuration provided by kernel command line or in-image config.
see overlayroot/etc/overlayroot.conf for more information.
== dyn-netconf ==
see dyn-netconf/doc/README.txt

View file

@ -0,0 +1,31 @@
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Upstream-Name: cloud-initramfs-tools
Files: *
Copyright: 2011 Scott Moser <scott.moser@canonical.com>
License: GPL-3.0+
Files: debian/*
Copyright:
2011 Scott Moser <smoser@ubuntu.com>
2012 Dustin Kirkland <kirkland@ubuntu.com>
2012 Axel Heider
2024 Canonical Ltd.
License: GPL-3.0+
License: GPL-3.0+
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
.
This package is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
.
On Debian systems, the complete text of the GNU General
Public License version 3 can be found in "/usr/share/common-licenses/GPL-3".

View file

@ -0,0 +1 @@
export CRYPTSETUP=y

View file

@ -0,0 +1,25 @@
#!/bin/sh
set -e
PREREQS="cryptsetup"
case $1 in
prereqs) echo "${PREREQS}"; exit 0;;
esac
. /usr/share/initramfs-tools/hook-functions
##
copy_exec /usr/bin/head /bin
copy_exec /usr/bin/sha512sum /bin
copy_exec /sbin/wipefs /sbin
copy_exec /sbin/cryptsetup /sbin
copy_exec /sbin/mke2fs /sbin
# this is '||' only in case aesni_intel module isn't built (or others are built in)
manual_add_modules overlayfs overlay dm_mod dm_crypt aesni_intel || true
# Grab as much true random data as possible, up to 4KB, and stash it into a
# random seed in the initramfs
dd if=/dev/random of="${DESTDIR}/.random-seed" bs=1 count=4096 iflag=nonblock >/dev/null 2>&1 || true
# vi: ts=4 noexpandtab

View file

@ -0,0 +1,878 @@
#!/bin/sh
# Copyright, 2012 Dustin Kirkland <kirkland@ubuntu.com>
# Copyright, 2012 Scott Moser <smoser@ubuntu.com>
# Copyright, 2012 Axel Heider
#
# Based on scripts from
# Sebastian P.
# Nicholas A. Schembri State College PA USA
# Axel Heider
# Dustin Kirkland
# Scott Moser
#
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see
# <http://www.gnu.org/licenses/>.
case "$1" in
# no pre-reqs
prereqs) echo ""; exit 0;;
esac
. /scripts/functions
PATH=/usr/sbin:/usr/bin:/sbin:/bin
MYTAG="overlayroot"
TEMP_D="${TMPDIR:-/tmp}/${0##*/}.configs"
VARIABLES="overlayroot overlayroot_cfgdisk"
# generic settings
# ${ROOT} and ${rootmnt} are predefined by caller of this script. Note that
# the root fs ${rootmnt} it mounted readonly on the initrams, which fits
# nicely for our purposes.
root_rw=/media/root-rw
root_ro=/media/root-ro
ROOTMNT=${rootmnt} # use global name to indicate created outside this
OVERLAYROOT_DEBUG=0
# PERSIST_DIR will persist after pivot-root. It is used for log file
# and for the mktemp-made password file in crypt.
PERSIST_DIR=/run/initramfs
if [ ! -d "$PERSIST_DIR" -a -d /dev/.initramfs ]; then
PERSIST_DIR="/dev/.initramfs"
fi
if [ ! -d "$PERSIST_DIR" ]; then
mkdir -p "$PERSIST_DIR" ||
echo "WARNING: $MYTAG: failed to create ${PERSIST_DIR}" 1>&2
fi
LOG_FILE="${PERSIST_DIR}/${MYTAG}.log"
log() {
"log_${1}_msg" "$MYTAG: $2";
_debug "[$1]:" "$2"
}
log_fail() { log failure "$*"; }
log_success() { log success "$*"; }
log_warn() { log warning "$*"; }
fail() {
[ $# -eq 0 ] || log_fail "$@";
exit 0; # why do we exit success?
}
cleanup() {
[ -d "${TEMP_D}" ] && rm -Rf "${TEMP_D}"
}
debug() {
_debug "$@"
[ "${OVERLAYROOT_DEBUG:-0}" = "0" ] && return
echo "$MYTAG:" "$@"
}
_debug() {
if [ "${DEBUG_BUSTED:-0}" ]; then
{ echo "$@" >> "$LOG_FILE"; } 2>/dev/null ||
{ DEBUG_BUSTED=1; log_warn "debug is busted"; }
fi
}
safe_string() {
local prev="$1" allowed="$2" cur=""
[ -n "$prev" ] || return 1
while cur="${prev#[${allowed}]}"; do
[ -z "$cur" ] && return 0
[ "$cur" = "$prev" ] && break
prev="$cur"
done
return 1
}
parse_string() {
# parse a key/value string like:
# name=mapper,pass=foo,fstype=ext4,mkfs=1
# set variables under namespace 'ns'.
# _RET_name=mapper
# _RET_pass=foo
# _RET_fstype=ext4
# set _RET to the list of variables found
local input="${1}" delim="${2:-,}" ns="${3:-_RET_}"
local oifs="$IFS" tok="" keys="" key="" val=""
set -f; IFS="$delim"; set -- $input; IFS="$oifs"; set +f;
_RET=""
for tok in "$@"; do
key="${tok%%=*}"
val="${tok#${key}}"
val=${val#=}
safe_string "$key" "0-9a-zA-Z_" ||
{ debug "$key not a safe variable name"; return 1; }
eval "${ns}${key}"='${val}' || return 1
keys="${keys} ${ns}${key}"
done
_RET=${keys# }
return
}
get_varval() { eval _RET='${'$1'}'; }
write_kernel_cmdline_cfg() {
local cfg="$1" desc="${2:-kernel cmdline}"
local cmdline="" var=""
read cmdline < /proc/cmdline || return 1
: > "${cfg}" || return
set -f
{
echo "desc='${desc}'"
for tok in $cmdline; do
for var in $VARIABLES; do
if [ "$tok" = "$var" ]; then
log_warn "kernel param without value '${tok}'";
continue;
elif [ "${tok}" = "${var}=" ]; then
echo "${var}=''";
elif [ "${tok#${var}=}" != "${tok}" ]; then
echo "${var}='${tok#${var}=}'"
fi
done
done
} >> "$cfg"
set +f
}
wait_for_dev() {
local dev="$1" timeout="${2:-0}"
[ -b "$dev" ] && return 0
[ "$timeout" = "0" ] && return 1
# wait-for-root writes fstype to stdout, redirect to null
wait-for-root "$dev" "$timeout" >/dev/null
}
crypto_setup() {
local fstype="ext4" pass="" mapname="secure" mkfs="1" dev=""
local timeout=0
local entropy_sources="/proc/sys/kernel/random/boot_id /proc/sys/kernel/random/uuid /dev/urandom"
local seed="" rootseed="$ROOTMNT/var/lib/urandom/random-seed"
if [ ! -f "$rootseed" -a -f "$ROOTMNT/var/lib/systemd/random-seed" ]; then
rootseed="$ROOTMNT/var/lib/systemd/random-seed"
fi
# Seed the psuedo random number generator with available seeds
for seed in "/.random-seed" "$rootseed"; do
[ -f "${seed}" ] ||
{ debug "missing rng seed [${seed}]"; continue; }
cat "${seed}" > /dev/urandom ||
debug "failed seeding /dev/urandom from $seed"
done
# this does necessary crypto setup and sets _RET
# to the appropriate block device (ie /dev/mapper/secure)
# mkfs (default is 1):
# 0: never create filesystem
# 1: if pass is given and mount fails, create a new one
# if no pass given, create new
# 2: if pass is given and mount fails, fail
# if no pass given, create new
local options="$1"
parse_string "${options}" ||
{ log_fail "failed parsing '${options}'"; return 1; }
fstype=${_RET_fstype:-${fstype}}
pass=${_RET_pass:-${pass}}
mapname=${_RET_mapname:-${mapname}}
mkfs=${_RET_mkfs:-${mkfs}}
dev=${_RET_dev:-${dev}}
timeout=${_RET_timeout:-${timeout}}
[ -n "$dev" ] ||
{ log_fail "dev= argument not provided in '${options}'"; return 1; }
short2dev "$dev" ||
{ log_fail "failed to convert $dev to a device"; return 1; }
dev="${_RET}"
debug "fstype=${fstype} pass=${pass} mapname=${mapname}"
debug "mkfs=${mkfs} dev=${dev} timeout=${timeout}"
wait_for_dev "$dev" "$timeout" || {
log_fail "crypt dev device $dev does not exist after ${timeout}s";
return 1;
}
if [ -n "$pass" ]; then
printf "%s" "$pass" |
cryptsetup luksOpen "$dev" "$mapname" --key-file -
if [ $? -eq 0 ]; then
local tdev="/dev/mapper/$mapname"
log_warn "reusing existing luks device at $dev"
wait_for_dev "$tdev" 20 ||
{ log_fail "$tdev did not appear"; return 1; }
_RET_DEVICE="/dev/mapper/$mapname"
return 0
fi
if [ "$mkfs" != "1" ]; then
log_fail "luksOpen failed on $dev with mkfs=$mkfs";
return 1;
fi
log_warn "re-opening $dev failed with mkfs=$mkfs will create new"
else
[ "$mkfs" = "0" ] &&
{ log_fail "mkfs=0, but no password provided"; return 1; }
entropy_sources="$entropy_sources $dev"
local tmpf="" pass_file="${PERSIST_DIR}/${MYTAG}.passwd"
tmpf=$(mktemp "${PERSIST_DIR}/${MYTAG}.XXXXXX") ||
{ log_fail "failed creation of password file"; return 1; }
stat -L /dev/* /proc/* /sys/* >"$tmpf" 2>&1 ||
{ log_warn "could not seed with stat entropy [$entropy_sources]"; }
head -c 4096 $entropy_sources >> "$tmpf" ||
{ log_fail "failed reading entropy [$entropy_sources]"; return 1; }
pass=$(sha512sum "$tmpf") ||
{ log_fail "failed generation of password"; return 1; }
pass=${pass%% *}
printf "%s" "${pass}" > "$tmpf" ||
{ log_fail "failed to record password to '$tmpf'"; return 1; }
mv "$tmpf" "${pass_file}" ||
{ log_fail "failed rename '$tmpf' to '${pass_file}'"; return 1; }
log_debug "stored password in ${pass_file}"
fi
log_warn "setting up new luks device at $dev"
# clear backing device
wipefs -a "$dev" ||
{ log_fail "failed to wipe $dev"; return 1; }
printf "%s" "$pass" | cryptsetup luksFormat "$dev" --key-file - ||
{ log_fail "luksFormat $dev failed"; return 1; }
printf "%s" "$pass" |
cryptsetup luksOpen "$dev" "$mapname" --key-file - ||
{ log_fail "luksOpen $dev failed"; return 1; }
mke2fs -t "${fstype}" "/dev/mapper/${mapname}" || {
log_fail "failed to mkfs -t $fstype on map $mapname";
return 1;
}
_RET_DEVICE="/dev/mapper/$mapname"
return 0
}
dev_setup() {
local options="$1" dev="" timeout=0 path="/"
# options supported:
# dev=device,timeout=X,path=/
parse_string "${options}" ||
{ log_fail "failed parsing '${options}'"; return 1; }
dev=${_RET_dev:-${dev}}
timeout=${_RET_timeout:-${timeout}}
[ -n "$dev" ] ||
{ log_fail "dev= argument not provided in '${options}'"; return 1; }
short2dev "$dev" ||
{ log_fail "failed to convert $dev to a device"; return 1; }
dev="${_RET}"
debug "dev=${dev} timeout=${timeout}"
wait_for_dev "$dev" "$timeout"
_RET_DEVICE="$dev"
}
clean_path() {
# remove '//' in a path.
local p="$1" tmp=""
while [ "${p#*//}" != "$p" ]; do
tmp=${p#*//}
p="${p%%//*}/${tmp}"
done
_RET="$p"
}
get_workdir() {
local root_rw="$1" dir_prefix="$2" file="$3"
file=${file%/}
if [ "$file" = "/" -o "$file" = "" ]; then
file="_"
fi
clean_path "${root_rw}/${dir_prefix%/}-workdir/${file}"
}
gen_fstab() {
# gen_fstab(mp) - generate a fabricated /etc/fstab for mount point $mp
local mp="$1" m_spec="" m_opts="" m_fstype=""
local spec file vfstype opts pass freq
# just remove any trailing /
[ "$mp" != "/" ] && mp=${mp%/}
while read spec file vfstype opts pass freq; do
[ "$file" = "$mp" ] && {
m_spec="$spec"
m_opts="$opts"
m_fstype="$vfstype"
break
}
done </proc/mounts
[ -z "$m_spec" ] && {
log_warn "did not find root mount point $mp in /proc/mounts"
m_opts="/dev/root"
m_opts="defaults"
m_fstype="auto"
}
echo "# fabricated by overlayroot, rootfs did not contain /etc/fstab"
echo "${m_spec} / ${m_fstype} ${m_opts} 0 0 "
}
overlayrootify_fstab() {
# overlayrootify_fstab(input, root_ro, root_rw, dir_prefix, recurse, swap)
# read input fstab file, write an overlayroot version to stdout
# also returns (_RET) a list of directories that will need to be made
local input="$1" root_ro="${2:-/media/root-ro}"
local root_rw="${3:-/media/root-rw}" dir_prefix="${4:-/}"
local recurse=${5:-1} swap=${6:-0} fstype=${7:-overlayfs}
local hash="#" oline="" ospec="" upper="" dirs="" copy_opts="" copy_opt=""
local spec file vfstype opts pass freq line ro_line
local workdir="" use_orig="" relfile="" needs_workdir=false noauto=""
[ -f "$input" ] || return 1
cat <<EOF
#
# This fstab is for overlayroot. The real one can be found at
# ${root_ro}/etc/fstab
# The original entry for '/' and other mounts have been updated to be placed
# under $root_ro.
# To permanently modify this (or any other file), you should change-root into
# a writable view of the underlying filesystem using:
# sudo overlayroot-chroot
#
EOF
needs_workdir && needs_workdir=true || needs_workdir=false
while read spec file vfstype opts pass freq; do
[ "$file" = "/" ] && noauto="noauto" || noauto=""
line="$spec $file $vfstype $opts $pass $freq"
case ",$opts," in
*,ro,*) ro_opts="$opts";;
*) ro_opts="ro,${opts}";;
esac
ro_line="$spec ${root_ro}$file $vfstype"
ro_line="${ro_line} ${ro_opts}${noauto:+,${noauto}} $pass $freq"
use_orig=""
if [ "${spec#${hash}}" != "$spec" ]; then
use_orig="comment"
elif [ -z "$freq" ]; then
use_orig="malformed-line"
else
case "$vfstype" in
vfat|fat) use_orig="fs-unsupported";;
proc|sys|tmpfs|dev|udev|debugfs) use_orig="fs-virtual";;
esac
fi
if [ -n "$use_orig" ]; then
if [ "$use_orig" != "comment" ]; then
echo "$line # $MYTAG:$use_orig"
else
echo "$line"
fi
elif [ "$vfstype" = "swap" ]; then
if [ "$swap" = "0" ]; then
# comment out swap lines
echo "#$MYTAG:swap=${swap}#${line}"
elif [ "${spec#/}" != "${spec}" ] &&
[ "${spec#/dev/}" = "${spec}" ]; then
# comment out swap files (spec starts with / and not in /dev)
echo "#$MYTAG:swapfile#${line}"
else
echo "${line}"
fi
else
ospec="${root_ro}${file}"
copy_opts=""
for copy_opt in nobootwait noauto nofail; do
case ",$opts," in
*,${copy_opt},*)
copy_opts="${copy_opts},${copy_opt}";;
esac
done
clean_path "${root_rw}/${dir_prefix}${file}"
upper="$_RET"
oline="${ospec} ${file} $fstype "
clean_path "${root_ro}${file}"
oline="${oline}lowerdir=$_RET"
oline="${oline},upperdir=${upper}${copy_opts}"
if [ "$fstype" = "overlayfs" -o "$fstype" = "overlay" ] &&
${needs_workdir}; then
get_workdir "$root_rw" "$dir_prefix" "$file"
workdir="$_RET"
oline="${oline},workdir=$workdir"
dirs="${dirs} $workdir"
fi
oline="${oline} $pass $freq"
if [ "$recurse" != "0" -o "$file" = "/" ]; then
if [ "$file" = "/" ]; then
# this can confuse systemd (LP: #1723183)
echo "#$ro_line"
else
echo "$ro_line"
fi
echo "$oline"
dirs="${dirs} ${upper}"
else
echo "$line"
fi
fi
done < "$input"
_RET=${dirs# }
}
short2dev() {
# turn 'LABEL=' or 'UUID=' into a device path
# also support /dev/* and 'vdb' or 'xvda'
local input="$1" oifs="$IFS" dev newdev s
case "$input" in
LABEL=*)
dev="${input#LABEL=}"
case "${dev}" in
*/*) dev="$(echo "${dev}" | sed 's,/,\\x2f,g')";;
esac
dev="/dev/disk/by-label/${dev}"
;;
UUID=*) dev="/dev/disk/by-uuid/${input#UUID=}" ;;
/dev/*) dev="${input}";;
*) dev="/dev/${input}";;
esac
_RET=$dev
}
get_cfg() {
# get_cfg(device, file, cfg, timeout=0)
# copy the file $cfg off $device to $file, waiting $timeout for
# $device to appear
local dev="$1" file="$2" cfg="${3:-overlayroot.conf}" timeout="${4:-0}"
local cfgdev="" success=0 didmnt=false mp="" pre="get_cfg($dev):"
[ -z "$dev" ] && return 1
if [ "$timeout" != "0" ]; then
wait_for_dev "$dev" "$timeout" ||
{ debug "$pre did not appear in $timeout"; return 1; }
else
udevadm settle
fi
short2dev "$dev" && cfgdev="$_RET" && [ -b "$cfgdev" ] ||
{ debug "$pre not present"; return 1; }
if mp="${TEMP_D}/mp" && mkdir "$mp" &&
mount -o ro "$cfgdev" "$mp"; then
if [ -f "$mp/$cfg" ]; then
cp "$mp/$cfg" "$file" && success=1 ||
debug "$pre copy failed"
else
debug "$pre '$file' file not found"
fi
umount "$mp"
else
debug "$pre mount failed"
fi
[ -d "$mp" ] || rmdir "$mp"
[ $success -eq 1 ] || return 1
_RET="$dev/$cfg"
}
parse_cfg() {
# parse_cfg($file,$desc,$vars)
# this reasonably safely sources the "config" file $file
# and then declares the variables listed to stdout
#
# known issues:
# * sourced file could re-define 'echo'
# * just fails if a value has a ' in it
[ -f "$1" ] || return 0
tick="'" sh -c '
__tick=$tick
__file=$1; __desc=$2;
__unset__="__unset__"
shift 2
__vars="$*"
readonly __tick __file __desc __vars
. "${__file}"
if [ $? -ne 0 ]; then
echo "failed source \"${__file}\" ($__desc)" 1>&2
return 1
fi
set -e
echo "desc=${__tick}${__desc}${__tick}"
for var in ${__vars}; do
eval val=\${${var}-${__unset__}} ||
{ echo "eval of $var failed"; exit 1; }
[ "${val#*${__tick}}" = "${val}" ] || {
echo "variable \"$var\" had single tick in it. fail";
exit 1;
}
[ "${val}" = "${__unset__}" ] ||
echo "$var=${__tick}${val}${__tick}"
done
' -- "$@"
}
readcfgd() {
local cfg_d="$1"
# this kind of stinks, each VARIABLE goes into global scope
local or="" or_cfgdisk=""
_RET_desc_oroot=""
_RET_desc_cfgdisk=""
set +f
for f in "${cfg_d}"/*; do
. "$f" || fail "failed reading $f"
[ "$or" != "${overlayroot}" ] &&
_RET_desc_oroot="$desc"
[ "${or_cfgdisk}" != "${overlayroot_cfgdisk}" ] &&
_RET_desc_cfgdisk="$desc"
or=${overlayroot}
or_cfgdisk=${overlayroot_cfgdisk}
done
set -f
}
fix_upstart_overlayfs() {
# inotify events on an overlayfs underlay do not propogate through
# a newly created overlay. This causes job creation and deletion issues
# for upstart, which uses inotify on /etc/init. So ensure that the overlay
# explicitly has a /etc/init (LP: #1213925)
local root="$1"
local initctl="$root/sbin/initctl"
local eifile="/etc/init/.overlayfs-upstart-helper"
[ -e "$initctl" -o -L "$initctl" ] || return 0
[ -d "$root/etc/init" ] || return 0
echo "#upstart needs help for overlayfs (LP: #1213925)." \
> "$root/$eifile" ||
{ log_fail "failed to write $root/$eifile"; return 1; }
debug "created $eifile under $root (LP: #1213925)"
}
needs_workdir() {
local uname_r="${UNAME_R}"
if [ -z "$uname_r" ]; then
uname_r=$(uname -r) && UNAME_R="$uname_r" ||
{ log_warn "failed to read uname!"; return 2; }
fi
# 3.18+ require 'workdir=' option.
case "${uname_r}" in
2*|3.1[01234567]*|3.[0-9].*) return 1;;
*) return 0;;
esac
}
search_fs_driver() {
# search_fs_driver(driver1, driver2...)
# return the first supported filesystem driver in the list.
# if no drivers are provided, search default list.
# assumes that name in /proc/filesystems and module name are the same.
local m="" driver="" tab=' '
for m in "$@"; do
grep -q "${tab}$m$" /proc/filesystems && driver="$m" &&
{ debug "/proc/filesystems support for '$m'"; break; }
done
if [ -z "$driver" ]; then
for m in "$@"; do
if modprobe -qb "$m"; then
if grep -q "${tab}$m$" /proc/filesystems; then
debug "loaded module '$m'";
driver="$m"
break;
else
log_warn "loaded '$m' module but no '$m' in /proc/filesystems"
fi
fi
done
fi
[ -n "$driver" ] ||
{ debug "Unable to find driver/module. searched: $*"; return 1; }
_RET="$driver"
}
cfgd="${TEMP_D}/configs"
mkdir -p "${cfgd}" || fail "failed to create tempdir"
trap cleanup EXIT
# collect the different config locations into a file
# write individual config files in $cfgd that contain
{
echo "desc='builtin'"
echo "overlayroot=''"
echo "overlayroot_cfgdisk='disabled'"
} > "$cfgd/00-builtin"
write_kernel_cmdline_cfg "${cfgd}/90-kernel" ||
fail "failed to read kernel command line!"
parse_cfg "/conf/conf.d/overlayroot" "initramfs config" \
"$VARIABLES" > "${cfgd}/10-initramfs" ||
fail "failed parsing initramfs config"
parse_cfg "${ROOTMNT}/etc/overlayroot.conf" "$ROOT/etc/overlayroot.conf" \
"$VARIABLES" > "${cfgd}/20-root-config" ||
fail "failed parsing root config"
parse_cfg "${ROOTMNT}/etc/overlayroot.local.conf" \
"$ROOT/etc/overlayroot.local.conf" \
"$VARIABLES" > "${cfgd}/30-root-local-config" ||
fail "failed parsing root config"
# now read the trusted configs, to see if overlayroot_cfgdisk is set
readcfgd "$cfgd" ||
fail "reading configs failed"
used_desc="${_RET_desc_oroot}"
[ -n "${_RET_desc_cfgdisk}" ] &&
debug "${_RET_desc_cfgdisk} set cfgdisk='${overlayroot_cfgdisk}'"
# if one of the trusted configs above gave us set the overlayroot_cfgdisk
# variable, then look for such a device and read a config from it.
cfgdisk=0
if [ "${overlayroot_cfgdisk:-disabled}" != "disabled" ] &&
get_cfg "${overlayroot_cfgdisk}" "${TEMP_D}/cfgdisk"; then
desc=${_RET}
parse_cfg "${TEMP_D}/cfgdisk" "${desc}" "$VARIABLES" \
> "${cfgd}/80-cfgdisk" ||
fail "reading config from ${desc} failed"
used_desc="${_RET_desc_oroot}"
# now read the parsed configs again.
readcfgd "$cfgd" ||
fail "reading configs failed"
[ -n "${_RET_desc_cfgdisk}" ] &&
debug "${_RET_desc_cfgdisk} set cfgdisk=${overlayroot_cfgdisk}"
[ -n "${_RET_desc_oroot}" ] &&
debug "${_RET_desc_oroot} set overlayroot=${overlayroot}"
fi
opts=""
cfgmsg="${used_desc:+ (per ${used_desc})}"
case "${overlayroot:-disabled}" in
tmpfs|tmpfs:*)
mode="tmpfs"
opts="${overlayroot#tmpfs}";
opts=${opts#:}
;;
/dev/*|device:*)
case "$overlayroot" in
/dev/*) opts="dev=${overlayroot}";;
*) opts="${overlayroot#device:}";;
esac
dev_setup "${opts}" ||
fail "failed setup overlay for ${overlayroot} [$opts]${cfgmsg}"
mode="device"
device="$_RET_DEVICE"
;;
crypt:*)
mode="crypt"
opts=${overlayroot#crypt:}
crypto_setup "${opts}" ||
fail "failed setup crypt for ${overlayroot}${cfgmsg}"
device="$_RET_DEVICE"
;;
disabled)
debug "overlayroot disabled${cfgmsg}"
exit 0;;
*)
fail "invalid value for overlayroot: ${overlayroot}${cfgmsg}"
exit 0;;
esac
parse_string "$opts" "," _RET_common_
swap=${_RET_common_swap:-0}
recurse=${_RET_common_recurse:-1}
OVERLAYROOT_DEBUG=${_RET_common_debug:-${OVERLAYROOT_DEBUG}}
dir_prefix=${_RET_common_dir:-"/overlay"}
overlayroot_driver=${_RET_common_driver}
read cmdline </proc/cmdline
cmdline=" $cmdline "
[ "${cmdline#* ro }" != "$cmdline" ] && cmdline_ro=true || cmdline_ro=false
if [ "${overlayroot_driver:-auto}" = "auto" ]; then
search_fs_driver overlay overlayfs ||
fail "Unable to find a driver. searched: overlay overlayfs"
overlayroot_driver="$_RET"
else
search_fs_driver ${overlayroot_driver} ||
fail "Unable to find a driver named '${overlayroot_driver}'"
overlayroot_driver="$_RET"
fi
debug "swap=$swap recurse=$recurse debug=$OVERLAYROOT_DEBUG dir=$dir_prefix"
debug "device=$device mode=$mode driver=${overlayroot_driver}"
[ "$swap" = "0" -o "$swap" = "1" ] ||
fail "invalid setting for swap: $swap. must be '0' or '1'"
[ "$recurse" = "0" -o "$recurse" = "1" ] ||
fail "invalid setting for recurse: $recurse. must be '0' or '1'"
log_warn "configuring overlayroot with driver=${overlayroot_driver} mode=$mode opts='$opts' per $used_desc"
# settings based on overlayroot_driver
workdir=""
case "${overlayroot_driver}" in
overlayfs|overlay)
mount_type="${overlayroot_driver}"
mount_opts="-o lowerdir=${root_ro},upperdir=${root_rw}/${dir_prefix}"
if needs_workdir; then
get_workdir "$root_rw" "$dir_prefix" "/"
workdir="$_RET"
mount_opts="${mount_opts},workdir=$workdir"
fi
clean_path "${mount_opts} overlayroot ${ROOTMNT}"
mount_opts="$_RET"
;;
aufs)
mount_type="aufs"
mount_opts="-o dirs=${root_rw}/${dir_prefix}:${root_ro}=ro aufs-root ${ROOTMNT}"
;;
*)
log_fail "invalid overlayroot driver: ${overlayroot_driver}"
panic "$MYTAG"
;;
esac
# make the mount point on the init root fs ${root_rw}
mkdir -p "${root_rw}" ||
fail "failed to create ${root_rw}"
# make the mount point on the init root fs ${root_ro}
mkdir -p "${root_ro}" ||
fail "failed to create ${root_ro}"
# mount the backing device to $root_rw
if [ "$mode" = "tmpfs" ]; then
# mount a tmpfs using the device name tmpfs-root
mount -t tmpfs tmpfs-root "${root_rw}" ||
fail "failed to create tmpfs"
else
# dev or crypto
mount "$device" "${root_rw}" ||
fail "failed mount backing device $device"
fi
mkdir -p "${root_rw}/${dir_prefix}" ||
fail "failed to create ${dir_prefix} on ${device}"
[ -z "$workdir" ] || mkdir -p "$workdir" ||
fail "failed to create workdir '$workdir' on ${device}"
# root is mounted on ${ROOTMNT}, move it to ${ROOT_RO}.
mount --move "${ROOTMNT}" "${root_ro}" ||
fail "failed to move root away from ${ROOTMNT} to ${root_ro}"
# there is nothing left at ${ROOTMNT} now. So for any error we get we should
# either do recovery to restore ${ROOTMNT} for drop to a initramfs shell using
# "panic". Otherwise the boot process is very likely to fail with even more
# errors and leave the system in a wired state.
# mount virtual fs ${ROOTMNT} with rw-fs ${root_rw} on top or ro-fs ${root_ro}.
debug mount -t "$mount_type" $mount_opts
mount -t "$mount_type" $mount_opts
if [ $? -ne 0 ]; then
log_fail "failed to create new ro/rw layered ${ROOTMNT}"
log_fail "mount command was: mount -t $mount_type $mount_opts"
# do recovery and try restoring the mount for ${ROOTMNT}
mount --move ${root_ro} ${ROOTMNT}
if [ $? -ne 0 ]; then
# thats bad, drop to shell to let the user try fixing this
log_fail "RECOVERY_ERROR: failed to move $root_ro back to ${ROOTMNT}"
panic "$MYTAG"
fi
exit 0
fi
# now the real root fs is on ${root_ro} of the init file system, our
# layered root fs is set up at ${ROOTMNT}. So we can write anywhere in
# {ROOTMNT} and the changes will end up in ${root_rw} while ${root_ro} it
# not touched. However ${root_ro} and ${root_rw} are on the initramfs root
# fs, which will be removed an replaced by ${ROOTMNT}. Thus we must move
# ${root_ro} and ${root_rw} to the rootfs visible later, ie.
# ${ROOTMNT}${root_ro} and ${ROOTMNT}${root_ro}. Since the layered ro/rw
# is already up, these changes also end up on ${root_rw} while ${root_ro}
# is not touched.
# move mount from ${root_ro} to ${ROOTMNT}${root_ro}
mkdir -p "${ROOTMNT}/${root_ro}"
mount --move ${root_ro} "${ROOTMNT}${root_ro}" ||
fail "failed to move ${root_ro} to ${ROOTMNT}${root_ro}"
# move mount from ${root_rw} to ${ROOTMNT}${root_rw}
[ -d ${ROOTMNT}${root_rw} ] || mkdir -p ${ROOTMNT}${root_rw}
mount --move "${root_rw}" "${ROOTMNT}${root_rw}" ||
fail "failed to move ${root_rw} to ${ROOTMNT}${root_rw}"
# technically, everything is set up nicely now. Since ${ROOTMNT} had beend
# mounted read-only on the initfamfs already, ${ROOTMNT}${root_ro} is it,
# too. Now we init process could run - but unfortunately, we may have to
# prepare some more things here.
# Basically, there are two ways to deal with the read-only root fs. If the
# system is made aware of this, things can be simplified a lot. If it is
# not, things need to be done to our best knowledge.
#
# So we assume here, the system does not really know about our read-only
# root fs.
#
# Let's deal with /etc/fstab first. It usually contains an entry for the
# root fs, which is no longer valid now. We have to remove it and add our
# new ${root_ro} entry.
# Remember we are still on the initramfs root fs here, so we have to work
# on ${ROOTMNT}/etc/fstab. The original fstab is
# ${ROOTMNT}${root_ro}/etc/fstab.
source_fstab="$ROOTMNT/${root_ro}/etc/fstab"
if [ ! -f "$source_fstab" ] && [ "$cmdline_ro" = "true" ]; then
debug "rootfs did not contain /etc/fstab, creating" \
"based on kernel cmdline"
source_fstab="${TEMP_D}/fstab"
gen_fstab "${ROOTMNT}${root_ro}" > "$source_fstab" ||
log_fail "gen_fstab failed for $ROOTMNT/$root_ro"
fi
if [ -f "$source_fstab" ]; then
overlayrootify_fstab "$source_fstab" "$root_ro" \
"$root_rw" "$dir_prefix" "$recurse" "$swap" "${overlayroot_driver}" \
> "${ROOTMNT}/etc/fstab" ||
log_fail "failed to modify /etc/fstab"
else
debug "rootfs did not contain /etc/fstab."
fi
# we have to make the directories in ${root_rw} because if they do not
# exist, then the 'upper=' argument to overlayfs will fail.
for d in ${_RET}; do
mkdir -p "${ROOTMNT}/$d"
done
if [ "${overlayroot_driver}" = "overlayfs" ]; then
fix_upstart_overlayfs "$ROOTMNT" ||
log_fail "failed to fix upstart for overlayfs"
fi
# if / is supposed to be mounted read-only (cmdline with 'ro')
# then mount our overlayfs as read-only just to be more normal
if [ "${cmdline_ro}" = "true" ]; then
mount -o remount,ro "$ROOTMNT" ||
log_fail "failed to remount overlayroot read-only"
debug "mounted $ROOTMNT read-only per kernel cmdline"
fi
msg="configured root with '$overlayroot' using ${overlayroot_driver} per"
msg="$msg ${used_desc}"
log_success "$msg"
exit 0
# vi: ts=4 noexpandtab

13
debian/rules vendored Executable file
View file

@ -0,0 +1,13 @@
#!/usr/bin/make -f
# Uncomment this to turn on verbose mode.
#export DH_VERBOSE=1
# This has to be exported to make some magic below work.
export DH_OPTIONS
%:
dh $@
override_dh_auto_install:
dh_auto_install --destdir=debian/tmp

1
debian/source/format vendored Normal file
View file

@ -0,0 +1 @@
3.0 (native)

172
debian/tmp/bin/romtalsd vendored Executable file
View file

@ -0,0 +1,172 @@
#!/usr/bin/env python3
import os
import subprocess
import sys
import gi
gi.require_version('Gtk', '3.0')
from gi.repository import Gtk, Gdk
def run_as_root(cmd_list):
"""
Verilen komut listesini pkexec ile root olarak çalıştırır.
"""
try:
subprocess.run(["pkexec"] + cmd_list, check=True)
except subprocess.CalledProcessError as e:
raise RuntimeError(f"Komut hatası: {e.cmd}, Çıkış kodu: {e.returncode}")
def get_mount_device(mount_point):
"""
/proc/mounts dosyasını okuyarak, verilen mount noktasının bağlı olduğu cihazı döner.
Args:
mount_point (str): İncelenecek mount noktası, örneğin "/media/root-ro".
Returns:
str veya None: Mount edilmiş aygıtın adı (örneğin, "/dev/sda1")
veya belirtilen mount noktası bulunamazsa None.
"""
try:
with open("/proc/mounts", "r") as f:
for line in f:
parts = line.split()
if parts[1] == mount_point:
return parts[0]
except Exception:
pass
return None
def overlay_status():
"""
/etc/overlayroot.conf dosyasını ve /media/root-rw mount noktasını kontrol eder:
- Eğer /media/root-rw mount edilmişse, overlay aktif kabul edilir.
- Aksi halde, /etc/overlayroot.conf dosyasını açar; içeriğinde "tmpfs" ifadesi varsa overlay aktif,
yoksa overlay pasif olarak belirlenir.
"""
# İlk olarak /media/root-rw mount edilip edilmediğini kontrol et
if get_mount_device("/media/root-rw"):
return True
# /etc/overlayroot.conf kontrolü
conf_path = "/etc/overlayroot.conf"
if os.path.exists(conf_path):
try:
with open(conf_path, "r") as f:
content = f.read()
return "tmpfs" in content
except Exception:
return False
else:
# Dosya yoksa paket kontrolü yapılabilir
try:
result = subprocess.run(["dpkg", "-l", "romtal-sistem-dondurma"], capture_output=True, text=True)
return "overlayroot" in result.stdout
except Exception:
return False
class OverlayrootGUI(Gtk.Window):
def __init__(self):
super().__init__(title="R.O.M.T.A.L Sistem Dondurma")
self.set_default_size(400, 250)
self.set_border_width(20)
# Stil ayarları
css = b"""
button {
font: 15px Arial;
padding: 10px;
margin: 5px;
}
"""
style_provider = Gtk.CssProvider()
style_provider.load_from_data(css)
Gtk.StyleContext.add_provider_for_screen(
Gdk.Screen.get_default(),
style_provider,
Gtk.STYLE_PROVIDER_PRIORITY_APPLICATION
)
self.overlay_enabled = overlay_status()
self.create_ui()
def create_ui(self):
grid = Gtk.Grid(column_spacing=10, row_spacing=10)
self.enable_btn = Gtk.Button(label="Sistem Dondurma Aktif Et")
self.disable_btn = Gtk.Button(label="Sistem Dondurma Devre Dışı Bırak")
self.enable_btn.connect("clicked", self.enable_overlayroot)
self.disable_btn.connect("clicked", self.disable_overlayroot)
self.status_label = Gtk.Label()
self.update_status()
# Footer label ekliyoruz
self.footer_label = Gtk.Label(label="Made By R.O.M.T.A.L | https://rasimoneltml.meb.k12.tr/")
grid.attach(self.status_label, 0, 0, 2, 1)
grid.attach(self.enable_btn, 0, 1, 1, 1)
grid.attach(self.disable_btn, 1, 1, 1, 1)
grid.attach(self.footer_label, 0, 2, 2, 1)
self.add(grid)
def update_status(self):
status_text = "Şuanki Durum: " + ("Aktif" if self.overlay_enabled else "Devre Dışı")
self.status_label.set_markup(f"<b>{status_text}</b>")
self.enable_btn.set_sensitive(not self.overlay_enabled)
self.disable_btn.set_sensitive(self.overlay_enabled)
def show_dialog(self, message, is_error=False):
dialog = Gtk.MessageDialog(
parent=self,
flags=0,
message_type=Gtk.MessageType.ERROR if is_error else Gtk.MessageType.INFO,
buttons=Gtk.ButtonsType.OK,
text=message
)
dialog.run()
dialog.destroy()
def enable_overlayroot(self, widget):
try:
cmd = [
"sh", "-c",
("rm -f /etc/overlayroot.conf && "
"echo 'overlayroot_cfgdisk=\"disable\"' > /etc/overlayroot.conf && "
"echo 'overlayroot=\"tmpfs\"' >> /etc/overlayroot.conf")
]
run_as_root(cmd)
self.overlay_enabled = True
self.update_status()
self.show_dialog("Overlayroot aktif edildi!\nDeğişikliklerin geçerli olması için yeniden başlatın.")
except Exception as e:
self.show_dialog(f"Hata oluştu: {str(e)}", is_error=True)
def disable_overlayroot(self, widget):
try:
device = get_mount_device("/media/root-ro")
if not device:
raise RuntimeError("'/media/root-ro' mount edilen cihaz bulunamadı.")
cmd = [
"sh", "-c",
(f"mount -o remount,rw {device} && "
"rm -f /media/root-ro/etc/overlayroot.conf && "
"echo 'overlayroot_cfgdisk=\"disable\"' > /media/root-ro/etc/overlayroot.conf && "
"echo 'overlayroot=\"\"' >> /media/root-ro/etc/overlayroot.conf")
]
run_as_root(cmd)
self.overlay_enabled = False
self.update_status()
self.show_dialog("Overlayroot devre dışı bırakıldı!\nDeğişikliklerin geçerli olması için yeniden başlatın.")
except Exception as e:
self.show_dialog(f"Hata oluştu: {str(e)}", is_error=True)
if __name__ == "__main__":
win = OverlayrootGUI()
win.connect("destroy", Gtk.main_quit)
win.show_all()
Gtk.main()

2
debian/tmp/etc/overlayroot.conf vendored Normal file
View file

@ -0,0 +1,2 @@
overlayroot_cfgdisk="disabled"
overlayroot=""

4
debian/tmp/etc/update-motd.d/97-overlayroot vendored Executable file
View file

@ -0,0 +1,4 @@
#!/bin/sh
(egrep "overlayroot|/media/root-ro|/media/root-rw" /proc/mounts 2>/dev/null | sort -r) || true
echo

93
debian/tmp/usr/sbin/overlayroot-chroot vendored Executable file
View file

@ -0,0 +1,93 @@
#!/bin/sh
#
# overlayroot-chroot - chroot wrapper script for overlayroot
# Copyright (C) 2012 Dustin Kirkland <kirkland@ubuntu.com>
#
# Authors: Dustin Kirkland <kirkland@ubuntu.com>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, version 3 of the License.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
set -e
set -f # disable path expansion
REMOUNTS=""
error() {
printf "ERROR: $@\n" 1>&2
}
fail() { [ $# -eq 0 ] || error "$@"; exit 1; }
info() {
printf "INFO: $@\n" 1>&2
}
get_lowerdir() {
local overlay=""
overlay=$(awk \
'$1 == "overlayroot" && $2 == "/" { print $0 }' /proc/mounts)
if [ -n "${overlay}" ]; then
lowerdir=${overlay##*lowerdir=}
lowerdir=${lowerdir%%,*}
if mountpoint "${lowerdir}" >/dev/null; then
_RET="${lowerdir}"
else
fail "Unable to find the overlayroot lowerdir"
fi
else
fail "Unable to find an overlayroot filesystem"
fi
}
clean_exit() {
local mounts="$1" rc=0 d="" lowerdir="" mp=""
for d in ${mounts}; do
if mountpoint ${d} >/dev/null; then
umount ${d} || rc=1
fi
done
for mp in $REMOUNTS; do
mount -o remount,ro "${mp}" ||
error "Note that [${mp}] is still mounted read/write"
done
[ "$2" = "return" ] && return ${rc} || exit ${rc}
}
# Try to find the overlayroot filesystem
get_lowerdir
lowerdir=${_RET}
recurse_mps=$(awk '$1 ~ /^\/dev\// && $2 ~ starts { print $2 }' \
starts="^$lowerdir/" /proc/mounts)
mounts=
for d in proc run sys; do
if ! mountpoint "${lowerdir}/${d}" >/dev/null; then
mount -o bind "/${d}" "${lowerdir}/${d}" || fail "Unable to bind /${d}"
mounts="$mounts $lowerdir/$d"
trap "clean_exit \"${mounts}\" || true" EXIT HUP INT QUIT TERM
fi
done
# Remount with read/write
for mp in "$lowerdir" $recurse_mps; do
mount -o remount,rw "${mp}" &&
REMOUNTS="$mp $REMOUNTS" ||
fail "Unable to remount [$mp] writable"
done
info "Chrooting into [${lowerdir}]"
chroot ${lowerdir} "$@"
# Clean up mounts on exit
clean_exit "${mounts}" "return"
trap "" EXIT HUP INT QUIT TERM
# vi: ts=4 noexpandtab

View file

@ -0,0 +1 @@
export CRYPTSETUP=y

View file

@ -0,0 +1,25 @@
#!/bin/sh
set -e
PREREQS="cryptsetup"
case $1 in
prereqs) echo "${PREREQS}"; exit 0;;
esac
. /usr/share/initramfs-tools/hook-functions
##
copy_exec /usr/bin/head /bin
copy_exec /usr/bin/sha512sum /bin
copy_exec /sbin/wipefs /sbin
copy_exec /sbin/cryptsetup /sbin
copy_exec /sbin/mke2fs /sbin
# this is '||' only in case aesni_intel module isn't built (or others are built in)
manual_add_modules overlayfs overlay dm_mod dm_crypt aesni_intel || true
# Grab as much true random data as possible, up to 4KB, and stash it into a
# random seed in the initramfs
dd if=/dev/random of="${DESTDIR}/.random-seed" bs=1 count=4096 iflag=nonblock >/dev/null 2>&1 || true
# vi: ts=4 noexpandtab

View file

@ -0,0 +1,878 @@
#!/bin/sh
# Copyright, 2012 Dustin Kirkland <kirkland@ubuntu.com>
# Copyright, 2012 Scott Moser <smoser@ubuntu.com>
# Copyright, 2012 Axel Heider
#
# Based on scripts from
# Sebastian P.
# Nicholas A. Schembri State College PA USA
# Axel Heider
# Dustin Kirkland
# Scott Moser
#
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see
# <http://www.gnu.org/licenses/>.
case "$1" in
# no pre-reqs
prereqs) echo ""; exit 0;;
esac
. /scripts/functions
PATH=/usr/sbin:/usr/bin:/sbin:/bin
MYTAG="overlayroot"
TEMP_D="${TMPDIR:-/tmp}/${0##*/}.configs"
VARIABLES="overlayroot overlayroot_cfgdisk"
# generic settings
# ${ROOT} and ${rootmnt} are predefined by caller of this script. Note that
# the root fs ${rootmnt} it mounted readonly on the initrams, which fits
# nicely for our purposes.
root_rw=/media/root-rw
root_ro=/media/root-ro
ROOTMNT=${rootmnt} # use global name to indicate created outside this
OVERLAYROOT_DEBUG=0
# PERSIST_DIR will persist after pivot-root. It is used for log file
# and for the mktemp-made password file in crypt.
PERSIST_DIR=/run/initramfs
if [ ! -d "$PERSIST_DIR" -a -d /dev/.initramfs ]; then
PERSIST_DIR="/dev/.initramfs"
fi
if [ ! -d "$PERSIST_DIR" ]; then
mkdir -p "$PERSIST_DIR" ||
echo "WARNING: $MYTAG: failed to create ${PERSIST_DIR}" 1>&2
fi
LOG_FILE="${PERSIST_DIR}/${MYTAG}.log"
log() {
"log_${1}_msg" "$MYTAG: $2";
_debug "[$1]:" "$2"
}
log_fail() { log failure "$*"; }
log_success() { log success "$*"; }
log_warn() { log warning "$*"; }
fail() {
[ $# -eq 0 ] || log_fail "$@";
exit 0; # why do we exit success?
}
cleanup() {
[ -d "${TEMP_D}" ] && rm -Rf "${TEMP_D}"
}
debug() {
_debug "$@"
[ "${OVERLAYROOT_DEBUG:-0}" = "0" ] && return
echo "$MYTAG:" "$@"
}
_debug() {
if [ "${DEBUG_BUSTED:-0}" ]; then
{ echo "$@" >> "$LOG_FILE"; } 2>/dev/null ||
{ DEBUG_BUSTED=1; log_warn "debug is busted"; }
fi
}
safe_string() {
local prev="$1" allowed="$2" cur=""
[ -n "$prev" ] || return 1
while cur="${prev#[${allowed}]}"; do
[ -z "$cur" ] && return 0
[ "$cur" = "$prev" ] && break
prev="$cur"
done
return 1
}
parse_string() {
# parse a key/value string like:
# name=mapper,pass=foo,fstype=ext4,mkfs=1
# set variables under namespace 'ns'.
# _RET_name=mapper
# _RET_pass=foo
# _RET_fstype=ext4
# set _RET to the list of variables found
local input="${1}" delim="${2:-,}" ns="${3:-_RET_}"
local oifs="$IFS" tok="" keys="" key="" val=""
set -f; IFS="$delim"; set -- $input; IFS="$oifs"; set +f;
_RET=""
for tok in "$@"; do
key="${tok%%=*}"
val="${tok#${key}}"
val=${val#=}
safe_string "$key" "0-9a-zA-Z_" ||
{ debug "$key not a safe variable name"; return 1; }
eval "${ns}${key}"='${val}' || return 1
keys="${keys} ${ns}${key}"
done
_RET=${keys# }
return
}
get_varval() { eval _RET='${'$1'}'; }
write_kernel_cmdline_cfg() {
local cfg="$1" desc="${2:-kernel cmdline}"
local cmdline="" var=""
read cmdline < /proc/cmdline || return 1
: > "${cfg}" || return
set -f
{
echo "desc='${desc}'"
for tok in $cmdline; do
for var in $VARIABLES; do
if [ "$tok" = "$var" ]; then
log_warn "kernel param without value '${tok}'";
continue;
elif [ "${tok}" = "${var}=" ]; then
echo "${var}=''";
elif [ "${tok#${var}=}" != "${tok}" ]; then
echo "${var}='${tok#${var}=}'"
fi
done
done
} >> "$cfg"
set +f
}
wait_for_dev() {
local dev="$1" timeout="${2:-0}"
[ -b "$dev" ] && return 0
[ "$timeout" = "0" ] && return 1
# wait-for-root writes fstype to stdout, redirect to null
wait-for-root "$dev" "$timeout" >/dev/null
}
crypto_setup() {
local fstype="ext4" pass="" mapname="secure" mkfs="1" dev=""
local timeout=0
local entropy_sources="/proc/sys/kernel/random/boot_id /proc/sys/kernel/random/uuid /dev/urandom"
local seed="" rootseed="$ROOTMNT/var/lib/urandom/random-seed"
if [ ! -f "$rootseed" -a -f "$ROOTMNT/var/lib/systemd/random-seed" ]; then
rootseed="$ROOTMNT/var/lib/systemd/random-seed"
fi
# Seed the psuedo random number generator with available seeds
for seed in "/.random-seed" "$rootseed"; do
[ -f "${seed}" ] ||
{ debug "missing rng seed [${seed}]"; continue; }
cat "${seed}" > /dev/urandom ||
debug "failed seeding /dev/urandom from $seed"
done
# this does necessary crypto setup and sets _RET
# to the appropriate block device (ie /dev/mapper/secure)
# mkfs (default is 1):
# 0: never create filesystem
# 1: if pass is given and mount fails, create a new one
# if no pass given, create new
# 2: if pass is given and mount fails, fail
# if no pass given, create new
local options="$1"
parse_string "${options}" ||
{ log_fail "failed parsing '${options}'"; return 1; }
fstype=${_RET_fstype:-${fstype}}
pass=${_RET_pass:-${pass}}
mapname=${_RET_mapname:-${mapname}}
mkfs=${_RET_mkfs:-${mkfs}}
dev=${_RET_dev:-${dev}}
timeout=${_RET_timeout:-${timeout}}
[ -n "$dev" ] ||
{ log_fail "dev= argument not provided in '${options}'"; return 1; }
short2dev "$dev" ||
{ log_fail "failed to convert $dev to a device"; return 1; }
dev="${_RET}"
debug "fstype=${fstype} pass=${pass} mapname=${mapname}"
debug "mkfs=${mkfs} dev=${dev} timeout=${timeout}"
wait_for_dev "$dev" "$timeout" || {
log_fail "crypt dev device $dev does not exist after ${timeout}s";
return 1;
}
if [ -n "$pass" ]; then
printf "%s" "$pass" |
cryptsetup luksOpen "$dev" "$mapname" --key-file -
if [ $? -eq 0 ]; then
local tdev="/dev/mapper/$mapname"
log_warn "reusing existing luks device at $dev"
wait_for_dev "$tdev" 20 ||
{ log_fail "$tdev did not appear"; return 1; }
_RET_DEVICE="/dev/mapper/$mapname"
return 0
fi
if [ "$mkfs" != "1" ]; then
log_fail "luksOpen failed on $dev with mkfs=$mkfs";
return 1;
fi
log_warn "re-opening $dev failed with mkfs=$mkfs will create new"
else
[ "$mkfs" = "0" ] &&
{ log_fail "mkfs=0, but no password provided"; return 1; }
entropy_sources="$entropy_sources $dev"
local tmpf="" pass_file="${PERSIST_DIR}/${MYTAG}.passwd"
tmpf=$(mktemp "${PERSIST_DIR}/${MYTAG}.XXXXXX") ||
{ log_fail "failed creation of password file"; return 1; }
stat -L /dev/* /proc/* /sys/* >"$tmpf" 2>&1 ||
{ log_warn "could not seed with stat entropy [$entropy_sources]"; }
head -c 4096 $entropy_sources >> "$tmpf" ||
{ log_fail "failed reading entropy [$entropy_sources]"; return 1; }
pass=$(sha512sum "$tmpf") ||
{ log_fail "failed generation of password"; return 1; }
pass=${pass%% *}
printf "%s" "${pass}" > "$tmpf" ||
{ log_fail "failed to record password to '$tmpf'"; return 1; }
mv "$tmpf" "${pass_file}" ||
{ log_fail "failed rename '$tmpf' to '${pass_file}'"; return 1; }
log_debug "stored password in ${pass_file}"
fi
log_warn "setting up new luks device at $dev"
# clear backing device
wipefs -a "$dev" ||
{ log_fail "failed to wipe $dev"; return 1; }
printf "%s" "$pass" | cryptsetup luksFormat "$dev" --key-file - ||
{ log_fail "luksFormat $dev failed"; return 1; }
printf "%s" "$pass" |
cryptsetup luksOpen "$dev" "$mapname" --key-file - ||
{ log_fail "luksOpen $dev failed"; return 1; }
mke2fs -t "${fstype}" "/dev/mapper/${mapname}" || {
log_fail "failed to mkfs -t $fstype on map $mapname";
return 1;
}
_RET_DEVICE="/dev/mapper/$mapname"
return 0
}
dev_setup() {
local options="$1" dev="" timeout=0 path="/"
# options supported:
# dev=device,timeout=X,path=/
parse_string "${options}" ||
{ log_fail "failed parsing '${options}'"; return 1; }
dev=${_RET_dev:-${dev}}
timeout=${_RET_timeout:-${timeout}}
[ -n "$dev" ] ||
{ log_fail "dev= argument not provided in '${options}'"; return 1; }
short2dev "$dev" ||
{ log_fail "failed to convert $dev to a device"; return 1; }
dev="${_RET}"
debug "dev=${dev} timeout=${timeout}"
wait_for_dev "$dev" "$timeout"
_RET_DEVICE="$dev"
}
clean_path() {
# remove '//' in a path.
local p="$1" tmp=""
while [ "${p#*//}" != "$p" ]; do
tmp=${p#*//}
p="${p%%//*}/${tmp}"
done
_RET="$p"
}
get_workdir() {
local root_rw="$1" dir_prefix="$2" file="$3"
file=${file%/}
if [ "$file" = "/" -o "$file" = "" ]; then
file="_"
fi
clean_path "${root_rw}/${dir_prefix%/}-workdir/${file}"
}
gen_fstab() {
# gen_fstab(mp) - generate a fabricated /etc/fstab for mount point $mp
local mp="$1" m_spec="" m_opts="" m_fstype=""
local spec file vfstype opts pass freq
# just remove any trailing /
[ "$mp" != "/" ] && mp=${mp%/}
while read spec file vfstype opts pass freq; do
[ "$file" = "$mp" ] && {
m_spec="$spec"
m_opts="$opts"
m_fstype="$vfstype"
break
}
done </proc/mounts
[ -z "$m_spec" ] && {
log_warn "did not find root mount point $mp in /proc/mounts"
m_opts="/dev/root"
m_opts="defaults"
m_fstype="auto"
}
echo "# fabricated by overlayroot, rootfs did not contain /etc/fstab"
echo "${m_spec} / ${m_fstype} ${m_opts} 0 0 "
}
overlayrootify_fstab() {
# overlayrootify_fstab(input, root_ro, root_rw, dir_prefix, recurse, swap)
# read input fstab file, write an overlayroot version to stdout
# also returns (_RET) a list of directories that will need to be made
local input="$1" root_ro="${2:-/media/root-ro}"
local root_rw="${3:-/media/root-rw}" dir_prefix="${4:-/}"
local recurse=${5:-1} swap=${6:-0} fstype=${7:-overlayfs}
local hash="#" oline="" ospec="" upper="" dirs="" copy_opts="" copy_opt=""
local spec file vfstype opts pass freq line ro_line
local workdir="" use_orig="" relfile="" needs_workdir=false noauto=""
[ -f "$input" ] || return 1
cat <<EOF
#
# This fstab is for overlayroot. The real one can be found at
# ${root_ro}/etc/fstab
# The original entry for '/' and other mounts have been updated to be placed
# under $root_ro.
# To permanently modify this (or any other file), you should change-root into
# a writable view of the underlying filesystem using:
# sudo overlayroot-chroot
#
EOF
needs_workdir && needs_workdir=true || needs_workdir=false
while read spec file vfstype opts pass freq; do
[ "$file" = "/" ] && noauto="noauto" || noauto=""
line="$spec $file $vfstype $opts $pass $freq"
case ",$opts," in
*,ro,*) ro_opts="$opts";;
*) ro_opts="ro,${opts}";;
esac
ro_line="$spec ${root_ro}$file $vfstype"
ro_line="${ro_line} ${ro_opts}${noauto:+,${noauto}} $pass $freq"
use_orig=""
if [ "${spec#${hash}}" != "$spec" ]; then
use_orig="comment"
elif [ -z "$freq" ]; then
use_orig="malformed-line"
else
case "$vfstype" in
vfat|fat) use_orig="fs-unsupported";;
proc|sys|tmpfs|dev|udev|debugfs) use_orig="fs-virtual";;
esac
fi
if [ -n "$use_orig" ]; then
if [ "$use_orig" != "comment" ]; then
echo "$line # $MYTAG:$use_orig"
else
echo "$line"
fi
elif [ "$vfstype" = "swap" ]; then
if [ "$swap" = "0" ]; then
# comment out swap lines
echo "#$MYTAG:swap=${swap}#${line}"
elif [ "${spec#/}" != "${spec}" ] &&
[ "${spec#/dev/}" = "${spec}" ]; then
# comment out swap files (spec starts with / and not in /dev)
echo "#$MYTAG:swapfile#${line}"
else
echo "${line}"
fi
else
ospec="${root_ro}${file}"
copy_opts=""
for copy_opt in nobootwait noauto nofail; do
case ",$opts," in
*,${copy_opt},*)
copy_opts="${copy_opts},${copy_opt}";;
esac
done
clean_path "${root_rw}/${dir_prefix}${file}"
upper="$_RET"
oline="${ospec} ${file} $fstype "
clean_path "${root_ro}${file}"
oline="${oline}lowerdir=$_RET"
oline="${oline},upperdir=${upper}${copy_opts}"
if [ "$fstype" = "overlayfs" -o "$fstype" = "overlay" ] &&
${needs_workdir}; then
get_workdir "$root_rw" "$dir_prefix" "$file"
workdir="$_RET"
oline="${oline},workdir=$workdir"
dirs="${dirs} $workdir"
fi
oline="${oline} $pass $freq"
if [ "$recurse" != "0" -o "$file" = "/" ]; then
if [ "$file" = "/" ]; then
# this can confuse systemd (LP: #1723183)
echo "#$ro_line"
else
echo "$ro_line"
fi
echo "$oline"
dirs="${dirs} ${upper}"
else
echo "$line"
fi
fi
done < "$input"
_RET=${dirs# }
}
short2dev() {
# turn 'LABEL=' or 'UUID=' into a device path
# also support /dev/* and 'vdb' or 'xvda'
local input="$1" oifs="$IFS" dev newdev s
case "$input" in
LABEL=*)
dev="${input#LABEL=}"
case "${dev}" in
*/*) dev="$(echo "${dev}" | sed 's,/,\\x2f,g')";;
esac
dev="/dev/disk/by-label/${dev}"
;;
UUID=*) dev="/dev/disk/by-uuid/${input#UUID=}" ;;
/dev/*) dev="${input}";;
*) dev="/dev/${input}";;
esac
_RET=$dev
}
get_cfg() {
# get_cfg(device, file, cfg, timeout=0)
# copy the file $cfg off $device to $file, waiting $timeout for
# $device to appear
local dev="$1" file="$2" cfg="${3:-overlayroot.conf}" timeout="${4:-0}"
local cfgdev="" success=0 didmnt=false mp="" pre="get_cfg($dev):"
[ -z "$dev" ] && return 1
if [ "$timeout" != "0" ]; then
wait_for_dev "$dev" "$timeout" ||
{ debug "$pre did not appear in $timeout"; return 1; }
else
udevadm settle
fi
short2dev "$dev" && cfgdev="$_RET" && [ -b "$cfgdev" ] ||
{ debug "$pre not present"; return 1; }
if mp="${TEMP_D}/mp" && mkdir "$mp" &&
mount -o ro "$cfgdev" "$mp"; then
if [ -f "$mp/$cfg" ]; then
cp "$mp/$cfg" "$file" && success=1 ||
debug "$pre copy failed"
else
debug "$pre '$file' file not found"
fi
umount "$mp"
else
debug "$pre mount failed"
fi
[ -d "$mp" ] || rmdir "$mp"
[ $success -eq 1 ] || return 1
_RET="$dev/$cfg"
}
parse_cfg() {
# parse_cfg($file,$desc,$vars)
# this reasonably safely sources the "config" file $file
# and then declares the variables listed to stdout
#
# known issues:
# * sourced file could re-define 'echo'
# * just fails if a value has a ' in it
[ -f "$1" ] || return 0
tick="'" sh -c '
__tick=$tick
__file=$1; __desc=$2;
__unset__="__unset__"
shift 2
__vars="$*"
readonly __tick __file __desc __vars
. "${__file}"
if [ $? -ne 0 ]; then
echo "failed source \"${__file}\" ($__desc)" 1>&2
return 1
fi
set -e
echo "desc=${__tick}${__desc}${__tick}"
for var in ${__vars}; do
eval val=\${${var}-${__unset__}} ||
{ echo "eval of $var failed"; exit 1; }
[ "${val#*${__tick}}" = "${val}" ] || {
echo "variable \"$var\" had single tick in it. fail";
exit 1;
}
[ "${val}" = "${__unset__}" ] ||
echo "$var=${__tick}${val}${__tick}"
done
' -- "$@"
}
readcfgd() {
local cfg_d="$1"
# this kind of stinks, each VARIABLE goes into global scope
local or="" or_cfgdisk=""
_RET_desc_oroot=""
_RET_desc_cfgdisk=""
set +f
for f in "${cfg_d}"/*; do
. "$f" || fail "failed reading $f"
[ "$or" != "${overlayroot}" ] &&
_RET_desc_oroot="$desc"
[ "${or_cfgdisk}" != "${overlayroot_cfgdisk}" ] &&
_RET_desc_cfgdisk="$desc"
or=${overlayroot}
or_cfgdisk=${overlayroot_cfgdisk}
done
set -f
}
fix_upstart_overlayfs() {
# inotify events on an overlayfs underlay do not propogate through
# a newly created overlay. This causes job creation and deletion issues
# for upstart, which uses inotify on /etc/init. So ensure that the overlay
# explicitly has a /etc/init (LP: #1213925)
local root="$1"
local initctl="$root/sbin/initctl"
local eifile="/etc/init/.overlayfs-upstart-helper"
[ -e "$initctl" -o -L "$initctl" ] || return 0
[ -d "$root/etc/init" ] || return 0
echo "#upstart needs help for overlayfs (LP: #1213925)." \
> "$root/$eifile" ||
{ log_fail "failed to write $root/$eifile"; return 1; }
debug "created $eifile under $root (LP: #1213925)"
}
needs_workdir() {
local uname_r="${UNAME_R}"
if [ -z "$uname_r" ]; then
uname_r=$(uname -r) && UNAME_R="$uname_r" ||
{ log_warn "failed to read uname!"; return 2; }
fi
# 3.18+ require 'workdir=' option.
case "${uname_r}" in
2*|3.1[01234567]*|3.[0-9].*) return 1;;
*) return 0;;
esac
}
search_fs_driver() {
# search_fs_driver(driver1, driver2...)
# return the first supported filesystem driver in the list.
# if no drivers are provided, search default list.
# assumes that name in /proc/filesystems and module name are the same.
local m="" driver="" tab=' '
for m in "$@"; do
grep -q "${tab}$m$" /proc/filesystems && driver="$m" &&
{ debug "/proc/filesystems support for '$m'"; break; }
done
if [ -z "$driver" ]; then
for m in "$@"; do
if modprobe -qb "$m"; then
if grep -q "${tab}$m$" /proc/filesystems; then
debug "loaded module '$m'";
driver="$m"
break;
else
log_warn "loaded '$m' module but no '$m' in /proc/filesystems"
fi
fi
done
fi
[ -n "$driver" ] ||
{ debug "Unable to find driver/module. searched: $*"; return 1; }
_RET="$driver"
}
cfgd="${TEMP_D}/configs"
mkdir -p "${cfgd}" || fail "failed to create tempdir"
trap cleanup EXIT
# collect the different config locations into a file
# write individual config files in $cfgd that contain
{
echo "desc='builtin'"
echo "overlayroot=''"
echo "overlayroot_cfgdisk='disabled'"
} > "$cfgd/00-builtin"
write_kernel_cmdline_cfg "${cfgd}/90-kernel" ||
fail "failed to read kernel command line!"
parse_cfg "/conf/conf.d/overlayroot" "initramfs config" \
"$VARIABLES" > "${cfgd}/10-initramfs" ||
fail "failed parsing initramfs config"
parse_cfg "${ROOTMNT}/etc/overlayroot.conf" "$ROOT/etc/overlayroot.conf" \
"$VARIABLES" > "${cfgd}/20-root-config" ||
fail "failed parsing root config"
parse_cfg "${ROOTMNT}/etc/overlayroot.local.conf" \
"$ROOT/etc/overlayroot.local.conf" \
"$VARIABLES" > "${cfgd}/30-root-local-config" ||
fail "failed parsing root config"
# now read the trusted configs, to see if overlayroot_cfgdisk is set
readcfgd "$cfgd" ||
fail "reading configs failed"
used_desc="${_RET_desc_oroot}"
[ -n "${_RET_desc_cfgdisk}" ] &&
debug "${_RET_desc_cfgdisk} set cfgdisk='${overlayroot_cfgdisk}'"
# if one of the trusted configs above gave us set the overlayroot_cfgdisk
# variable, then look for such a device and read a config from it.
cfgdisk=0
if [ "${overlayroot_cfgdisk:-disabled}" != "disabled" ] &&
get_cfg "${overlayroot_cfgdisk}" "${TEMP_D}/cfgdisk"; then
desc=${_RET}
parse_cfg "${TEMP_D}/cfgdisk" "${desc}" "$VARIABLES" \
> "${cfgd}/80-cfgdisk" ||
fail "reading config from ${desc} failed"
used_desc="${_RET_desc_oroot}"
# now read the parsed configs again.
readcfgd "$cfgd" ||
fail "reading configs failed"
[ -n "${_RET_desc_cfgdisk}" ] &&
debug "${_RET_desc_cfgdisk} set cfgdisk=${overlayroot_cfgdisk}"
[ -n "${_RET_desc_oroot}" ] &&
debug "${_RET_desc_oroot} set overlayroot=${overlayroot}"
fi
opts=""
cfgmsg="${used_desc:+ (per ${used_desc})}"
case "${overlayroot:-disabled}" in
tmpfs|tmpfs:*)
mode="tmpfs"
opts="${overlayroot#tmpfs}";
opts=${opts#:}
;;
/dev/*|device:*)
case "$overlayroot" in
/dev/*) opts="dev=${overlayroot}";;
*) opts="${overlayroot#device:}";;
esac
dev_setup "${opts}" ||
fail "failed setup overlay for ${overlayroot} [$opts]${cfgmsg}"
mode="device"
device="$_RET_DEVICE"
;;
crypt:*)
mode="crypt"
opts=${overlayroot#crypt:}
crypto_setup "${opts}" ||
fail "failed setup crypt for ${overlayroot}${cfgmsg}"
device="$_RET_DEVICE"
;;
disabled)
debug "overlayroot disabled${cfgmsg}"
exit 0;;
*)
fail "invalid value for overlayroot: ${overlayroot}${cfgmsg}"
exit 0;;
esac
parse_string "$opts" "," _RET_common_
swap=${_RET_common_swap:-0}
recurse=${_RET_common_recurse:-1}
OVERLAYROOT_DEBUG=${_RET_common_debug:-${OVERLAYROOT_DEBUG}}
dir_prefix=${_RET_common_dir:-"/overlay"}
overlayroot_driver=${_RET_common_driver}
read cmdline </proc/cmdline
cmdline=" $cmdline "
[ "${cmdline#* ro }" != "$cmdline" ] && cmdline_ro=true || cmdline_ro=false
if [ "${overlayroot_driver:-auto}" = "auto" ]; then
search_fs_driver overlay overlayfs ||
fail "Unable to find a driver. searched: overlay overlayfs"
overlayroot_driver="$_RET"
else
search_fs_driver ${overlayroot_driver} ||
fail "Unable to find a driver named '${overlayroot_driver}'"
overlayroot_driver="$_RET"
fi
debug "swap=$swap recurse=$recurse debug=$OVERLAYROOT_DEBUG dir=$dir_prefix"
debug "device=$device mode=$mode driver=${overlayroot_driver}"
[ "$swap" = "0" -o "$swap" = "1" ] ||
fail "invalid setting for swap: $swap. must be '0' or '1'"
[ "$recurse" = "0" -o "$recurse" = "1" ] ||
fail "invalid setting for recurse: $recurse. must be '0' or '1'"
log_warn "configuring overlayroot with driver=${overlayroot_driver} mode=$mode opts='$opts' per $used_desc"
# settings based on overlayroot_driver
workdir=""
case "${overlayroot_driver}" in
overlayfs|overlay)
mount_type="${overlayroot_driver}"
mount_opts="-o lowerdir=${root_ro},upperdir=${root_rw}/${dir_prefix}"
if needs_workdir; then
get_workdir "$root_rw" "$dir_prefix" "/"
workdir="$_RET"
mount_opts="${mount_opts},workdir=$workdir"
fi
clean_path "${mount_opts} overlayroot ${ROOTMNT}"
mount_opts="$_RET"
;;
aufs)
mount_type="aufs"
mount_opts="-o dirs=${root_rw}/${dir_prefix}:${root_ro}=ro aufs-root ${ROOTMNT}"
;;
*)
log_fail "invalid overlayroot driver: ${overlayroot_driver}"
panic "$MYTAG"
;;
esac
# make the mount point on the init root fs ${root_rw}
mkdir -p "${root_rw}" ||
fail "failed to create ${root_rw}"
# make the mount point on the init root fs ${root_ro}
mkdir -p "${root_ro}" ||
fail "failed to create ${root_ro}"
# mount the backing device to $root_rw
if [ "$mode" = "tmpfs" ]; then
# mount a tmpfs using the device name tmpfs-root
mount -t tmpfs tmpfs-root "${root_rw}" ||
fail "failed to create tmpfs"
else
# dev or crypto
mount "$device" "${root_rw}" ||
fail "failed mount backing device $device"
fi
mkdir -p "${root_rw}/${dir_prefix}" ||
fail "failed to create ${dir_prefix} on ${device}"
[ -z "$workdir" ] || mkdir -p "$workdir" ||
fail "failed to create workdir '$workdir' on ${device}"
# root is mounted on ${ROOTMNT}, move it to ${ROOT_RO}.
mount --move "${ROOTMNT}" "${root_ro}" ||
fail "failed to move root away from ${ROOTMNT} to ${root_ro}"
# there is nothing left at ${ROOTMNT} now. So for any error we get we should
# either do recovery to restore ${ROOTMNT} for drop to a initramfs shell using
# "panic". Otherwise the boot process is very likely to fail with even more
# errors and leave the system in a wired state.
# mount virtual fs ${ROOTMNT} with rw-fs ${root_rw} on top or ro-fs ${root_ro}.
debug mount -t "$mount_type" $mount_opts
mount -t "$mount_type" $mount_opts
if [ $? -ne 0 ]; then
log_fail "failed to create new ro/rw layered ${ROOTMNT}"
log_fail "mount command was: mount -t $mount_type $mount_opts"
# do recovery and try restoring the mount for ${ROOTMNT}
mount --move ${root_ro} ${ROOTMNT}
if [ $? -ne 0 ]; then
# thats bad, drop to shell to let the user try fixing this
log_fail "RECOVERY_ERROR: failed to move $root_ro back to ${ROOTMNT}"
panic "$MYTAG"
fi
exit 0
fi
# now the real root fs is on ${root_ro} of the init file system, our
# layered root fs is set up at ${ROOTMNT}. So we can write anywhere in
# {ROOTMNT} and the changes will end up in ${root_rw} while ${root_ro} it
# not touched. However ${root_ro} and ${root_rw} are on the initramfs root
# fs, which will be removed an replaced by ${ROOTMNT}. Thus we must move
# ${root_ro} and ${root_rw} to the rootfs visible later, ie.
# ${ROOTMNT}${root_ro} and ${ROOTMNT}${root_ro}. Since the layered ro/rw
# is already up, these changes also end up on ${root_rw} while ${root_ro}
# is not touched.
# move mount from ${root_ro} to ${ROOTMNT}${root_ro}
mkdir -p "${ROOTMNT}/${root_ro}"
mount --move ${root_ro} "${ROOTMNT}${root_ro}" ||
fail "failed to move ${root_ro} to ${ROOTMNT}${root_ro}"
# move mount from ${root_rw} to ${ROOTMNT}${root_rw}
[ -d ${ROOTMNT}${root_rw} ] || mkdir -p ${ROOTMNT}${root_rw}
mount --move "${root_rw}" "${ROOTMNT}${root_rw}" ||
fail "failed to move ${root_rw} to ${ROOTMNT}${root_rw}"
# technically, everything is set up nicely now. Since ${ROOTMNT} had beend
# mounted read-only on the initfamfs already, ${ROOTMNT}${root_ro} is it,
# too. Now we init process could run - but unfortunately, we may have to
# prepare some more things here.
# Basically, there are two ways to deal with the read-only root fs. If the
# system is made aware of this, things can be simplified a lot. If it is
# not, things need to be done to our best knowledge.
#
# So we assume here, the system does not really know about our read-only
# root fs.
#
# Let's deal with /etc/fstab first. It usually contains an entry for the
# root fs, which is no longer valid now. We have to remove it and add our
# new ${root_ro} entry.
# Remember we are still on the initramfs root fs here, so we have to work
# on ${ROOTMNT}/etc/fstab. The original fstab is
# ${ROOTMNT}${root_ro}/etc/fstab.
source_fstab="$ROOTMNT/${root_ro}/etc/fstab"
if [ ! -f "$source_fstab" ] && [ "$cmdline_ro" = "true" ]; then
debug "rootfs did not contain /etc/fstab, creating" \
"based on kernel cmdline"
source_fstab="${TEMP_D}/fstab"
gen_fstab "${ROOTMNT}${root_ro}" > "$source_fstab" ||
log_fail "gen_fstab failed for $ROOTMNT/$root_ro"
fi
if [ -f "$source_fstab" ]; then
overlayrootify_fstab "$source_fstab" "$root_ro" \
"$root_rw" "$dir_prefix" "$recurse" "$swap" "${overlayroot_driver}" \
> "${ROOTMNT}/etc/fstab" ||
log_fail "failed to modify /etc/fstab"
else
debug "rootfs did not contain /etc/fstab."
fi
# we have to make the directories in ${root_rw} because if they do not
# exist, then the 'upper=' argument to overlayfs will fail.
for d in ${_RET}; do
mkdir -p "${ROOTMNT}/$d"
done
if [ "${overlayroot_driver}" = "overlayfs" ]; then
fix_upstart_overlayfs "$ROOTMNT" ||
log_fail "failed to fix upstart for overlayfs"
fi
# if / is supposed to be mounted read-only (cmdline with 'ro')
# then mount our overlayfs as read-only just to be more normal
if [ "${cmdline_ro}" = "true" ]; then
mount -o remount,ro "$ROOTMNT" ||
log_fail "failed to remount overlayroot read-only"
debug "mounted $ROOTMNT read-only per kernel cmdline"
fi
msg="configured root with '$overlayroot' using ${overlayroot_driver} per"
msg="$msg ${used_desc}"
log_success "$msg"
exit 0
# vi: ts=4 noexpandtab

View file

@ -0,0 +1,21 @@
.TH overlayroot-chroot 8 "20 July 2012" overlayroot-chroot "initramfs-tools-overlayroot"
.SH NAME
\fBoverlayroot-chroot\fP - chroot into the lower filesystem in a writable mode
.SH SYNOPSIS
\fBoverlayroot-chroot\fP [COMMAND [ARG]...]
.SH DESCRIPTION
\fBoverlayroot-chroot\fP is a program that sets up bind mounts for \fI/proc\fP, \fI/run\fP, and \fI/sys\fP, remounts the lower directory in an overlayfs with write capabilities and will \fBchroot\fP(8) into it. Upon exit, the bind mounts are unmounted.
Any [COMMAND [ARG]...] are passed directly through to \fBchroot\fP(8).
.SH SEE ALSO
.TP
\fBchroot\fP(8)
.PD
.SH AUTHOR
This manpage and the utility were written by Dustin Kirkland <kirkland@ubuntu.com> for Ubuntu systems (but may be used by others). Permission is granted to copy, distribute and/or modify this document and the utility under the terms of the GNU General Public License, Version 3 published by the Free Software Foundation.
The complete text of the GNU General Public License can be found in \fI/usr/share/common-licenses/GPL\fP on Debian/Ubuntu systems, or on the web at \fIhttp://www.gnu.org/licenses/gpl.txt\fP.

View file

@ -0,0 +1,377 @@
#!/usr/bin/env python3
import os
import subprocess
import gi
gi.require_version('Gtk', '3.0')
from gi.repository import Gtk, Gdk
# Kurulum bayrağının konumu: Kullanıcının ana dizininde, yazma izni sorunu yaşamamak için.
SETUP_FLAG_FILE = os.path.expanduser("~/.setup_tamam")
# -------------------- Yardımcı Fonksiyonlar --------------------
def run_as_root(cmd_list):
"""
Belirtilen komut listesini pkexec kullanarak root ayrıcalıklarıyla çalıştırır.
Eğer kullanıcı root şifresini girmeyi iptal ederse, uygun uyarı mesajı verir.
"""
try:
subprocess.run(["pkexec"] + cmd_list, check=True)
except subprocess.CalledProcessError as e:
if e.returncode == 1:
raise RuntimeError("Root yetkilendirmesi iptal edildi! Lütfen root şifresini giriniz. Sistem, root yetkisi ile çalıştırılmalıdır.")
raise RuntimeError(f"Komut hatası: {e.cmd}, Çıkış kodu: {e.returncode}")
def set_setup_complete_flag():
"""
Kurulumun tamamlandığını belirten bayrak dosyasını oluşturur.
Böylece sonraki çalıştırmalarda kurulum sihirbazı tekrarlanmaz.
"""
try:
with open(SETUP_FLAG_FILE, "w") as file:
file.write("setup_complete")
except Exception as ex:
print(f"Kurulum bayrağı ayarlanırken hata: {ex}")
def read_users():
"""
Sistemdeki mevcut kullanıcıları /etc/passwd dosyasından okur.
"""
users = []
try:
with open("/etc/passwd", "r") as file:
for line in file:
parts = line.split(":")
if parts:
users.append(parts[0])
except Exception as ex:
print(f"Kullanıcılar okunurken hata: {ex}")
return users
def get_mount_device(mount_point):
"""
Belirtilen mount noktasının bağlı olduğu aygıtı /proc/mounts dosyasından bulur.
"""
try:
with open("/proc/mounts", "r") as file:
for line in file:
parts = line.split()
if parts[1] == mount_point:
return parts[0]
except Exception:
pass
return None
def overlayroot_status():
"""
Sistem Dondurma durumunu, /media/root-rw montajı ve /etc/overlayroot.conf dosyasına göre belirler.
"""
if get_mount_device("/media/root-rw"):
return True
conf_path = "/etc/overlayroot.conf"
if os.path.exists(conf_path):
try:
with open(conf_path, "r") as file:
content = file.read()
return "tmpfs" in content
except Exception:
return False
else:
try:
result = subprocess.run(["dpkg", "-l", "romtal-sistem-dondurma"],
capture_output=True, text=True)
return "overlayroot" in result.stdout
except Exception:
return False
# -------------------- Kurulum Sihirbazı (Setup Wizard) --------------------
class SetupWizard(Gtk.Window):
"""
Üç aşamalı kurulum sihirbazı:
1. Açıklama Sayfası: Neden nonroot kullanıcı kullanılmalı? İki seçenek sunar.
2. Kullanıcı Oluşturma Sayfası: Önerilen "ogrenci" adında, sınırlı yetkili kullanıcı oluşturulur.
3. Onay Sayfası: İşlemin tamamlandığı bildirildiği sayfa.
NOT: Notebook sekmeleri gizlenmiştir; kullanıcı yalnızca sayfa içindeki gezinme butonlarıyla ilerler.
"""
def __init__(self):
super().__init__(title="Kurulum Sihirbazı")
self.set_default_size(600, 500)
self.set_border_width(20)
self.notebook = Gtk.Notebook()
self.notebook.set_show_tabs(False)
self.add(self.notebook)
self.create_explanation_page()
self.create_user_creation_page()
self.create_confirmation_page()
def create_explanation_page(self):
page = Gtk.Box(orientation=Gtk.Orientation.VERTICAL, spacing=15)
page.set_border_width(15)
explanation_label = Gtk.Label()
explanation_label.set_markup(
"<b>R.O.M.T.A.L | https://rasimoneltml.meb.k12.tr/</b>\n\n"
"<b>Neden Yeni Bir Kullanıcı Oluşturmalısınız?</b>\n\n"
"Bu sistem, güvenlik açısından root yetkisinin kullanılmaması gereken bir yapıya sahiptir. "
"Root yetkisine sahip bir kullanıcı, sistem üzerinde tam kontrol sağlar ve güvenlik risklerini artırır.\n\n"
"Eğer sisteminizde zaten root yetkisine sahip olmayan bir kullanıcı mevcutsa, bu adımı atlayabilirsiniz. "
"Aksi halde, lütfen 'Devam Et' butonuna basarak örneğin 'ogrenci' adlı sınırlı yetkili bir kullanıcı oluşturun."
)
explanation_label.set_line_wrap(True)
page.pack_start(explanation_label, True, True, 0)
nav_box = Gtk.Box(orientation=Gtk.Orientation.HORIZONTAL, spacing=10)
skip_button = Gtk.Button(label="Atla")
continue_button = Gtk.Button(label="Devam Et")
skip_button.connect("clicked", self.on_skip_clicked)
continue_button.connect("clicked", self.on_continue_to_creation)
nav_box.pack_start(skip_button, True, True, 0)
nav_box.pack_start(continue_button, True, True, 0)
page.pack_start(nav_box, False, False, 0)
self.notebook.append_page(page, Gtk.Label(label="Açıklama"))
def create_user_creation_page(self):
page = Gtk.Box(orientation=Gtk.Orientation.VERTICAL, spacing=15)
page.set_border_width(15)
instruction_label = Gtk.Label(
label="Yeni bir kullanıcı oluşturmak için lütfen bilgileri giriniz. "
"Önerilen kullanıcı adı: 'ogrenci'"
)
instruction_label.set_line_wrap(True)
page.pack_start(instruction_label, False, False, 0)
form_grid = Gtk.Grid(column_spacing=10, row_spacing=10)
username_label = Gtk.Label(label="Kullanıcı Adı:")
self.username_entry = Gtk.Entry()
self.username_entry.set_text("ogrenci")
self.username_entry.set_placeholder_text("örn: ogrenci")
password_label = Gtk.Label(label="Şifre:")
self.password_entry = Gtk.Entry()
self.password_entry.set_placeholder_text("Güçlü bir şifre giriniz")
self.password_entry.set_visibility(False)
form_grid.attach(username_label, 0, 0, 1, 1)
form_grid.attach(self.username_entry, 1, 0, 1, 1)
form_grid.attach(password_label, 0, 1, 1, 1)
form_grid.attach(self.password_entry, 1, 1, 1, 1)
page.pack_start(form_grid, False, False, 0)
nav_box = Gtk.Box(orientation=Gtk.Orientation.HORIZONTAL, spacing=10)
back_button = Gtk.Button(label="Geri")
create_button = Gtk.Button(label="Kullanıcı Oluştur")
back_button.connect("clicked", lambda w: self.notebook.set_current_page(0))
create_button.connect("clicked", self.on_create_user)
nav_box.pack_start(back_button, True, True, 0)
nav_box.pack_start(create_button, True, True, 0)
page.pack_start(nav_box, False, False, 0)
self.notebook.append_page(page, Gtk.Label(label="Kullanıcı Oluşturma"))
def create_confirmation_page(self):
page = Gtk.Box(orientation=Gtk.Orientation.VERTICAL, spacing=15)
page.set_border_width(15)
confirmation_label = Gtk.Label(
label="Kullanıcı başarıyla oluşturuldu.\nKurulum tamamlandı.\n"
"Ana arayüze geçmek için 'Devam Et' butonuna basınız."
)
confirmation_label.set_line_wrap(True)
page.pack_start(confirmation_label, True, True, 0)
nav_box = Gtk.Box(orientation=Gtk.Orientation.HORIZONTAL, spacing=10)
back_button = Gtk.Button(label="Geri")
continue_button = Gtk.Button(label="Devam Et")
back_button.connect("clicked", lambda w: self.notebook.set_current_page(1))
continue_button.connect("clicked", self.on_final_continue)
nav_box.pack_start(back_button, True, True, 0)
nav_box.pack_start(continue_button, True, True, 0)
page.pack_start(nav_box, False, False, 0)
self.notebook.append_page(page, Gtk.Label(label="Onay"))
def on_skip_clicked(self, widget):
"""
Eğer sisteminizde root yetkisine sahip olmayan bir kullanıcı mevcutsa,
bu adımı atlayarak ana arayüze geçin.
"""
set_setup_complete_flag()
self.hide()
main_app = SistemDondurmaGUI()
main_app.connect("destroy", Gtk.main_quit)
main_app.show_all()
def on_continue_to_creation(self, widget):
"""
'Devam Et' butonuna basıldığında, kullanıcı oluşturma sayfasına geçiş yapılır.
"""
self.notebook.set_current_page(1)
def on_create_user(self, widget):
"""
Kullanıcı adı ve şifre bilgilerini alır, ardından önerilen nonroot kullanıcıyı oluşturur.
Eğer girilen kullanıcı adı zaten sistemde mevcutsa hata mesajı gösterip farklı bir isim istenir.
Kullanıcı oluşturma ve şifre ayarlama işlemleri tek bir pkexec çağrısında birleştirilmiştir.
"""
username = self.username_entry.get_text().strip()
password = self.password_entry.get_text().strip()
if not username or not password:
self.show_dialog("Kullanıcı adı ve şifre boş bırakılamaz!", True)
return
if username in read_users():
self.show_dialog(f"{username} adlı kullanıcı zaten mevcut! Lütfen farklı bir kullanıcı adı giriniz.", True)
return
try:
cmd = ["sh", "-c", f"useradd -m --shell /bin/bash {username} && echo '{username}:{password}' | chpasswd"]
run_as_root(cmd)
self.show_dialog(f"{username} adlı kullanıcı başarıyla oluşturuldu.", False)
self.notebook.set_current_page(2)
except Exception as e:
self.show_dialog(f"Kullanıcı oluşturulurken hata: {e}", True)
def on_final_continue(self, widget):
"""
Kurulum tamamlandığında bayrak dosyası oluşturulur ve ana arayüz açılır.
"""
set_setup_complete_flag()
self.hide()
main_app = SistemDondurmaGUI()
main_app.connect("destroy", Gtk.main_quit)
main_app.show_all()
def show_dialog(self, message, is_error=False):
dialog = Gtk.MessageDialog(
transient_for=self,
flags=0,
message_type=Gtk.MessageType.ERROR if is_error else Gtk.MessageType.INFO,
buttons=Gtk.ButtonsType.OK,
text=message
)
dialog.run()
dialog.destroy()
# -------------------- Ana Uygulama Arayüzü (Sistem Dondurma GUI) --------------------
class SistemDondurmaGUI(Gtk.Window):
def __init__(self):
super().__init__(title="R.O.M.T.A.L Sistem Dondurma")
self.set_default_size(500, 300)
self.set_border_width(20)
self.setup_css()
self.overlayroot_aktif = overlayroot_status()
self.create_ui()
def setup_css(self):
css = b"""
label { font-size: 14px; }
"""
style_provider = Gtk.CssProvider()
style_provider.load_from_data(css)
Gtk.StyleContext.add_provider_for_screen(
Gdk.Screen.get_default(),
style_provider,
Gtk.STYLE_PROVIDER_PRIORITY_APPLICATION
)
def create_ui(self):
grid = Gtk.Grid(column_spacing=10, row_spacing=10)
grid.set_column_homogeneous(True)
self.status_label = Gtk.Label()
self.enable_btn = Gtk.Button(label="Sistem Dondurma Aktif Et")
self.enable_btn.connect("clicked", self.enable_overlayroot)
self.disable_btn = Gtk.Button(label="Sistem Dondurma Devre Dışı")
self.disable_btn.connect("clicked", self.disable_overlayroot)
footer_label = Gtk.Label(label="R.O.M.T.A.L | https://rasimoneltml.meb.k12.tr/")
grid.attach(self.status_label, 0, 0, 2, 1)
grid.attach(self.enable_btn, 0, 1, 1, 1)
grid.attach(self.disable_btn, 1, 1, 1, 1)
grid.attach(footer_label, 0, 2, 2, 1)
self.add(grid)
self.update_status()
def update_status(self):
status_text = "Aktif" if self.overlayroot_aktif else "Devre Dışı"
self.status_label.set_markup(f"<b>Sistem Dondurma Durumu: {status_text}</b>")
self.enable_btn.set_sensitive(not self.overlayroot_aktif)
self.disable_btn.set_sensitive(self.overlayroot_aktif)
def show_dialog(self, message, is_error=False):
dialog = Gtk.MessageDialog(
transient_for=self,
flags=0,
message_type=Gtk.MessageType.ERROR if is_error else Gtk.MessageType.INFO,
buttons=Gtk.ButtonsType.OK,
text=message
)
dialog.run()
dialog.destroy()
def enable_overlayroot(self, widget):
try:
cmd = [
"sh", "-c",
("rm -f /etc/overlayroot.conf && "
"echo 'overlayroot_cfgdisk=\"disable\"' > /etc/overlayroot.conf && "
"echo 'overlayroot=\"tmpfs\"' >> /etc/overlayroot.conf")
]
run_as_root(cmd)
self.overlayroot_aktif = True
self.update_status()
self.show_dialog("Sistem Dondurma başarıyla aktif edildi.\nDeğişikliklerin geçerli olması için sistemi yeniden başlatın.")
except Exception as e:
self.show_dialog(f"Sistem Dondurma etkinleştirilirken hata: {e}", True)
def disable_overlayroot(self, widget):
"""
Sistem Dondurma işlemini devre dışı bırakır.
Eğer /media/root-ro mount edilmişse ilgili dizin üzerinden işlem yapılır;
aksi halde, /etc/overlayroot.conf dosyası doğrudan güncellenir.
"""
try:
device = get_mount_device("/media/root-ro")
if device:
cmd = [
"sh", "-c",
(f"mount -o remount,rw {device} && "
"rm -f /media/root-ro/etc/overlayroot.conf && "
"echo 'overlayroot_cfgdisk=\"disable\"' > /media/root-ro/etc/overlayroot.conf && "
"echo 'overlayroot=\"\"' >> /media/root-ro/etc/overlayroot.conf")
]
else:
cmd = [
"sh", "-c",
("rm -f /etc/overlayroot.conf && "
"echo 'overlayroot_cfgdisk=\"disable\"' > /etc/overlayroot.conf && "
"echo 'overlayroot=\"\"' >> /etc/overlayroot.conf")
]
run_as_root(cmd)
self.overlayroot_aktif = False
self.update_status()
self.show_dialog("Sistem Dondurma başarıyla devre dışı bırakıldı.\nDeğişikliklerin geçerli olması için sistemi yeniden başlatın.")
except Exception as e:
self.show_dialog(f"Sistem Dondurma devre dışı bırakılırken hata: {e}", True)
# -------------------- Uygulama Giriş Noktası --------------------
if __name__ == "__main__":
if not os.path.exists(SETUP_FLAG_FILE):
wizard = SetupWizard()
wizard.connect("destroy", Gtk.main_quit)
wizard.show_all()
else:
app = SistemDondurmaGUI()
app.connect("destroy", Gtk.main_quit)
app.show_all()
Gtk.main()

View file

@ -0,0 +1 @@
export CRYPTSETUP=y

View file

@ -0,0 +1,2 @@
overlayroot_cfgdisk="disabled"
overlayroot=""

View file

@ -0,0 +1,4 @@
#!/bin/sh
(egrep "overlayroot|/media/root-ro|/media/root-rw" /proc/mounts 2>/dev/null | sort -r) || true
echo

View file

@ -0,0 +1,25 @@
#!/bin/sh
set -e
PREREQS="cryptsetup"
case $1 in
prereqs) echo "${PREREQS}"; exit 0;;
esac
. /usr/share/initramfs-tools/hook-functions
##
copy_exec /usr/bin/head /bin
copy_exec /usr/bin/sha512sum /bin
copy_exec /sbin/wipefs /sbin
copy_exec /sbin/cryptsetup /sbin
copy_exec /sbin/mke2fs /sbin
# this is '||' only in case aesni_intel module isn't built (or others are built in)
manual_add_modules overlayfs overlay dm_mod dm_crypt aesni_intel || true
# Grab as much true random data as possible, up to 4KB, and stash it into a
# random seed in the initramfs
dd if=/dev/random of="${DESTDIR}/.random-seed" bs=1 count=4096 iflag=nonblock >/dev/null 2>&1 || true
# vi: ts=4 noexpandtab

View file

@ -0,0 +1,878 @@
#!/bin/sh
# Copyright, 2012 Dustin Kirkland <kirkland@ubuntu.com>
# Copyright, 2012 Scott Moser <smoser@ubuntu.com>
# Copyright, 2012 Axel Heider
#
# Based on scripts from
# Sebastian P.
# Nicholas A. Schembri State College PA USA
# Axel Heider
# Dustin Kirkland
# Scott Moser
#
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see
# <http://www.gnu.org/licenses/>.
case "$1" in
# no pre-reqs
prereqs) echo ""; exit 0;;
esac
. /scripts/functions
PATH=/usr/sbin:/usr/bin:/sbin:/bin
MYTAG="overlayroot"
TEMP_D="${TMPDIR:-/tmp}/${0##*/}.configs"
VARIABLES="overlayroot overlayroot_cfgdisk"
# generic settings
# ${ROOT} and ${rootmnt} are predefined by caller of this script. Note that
# the root fs ${rootmnt} it mounted readonly on the initrams, which fits
# nicely for our purposes.
root_rw=/media/root-rw
root_ro=/media/root-ro
ROOTMNT=${rootmnt} # use global name to indicate created outside this
OVERLAYROOT_DEBUG=0
# PERSIST_DIR will persist after pivot-root. It is used for log file
# and for the mktemp-made password file in crypt.
PERSIST_DIR=/run/initramfs
if [ ! -d "$PERSIST_DIR" -a -d /dev/.initramfs ]; then
PERSIST_DIR="/dev/.initramfs"
fi
if [ ! -d "$PERSIST_DIR" ]; then
mkdir -p "$PERSIST_DIR" ||
echo "WARNING: $MYTAG: failed to create ${PERSIST_DIR}" 1>&2
fi
LOG_FILE="${PERSIST_DIR}/${MYTAG}.log"
log() {
"log_${1}_msg" "$MYTAG: $2";
_debug "[$1]:" "$2"
}
log_fail() { log failure "$*"; }
log_success() { log success "$*"; }
log_warn() { log warning "$*"; }
fail() {
[ $# -eq 0 ] || log_fail "$@";
exit 0; # why do we exit success?
}
cleanup() {
[ -d "${TEMP_D}" ] && rm -Rf "${TEMP_D}"
}
debug() {
_debug "$@"
[ "${OVERLAYROOT_DEBUG:-0}" = "0" ] && return
echo "$MYTAG:" "$@"
}
_debug() {
if [ "${DEBUG_BUSTED:-0}" ]; then
{ echo "$@" >> "$LOG_FILE"; } 2>/dev/null ||
{ DEBUG_BUSTED=1; log_warn "debug is busted"; }
fi
}
safe_string() {
local prev="$1" allowed="$2" cur=""
[ -n "$prev" ] || return 1
while cur="${prev#[${allowed}]}"; do
[ -z "$cur" ] && return 0
[ "$cur" = "$prev" ] && break
prev="$cur"
done
return 1
}
parse_string() {
# parse a key/value string like:
# name=mapper,pass=foo,fstype=ext4,mkfs=1
# set variables under namespace 'ns'.
# _RET_name=mapper
# _RET_pass=foo
# _RET_fstype=ext4
# set _RET to the list of variables found
local input="${1}" delim="${2:-,}" ns="${3:-_RET_}"
local oifs="$IFS" tok="" keys="" key="" val=""
set -f; IFS="$delim"; set -- $input; IFS="$oifs"; set +f;
_RET=""
for tok in "$@"; do
key="${tok%%=*}"
val="${tok#${key}}"
val=${val#=}
safe_string "$key" "0-9a-zA-Z_" ||
{ debug "$key not a safe variable name"; return 1; }
eval "${ns}${key}"='${val}' || return 1
keys="${keys} ${ns}${key}"
done
_RET=${keys# }
return
}
get_varval() { eval _RET='${'$1'}'; }
write_kernel_cmdline_cfg() {
local cfg="$1" desc="${2:-kernel cmdline}"
local cmdline="" var=""
read cmdline < /proc/cmdline || return 1
: > "${cfg}" || return
set -f
{
echo "desc='${desc}'"
for tok in $cmdline; do
for var in $VARIABLES; do
if [ "$tok" = "$var" ]; then
log_warn "kernel param without value '${tok}'";
continue;
elif [ "${tok}" = "${var}=" ]; then
echo "${var}=''";
elif [ "${tok#${var}=}" != "${tok}" ]; then
echo "${var}='${tok#${var}=}'"
fi
done
done
} >> "$cfg"
set +f
}
wait_for_dev() {
local dev="$1" timeout="${2:-0}"
[ -b "$dev" ] && return 0
[ "$timeout" = "0" ] && return 1
# wait-for-root writes fstype to stdout, redirect to null
wait-for-root "$dev" "$timeout" >/dev/null
}
crypto_setup() {
local fstype="ext4" pass="" mapname="secure" mkfs="1" dev=""
local timeout=0
local entropy_sources="/proc/sys/kernel/random/boot_id /proc/sys/kernel/random/uuid /dev/urandom"
local seed="" rootseed="$ROOTMNT/var/lib/urandom/random-seed"
if [ ! -f "$rootseed" -a -f "$ROOTMNT/var/lib/systemd/random-seed" ]; then
rootseed="$ROOTMNT/var/lib/systemd/random-seed"
fi
# Seed the psuedo random number generator with available seeds
for seed in "/.random-seed" "$rootseed"; do
[ -f "${seed}" ] ||
{ debug "missing rng seed [${seed}]"; continue; }
cat "${seed}" > /dev/urandom ||
debug "failed seeding /dev/urandom from $seed"
done
# this does necessary crypto setup and sets _RET
# to the appropriate block device (ie /dev/mapper/secure)
# mkfs (default is 1):
# 0: never create filesystem
# 1: if pass is given and mount fails, create a new one
# if no pass given, create new
# 2: if pass is given and mount fails, fail
# if no pass given, create new
local options="$1"
parse_string "${options}" ||
{ log_fail "failed parsing '${options}'"; return 1; }
fstype=${_RET_fstype:-${fstype}}
pass=${_RET_pass:-${pass}}
mapname=${_RET_mapname:-${mapname}}
mkfs=${_RET_mkfs:-${mkfs}}
dev=${_RET_dev:-${dev}}
timeout=${_RET_timeout:-${timeout}}
[ -n "$dev" ] ||
{ log_fail "dev= argument not provided in '${options}'"; return 1; }
short2dev "$dev" ||
{ log_fail "failed to convert $dev to a device"; return 1; }
dev="${_RET}"
debug "fstype=${fstype} pass=${pass} mapname=${mapname}"
debug "mkfs=${mkfs} dev=${dev} timeout=${timeout}"
wait_for_dev "$dev" "$timeout" || {
log_fail "crypt dev device $dev does not exist after ${timeout}s";
return 1;
}
if [ -n "$pass" ]; then
printf "%s" "$pass" |
cryptsetup luksOpen "$dev" "$mapname" --key-file -
if [ $? -eq 0 ]; then
local tdev="/dev/mapper/$mapname"
log_warn "reusing existing luks device at $dev"
wait_for_dev "$tdev" 20 ||
{ log_fail "$tdev did not appear"; return 1; }
_RET_DEVICE="/dev/mapper/$mapname"
return 0
fi
if [ "$mkfs" != "1" ]; then
log_fail "luksOpen failed on $dev with mkfs=$mkfs";
return 1;
fi
log_warn "re-opening $dev failed with mkfs=$mkfs will create new"
else
[ "$mkfs" = "0" ] &&
{ log_fail "mkfs=0, but no password provided"; return 1; }
entropy_sources="$entropy_sources $dev"
local tmpf="" pass_file="${PERSIST_DIR}/${MYTAG}.passwd"
tmpf=$(mktemp "${PERSIST_DIR}/${MYTAG}.XXXXXX") ||
{ log_fail "failed creation of password file"; return 1; }
stat -L /dev/* /proc/* /sys/* >"$tmpf" 2>&1 ||
{ log_warn "could not seed with stat entropy [$entropy_sources]"; }
head -c 4096 $entropy_sources >> "$tmpf" ||
{ log_fail "failed reading entropy [$entropy_sources]"; return 1; }
pass=$(sha512sum "$tmpf") ||
{ log_fail "failed generation of password"; return 1; }
pass=${pass%% *}
printf "%s" "${pass}" > "$tmpf" ||
{ log_fail "failed to record password to '$tmpf'"; return 1; }
mv "$tmpf" "${pass_file}" ||
{ log_fail "failed rename '$tmpf' to '${pass_file}'"; return 1; }
log_debug "stored password in ${pass_file}"
fi
log_warn "setting up new luks device at $dev"
# clear backing device
wipefs -a "$dev" ||
{ log_fail "failed to wipe $dev"; return 1; }
printf "%s" "$pass" | cryptsetup luksFormat "$dev" --key-file - ||
{ log_fail "luksFormat $dev failed"; return 1; }
printf "%s" "$pass" |
cryptsetup luksOpen "$dev" "$mapname" --key-file - ||
{ log_fail "luksOpen $dev failed"; return 1; }
mke2fs -t "${fstype}" "/dev/mapper/${mapname}" || {
log_fail "failed to mkfs -t $fstype on map $mapname";
return 1;
}
_RET_DEVICE="/dev/mapper/$mapname"
return 0
}
dev_setup() {
local options="$1" dev="" timeout=0 path="/"
# options supported:
# dev=device,timeout=X,path=/
parse_string "${options}" ||
{ log_fail "failed parsing '${options}'"; return 1; }
dev=${_RET_dev:-${dev}}
timeout=${_RET_timeout:-${timeout}}
[ -n "$dev" ] ||
{ log_fail "dev= argument not provided in '${options}'"; return 1; }
short2dev "$dev" ||
{ log_fail "failed to convert $dev to a device"; return 1; }
dev="${_RET}"
debug "dev=${dev} timeout=${timeout}"
wait_for_dev "$dev" "$timeout"
_RET_DEVICE="$dev"
}
clean_path() {
# remove '//' in a path.
local p="$1" tmp=""
while [ "${p#*//}" != "$p" ]; do
tmp=${p#*//}
p="${p%%//*}/${tmp}"
done
_RET="$p"
}
get_workdir() {
local root_rw="$1" dir_prefix="$2" file="$3"
file=${file%/}
if [ "$file" = "/" -o "$file" = "" ]; then
file="_"
fi
clean_path "${root_rw}/${dir_prefix%/}-workdir/${file}"
}
gen_fstab() {
# gen_fstab(mp) - generate a fabricated /etc/fstab for mount point $mp
local mp="$1" m_spec="" m_opts="" m_fstype=""
local spec file vfstype opts pass freq
# just remove any trailing /
[ "$mp" != "/" ] && mp=${mp%/}
while read spec file vfstype opts pass freq; do
[ "$file" = "$mp" ] && {
m_spec="$spec"
m_opts="$opts"
m_fstype="$vfstype"
break
}
done </proc/mounts
[ -z "$m_spec" ] && {
log_warn "did not find root mount point $mp in /proc/mounts"
m_opts="/dev/root"
m_opts="defaults"
m_fstype="auto"
}
echo "# fabricated by overlayroot, rootfs did not contain /etc/fstab"
echo "${m_spec} / ${m_fstype} ${m_opts} 0 0 "
}
overlayrootify_fstab() {
# overlayrootify_fstab(input, root_ro, root_rw, dir_prefix, recurse, swap)
# read input fstab file, write an overlayroot version to stdout
# also returns (_RET) a list of directories that will need to be made
local input="$1" root_ro="${2:-/media/root-ro}"
local root_rw="${3:-/media/root-rw}" dir_prefix="${4:-/}"
local recurse=${5:-1} swap=${6:-0} fstype=${7:-overlayfs}
local hash="#" oline="" ospec="" upper="" dirs="" copy_opts="" copy_opt=""
local spec file vfstype opts pass freq line ro_line
local workdir="" use_orig="" relfile="" needs_workdir=false noauto=""
[ -f "$input" ] || return 1
cat <<EOF
#
# This fstab is for overlayroot. The real one can be found at
# ${root_ro}/etc/fstab
# The original entry for '/' and other mounts have been updated to be placed
# under $root_ro.
# To permanently modify this (or any other file), you should change-root into
# a writable view of the underlying filesystem using:
# sudo overlayroot-chroot
#
EOF
needs_workdir && needs_workdir=true || needs_workdir=false
while read spec file vfstype opts pass freq; do
[ "$file" = "/" ] && noauto="noauto" || noauto=""
line="$spec $file $vfstype $opts $pass $freq"
case ",$opts," in
*,ro,*) ro_opts="$opts";;
*) ro_opts="ro,${opts}";;
esac
ro_line="$spec ${root_ro}$file $vfstype"
ro_line="${ro_line} ${ro_opts}${noauto:+,${noauto}} $pass $freq"
use_orig=""
if [ "${spec#${hash}}" != "$spec" ]; then
use_orig="comment"
elif [ -z "$freq" ]; then
use_orig="malformed-line"
else
case "$vfstype" in
vfat|fat) use_orig="fs-unsupported";;
proc|sys|tmpfs|dev|udev|debugfs) use_orig="fs-virtual";;
esac
fi
if [ -n "$use_orig" ]; then
if [ "$use_orig" != "comment" ]; then
echo "$line # $MYTAG:$use_orig"
else
echo "$line"
fi
elif [ "$vfstype" = "swap" ]; then
if [ "$swap" = "0" ]; then
# comment out swap lines
echo "#$MYTAG:swap=${swap}#${line}"
elif [ "${spec#/}" != "${spec}" ] &&
[ "${spec#/dev/}" = "${spec}" ]; then
# comment out swap files (spec starts with / and not in /dev)
echo "#$MYTAG:swapfile#${line}"
else
echo "${line}"
fi
else
ospec="${root_ro}${file}"
copy_opts=""
for copy_opt in nobootwait noauto nofail; do
case ",$opts," in
*,${copy_opt},*)
copy_opts="${copy_opts},${copy_opt}";;
esac
done
clean_path "${root_rw}/${dir_prefix}${file}"
upper="$_RET"
oline="${ospec} ${file} $fstype "
clean_path "${root_ro}${file}"
oline="${oline}lowerdir=$_RET"
oline="${oline},upperdir=${upper}${copy_opts}"
if [ "$fstype" = "overlayfs" -o "$fstype" = "overlay" ] &&
${needs_workdir}; then
get_workdir "$root_rw" "$dir_prefix" "$file"
workdir="$_RET"
oline="${oline},workdir=$workdir"
dirs="${dirs} $workdir"
fi
oline="${oline} $pass $freq"
if [ "$recurse" != "0" -o "$file" = "/" ]; then
if [ "$file" = "/" ]; then
# this can confuse systemd (LP: #1723183)
echo "#$ro_line"
else
echo "$ro_line"
fi
echo "$oline"
dirs="${dirs} ${upper}"
else
echo "$line"
fi
fi
done < "$input"
_RET=${dirs# }
}
short2dev() {
# turn 'LABEL=' or 'UUID=' into a device path
# also support /dev/* and 'vdb' or 'xvda'
local input="$1" oifs="$IFS" dev newdev s
case "$input" in
LABEL=*)
dev="${input#LABEL=}"
case "${dev}" in
*/*) dev="$(echo "${dev}" | sed 's,/,\\x2f,g')";;
esac
dev="/dev/disk/by-label/${dev}"
;;
UUID=*) dev="/dev/disk/by-uuid/${input#UUID=}" ;;
/dev/*) dev="${input}";;
*) dev="/dev/${input}";;
esac
_RET=$dev
}
get_cfg() {
# get_cfg(device, file, cfg, timeout=0)
# copy the file $cfg off $device to $file, waiting $timeout for
# $device to appear
local dev="$1" file="$2" cfg="${3:-overlayroot.conf}" timeout="${4:-0}"
local cfgdev="" success=0 didmnt=false mp="" pre="get_cfg($dev):"
[ -z "$dev" ] && return 1
if [ "$timeout" != "0" ]; then
wait_for_dev "$dev" "$timeout" ||
{ debug "$pre did not appear in $timeout"; return 1; }
else
udevadm settle
fi
short2dev "$dev" && cfgdev="$_RET" && [ -b "$cfgdev" ] ||
{ debug "$pre not present"; return 1; }
if mp="${TEMP_D}/mp" && mkdir "$mp" &&
mount -o ro "$cfgdev" "$mp"; then
if [ -f "$mp/$cfg" ]; then
cp "$mp/$cfg" "$file" && success=1 ||
debug "$pre copy failed"
else
debug "$pre '$file' file not found"
fi
umount "$mp"
else
debug "$pre mount failed"
fi
[ -d "$mp" ] || rmdir "$mp"
[ $success -eq 1 ] || return 1
_RET="$dev/$cfg"
}
parse_cfg() {
# parse_cfg($file,$desc,$vars)
# this reasonably safely sources the "config" file $file
# and then declares the variables listed to stdout
#
# known issues:
# * sourced file could re-define 'echo'
# * just fails if a value has a ' in it
[ -f "$1" ] || return 0
tick="'" sh -c '
__tick=$tick
__file=$1; __desc=$2;
__unset__="__unset__"
shift 2
__vars="$*"
readonly __tick __file __desc __vars
. "${__file}"
if [ $? -ne 0 ]; then
echo "failed source \"${__file}\" ($__desc)" 1>&2
return 1
fi
set -e
echo "desc=${__tick}${__desc}${__tick}"
for var in ${__vars}; do
eval val=\${${var}-${__unset__}} ||
{ echo "eval of $var failed"; exit 1; }
[ "${val#*${__tick}}" = "${val}" ] || {
echo "variable \"$var\" had single tick in it. fail";
exit 1;
}
[ "${val}" = "${__unset__}" ] ||
echo "$var=${__tick}${val}${__tick}"
done
' -- "$@"
}
readcfgd() {
local cfg_d="$1"
# this kind of stinks, each VARIABLE goes into global scope
local or="" or_cfgdisk=""
_RET_desc_oroot=""
_RET_desc_cfgdisk=""
set +f
for f in "${cfg_d}"/*; do
. "$f" || fail "failed reading $f"
[ "$or" != "${overlayroot}" ] &&
_RET_desc_oroot="$desc"
[ "${or_cfgdisk}" != "${overlayroot_cfgdisk}" ] &&
_RET_desc_cfgdisk="$desc"
or=${overlayroot}
or_cfgdisk=${overlayroot_cfgdisk}
done
set -f
}
fix_upstart_overlayfs() {
# inotify events on an overlayfs underlay do not propogate through
# a newly created overlay. This causes job creation and deletion issues
# for upstart, which uses inotify on /etc/init. So ensure that the overlay
# explicitly has a /etc/init (LP: #1213925)
local root="$1"
local initctl="$root/sbin/initctl"
local eifile="/etc/init/.overlayfs-upstart-helper"
[ -e "$initctl" -o -L "$initctl" ] || return 0
[ -d "$root/etc/init" ] || return 0
echo "#upstart needs help for overlayfs (LP: #1213925)." \
> "$root/$eifile" ||
{ log_fail "failed to write $root/$eifile"; return 1; }
debug "created $eifile under $root (LP: #1213925)"
}
needs_workdir() {
local uname_r="${UNAME_R}"
if [ -z "$uname_r" ]; then
uname_r=$(uname -r) && UNAME_R="$uname_r" ||
{ log_warn "failed to read uname!"; return 2; }
fi
# 3.18+ require 'workdir=' option.
case "${uname_r}" in
2*|3.1[01234567]*|3.[0-9].*) return 1;;
*) return 0;;
esac
}
search_fs_driver() {
# search_fs_driver(driver1, driver2...)
# return the first supported filesystem driver in the list.
# if no drivers are provided, search default list.
# assumes that name in /proc/filesystems and module name are the same.
local m="" driver="" tab=' '
for m in "$@"; do
grep -q "${tab}$m$" /proc/filesystems && driver="$m" &&
{ debug "/proc/filesystems support for '$m'"; break; }
done
if [ -z "$driver" ]; then
for m in "$@"; do
if modprobe -qb "$m"; then
if grep -q "${tab}$m$" /proc/filesystems; then
debug "loaded module '$m'";
driver="$m"
break;
else
log_warn "loaded '$m' module but no '$m' in /proc/filesystems"
fi
fi
done
fi
[ -n "$driver" ] ||
{ debug "Unable to find driver/module. searched: $*"; return 1; }
_RET="$driver"
}
cfgd="${TEMP_D}/configs"
mkdir -p "${cfgd}" || fail "failed to create tempdir"
trap cleanup EXIT
# collect the different config locations into a file
# write individual config files in $cfgd that contain
{
echo "desc='builtin'"
echo "overlayroot=''"
echo "overlayroot_cfgdisk='disabled'"
} > "$cfgd/00-builtin"
write_kernel_cmdline_cfg "${cfgd}/90-kernel" ||
fail "failed to read kernel command line!"
parse_cfg "/conf/conf.d/overlayroot" "initramfs config" \
"$VARIABLES" > "${cfgd}/10-initramfs" ||
fail "failed parsing initramfs config"
parse_cfg "${ROOTMNT}/etc/overlayroot.conf" "$ROOT/etc/overlayroot.conf" \
"$VARIABLES" > "${cfgd}/20-root-config" ||
fail "failed parsing root config"
parse_cfg "${ROOTMNT}/etc/overlayroot.local.conf" \
"$ROOT/etc/overlayroot.local.conf" \
"$VARIABLES" > "${cfgd}/30-root-local-config" ||
fail "failed parsing root config"
# now read the trusted configs, to see if overlayroot_cfgdisk is set
readcfgd "$cfgd" ||
fail "reading configs failed"
used_desc="${_RET_desc_oroot}"
[ -n "${_RET_desc_cfgdisk}" ] &&
debug "${_RET_desc_cfgdisk} set cfgdisk='${overlayroot_cfgdisk}'"
# if one of the trusted configs above gave us set the overlayroot_cfgdisk
# variable, then look for such a device and read a config from it.
cfgdisk=0
if [ "${overlayroot_cfgdisk:-disabled}" != "disabled" ] &&
get_cfg "${overlayroot_cfgdisk}" "${TEMP_D}/cfgdisk"; then
desc=${_RET}
parse_cfg "${TEMP_D}/cfgdisk" "${desc}" "$VARIABLES" \
> "${cfgd}/80-cfgdisk" ||
fail "reading config from ${desc} failed"
used_desc="${_RET_desc_oroot}"
# now read the parsed configs again.
readcfgd "$cfgd" ||
fail "reading configs failed"
[ -n "${_RET_desc_cfgdisk}" ] &&
debug "${_RET_desc_cfgdisk} set cfgdisk=${overlayroot_cfgdisk}"
[ -n "${_RET_desc_oroot}" ] &&
debug "${_RET_desc_oroot} set overlayroot=${overlayroot}"
fi
opts=""
cfgmsg="${used_desc:+ (per ${used_desc})}"
case "${overlayroot:-disabled}" in
tmpfs|tmpfs:*)
mode="tmpfs"
opts="${overlayroot#tmpfs}";
opts=${opts#:}
;;
/dev/*|device:*)
case "$overlayroot" in
/dev/*) opts="dev=${overlayroot}";;
*) opts="${overlayroot#device:}";;
esac
dev_setup "${opts}" ||
fail "failed setup overlay for ${overlayroot} [$opts]${cfgmsg}"
mode="device"
device="$_RET_DEVICE"
;;
crypt:*)
mode="crypt"
opts=${overlayroot#crypt:}
crypto_setup "${opts}" ||
fail "failed setup crypt for ${overlayroot}${cfgmsg}"
device="$_RET_DEVICE"
;;
disabled)
debug "overlayroot disabled${cfgmsg}"
exit 0;;
*)
fail "invalid value for overlayroot: ${overlayroot}${cfgmsg}"
exit 0;;
esac
parse_string "$opts" "," _RET_common_
swap=${_RET_common_swap:-0}
recurse=${_RET_common_recurse:-1}
OVERLAYROOT_DEBUG=${_RET_common_debug:-${OVERLAYROOT_DEBUG}}
dir_prefix=${_RET_common_dir:-"/overlay"}
overlayroot_driver=${_RET_common_driver}
read cmdline </proc/cmdline
cmdline=" $cmdline "
[ "${cmdline#* ro }" != "$cmdline" ] && cmdline_ro=true || cmdline_ro=false
if [ "${overlayroot_driver:-auto}" = "auto" ]; then
search_fs_driver overlay overlayfs ||
fail "Unable to find a driver. searched: overlay overlayfs"
overlayroot_driver="$_RET"
else
search_fs_driver ${overlayroot_driver} ||
fail "Unable to find a driver named '${overlayroot_driver}'"
overlayroot_driver="$_RET"
fi
debug "swap=$swap recurse=$recurse debug=$OVERLAYROOT_DEBUG dir=$dir_prefix"
debug "device=$device mode=$mode driver=${overlayroot_driver}"
[ "$swap" = "0" -o "$swap" = "1" ] ||
fail "invalid setting for swap: $swap. must be '0' or '1'"
[ "$recurse" = "0" -o "$recurse" = "1" ] ||
fail "invalid setting for recurse: $recurse. must be '0' or '1'"
log_warn "configuring overlayroot with driver=${overlayroot_driver} mode=$mode opts='$opts' per $used_desc"
# settings based on overlayroot_driver
workdir=""
case "${overlayroot_driver}" in
overlayfs|overlay)
mount_type="${overlayroot_driver}"
mount_opts="-o lowerdir=${root_ro},upperdir=${root_rw}/${dir_prefix}"
if needs_workdir; then
get_workdir "$root_rw" "$dir_prefix" "/"
workdir="$_RET"
mount_opts="${mount_opts},workdir=$workdir"
fi
clean_path "${mount_opts} overlayroot ${ROOTMNT}"
mount_opts="$_RET"
;;
aufs)
mount_type="aufs"
mount_opts="-o dirs=${root_rw}/${dir_prefix}:${root_ro}=ro aufs-root ${ROOTMNT}"
;;
*)
log_fail "invalid overlayroot driver: ${overlayroot_driver}"
panic "$MYTAG"
;;
esac
# make the mount point on the init root fs ${root_rw}
mkdir -p "${root_rw}" ||
fail "failed to create ${root_rw}"
# make the mount point on the init root fs ${root_ro}
mkdir -p "${root_ro}" ||
fail "failed to create ${root_ro}"
# mount the backing device to $root_rw
if [ "$mode" = "tmpfs" ]; then
# mount a tmpfs using the device name tmpfs-root
mount -t tmpfs tmpfs-root "${root_rw}" ||
fail "failed to create tmpfs"
else
# dev or crypto
mount "$device" "${root_rw}" ||
fail "failed mount backing device $device"
fi
mkdir -p "${root_rw}/${dir_prefix}" ||
fail "failed to create ${dir_prefix} on ${device}"
[ -z "$workdir" ] || mkdir -p "$workdir" ||
fail "failed to create workdir '$workdir' on ${device}"
# root is mounted on ${ROOTMNT}, move it to ${ROOT_RO}.
mount --move "${ROOTMNT}" "${root_ro}" ||
fail "failed to move root away from ${ROOTMNT} to ${root_ro}"
# there is nothing left at ${ROOTMNT} now. So for any error we get we should
# either do recovery to restore ${ROOTMNT} for drop to a initramfs shell using
# "panic". Otherwise the boot process is very likely to fail with even more
# errors and leave the system in a wired state.
# mount virtual fs ${ROOTMNT} with rw-fs ${root_rw} on top or ro-fs ${root_ro}.
debug mount -t "$mount_type" $mount_opts
mount -t "$mount_type" $mount_opts
if [ $? -ne 0 ]; then
log_fail "failed to create new ro/rw layered ${ROOTMNT}"
log_fail "mount command was: mount -t $mount_type $mount_opts"
# do recovery and try restoring the mount for ${ROOTMNT}
mount --move ${root_ro} ${ROOTMNT}
if [ $? -ne 0 ]; then
# thats bad, drop to shell to let the user try fixing this
log_fail "RECOVERY_ERROR: failed to move $root_ro back to ${ROOTMNT}"
panic "$MYTAG"
fi
exit 0
fi
# now the real root fs is on ${root_ro} of the init file system, our
# layered root fs is set up at ${ROOTMNT}. So we can write anywhere in
# {ROOTMNT} and the changes will end up in ${root_rw} while ${root_ro} it
# not touched. However ${root_ro} and ${root_rw} are on the initramfs root
# fs, which will be removed an replaced by ${ROOTMNT}. Thus we must move
# ${root_ro} and ${root_rw} to the rootfs visible later, ie.
# ${ROOTMNT}${root_ro} and ${ROOTMNT}${root_ro}. Since the layered ro/rw
# is already up, these changes also end up on ${root_rw} while ${root_ro}
# is not touched.
# move mount from ${root_ro} to ${ROOTMNT}${root_ro}
mkdir -p "${ROOTMNT}/${root_ro}"
mount --move ${root_ro} "${ROOTMNT}${root_ro}" ||
fail "failed to move ${root_ro} to ${ROOTMNT}${root_ro}"
# move mount from ${root_rw} to ${ROOTMNT}${root_rw}
[ -d ${ROOTMNT}${root_rw} ] || mkdir -p ${ROOTMNT}${root_rw}
mount --move "${root_rw}" "${ROOTMNT}${root_rw}" ||
fail "failed to move ${root_rw} to ${ROOTMNT}${root_rw}"
# technically, everything is set up nicely now. Since ${ROOTMNT} had beend
# mounted read-only on the initfamfs already, ${ROOTMNT}${root_ro} is it,
# too. Now we init process could run - but unfortunately, we may have to
# prepare some more things here.
# Basically, there are two ways to deal with the read-only root fs. If the
# system is made aware of this, things can be simplified a lot. If it is
# not, things need to be done to our best knowledge.
#
# So we assume here, the system does not really know about our read-only
# root fs.
#
# Let's deal with /etc/fstab first. It usually contains an entry for the
# root fs, which is no longer valid now. We have to remove it and add our
# new ${root_ro} entry.
# Remember we are still on the initramfs root fs here, so we have to work
# on ${ROOTMNT}/etc/fstab. The original fstab is
# ${ROOTMNT}${root_ro}/etc/fstab.
source_fstab="$ROOTMNT/${root_ro}/etc/fstab"
if [ ! -f "$source_fstab" ] && [ "$cmdline_ro" = "true" ]; then
debug "rootfs did not contain /etc/fstab, creating" \
"based on kernel cmdline"
source_fstab="${TEMP_D}/fstab"
gen_fstab "${ROOTMNT}${root_ro}" > "$source_fstab" ||
log_fail "gen_fstab failed for $ROOTMNT/$root_ro"
fi
if [ -f "$source_fstab" ]; then
overlayrootify_fstab "$source_fstab" "$root_ro" \
"$root_rw" "$dir_prefix" "$recurse" "$swap" "${overlayroot_driver}" \
> "${ROOTMNT}/etc/fstab" ||
log_fail "failed to modify /etc/fstab"
else
debug "rootfs did not contain /etc/fstab."
fi
# we have to make the directories in ${root_rw} because if they do not
# exist, then the 'upper=' argument to overlayfs will fail.
for d in ${_RET}; do
mkdir -p "${ROOTMNT}/$d"
done
if [ "${overlayroot_driver}" = "overlayfs" ]; then
fix_upstart_overlayfs "$ROOTMNT" ||
log_fail "failed to fix upstart for overlayfs"
fi
# if / is supposed to be mounted read-only (cmdline with 'ro')
# then mount our overlayfs as read-only just to be more normal
if [ "${cmdline_ro}" = "true" ]; then
mount -o remount,ro "$ROOTMNT" ||
log_fail "failed to remount overlayroot read-only"
debug "mounted $ROOTMNT read-only per kernel cmdline"
fi
msg="configured root with '$overlayroot' using ${overlayroot_driver} per"
msg="$msg ${used_desc}"
log_success "$msg"
exit 0
# vi: ts=4 noexpandtab

View file

@ -0,0 +1,93 @@
#!/bin/sh
#
# overlayroot-chroot - chroot wrapper script for overlayroot
# Copyright (C) 2012 Dustin Kirkland <kirkland@ubuntu.com>
#
# Authors: Dustin Kirkland <kirkland@ubuntu.com>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, version 3 of the License.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
set -e
set -f # disable path expansion
REMOUNTS=""
error() {
printf "ERROR: $@\n" 1>&2
}
fail() { [ $# -eq 0 ] || error "$@"; exit 1; }
info() {
printf "INFO: $@\n" 1>&2
}
get_lowerdir() {
local overlay=""
overlay=$(awk \
'$1 == "overlayroot" && $2 == "/" { print $0 }' /proc/mounts)
if [ -n "${overlay}" ]; then
lowerdir=${overlay##*lowerdir=}
lowerdir=${lowerdir%%,*}
if mountpoint "${lowerdir}" >/dev/null; then
_RET="${lowerdir}"
else
fail "Unable to find the overlayroot lowerdir"
fi
else
fail "Unable to find an overlayroot filesystem"
fi
}
clean_exit() {
local mounts="$1" rc=0 d="" lowerdir="" mp=""
for d in ${mounts}; do
if mountpoint ${d} >/dev/null; then
umount ${d} || rc=1
fi
done
for mp in $REMOUNTS; do
mount -o remount,ro "${mp}" ||
error "Note that [${mp}] is still mounted read/write"
done
[ "$2" = "return" ] && return ${rc} || exit ${rc}
}
# Try to find the overlayroot filesystem
get_lowerdir
lowerdir=${_RET}
recurse_mps=$(awk '$1 ~ /^\/dev\// && $2 ~ starts { print $2 }' \
starts="^$lowerdir/" /proc/mounts)
mounts=
for d in proc run sys; do
if ! mountpoint "${lowerdir}/${d}" >/dev/null; then
mount -o bind "/${d}" "${lowerdir}/${d}" || fail "Unable to bind /${d}"
mounts="$mounts $lowerdir/$d"
trap "clean_exit \"${mounts}\" || true" EXIT HUP INT QUIT TERM
fi
done
# Remount with read/write
for mp in "$lowerdir" $recurse_mps; do
mount -o remount,rw "${mp}" &&
REMOUNTS="$mp $REMOUNTS" ||
fail "Unable to remount [$mp] writable"
done
info "Chrooting into [${lowerdir}]"
chroot ${lowerdir} "$@"
# Clean up mounts on exit
clean_exit "${mounts}" "return"
trap "" EXIT HUP INT QUIT TERM
# vi: ts=4 noexpandtab

View file

@ -0,0 +1,21 @@
.TH overlayroot-chroot 8 "20 July 2012" overlayroot-chroot "initramfs-tools-overlayroot"
.SH NAME
\fBoverlayroot-chroot\fP - chroot into the lower filesystem in a writable mode
.SH SYNOPSIS
\fBoverlayroot-chroot\fP [COMMAND [ARG]...]
.SH DESCRIPTION
\fBoverlayroot-chroot\fP is a program that sets up bind mounts for \fI/proc\fP, \fI/run\fP, and \fI/sys\fP, remounts the lower directory in an overlayfs with write capabilities and will \fBchroot\fP(8) into it. Upon exit, the bind mounts are unmounted.
Any [COMMAND [ARG]...] are passed directly through to \fBchroot\fP(8).
.SH SEE ALSO
.TP
\fBchroot\fP(8)
.PD
.SH AUTHOR
This manpage and the utility were written by Dustin Kirkland <kirkland@ubuntu.com> for Ubuntu systems (but may be used by others). Permission is granted to copy, distribute and/or modify this document and the utility under the terms of the GNU General Public License, Version 3 published by the Free Software Foundation.
The complete text of the GNU General Public License can be found in \fI/usr/share/common-licenses/GPL\fP on Debian/Ubuntu systems, or on the web at \fIhttp://www.gnu.org/licenses/gpl.txt\fP.