feat: enforce bounded API-only Grocy transport
This commit is contained in:
4
.gitignore
vendored
Normal file
4
.gitignore
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
/target/
|
||||
/.superpowers/
|
||||
/.env*
|
||||
*.log
|
||||
2946
Cargo.lock
generated
Normal file
2946
Cargo.lock
generated
Normal file
File diff suppressed because it is too large
Load Diff
38
Cargo.toml
Normal file
38
Cargo.toml
Normal file
@@ -0,0 +1,38 @@
|
||||
[package]
|
||||
name = "hermes-grocy-mcp"
|
||||
version = "0.1.0"
|
||||
edition = "2024"
|
||||
license = "AGPL-3.0-only"
|
||||
description = "Protected local Grocy MCP for household data"
|
||||
|
||||
[dependencies]
|
||||
rmcp = { version = "1.5", features = ["server", "transport-io"] }
|
||||
tokio = { version = "1", features = ["rt-multi-thread", "macros", "io-std", "sync", "time", "process"] }
|
||||
serde = { version = "1", features = ["derive"] }
|
||||
serde_json = "1"
|
||||
schemars = "1"
|
||||
reqwest = { version = "0.13", default-features = false, features = ["rustls", "json", "stream", "query"] }
|
||||
url = "2"
|
||||
rust_decimal = { version = "1", features = ["serde"] }
|
||||
secrecy = "0.10"
|
||||
zeroize = "1"
|
||||
clap = { version = "4", features = ["derive"] }
|
||||
dialoguer = "0.12"
|
||||
base64 = "0.22"
|
||||
libsecret = { version = "0.9", features = ["v0_19"] }
|
||||
gio = "0.22"
|
||||
glib = "0.22"
|
||||
futures-util = "0.3"
|
||||
libc = "0.2"
|
||||
chrono = "0.4"
|
||||
|
||||
[dev-dependencies]
|
||||
axum = "0.8"
|
||||
tokio = { version = "1", features = ["net", "io-util"] }
|
||||
tempfile = "3"
|
||||
rmcp = { version = "1.5", features = ["client"] }
|
||||
zbus = { version = "5", default-features = false, features = ["tokio"] }
|
||||
|
||||
[profile.release]
|
||||
lto = "thin"
|
||||
strip = true
|
||||
663
LICENSE
Normal file
663
LICENSE
Normal file
@@ -0,0 +1,663 @@
|
||||
Copyright (c) 2026 Hermes CalDAV MCP contributors
|
||||
|
||||
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/>.
|
||||
117
src/client/destination.rs
Normal file
117
src/client/destination.rs
Normal file
@@ -0,0 +1,117 @@
|
||||
use crate::{
|
||||
error::{AppError, Result},
|
||||
model::TransportPolicy,
|
||||
};
|
||||
use std::collections::BTreeMap;
|
||||
use url::Url;
|
||||
#[derive(Clone)]
|
||||
pub struct ApiBase(Url);
|
||||
impl ApiBase {
|
||||
pub fn parse(input: &str, policy: TransportPolicy) -> Result<Self> {
|
||||
if input.trim() != input
|
||||
|| input.contains(['\\', '%', '?', '#'])
|
||||
|| input.chars().any(char::is_control)
|
||||
{
|
||||
return Err(AppError::input());
|
||||
}
|
||||
let authority = input
|
||||
.split_once("://")
|
||||
.ok_or_else(AppError::input)?
|
||||
.1
|
||||
.split('/')
|
||||
.next()
|
||||
.unwrap_or("");
|
||||
if authority.contains('@') {
|
||||
return Err(AppError::input());
|
||||
}
|
||||
let raw_host = if authority.starts_with('[') {
|
||||
authority
|
||||
.split(']')
|
||||
.next()
|
||||
.unwrap_or("")
|
||||
.trim_start_matches('[')
|
||||
} else {
|
||||
authority.split(':').next().unwrap_or("")
|
||||
};
|
||||
let literal_loopback = raw_host
|
||||
.parse::<std::net::IpAddr>()
|
||||
.is_ok_and(|a| a.is_loopback());
|
||||
let mut u = Url::parse(input).map_err(|_| AppError::input())?;
|
||||
let raw_path = input
|
||||
.split_once("://")
|
||||
.ok_or_else(AppError::input)?
|
||||
.1
|
||||
.split_once('/')
|
||||
.map(|(_, p)| p)
|
||||
.unwrap_or("");
|
||||
if raw_path
|
||||
.split('/')
|
||||
.any(|s| s == "." || s == ".." || s.is_empty() && raw_path.contains("//"))
|
||||
|| !u.username().is_empty()
|
||||
|| u.password().is_some()
|
||||
|| u.host_str().is_none()
|
||||
{
|
||||
return Err(AppError::input());
|
||||
}
|
||||
let loopback = match u.host() {
|
||||
Some(url::Host::Ipv4(a)) => a.is_loopback(),
|
||||
Some(url::Host::Ipv6(a)) => a.is_loopback(),
|
||||
_ => false,
|
||||
};
|
||||
if u.scheme() != "https"
|
||||
&& !(u.scheme() == "http"
|
||||
&& loopback
|
||||
&& literal_loopback
|
||||
&& policy == TransportPolicy::LoopbackDevelopment)
|
||||
{
|
||||
return Err(AppError::new(
|
||||
"HTTPS_REQUIRED",
|
||||
"Use HTTPS. Literal loopback HTTP is available only with explicit development enrollment.",
|
||||
));
|
||||
}
|
||||
let path = u.path().trim_end_matches('/');
|
||||
let path = if path.ends_with("/api") {
|
||||
path.to_string()
|
||||
} else {
|
||||
format!("{path}/api")
|
||||
};
|
||||
u.set_path(&path);
|
||||
Ok(Self(u))
|
||||
}
|
||||
pub fn path(&self) -> &str {
|
||||
self.0.path()
|
||||
}
|
||||
pub fn as_str(&self) -> &str {
|
||||
self.0.as_str()
|
||||
}
|
||||
pub fn route(&self, template: &'static str, params: &BTreeMap<String, String>) -> Result<Url> {
|
||||
if !template.starts_with('/') || template.contains(['?', '#', '%', '\\']) {
|
||||
return Err(AppError::input());
|
||||
}
|
||||
let mut u = self.0.clone();
|
||||
{
|
||||
let mut segments = u.path_segments_mut().map_err(|_| AppError::input())?;
|
||||
for part in template[1..].split('/') {
|
||||
let value = if part.starts_with('{') && part.ends_with('}') {
|
||||
params
|
||||
.get(&part[1..part.len() - 1])
|
||||
.ok_or_else(AppError::input)?
|
||||
.as_str()
|
||||
} else {
|
||||
part
|
||||
};
|
||||
if value.is_empty()
|
||||
|| matches!(value, "." | "..")
|
||||
|| value.chars().any(char::is_control)
|
||||
{
|
||||
return Err(AppError::input());
|
||||
}
|
||||
segments.push(value);
|
||||
}
|
||||
}
|
||||
if u.origin() != self.0.origin() || !u.path().starts_with(&format!("{}/", self.path())) {
|
||||
return Err(AppError::input());
|
||||
}
|
||||
Ok(u)
|
||||
}
|
||||
}
|
||||
273
src/client/mod.rs
Normal file
273
src/client/mod.rs
Normal file
@@ -0,0 +1,273 @@
|
||||
mod destination;
|
||||
use crate::{
|
||||
error::{AppError, Result},
|
||||
model::{AccessMode, PrivateProfile},
|
||||
};
|
||||
pub use destination::ApiBase;
|
||||
use futures_util::StreamExt;
|
||||
use reqwest::{
|
||||
Method,
|
||||
header::{ACCEPT_ENCODING, CONTENT_ENCODING, CONTENT_TYPE, HeaderValue},
|
||||
};
|
||||
use secrecy::ExposeSecret;
|
||||
use serde_json::{Value, json};
|
||||
use std::{collections::BTreeMap, time::Duration};
|
||||
pub const JSON_LIMIT: usize = 2 * 1024 * 1024;
|
||||
pub const BINARY_LIMIT: usize = 8 * 1024 * 1024;
|
||||
#[derive(Clone, Copy, PartialEq, Eq)]
|
||||
pub enum HttpMethod {
|
||||
Get,
|
||||
Post,
|
||||
Put,
|
||||
Delete,
|
||||
}
|
||||
impl HttpMethod {
|
||||
pub fn mutates(self) -> bool {
|
||||
self != Self::Get
|
||||
}
|
||||
fn reqwest(self) -> Method {
|
||||
match self {
|
||||
Self::Get => Method::GET,
|
||||
Self::Post => Method::POST,
|
||||
Self::Put => Method::PUT,
|
||||
Self::Delete => Method::DELETE,
|
||||
}
|
||||
}
|
||||
}
|
||||
#[derive(Clone, Copy)]
|
||||
pub enum ResponseKind {
|
||||
Json,
|
||||
Text,
|
||||
Binary,
|
||||
}
|
||||
pub enum RequestBody {
|
||||
Empty,
|
||||
Json(Value),
|
||||
Binary(Vec<u8>),
|
||||
}
|
||||
pub struct ApiRequest {
|
||||
pub route: &'static str,
|
||||
pub method: HttpMethod,
|
||||
pub params: BTreeMap<String, String>,
|
||||
pub query: BTreeMap<String, String>,
|
||||
pub body: RequestBody,
|
||||
pub kind: ResponseKind,
|
||||
}
|
||||
impl ApiRequest {
|
||||
pub fn get(route: &'static str) -> Self {
|
||||
Self {
|
||||
route,
|
||||
method: HttpMethod::Get,
|
||||
params: BTreeMap::new(),
|
||||
query: BTreeMap::new(),
|
||||
body: RequestBody::Empty,
|
||||
kind: ResponseKind::Json,
|
||||
}
|
||||
}
|
||||
pub fn target(&self) -> Value {
|
||||
json!({"operation":self.route,"identifiers":self.params})
|
||||
}
|
||||
}
|
||||
pub enum ResponseBody {
|
||||
Json(Value),
|
||||
Text(String),
|
||||
Binary(Vec<u8>),
|
||||
}
|
||||
pub struct ApiResponse {
|
||||
pub status: u16,
|
||||
pub body: ResponseBody,
|
||||
pub content_type: String,
|
||||
}
|
||||
impl ApiResponse {
|
||||
pub fn json(self) -> Result<Value> {
|
||||
match self.body {
|
||||
ResponseBody::Json(v) => Ok(v),
|
||||
_ => Err(AppError::new(
|
||||
"INVALID_RESPONSE",
|
||||
"Grocy returned an unexpected response format.",
|
||||
)),
|
||||
}
|
||||
}
|
||||
}
|
||||
pub struct ApiClient {
|
||||
http: reqwest::Client,
|
||||
profile: PrivateProfile,
|
||||
}
|
||||
impl ApiClient {
|
||||
pub fn new(profile: PrivateProfile) -> Result<Self> {
|
||||
let mut builder = reqwest::Client::builder()
|
||||
.no_proxy()
|
||||
.redirect(reqwest::redirect::Policy::none())
|
||||
.retry(reqwest::retry::never())
|
||||
.connect_timeout(Duration::from_secs(10))
|
||||
.timeout(Duration::from_secs(30))
|
||||
.no_gzip()
|
||||
.no_brotli()
|
||||
.no_deflate()
|
||||
.no_zstd();
|
||||
if let Some(path) = &profile.ca_path {
|
||||
let cert = std::fs::read(path).map_err(|_| {
|
||||
AppError::new(
|
||||
"CA_UNAVAILABLE",
|
||||
"Cannot read the selected trusted CA bundle.",
|
||||
)
|
||||
})?;
|
||||
let certs = reqwest::Certificate::from_pem_bundle(&cert)
|
||||
.map_err(|_| AppError::new("INVALID_CA", "Choose a valid PEM CA bundle."))?;
|
||||
if certs.is_empty() {
|
||||
return Err(AppError::new("INVALID_CA", "Choose a valid PEM CA bundle."));
|
||||
}
|
||||
for cert in certs {
|
||||
builder = builder.add_root_certificate(cert)
|
||||
}
|
||||
}
|
||||
let http = builder.build().map_err(|_| {
|
||||
AppError::new(
|
||||
"HTTP_CLIENT_ERROR",
|
||||
"Could not initialize the verified HTTP client.",
|
||||
)
|
||||
})?;
|
||||
Ok(Self { http, profile })
|
||||
}
|
||||
pub fn access(&self) -> AccessMode {
|
||||
self.profile.access
|
||||
}
|
||||
pub async fn request(&self, r: ApiRequest) -> Result<ApiResponse> {
|
||||
if r.method.mutates() && self.profile.access == AccessMode::ReadOnly {
|
||||
return Err(AppError::new(
|
||||
"READ_ONLY",
|
||||
"This profile does not allow writes.",
|
||||
));
|
||||
}
|
||||
let target = r.target();
|
||||
let write = r.method.mutates();
|
||||
let url = self.profile.api_base.route(r.route, &r.params)?;
|
||||
let mut key = HeaderValue::from_str(self.profile.api_key.expose_secret())
|
||||
.map_err(|_| AppError::new("INVALID_CREDENTIAL", "The stored API key is not valid."))?;
|
||||
key.set_sensitive(true);
|
||||
let mut request = self
|
||||
.http
|
||||
.request(r.method.reqwest(), url)
|
||||
.header("GROCY-API-KEY", key)
|
||||
.header(ACCEPT_ENCODING, "identity")
|
||||
.query(&r.query);
|
||||
request = match r.body {
|
||||
RequestBody::Empty => request,
|
||||
RequestBody::Json(v) => request.json(&v),
|
||||
RequestBody::Binary(b) => {
|
||||
if b.len() > BINARY_LIMIT {
|
||||
return Err(AppError::new(
|
||||
"RESPONSE_TOO_LARGE",
|
||||
"The binary content exceeds 8 MiB.",
|
||||
));
|
||||
}
|
||||
request
|
||||
.header(CONTENT_TYPE, "application/octet-stream")
|
||||
.body(b)
|
||||
}
|
||||
};
|
||||
let response=request.send().await.map_err(|_|if write{AppError::unknown(target.clone())}else{AppError::new("CONNECTION_FAILED","Cannot reach the API using verified TLS. Check the URL, trusted CA and API proxy bypass.")})?;
|
||||
let status = response.status();
|
||||
if status.is_redirection() {
|
||||
return Err(AppError::new(
|
||||
"API_REDIRECT",
|
||||
"The API redirected the request. Check the API URL and reverse-proxy /api bypass; no redirect was followed.",
|
||||
));
|
||||
}
|
||||
if !status.is_success() {
|
||||
return Err(match status.as_u16() {
|
||||
401 | 403 => AppError::new(
|
||||
"ACCESS_DENIED",
|
||||
"The API rejected access. Check the dedicated user's key and household permissions.",
|
||||
),
|
||||
404 => AppError::new(
|
||||
"NOT_FOUND",
|
||||
"The requested record or API operation is unavailable.",
|
||||
),
|
||||
400 | 409 | 422 => AppError::new(
|
||||
"API_REJECTED",
|
||||
"Grocy rejected the operation. Check the target, fields, units and current state.",
|
||||
),
|
||||
_ if write => AppError::unknown(target),
|
||||
_ => AppError::new(
|
||||
"API_UNAVAILABLE",
|
||||
"The API is unavailable. Check Grocy health and whether an administrator must complete its upgrade.",
|
||||
),
|
||||
});
|
||||
}
|
||||
let outcome_error = |code, message| {
|
||||
if write {
|
||||
AppError::unknown(target.clone())
|
||||
} else {
|
||||
AppError::new(code, message)
|
||||
}
|
||||
};
|
||||
if response
|
||||
.headers()
|
||||
.get(CONTENT_ENCODING)
|
||||
.is_some_and(|e| e != "identity")
|
||||
{
|
||||
return Err(outcome_error(
|
||||
"COMPRESSION_REFUSED",
|
||||
"Compressed API responses are not supported.",
|
||||
));
|
||||
}
|
||||
let content_type = response
|
||||
.headers()
|
||||
.get(CONTENT_TYPE)
|
||||
.and_then(|v| v.to_str().ok())
|
||||
.unwrap_or("application/octet-stream")
|
||||
.split(';')
|
||||
.next()
|
||||
.unwrap_or("")
|
||||
.trim()
|
||||
.to_string();
|
||||
let limit = match r.kind {
|
||||
ResponseKind::Binary => BINARY_LIMIT,
|
||||
_ => JSON_LIMIT,
|
||||
};
|
||||
if response.content_length().is_some_and(|n| n > limit as u64) {
|
||||
return Err(outcome_error(
|
||||
"RESPONSE_TOO_LARGE",
|
||||
"The API response exceeds the configured size limit.",
|
||||
));
|
||||
}
|
||||
let mut bytes = Vec::new();
|
||||
let mut stream = response.bytes_stream();
|
||||
while let Some(chunk) = stream.next().await {
|
||||
let c = chunk.map_err(|_| {
|
||||
outcome_error("INCOMPLETE_RESPONSE", "The response was interrupted.")
|
||||
})?;
|
||||
if c.len() > limit - bytes.len() {
|
||||
return Err(outcome_error(
|
||||
"RESPONSE_TOO_LARGE",
|
||||
"The API response exceeds the configured size limit.",
|
||||
));
|
||||
}
|
||||
bytes.extend_from_slice(&c);
|
||||
}
|
||||
let body = match r.kind {
|
||||
ResponseKind::Json if bytes.is_empty() => ResponseBody::Json(Value::Null),
|
||||
ResponseKind::Json => {
|
||||
if content_type != "application/json" {
|
||||
return Err(outcome_error(
|
||||
"INVALID_RESPONSE",
|
||||
"Expected JSON from the API. Check the proxy bypass.",
|
||||
));
|
||||
}
|
||||
ResponseBody::Json(serde_json::from_slice(&bytes).map_err(|_| {
|
||||
outcome_error("INVALID_RESPONSE", "The API returned invalid JSON.")
|
||||
})?)
|
||||
}
|
||||
ResponseKind::Text => ResponseBody::Text(String::from_utf8(bytes).map_err(|_| {
|
||||
outcome_error("INVALID_RESPONSE", "The API returned invalid text.")
|
||||
})?),
|
||||
ResponseKind::Binary => ResponseBody::Binary(bytes),
|
||||
};
|
||||
Ok(ApiResponse {
|
||||
status: status.as_u16(),
|
||||
body,
|
||||
content_type,
|
||||
})
|
||||
}
|
||||
}
|
||||
38
src/error.rs
Normal file
38
src/error.rs
Normal file
@@ -0,0 +1,38 @@
|
||||
use serde::Serialize;
|
||||
use serde_json::{Value, json};
|
||||
#[derive(Debug, Clone, Serialize)]
|
||||
pub struct AppError {
|
||||
pub code: &'static str,
|
||||
pub message: &'static str,
|
||||
#[serde(skip_serializing_if = "Option::is_none")]
|
||||
pub recovery: Option<Value>,
|
||||
}
|
||||
pub type Result<T> = std::result::Result<T, AppError>;
|
||||
impl AppError {
|
||||
pub fn new(code: &'static str, message: &'static str) -> Self {
|
||||
Self {
|
||||
code,
|
||||
message,
|
||||
recovery: None,
|
||||
}
|
||||
}
|
||||
pub fn input() -> Self {
|
||||
Self::new(
|
||||
"INVALID_INPUT",
|
||||
"Check the tool schema and required fields.",
|
||||
)
|
||||
}
|
||||
pub fn unknown(target: Value) -> Self {
|
||||
Self {
|
||||
code: "UNKNOWN_WRITE_OUTCOME",
|
||||
message: "The write may have completed. Inspect current state before attempting another write; do not automatically repeat it.",
|
||||
recovery: Some(json!({"target":target})),
|
||||
}
|
||||
}
|
||||
}
|
||||
impl std::fmt::Display for AppError {
|
||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||
write!(f, "{}: {}", self.code, self.message)
|
||||
}
|
||||
}
|
||||
impl std::error::Error for AppError {}
|
||||
3
src/lib.rs
Normal file
3
src/lib.rs
Normal file
@@ -0,0 +1,3 @@
|
||||
pub mod client;
|
||||
pub mod error;
|
||||
pub mod model;
|
||||
1
src/main.rs
Normal file
1
src/main.rs
Normal file
@@ -0,0 +1 @@
|
||||
fn main() {}
|
||||
114
src/model.rs
Normal file
114
src/model.rs
Normal file
@@ -0,0 +1,114 @@
|
||||
use crate::{
|
||||
client::ApiBase,
|
||||
error::{AppError, Result},
|
||||
};
|
||||
use secrecy::SecretString;
|
||||
use serde::{Deserialize, Serialize};
|
||||
use serde_json::Value;
|
||||
use std::path::PathBuf;
|
||||
#[derive(Clone, Copy, Debug, Serialize, Deserialize, PartialEq, Eq)]
|
||||
#[serde(rename_all = "snake_case")]
|
||||
pub enum AccessMode {
|
||||
ReadOnly,
|
||||
Full,
|
||||
}
|
||||
#[derive(Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
|
||||
#[serde(rename_all = "snake_case")]
|
||||
pub enum TransportPolicy {
|
||||
HttpsOnly,
|
||||
LoopbackDevelopment,
|
||||
}
|
||||
#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq)]
|
||||
pub struct ProviderIdentity {
|
||||
pub bus_name: String,
|
||||
pub executable: PathBuf,
|
||||
}
|
||||
#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq)]
|
||||
pub struct ProfileSelection {
|
||||
pub profile: String,
|
||||
pub provider: ProviderIdentity,
|
||||
}
|
||||
pub struct PrivateProfile {
|
||||
pub api_base: ApiBase,
|
||||
pub api_key: SecretString,
|
||||
pub access: AccessMode,
|
||||
pub timezone: Option<String>,
|
||||
pub defaults: Value,
|
||||
pub ca_path: Option<PathBuf>,
|
||||
pub transport: TransportPolicy,
|
||||
pub unsafe_storage: bool,
|
||||
}
|
||||
#[derive(Clone, Copy, Debug)]
|
||||
pub struct Page {
|
||||
pub offset: usize,
|
||||
pub limit: usize,
|
||||
}
|
||||
impl Default for Page {
|
||||
fn default() -> Self {
|
||||
Self {
|
||||
offset: 0,
|
||||
limit: 100,
|
||||
}
|
||||
}
|
||||
}
|
||||
impl Page {
|
||||
pub fn new(offset: usize, limit: usize) -> Result<Self> {
|
||||
if !(1..=500).contains(&limit) || offset.checked_add(limit + 1).is_none() {
|
||||
return Err(AppError::input());
|
||||
}
|
||||
Ok(Self { offset, limit })
|
||||
}
|
||||
pub fn slice(&self, items: Vec<Value>) -> Value {
|
||||
let total = items.len();
|
||||
let data = items
|
||||
.into_iter()
|
||||
.skip(self.offset)
|
||||
.take(self.limit)
|
||||
.collect::<Vec<_>>();
|
||||
let more = self.offset.saturating_add(self.limit) < total;
|
||||
serde_json::json!({"items":data,"total":total,"has_more":more,"next_offset":if more{Some(self.offset+self.limit)}else{None}})
|
||||
}
|
||||
}
|
||||
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
|
||||
pub struct RecordId(pub u64);
|
||||
#[derive(Serialize, Debug, PartialEq, Eq)]
|
||||
#[serde(rename_all = "snake_case")]
|
||||
pub enum WriteStatus {
|
||||
Completed,
|
||||
}
|
||||
#[derive(Serialize, Debug, PartialEq, Eq)]
|
||||
#[serde(rename_all = "snake_case")]
|
||||
pub enum Verification {
|
||||
Confirmed,
|
||||
Incomplete,
|
||||
Unavailable,
|
||||
}
|
||||
#[derive(Serialize)]
|
||||
pub struct WriteReport {
|
||||
pub status: WriteStatus,
|
||||
pub verification: Verification,
|
||||
pub target: Value,
|
||||
pub receipt: Value,
|
||||
}
|
||||
pub struct Attachment {
|
||||
pub bytes: Vec<u8>,
|
||||
pub mime: String,
|
||||
pub name: String,
|
||||
}
|
||||
pub struct ToolOutput {
|
||||
pub data: Value,
|
||||
pub write: Option<WriteReport>,
|
||||
pub attachment: Option<Attachment>,
|
||||
}
|
||||
impl ToolOutput {
|
||||
pub fn data(data: Value) -> Self {
|
||||
Self {
|
||||
data,
|
||||
write: None,
|
||||
attachment: None,
|
||||
}
|
||||
}
|
||||
pub fn json(&self) -> Value {
|
||||
serde_json::json!({"data":self.data,"write":self.write})
|
||||
}
|
||||
}
|
||||
258
tests/client_boundary.rs
Normal file
258
tests/client_boundary.rs
Normal file
@@ -0,0 +1,258 @@
|
||||
use hermes_grocy_mcp::{client::ApiBase, model::TransportPolicy};
|
||||
#[test]
|
||||
fn api_boundary() {
|
||||
for (input, path) in [
|
||||
("https://grocy.example/household", "/household/api"),
|
||||
("https://grocy.example/household/api/", "/household/api"),
|
||||
("https://grocy.example", "/api"),
|
||||
] {
|
||||
assert_eq!(
|
||||
ApiBase::parse(input, TransportPolicy::HttpsOnly)
|
||||
.unwrap()
|
||||
.path(),
|
||||
path
|
||||
);
|
||||
}
|
||||
for input in [
|
||||
"https://user:pass@grocy.example/api",
|
||||
"https://@grocy.example/api",
|
||||
"http://2130706433/api",
|
||||
"https://grocy.example/api?q=1",
|
||||
"https://grocy.example/api#x",
|
||||
"https://grocy.example/a/../api",
|
||||
"https://grocy.example/%2e/api",
|
||||
"https://grocy.example/a%2fb/api",
|
||||
"https://grocy.example/%252f/api",
|
||||
"http://192.168.1.2/api",
|
||||
"http://localhost/api",
|
||||
] {
|
||||
assert!(
|
||||
ApiBase::parse(input, TransportPolicy::LoopbackDevelopment).is_err(),
|
||||
"accepted {input}"
|
||||
);
|
||||
}
|
||||
assert!(ApiBase::parse("http://127.0.0.1:8000", TransportPolicy::HttpsOnly).is_err());
|
||||
assert_eq!(
|
||||
ApiBase::parse(
|
||||
"http://127.0.0.1:8000",
|
||||
TransportPolicy::LoopbackDevelopment
|
||||
)
|
||||
.unwrap()
|
||||
.path(),
|
||||
"/api"
|
||||
);
|
||||
}
|
||||
|
||||
use axum::{Router, http::StatusCode, response::IntoResponse};
|
||||
use hermes_grocy_mcp::{
|
||||
client::{ApiClient, ApiRequest, HttpMethod, RequestBody, ResponseKind},
|
||||
model::{AccessMode, PrivateProfile},
|
||||
};
|
||||
use secrecy::SecretString;
|
||||
use std::{
|
||||
collections::BTreeMap,
|
||||
sync::{
|
||||
Arc,
|
||||
atomic::{AtomicUsize, Ordering},
|
||||
},
|
||||
};
|
||||
fn profile(url: &str) -> PrivateProfile {
|
||||
PrivateProfile {
|
||||
api_base: ApiBase::parse(url, TransportPolicy::LoopbackDevelopment).unwrap(),
|
||||
api_key: SecretString::from("synthetic-key"),
|
||||
access: AccessMode::Full,
|
||||
timezone: None,
|
||||
defaults: serde_json::Value::Null,
|
||||
ca_path: None,
|
||||
transport: TransportPolicy::LoopbackDevelopment,
|
||||
unsafe_storage: false,
|
||||
}
|
||||
}
|
||||
#[tokio::test]
|
||||
async fn write_dispatch_boundary() {
|
||||
let count = Arc::new(AtomicUsize::new(0));
|
||||
let counted = count.clone();
|
||||
let app = Router::new().fallback(move |req: axum::extract::Request| {
|
||||
let counted = counted.clone();
|
||||
async move {
|
||||
counted.fetch_add(1, Ordering::SeqCst);
|
||||
assert!(req.uri().path().starts_with("/household/api/"));
|
||||
assert_eq!(req.headers().get("GROCY-API-KEY").unwrap(), "synthetic-key");
|
||||
match req.uri().path() {
|
||||
"/household/api/redirect" => (
|
||||
StatusCode::FOUND,
|
||||
[("location", "http://127.0.0.1:1/secret")],
|
||||
"",
|
||||
)
|
||||
.into_response(),
|
||||
"/household/api/compressed" => {
|
||||
(StatusCode::OK, [("content-encoding", "gzip")], "data").into_response()
|
||||
}
|
||||
"/household/api/large-json" => (
|
||||
StatusCode::OK,
|
||||
[("content-type", "application/json")],
|
||||
"x".repeat(2 * 1024 * 1024 + 1),
|
||||
)
|
||||
.into_response(),
|
||||
"/household/api/large-file" => {
|
||||
(StatusCode::OK, "x".repeat(8 * 1024 * 1024 + 1)).into_response()
|
||||
}
|
||||
"/household/api/error" => {
|
||||
(StatusCode::BAD_REQUEST, "synthetic-private-marker").into_response()
|
||||
}
|
||||
"/household/api/empty" => StatusCode::NO_CONTENT.into_response(),
|
||||
_ => (
|
||||
StatusCode::OK,
|
||||
[("content-type", "application/json")],
|
||||
"{\"id\":7}",
|
||||
)
|
||||
.into_response(),
|
||||
}
|
||||
}
|
||||
});
|
||||
let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
|
||||
let port = listener.local_addr().unwrap().port();
|
||||
let server = tokio::spawn(async move { axum::serve(listener, app).await.unwrap() });
|
||||
let client = ApiClient::new(profile(&format!("http://127.0.0.1:{port}/household"))).unwrap();
|
||||
for (route, kind, code) in [
|
||||
("/redirect", ResponseKind::Json, "API_REDIRECT"),
|
||||
("/compressed", ResponseKind::Json, "COMPRESSION_REFUSED"),
|
||||
("/large-json", ResponseKind::Json, "RESPONSE_TOO_LARGE"),
|
||||
("/large-file", ResponseKind::Binary, "RESPONSE_TOO_LARGE"),
|
||||
("/error", ResponseKind::Json, "API_REJECTED"),
|
||||
] {
|
||||
let mut r = ApiRequest::get(route);
|
||||
r.kind = kind;
|
||||
let err = client.request(r).await.err().unwrap();
|
||||
assert_eq!(err.code, code);
|
||||
assert!(!err.to_string().contains("synthetic-private-marker"));
|
||||
}
|
||||
assert_eq!(count.load(Ordering::SeqCst), 5);
|
||||
let success = client
|
||||
.request(ApiRequest::get("/data"))
|
||||
.await
|
||||
.unwrap()
|
||||
.json()
|
||||
.unwrap();
|
||||
assert_eq!(success["id"], 7);
|
||||
let mut empty = ApiRequest::get("/empty");
|
||||
empty.method = HttpMethod::Put;
|
||||
assert!(
|
||||
client
|
||||
.request(empty)
|
||||
.await
|
||||
.unwrap()
|
||||
.json()
|
||||
.unwrap()
|
||||
.is_null()
|
||||
);
|
||||
let dead = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
|
||||
let port = dead.local_addr().unwrap().port();
|
||||
let attempts = Arc::new(AtomicUsize::new(0));
|
||||
let accepted = attempts.clone();
|
||||
let dropper = tokio::spawn(async move {
|
||||
let (s, _) = dead.accept().await.unwrap();
|
||||
accepted.fetch_add(1, Ordering::SeqCst);
|
||||
drop(s);
|
||||
tokio::time::sleep(std::time::Duration::from_millis(100)).await;
|
||||
});
|
||||
let c = ApiClient::new(profile(&format!("http://127.0.0.1:{port}"))).unwrap();
|
||||
let mut r = ApiRequest::get("/stock");
|
||||
r.method = HttpMethod::Post;
|
||||
r.body = RequestBody::Json(serde_json::json!({"amount":1}));
|
||||
assert_eq!(
|
||||
c.request(r).await.err().unwrap().code,
|
||||
"UNKNOWN_WRITE_OUTCOME"
|
||||
);
|
||||
dropper.await.unwrap();
|
||||
assert_eq!(attempts.load(Ordering::SeqCst), 1);
|
||||
let tls = ApiClient::new(profile(&format!("https://127.0.0.1:{port}"))).unwrap();
|
||||
assert_eq!(
|
||||
tls.request(ApiRequest::get("/data"))
|
||||
.await
|
||||
.err()
|
||||
.unwrap()
|
||||
.code,
|
||||
"CONNECTION_FAILED"
|
||||
);
|
||||
let mut path = BTreeMap::new();
|
||||
path.insert("id".into(), "a/b ?#%".into());
|
||||
assert_eq!(
|
||||
ApiBase::parse("https://grocy.example/prefix", TransportPolicy::HttpsOnly)
|
||||
.unwrap()
|
||||
.route("/objects/{id}", &path)
|
||||
.unwrap()
|
||||
.path(),
|
||||
"/prefix/api/objects/a%2Fb%20%3F%23%25"
|
||||
);
|
||||
server.abort();
|
||||
}
|
||||
|
||||
#[tokio::test]
|
||||
async fn untrusted_tls_certificate_is_rejected() {
|
||||
use std::process::{Command, Stdio};
|
||||
let dir = tempfile::tempdir().unwrap();
|
||||
let cert = dir.path().join("cert.pem");
|
||||
let key = dir.path().join("key.pem");
|
||||
assert!(
|
||||
Command::new("openssl")
|
||||
.args([
|
||||
"req",
|
||||
"-x509",
|
||||
"-newkey",
|
||||
"rsa:2048",
|
||||
"-nodes",
|
||||
"-days",
|
||||
"1",
|
||||
"-subj",
|
||||
"/CN=localhost",
|
||||
"-keyout"
|
||||
])
|
||||
.arg(&key)
|
||||
.arg("-out")
|
||||
.arg(&cert)
|
||||
.stdout(Stdio::null())
|
||||
.stderr(Stdio::null())
|
||||
.status()
|
||||
.unwrap()
|
||||
.success()
|
||||
);
|
||||
let listener = std::net::TcpListener::bind("127.0.0.1:0").unwrap();
|
||||
let port = listener.local_addr().unwrap().port();
|
||||
drop(listener);
|
||||
let mut server = Command::new("openssl")
|
||||
.args([
|
||||
"s_server",
|
||||
"-accept",
|
||||
&format!("127.0.0.1:{port}"),
|
||||
"-www",
|
||||
"-quiet",
|
||||
"-cert",
|
||||
])
|
||||
.arg(cert)
|
||||
.arg("-key")
|
||||
.arg(key)
|
||||
.stdout(Stdio::null())
|
||||
.stderr(Stdio::null())
|
||||
.spawn()
|
||||
.unwrap();
|
||||
let mut ready = false;
|
||||
for _ in 0..50 {
|
||||
if tokio::net::TcpStream::connect(("127.0.0.1", port))
|
||||
.await
|
||||
.is_ok()
|
||||
{
|
||||
ready = true;
|
||||
break;
|
||||
}
|
||||
tokio::time::sleep(std::time::Duration::from_millis(20)).await;
|
||||
}
|
||||
assert!(ready);
|
||||
let result = ApiClient::new(profile(&format!("https://127.0.0.1:{port}")))
|
||||
.unwrap()
|
||||
.request(ApiRequest::get("/data"))
|
||||
.await;
|
||||
let _ = server.kill();
|
||||
let _ = server.wait();
|
||||
assert_eq!(result.err().unwrap().code, "CONNECTION_FAILED");
|
||||
}
|
||||
Reference in New Issue
Block a user