Merge pull request 'Fix the findings of the pre-review check' (#27) from fix/review-findings into main
This commit is contained in:
commit
8184f5aefc
43 changed files with 2842 additions and 148 deletions
|
|
@ -21,3 +21,12 @@ jobs:
|
|||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- run: make admin-ci
|
||||
|
||||
# Separate job: a vulnerability published tomorrow must not make an unrelated change look broken,
|
||||
# but it should be visible.
|
||||
vuln:
|
||||
runs-on: docker
|
||||
container: golang:1.27
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- run: make vuln
|
||||
|
|
|
|||
674
LICENSE
Normal file
674
LICENSE
Normal file
|
|
@ -0,0 +1,674 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 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 General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
15
Makefile
15
Makefile
|
|
@ -1,4 +1,4 @@
|
|||
.PHONY: all admin test build e2e clean fmt-check go-ci admin-ci ci
|
||||
.PHONY: all admin test build e2e scale clean fmt-check lint vuln go-ci admin-ci ci
|
||||
|
||||
all: admin build
|
||||
|
||||
|
|
@ -17,7 +17,14 @@ test:
|
|||
fmt-check:
|
||||
@unformatted="$$(gofmt -l .)"; if [ -n "$$unformatted" ]; then echo "gofmt needed:"; echo "$$unformatted"; exit 1; fi
|
||||
|
||||
go-ci: fmt-check
|
||||
lint:
|
||||
go run honnef.co/go/tools/cmd/staticcheck@v0.8.2 ./...
|
||||
|
||||
# Known vulnerabilities in the Go standard library and dependencies, only for code the project calls.
|
||||
vuln:
|
||||
go run golang.org/x/vuln/cmd/govulncheck@latest ./...
|
||||
|
||||
go-ci: fmt-check lint
|
||||
go vet ./...
|
||||
go test -race -count=1 ./...
|
||||
|
||||
|
|
@ -31,6 +38,10 @@ ci: go-ci admin-ci build
|
|||
e2e:
|
||||
go test -tags e2e -count=1 -timeout 15m -v ./e2e
|
||||
|
||||
# How the daemon behaves with a 10000-member list and a 50000-message archive (prints timings).
|
||||
scale:
|
||||
go test -tags scale -count=1 -timeout 30m -v ./scale
|
||||
|
||||
clean:
|
||||
rm -f parsimony
|
||||
node admin/scripts/clean.mjs
|
||||
|
|
|
|||
61
README.md
61
README.md
|
|
@ -36,7 +36,7 @@ Three listeners, each configurable:
|
|||
|
||||
| Listener | Default | Purpose |
|
||||
|----------|---------|---------|
|
||||
| `lmtp` | `127.0.0.1:2424` | mail from Postfix |
|
||||
| `lmtp` | `127.0.0.1:2424` | mail from Postfix; **no authentication**, see Security notes |
|
||||
| `api` | `127.0.0.1:8080` | admin REST API, bearer token |
|
||||
| `web` | `127.0.0.1:8081` | public archive and unsubscribe pages (`""` disables) |
|
||||
|
||||
|
|
@ -133,10 +133,11 @@ docker build -t parsimony .
|
|||
docker run -d --name parsimony --read-only --cap-drop ALL \
|
||||
-v parsimony-data:/data \
|
||||
-v $PWD/parsimony.yaml:/etc/parsimony/parsimony.yaml:ro \
|
||||
-e PARSIMONY_API_TOKEN=... -p 2424:2424 -p 8080:8080 -p 8081:8081 parsimony
|
||||
-e PARSIMONY_API_TOKEN=... -p 127.0.0.1:8080:8080 -p 8081:8081 parsimony
|
||||
```
|
||||
|
||||
Use `db: /data/parsimony.db` in the config. A new named volume gets the right ownership by itself;
|
||||
Use `db: /data/parsimony.db` in the config. Do not publish the LMTP port (2424): Postfix reaches it over a Docker network
|
||||
shared with the container, and `lmtp.allow` should list that network's range (see Security notes). A new named volume gets the right ownership by itself;
|
||||
for a bind mount, make the host directory writable by uid 65532.
|
||||
|
||||
## Delivery and the queue
|
||||
|
|
@ -145,8 +146,11 @@ LMTP answers `250` when the post is in the queue, so a down relay never bounces
|
|||
It answers `451` only when the database itself fails.
|
||||
|
||||
- Temporary relay errors (4xx, timeouts, connection failures) are retried with backoff.
|
||||
- A permanent rejection (5xx) drops that delivery. Only a bad-mailbox reply (`5.1.x`) counts as a hard
|
||||
bounce for the member; errors such as "relay access denied" never disable members.
|
||||
- A permanent rejection of the message by the relay (5xx: policy, size, line length...) is never retried, but the
|
||||
delivery is not made to vanish: it is kept as **failed**, with the reason, for a week (queue API, `parsimony queue ls`,
|
||||
the Queue page; discard it to clear it). The same happens when a delivery is still failing after 3 days.
|
||||
- A bad-mailbox reply (`5.1.x`, the address does not exist) drops the delivery and counts as a hard bounce for the
|
||||
member (3 disable it). Other errors, such as "relay access denied", never disable members.
|
||||
- Delivery is at-least-once: a crash between the relay accepting a message and the queue entry being
|
||||
removed can send one message to one recipient twice.
|
||||
- `GET /api/v1/queue` and the Queue page show what is pending or failing, and a stuck delivery can be discarded.
|
||||
|
|
@ -193,3 +197,50 @@ transport_maps = hash:/etc/postfix/transport
|
|||
# /etc/postfix/transport
|
||||
lists.example.org lmtp:inet:127.0.0.1:2424
|
||||
```
|
||||
|
||||
## Security notes
|
||||
|
||||
- **LMTP has no authentication.** Whoever can connect to it can send mail as any member. Keep it on `127.0.0.1`, on a
|
||||
private network, or on a unix socket, and list the clients that may connect:
|
||||
|
||||
```yaml
|
||||
lmtp:
|
||||
addr: 0.0.0.0:2424
|
||||
allow: [172.16.0.0/12] # CIDR ranges or single addresses; other clients are dropped before the greeting
|
||||
```
|
||||
|
||||
The daemon logs a warning at startup when LMTP is reachable beyond the machine and `lmtp.allow` is empty.
|
||||
`allow` does not apply to unix sockets: use the permissions of the socket file.
|
||||
- **Who is posting.** A post is accepted when the SMTP sender is a member *and* the `From` header names the same
|
||||
address. The SMTP sender can be forged by anyone who can send mail to your MX, and the archive, the rewritten `From`
|
||||
and `Reply-To` come from the header; so a post whose header names someone else (or has no usable `From`, or several
|
||||
addresses) is held for moderation instead of delivered, with the reason shown to the admin (API, CLI, UI). Let Postfix
|
||||
reject forged senders too (SPF, DKIM, DMARC checks on inbound mail).
|
||||
- **API token.** `parsimony serve` refuses a token shorter than 24 characters or containing whitespace
|
||||
(`openssl rand -hex 24` makes a good one). After 10 wrong or missing tokens within 5 minutes an address is
|
||||
locked out for 5 minutes (HTTP 429, valid token included). The address is the TCP peer: behind a reverse proxy
|
||||
every client shares the proxy's address, so rate-limit at the proxy as well.
|
||||
- The API and the admin UI use one bearer token and no TLS: put them behind a reverse proxy with TLS and keep the `api`
|
||||
listener private.
|
||||
|
||||
## Scale
|
||||
|
||||
Measured on one machine with `make scale` (SQLite file on a local disk, relay on localhost; your numbers will differ):
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
| Queue a post for a 10 001-member list (one transaction) | 0.12 s |
|
||||
| Send it through a local relay, 4 deliveries at a time | about 460 messages/s (22 s for the whole list) |
|
||||
| Import a 50 000-message mbox (14 MiB) | 2.9 s, about 17 000 messages/s |
|
||||
| Search a 50 000-message archive (one page of 25) | 6 to 15 ms |
|
||||
| Open page 1 000 of the archive, read a thread | about 4 ms, about 9 ms |
|
||||
| Subscribe members one at a time (`member add`, no batching) | about 1.9 ms each at the store, plus one HTTP request |
|
||||
|
||||
Sending is bounded by the SMTP round trips to your relay: raise `relay.concurrency` for big lists.
|
||||
|
||||
## Licence
|
||||
|
||||
Parsimony is free software, released under the GNU General Public License, version 3 or (at your option) any later
|
||||
version. See [LICENSE](LICENSE). The components in `admin/src/components/ui` come from shadcn/ui (MIT); the Go
|
||||
dependencies (go-smtp, go-message, go-msgauth, modernc.org/sqlite, yaml.v3) use MIT, BSD or Apache 2.0 licences, which are
|
||||
compatible with the GPL.
|
||||
|
|
|
|||
218
admin/package-lock.json
generated
218
admin/package-lock.json
generated
File diff suppressed because it is too large
Load diff
|
|
@ -23,7 +23,6 @@
|
|||
"react": "^19.3.1",
|
||||
"react-dom": "^19.3.1",
|
||||
"react-router": "^8.5.1",
|
||||
"shadcn": "^4.23.0",
|
||||
"sonner": "^2.0.8",
|
||||
"tailwind-merge": "^3.7.0",
|
||||
"tailwindcss": "^4.3.5",
|
||||
|
|
@ -40,8 +39,10 @@
|
|||
"@vitejs/plugin-react": "^6.1.2",
|
||||
"jsdom": "^31.0.0",
|
||||
"oxlint": "^1.90.0",
|
||||
"shadcn": "^4.23.0",
|
||||
"typescript": "~7.0.2",
|
||||
"vite": "^8.3.6",
|
||||
"vitest": "^5.1.0"
|
||||
}
|
||||
},
|
||||
"license": "GPL-3.0-or-later"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -28,6 +28,8 @@ export interface Held {
|
|||
subject: string
|
||||
size: number
|
||||
created_at: string
|
||||
/** Why the message was held, for the admin. */
|
||||
reason: string
|
||||
}
|
||||
|
||||
export interface Message {
|
||||
|
|
@ -61,11 +63,14 @@ export interface QueueItem {
|
|||
last_error: string
|
||||
next_attempt: string
|
||||
created_at: string
|
||||
/** Given up for good: never retried, kept for a week so the admin can see it. */
|
||||
failed: boolean
|
||||
}
|
||||
|
||||
export interface Queue {
|
||||
pending: number
|
||||
retrying: number
|
||||
failed: number
|
||||
oldest: string | null
|
||||
items: QueueItem[]
|
||||
}
|
||||
|
|
|
|||
|
|
@ -50,7 +50,7 @@ describe('list page', () => {
|
|||
installFakeApi(
|
||||
newState({
|
||||
lists: [dev()],
|
||||
held: { 1: [{ id: 5, sender: 'a@x.com', subject: 's', size: 10, created_at: '2030-01-01T00:00:00Z' }] },
|
||||
held: { 1: [{ id: 5, sender: 'a@x.com', subject: 's', size: 10, created_at: '2030-01-01T00:00:00Z', reason: '' }] },
|
||||
}),
|
||||
)
|
||||
renderApp('/lists/1', { token: 'good' })
|
||||
|
|
|
|||
|
|
@ -11,6 +11,7 @@ const item = (id: number, over: Partial<QueueItem> = {}): QueueItem => ({
|
|||
last_error: '',
|
||||
next_attempt: '2030-01-02T03:04:05Z',
|
||||
created_at: '2030-01-01T00:00:00Z',
|
||||
failed: false,
|
||||
...over,
|
||||
})
|
||||
|
||||
|
|
@ -51,7 +52,7 @@ describe('queue page', () => {
|
|||
expect(within(fresh).getByText('—')).toBeInTheDocument()
|
||||
|
||||
expect(screen.getByText('Pending').nextElementSibling).toHaveTextContent('2')
|
||||
expect(screen.getByText('Retrying').nextElementSibling).toHaveTextContent('1')
|
||||
expect(screen.getByText('Retrying', { selector: 'div' }).nextElementSibling).toHaveTextContent('1')
|
||||
expect(screen.getByText('Oldest').nextElementSibling).toHaveTextContent('2030-01-01 00:00 UTC')
|
||||
})
|
||||
|
||||
|
|
@ -68,6 +69,26 @@ describe('queue page', () => {
|
|||
expect(screen.queryByText(/showing/i)).not.toBeInTheDocument()
|
||||
})
|
||||
|
||||
it('shows failed deliveries apart from pending ones, with the reason', async () => {
|
||||
await setup([
|
||||
item(1),
|
||||
item(2, { attempts: 2, last_error: 'connection refused' }),
|
||||
item(3, { attempts: 1, failed: true, last_error: 'refused by the relay: 554 policy rejection' }),
|
||||
])
|
||||
const failed = (await screen.findByText('user3@example.com')).closest('tr')!
|
||||
expect(within(failed).getByText('Failed')).toBeInTheDocument()
|
||||
expect(within(failed).getByText(/refused by the relay: 554 policy rejection/)).toBeInTheDocument()
|
||||
expect(within(failed).getByText('—', { selector: 'td' })).toBeInTheDocument() // never retried: no next attempt
|
||||
expect(within(screen.getByText('user2@example.com').closest('tr')!).getByText('Retrying')).toBeInTheDocument()
|
||||
expect(within(screen.getByText('user1@example.com').closest('tr')!).getByText('Waiting')).toBeInTheDocument()
|
||||
|
||||
expect(screen.getByText('Pending').nextElementSibling).toHaveTextContent('2')
|
||||
expect(screen.getByText('Retrying', { selector: 'div' }).nextElementSibling).toHaveTextContent('1')
|
||||
expect(screen.getByText('Failed', { selector: 'div' }).nextElementSibling).toHaveTextContent('1')
|
||||
const rows = screen.getAllByRole('row').slice(1).map((r) => r.textContent ?? '')
|
||||
expect(rows[0]).toContain('user3@example.com') // failed first
|
||||
})
|
||||
|
||||
it('refreshes on demand', async () => {
|
||||
const { user, state } = await setup([item(1)])
|
||||
await screen.findByText('user1@example.com')
|
||||
|
|
|
|||
|
|
@ -10,6 +10,7 @@ import {
|
|||
AlertDialogHeader,
|
||||
AlertDialogTitle,
|
||||
} from '@/components/ui/alert-dialog'
|
||||
import { Badge } from '@/components/ui/badge'
|
||||
import { Button } from '@/components/ui/button'
|
||||
import { Card, CardContent } from '@/components/ui/card'
|
||||
import { Table, TableBody, TableCell, TableHead, TableHeader, TableRow } from '@/components/ui/table'
|
||||
|
|
@ -38,9 +39,10 @@ export function QueuePage() {
|
|||
|
||||
{q && (
|
||||
<>
|
||||
<div className="grid gap-4 sm:grid-cols-3">
|
||||
<div className="grid gap-4 sm:grid-cols-4">
|
||||
<Stat label="Pending" value={String(q.pending)} />
|
||||
<Stat label="Retrying" value={String(q.retrying)} />
|
||||
<Stat label="Failed" value={String(q.failed)} />
|
||||
<Stat label="Oldest" value={q.oldest ? formatDate(q.oldest) : '—'} />
|
||||
</div>
|
||||
{q.items.length === 0 ? (
|
||||
|
|
@ -50,6 +52,7 @@ export function QueuePage() {
|
|||
<TableHeader>
|
||||
<TableRow>
|
||||
<TableHead>Recipient</TableHead>
|
||||
<TableHead>State</TableHead>
|
||||
<TableHead>Attempts</TableHead>
|
||||
<TableHead>Last error</TableHead>
|
||||
<TableHead>Next attempt</TableHead>
|
||||
|
|
@ -60,9 +63,18 @@ export function QueuePage() {
|
|||
{q.items.map((i) => (
|
||||
<TableRow key={i.id}>
|
||||
<TableCell className="font-medium">{i.recipient}</TableCell>
|
||||
<TableCell>
|
||||
{i.failed ? (
|
||||
<Badge variant="destructive">Failed</Badge>
|
||||
) : i.attempts > 0 ? (
|
||||
<Badge variant="secondary">Retrying</Badge>
|
||||
) : (
|
||||
<Badge variant="outline">Waiting</Badge>
|
||||
)}
|
||||
</TableCell>
|
||||
<TableCell>{i.attempts}</TableCell>
|
||||
<TableCell>{i.last_error || '—'}</TableCell>
|
||||
<TableCell>{formatDate(i.next_attempt)}</TableCell>
|
||||
<TableCell className="max-w-xs whitespace-normal">{i.last_error || '—'}</TableCell>
|
||||
<TableCell>{i.failed ? '—' : formatDate(i.next_attempt)}</TableCell>
|
||||
<TableCell className="text-right">
|
||||
<Button size="sm" variant="outline" onClick={() => setDiscarding(i)}>
|
||||
Discard
|
||||
|
|
|
|||
|
|
@ -10,6 +10,7 @@ const held = (id: number, over: Partial<Held> = {}): Held => ({
|
|||
subject: `Subject ${id}`,
|
||||
size: 2048,
|
||||
created_at: '2030-01-02T03:04:05Z',
|
||||
reason: 'the list is moderated',
|
||||
...over,
|
||||
})
|
||||
|
||||
|
|
@ -30,6 +31,21 @@ describe('held tab', () => {
|
|||
expect(screen.getByText('(no subject)')).toBeInTheDocument()
|
||||
})
|
||||
|
||||
it('tells the admin why each message was held', async () => {
|
||||
await setup([
|
||||
held(1),
|
||||
held(2, { reason: 'the From header does not match the sender of the message (From: bob@example.com)' }),
|
||||
held(3, { reason: '' }),
|
||||
])
|
||||
const one = (await screen.findByText('Subject 1')).closest('tr')!
|
||||
expect(within(one).getByText('the list is moderated')).toBeInTheDocument()
|
||||
const two = screen.getByText('Subject 2').closest('tr')!
|
||||
expect(within(two).getByText(/From header does not match the sender/)).toBeInTheDocument()
|
||||
const three = screen.getByText('Subject 3').closest('tr')!
|
||||
expect(within(three).getByText('—')).toBeInTheDocument() // messages held before this was recorded
|
||||
expect(screen.getByRole('columnheader', { name: /reason/i })).toBeInTheDocument()
|
||||
})
|
||||
|
||||
it('says nothing is waiting', async () => {
|
||||
await setup([])
|
||||
expect(await screen.findByText(/nothing is waiting/i)).toBeInTheDocument()
|
||||
|
|
|
|||
|
|
@ -63,6 +63,7 @@ export function HeldTab() {
|
|||
<TableHead>From</TableHead>
|
||||
<TableHead>Received</TableHead>
|
||||
<TableHead>Size</TableHead>
|
||||
<TableHead>Reason</TableHead>
|
||||
<TableHead className="text-right">Actions</TableHead>
|
||||
</TableRow>
|
||||
</TableHeader>
|
||||
|
|
@ -73,6 +74,7 @@ export function HeldTab() {
|
|||
<TableCell>{h.sender}</TableCell>
|
||||
<TableCell>{formatDate(h.created_at)}</TableCell>
|
||||
<TableCell>{formatBytes(h.size)}</TableCell>
|
||||
<TableCell className="max-w-xs whitespace-normal text-muted-foreground">{h.reason || '—'}</TableCell>
|
||||
<TableCell className="space-x-2 text-right">
|
||||
<Button size="sm" disabled={approve.isPending} onClick={() => approve.mutate(h)}>
|
||||
Approve
|
||||
|
|
|
|||
|
|
@ -71,10 +71,12 @@ export function installFakeApi(state: FakeState) {
|
|||
let m: RegExpMatchArray | null
|
||||
|
||||
if (path === '/queue' && method === 'GET') {
|
||||
const items = [...state.queue].sort((a, b) => b.attempts - a.attempts).slice(0, state.queueLimit)
|
||||
const retrying = state.queue.filter((i) => i.attempts > 0).length
|
||||
const oldest = state.queue.map((i) => i.created_at).sort()[0] ?? null
|
||||
return json(200, { pending: state.queue.length, retrying, oldest, items })
|
||||
const items = [...state.queue].sort((a, b) => Number(b.failed) - Number(a.failed) || b.attempts - a.attempts).slice(0, state.queueLimit)
|
||||
const waiting = state.queue.filter((i) => !i.failed)
|
||||
const retrying = waiting.filter((i) => i.attempts > 0).length
|
||||
const failed = state.queue.length - waiting.length
|
||||
const oldest = waiting.map((i) => i.created_at).sort()[0] ?? null
|
||||
return json(200, { pending: waiting.length, retrying, failed, oldest, items })
|
||||
}
|
||||
if ((m = path.match(/^\/queue\/(\d+)$/)) && method === 'DELETE') {
|
||||
const id = Number(m[1])
|
||||
|
|
|
|||
|
|
@ -44,6 +44,7 @@ components:
|
|||
last_error: {type: string}
|
||||
next_attempt: {type: string, format: date-time}
|
||||
created_at: {type: string, format: date-time}
|
||||
failed: {type: boolean, description: Given up for good (refused by the relay, or too old); never retried, listed for a week}
|
||||
Member:
|
||||
type: object
|
||||
properties:
|
||||
|
|
@ -264,7 +265,8 @@ paths:
|
|||
type: object
|
||||
properties:
|
||||
pending: {type: integer}
|
||||
retrying: {type: integer, description: Deliveries that failed at least once}
|
||||
retrying: {type: integer, description: Waiting deliveries that failed at least once}
|
||||
failed: {type: integer, description: Deliveries given up for good, kept for a week}
|
||||
oldest: {type: string, format: date-time, nullable: true}
|
||||
items: {type: array, items: {$ref: '#/components/schemas/QueueItem'}}
|
||||
/queue/{id}:
|
||||
|
|
|
|||
|
|
@ -34,7 +34,7 @@ import (
|
|||
)
|
||||
|
||||
const (
|
||||
token = "e2e-token"
|
||||
token = "e2e-token-0123456789-abcdefghij"
|
||||
domain = "lists.example.test"
|
||||
)
|
||||
|
||||
|
|
@ -108,6 +108,7 @@ base_url: %s
|
|||
lmtp:
|
||||
network: tcp
|
||||
addr: 0.0.0.0:2424
|
||||
allow: [10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16]
|
||||
relay:
|
||||
addr: postfix:25
|
||||
concurrency: 4
|
||||
|
|
|
|||
2
go.mod
2
go.mod
|
|
@ -1,6 +1,6 @@
|
|||
module codeberg.org/squidd/parsimony
|
||||
|
||||
go 1.27.1
|
||||
go 1.27.3
|
||||
|
||||
require (
|
||||
github.com/emersion/go-message v0.18.2
|
||||
|
|
|
|||
|
|
@ -28,13 +28,19 @@ type server struct {
|
|||
store *store.Store
|
||||
token string
|
||||
releaser Releaser
|
||||
lim *limiter
|
||||
}
|
||||
|
||||
// New returns the API handler. Every route except /api/v1/health needs
|
||||
// "Authorization: Bearer <token>". An empty token rejects all requests.
|
||||
// rel may be nil: approving held messages then answers 501.
|
||||
func New(s *store.Store, token string, rel Releaser) http.Handler {
|
||||
srv := &server{store: s, token: token, releaser: rel}
|
||||
return newHandler(s, token, rel, time.Now)
|
||||
}
|
||||
|
||||
// newHandler is New with an injectable clock for the tests.
|
||||
func newHandler(s *store.Store, token string, rel Releaser, now func() time.Time) http.Handler {
|
||||
srv := &server{store: s, token: token, releaser: rel, lim: newLimiter(now)}
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("GET /api/v1/health", func(w http.ResponseWriter, _ *http.Request) {
|
||||
writeJSON(w, http.StatusOK, map[string]string{"status": "ok"})
|
||||
|
|
@ -61,12 +67,20 @@ func New(s *store.Store, token string, rel Releaser) http.Handler {
|
|||
|
||||
func (s *server) auth(next http.HandlerFunc) http.Handler {
|
||||
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||
ip := clientIP(r)
|
||||
if wait, locked := s.lim.blocked(ip); locked {
|
||||
w.Header().Set("Retry-After", strconv.Itoa(int((wait+time.Second-1)/time.Second)))
|
||||
writeError(w, http.StatusTooManyRequests, "too many failed attempts, try again later")
|
||||
return
|
||||
}
|
||||
got, ok := strings.CutPrefix(r.Header.Get("Authorization"), "Bearer ")
|
||||
if !ok || s.token == "" || subtle.ConstantTimeCompare([]byte(got), []byte(s.token)) != 1 {
|
||||
s.lim.fail(ip)
|
||||
w.Header().Set("WWW-Authenticate", `Bearer realm="parsimony"`)
|
||||
writeError(w, http.StatusUnauthorized, "invalid or missing token")
|
||||
return
|
||||
}
|
||||
s.lim.succeed(ip)
|
||||
next(w, r)
|
||||
})
|
||||
}
|
||||
|
|
@ -338,6 +352,7 @@ type heldDTO struct {
|
|||
Subject string `json:"subject"`
|
||||
Size int `json:"size"`
|
||||
CreatedAt time.Time `json:"created_at"`
|
||||
Reason string `json:"reason"` // why the message was held
|
||||
}
|
||||
|
||||
func subjectOf(data []byte) string {
|
||||
|
|
@ -368,7 +383,7 @@ func (s *server) listHeld(w http.ResponseWriter, r *http.Request) {
|
|||
}
|
||||
out := make([]heldDTO, 0, len(hs))
|
||||
for _, h := range hs {
|
||||
out = append(out, heldDTO{ID: h.ID, Sender: h.Sender, Subject: subjectOf(h.Data), Size: len(h.Data), CreatedAt: h.CreatedAt})
|
||||
out = append(out, heldDTO{ID: h.ID, Sender: h.Sender, Subject: subjectOf(h.Data), Size: len(h.Data), CreatedAt: h.CreatedAt, Reason: h.Reason})
|
||||
}
|
||||
writeJSON(w, http.StatusOK, out)
|
||||
}
|
||||
|
|
@ -508,6 +523,7 @@ type queuedDTO struct {
|
|||
LastError string `json:"last_error"`
|
||||
NextAttempt time.Time `json:"next_attempt"`
|
||||
CreatedAt time.Time `json:"created_at"`
|
||||
Failed bool `json:"failed"` // given up for good: never retried
|
||||
}
|
||||
|
||||
func (s *server) getQueue(w http.ResponseWriter, _ *http.Request) {
|
||||
|
|
@ -524,14 +540,14 @@ func (s *server) getQueue(w http.ResponseWriter, _ *http.Request) {
|
|||
out := make([]queuedDTO, 0, len(items))
|
||||
for _, it := range items {
|
||||
out = append(out, queuedDTO{ID: it.ID, Recipient: it.Rcpt, Attempts: it.Attempts, LastError: it.LastError,
|
||||
NextAttempt: it.NextAt, CreatedAt: it.CreatedAt})
|
||||
NextAttempt: it.NextAt, CreatedAt: it.CreatedAt, Failed: it.Failed})
|
||||
}
|
||||
var oldest *time.Time
|
||||
if !st.Oldest.IsZero() {
|
||||
oldest = &st.Oldest
|
||||
}
|
||||
writeJSON(w, http.StatusOK, map[string]any{
|
||||
"pending": st.Pending, "retrying": st.Retrying, "oldest": oldest, "items": out,
|
||||
"pending": st.Pending, "retrying": st.Retrying, "failed": st.Failed, "oldest": oldest, "items": out,
|
||||
})
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -7,6 +7,7 @@ import (
|
|||
"fmt"
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strconv"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
|
@ -264,7 +265,7 @@ func heldServer(t *testing.T) (http.Handler, *store.Store, *fakeReleaser) {
|
|||
s, _ := store.Open(":memory:")
|
||||
t.Cleanup(func() { s.Close() })
|
||||
l, _ := s.CreateList("dev", "example.org", "Dev")
|
||||
s.HoldMessage(l.ID, "Bob@x.com", []byte("From: Bob <bob@x.com>\r\nSubject: Hello there\r\n\r\nbody"))
|
||||
s.HoldMessage(l.ID, "Bob@x.com", []byte("From: Bob <bob@x.com>\r\nSubject: Hello there\r\n\r\nbody"), "the list is moderated")
|
||||
rel := &fakeReleaser{}
|
||||
return New(s, token, rel), s, rel
|
||||
}
|
||||
|
|
@ -274,6 +275,7 @@ type heldJSON struct {
|
|||
Sender string `json:"sender"`
|
||||
Subject string `json:"subject"`
|
||||
Size int `json:"size"`
|
||||
Reason string `json:"reason"`
|
||||
}
|
||||
|
||||
func TestHeldQueueAPI(t *testing.T) {
|
||||
|
|
@ -282,7 +284,7 @@ func TestHeldQueueAPI(t *testing.T) {
|
|||
expect(t, rec, 200)
|
||||
var hs []heldJSON
|
||||
decode(t, rec, &hs)
|
||||
if len(hs) != 1 || hs[0].Sender != "bob@x.com" || hs[0].Subject != "Hello there" || hs[0].Size == 0 {
|
||||
if len(hs) != 1 || hs[0].Sender != "bob@x.com" || hs[0].Subject != "Hello there" || hs[0].Size == 0 || hs[0].Reason != "the list is moderated" {
|
||||
t.Fatalf("held: %+v", hs)
|
||||
}
|
||||
expect(t, do(t, h, "GET", "/api/v1/lists/99/held", "", true), 404)
|
||||
|
|
@ -447,6 +449,7 @@ func queueServer(t *testing.T) (http.Handler, *store.Store) {
|
|||
type queueJSON struct {
|
||||
Pending int `json:"pending"`
|
||||
Retrying int `json:"retrying"`
|
||||
Failed int `json:"failed"`
|
||||
Oldest *time.Time `json:"oldest"`
|
||||
Items []struct {
|
||||
ID int64 `json:"id"`
|
||||
|
|
@ -455,6 +458,7 @@ type queueJSON struct {
|
|||
LastError string `json:"last_error"`
|
||||
NextAttempt time.Time `json:"next_attempt"`
|
||||
CreatedAt time.Time `json:"created_at"`
|
||||
Failed bool `json:"failed"`
|
||||
} `json:"items"`
|
||||
}
|
||||
|
||||
|
|
@ -629,3 +633,24 @@ func TestArchiveImportStoppedByAReadErrorIsAnErrorResponse(t *testing.T) {
|
|||
t.Fatalf("the first message was complete and is kept, got %d", total)
|
||||
}
|
||||
}
|
||||
|
||||
func TestQueueShowsFailedDeliveriesApartFromPendingOnes(t *testing.T) {
|
||||
h, s := queueServer(t)
|
||||
s.Enqueue([]byte("x"), []store.NewOutbound{{From: "b@x.org", Rcpt: "a@x.com"}, {From: "b@x.org", Rcpt: "b@x.com"}, {From: "b@x.org", Rcpt: "c@x.com"}})
|
||||
due, _ := s.DueOutbox(10)
|
||||
s.FailOutbox(due[2].ID, "refused by the relay: 554 no")
|
||||
s.RetryOutbox(due[1].ID, time.Now().Add(time.Hour), "down")
|
||||
|
||||
var q queueJSON
|
||||
decode(t, do(t, h, "GET", "/api/v1/queue", "", true), &q)
|
||||
if q.Pending != 2 || q.Retrying != 1 || q.Failed != 1 || len(q.Items) != 3 {
|
||||
t.Fatalf("queue: %+v", q)
|
||||
}
|
||||
if !q.Items[0].Failed || q.Items[0].Recipient != "c@x.com" || q.Items[0].LastError != "refused by the relay: 554 no" {
|
||||
t.Fatalf("failed deliveries come first, with the reason: %+v", q.Items[0])
|
||||
}
|
||||
if q.Items[1].Failed || q.Items[2].Failed {
|
||||
t.Fatalf("only one failed: %+v", q.Items)
|
||||
}
|
||||
expect(t, do(t, h, "DELETE", "/api/v1/queue/"+strconv.FormatInt(due[2].ID, 10), "", true), 204)
|
||||
}
|
||||
|
|
|
|||
97
internal/api/limit.go
Normal file
97
internal/api/limit.go
Normal file
|
|
@ -0,0 +1,97 @@
|
|||
package api
|
||||
|
||||
import (
|
||||
"net"
|
||||
"net/http"
|
||||
"sync"
|
||||
"time"
|
||||
)
|
||||
|
||||
// Brute-force protection for the bearer token: after maxFailures wrong (or missing) tokens within
|
||||
// failureWindow, an address is locked out for lockout, valid token included.
|
||||
const (
|
||||
maxFailures = 10
|
||||
failureWindow = 5 * time.Minute
|
||||
lockout = 5 * time.Minute
|
||||
sweepEvery = time.Minute
|
||||
)
|
||||
|
||||
type attempts struct {
|
||||
count int
|
||||
first time.Time
|
||||
blockedUntil time.Time
|
||||
}
|
||||
|
||||
type limiter struct {
|
||||
mu sync.Mutex
|
||||
now func() time.Time
|
||||
byIP map[string]*attempts
|
||||
lastSweep time.Time
|
||||
}
|
||||
|
||||
func newLimiter(now func() time.Time) *limiter {
|
||||
return &limiter{now: now, byIP: map[string]*attempts{}, lastSweep: now()}
|
||||
}
|
||||
|
||||
// blocked reports whether ip is locked out and for how much longer.
|
||||
func (l *limiter) blocked(ip string) (time.Duration, bool) {
|
||||
l.mu.Lock()
|
||||
defer l.mu.Unlock()
|
||||
if e := l.byIP[ip]; e != nil {
|
||||
if wait := e.blockedUntil.Sub(l.now()); wait > 0 {
|
||||
return wait, true
|
||||
}
|
||||
}
|
||||
return 0, false
|
||||
}
|
||||
|
||||
func (l *limiter) fail(ip string) {
|
||||
l.mu.Lock()
|
||||
defer l.mu.Unlock()
|
||||
now := l.now()
|
||||
l.sweep(now)
|
||||
e := l.byIP[ip]
|
||||
if e == nil || now.Sub(e.first) > failureWindow {
|
||||
e = &attempts{first: now}
|
||||
l.byIP[ip] = e
|
||||
}
|
||||
e.count++
|
||||
if e.count >= maxFailures {
|
||||
e.blockedUntil = now.Add(lockout)
|
||||
}
|
||||
}
|
||||
|
||||
func (l *limiter) succeed(ip string) {
|
||||
l.mu.Lock()
|
||||
defer l.mu.Unlock()
|
||||
delete(l.byIP, ip)
|
||||
}
|
||||
|
||||
// sweep forgets addresses whose failures and lockout are over, so the map cannot grow forever.
|
||||
func (l *limiter) sweep(now time.Time) {
|
||||
if now.Sub(l.lastSweep) < sweepEvery {
|
||||
return
|
||||
}
|
||||
l.lastSweep = now
|
||||
for ip, e := range l.byIP {
|
||||
if now.Sub(e.first) > failureWindow && !now.Before(e.blockedUntil) {
|
||||
delete(l.byIP, ip)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func (l *limiter) size() int {
|
||||
l.mu.Lock()
|
||||
defer l.mu.Unlock()
|
||||
return len(l.byIP)
|
||||
}
|
||||
|
||||
// clientIP is the address of the TCP peer. X-Forwarded-For is deliberately ignored: anyone can
|
||||
// send it, so trusting it would let an attacker choose a fresh identity for every guess.
|
||||
func clientIP(r *http.Request) string {
|
||||
host, _, err := net.SplitHostPort(r.RemoteAddr)
|
||||
if err != nil {
|
||||
return r.RemoteAddr
|
||||
}
|
||||
return host
|
||||
}
|
||||
216
internal/api/limit_test.go
Normal file
216
internal/api/limit_test.go
Normal file
|
|
@ -0,0 +1,216 @@
|
|||
package api
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
"net/http/httptest"
|
||||
"strconv"
|
||||
"strings"
|
||||
"sync"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"codeberg.org/squidd/parsimony/internal/store"
|
||||
)
|
||||
|
||||
type clock struct {
|
||||
mu sync.Mutex
|
||||
t time.Time
|
||||
}
|
||||
|
||||
func (c *clock) now() time.Time {
|
||||
c.mu.Lock()
|
||||
defer c.mu.Unlock()
|
||||
return c.t
|
||||
}
|
||||
|
||||
func (c *clock) advance(d time.Duration) {
|
||||
c.mu.Lock()
|
||||
c.t = c.t.Add(d)
|
||||
c.mu.Unlock()
|
||||
}
|
||||
|
||||
func limited(t *testing.T) (http.Handler, *clock) {
|
||||
t.Helper()
|
||||
s, err := store.Open(":memory:")
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
t.Cleanup(func() { s.Close() })
|
||||
clk := &clock{t: time.Unix(2_000_000_000, 0)}
|
||||
return newHandler(s, token, nil, clk.now), clk
|
||||
}
|
||||
|
||||
func attempt(h http.Handler, ip, bearer string) *httptest.ResponseRecorder {
|
||||
req := httptest.NewRequest("GET", "/api/v1/lists", nil)
|
||||
req.RemoteAddr = ip + ":40000"
|
||||
if bearer != "" {
|
||||
req.Header.Set("Authorization", "Bearer "+bearer)
|
||||
}
|
||||
rec := httptest.NewRecorder()
|
||||
h.ServeHTTP(rec, req)
|
||||
return rec
|
||||
}
|
||||
|
||||
func TestTooManyWrongTokensLockTheAddressOut(t *testing.T) {
|
||||
h, _ := limited(t)
|
||||
for i := 0; i < maxFailures; i++ {
|
||||
if rec := attempt(h, "203.0.113.7", "wrong"+strconv.Itoa(i)); rec.Code != 401 {
|
||||
t.Fatalf("attempt %d: %d", i+1, rec.Code)
|
||||
}
|
||||
}
|
||||
rec := attempt(h, "203.0.113.7", token) // even the right token is refused while locked out
|
||||
if rec.Code != 429 {
|
||||
t.Fatalf("locked out: status %d", rec.Code)
|
||||
}
|
||||
secs, err := strconv.Atoi(rec.Header().Get("Retry-After"))
|
||||
if err != nil || secs < 1 || secs > int(lockout/time.Second) {
|
||||
t.Fatalf("Retry-After = %q", rec.Header().Get("Retry-After"))
|
||||
}
|
||||
if !strings.Contains(rec.Body.String(), "too many") {
|
||||
t.Fatalf("body: %s", rec.Body.String())
|
||||
}
|
||||
// Other addresses are not affected.
|
||||
if rec := attempt(h, "203.0.113.8", token); rec.Code != 200 {
|
||||
t.Fatalf("another address: %d", rec.Code)
|
||||
}
|
||||
}
|
||||
|
||||
func TestTheLockoutEnds(t *testing.T) {
|
||||
h, clk := limited(t)
|
||||
for i := 0; i < maxFailures; i++ {
|
||||
attempt(h, "203.0.113.7", "wrong")
|
||||
}
|
||||
clk.advance(lockout - time.Second)
|
||||
if rec := attempt(h, "203.0.113.7", token); rec.Code != 429 {
|
||||
t.Fatalf("still locked: %d", rec.Code)
|
||||
}
|
||||
clk.advance(2 * time.Second)
|
||||
if rec := attempt(h, "203.0.113.7", token); rec.Code != 200 {
|
||||
t.Fatalf("after the lockout: %d", rec.Code)
|
||||
}
|
||||
}
|
||||
|
||||
func TestASuccessClearsTheCountAndOldFailuresExpire(t *testing.T) {
|
||||
h, clk := limited(t)
|
||||
for i := 0; i < maxFailures-1; i++ {
|
||||
attempt(h, "203.0.113.7", "wrong")
|
||||
}
|
||||
if rec := attempt(h, "203.0.113.7", token); rec.Code != 200 {
|
||||
t.Fatal("under the limit the right token works")
|
||||
}
|
||||
for i := 0; i < maxFailures-1; i++ { // a fresh allowance after a success
|
||||
attempt(h, "203.0.113.7", "wrong")
|
||||
}
|
||||
if rec := attempt(h, "203.0.113.7", token); rec.Code != 200 {
|
||||
t.Fatalf("a success resets the count: %d", rec.Code)
|
||||
}
|
||||
for i := 0; i < maxFailures-1; i++ {
|
||||
attempt(h, "203.0.113.7", "wrong")
|
||||
}
|
||||
clk.advance(failureWindow + time.Second) // the failures are old news
|
||||
for i := 0; i < maxFailures-1; i++ {
|
||||
attempt(h, "203.0.113.7", "wrong")
|
||||
}
|
||||
if rec := attempt(h, "203.0.113.7", token); rec.Code != 200 {
|
||||
t.Fatalf("failures older than the window do not add up: %d", rec.Code)
|
||||
}
|
||||
}
|
||||
|
||||
func TestMissingTokensCountAndHealthDoesNot(t *testing.T) {
|
||||
h, _ := limited(t)
|
||||
for i := 0; i < maxFailures; i++ {
|
||||
health := httptest.NewRequest("GET", "/api/v1/health", nil)
|
||||
health.RemoteAddr = "203.0.113.7:1"
|
||||
rec := httptest.NewRecorder()
|
||||
h.ServeHTTP(rec, health)
|
||||
if rec.Code != 200 {
|
||||
t.Fatalf("health: %d", rec.Code)
|
||||
}
|
||||
attempt(h, "203.0.113.7", "") // no Authorization header at all
|
||||
}
|
||||
if rec := attempt(h, "203.0.113.7", token); rec.Code != 429 {
|
||||
t.Fatalf("probing without a token adds up too: %d", rec.Code)
|
||||
}
|
||||
}
|
||||
|
||||
func TestForwardedForHeadersCannotEvadeTheLimit(t *testing.T) {
|
||||
h, _ := limited(t)
|
||||
for i := 0; i < maxFailures+3; i++ {
|
||||
req := httptest.NewRequest("GET", "/api/v1/lists", nil)
|
||||
req.RemoteAddr = "203.0.113.7:1"
|
||||
req.Header.Set("X-Forwarded-For", "198.51.100."+strconv.Itoa(i))
|
||||
req.Header.Set("Authorization", "Bearer wrong")
|
||||
h.ServeHTTP(httptest.NewRecorder(), req)
|
||||
}
|
||||
if rec := attempt(h, "203.0.113.7", token); rec.Code != 429 {
|
||||
t.Fatalf("a spoofed header must not give a fresh allowance: %d", rec.Code)
|
||||
}
|
||||
}
|
||||
|
||||
func TestAnEmptyServerTokenStillCountsFailures(t *testing.T) {
|
||||
s, _ := store.Open(":memory:")
|
||||
defer s.Close()
|
||||
h := newHandler(s, "", nil, time.Now)
|
||||
for i := 0; i < maxFailures; i++ {
|
||||
req := httptest.NewRequest("GET", "/api/v1/lists", nil)
|
||||
req.RemoteAddr = "203.0.113.7:1"
|
||||
req.Header.Set("Authorization", "Bearer ")
|
||||
h.ServeHTTP(httptest.NewRecorder(), req)
|
||||
}
|
||||
req := httptest.NewRequest("GET", "/api/v1/lists", nil)
|
||||
req.RemoteAddr = "203.0.113.7:1"
|
||||
rec := httptest.NewRecorder()
|
||||
h.ServeHTTP(rec, req)
|
||||
if rec.Code != 429 {
|
||||
t.Fatalf("%d", rec.Code)
|
||||
}
|
||||
}
|
||||
|
||||
func TestTheLimiterForgetsOldAddresses(t *testing.T) {
|
||||
s, _ := store.Open(":memory:")
|
||||
defer s.Close()
|
||||
clk := &clock{t: time.Unix(2_000_000_000, 0)}
|
||||
l := newLimiter(clk.now)
|
||||
for i := 0; i < 5000; i++ {
|
||||
l.fail("10.0." + strconv.Itoa(i/250) + "." + strconv.Itoa(i%250))
|
||||
}
|
||||
clk.advance(failureWindow + lockout + time.Second)
|
||||
l.fail("192.0.2.1") // the next failure sweeps expired entries
|
||||
if n := l.size(); n > 10 {
|
||||
t.Fatalf("the limiter keeps %d expired addresses: memory grows without bound", n)
|
||||
}
|
||||
}
|
||||
|
||||
func TestTheLimitIsTenWrongTokensInFiveMinutes(t *testing.T) {
|
||||
// The numbers are part of the documented behaviour: do not derive them from the constants.
|
||||
h, clk := limited(t)
|
||||
for i := 1; i <= 10; i++ {
|
||||
if rec := attempt(h, "203.0.113.7", "wrong"); rec.Code != 401 {
|
||||
t.Fatalf("wrong token number %d must still be a plain 401, got %d", i, rec.Code)
|
||||
}
|
||||
}
|
||||
if rec := attempt(h, "203.0.113.7", token); rec.Code != 429 {
|
||||
t.Fatalf("the 11th attempt is locked out: %d", rec.Code)
|
||||
}
|
||||
clk.advance(4*time.Minute + 59*time.Second)
|
||||
if rec := attempt(h, "203.0.113.7", token); rec.Code != 429 {
|
||||
t.Fatalf("still locked just before 5 minutes: %d", rec.Code)
|
||||
}
|
||||
clk.advance(2 * time.Second)
|
||||
if rec := attempt(h, "203.0.113.7", token); rec.Code != 200 {
|
||||
t.Fatalf("free after 5 minutes: %d", rec.Code)
|
||||
}
|
||||
}
|
||||
|
||||
func TestRetryAfterCountsDown(t *testing.T) {
|
||||
h, clk := limited(t)
|
||||
for i := 0; i < 10; i++ {
|
||||
attempt(h, "203.0.113.7", "wrong")
|
||||
}
|
||||
first, _ := strconv.Atoi(attempt(h, "203.0.113.7", token).Header().Get("Retry-After"))
|
||||
clk.advance(2 * time.Minute)
|
||||
later, _ := strconv.Atoi(attempt(h, "203.0.113.7", token).Header().Get("Retry-After"))
|
||||
if first != 300 || later != 180 {
|
||||
t.Fatalf("Retry-After is the time left: %d then %d, want 300 then 180", first, later)
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue