Compare commits
2 Commits
65933b5cb3
...
eadb53db0b
Author | SHA1 | Date | |
---|---|---|---|
eadb53db0b | |||
49ac208286 |
661
LICENSE.txt
Normal file
661
LICENSE.txt
Normal file
@ -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/>.
|
10
README.md
10
README.md
@ -118,6 +118,16 @@ domain:
|
|||||||
# http_url is set.
|
# http_url is set.
|
||||||
#https_disabled: false
|
#https_disabled: false
|
||||||
|
|
||||||
|
# External domains will have a TLS key/cert generated and signed for them, but
|
||||||
|
# which will not be served by domani itself. The key/cert files will be placed
|
||||||
|
# in the configured paths.
|
||||||
|
#
|
||||||
|
# HTTPS must be enabled for external_domains to be used.
|
||||||
|
#external_domains:
|
||||||
|
#example.com
|
||||||
|
# tls_key_path: /dir/path/key.pem
|
||||||
|
# tls_cert_path: /dir/path/cert.pem
|
||||||
|
|
||||||
service:
|
service:
|
||||||
|
|
||||||
# Passphrase which must be given by users who are configuring new domains via
|
# Passphrase which must be given by users who are configuring new domains via
|
||||||
|
@ -1,2 +1,3 @@
|
|||||||
|
pub mod account_key_store;
|
||||||
pub mod manager;
|
pub mod manager;
|
||||||
pub mod store;
|
pub mod store;
|
||||||
|
86
src/domain/acme/account_key_store.rs
Normal file
86
src/domain/acme/account_key_store.rs
Normal file
@ -0,0 +1,86 @@
|
|||||||
|
use std::io::{Read, Write};
|
||||||
|
use std::{fs, path};
|
||||||
|
|
||||||
|
use crate::domain::tls::PrivateKey;
|
||||||
|
use crate::error::unexpected::{self, Mappable};
|
||||||
|
use crate::util;
|
||||||
|
|
||||||
|
#[mockall::automock]
|
||||||
|
pub trait Store {
|
||||||
|
fn set(&self, k: &PrivateKey) -> Result<(), unexpected::Error>;
|
||||||
|
fn get(&self) -> unexpected::Result<Option<PrivateKey>>;
|
||||||
|
}
|
||||||
|
|
||||||
|
pub struct FSStore {
|
||||||
|
dir_path: path::PathBuf,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl FSStore {
|
||||||
|
pub fn new(dir_path: &path::Path) -> Result<Self, unexpected::Error> {
|
||||||
|
fs::create_dir_all(dir_path).or_unexpected()?;
|
||||||
|
Ok(Self {
|
||||||
|
dir_path: dir_path.into(),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
fn account_key_path(&self) -> path::PathBuf {
|
||||||
|
self.dir_path.join("account.key")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Store for FSStore {
|
||||||
|
fn set(&self, k: &PrivateKey) -> Result<(), unexpected::Error> {
|
||||||
|
let path = self.account_key_path();
|
||||||
|
{
|
||||||
|
let mut file = fs::File::create(&path).or_unexpected_while("creating file")?;
|
||||||
|
file.write_all(k.to_string().as_bytes())
|
||||||
|
.or_unexpected_while("writing file")
|
||||||
|
}
|
||||||
|
.map_unexpected_while(|| format!("path is {}", path.display()))?;
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn get(&self) -> unexpected::Result<Option<PrivateKey>> {
|
||||||
|
let path = self.account_key_path();
|
||||||
|
{
|
||||||
|
let mut file =
|
||||||
|
match util::open_file(path.as_path()).or_unexpected_while("opening_file")? {
|
||||||
|
Some(file) => file,
|
||||||
|
None => return Ok(None),
|
||||||
|
};
|
||||||
|
|
||||||
|
let mut key = String::new();
|
||||||
|
file.read_to_string(&mut key)
|
||||||
|
.or_unexpected_while("reading file")?;
|
||||||
|
|
||||||
|
let key: PrivateKey = key.parse().or_unexpected_while("parsing private key")?;
|
||||||
|
|
||||||
|
unexpected::Result::<Option<PrivateKey>>::Ok(Some(key))
|
||||||
|
}
|
||||||
|
.map_unexpected_while(|| format!("path is {}", path.display()))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
use crate::domain::tls;
|
||||||
|
use tempdir::TempDir;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn account_key() {
|
||||||
|
let tmp_dir = TempDir::new("domain_acme_account_key_store").unwrap();
|
||||||
|
let store = FSStore::new(tmp_dir.path()).expect("store created");
|
||||||
|
|
||||||
|
assert!(matches!(
|
||||||
|
store.get(),
|
||||||
|
unexpected::Result::<Option<PrivateKey>>::Ok(None)
|
||||||
|
));
|
||||||
|
|
||||||
|
let k = tls::PrivateKey::new();
|
||||||
|
|
||||||
|
store.set(&k).expect("account private key set");
|
||||||
|
|
||||||
|
assert_eq!(Some(k), store.get().expect("account private key retrieved"));
|
||||||
|
}
|
||||||
|
}
|
@ -1,8 +1,8 @@
|
|||||||
use std::{sync, time};
|
use std::{sync, time};
|
||||||
|
|
||||||
use crate::domain::acme;
|
use crate::domain::acme;
|
||||||
use crate::domain::tls::{Certificate, PrivateKey};
|
use crate::domain::tls::{Certificate, CertificateChain, PrivateKey};
|
||||||
use crate::error::unexpected::{self, Intoable, Mappable};
|
use crate::error::unexpected::{self, Mappable};
|
||||||
use crate::{domain, token, util};
|
use crate::{domain, token, util};
|
||||||
|
|
||||||
const LETS_ENCRYPT_URL: &str = "https://acme-v02.api.letsencrypt.org/directory";
|
const LETS_ENCRYPT_URL: &str = "https://acme-v02.api.letsencrypt.org/directory";
|
||||||
@ -16,39 +16,53 @@ pub enum GetHttp01ChallengeKeyError {
|
|||||||
Unexpected(#[from] unexpected::Error),
|
Unexpected(#[from] unexpected::Error),
|
||||||
}
|
}
|
||||||
|
|
||||||
pub type GetCertificateError = acme::store::GetCertificateError;
|
|
||||||
|
|
||||||
#[mockall::automock]
|
#[mockall::automock]
|
||||||
pub trait Manager {
|
pub trait Manager {
|
||||||
fn sync_domain<'mgr>(
|
fn sync_domain<'mgr>(
|
||||||
&'mgr self,
|
&'mgr self,
|
||||||
domain: domain::Name,
|
domain: domain::Name,
|
||||||
) -> util::BoxFuture<'mgr, Result<(), unexpected::Error>>;
|
external_config: Option<domain::ConfigExternalDomain>,
|
||||||
|
) -> util::BoxFuture<'mgr, unexpected::Result<()>>;
|
||||||
|
|
||||||
fn get_http01_challenge_key(&self, token: &str) -> Result<String, GetHttp01ChallengeKeyError>;
|
fn get_http01_challenge_key(&self, token: &str) -> Result<String, GetHttp01ChallengeKeyError>;
|
||||||
|
|
||||||
/// Returned vec is guaranteed to have len > 0
|
|
||||||
fn get_certificate(
|
fn get_certificate(
|
||||||
&self,
|
&self,
|
||||||
domain: &str,
|
domain: &str,
|
||||||
) -> Result<(PrivateKey, Vec<Certificate>), GetCertificateError>;
|
) -> unexpected::Result<Option<(PrivateKey, CertificateChain)>>;
|
||||||
}
|
}
|
||||||
|
|
||||||
pub struct ManagerImpl {
|
pub struct ManagerImpl {
|
||||||
store: Box<dyn acme::store::Store + Send + Sync>,
|
store: Box<dyn acme::store::Store + Send + Sync>,
|
||||||
token_store: Box<dyn token::Store + Send + Sync>,
|
token_store: Box<dyn token::Store + Send + Sync>,
|
||||||
account: sync::Arc<acme2::Account>,
|
account: sync::Arc<acme2::Account>,
|
||||||
|
external_store_fn: Box<
|
||||||
|
dyn Fn(
|
||||||
|
&domain::ConfigExternalDomain,
|
||||||
|
) -> unexpected::Result<Box<dyn acme::store::Store + Send + Sync>>
|
||||||
|
+ Send
|
||||||
|
+ Sync,
|
||||||
|
>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl ManagerImpl {
|
impl ManagerImpl {
|
||||||
pub async fn new<AcmeStore, TokenStore>(
|
pub async fn new<ExternalAcmeStoreFn, AcmeStore, TokenStore, AccountKeyStore>(
|
||||||
store: AcmeStore,
|
store: AcmeStore,
|
||||||
token_store: TokenStore,
|
token_store: TokenStore,
|
||||||
|
account_key_store: AccountKeyStore,
|
||||||
|
external_store_fn: ExternalAcmeStoreFn,
|
||||||
config: &domain::ConfigACME,
|
config: &domain::ConfigACME,
|
||||||
) -> Result<Self, unexpected::Error>
|
) -> unexpected::Result<Self>
|
||||||
where
|
where
|
||||||
|
ExternalAcmeStoreFn: Fn(
|
||||||
|
&domain::ConfigExternalDomain,
|
||||||
|
) -> unexpected::Result<Box<dyn acme::store::Store + Send + Sync>>
|
||||||
|
+ Send
|
||||||
|
+ Sync
|
||||||
|
+ 'static,
|
||||||
AcmeStore: acme::store::Store + Send + Sync + 'static,
|
AcmeStore: acme::store::Store + Send + Sync + 'static,
|
||||||
TokenStore: token::Store + Send + Sync + 'static,
|
TokenStore: token::Store + Send + Sync + 'static,
|
||||||
|
AccountKeyStore: acme::account_key_store::Store + Send + Sync + 'static,
|
||||||
{
|
{
|
||||||
let dir = acme2::DirectoryBuilder::new(LETS_ENCRYPT_URL.to_string())
|
let dir = acme2::DirectoryBuilder::new(LETS_ENCRYPT_URL.to_string())
|
||||||
.build()
|
.build()
|
||||||
@ -62,19 +76,16 @@ impl ManagerImpl {
|
|||||||
builder.contact(vec![contact]);
|
builder.contact(vec![contact]);
|
||||||
builder.terms_of_service_agreed(true);
|
builder.terms_of_service_agreed(true);
|
||||||
|
|
||||||
match store.get_account_key() {
|
if let Some(account_key) = account_key_store
|
||||||
Ok(account_key) => {
|
.get()
|
||||||
|
.or_unexpected_while("fetching account key")?
|
||||||
|
{
|
||||||
builder.private_key(
|
builder.private_key(
|
||||||
(&account_key)
|
(&account_key)
|
||||||
.try_into()
|
.try_into()
|
||||||
.or_unexpected_while("parsing private key")?,
|
.or_unexpected_while("parsing private key")?,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
Err(acme::store::GetAccountKeyError::NotFound) => (),
|
|
||||||
Err(acme::store::GetAccountKeyError::Unexpected(err)) => {
|
|
||||||
return Err(err.into_unexpected())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
let account = builder
|
let account = builder
|
||||||
.build()
|
.build()
|
||||||
@ -87,14 +98,15 @@ impl ManagerImpl {
|
|||||||
.try_into()
|
.try_into()
|
||||||
.or_unexpected_while("parsing private key back out")?;
|
.or_unexpected_while("parsing private key back out")?;
|
||||||
|
|
||||||
store
|
account_key_store
|
||||||
.set_account_key(&account_key)
|
.set(&account_key)
|
||||||
.or_unexpected_while("storing account key")?;
|
.or_unexpected_while("storing account key")?;
|
||||||
|
|
||||||
Ok(Self {
|
Ok(Self {
|
||||||
store: Box::from(store),
|
store: Box::from(store),
|
||||||
token_store: Box::from(token_store),
|
token_store: Box::from(token_store),
|
||||||
account,
|
account,
|
||||||
|
external_store_fn: Box::from(external_store_fn),
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -103,16 +115,26 @@ impl Manager for ManagerImpl {
|
|||||||
fn sync_domain<'mgr>(
|
fn sync_domain<'mgr>(
|
||||||
&'mgr self,
|
&'mgr self,
|
||||||
domain: domain::Name,
|
domain: domain::Name,
|
||||||
|
external_config: Option<domain::ConfigExternalDomain>,
|
||||||
) -> util::BoxFuture<'mgr, Result<(), unexpected::Error>> {
|
) -> util::BoxFuture<'mgr, Result<(), unexpected::Error>> {
|
||||||
Box::pin(async move {
|
Box::pin(async move {
|
||||||
|
let external_store;
|
||||||
|
let store = match external_config {
|
||||||
|
None => &self.store,
|
||||||
|
Some(config) => {
|
||||||
|
external_store = (self.external_store_fn)(&config).or_unexpected()?;
|
||||||
|
&external_store
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
// if there's an existing cert, and its expiry (determined by the soonest value of
|
// if there's an existing cert, and its expiry (determined by the soonest value of
|
||||||
// not_after amongst its parts) is later than 30 days from now, then we consider it to
|
// not_after amongst its parts) is later than 30 days from now, then we consider it to
|
||||||
// be synced.
|
// be synced.
|
||||||
if let Ok((_, cert)) = self.store.get_certificate(domain.as_str()) {
|
if let Ok(Some((_, certs))) = store.get_certificate(domain.as_str()) {
|
||||||
let thirty_days = openssl::asn1::Asn1Time::days_from_now(30)
|
let thirty_days = openssl::asn1::Asn1Time::days_from_now(30)
|
||||||
.expect("parsed thirty days from now as Asn1Time");
|
.expect("parsed thirty days from now as Asn1Time");
|
||||||
|
|
||||||
let cert_with_soonest_not_after = cert
|
let cert_with_soonest_not_after = certs
|
||||||
.into_iter()
|
.into_iter()
|
||||||
.map(|cert| openssl::x509::X509::try_from(&cert))
|
.map(|cert| openssl::x509::X509::try_from(&cert))
|
||||||
.try_collect::<Vec<openssl::x509::X509>>()
|
.try_collect::<Vec<openssl::x509::X509>>()
|
||||||
@ -280,7 +302,7 @@ impl Manager for ManagerImpl {
|
|||||||
|
|
||||||
// Download the certificate, and panic if it doesn't exist.
|
// Download the certificate, and panic if it doesn't exist.
|
||||||
log::info!("Fetching certificate for domain {}", domain.as_str());
|
log::info!("Fetching certificate for domain {}", domain.as_str());
|
||||||
let cert = order
|
let certs = order
|
||||||
.certificate()
|
.certificate()
|
||||||
.await
|
.await
|
||||||
.or_unexpected_while("fetching certificate")?
|
.or_unexpected_while("fetching certificate")?
|
||||||
@ -292,19 +314,19 @@ impl Manager for ManagerImpl {
|
|||||||
.try_collect::<Vec<Certificate>>()
|
.try_collect::<Vec<Certificate>>()
|
||||||
.or_unexpected_while("parsing certificate")?;
|
.or_unexpected_while("parsing certificate")?;
|
||||||
|
|
||||||
if cert.len() <= 1 {
|
if certs.len() <= 1 {
|
||||||
return Err(unexpected::Error::from(
|
return Err(unexpected::Error::from(
|
||||||
format!(
|
format!(
|
||||||
"expected more than one certificate to be returned, instead got {}",
|
"expected more than one certificate to be returned, instead got {}",
|
||||||
cert.len(),
|
certs.len(),
|
||||||
)
|
)
|
||||||
.as_str(),
|
.as_str(),
|
||||||
));
|
));
|
||||||
}
|
}
|
||||||
|
|
||||||
log::info!("Certificate for {} successfully retrieved", domain.as_str());
|
log::info!("Certificate for {} successfully retrieved", domain.as_str());
|
||||||
self.store
|
store
|
||||||
.set_certificate(domain.as_str(), pkey, cert)
|
.set_certificate(domain.as_str(), pkey, certs.into())
|
||||||
.or_unexpected_while("storing new cert")?;
|
.or_unexpected_while("storing new cert")?;
|
||||||
|
|
||||||
Ok(())
|
Ok(())
|
||||||
@ -323,7 +345,7 @@ impl Manager for ManagerImpl {
|
|||||||
fn get_certificate(
|
fn get_certificate(
|
||||||
&self,
|
&self,
|
||||||
domain: &str,
|
domain: &str,
|
||||||
) -> Result<(PrivateKey, Vec<Certificate>), GetCertificateError> {
|
) -> unexpected::Result<Option<(PrivateKey, CertificateChain)>> {
|
||||||
self.store.get_certificate(domain)
|
self.store.get_certificate(domain)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -1,193 +1,24 @@
|
|||||||
use std::io::{Read, Write};
|
mod json_fs_store;
|
||||||
use std::str::FromStr;
|
pub use json_fs_store::*;
|
||||||
use std::{fs, path};
|
|
||||||
|
|
||||||
use crate::domain::tls::{Certificate, PrivateKey};
|
mod direct_fs_store;
|
||||||
use crate::error::unexpected::{self, Mappable};
|
pub use direct_fs_store::*;
|
||||||
use crate::util;
|
|
||||||
|
|
||||||
use serde::{Deserialize, Serialize};
|
use crate::domain::tls::{CertificateChain, PrivateKey};
|
||||||
|
use crate::error::unexpected;
|
||||||
#[derive(thiserror::Error, Debug)]
|
|
||||||
pub enum GetAccountKeyError {
|
|
||||||
#[error("not found")]
|
|
||||||
NotFound,
|
|
||||||
|
|
||||||
#[error(transparent)]
|
|
||||||
Unexpected(#[from] unexpected::Error),
|
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(thiserror::Error, Debug)]
|
|
||||||
pub enum GetCertificateError {
|
|
||||||
#[error("not found")]
|
|
||||||
NotFound,
|
|
||||||
|
|
||||||
#[error(transparent)]
|
|
||||||
Unexpected(#[from] unexpected::Error),
|
|
||||||
}
|
|
||||||
|
|
||||||
#[mockall::automock]
|
#[mockall::automock]
|
||||||
pub trait Store {
|
pub trait Store {
|
||||||
fn set_account_key(&self, k: &PrivateKey) -> Result<(), unexpected::Error>;
|
|
||||||
fn get_account_key(&self) -> Result<PrivateKey, GetAccountKeyError>;
|
|
||||||
|
|
||||||
fn set_certificate(
|
fn set_certificate(
|
||||||
&self,
|
&self,
|
||||||
domain: &str,
|
domain: &str,
|
||||||
key: PrivateKey,
|
key: PrivateKey,
|
||||||
cert: Vec<Certificate>,
|
cert: CertificateChain,
|
||||||
) -> Result<(), unexpected::Error>;
|
) -> Result<(), unexpected::Error>;
|
||||||
|
|
||||||
/// Returned vec is guaranteed to have len > 0
|
/// Returned chain is guaranteed to have len > 0
|
||||||
fn get_certificate(
|
fn get_certificate(
|
||||||
&self,
|
&self,
|
||||||
domain: &str,
|
domain: &str,
|
||||||
) -> Result<(PrivateKey, Vec<Certificate>), GetCertificateError>;
|
) -> unexpected::Result<Option<(PrivateKey, CertificateChain)>>;
|
||||||
}
|
|
||||||
|
|
||||||
#[derive(Debug, Serialize, Deserialize)]
|
|
||||||
struct StoredPKeyCert {
|
|
||||||
private_key: PrivateKey,
|
|
||||||
cert: Vec<Certificate>,
|
|
||||||
}
|
|
||||||
|
|
||||||
pub struct FSStore {
|
|
||||||
dir_path: path::PathBuf,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl FSStore {
|
|
||||||
pub fn new(dir_path: &path::Path) -> Result<Self, unexpected::Error> {
|
|
||||||
vec![
|
|
||||||
dir_path,
|
|
||||||
dir_path.join("http01_challenge_keys").as_ref(),
|
|
||||||
dir_path.join("certificates").as_ref(),
|
|
||||||
]
|
|
||||||
.iter()
|
|
||||||
.map(|dir| {
|
|
||||||
fs::create_dir_all(dir)
|
|
||||||
.map_unexpected_while(|| format!("creating dir {}", dir.display()))
|
|
||||||
})
|
|
||||||
.try_collect()?;
|
|
||||||
|
|
||||||
Ok(Self {
|
|
||||||
dir_path: dir_path.into(),
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
fn account_key_path(&self) -> path::PathBuf {
|
|
||||||
self.dir_path.join("account.key")
|
|
||||||
}
|
|
||||||
|
|
||||||
fn certificate_path(&self, domain: &str) -> path::PathBuf {
|
|
||||||
let mut domain = domain.to_string();
|
|
||||||
domain.push_str(".json");
|
|
||||||
|
|
||||||
self.dir_path.join("certificates").join(domain)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Store for FSStore {
|
|
||||||
fn set_account_key(&self, k: &PrivateKey) -> Result<(), unexpected::Error> {
|
|
||||||
let path = self.account_key_path();
|
|
||||||
{
|
|
||||||
let mut file = fs::File::create(&path).or_unexpected_while("creating file")?;
|
|
||||||
file.write_all(k.to_string().as_bytes())
|
|
||||||
.or_unexpected_while("writing file")
|
|
||||||
}
|
|
||||||
.map_unexpected_while(|| format!("path is {}", path.display()))?;
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
fn get_account_key(&self) -> Result<PrivateKey, GetAccountKeyError> {
|
|
||||||
let path = self.account_key_path();
|
|
||||||
{
|
|
||||||
let mut file =
|
|
||||||
match util::open_file(path.as_path()).or_unexpected_while("opening_file")? {
|
|
||||||
Some(file) => file,
|
|
||||||
None => return Err(GetAccountKeyError::NotFound),
|
|
||||||
};
|
|
||||||
|
|
||||||
let mut key = String::new();
|
|
||||||
file.read_to_string(&mut key)
|
|
||||||
.or_unexpected_while("reading file")?;
|
|
||||||
|
|
||||||
let key = PrivateKey::from_str(&key).or_unexpected_while("parsing private key")?;
|
|
||||||
|
|
||||||
Ok::<PrivateKey, unexpected::Error>(key)
|
|
||||||
}
|
|
||||||
.map_unexpected_while(|| format!("path is {}", path.display()))
|
|
||||||
.map_err(|err| err.into())
|
|
||||||
}
|
|
||||||
|
|
||||||
fn set_certificate(
|
|
||||||
&self,
|
|
||||||
domain: &str,
|
|
||||||
key: PrivateKey,
|
|
||||||
cert: Vec<Certificate>,
|
|
||||||
) -> Result<(), unexpected::Error> {
|
|
||||||
let to_store = StoredPKeyCert {
|
|
||||||
private_key: key,
|
|
||||||
cert,
|
|
||||||
};
|
|
||||||
|
|
||||||
let path = self.certificate_path(domain);
|
|
||||||
{
|
|
||||||
let cert_file =
|
|
||||||
fs::File::create(path.as_path()).or_unexpected_while("creating file")?;
|
|
||||||
serde_json::to_writer(cert_file, &to_store).or_unexpected_while("writing cert to file")
|
|
||||||
}
|
|
||||||
.map_unexpected_while(|| format!("path is {}", path.display()))
|
|
||||||
}
|
|
||||||
|
|
||||||
fn get_certificate(
|
|
||||||
&self,
|
|
||||||
domain: &str,
|
|
||||||
) -> Result<(PrivateKey, Vec<Certificate>), GetCertificateError> {
|
|
||||||
let path = self.certificate_path(domain);
|
|
||||||
{
|
|
||||||
let file = match util::open_file(path.as_path()).or_unexpected_while("opening_file")? {
|
|
||||||
Some(file) => file,
|
|
||||||
None => return Err(GetCertificateError::NotFound),
|
|
||||||
};
|
|
||||||
|
|
||||||
let stored: StoredPKeyCert =
|
|
||||||
serde_json::from_reader(file).or_unexpected_while("parsing json")?;
|
|
||||||
|
|
||||||
Ok::<(PrivateKey, Vec<Certificate>), unexpected::Error>((
|
|
||||||
stored.private_key,
|
|
||||||
stored.cert,
|
|
||||||
))
|
|
||||||
}
|
|
||||||
.map_unexpected_while(|| format!("path is {}", path.display()))
|
|
||||||
.map_err(|err| err.into())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(test)]
|
|
||||||
mod tests {
|
|
||||||
use super::*;
|
|
||||||
use crate::domain::tls;
|
|
||||||
use tempdir::TempDir;
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn account_key() {
|
|
||||||
let tmp_dir = TempDir::new("domain_acme_store_account_key").unwrap();
|
|
||||||
let store = FSStore::new(tmp_dir.path()).expect("store created");
|
|
||||||
|
|
||||||
assert!(matches!(
|
|
||||||
store.get_account_key(),
|
|
||||||
Err::<PrivateKey, GetAccountKeyError>(GetAccountKeyError::NotFound)
|
|
||||||
));
|
|
||||||
|
|
||||||
let k = tls::PrivateKey::new();
|
|
||||||
|
|
||||||
store.set_account_key(&k).expect("account private key set");
|
|
||||||
|
|
||||||
assert_eq!(
|
|
||||||
k,
|
|
||||||
store
|
|
||||||
.get_account_key()
|
|
||||||
.expect("account private key retrieved")
|
|
||||||
);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
70
src/domain/acme/store/direct_fs_store.rs
Normal file
70
src/domain/acme/store/direct_fs_store.rs
Normal file
@ -0,0 +1,70 @@
|
|||||||
|
use std::{fs, path};
|
||||||
|
|
||||||
|
use crate::domain::tls::{CertificateChain, PrivateKey};
|
||||||
|
use crate::error::unexpected::{self, Mappable};
|
||||||
|
use crate::util;
|
||||||
|
|
||||||
|
pub struct DirectFSStore {
|
||||||
|
key_file_path: path::PathBuf,
|
||||||
|
cert_file_path: path::PathBuf,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl DirectFSStore {
|
||||||
|
pub fn new( key_file_path: &path::Path, cert_file_path: &path::Path,) -> Self {
|
||||||
|
Self {
|
||||||
|
key_file_path: key_file_path.into(),
|
||||||
|
cert_file_path: cert_file_path.into(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl super::Store for DirectFSStore {
|
||||||
|
fn set_certificate(
|
||||||
|
&self,
|
||||||
|
_domain: &str,
|
||||||
|
key: PrivateKey,
|
||||||
|
cert: CertificateChain,
|
||||||
|
) -> unexpected::Result<()> {
|
||||||
|
fs::write(&self.key_file_path, key.to_string()).map_unexpected_while(|| {
|
||||||
|
format!("writing private key to {}", &self.key_file_path.display())
|
||||||
|
})?;
|
||||||
|
|
||||||
|
fs::write(&self.cert_file_path, cert.to_string()).map_unexpected_while(|| {
|
||||||
|
format!("writing certificate to {}", &self.cert_file_path.display())
|
||||||
|
})?;
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn get_certificate(
|
||||||
|
&self,
|
||||||
|
_domain: &str,
|
||||||
|
) -> unexpected::Result<Option<(PrivateKey, CertificateChain)>> {
|
||||||
|
let key: Option<PrivateKey> =
|
||||||
|
util::parse_file(&self.key_file_path).map_unexpected_while(|| {
|
||||||
|
format!("reading private key from {}", &self.key_file_path.display())
|
||||||
|
})?;
|
||||||
|
|
||||||
|
let certs: Option<CertificateChain> = util::parse_file(&self.cert_file_path)
|
||||||
|
.map_unexpected_while(|| {
|
||||||
|
format!(
|
||||||
|
"reading certificate from {}",
|
||||||
|
&self.cert_file_path.display()
|
||||||
|
)
|
||||||
|
})?;
|
||||||
|
|
||||||
|
if key.is_none() != certs.is_none() {
|
||||||
|
}
|
||||||
|
|
||||||
|
match (key, certs) {
|
||||||
|
(None, None) => Ok(None),
|
||||||
|
(Some(key), Some(certs)) => Ok(Some((key, certs))),
|
||||||
|
_ =>
|
||||||
|
Err(unexpected::Error::from(format!(
|
||||||
|
"private key file {} and cert file {} are in inconsistent state, one exists but the other doesn't",
|
||||||
|
&self.key_file_path.display(),
|
||||||
|
&self.cert_file_path.display(),
|
||||||
|
).as_str()))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
78
src/domain/acme/store/json_fs_store.rs
Normal file
78
src/domain/acme/store/json_fs_store.rs
Normal file
@ -0,0 +1,78 @@
|
|||||||
|
use std::{fs, path};
|
||||||
|
|
||||||
|
use crate::domain::tls::{Certificate, CertificateChain, PrivateKey};
|
||||||
|
use crate::error::unexpected::{self, Mappable};
|
||||||
|
use crate::util;
|
||||||
|
|
||||||
|
use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
|
#[derive(Debug, Serialize, Deserialize)]
|
||||||
|
struct StoredPKeyCert {
|
||||||
|
private_key: PrivateKey,
|
||||||
|
cert: Vec<Certificate>,
|
||||||
|
}
|
||||||
|
|
||||||
|
pub struct JSONFSStore {
|
||||||
|
dir_path: path::PathBuf,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl JSONFSStore {
|
||||||
|
pub fn new(dir_path: &path::Path) -> unexpected::Result<Self> {
|
||||||
|
fs::create_dir_all(dir_path).or_unexpected()?;
|
||||||
|
Ok(Self {
|
||||||
|
dir_path: dir_path.into(),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
fn certificate_path(&self, domain: &str) -> path::PathBuf {
|
||||||
|
let mut domain = domain.to_string();
|
||||||
|
domain.push_str(".json");
|
||||||
|
|
||||||
|
self.dir_path.join(domain)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl super::Store for JSONFSStore {
|
||||||
|
fn set_certificate(
|
||||||
|
&self,
|
||||||
|
domain: &str,
|
||||||
|
key: PrivateKey,
|
||||||
|
certs: CertificateChain,
|
||||||
|
) -> Result<(), unexpected::Error> {
|
||||||
|
let to_store = StoredPKeyCert {
|
||||||
|
private_key: key,
|
||||||
|
cert: certs.into(),
|
||||||
|
};
|
||||||
|
|
||||||
|
let path = self.certificate_path(domain);
|
||||||
|
{
|
||||||
|
let cert_file =
|
||||||
|
fs::File::create(path.as_path()).or_unexpected_while("creating file")?;
|
||||||
|
serde_json::to_writer(cert_file, &to_store).or_unexpected_while("writing cert to file")
|
||||||
|
}
|
||||||
|
.map_unexpected_while(|| format!("path is {}", path.display()))
|
||||||
|
}
|
||||||
|
|
||||||
|
fn get_certificate(
|
||||||
|
&self,
|
||||||
|
domain: &str,
|
||||||
|
) -> unexpected::Result<Option<(PrivateKey, CertificateChain)>> {
|
||||||
|
let path = self.certificate_path(domain);
|
||||||
|
{
|
||||||
|
let file = match util::open_file(path.as_path()).or_unexpected_while("opening_file")? {
|
||||||
|
Some(file) => file,
|
||||||
|
None => return Ok(None),
|
||||||
|
};
|
||||||
|
|
||||||
|
let stored: StoredPKeyCert =
|
||||||
|
serde_json::from_reader(file).or_unexpected_while("parsing json")?;
|
||||||
|
|
||||||
|
unexpected::Result::<Option<(PrivateKey, CertificateChain)>>::Ok(Some((
|
||||||
|
stored.private_key,
|
||||||
|
stored.cert.into(),
|
||||||
|
)))
|
||||||
|
}
|
||||||
|
.map_unexpected_while(|| format!("path is {}", path.display()))
|
||||||
|
.map_err(|err| err.into())
|
||||||
|
}
|
||||||
|
}
|
@ -58,6 +58,13 @@ pub struct ConfigProxiedDomain {
|
|||||||
pub https_disabled: bool,
|
pub https_disabled: bool,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[serde_as]
|
||||||
|
#[derive(Clone, Deserialize, Serialize)]
|
||||||
|
pub struct ConfigExternalDomain {
|
||||||
|
pub tls_key_path: path::PathBuf,
|
||||||
|
pub tls_cert_path: path::PathBuf,
|
||||||
|
}
|
||||||
|
|
||||||
#[derive(Clone, Deserialize, Serialize)]
|
#[derive(Clone, Deserialize, Serialize)]
|
||||||
pub struct Config {
|
pub struct Config {
|
||||||
pub store_dir_path: path::PathBuf,
|
pub store_dir_path: path::PathBuf,
|
||||||
@ -73,4 +80,7 @@ pub struct Config {
|
|||||||
|
|
||||||
#[serde(default = "default_interface_domain")]
|
#[serde(default = "default_interface_domain")]
|
||||||
pub interface_domain: Option<domain::Name>,
|
pub interface_domain: Option<domain::Name>,
|
||||||
|
|
||||||
|
#[serde(default)]
|
||||||
|
pub external_domains: collections::HashMap<domain::Name, ConfigExternalDomain>,
|
||||||
}
|
}
|
||||||
|
@ -10,6 +10,7 @@ pub enum GetSettingsResult {
|
|||||||
Builtin(domain::config::ConfigBuiltinDomain),
|
Builtin(domain::config::ConfigBuiltinDomain),
|
||||||
Proxied(domain::config::ConfigProxiedDomain),
|
Proxied(domain::config::ConfigProxiedDomain),
|
||||||
Interface,
|
Interface,
|
||||||
|
External(domain::config::ConfigExternalDomain),
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(thiserror::Error, Debug)]
|
#[derive(thiserror::Error, Debug)]
|
||||||
@ -222,7 +223,22 @@ impl ManagerImpl {
|
|||||||
async fn sync_domain_https_cert(&self, domain: &domain::Name) -> unexpected::Result<()> {
|
async fn sync_domain_https_cert(&self, domain: &domain::Name) -> unexpected::Result<()> {
|
||||||
if let Some(ref acme_manager) = self.acme_manager {
|
if let Some(ref acme_manager) = self.acme_manager {
|
||||||
log::info!("Syncing HTTPS certificate for domain {domain}");
|
log::info!("Syncing HTTPS certificate for domain {domain}");
|
||||||
acme_manager.sync_domain(domain.clone()).await?;
|
acme_manager.sync_domain(domain.clone(), None).await?;
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn sync_external_domain(
|
||||||
|
&self,
|
||||||
|
domain: &domain::Name,
|
||||||
|
config: &domain::ConfigExternalDomain,
|
||||||
|
) -> unexpected::Result<()> {
|
||||||
|
if let Some(ref acme_manager) = self.acme_manager {
|
||||||
|
log::info!("Syncing HTTPS certificate for external domain {domain}");
|
||||||
|
acme_manager
|
||||||
|
.sync_domain(domain.clone(), Some(config.clone()))
|
||||||
|
.await?;
|
||||||
}
|
}
|
||||||
|
|
||||||
Ok(())
|
Ok(())
|
||||||
@ -247,6 +263,14 @@ impl ManagerImpl {
|
|||||||
GetSettingsResult::Proxied(config) => (None, !config.https_disabled, false),
|
GetSettingsResult::Proxied(config) => (None, !config.https_disabled, false),
|
||||||
|
|
||||||
GetSettingsResult::Interface => (None, true, false),
|
GetSettingsResult::Interface => (None, true, false),
|
||||||
|
|
||||||
|
// External domains do their own thing, separate from the rest of this flow.
|
||||||
|
GetSettingsResult::External(config) => {
|
||||||
|
self.sync_external_domain(&domain, &config)
|
||||||
|
.await
|
||||||
|
.map_unexpected_while(|| format!("syncing external domain {domain}"))?;
|
||||||
|
continue;
|
||||||
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
if let Some(settings) = settings {
|
if let Some(settings) = settings {
|
||||||
@ -301,6 +325,10 @@ impl Manager for ManagerImpl {
|
|||||||
return Ok(GetSettingsResult::Proxied(config.clone()));
|
return Ok(GetSettingsResult::Proxied(config.clone()));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if let Some(config) = self.config.external_domains.get(domain) {
|
||||||
|
return Ok(GetSettingsResult::External(config.clone()));
|
||||||
|
}
|
||||||
|
|
||||||
Ok(GetSettingsResult::Stored(self.domain_store.get(domain)?))
|
Ok(GetSettingsResult::Stored(self.domain_store.get(domain)?))
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -322,6 +350,9 @@ impl Manager for ManagerImpl {
|
|||||||
unexpected::Error::from("can't call get_file on interface domain").into(),
|
unexpected::Error::from("can't call get_file on interface domain").into(),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
GetSettingsResult::External(_) => {
|
||||||
|
return Err(GetFileError::DomainNotFound);
|
||||||
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
let path = settings.process_path(path);
|
let path = settings.process_path(path);
|
||||||
@ -342,8 +373,9 @@ impl Manager for ManagerImpl {
|
|||||||
let is_interface = Some(&domain) == self.config.interface_domain.as_ref();
|
let is_interface = Some(&domain) == self.config.interface_domain.as_ref();
|
||||||
let is_builtin = self.config.builtin_domains.contains_key(&domain);
|
let is_builtin = self.config.builtin_domains.contains_key(&domain);
|
||||||
let is_proxied = self.config.proxied_domains.contains_key(&domain);
|
let is_proxied = self.config.proxied_domains.contains_key(&domain);
|
||||||
|
let is_external = self.config.external_domains.contains_key(&domain);
|
||||||
|
|
||||||
if is_interface || is_builtin || is_proxied {
|
if is_interface || is_builtin || is_proxied || is_external {
|
||||||
return Err(SyncWithSettingsError::NotModifiable);
|
return Err(SyncWithSettingsError::NotModifiable);
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -422,6 +454,15 @@ impl Manager for ManagerImpl {
|
|||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
self.config
|
||||||
|
.external_domains
|
||||||
|
.iter()
|
||||||
|
.map(|(domain, _)| ManagedDomain {
|
||||||
|
domain: domain.clone(),
|
||||||
|
public: false,
|
||||||
|
})
|
||||||
|
.collect_into(&mut res);
|
||||||
|
|
||||||
Ok(res)
|
Ok(res)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -442,12 +483,12 @@ impl rustls::server::ResolvesServerCert for HttpsCertResolver {
|
|||||||
let domain = client_hello.server_name()?;
|
let domain = client_hello.server_name()?;
|
||||||
|
|
||||||
match (self.0).acme_manager.as_ref()?.get_certificate(domain) {
|
match (self.0).acme_manager.as_ref()?.get_certificate(domain) {
|
||||||
Err(acme::manager::GetCertificateError::NotFound) => {
|
Err(err) => Err(err),
|
||||||
|
Ok(None) => {
|
||||||
log::warn!("No cert found for domain {domain}");
|
log::warn!("No cert found for domain {domain}");
|
||||||
Ok(None)
|
Ok(None)
|
||||||
}
|
}
|
||||||
Err(acme::manager::GetCertificateError::Unexpected(err)) => Err(err),
|
Ok(Some((key, cert))) => {
|
||||||
Ok((key, cert)) => {
|
|
||||||
match rustls::sign::any_supported_type(&key.into()).or_unexpected() {
|
match rustls::sign::any_supported_type(&key.into()).or_unexpected() {
|
||||||
Err(err) => Err(err),
|
Err(err) => Err(err),
|
||||||
Ok(key) => Ok(Some(sync::Arc::new(rustls::sign::CertifiedKey {
|
Ok(key) => Ok(Some(sync::Arc::new(rustls::sign::CertifiedKey {
|
||||||
|
@ -2,4 +2,4 @@ mod private_key;
|
|||||||
pub use self::private_key::PrivateKey;
|
pub use self::private_key::PrivateKey;
|
||||||
|
|
||||||
mod certificate;
|
mod certificate;
|
||||||
pub use self::certificate::Certificate;
|
pub use self::certificate::{Certificate, CertificateChain};
|
||||||
|
@ -113,3 +113,47 @@ impl From<Certificate> for rustls::Certificate {
|
|||||||
rustls::Certificate(c.0)
|
rustls::Certificate(c.0)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub struct CertificateChain(Vec<Certificate>);
|
||||||
|
|
||||||
|
impl FromStr for CertificateChain {
|
||||||
|
type Err = pem::PemError;
|
||||||
|
|
||||||
|
fn from_str(s: &str) -> Result<Self, Self::Err> {
|
||||||
|
Ok(CertificateChain(
|
||||||
|
pem::parse_many(s)?
|
||||||
|
.into_iter()
|
||||||
|
.map(|s| Certificate(s.into_contents()))
|
||||||
|
.collect(),
|
||||||
|
))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl fmt::Display for CertificateChain {
|
||||||
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
||||||
|
for cert in &self.0 {
|
||||||
|
pem::Pem::new("CERTIFICATE", cert.0.clone()).fmt(f)?;
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl From<CertificateChain> for Vec<Certificate> {
|
||||||
|
fn from(c: CertificateChain) -> Self {
|
||||||
|
c.0
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl From<Vec<Certificate>> for CertificateChain {
|
||||||
|
fn from(v: Vec<Certificate>) -> Self {
|
||||||
|
Self(v)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl std::iter::IntoIterator for CertificateChain {
|
||||||
|
type Item = Certificate;
|
||||||
|
type IntoIter = std::vec::IntoIter<Self::Item>;
|
||||||
|
fn into_iter(self) -> Self::IntoIter {
|
||||||
|
self.0.into_iter()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
35
src/main.rs
35
src/main.rs
@ -77,6 +77,10 @@ async fn main() {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if config.domain.external_domains.len() > 0 && config.service.http.https_addr.is_none() {
|
||||||
|
panic!("https must be enabled to use external_domains")
|
||||||
|
}
|
||||||
|
|
||||||
config
|
config
|
||||||
};
|
};
|
||||||
|
|
||||||
@ -109,14 +113,39 @@ async fn main() {
|
|||||||
.clone()
|
.clone()
|
||||||
.expect("acme configuration must be set if https is enabled");
|
.expect("acme configuration must be set if https is enabled");
|
||||||
|
|
||||||
let domain_acme_store =
|
let acme_dir_path = config.domain.store_dir_path.join("acme");
|
||||||
domani::domain::acme::store::FSStore::new(&config.domain.store_dir_path.join("acme"))
|
|
||||||
.expect("domain acme store initialization failed");
|
let domain_acme_store = {
|
||||||
|
let dir_path = acme_dir_path.join("certificates");
|
||||||
|
domani::domain::acme::store::JSONFSStore::new(&dir_path).unwrap_or_else(|e| {
|
||||||
|
panic!(
|
||||||
|
"failed to initialize acme cert store at {}: {e}",
|
||||||
|
dir_path.display()
|
||||||
|
)
|
||||||
|
})
|
||||||
|
};
|
||||||
|
|
||||||
|
let domain_acme_account_key_store = domani::domain::acme::account_key_store::FSStore::new(
|
||||||
|
&acme_dir_path,
|
||||||
|
)
|
||||||
|
.unwrap_or_else(|e| {
|
||||||
|
panic!(
|
||||||
|
"failed to initialize account key store at {}: {e}",
|
||||||
|
acme_dir_path.display()
|
||||||
|
)
|
||||||
|
});
|
||||||
|
|
||||||
Some(
|
Some(
|
||||||
domani::domain::acme::manager::ManagerImpl::new(
|
domani::domain::acme::manager::ManagerImpl::new(
|
||||||
domain_acme_store,
|
domain_acme_store,
|
||||||
domani::token::MemStore::new(),
|
domani::token::MemStore::new(),
|
||||||
|
domain_acme_account_key_store,
|
||||||
|
|config| {
|
||||||
|
Ok(Box::from(domani::domain::acme::store::DirectFSStore::new(
|
||||||
|
&config.tls_key_path,
|
||||||
|
&config.tls_cert_path,
|
||||||
|
)))
|
||||||
|
},
|
||||||
&acme_config,
|
&acme_config,
|
||||||
)
|
)
|
||||||
.await
|
.await
|
||||||
|
@ -238,6 +238,7 @@ impl Service {
|
|||||||
}
|
}
|
||||||
Ok(domain::manager::GetSettingsResult::Proxied(_)) => None,
|
Ok(domain::manager::GetSettingsResult::Proxied(_)) => None,
|
||||||
Ok(domain::manager::GetSettingsResult::Interface) => None,
|
Ok(domain::manager::GetSettingsResult::Interface) => None,
|
||||||
|
Ok(domain::manager::GetSettingsResult::External(_)) => None,
|
||||||
Err(domain::manager::GetSettingsError::NotFound) => None,
|
Err(domain::manager::GetSettingsError::NotFound) => None,
|
||||||
Err(domain::manager::GetSettingsError::Unexpected(e)) => {
|
Err(domain::manager::GetSettingsError::Unexpected(e)) => {
|
||||||
return self.internal_error(
|
return self.internal_error(
|
||||||
|
21
src/util.rs
21
src/util.rs
@ -10,6 +10,27 @@ pub fn open_file(path: &path::Path) -> io::Result<Option<fs::File>> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[derive(thiserror::Error, Debug)]
|
||||||
|
pub enum ParseFileError<ParseError> {
|
||||||
|
#[error("io error: {0}")]
|
||||||
|
IO(io::Error),
|
||||||
|
|
||||||
|
#[error("parse error")]
|
||||||
|
FromStr(ParseError),
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn parse_file<T: std::str::FromStr>(
|
||||||
|
path: &path::Path,
|
||||||
|
) -> Result<Option<T>, ParseFileError<T::Err>> {
|
||||||
|
match fs::read_to_string(path) {
|
||||||
|
Ok(s) => Ok(Some(s.parse().map_err(|e| ParseFileError::FromStr(e))?)),
|
||||||
|
Err(err) => match err.kind() {
|
||||||
|
io::ErrorKind::NotFound => Ok(None),
|
||||||
|
_ => Err(ParseFileError::IO(err)),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
pub type BoxByteStream = futures::stream::BoxStream<'static, io::Result<bytes::Bytes>>;
|
pub type BoxByteStream = futures::stream::BoxStream<'static, io::Result<bytes::Bytes>>;
|
||||||
|
|
||||||
pub type BoxFuture<'a, O> = pin::Pin<Box<dyn futures::Future<Output = O> + Send + 'a>>;
|
pub type BoxFuture<'a, O> = pin::Pin<Box<dyn futures::Future<Output = O> + Send + 'a>>;
|
||||||
|
Loading…
Reference in New Issue
Block a user