initial version
This commit is contained in:
commit
4691f4ea9e
12 changed files with 1479 additions and 0 deletions
36
.gitignore
vendored
Normal file
36
.gitignore
vendored
Normal file
|
@ -0,0 +1,36 @@
|
||||||
|
# dependencies (bun install)
|
||||||
|
node_modules
|
||||||
|
|
||||||
|
# output
|
||||||
|
out
|
||||||
|
dist
|
||||||
|
*.tgz
|
||||||
|
|
||||||
|
# code coverage
|
||||||
|
coverage
|
||||||
|
*.lcov
|
||||||
|
|
||||||
|
# logs
|
||||||
|
logs
|
||||||
|
_.log
|
||||||
|
report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
|
||||||
|
|
||||||
|
# dotenv environment variable files
|
||||||
|
.env
|
||||||
|
.env.development.local
|
||||||
|
.env.test.local
|
||||||
|
.env.production.local
|
||||||
|
.env.local
|
||||||
|
|
||||||
|
# caches
|
||||||
|
.eslintcache
|
||||||
|
.cache
|
||||||
|
*.tsbuildinfo
|
||||||
|
|
||||||
|
# IntelliJ based IDEs
|
||||||
|
.idea
|
||||||
|
|
||||||
|
# Finder (MacOS) folder config
|
||||||
|
.DS_Store
|
||||||
|
|
||||||
|
allowed-pubkeys.json
|
20
Dockerfile
Normal file
20
Dockerfile
Normal file
|
@ -0,0 +1,20 @@
|
||||||
|
FROM oven/bun:canary-debian AS builder
|
||||||
|
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
ADD package.json .
|
||||||
|
RUN bun install
|
||||||
|
|
||||||
|
ADD . .
|
||||||
|
|
||||||
|
RUN bun build index.ts --compile
|
||||||
|
|
||||||
|
FROM debian:bookworm-slim
|
||||||
|
|
||||||
|
WORKDIR /app
|
||||||
|
|
||||||
|
COPY --from=builder /app/index /app/index
|
||||||
|
|
||||||
|
EXPOSE 3000
|
||||||
|
|
||||||
|
CMD ["/app/index"]
|
661
LICENSE
Normal file
661
LICENSE
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/>.
|
123
README.md
Normal file
123
README.md
Normal file
|
@ -0,0 +1,123 @@
|
||||||
|
<table>
|
||||||
|
<tr>
|
||||||
|
<td><img src="images/logo.webp" alt="NIP-42 Proxy Logo" width="200"/></td>
|
||||||
|
<td>
|
||||||
|
<h1>NIP-42 Proxy</h1>
|
||||||
|
<p>A simple, no-fuss NIP-42 authentication proxy for your Nostr relay.</p>
|
||||||
|
<p>
|
||||||
|
<a href="https://www.gnu.org/licenses/agpl-3.0"><img src="https://img.shields.io/badge/License-AGPL_v3-blue.svg" alt="License: AGPL v3"></a>
|
||||||
|
</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Ever wanted to run a private Nostr relay without all the hassle? This NIP-42 proxy is your answer. It sits in front of your relay and makes sure only the right people can get in. Simple as that.
|
||||||
|
|
||||||
|
## ✨ What's Inside?
|
||||||
|
|
||||||
|
- **NIP-42 Auth:** Keep your relay safe and sound with NIP-42 authentication.
|
||||||
|
- **Proxy Power:** It's a straightforward proxy that forwards messages between your users and the relay.
|
||||||
|
- **Whitelist Control:** Easily manage who gets in and what they can do with a dynamic whitelist.
|
||||||
|
- **Admin Interface:** A handy RPC interface (protected by NIP-98) to manage your proxy.
|
||||||
|
- **Docker-Ready:** Comes with a `Dockerfile`, so you can get it up and running in a flash.
|
||||||
|
- **Bun-Powered:** Built with Bun for a fast and modern experience.
|
||||||
|
|
||||||
|
## 🚀 Get Going
|
||||||
|
|
||||||
|
### What You'll Need
|
||||||
|
|
||||||
|
- [Bun](https://bun.sh/)
|
||||||
|
- [Docker](https://www.docker.com/) (if you're into that)
|
||||||
|
|
||||||
|
### Let's Do This
|
||||||
|
|
||||||
|
1. **Clone the code:**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://git.arx-ccn.com/Arx/nip42-proxy.git
|
||||||
|
cd nip42-proxy
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **Install the things:**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
bun install
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **Fire it up:**
|
||||||
|
- **With Bun:**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
RELAY_URL="wss://my-relay.com" ADMIN_PUBKEY="my-admin-pubkey" bun run index.ts
|
||||||
|
```
|
||||||
|
|
||||||
|
- **With Docker:**
|
||||||
|
1. Build it:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker build -t nip42-proxy .
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Run it:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker run -p 3000:3000 -e RELAY_URL="wss://your-relay-url.com" -e ADMIN_PUBKEY="my-admin-pubkey" --name nip42-proxy nip42-proxy
|
||||||
|
```
|
||||||
|
|
||||||
|
Now you can connect to your proxy with any Nostr client that gets NIP-42.
|
||||||
|
|
||||||
|
## ⚙️ Tweaks and Knobs
|
||||||
|
|
||||||
|
This proxy is configured with environment variables. Here's the rundown:
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Click to see all the options</summary>
|
||||||
|
|
||||||
|
| Variable | What it does | Default |
|
||||||
|
| ------------------------ | ----------------------------------------- | ----------- |
|
||||||
|
| `ALLOW_UNAUTHED_PUBLISH` | Let unauthenticated users publish events. | `false` |
|
||||||
|
| `RELAY_URL` | The URL of the relay you're proxying. | |
|
||||||
|
| `RELAY_OUTSIDE_URL` | The URL your users will connect to. | `RELAY_URL` |
|
||||||
|
| `RELAY_NAME` | The name of your relay. | |
|
||||||
|
| `RELAY_DESCRIPTION` | A little something about your relay. | |
|
||||||
|
| `RELAY_BANNER` | A URL for a banner image. | |
|
||||||
|
| `RELAY_ICON` | A URL for an icon. | |
|
||||||
|
| `RELAY_CONTACT` | How people can get in touch. | |
|
||||||
|
| `RELAY_POLICY` | A URL to your relay's policy. | |
|
||||||
|
| `ADMIN_PUBKEY` | The public key of the relay's admin. | |
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
## 🔧 The Admin Zone
|
||||||
|
|
||||||
|
The proxy has a special RPC interface for admins, protected by NIP-98. Just send a `POST` request to the root URL (`/`) with the right headers (`Content-Type: application/nostr+json+rpc` and a NIP-98 `Authorization` token).
|
||||||
|
|
||||||
|
**What you can do:**
|
||||||
|
|
||||||
|
- `supportedmethods`: See what commands are available.
|
||||||
|
- `getinfo`: Get the relay's info doc.
|
||||||
|
- `banpubkey`: Kick someone out.
|
||||||
|
- `allowpubkey`: Let someone in.
|
||||||
|
- `listallowedpubkeys`: See who's on the list.
|
||||||
|
- `allowkind`: Allow a certain kind of event.
|
||||||
|
- `disallowkind`: Block a certain kind of event.
|
||||||
|
- `listallowedkinds`: See what kinds are allowed.
|
||||||
|
|
||||||
|
## 🤔 How's It Work?
|
||||||
|
|
||||||
|
1. **Knock Knock:** A client connects, but they're just a guest for now.
|
||||||
|
2. **Who's There?:** The proxy asks for their credentials with an `AUTH` challenge.
|
||||||
|
3. **The Password:** The client sends back a valid `AUTH` event, signed with a key that's on the list.
|
||||||
|
4. **You're In:** The client is now authenticated and can chat with the relay.
|
||||||
|
5. **The Conversation:** Messages flow freely between the client and the relay.
|
||||||
|
|
||||||
|
## 🤝 Wanna Help?
|
||||||
|
|
||||||
|
Got ideas? Found a bug? Pull requests and issues are always welcome.
|
||||||
|
|
||||||
|
## 📄 The Fine Print
|
||||||
|
|
||||||
|
This project is licensed under the AGPLv3. Check out the [LICENSE](LICENSE) file for the full text.
|
||||||
|
|
31
biome.json
Normal file
31
biome.json
Normal file
|
@ -0,0 +1,31 @@
|
||||||
|
{
|
||||||
|
"$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
|
||||||
|
"vcs": {
|
||||||
|
"enabled": true,
|
||||||
|
"clientKind": "git",
|
||||||
|
"useIgnoreFile": false
|
||||||
|
},
|
||||||
|
"files": {
|
||||||
|
"ignoreUnknown": false,
|
||||||
|
"ignore": []
|
||||||
|
},
|
||||||
|
"formatter": {
|
||||||
|
"enabled": true,
|
||||||
|
"indentStyle": "space",
|
||||||
|
"indentWidth": 2
|
||||||
|
},
|
||||||
|
"organizeImports": {
|
||||||
|
"enabled": true
|
||||||
|
},
|
||||||
|
"linter": {
|
||||||
|
"enabled": true,
|
||||||
|
"rules": {
|
||||||
|
"recommended": true
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"javascript": {
|
||||||
|
"formatter": {
|
||||||
|
"quoteStyle": "double"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
58
bun.lock
Normal file
58
bun.lock
Normal file
|
@ -0,0 +1,58 @@
|
||||||
|
{
|
||||||
|
"lockfileVersion": 1,
|
||||||
|
"workspaces": {
|
||||||
|
"": {
|
||||||
|
"name": "nip42-proxy",
|
||||||
|
"dependencies": {
|
||||||
|
"nostr-tools": "^2.16.2",
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@types/bun": "latest",
|
||||||
|
},
|
||||||
|
"peerDependencies": {
|
||||||
|
"typescript": "^5",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
"packages": {
|
||||||
|
"@noble/ciphers": ["@noble/ciphers@0.5.3", "", {}, "sha512-B0+6IIHiqEs3BPMT0hcRmHvEj2QHOLu+uwt+tqDDeVd0oyVzh7BPrDcPjRnV1PV/5LaknXJJQvOuRGR0zQJz+w=="],
|
||||||
|
|
||||||
|
"@noble/curves": ["@noble/curves@1.2.0", "", { "dependencies": { "@noble/hashes": "1.3.2" } }, "sha512-oYclrNgRaM9SsBUBVbb8M6DTV7ZHRTKugureoYEncY5c65HOmRzvSiTE3y5CYaPYJA/GVkrhXEoF0M3Ya9PMnw=="],
|
||||||
|
|
||||||
|
"@noble/hashes": ["@noble/hashes@1.3.1", "", {}, "sha512-EbqwksQwz9xDRGfDST86whPBgM65E0OH/pCgqW0GBVzO22bNE+NuIbeTb714+IfSjU3aRk47EUvXIb5bTsenKA=="],
|
||||||
|
|
||||||
|
"@scure/base": ["@scure/base@1.1.1", "", {}, "sha512-ZxOhsSyxYwLJj3pLZCefNitxsj093tb2vq90mp2txoYeBqbcjDjqFhyM8eUjq/uFm6zJ+mUuqxlS2FkuSY1MTA=="],
|
||||||
|
|
||||||
|
"@scure/bip32": ["@scure/bip32@1.3.1", "", { "dependencies": { "@noble/curves": "~1.1.0", "@noble/hashes": "~1.3.1", "@scure/base": "~1.1.0" } }, "sha512-osvveYtyzdEVbt3OfwwXFr4P2iVBL5u1Q3q4ONBfDY/UpOuXmOlbgwc1xECEboY8wIays8Yt6onaWMUdUbfl0A=="],
|
||||||
|
|
||||||
|
"@scure/bip39": ["@scure/bip39@1.2.1", "", { "dependencies": { "@noble/hashes": "~1.3.0", "@scure/base": "~1.1.0" } }, "sha512-Z3/Fsz1yr904dduJD0NpiyRHhRYHdcnyh73FZWiV+/qhWi83wNJ3NWolYqCEN+ZWsUz2TWwajJggcRE9r1zUYg=="],
|
||||||
|
|
||||||
|
"@types/bun": ["@types/bun@1.2.19", "", { "dependencies": { "bun-types": "1.2.19" } }, "sha512-d9ZCmrH3CJ2uYKXQIUuZ/pUnTqIvLDS0SK7pFmbx8ma+ziH/FRMoAq5bYpRG7y+w1gl+HgyNZbtqgMq4W4e2Lg=="],
|
||||||
|
|
||||||
|
"@types/node": ["@types/node@24.2.0", "", { "dependencies": { "undici-types": "~7.10.0" } }, "sha512-3xyG3pMCq3oYCNg7/ZP+E1ooTaGB4cG8JWRsqqOYQdbWNY4zbaV0Ennrd7stjiJEFZCaybcIgpTjJWHRfBSIDw=="],
|
||||||
|
|
||||||
|
"@types/react": ["@types/react@19.1.9", "", { "dependencies": { "csstype": "^3.0.2" } }, "sha512-WmdoynAX8Stew/36uTSVMcLJJ1KRh6L3IZRx1PZ7qJtBqT3dYTgyDTx8H1qoRghErydW7xw9mSJ3wS//tCRpFA=="],
|
||||||
|
|
||||||
|
"bun-types": ["bun-types@1.2.19", "", { "dependencies": { "@types/node": "*" }, "peerDependencies": { "@types/react": "^19" } }, "sha512-uAOTaZSPuYsWIXRpj7o56Let0g/wjihKCkeRqUBhlLVM/Bt+Fj9xTo+LhC1OV1XDaGkz4hNC80et5xgy+9KTHQ=="],
|
||||||
|
|
||||||
|
"csstype": ["csstype@3.1.3", "", {}, "sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw=="],
|
||||||
|
|
||||||
|
"nostr-tools": ["nostr-tools@2.16.2", "", { "dependencies": { "@noble/ciphers": "^0.5.1", "@noble/curves": "1.2.0", "@noble/hashes": "1.3.1", "@scure/base": "1.1.1", "@scure/bip32": "1.3.1", "@scure/bip39": "1.2.1", "nostr-wasm": "0.1.0" }, "peerDependencies": { "typescript": ">=5.0.0" }, "optionalPeers": ["typescript"] }, "sha512-ZxH9EbSt5ypURZj2TGNJxZd0Omb5ag5KZSu8IyJMCdLyg2KKz+2GA0sP/cSawCQEkyviIN4eRT4G2gB/t9lMRw=="],
|
||||||
|
|
||||||
|
"nostr-wasm": ["nostr-wasm@0.1.0", "", {}, "sha512-78BTryCLcLYv96ONU8Ws3Q1JzjlAt+43pWQhIl86xZmWeegYCNLPml7yQ+gG3vR6V5h4XGj+TxO+SS5dsThQIA=="],
|
||||||
|
|
||||||
|
"typescript": ["typescript@5.9.2", "", { "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" } }, "sha512-CWBzXQrc/qOkhidw1OzBTQuYRbfyxDXJMVJ1XNwUHGROVmuaeiEm3OslpZ1RV96d7SKKjZKrSJu3+t/xlw3R9A=="],
|
||||||
|
|
||||||
|
"undici-types": ["undici-types@7.10.0", "", {}, "sha512-t5Fy/nfn+14LuOc2KNYg75vZqClpAiqscVvMygNnlsHBFpSXdJaYtXMcdNLpl/Qvc3P2cB3s6lOV51nqsFq4ag=="],
|
||||||
|
|
||||||
|
"@noble/curves/@noble/hashes": ["@noble/hashes@1.3.2", "", {}, "sha512-MVC8EAQp7MvEcm30KWENFjgR+Mkmf+D189XJTkFIlwohU5hcBbn1ZkKq7KVTi2Hme3PMGF390DaL52beVrIihQ=="],
|
||||||
|
|
||||||
|
"@scure/bip32/@noble/curves": ["@noble/curves@1.1.0", "", { "dependencies": { "@noble/hashes": "1.3.1" } }, "sha512-091oBExgENk/kGj3AZmtBDMpxQPDtxQABR2B9lb1JbVTs6ytdzZNwvhxQ4MWasRNEzlbEH8jCWFCwhF/Obj5AA=="],
|
||||||
|
|
||||||
|
"@scure/bip32/@noble/hashes": ["@noble/hashes@1.3.2", "", {}, "sha512-MVC8EAQp7MvEcm30KWENFjgR+Mkmf+D189XJTkFIlwohU5hcBbn1ZkKq7KVTi2Hme3PMGF390DaL52beVrIihQ=="],
|
||||||
|
|
||||||
|
"@scure/bip39/@noble/hashes": ["@noble/hashes@1.3.2", "", {}, "sha512-MVC8EAQp7MvEcm30KWENFjgR+Mkmf+D189XJTkFIlwohU5hcBbn1ZkKq7KVTi2Hme3PMGF390DaL52beVrIihQ=="],
|
||||||
|
|
||||||
|
"@scure/bip32/@noble/curves/@noble/hashes": ["@noble/hashes@1.3.1", "", {}, "sha512-EbqwksQwz9xDRGfDST86whPBgM65E0OH/pCgqW0GBVzO22bNE+NuIbeTb714+IfSjU3aRk47EUvXIb5bTsenKA=="],
|
||||||
|
}
|
||||||
|
}
|
BIN
images/logo.webp
Normal file
BIN
images/logo.webp
Normal file
Binary file not shown.
After Width: | Height: | Size: 24 KiB |
22
index.ts
Normal file
22
index.ts
Normal file
|
@ -0,0 +1,22 @@
|
||||||
|
import { type RelayConfig, main } from "./src/main.ts";
|
||||||
|
|
||||||
|
const config: RelayConfig = {
|
||||||
|
allowUnauthedPublish: Boolean(process.env.ALLOW_UNAUTHED_PUBLISH) || false,
|
||||||
|
outsideURL: process.env.RELAY_OUTSIDE_URL || process.env.RELAY_URL!,
|
||||||
|
relay: process.env.RELAY_URL!,
|
||||||
|
name: process.env.RELAY_NAME,
|
||||||
|
description: process.env.RELAY_DESCRIPTION,
|
||||||
|
banner: process.env.RELAY_BANNER,
|
||||||
|
icon: process.env.RELAY_ICON,
|
||||||
|
contact: process.env.RELAY_CONTACT,
|
||||||
|
policy: process.env.RELAY_POLICY,
|
||||||
|
adminPubkey: process.env.ADMIN_PUBKEY,
|
||||||
|
};
|
||||||
|
|
||||||
|
if (
|
||||||
|
!config.relay ||
|
||||||
|
(!config.relay?.startsWith("wss://") && !config.relay?.startsWith("ws://"))
|
||||||
|
)
|
||||||
|
config.relay = "wss://relay.arx-ccn.com";
|
||||||
|
|
||||||
|
main(config);
|
15
package.json
Normal file
15
package.json
Normal file
|
@ -0,0 +1,15 @@
|
||||||
|
{
|
||||||
|
"name": "nip42-proxy",
|
||||||
|
"module": "index.ts",
|
||||||
|
"type": "module",
|
||||||
|
"private": true,
|
||||||
|
"devDependencies": {
|
||||||
|
"@types/bun": "latest"
|
||||||
|
},
|
||||||
|
"peerDependencies": {
|
||||||
|
"typescript": "^5"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"nostr-tools": "^2.16.2"
|
||||||
|
}
|
||||||
|
}
|
371
src/main.ts
Normal file
371
src/main.ts
Normal file
|
@ -0,0 +1,371 @@
|
||||||
|
import type { ServerWebSocket } from "bun";
|
||||||
|
import { nip98, type Event } from "nostr-tools";
|
||||||
|
import {
|
||||||
|
allowKind,
|
||||||
|
allowPubkey,
|
||||||
|
banPubkey,
|
||||||
|
disallowKind,
|
||||||
|
getAllAllowedKinds,
|
||||||
|
getAllAllowedPubkeys,
|
||||||
|
isKindAllowed,
|
||||||
|
isPubkeyAllowed,
|
||||||
|
validateAuthEvent,
|
||||||
|
} from "./utils.ts";
|
||||||
|
import { getGitCommitHash } from "./utils.ts" with { type: "macro" };
|
||||||
|
|
||||||
|
type Nip42ProxySocketData = {
|
||||||
|
authenticated: boolean;
|
||||||
|
authToken: string;
|
||||||
|
remoteWs?: WebSocket;
|
||||||
|
};
|
||||||
|
|
||||||
|
const sendMessage = (
|
||||||
|
ws: ServerWebSocket<Nip42ProxySocketData>,
|
||||||
|
message: any[],
|
||||||
|
) => ws.send(JSON.stringify(message), true);
|
||||||
|
|
||||||
|
const sendAuth = (ws: ServerWebSocket<Nip42ProxySocketData>) => {
|
||||||
|
sendMessage(ws, [
|
||||||
|
"AUTH",
|
||||||
|
ws.data.authToken,
|
||||||
|
"This is an authenticated relay.",
|
||||||
|
]);
|
||||||
|
};
|
||||||
|
|
||||||
|
export interface RelayConfig {
|
||||||
|
adminPubkey?: string;
|
||||||
|
outsideURL: string;
|
||||||
|
relay: string;
|
||||||
|
name?: string;
|
||||||
|
description?: string;
|
||||||
|
icon?: string;
|
||||||
|
banner?: string;
|
||||||
|
contact?: string;
|
||||||
|
policy?: string;
|
||||||
|
allowUnauthedPublish: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function main({
|
||||||
|
relay,
|
||||||
|
outsideURL,
|
||||||
|
adminPubkey,
|
||||||
|
name,
|
||||||
|
description,
|
||||||
|
icon,
|
||||||
|
banner,
|
||||||
|
contact,
|
||||||
|
policy,
|
||||||
|
allowUnauthedPublish,
|
||||||
|
}: RelayConfig) {
|
||||||
|
function relayInfo(returnJson: boolean = false) {
|
||||||
|
const json = {
|
||||||
|
name,
|
||||||
|
description,
|
||||||
|
banner,
|
||||||
|
pubkey: adminPubkey,
|
||||||
|
contact,
|
||||||
|
software: "https://git.arx-ccn.com/Arx/nip42-proxy.git",
|
||||||
|
supported_nips: [1, 2, 4, 9, 11, 22, 28, 40, 42, 70, 77, 86],
|
||||||
|
version: `nip42-proxy - ${getGitCommitHash()}`,
|
||||||
|
posting_policy: policy,
|
||||||
|
icon,
|
||||||
|
limitation: {
|
||||||
|
auth_required: true,
|
||||||
|
restricted_writes: true,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
if (returnJson) return json;
|
||||||
|
return new Response(JSON.stringify(json), {
|
||||||
|
headers: { "content-type": "application/json; charset=utf-8" },
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
async function relayRPC(
|
||||||
|
adminPubkey: string | undefined,
|
||||||
|
token: string,
|
||||||
|
url: string,
|
||||||
|
method: string,
|
||||||
|
params: any[],
|
||||||
|
) {
|
||||||
|
if (method === "supportedmethods")
|
||||||
|
return new Response(
|
||||||
|
JSON.stringify({
|
||||||
|
result: [
|
||||||
|
"supportedmethods",
|
||||||
|
"getinfo",
|
||||||
|
"banpubkey",
|
||||||
|
"allowpubkey",
|
||||||
|
"listallowedpubkeys",
|
||||||
|
"allowkind",
|
||||||
|
"disallowkind",
|
||||||
|
"listallowedkinds",
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
if (method === "getinfo")
|
||||||
|
return new Response(
|
||||||
|
JSON.stringify({
|
||||||
|
result: relayInfo(true),
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
const valid = await nip98.validateToken(token, url, method);
|
||||||
|
if (!token || !valid)
|
||||||
|
return new Response(
|
||||||
|
JSON.stringify({
|
||||||
|
error: "You are not authorized",
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
const event = await nip98.unpackEventFromToken(token);
|
||||||
|
if (adminPubkey && event.pubkey !== adminPubkey)
|
||||||
|
return new Response(
|
||||||
|
JSON.stringify({
|
||||||
|
error: "You are not authorized",
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
if (!(await isPubkeyAllowed(event)))
|
||||||
|
return new Response(
|
||||||
|
JSON.stringify({
|
||||||
|
error: "You are not authorized",
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
|
||||||
|
if (method === "allowpubkey") {
|
||||||
|
const [pubkey] = params;
|
||||||
|
if (!pubkey)
|
||||||
|
return new Response(
|
||||||
|
JSON.stringify({
|
||||||
|
error: "Missing pubkey parameter",
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
await allowPubkey(pubkey);
|
||||||
|
return new Response(
|
||||||
|
JSON.stringify({
|
||||||
|
result: true,
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (method === "listallowedpubkeys") {
|
||||||
|
const resp = await getAllAllowedPubkeys();
|
||||||
|
return new Response(
|
||||||
|
JSON.stringify({
|
||||||
|
result: resp.map((k: string) => ({ pubkey: k })),
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (method === "banpubkey") {
|
||||||
|
const [pubkey] = params;
|
||||||
|
if (!pubkey)
|
||||||
|
return new Response(
|
||||||
|
JSON.stringify({
|
||||||
|
error: "Missing pubkey parameter",
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
await banPubkey(pubkey);
|
||||||
|
return new Response(
|
||||||
|
JSON.stringify({
|
||||||
|
result: true,
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (method === "allowkind") {
|
||||||
|
const [kind] = params;
|
||||||
|
if (typeof kind !== "number")
|
||||||
|
return new Response(
|
||||||
|
JSON.stringify({
|
||||||
|
error: "Missing or invalid kind parameter",
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
await allowKind(kind);
|
||||||
|
return new Response(
|
||||||
|
JSON.stringify({
|
||||||
|
result: true,
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (method === "disallowkind") {
|
||||||
|
const [kind] = params;
|
||||||
|
if (typeof kind !== "number")
|
||||||
|
return new Response(
|
||||||
|
JSON.stringify({
|
||||||
|
error: "Missing or invalid kind parameter",
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
await disallowKind(kind);
|
||||||
|
return new Response(
|
||||||
|
JSON.stringify({
|
||||||
|
result: true,
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if (method === "listallowedkinds") {
|
||||||
|
const resp = (await getAllAllowedKinds()).sort((a, b) => a - b);
|
||||||
|
return new Response(
|
||||||
|
JSON.stringify({
|
||||||
|
result: resp,
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
return new Response(
|
||||||
|
JSON.stringify({
|
||||||
|
error: `Unsupported method ${method}`,
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
const server = Bun.serve<Nip42ProxySocketData>({
|
||||||
|
async fetch(req, server) {
|
||||||
|
const upgraded = server.upgrade(req, {
|
||||||
|
data: {
|
||||||
|
authenticated: false,
|
||||||
|
authToken: Bun.randomUUIDv7(),
|
||||||
|
},
|
||||||
|
});
|
||||||
|
if (upgraded) return new Response("Upgraded");
|
||||||
|
const url = new URL(req.url);
|
||||||
|
if (url.pathname === "") url.pathname = "/";
|
||||||
|
if (url.pathname === "/") {
|
||||||
|
if (req.headers.get("accept") === "application/nostr+json")
|
||||||
|
return relayInfo() as Response;
|
||||||
|
switch (req.headers.get("content-type")) {
|
||||||
|
case "application/nostr+json":
|
||||||
|
return relayInfo() as Response;
|
||||||
|
case "application/nostr+json+rpc": {
|
||||||
|
const token = req.headers.get("Authorization") || "";
|
||||||
|
const data: { method?: string; params?: any[] } = await req.json();
|
||||||
|
if (!data || !data.method)
|
||||||
|
return new Response(
|
||||||
|
JSON.stringify({
|
||||||
|
error: "Please send a valid nostr rpc request",
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
let { method, params } = data;
|
||||||
|
params ||= [];
|
||||||
|
const urlForRequest = new URL(req.url);
|
||||||
|
urlForRequest.hostname = new URL(outsideURL).hostname;
|
||||||
|
urlForRequest.protocol = "https";
|
||||||
|
return relayRPC(
|
||||||
|
adminPubkey,
|
||||||
|
token,
|
||||||
|
urlForRequest.toString(),
|
||||||
|
method,
|
||||||
|
params,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
return new Response("Nip42 Proxy");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (url.pathname === "/api/health")
|
||||||
|
return new Response(
|
||||||
|
JSON.stringify({
|
||||||
|
activeRequests: server.pendingRequests,
|
||||||
|
activeWebsockets: server.pendingWebSockets,
|
||||||
|
}),
|
||||||
|
);
|
||||||
|
return new Response("Not Found", { status: 404 });
|
||||||
|
},
|
||||||
|
websocket: {
|
||||||
|
async message(ws, msg) {
|
||||||
|
const [command, ...data] = JSON.parse(msg as string);
|
||||||
|
if (!ws.data.authenticated) {
|
||||||
|
if (command === "REQ") {
|
||||||
|
const [name] = data;
|
||||||
|
sendMessage(ws, [
|
||||||
|
"CLOSED",
|
||||||
|
name,
|
||||||
|
"auth-required: you must authenticate first",
|
||||||
|
]);
|
||||||
|
|
||||||
|
} else if (command === "EVENT") {
|
||||||
|
const [event] = data as [Event];
|
||||||
|
if (
|
||||||
|
allowUnauthedPublish &&
|
||||||
|
(await isPubkeyAllowed(event)) &&
|
||||||
|
(await isKindAllowed(event))
|
||||||
|
) {
|
||||||
|
if (ws.data.remoteWs) {
|
||||||
|
ws.data.remoteWs.send(msg);
|
||||||
|
}
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
sendMessage(ws, [
|
||||||
|
"OK",
|
||||||
|
event.id,
|
||||||
|
false,
|
||||||
|
"auth-required: you must authenticate first",
|
||||||
|
]);
|
||||||
|
} else if (command === "AUTH") {
|
||||||
|
const [event] = data as [Event];
|
||||||
|
const valid = await validateAuthEvent(event, ws.data.authToken);
|
||||||
|
if (!valid) {
|
||||||
|
sendMessage(ws, ["NOTICE", "Invalid auth event"]);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
sendMessage(ws, [
|
||||||
|
"OK",
|
||||||
|
event.id,
|
||||||
|
true,
|
||||||
|
"successully authenticated. welcome",
|
||||||
|
]);
|
||||||
|
ws.data.authenticated = true;
|
||||||
|
} else {
|
||||||
|
sendAuth(ws);
|
||||||
|
}
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (ws.data.authenticated && command === "AUTH") {
|
||||||
|
const [event] = data as [Event];
|
||||||
|
sendMessage(ws, [
|
||||||
|
"OK",
|
||||||
|
event.id,
|
||||||
|
true,
|
||||||
|
"you were already authenticated",
|
||||||
|
]);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (ws.data.remoteWs) {
|
||||||
|
const [event] = data as [Event];
|
||||||
|
if(command === "EVENT") {
|
||||||
|
if(!await isPubkeyAllowed(event))
|
||||||
|
return sendMessage(ws, [
|
||||||
|
"OK",
|
||||||
|
event.id,
|
||||||
|
false,
|
||||||
|
"pubkey not allowed",
|
||||||
|
]);
|
||||||
|
if(!await isKindAllowed(event))
|
||||||
|
return sendMessage(ws, [
|
||||||
|
"OK",
|
||||||
|
event.id,
|
||||||
|
false,
|
||||||
|
"kind not allowed",
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
ws.data.remoteWs.send(msg);
|
||||||
|
}
|
||||||
|
},
|
||||||
|
open(ws) {
|
||||||
|
const remoteWs = new WebSocket(relay);
|
||||||
|
ws.data.remoteWs = remoteWs;
|
||||||
|
|
||||||
|
remoteWs.addEventListener("message", (data) =>
|
||||||
|
ws.send(
|
||||||
|
(data as MessageEvent).data as string | ArrayBufferLike,
|
||||||
|
true,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
remoteWs.addEventListener("open", () => {
|
||||||
|
sendAuth(ws);
|
||||||
|
});
|
||||||
|
remoteWs.addEventListener("error", console.error);
|
||||||
|
},
|
||||||
|
perMessageDeflate: true,
|
||||||
|
close(ws) {
|
||||||
|
ws.data.remoteWs?.close();
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
console.log("Server listening @", server.url.host);
|
||||||
|
}
|
113
src/utils.ts
Normal file
113
src/utils.ts
Normal file
|
@ -0,0 +1,113 @@
|
||||||
|
import type { Event } from "nostr-tools";
|
||||||
|
|
||||||
|
export function getGitCommitHash() {
|
||||||
|
try {
|
||||||
|
const { stdout } = Bun.spawnSync({
|
||||||
|
cmd: ["git", "rev-parse", "HEAD"],
|
||||||
|
stdout: "pipe",
|
||||||
|
stderr: "pipe",
|
||||||
|
});
|
||||||
|
const out = stdout?.toString()?.trim();
|
||||||
|
return out?.split("\n")[0] || "unknown";
|
||||||
|
} catch {
|
||||||
|
return "unknown";
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function validateAuthEvent(
|
||||||
|
event: Event,
|
||||||
|
challenge: string,
|
||||||
|
): Promise<boolean> {
|
||||||
|
if (event.kind !== 22242) return false;
|
||||||
|
const last30Seconds = Math.floor(Date.now() / 1000) - 30;
|
||||||
|
if (event.created_at < last30Seconds) return false;
|
||||||
|
const challengeTag = event.tags.find((tag) => tag[0] === "challenge")?.[1];
|
||||||
|
if (challengeTag !== challenge) return false;
|
||||||
|
if(!await isPubkeyAllowed(event))
|
||||||
|
return false;
|
||||||
|
return await isKindAllowed(event);
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function isPubkeyAllowed(event: Event): Promise<boolean> {
|
||||||
|
const file = Bun.file("./allowed-pubkeys.json");
|
||||||
|
if (!(await file.exists())) return true;
|
||||||
|
try {
|
||||||
|
const allowedPubkeys = JSON.parse(await file.text());
|
||||||
|
return (
|
||||||
|
Array.isArray(allowedPubkeys) && allowedPubkeys.includes(event.pubkey)
|
||||||
|
);
|
||||||
|
} catch {
|
||||||
|
// If the file is malformed, default to deny
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function getAllAllowedPubkeys() {
|
||||||
|
const file = Bun.file("./allowed-pubkeys.json");
|
||||||
|
try {
|
||||||
|
if (await file.exists()) return JSON.parse(await file.text());
|
||||||
|
} catch {}
|
||||||
|
return [] as string[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function saveAllowedPubkeys(pubkeys: string[]): Promise<number> {
|
||||||
|
const file = Bun.file("./allowed-pubkeys.json");
|
||||||
|
const unique = Array.from(new Set(pubkeys));
|
||||||
|
return await file.write(JSON.stringify(unique));
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function allowPubkey(pubkey: string): Promise<number> {
|
||||||
|
const pubkeys = await getAllAllowedPubkeys();
|
||||||
|
if (!pubkeys.includes(pubkey)) pubkeys.push(pubkey);
|
||||||
|
return await saveAllowedPubkeys(pubkeys);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
export async function banPubkey(pubkey: string): Promise<number> {
|
||||||
|
const pubkeys = await getAllAllowedPubkeys();
|
||||||
|
const filtered = pubkeys.filter((p: string) => p !== pubkey);
|
||||||
|
return await saveAllowedPubkeys(filtered);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
export async function isKindAllowed(event: Event): Promise<boolean> {
|
||||||
|
const file = Bun.file("./allowed-kinds.json");
|
||||||
|
if (!(await file.exists())) return true;
|
||||||
|
try {
|
||||||
|
const allowedKinds = JSON.parse(await file.text());
|
||||||
|
if(!Array.isArray(allowedKinds)) return true;
|
||||||
|
if(allowedKinds.length === 0) return true;
|
||||||
|
return (
|
||||||
|
Array.isArray(allowedKinds) && allowedKinds.includes(event.kind)
|
||||||
|
);
|
||||||
|
} catch {
|
||||||
|
// If the file is malformed, default to allow
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function getAllAllowedKinds(): Promise<number[]> {
|
||||||
|
const file = Bun.file("./allowed-kinds.json");
|
||||||
|
try {
|
||||||
|
if (await file.exists()) return JSON.parse(await file.text());
|
||||||
|
} catch {}
|
||||||
|
return [] as number[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function saveAllowedKinds(kinds: number[]): Promise<number> {
|
||||||
|
const file = Bun.file("./allowed-kinds.json");
|
||||||
|
const unique = Array.from(new Set(kinds));
|
||||||
|
return await file.write(JSON.stringify(unique));
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function allowKind(kind: number): Promise<number> {
|
||||||
|
const kinds = await getAllAllowedKinds();
|
||||||
|
if (!kinds.includes(kind)) kinds.push(kind);
|
||||||
|
return await saveAllowedKinds(kinds);
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function disallowKind(kind: number): Promise<number> {
|
||||||
|
const kinds = await getAllAllowedKinds();
|
||||||
|
const filtered = kinds.filter((p: number) => p !== kind);
|
||||||
|
return await saveAllowedKinds(filtered);
|
||||||
|
}
|
29
tsconfig.json
Normal file
29
tsconfig.json
Normal file
|
@ -0,0 +1,29 @@
|
||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
// Environment setup & latest features
|
||||||
|
"lib": ["ESNext"],
|
||||||
|
"target": "ESNext",
|
||||||
|
"module": "Preserve",
|
||||||
|
"moduleDetection": "force",
|
||||||
|
"jsx": "react-jsx",
|
||||||
|
"allowJs": true,
|
||||||
|
|
||||||
|
// Bundler mode
|
||||||
|
"moduleResolution": "bundler",
|
||||||
|
"allowImportingTsExtensions": true,
|
||||||
|
"verbatimModuleSyntax": true,
|
||||||
|
"noEmit": true,
|
||||||
|
|
||||||
|
// Best practices
|
||||||
|
"strict": true,
|
||||||
|
"skipLibCheck": true,
|
||||||
|
"noFallthroughCasesInSwitch": true,
|
||||||
|
"noUncheckedIndexedAccess": true,
|
||||||
|
"noImplicitOverride": true,
|
||||||
|
|
||||||
|
// Some stricter flags (disabled by default)
|
||||||
|
"noUnusedLocals": false,
|
||||||
|
"noUnusedParameters": false,
|
||||||
|
"noPropertyAccessFromIndexSignature": false
|
||||||
|
}
|
||||||
|
}
|
Loading…
Add table
Add a link
Reference in a new issue