Phase 0: skeleton, streaming encryption (spike A)
Repository skeleton (app id ng_backup, AGPL-3.0-or-later), KeyRing with KDF subkeys, keyed blob ids and Argon2id key wrapping, and StreamCipher (secretstream XChaCha20-Poly1305, framed, bounded memory). Spike A: 1 GiB round trip with memory_limit=64M, peak < 2 MiB, ~160/122 MiB/s; tampering, truncation, wrong key/passphrase are rejected.
This commit is contained in:
@@ -0,0 +1,5 @@
|
||||
/vendor/
|
||||
/node_modules/
|
||||
/js/
|
||||
/build/
|
||||
/spikes/out/
|
||||
@@ -0,0 +1,661 @@
|
||||
GNU AFFERO GENERAL PUBLIC LICENSE
|
||||
Version 3, 19 November 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU Affero General Public License is a free, copyleft license for
|
||||
software and other kinds of works, specifically designed to ensure
|
||||
cooperation with the community in the case of network server software.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
our General Public Licenses are 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.
|
||||
|
||||
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.
|
||||
|
||||
Developers that use our General Public Licenses protect your rights
|
||||
with two steps: (1) assert copyright on the software, and (2) offer
|
||||
you this License which gives you legal permission to copy, distribute
|
||||
and/or modify the software.
|
||||
|
||||
A secondary benefit of defending all users' freedom is that
|
||||
improvements made in alternate versions of the program, if they
|
||||
receive widespread use, become available for other developers to
|
||||
incorporate. Many developers of free software are heartened and
|
||||
encouraged by the resulting cooperation. However, in the case of
|
||||
software used on network servers, this result may fail to come about.
|
||||
The GNU General Public License permits making a modified version and
|
||||
letting the public access it on a server without ever releasing its
|
||||
source code to the public.
|
||||
|
||||
The GNU Affero General Public License is designed specifically to
|
||||
ensure that, in such cases, the modified source code becomes available
|
||||
to the community. It requires the operator of a network server to
|
||||
provide the source code of the modified version running there to the
|
||||
users of that server. Therefore, public use of a modified version, on
|
||||
a publicly accessible server, gives the public access to the source
|
||||
code of the modified version.
|
||||
|
||||
An older license, called the Affero General Public License and
|
||||
published by Affero, was designed to accomplish similar goals. This is
|
||||
a different license, not a version of the Affero GPL, but Affero has
|
||||
released a new version of the Affero GPL which permits relicensing under
|
||||
this license.
|
||||
|
||||
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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, if you modify the
|
||||
Program, your modified version must prominently offer all users
|
||||
interacting with it remotely through a computer network (if your version
|
||||
supports such interaction) an opportunity to receive the Corresponding
|
||||
Source of your version by providing access to the Corresponding Source
|
||||
from a network server at no charge, through some standard or customary
|
||||
means of facilitating copying of software. This Corresponding Source
|
||||
shall include the Corresponding Source for any work covered by version 3
|
||||
of the GNU General Public License that is incorporated pursuant to the
|
||||
following paragraph.
|
||||
|
||||
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 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 work with which it is combined will remain governed by version
|
||||
3 of the GNU General Public License.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If your software can interact with users remotely through a computer
|
||||
network, you should also make sure that it provides a way for users to
|
||||
get its source. For example, if your program is a web application, its
|
||||
interface could display a "Source" link that leads users to an archive
|
||||
of the code. There are many ways you could offer source, and different
|
||||
solutions will be better for different programs; see section 13 for the
|
||||
specific requirements.
|
||||
|
||||
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 AGPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
@@ -0,0 +1,319 @@
|
||||
# ng_backup — plan
|
||||
|
||||
Een webgebaseerde, versleutelde backup- en restore-app voor Nextcloud 32–35, bedoeld voor MKB
|
||||
zonder eigen IT-afdeling en voor gehoste Nextcloud zonder SSH. occ-commando's onder `backup:`.
|
||||
|
||||
Opgesteld 2026-10-01, na de evaluatie van nextcloud/backup op NC34 (zie onderaan).
|
||||
|
||||
## 1. Uitgangspunten
|
||||
|
||||
1. **Werkt zonder shell.** Geen `pg_dump`, `mysqldump`, rclone, rsync, tar of extra PHP-extensies.
|
||||
Alleen wat Nextcloud zelf meelevert (files_external-opslagklassen, AWS-SDK, phpseclib, sabre,
|
||||
Doctrine/DBAL, sodium).
|
||||
2. **Werkt op elke variant:** AIO, losse installatie (Docker, bare metal, snap) én gehoste
|
||||
Nextcloud zonder SSH. Juist gehoste gebruikers hebben er het meeste aan; alles wat alleen met
|
||||
shell kan, is hooguit een optionele versnelling.
|
||||
3. **Backuplocaties zijn tussentijds niet gekoppeld.** Geen mount in Files, geen open verbinding
|
||||
buiten een run; de locatie is voor gebruikers onzichtbaar.
|
||||
4. **Restore is een hoofdfunctie, geen bijzaak.** Alles wat via occ kan, kan ook via de webinterface.
|
||||
5. **Nooit een instantie achterlaten in onderhoudsmodus.** Backups draaien zonder onderhoudsmodus;
|
||||
waar die toch nodig is (volledige restore), altijd met gegarandeerd herstel.
|
||||
6. **Hervatbaar.** Gehoste omgevingen hebben korte PHP-tijdslimieten en 512 MB geheugen: elk werk
|
||||
gebeurt in kleine, hervatbare stappen met checkpoints. Geheugengebruik onafhankelijk van datagrootte.
|
||||
7. **Streamend van bron naar doel, zonder lokale tussenkopie.** Lezen → opdelen → comprimeren →
|
||||
versleutelen → uploaden gebeurt als één doorlopende stroom; restore andersom (downloaden →
|
||||
ontsleutelen → uitpakken → wegschrijven). Er is nooit een lokaal backupbestand of een tweede
|
||||
kopie van de data nodig; de lokale schijf hoeft hooguit ruimte te hebben voor één pack in
|
||||
aanbouw (~32 MB, instelbaar), en ook dat bij voorkeur in het geheugen.
|
||||
8. **Alleen wat nodig is.** Data, database en config, geen Nextcloud-code en geen apps uit de store
|
||||
(die zijn opnieuw te installeren; de lijst met apps en versies gaat wel mee).
|
||||
9. **Aantoonbaar betrouwbaar.** Elke release draait in CI een volledige backup→restore-rondgang op
|
||||
NC32–35 × SQLite/MySQL/PostgreSQL.
|
||||
|
||||
## 2. Wat de app doet (functioneel)
|
||||
|
||||
| Functie | Fase |
|
||||
|---|---|
|
||||
| Geplande backups (dagelijks/wekelijks, tijdvenster) en handmatig starten | 1 |
|
||||
| Versleuteling, altijd aan, met herstelsleutel om te downloaden | 1 |
|
||||
| Opslag via files_external (S3, SFTP, WebDAV, lokaal pad), aangestuurd door ng_backup, zonder koppeling of share | 1 |
|
||||
| FTP(S), SMB, Swift; NFS/rclone via gateway (zie 3.5) | 2 |
|
||||
| Append-only-modus en advies voor object lock (bescherming tegen ransomware) | 1 |
|
||||
| Restore van één bestand of map, per gebruiker, naar elk herstelpunt | 1 |
|
||||
| Backup en restore per gebruiker via user_migration (bestanden, agenda, contacten, Deck, Mail-instellingen, profiel, prullenbak, ...) | 2 |
|
||||
| Volledige restore (disaster recovery) op een verse installatie | 2 |
|
||||
| Volledige restore in-place op de bestaande instantie | 3 (onderzoeken) |
|
||||
| Bewaarbeleid (bijv. 7 dagelijks, 4 wekelijks, 6 maandelijks) | 1 |
|
||||
| Verificatie: periodiek checksums controleren, steekproef-restore | 2 |
|
||||
| Meldingen bij mislukken of te oude backup (Nextcloud-notificatie + e-mail), setup-check in Beheer | 1 |
|
||||
| Differentiële/incrementele backups met deduplicatie | 1 (zit in het formaat) |
|
||||
|
||||
## 3. Architectuur
|
||||
|
||||
### 3.1 Backupformaat
|
||||
|
||||
Content-addressed opslag, vergelijkbaar met restic/borg, zodat incrementeel en deduplicatie vanzelf gaan:
|
||||
|
||||
- **Blobs:** bestandsinhoud in stukken van max. 4–8 MB, geïdentificeerd met een hash (BLAKE2b via sodium)
|
||||
van de *onversleutelde* inhoud met een geheime sleutel (keyed hash, zodat de hash niets verraadt).
|
||||
Een blob die al op de opslag staat, wordt niet opnieuw geüpload.
|
||||
- **Packs:** blobs worden gebundeld tot packbestanden van ~32 MB (minder kleine objecten op S3/SFTP).
|
||||
- **Snapshot-manifest:** per herstelpunt een versleuteld manifest: tijdstip, NC-versie, app-lijst met
|
||||
versies, databasetype, en per gebruiker/map de boom met bestanden → blobs, plus de database-dump.
|
||||
- **Index:** welke blob in welk pack zit, zodat restore van één bestand alleen de nodige packs ophaalt.
|
||||
|
||||
**Datastroom zonder tussenopslag:**
|
||||
|
||||
- *Backup:* bestand lezen als stream → blobs van 4–8 MB → elke blob gecomprimeerd (zstd als
|
||||
beschikbaar, anders gzip via zlib) en versleuteld in het geheugen → toegevoegd aan het pack in
|
||||
aanbouw. Een vol pack (~32 MB) wordt direct geüpload (bij S3 als multipart-onderdeel, bij
|
||||
SFTP/WebDAV als stream) en daarna uit het geheugen verwijderd. Piekgebruik: één blob + één pack,
|
||||
ongeacht de grootte van de backup.
|
||||
- *Database:* de dump gaat tabel voor tabel als stream door dezelfde pijplijn; er komt nooit een
|
||||
dumpbestand op schijf.
|
||||
- *Restore:* alleen de benodigde packs worden opgehaald, per blob ontsleuteld en gecontroleerd
|
||||
(AEAD) en direct naar het doelbestand geschreven. Een groot bestand terugzetten kost dus geen
|
||||
dubbele ruimte; een half teruggezet bestand wordt eerst als tijdelijk bestand naast het doel
|
||||
geschreven en pas na volledige controle op zijn plek gezet (alleen dát ene bestand dubbel).
|
||||
- *Volledige restore van de database:* rijen worden in batches uit de stroom geïmporteerd.
|
||||
- Als het geheugen te krap is voor een pack in aanbouw, kan dat naar een tijdelijk bestand
|
||||
(instelbaar), maar nooit meer dan één pack tegelijk.
|
||||
|
||||
Waarom niet zip/tar per backup: daarmee is één bestand of één gebruiker terugzetten traag (alles
|
||||
uitpakken) en kost elke backup weer de volle ruimte. Dat was precies het probleem bij nextcloud/backup.
|
||||
|
||||
### 3.2 Versleuteling
|
||||
|
||||
- libsodium **secretstream (XChaCha20-Poly1305)**: streamend, dus het geheugen blijft klein, ongeacht de grootte.
|
||||
- Een willekeurige **hoofdsleutel** per backup-repository; die wordt versleuteld opgeslagen met een
|
||||
sleutel afgeleid van een **wachtwoordzin** (Argon2id, `sodium_crypto_pwhash`).
|
||||
- **Herstelkit** (wachtwoordzin-hint, versleutelde hoofdsleutel, repository-ID; als tekst/PDF + QR,
|
||||
te downloaden bij inrichten). Zonder die kit is een backup na verlies van de server onbruikbaar.
|
||||
- **Verplichte bevestiging door de beheerder** voordat de eerste backup draait (en opnieuw bij een
|
||||
nieuwe sleutel):
|
||||
1. de kit downloaden (de knop verder blijft uit tot de download is gestart);
|
||||
2. een vinkje: *"Ik heb de herstelkit gedownload en veilig opgeslagen, buiten deze server. Ik
|
||||
begrijp dat het zorgvuldig bewaren van deze sleutels mijn eigen verantwoordelijkheid is en dat
|
||||
backups zonder deze sleutels niet te herstellen zijn."*;
|
||||
3. pas dan wordt de knop *"Yes, I confirm"* actief; klikken bevestigt en start de inrichting.
|
||||
Wie, wanneer en welke sleutelversie bevestigd is, wordt vastgelegd (audit log + instellingenpagina).
|
||||
- De herstelkit kan op verzoek ook versleuteld naar het e-mailadres van de beheerder worden
|
||||
gestuurd, als extra kopie; dit vervangt de bevestiging niet.
|
||||
- De sleutel staat **niet onversleuteld in de database**; de database gaat zelf ook mee in de backup.
|
||||
- Integriteit: elk object is geauthenticeerd (AEAD); manifesten verwijzen met hashes naar hun inhoud.
|
||||
|
||||
### 3.3 Database-dump zonder externe tools
|
||||
|
||||
- **Schema:** via Nextcloud's eigen `SchemaEncoder`/Doctrine-schema-export (zoals `occ db:export-schema`).
|
||||
- **Data:** per tabel in batches (bijv. 5.000 rijen, gesorteerd op primaire sleutel) via `IDBConnection`,
|
||||
weggeschreven als regels JSON met type-informatie, gestreamd door de versleuteling heen. Dit is
|
||||
hetzelfde principe als `occ db:convert-type`, dat ook rijen tussen databases kopieert.
|
||||
- **Consistentie:** de dump draait binnen één transactie met `REPEATABLE READ` (PostgreSQL/MySQL),
|
||||
zodat de snapshot consistent is zonder onderhoudsmodus. Voor SQLite: een kopie van het bestand.
|
||||
- **Restore:** werkt ook naar een ander databasetype (bijv. van MySQL naar PostgreSQL bij verhuizen).
|
||||
- Grote tabellen die opnieuw op te bouwen zijn (bijv. `filecache` van externe opslag, previews,
|
||||
zoekindexen) zijn instelbaar uit te sluiten.
|
||||
|
||||
### 3.4 Bestanden
|
||||
|
||||
- Gelezen via de Nextcloud Files-API / opslaglaag (zodat ook object storage als primaire opslag
|
||||
werkt), niet rechtstreeks uit de datamap.
|
||||
- Bron van wijzigingen: `filecache` (mtime, etag, size), zodat een incrementele run niet alle
|
||||
bestanden opnieuw hoeft te lezen.
|
||||
- Externe opslag gaat standaard **niet** mee (instelbaar per koppeling).
|
||||
- Server-side encryptie van Nextcloud: bestanden worden ontsleuteld gelezen en in de backup
|
||||
opnieuw versleuteld; documenteren dat de master key dan ook in de herstelkit moet.
|
||||
|
||||
### 3.5 Opslagdoelen
|
||||
|
||||
**files_external is een vereiste; ng_backup stuurt het aan, zonder koppeling.** De meegeleverde
|
||||
app files_external heeft alle verbindingscode al: backends voor S3, SFTP, FTP, SMB, Swift en
|
||||
WebDAV, met hun inlogmethoden (wachtwoord, SFTP-sleutel, enz.) en de beschrijving van hun
|
||||
instellingenvelden. ng_backup bouwt daar niets van na, maar gebruikt files_external zoals het zichzelf
|
||||
gebruikt (in NC34 nagekeken):
|
||||
|
||||
1. `BackendService::getAvailableBackends()` levert de beschikbare backends en hun parameters; het
|
||||
instellingenformulier van ng_backup wordt daaruit **automatisch opgebouwd** (zelfde velden en
|
||||
validatie als in files_external, ook voor backends die later bijkomen).
|
||||
2. Bij een run maakt ng_backup een **niet-opgeslagen** `StorageConfig`, laat backend en
|
||||
inlogmethode hun `manipulateStorageConfig()` doen, en maakt de opslag aan met
|
||||
`new $storageClass($options)`, precies zoals `ConfigAdapter::constructStorage()` dat doet.
|
||||
3. Na de run wordt het object vrijgegeven; er blijft geen verbinding open.
|
||||
|
||||
**Waarom geen (verborgen) koppeling in files_external:** een globale koppeling zonder toegewezen
|
||||
gebruikers of groepen geldt in files_external juist voor **alle** gebruikers. Een verborgen
|
||||
koppeling zou een aparte groep of systeemgebruiker vereisen; één verkeerde groepswijziging en
|
||||
de backups zijn zichtbaar en wijzigbaar in Files. Met de werkwijze hierboven bestaat de
|
||||
backuplocatie nergens als koppeling of share:
|
||||
|
||||
- niet zichtbaar in Files, niet gescand, niet deelbaar, ook niet voor beheerders;
|
||||
- geen verbinding buiten een run ("tussentijds niet gemount");
|
||||
- instellingen en inloggegevens in de eigen tabellen van ng_backup, versleuteld met `ICrypto`.
|
||||
|
||||
**Installatie en instellingen van files_external:**
|
||||
- ng_backup vereist files_external (meegeleverde app, op AIO, losse installaties en de meeste
|
||||
hosters aanwezig). Staat het uit, dan biedt de instellingenpagina aan het in te schakelen
|
||||
(`IAppManager::enableApp`, alleen door een beheerder, met uitleg).
|
||||
- Gebruikers hoeven files_external niet te zien: "gebruikers mogen externe opslag koppelen" kan
|
||||
uit blijven en er hoeven geen koppelingen te bestaan. ng_backup controleert dat en waarschuwt
|
||||
als gebruikers zelf externe opslag mogen koppelen (geen vereiste, wel een tip).
|
||||
- Dunne eigen adapter (`IBackend`: put/get/list/delete/stat met streams) bovenop de opslagobjecten
|
||||
van files_external, omdat dit interne klassen zijn: wijzigingen tussen NC-versies op één plek
|
||||
opvangen, met CI op elke versie. Een eigen implementatie alleen waar files_external tekortschiet
|
||||
(bijv. S3 multipart met object lock).
|
||||
|
||||
| Doel | Via | Opmerking |
|
||||
|---|---|---|
|
||||
| S3 en compatibel (incl. MinIO, Wasabi, Hetzner Object Storage) | files_external `AmazonS3` of eigen adapter op `aws/aws-sdk-php` (core) | voorkeursdoel, object lock mogelijk |
|
||||
| SFTP | files_external `SFTP` (phpseclib) | sleutel of wachtwoord |
|
||||
| FTP(S) | files_external `FTP` | |
|
||||
| SMB/CIFS | files_external `SMB` (icewind/smb) | vereist libsmbclient of `smbclient` op de server; op hosted vaak niet beschikbaar → melden bij instellen |
|
||||
| WebDAV (ook een andere Nextcloud) | core DAV-opslag | |
|
||||
| Swift | files_external `Swift` | |
|
||||
| NFS | alleen als lokaal pad | NFS kan PHP niet zelf aanspreken; vereist een koppeling op OS-niveau, wat botst met "tussentijds niet gemount". Advies: NFS-doel via een SFTP/S3-gateway, of een systemd-automount die de beheerder buiten de app regelt. Op hosted niet mogelijk. |
|
||||
| rclone | niet rechtstreeks | rclone is een los programma (shell nodig). Alternatief: `rclone serve sftp/webdav/s3` op de doelmachine en ng_backup daarheen laten schrijven; daarmee komen alle rclone-doelen beschikbaar zonder binary op de Nextcloud-server. |
|
||||
|
||||
**Bescherming van de backups zelf (ransomware, gehackte server):** de Nextcloud-server heeft
|
||||
noodzakelijk schrijfrechten op het doel; wie de server overneemt, kan dus ook backups wissen.
|
||||
Daarom:
|
||||
- aanbevolen inrichting per doel documenteren: S3 met **versioning + object lock** en een sleutel
|
||||
zonder delete-recht; SFTP met een chroot-gebruiker zonder shell; bij voorkeur een doel dat niet
|
||||
op hetzelfde netwerk staat;
|
||||
- **append-only-modus** als optie: ng_backup verwijdert dan zelf niets; opruimen (bewaarbeleid)
|
||||
gebeurt via een levenscyclusregel op het doel of via een aparte, handmatig gestarte run met
|
||||
andere inloggegevens;
|
||||
- meerdere doelen tegelijk (3-2-1), elk met eigen inloggegevens.
|
||||
|
||||
### 3.6 Uitvoering: hervatbare jobs
|
||||
|
||||
- Eén `TimedJob` start een run binnen het ingestelde tijdvenster; het werk zelf is een
|
||||
**toestandsmachine** (dump DB → verzamel bestanden → upload → manifest → opruimen) waarvan elke stap
|
||||
in delen van ~20–30 seconden draait en zijn voortgang opslaat (eigen tabel `ng_backup_runs`).
|
||||
- Werkt met system cron, webcron én AJAX-cron (dan trager, wel betrouwbaar). Bij system cron kan
|
||||
`occ backup:run` ook in één keer doorlopen.
|
||||
- **Lock** per repository (`ILockingProvider` + heartbeat), zodat twee runs nooit tegelijk schrijven;
|
||||
een verlopen lock (crash) wordt na een time-out netjes vrijgegeven.
|
||||
- Een afgebroken run wordt de volgende keer **hervat**, niet opnieuw begonnen.
|
||||
|
||||
### 3.7 Onderhoudsmodus en volledige restore
|
||||
|
||||
- **Backup:** nooit onderhoudsmodus (consistentie via DB-transactie, zie 3.3).
|
||||
- **Volledige restore, fase 2 (disaster recovery):** op een **verse** Nextcloud met dezelfde
|
||||
hoofdversie: ng_backup installeren → herstelkit invoeren → opslagdoel koppelen → herstelpunt
|
||||
kiezen → restore. Database wordt vervangen, bestanden teruggezet, de app-lijst wordt getoond om
|
||||
apps opnieuw te installeren. Hier is onderhoudsmodus niet nodig omdat er nog niets in gebruik is.
|
||||
- **Volledige restore in-place, fase 3:** lastig, omdat de app dan de database vervangt waarop hij
|
||||
zelf draait en de webinterface in onderhoudsmodus niet bereikbaar is. Te onderzoeken: een eigen
|
||||
"restore-modus" (middleware die alleen de beheerder en de restore-endpoints doorlaat) in plaats
|
||||
van onderhoudsmodus. Altijd met `try/finally` en een watchdog die de modus na een time-out opheft.
|
||||
|
||||
### 3.8 Backup en restore per gebruiker: via user_migration
|
||||
|
||||
In plaats van zelf te bepalen welke gegevens van een gebruiker meegaan, hergebruiken we
|
||||
**user_migration** (officiële Nextcloud-app, actief onderhouden, NC29–36; draait ook op onze eigen productie-instantie).
|
||||
Die app werkt met *migrators* die andere apps zelf aanleveren. Op onze productie-instantie zijn dat er al:
|
||||
calendar, dav (agenda's en contactpersonen), deck, files_trashbin, mail, settings (profiel,
|
||||
account, app-instellingen) en de bestanden zelf. Elke app die later een migrator toevoegt, gaat
|
||||
automatisch mee.
|
||||
|
||||
**Koppeling:** user_migration schrijft normaal een zip naar de map van de gebruiker, via de
|
||||
publieke interface `OCP\UserMigration\IExportDestination`. ng_backup levert een **eigen
|
||||
`IExportDestination`** die alles direct in de versleutelde, ontdubbelde backupstroom zet (geen
|
||||
zip, geen kopie in de map van de gebruiker, geen dubbele ruimte), en een **eigen `IImportSource`**
|
||||
die bij restore uit een herstelpunt leest. Het aansturen gaat via `UserMigrationService::export()`
|
||||
/ `import()` van user_migration.
|
||||
|
||||
- `copyFolder()` krijgt een `Folder` mee: daar gebruiken we etag/mtime uit de filecache, zodat
|
||||
ongewijzigde bestanden niet opnieuw gelezen of gehasht worden (incrementeel blijft goedkoop).
|
||||
- Dezelfde migrators zorgen dat een gebruiker ook naar **een andere Nextcloud** kan worden
|
||||
teruggezet (verhuizen), omdat het formaat app-onafhankelijk is.
|
||||
- Een gebruikersbackup en de volledige backup delen dezelfde blobs; dubbel opslaan kost niets.
|
||||
|
||||
**Afhankelijkheid en risico's (uitzoeken in fase 0):**
|
||||
- `UserMigrationService` is een interne klasse van user_migration (geen publieke API); net als bij
|
||||
files_external via een eigen adapter, met CI op elke NC-versie. Zonder user_migration valt alleen
|
||||
de gebruikersbackup weg; de volledige backup werkt dan nog.
|
||||
- **Restore over een bestaande gebruiker:** user_migration is gemaakt voor importeren in een
|
||||
(nieuw) account. Nagaan per migrator wat er gebeurt als de gegevens al bestaan (dubbele
|
||||
agenda's of mappen?). Mogelijke aanpak: terugzetten naar een tijdelijke gebruiker en daarna
|
||||
gericht overzetten, of de gebruiker eerst leegmaken (met bevestiging en een extra backup vooraf).
|
||||
- Een terugzetting per bestand of map blijft via de eigen bestandsboom gaan (sneller, geen migrators nodig).
|
||||
|
||||
Niet alle apps hebben een migrator (bijv. Talk-gesprekken); in de restore-wizard tonen welke
|
||||
onderdelen wel en niet terugkomen, op basis van de geregistreerde migrators.
|
||||
|
||||
## 4. Webinterface
|
||||
|
||||
- **Beheer → Backup:** status (laatste geslaagde backup, volgende run, opslaggebruik), opslagdoelen,
|
||||
schema, bewaarbeleid, uitsluitingen, sleutelbeheer (herstelkit opnieuw downloaden na wachtwoordcontrole).
|
||||
- **Herstelpunten:** lijst met datum, grootte, status van verificatie; per herstelpunt bladeren door
|
||||
gebruikers en mappen, bestanden of mappen terugzetten (naar de oorspronkelijke plek of naar een
|
||||
map "Teruggezet <datum>").
|
||||
- **Restore-wizard** voor één gebruiker en (fase 2) voor een volledige restore op een verse installatie.
|
||||
- **Voortgang** van lopende runs, met logboek; bij fouten een duidelijke melding en wat te doen.
|
||||
- **Gebruikers zelf** (optioneel, fase 3): eigen bestanden terugzetten vanuit de Files-app, zoals bij versies.
|
||||
|
||||
## 5. occ-commando's (`backup:`)
|
||||
|
||||
| Commando | Doel |
|
||||
|---|---|
|
||||
| `backup:status` | laatste runs, status per opslagdoel |
|
||||
| `backup:run [--target=] [--full]` | backup nu draaien (doorlopend, voor system cron/handmatig) |
|
||||
| `backup:list [--target=]` | herstelpunten |
|
||||
| `backup:verify <snapshot> [--deep]` | checksums controleren, optioneel alles ontsleutelen |
|
||||
| `backup:restore:file <snapshot> <user> <pad> [--to=]` | bestand/map terugzetten |
|
||||
| `backup:restore:user <snapshot> <user> [--to-user=]` | gebruiker terugzetten via user_migration (fase 2) |
|
||||
| `backup:restore:full <snapshot>` | volledige restore (fase 2, verse installatie) |
|
||||
| `backup:target:add/list/remove/test` | opslagdoelen beheren en testen |
|
||||
| `backup:key:export / import` | herstelkit |
|
||||
| `backup:prune [--dry-run]` | bewaarbeleid toepassen |
|
||||
|
||||
**Let op:** nextcloud/backup gebruikt ook het voorvoegsel `backup:` (o.a. `backup:point:*`).
|
||||
Als beide apps tegelijk aan staan, botsen commando's met dezelfde naam. Onze namen overlappen
|
||||
niet met de hunne, maar bij installatie waarschuwen als `backup` ook actief is.
|
||||
|
||||
## 6. Kwaliteit en tests
|
||||
|
||||
- PHPUnit-unittests voor formaat, versleuteling, chunking, toestandsmachine, bewaarbeleid.
|
||||
- Integratietests met echte databases: dump→restore→vergelijk (rij-voor-rij) op SQLite, MySQL/MariaDB, PostgreSQL.
|
||||
- **End-to-end in CI:** NC32–35 opzetten, testdata (gebruikers, bestanden, agenda, contacten),
|
||||
backup naar MinIO (S3) en SFTP-container, data beschadigen, restore, alles vergelijken.
|
||||
- Foutinjectie: crash halverwege een run/restore → instantie nooit in onderhoudsmodus, run hervat.
|
||||
- Geheugen- en schijftest: backup én restore van 20 GB data binnen `memory_limit=256M` op een
|
||||
machine met minder dan 1 GB vrije tijdelijke ruimte (tmpfs met limiet); meten dat er nooit meer
|
||||
dan één pack lokaal staat.
|
||||
- Psalm (niveau streng) tegen `nextcloud/ocp` van elke ondersteunde versie; geen private `OC\`-klassen.
|
||||
- Code review per PR, zoals bij occweb.
|
||||
|
||||
## 7. Fasering en inschatting
|
||||
|
||||
| Fase | Inhoud | Indicatie |
|
||||
|---|---|---|
|
||||
| 0 | Onderzoek/prototype: formaat, secretstream, DB-dump via DBAL, S3/SFTP via files_external-klassen, eigen IExportDestination voor user_migration; meten op hosted-achtige limieten | 1–2 weken |
|
||||
| 1 (MVP) | Geplande, versleutelde, incrementele backups naar lokaal/S3/SFTP/WebDAV; restore van bestanden/mappen via web en occ; bewaarbeleid; meldingen; CI-rondgang | 4–6 weken |
|
||||
| 2 | Backup/restore per gebruiker via user_migration, volledige restore op verse installatie, FTP/SMB, verificatie | 3–4 weken |
|
||||
| 3 | In-place volledige restore (restore-modus), zelfbediening voor gebruikers, extra doelen | open |
|
||||
|
||||
Release in de app store pas na fase 1 en een periode van eigen gebruik op onze productie-instantie (net als occweb):
|
||||
een backup-app die niet betrouwbaar is, is erger dan geen backup-app.
|
||||
|
||||
## 8. Besluiten (2026-10-01)
|
||||
|
||||
1. **Doelgroep:** alle varianten: AIO, losse installaties én gehoste Nextcloud zonder SSH.
|
||||
2. **Licentie:** AGPL-3.0-or-later.
|
||||
3. **Repository:** eigen Gitea + GitHub (dillardblom), zoals occweb.
|
||||
4. **Naam:** "NG Backup", app-id `ng_backup`, occ-voorvoegsel `backup:`.
|
||||
5. **Herstelkit:** verplicht downloaden + expliciete bevestiging door de beheerder (vinkje +
|
||||
"Yes, I confirm"), zie 3.2; versleuteld per e-mail als optionele extra kopie.
|
||||
6. **Opslag:** files_external is een vereiste en wordt door ng_backup aangestuurd zonder koppeling
|
||||
of (verborgen) share, zie 3.5.
|
||||
|
||||
## Bijlage: lessen uit nextcloud/backup (test NC34, 2026-10-01)
|
||||
|
||||
- Externe programma's (`pg_dump`) en extensies (`pgsql`, `mysqli`) → onbruikbaar op standaard/hosted.
|
||||
- Crash tijdens backup/restore laat de instantie in onderhoudsmodus; occ-commando's van de app
|
||||
zijn dan niet beschikbaar.
|
||||
- Hele chunks in het geheugen (`ZipArchive::getFromName()` als bestaan-check) → OOM bij restore.
|
||||
- Bij een fout eindeloos "opnieuw proberen?" zonder invoer → hangende restore.
|
||||
- Backupt de hele webroot + apps → groot en traag; restore alleen via occ in meerdere stappen.
|
||||
- Herbruikbaar als idee: checksums + metadata per herstelpunt, AES-GCM/sodium, differentiële backups.
|
||||
@@ -0,0 +1,8 @@
|
||||
# NG Backup
|
||||
|
||||
Encrypted, incremental backups of Nextcloud with restore from the web interface.
|
||||
Works without shell access: no external programs, no extra PHP extensions beyond sodium.
|
||||
|
||||
**Status: phase 0 (prototype). Not usable yet.** See `PLAN.md` for the design.
|
||||
|
||||
License: AGPL-3.0-or-later.
|
||||
@@ -0,0 +1,19 @@
|
||||
<?xml version="1.0"?>
|
||||
<info xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:noNamespaceSchemaLocation="https://apps.nextcloud.com/schema/apps/info.xsd">
|
||||
<id>ng_backup</id>
|
||||
<name>NG Backup</name>
|
||||
<summary>Encrypted, incremental backups of your Nextcloud with restore from the web interface</summary>
|
||||
<description><![CDATA[Work in progress, not ready for use.]]></description>
|
||||
<version>0.0.1</version>
|
||||
<licence>agpl</licence>
|
||||
<author>Dillard Blom</author>
|
||||
<namespace>NgBackup</namespace>
|
||||
<category>tools</category>
|
||||
<bugs>https://github.com/dillardblom/ng_backup/issues</bugs>
|
||||
<dependencies>
|
||||
<php min-version="8.1"/>
|
||||
<lib>sodium</lib>
|
||||
<nextcloud min-version="32" max-version="35"/>
|
||||
</dependencies>
|
||||
</info>
|
||||
@@ -0,0 +1,27 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
// SPDX-FileCopyrightText: 2026 Dillard Blom
|
||||
// SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
namespace OCA\NgBackup\AppInfo;
|
||||
|
||||
use OCP\AppFramework\App;
|
||||
use OCP\AppFramework\Bootstrap\IBootContext;
|
||||
use OCP\AppFramework\Bootstrap\IBootstrap;
|
||||
use OCP\AppFramework\Bootstrap\IRegistrationContext;
|
||||
|
||||
class Application extends App implements IBootstrap {
|
||||
public const APP_ID = 'ng_backup';
|
||||
|
||||
public function __construct() {
|
||||
parent::__construct(self::APP_ID);
|
||||
}
|
||||
|
||||
public function register(IRegistrationContext $context): void {
|
||||
}
|
||||
|
||||
public function boot(IBootContext $context): void {
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
// SPDX-FileCopyrightText: 2026 Dillard Blom
|
||||
// SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
namespace OCA\NgBackup\Crypto;
|
||||
|
||||
class CryptoException extends \RuntimeException {
|
||||
}
|
||||
@@ -0,0 +1,92 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
// SPDX-FileCopyrightText: 2026 Dillard Blom
|
||||
// SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
namespace OCA\NgBackup\Crypto;
|
||||
|
||||
/**
|
||||
* Holds the repository master key and derives the subkeys used for encryption and for the
|
||||
* keyed blob hashes. The master key never leaves this object unencrypted, except through
|
||||
* wrap(), which seals it with a key derived from the admin's passphrase.
|
||||
*/
|
||||
final class KeyRing {
|
||||
private const KDF_CONTEXT = 'ngbackup';
|
||||
private const SUBKEY_DATA = 1;
|
||||
private const SUBKEY_HASH = 2;
|
||||
|
||||
private string $dataKey;
|
||||
private string $hashKey;
|
||||
|
||||
public function __construct(
|
||||
#[\SensitiveParameter]
|
||||
private string $masterKey,
|
||||
) {
|
||||
if (strlen($masterKey) !== SODIUM_CRYPTO_KDF_KEYBYTES) {
|
||||
throw new \InvalidArgumentException('Master key must be ' . SODIUM_CRYPTO_KDF_KEYBYTES . ' bytes');
|
||||
}
|
||||
$this->dataKey = sodium_crypto_kdf_derive_from_key(
|
||||
SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_KEYBYTES, self::SUBKEY_DATA, self::KDF_CONTEXT, $masterKey);
|
||||
$this->hashKey = sodium_crypto_kdf_derive_from_key(
|
||||
SODIUM_CRYPTO_GENERICHASH_KEYBYTES, self::SUBKEY_HASH, self::KDF_CONTEXT, $masterKey);
|
||||
}
|
||||
|
||||
public static function generate(): self {
|
||||
return new self(sodium_crypto_kdf_keygen());
|
||||
}
|
||||
|
||||
public function dataKey(): string {
|
||||
return $this->dataKey;
|
||||
}
|
||||
|
||||
/** Keyed BLAKE2b of plaintext, so blob ids reveal nothing about the content. */
|
||||
public function blobId(string $plaintext): string {
|
||||
return sodium_bin2hex(sodium_crypto_generichash($plaintext, $this->hashKey, 32));
|
||||
}
|
||||
|
||||
/**
|
||||
* Seal the master key with a passphrase (Argon2id). The result is what goes into the
|
||||
* repository config and the recovery kit.
|
||||
*
|
||||
* @return array{v:int, salt:string, ops:int, mem:int, nonce:string, key:string}
|
||||
*/
|
||||
public function wrap(#[\SensitiveParameter] string $passphrase): array {
|
||||
$salt = random_bytes(SODIUM_CRYPTO_PWHASH_SALTBYTES);
|
||||
$ops = SODIUM_CRYPTO_PWHASH_OPSLIMIT_MODERATE;
|
||||
$mem = SODIUM_CRYPTO_PWHASH_MEMLIMIT_MODERATE;
|
||||
$kek = sodium_crypto_pwhash(SODIUM_CRYPTO_SECRETBOX_KEYBYTES, $passphrase, $salt, $ops, $mem,
|
||||
SODIUM_CRYPTO_PWHASH_ALG_ARGON2ID13);
|
||||
$nonce = random_bytes(SODIUM_CRYPTO_SECRETBOX_NONCEBYTES);
|
||||
$sealed = sodium_crypto_secretbox($this->masterKey, $nonce, $kek);
|
||||
sodium_memzero($kek);
|
||||
return [
|
||||
'v' => 1,
|
||||
'salt' => sodium_bin2base64($salt, SODIUM_BASE64_VARIANT_ORIGINAL),
|
||||
'ops' => $ops,
|
||||
'mem' => $mem,
|
||||
'nonce' => sodium_bin2base64($nonce, SODIUM_BASE64_VARIANT_ORIGINAL),
|
||||
'key' => sodium_bin2base64($sealed, SODIUM_BASE64_VARIANT_ORIGINAL),
|
||||
];
|
||||
}
|
||||
|
||||
/** @param array{v:int, salt:string, ops:int, mem:int, nonce:string, key:string} $wrapped */
|
||||
public static function unwrap(array $wrapped, #[\SensitiveParameter] string $passphrase): self {
|
||||
$b64 = static fn (string $s): string => sodium_base642bin($s, SODIUM_BASE64_VARIANT_ORIGINAL);
|
||||
$kek = sodium_crypto_pwhash(SODIUM_CRYPTO_SECRETBOX_KEYBYTES, $passphrase, $b64($wrapped['salt']),
|
||||
$wrapped['ops'], $wrapped['mem'], SODIUM_CRYPTO_PWHASH_ALG_ARGON2ID13);
|
||||
$master = sodium_crypto_secretbox_open($b64($wrapped['key']), $b64($wrapped['nonce']), $kek);
|
||||
sodium_memzero($kek);
|
||||
if ($master === false) {
|
||||
throw new CryptoException('Wrong passphrase or damaged key');
|
||||
}
|
||||
return new self($master);
|
||||
}
|
||||
|
||||
public function __destruct() {
|
||||
sodium_memzero($this->masterKey);
|
||||
sodium_memzero($this->dataKey);
|
||||
sodium_memzero($this->hashKey);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,154 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
// SPDX-FileCopyrightText: 2026 Dillard Blom
|
||||
// SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
namespace OCA\NgBackup\Crypto;
|
||||
|
||||
/**
|
||||
* Streaming authenticated encryption with libsodium secretstream (XChaCha20-Poly1305).
|
||||
*
|
||||
* Object layout:
|
||||
* "NGB1" | secretstream header (24 bytes) | frame*
|
||||
* frame = uint32 big-endian ciphertext length | ciphertext
|
||||
* Each frame holds at most FRAME_SIZE plaintext bytes; the last frame carries TAG_FINAL, so a
|
||||
* truncated object fails to decrypt instead of yielding a shorter plaintext.
|
||||
*
|
||||
* Memory use is bounded by FRAME_SIZE, independent of the object size.
|
||||
*/
|
||||
final class StreamCipher {
|
||||
public const MAGIC = 'NGB1';
|
||||
public const FRAME_SIZE = 65536;
|
||||
private const HEADER_BYTES = SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_HEADERBYTES;
|
||||
private const ABYTES = SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_ABYTES;
|
||||
|
||||
public function __construct(
|
||||
private KeyRing $keys,
|
||||
) {
|
||||
}
|
||||
|
||||
/**
|
||||
* @param resource $in readable stream (plaintext)
|
||||
* @param resource $out writable stream (ciphertext)
|
||||
* @return int number of ciphertext bytes written
|
||||
*/
|
||||
public function encrypt($in, $out, string $associatedData = ''): int {
|
||||
[$state, $header] = sodium_crypto_secretstream_xchacha20poly1305_init_push($this->keys->dataKey());
|
||||
$written = self::write($out, self::MAGIC . $header);
|
||||
|
||||
// Read one frame ahead so the last frame can be tagged FINAL.
|
||||
$current = self::readFull($in, self::FRAME_SIZE);
|
||||
do {
|
||||
$next = $current === '' ? '' : self::readFull($in, self::FRAME_SIZE);
|
||||
$tag = $next === ''
|
||||
? SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_FINAL
|
||||
: SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_MESSAGE;
|
||||
$cipher = sodium_crypto_secretstream_xchacha20poly1305_push($state, $current, $associatedData, $tag);
|
||||
$written += self::write($out, pack('N', strlen($cipher)) . $cipher);
|
||||
$current = $next;
|
||||
} while ($tag !== SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_FINAL);
|
||||
|
||||
sodium_memzero($state);
|
||||
return $written;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param resource $in readable stream (ciphertext)
|
||||
* @param resource $out writable stream (plaintext)
|
||||
* @return int number of plaintext bytes written
|
||||
* @throws CryptoException on a wrong key, tampering or truncation
|
||||
*/
|
||||
public function decrypt($in, $out, string $associatedData = ''): int {
|
||||
$head = self::readFull($in, strlen(self::MAGIC) + self::HEADER_BYTES);
|
||||
if (strlen($head) !== strlen(self::MAGIC) + self::HEADER_BYTES || !str_starts_with($head, self::MAGIC)) {
|
||||
throw new CryptoException('Not an NG Backup object');
|
||||
}
|
||||
$state = sodium_crypto_secretstream_xchacha20poly1305_init_pull(substr($head, strlen(self::MAGIC)), $this->keys->dataKey());
|
||||
|
||||
$written = 0;
|
||||
while (true) {
|
||||
$len = self::readFull($in, 4);
|
||||
if (strlen($len) !== 4) {
|
||||
throw new CryptoException('Object is truncated');
|
||||
}
|
||||
$size = unpack('N', $len)[1];
|
||||
if ($size < self::ABYTES || $size > self::FRAME_SIZE + self::ABYTES) {
|
||||
throw new CryptoException('Invalid frame size');
|
||||
}
|
||||
$cipher = self::readFull($in, $size);
|
||||
if (strlen($cipher) !== $size) {
|
||||
throw new CryptoException('Object is truncated');
|
||||
}
|
||||
$result = sodium_crypto_secretstream_xchacha20poly1305_pull($state, $cipher, $associatedData);
|
||||
if ($result === false) {
|
||||
throw new CryptoException('Decryption failed (wrong key or damaged data)');
|
||||
}
|
||||
[$plain, $tag] = $result;
|
||||
$written += self::write($out, $plain);
|
||||
if ($tag === SODIUM_CRYPTO_SECRETSTREAM_XCHACHA20POLY1305_TAG_FINAL) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
if (self::readFull($in, 1) !== '') {
|
||||
throw new CryptoException('Unexpected data after the final frame');
|
||||
}
|
||||
sodium_memzero($state);
|
||||
return $written;
|
||||
}
|
||||
|
||||
/** One-shot helpers for small objects (manifests, index). */
|
||||
public function encryptString(string $plain, string $associatedData = ''): string {
|
||||
$in = fopen('php://memory', 'w+b');
|
||||
fwrite($in, $plain);
|
||||
rewind($in);
|
||||
$out = fopen('php://memory', 'w+b');
|
||||
$this->encrypt($in, $out, $associatedData);
|
||||
rewind($out);
|
||||
return (string)stream_get_contents($out);
|
||||
}
|
||||
|
||||
public function decryptString(string $cipher, string $associatedData = ''): string {
|
||||
$in = fopen('php://memory', 'w+b');
|
||||
fwrite($in, $cipher);
|
||||
rewind($in);
|
||||
$out = fopen('php://memory', 'w+b');
|
||||
$this->decrypt($in, $out, $associatedData);
|
||||
rewind($out);
|
||||
return (string)stream_get_contents($out);
|
||||
}
|
||||
|
||||
/** fread() may return short reads on network streams; keep reading until $length or EOF. */
|
||||
private static function readFull($in, int $length): string {
|
||||
$buffer = '';
|
||||
while (strlen($buffer) < $length && !feof($in)) {
|
||||
$chunk = fread($in, $length - strlen($buffer));
|
||||
if ($chunk === false) {
|
||||
throw new CryptoException('Read error');
|
||||
}
|
||||
if ($chunk === '') {
|
||||
// Non-blocking stream without data yet, or EOF not yet flagged.
|
||||
if (feof($in)) {
|
||||
break;
|
||||
}
|
||||
continue;
|
||||
}
|
||||
$buffer .= $chunk;
|
||||
}
|
||||
return $buffer;
|
||||
}
|
||||
|
||||
private static function write($out, string $data): int {
|
||||
$total = 0;
|
||||
$length = strlen($data);
|
||||
while ($total < $length) {
|
||||
$n = fwrite($out, $total === 0 ? $data : substr($data, $total));
|
||||
if ($n === false || $n === 0) {
|
||||
throw new CryptoException('Write error');
|
||||
}
|
||||
$total += $n;
|
||||
}
|
||||
return $total;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,111 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
// Spike A: streaming encryption with bounded memory.
|
||||
// Usage: php -d memory_limit=64M spikes/01-stream-crypto.php [size-in-MiB] [workdir]
|
||||
|
||||
require __DIR__ . '/bootstrap.php';
|
||||
|
||||
use OCA\NgBackup\Crypto\CryptoException;
|
||||
use OCA\NgBackup\Crypto\KeyRing;
|
||||
use OCA\NgBackup\Crypto\StreamCipher;
|
||||
|
||||
/** Write-only stream that hashes everything written to it (so no plaintext copy hits the disk). */
|
||||
final class HashSink {
|
||||
public static \HashContext $ctx;
|
||||
public static int $bytes = 0;
|
||||
public $context;
|
||||
public function stream_open(): bool { self::$ctx = hash_init('sha256'); self::$bytes = 0; return true; }
|
||||
public function stream_write(string $d): int { hash_update(self::$ctx, $d); self::$bytes += strlen($d); return strlen($d); }
|
||||
public function stream_close(): void {}
|
||||
}
|
||||
stream_wrapper_register('hashsink', HashSink::class);
|
||||
|
||||
$sizeMiB = (int)($argv[1] ?? 1024);
|
||||
$work = rtrim($argv[2] ?? sys_get_temp_dir(), '/');
|
||||
$plainFile = "$work/ngb-plain.bin";
|
||||
$encFile = "$work/ngb-enc.bin";
|
||||
|
||||
$ok = true;
|
||||
$check = static function (string $name, bool $pass) use (&$ok): void {
|
||||
printf("%-58s %s\n", $name, $pass ? 'PASS' : 'FAIL');
|
||||
$ok = $ok && $pass;
|
||||
};
|
||||
|
||||
// 1. Round trip of a large file.
|
||||
$t = microtime(true);
|
||||
$fh = fopen($plainFile, 'wb');
|
||||
$h = hash_init('sha256');
|
||||
for ($i = 0; $i < $sizeMiB; $i++) {
|
||||
$block = random_bytes(1048576);
|
||||
hash_update($h, $block);
|
||||
fwrite($fh, $block);
|
||||
}
|
||||
fclose($fh);
|
||||
$plainHash = hash_final($h);
|
||||
printf("generated %d MiB in %.1fs\n", $sizeMiB, microtime(true) - $t);
|
||||
|
||||
$keys = KeyRing::generate();
|
||||
$cipher = new StreamCipher($keys);
|
||||
|
||||
memory_reset_peak_usage();
|
||||
$t = microtime(true);
|
||||
$in = fopen($plainFile, 'rb');
|
||||
$out = fopen($encFile, 'wb');
|
||||
$encBytes = $cipher->encrypt($in, $out, 'blob:test');
|
||||
fclose($in);
|
||||
fclose($out);
|
||||
$encSecs = microtime(true) - $t;
|
||||
$encPeak = memory_get_peak_usage();
|
||||
|
||||
memory_reset_peak_usage();
|
||||
$t = microtime(true);
|
||||
$in = fopen($encFile, 'rb');
|
||||
$out = fopen('hashsink://x', 'wb');
|
||||
$cipher->decrypt($in, $out, 'blob:test');
|
||||
fclose($in);
|
||||
fclose($out);
|
||||
$decSecs = microtime(true) - $t;
|
||||
$decPeak = memory_get_peak_usage();
|
||||
$roundHash = hash_final(HashSink::$ctx);
|
||||
|
||||
printf("encrypt: %.1fs (%.0f MiB/s), peak %.1f MiB, overhead %.3f%%\n", $encSecs, $sizeMiB / $encSecs, $encPeak / 1048576,
|
||||
($encBytes - $sizeMiB * 1048576) / ($sizeMiB * 1048576) * 100);
|
||||
printf("decrypt: %.1fs (%.0f MiB/s), peak %.1f MiB\n", $decSecs, $sizeMiB / $decSecs, $decPeak / 1048576);
|
||||
$check('round trip: sha256 identical', $roundHash === $plainHash);
|
||||
$check('peak memory below 8 MiB (independent of size)', max($encPeak, $decPeak) < 8 * 1048576);
|
||||
unlink($plainFile);
|
||||
|
||||
// 2. Failure cases on a small object.
|
||||
$small = $cipher->encryptString(str_repeat('abc', 100000), 'ad');
|
||||
$expectFail = static function (callable $fn): bool {
|
||||
try { $fn(); return false; } catch (CryptoException) { return true; }
|
||||
};
|
||||
$check('tampered byte is rejected', $expectFail(function () use ($cipher, $small) {
|
||||
$bad = $small; $bad[100] = chr(ord($bad[100]) ^ 1); $cipher->decryptString($bad, 'ad');
|
||||
}));
|
||||
$check('truncated object is rejected', $expectFail(fn () => $cipher->decryptString(substr($small, 0, -30), 'ad')));
|
||||
$check('object cut at a frame boundary is rejected', $expectFail(function () use ($cipher) {
|
||||
$two = $cipher->encryptString(str_repeat('x', StreamCipher::FRAME_SIZE + 10), 'ad');
|
||||
$firstFrameEnd = 4 + 24 + 4 + StreamCipher::FRAME_SIZE + 17;
|
||||
$cipher->decryptString(substr($two, 0, $firstFrameEnd), 'ad');
|
||||
}));
|
||||
$check('trailing garbage is rejected', $expectFail(fn () => $cipher->decryptString($small . 'x', 'ad')));
|
||||
$check('wrong associated data is rejected', $expectFail(fn () => $cipher->decryptString($small, 'other')));
|
||||
$check('wrong key is rejected', $expectFail(fn () => (new StreamCipher(KeyRing::generate()))->decryptString($small, 'ad')));
|
||||
$check('empty plaintext round trip', $cipher->decryptString($cipher->encryptString(''), '') === '');
|
||||
|
||||
// 3. Wrapping the master key with a passphrase.
|
||||
$t = microtime(true);
|
||||
$wrapped = $keys->wrap('correct horse battery staple');
|
||||
$unwrapped = KeyRing::unwrap($wrapped, 'correct horse battery staple');
|
||||
printf("wrap+unwrap (Argon2id moderate): %.1fs\n", microtime(true) - $t);
|
||||
$check('unwrapped key decrypts', (new StreamCipher($unwrapped))->decryptString($small, 'ad') === str_repeat('abc', 100000));
|
||||
$check('wrong passphrase is rejected', $expectFail(fn () => KeyRing::unwrap($wrapped, 'wrong')));
|
||||
$check('same blob id from both keyrings', $keys->blobId('hello') === $unwrapped->blobId('hello'));
|
||||
$check('blob id differs per repository', $keys->blobId('hello') !== KeyRing::generate()->blobId('hello'));
|
||||
|
||||
unlink($encFile);
|
||||
echo $ok ? "ALL PASS\n" : "FAILURES\n";
|
||||
exit($ok ? 0 : 1);
|
||||
@@ -0,0 +1,14 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
// Minimal PSR-4 autoloader so the spikes run without Nextcloud or composer.
|
||||
spl_autoload_register(static function (string $class): void {
|
||||
$prefix = 'OCA\\NgBackup\\';
|
||||
if (str_starts_with($class, $prefix)) {
|
||||
$file = __DIR__ . '/../lib/' . str_replace('\\', '/', substr($class, strlen($prefix))) . '.php';
|
||||
if (is_file($file)) {
|
||||
require $file;
|
||||
}
|
||||
}
|
||||
});
|
||||
Reference in New Issue
Block a user