jeff/ jtftp
1
0
Fork
Code Issues Pull Requests Packages Projects Releases Wiki Activity

initial commit

This commit is contained in:
Jeffrey C. Ollie 2022-07-07 12:37:41 -05:00
commit df6711c5bf
26 changed files with 4175 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
.gitignore vendored Normal file
View File

@ -0,0 +1,7 @@
/.venv
/result
__pycache__
/.pytest_cache
/.hypothesis
/htmlcov
/.coverage

23
.vscode/settings.json vendored Normal file
View File

@ -0,0 +1,23 @@
{
"python.formatting.provider": "black",
"editor.formatOnSave": true,
"files.autoSave": "afterDelay",
"files.trimTrailingWhitespace": true,
"files.insertFinalNewline": true,
"files.trimFinalNewlines": true,
"python.linting.flake8Enabled": true,
"python.linting.flake8Args": [
"--max-line-length=88",
"--extend-ignore=E501",
"--extend-select=B950"
],
"python.formatting.blackArgs": [
"--line-length=88"
],
"editor.codeActionsOnSave": {
"source.organizeImports": true,
},
"python.sortImports.args": [
"--force-single-line-imports"
]
}

674
LICENSE Normal file
View File

@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.

28
README.md Normal file
View File

@ -0,0 +1,28 @@
# Jeff's TFTP
TFTP server for Python using asyncio. Borrows heavily from [python-tx-tftp](https://github.com/shylent/python-tx-tftp) and
[aiotftp](https://github.com/sangoma/aiotftp). ``python-tx-tftp`` was not suitable for my needs as it's Python 3 support is limited, it uses Twisted instead of Python's native async support (Twisted is a fine library but I needed an implementation that )
## Features
* Use of newer Python features
* asyncio
* type hinting
* enums
## TODO
* More tests
* TFTP client
## Reference List
* [IEN 133](https://www.rfc-editor.org/ien/ien133.txt) - TFTP protocol
* [RFC 783](https://datatracker.ietf.org/doc/html/rfc783) - TFTP protocol revision 2
* [RFC 1350](https://datatracker.ietf.org/doc/html/rfc1350) - TFTP protocol revision 2
* [RFC 1782](https://datatracker.ietf.org/doc/html/rfc1782) - TFTP Option Extension
* [RFC 1783](https://datatracker.ietf.org/doc/html/rfc1783) - TFTP Blocksize Option
* [RFC 1784](https://datatracker.ietf.org/doc/html/rfc1784) - TFTP Timeout Interval and Transfer Size Options
* [RFC 1785](https://datatracker.ietf.org/doc/html/rfc1785) - TFTP Option Negotiation Analysis
* [RFC 2347](https://datatracker.ietf.org/doc/html/rfc2347) - TFTP Option Extension
* [RFC 2348](https://datatracker.ietf.org/doc/html/rfc2348) - TFTP Blocksize Option
* [RFC 2349](https://datatracker.ietf.org/doc/html/rfc2349) - TFTP Timeout Interval and Transfer Size Options

91
examples/main.py Normal file
View File

@ -0,0 +1,91 @@
# JTFTP - Python/AsyncIO TFTP Server
# Copyright (C) 2022 Jeffrey C. Ollie
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
import asyncio
import functools
import logging
import pathlib
import sys
import traceback
import arrow
from jtftp.filesystem.inmemory import InMemoryFilesystem
from jtftp.protocol import tftp_server_protocol_factory
logger = logging.getLogger(__name__)
class Formatter(logging.Formatter):
def __init__(self):
logging.Formatter.__init__(self, "")
def format(self, record: logging.LogRecord):
message = record.msg
if len(record.args) > 0:
message = record.msg % record.args
created = arrow.get(record.created).to("America/Chicago")
name = record.name
if len(name) > 25:
name = name[:24] + "\u2026"
msg = f"{created:YYYY-MM-DD HH:mm:ss.SSSSSS Z} [{name:^25s}] {record.levelname:8s} {message:s}"
if record.exc_info is not None:
msg += "\n"
lines = traceback.format_exception(*record.exc_info)
for line in lines:
msg += line
return msg.rstrip()
def formatTime(self, record: logging.LogRecord, datefmt=None): # noqa: N802
"""Format the timestamp."""
created = arrow.get(record.created)
return created.format("YYYY-MM-DD HH:mm:ss.SSSSSS Z")
def setup_logging() -> None:
"""Set up logging."""
formatter = Formatter()
console = logging.StreamHandler(stream=sys.stderr)
console.setFormatter(formatter)
console.setLevel(logging.DEBUG)
root = logging.getLogger()
for handler in root.handlers:
root.removeHandler(handler)
handler.close()
root.addHandler(console)
root.setLevel(logging.DEBUG)
logging.getLogger("opentelemetry").setLevel(logging.DEBUG)
logging.getLogger("urllib3.connectionpool").setLevel(logging.DEBUG)
logging.getLogger("cisco.connection").setLevel(logging.DEBUG)
def serve():
setup_logging()
# filesystem = TestFilesystem()
filesystem = InMemoryFilesystem()
loop = asyncio.get_event_loop()
future = loop.create_datagram_endpoint(
functools.partial(
tftp_server_protocol_factory, filesystem=filesystem, loop=loop
),
local_addr=("::", 69),
)
loop.run_until_complete(future)
loop.run_forever()

43
flake.lock Normal file
View File

@ -0,0 +1,43 @@
{
"nodes": {
"flake-utils": {
"locked": {
"lastModified": 1656065134,
"narHash": "sha256-oc6E6ByIw3oJaIyc67maaFcnjYOz1mMcOtHxbEf9NwQ=",
"owner": "numtide",
"repo": "flake-utils",
"rev": "bee6a7250dd1b01844a2de7e02e4df7d8a0a206c",
"type": "github"
},
"original": {
"owner": "numtide",
"repo": "flake-utils",
"type": "github"
}
},
"nixpkgs": {
"locked": {
"lastModified": 1656335358,
"narHash": "sha256-t0PZIFCKgjF2WQ0NC6ORigdGgLqQD3vtT+Jx/dhjNsY=",
"owner": "NixOS",
"repo": "nixpkgs",
"rev": "62de360d75419386b69ea4af4a8ce104949a8242",
"type": "github"
},
"original": {
"owner": "NixOS",
"ref": "nixos-22.05",
"repo": "nixpkgs",
"type": "github"
}
},
"root": {
"inputs": {
"flake-utils": "flake-utils",
"nixpkgs": "nixpkgs"
}
}
},
"root": "root",
"version": 7
}

50
flake.nix Normal file
View File

@ -0,0 +1,50 @@
{
inputs = {
nixpkgs = {
url = "github:NixOS/nixpkgs/nixos-22.05";
};
flake-utils = {
url = "github:numtide/flake-utils";
inputs.nixpkgs.follows = "nixpkgs";
};
};
outputs = { self, nixpkgs, flake-utils, ... }@inputs:
flake-utils.lib.eachDefaultSystem (system:
let
pkgs = import nixpkgs {
inherit system;
};
in
{
devShells.default =
let
python = pkgs.python310.withPackages (ps: with ps; [
poetry
]);
in
pkgs.mkShell {
buildInputs = [
python
];
shellHook = ''
export POETRY_VIRTUALENVS_IN_PROJECT=true
export PS1='\n\[\033[1;34m\][jtftp:\w]\$\[\033[0m\] '
'';
};
packages = {
jtftp = pkgs.poetry2nix.mkPoetryApplication {
python = pkgs.python310;
projectDir = ./.;
};
default = self.packages.${system}.jtftp;
};
apps = {
default = {
type = "app";
program = "${self.packages.${system}.jtftp}/bin/serve";
};
};
}
);
}

15
jtftp/__init__.py Normal file
View File

@ -0,0 +1,15 @@
# JTFTP - Python/AsyncIO TFTP Server
# Copyright (C) 2022 Jeffrey C. Ollie
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.

518
jtftp/datagram.py Normal file
View File

@ -0,0 +1,518 @@
# JTFTP - Python/AsyncIO TFTP Server
# Copyright (C) 2022 Jeffrey C. Ollie
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
import itertools
import logging
import struct
from abc import ABC
from abc import abstractmethod
from collections import OrderedDict
from enum import Enum
from enum import IntEnum
from typing import Any
from jtftp.errors import InvalidErrorcodeError
from jtftp.errors import InvalidOpcodeError
from jtftp.errors import OptionsDecodeError
from jtftp.errors import PayloadDecodeError
from jtftp.errors import WireProtocolError
logger = logging.getLogger(__name__)
class TFTPOption(bytes, Enum):
BLOCKSIZE = b"blksize"
TIMEOUT = b"timeout"
TRANSFER_SIZE = b"tsize"
@classmethod
def _missing_(cls, value: bytes | str):
if isinstance(value, str):
value = value.encode("ascii", "replace")
value = value.lower()
for member in cls:
if member.value == value:
return member
class TFTPMode(bytes, Enum):
MAIL = b"mail"
NETASCII = b"netascii"
OCTET = b"octet"
@classmethod
def _missing_(cls, value: bytes | str):
if isinstance(value, str):
value = value.encode("ascii", "replace")
value = value.lower()
for member in cls:
if member.value == value:
return member
class TFTPOpcode(IntEnum):
RRQ = 1
WRQ = 2
DATA = 3
ACK = 4
ERROR = 5
OACK = 6
class TFTPError(IntEnum):
NOT_DEFINED = 0
FILE_NOT_FOUND = 1
ACCESS_VIOLATION = 2
DISK_FULL = 3
ILLEGAL_OPERATION = 4
TID_UNKNOWN = 5
FILE_EXISTS = 6
NO_SUCH_USER = 7
TERM_OPTION = 8
def message(self) -> bytes:
match self.value:
case self.NOT_DEFINED:
return b""
case self.FILE_NOT_FOUND:
return b"File not found"
case self.ACCESS_VIOLATION:
return b"Access violation"
case self.DISK_FULL:
return b"Disk full or allocation exceeded"
case self.ILLEGAL_OPERATION:
return b"Illegal TFTP operation"
case self.TID_UNKNOWN:
return b"Unknown transfer ID"
case self.FILE_EXISTS:
return b"File already exists"
case self.NO_SUCH_USER:
return b"No such user"
case self.TERM_OPTION:
return b"Terminate transfer due to option negotiation"
def split_opcode(datagram: bytes) -> tuple[TFTPOpcode, bytes]:
"""Split the raw datagram into opcode and payload.
@param datagram: raw datagram
@type datagram: C{bytes}
@return: a 2-tuple, the first item is the opcode and the second item is the payload
@rtype: (C{OP}, C{bytes})
@raise WireProtocolError: if the opcode cannot be extracted
"""
try:
opcode = struct.unpack(b"!H", datagram[:2])[0]
try:
opcode = TFTPOpcode(opcode)
except ValueError:
raise InvalidOpcodeError(opcode)
return opcode, datagram[2:]
except struct.error:
raise WireProtocolError("failed to extract the opcode")
def assert_options(options: dict) -> None:
if __debug__:
for name, value in options.items():
assert isinstance(
name, TFTPOption
), f"{name} ({type(name)}) is not a TFTPOption"
def decode_options(parts: list[bytes]) -> dict[TFTPOption, Any]:
if parts and not parts[-1]:
parts.pop(-1)
# To maintain consistency during testing.
# The actual order of options is not important as per RFC2347
options = OrderedDict()
if len(parts) % 2:
raise OptionsDecodeError(f"no value for option {parts[-1]}")
iparts = iter(parts)
for name, value in [(name, next(iparts, None)) for name in iparts]:
try:
name = TFTPOption(name)
except ValueError:
raise OptionsDecodeError(
f"{name.decode('ascii', 'replace')!r} is not a valid option"
)
try:
match name:
case TFTPOption.BLOCKSIZE:
value = int(value)
if value < 8 or value > 65464:
raise OptionsDecodeError(
f"{value} is not a valid value for option {name.decode('ascii', 'replace')!r}"
)
case TFTPOption.TIMEOUT:
value = int(value)
if value < 1:
raise OptionsDecodeError(
f"{value} is not a valid value for option {name.decode('ascii', 'replace')!r}"
)
case TFTPOption.TRANSFER_SIZE:
value = int(value)
if value < 0:
raise OptionsDecodeError(
f"{value} is not a valid value for option {name.decode('ascii', 'replace')!r}"
)
except ValueError:
raise OptionsDecodeError(
f"{value.decode('ascii','replace')!r} is not a valid value for option {name.decode('ascii', 'replace')!r}"
)
if name in options:
raise OptionsDecodeError(
f"duplicate option specified: {name.decode('ascii', 'replace')!r}"
)
options[name] = value
return options
def encode_options(options: dict[TFTPOption, Any]) -> list[bytes]:
parts = []
for name, value in options.items():
match name:
case TFTPOption.BLOCKSIZE | TFTPOption.TIMEOUT | TFTPOption.TRANSFER_SIZE:
parts.append(bytes(name))
parts.append(f"{value:d}".encode("ascii"))
case _:
raise WireProtocolError(
f"unknown option {name.decode('ascii','replace')}"
)
return parts
class Datagram(ABC):
"""Base class for datagrams
@cvar opcode: The opcode, corresponding to this datagram
@type opcode: C{Opcode}
"""
opcode: TFTPOpcode
@classmethod
@abstractmethod
def from_wire(cls, payload: bytes):
"""Parse the payload and return a datagram object
@param payload: Binary representation of the payload (without the opcode)
@type payload: C{bytes}
"""
raise NotImplementedError("Subclasses must override this")
@abstractmethod
def to_wire(self) -> bytes:
"""Return the wire representation of the datagram.
@rtype: C{bytes}
"""
raise NotImplementedError("Subclasses must override this")
class RQDatagram(Datagram):
"""Base class for "RQ" (request) datagrams.
@ivar filename: File name, that corresponds to this request.
@type filename: C{bytes}
@ivar mode: Transfer mode. Valid values are C{netascii} and C{octet}.
Case-insensitive.
@type mode: C{bytes}
@ivar options: Any options, that were requested by the client (as per
U{RFC2374<http://tools.ietf.org/html/rfc2347>}
@type options: C{dict}
"""
filename: bytes
mode: TFTPMode
options: dict[TFTPOption, Any]
@classmethod
def from_wire(cls, payload: bytes):
"""Parse the payload and return a RRQ/WRQ datagram object.
@return: datagram object
@rtype: L{RRQDatagram} or L{WRQDatagram}
@raise OptionsDecodeError: if we failed to decode the options, requested
by the client
@raise PayloadDecodeError: if there were not enough fields in the payload.
Fields are terminated by NUL.
"""
parts = payload.split(b"\x00")
try:
filename, mode = parts.pop(0), parts.pop(0)
try:
mode = TFTPMode(mode)
except ValueError:
raise PayloadDecodeError(
f"{mode.decode('ascii', 'replace')!r} is not a valid mode"
)
except IndexError:
raise PayloadDecodeError("Not enough fields in the payload")
options = decode_options(parts)
return cls(filename, mode, options)
def __init__(
self, filename: bytes, mode: TFTPMode, options: dict[TFTPOption, bytes]
):
assert isinstance(filename, bytes)
assert isinstance(mode, TFTPMode)
assert_options(options)
self.filename = filename
self.mode = mode
self.options = options
def __repr__(self):
if self.options:
return f"<{self.__class__.__name__}(filename={self.filename}, mode={self.mode}, options={self.options})>"
return "<{self.__class__.__name__}(filename={self.filename}, mode={self.mode})>"
def to_wire(self):
opcode = struct.pack(b"!H", self.opcode)
if self.options:
options = b"\x00".join(encode_options(self.options))
return b"".join(
(opcode, self.filename, b"\x00", self.mode, b"\x00", options, b"\x00")
)
else:
return b"".join((opcode, self.filename, b"\x00", self.mode, b"\x00"))
class RRQDatagram(RQDatagram):
opcode = TFTPOpcode.RRQ
class WRQDatagram(RQDatagram):
opcode = TFTPOpcode.WRQ
class OACKDatagram(Datagram):
"""An OACK datagram
@ivar options: Any options, that were requested by the client (as per
U{RFC2374<http://tools.ietf.org/html/rfc2347>}
@type options: C{dict}
"""
opcode = TFTPOpcode.OACK
options = dict[TFTPOption, Any]
@classmethod
def from_wire(cls, payload: bytes):
"""Parse the payload and return an OACK datagram object.
@return: datagram object
@rtype: L{OACKDatagram}
@raise OptionsDecodeError: if we failed to decode the options
"""
parts = payload.split(b"\x00")
options = decode_options(parts)
return cls(options)
def __init__(self, options: dict[TFTPOption, Any]):
assert_options(options)
self.options = options
def __repr__(self) -> str:
return f"<{self.__class__.__name__}(options={self.options})>"
def to_wire(self) -> bytes:
opcode = struct.pack(b"!H", self.opcode)
if self.options:
options = b"\x00".join(encode_options(self.options))
return b"".join((opcode, options, b"\x00"))
else:
return opcode
class DATADatagram(Datagram):
"""A DATA datagram
@ivar blocknum: A block number, that this chunk of data is associated with
@type blocknum: C{int}
@ivar data: binary data
@type data: C{bytes}
"""
opcode = TFTPOpcode.DATA
payload: bytes
@classmethod
def from_wire(cls, payload: bytes):
"""Parse the payload and return a L{DATADatagram} object.
@param payload: Binary representation of the payload (without the opcode)
@type payload: C{bytes}
@return: A L{DATADatagram} object
@rtype: L{DATADatagram}
@raise PayloadDecodeError: if the format of payload is incorrect
"""
try:
block_number, payload = struct.unpack(b"!H", payload[:2])[0], payload[2:]
except struct.error:
raise PayloadDecodeError()
return cls(block_number, payload)
def __init__(self, block_number: int, payload: bytes):
assert isinstance(payload, bytes)
self.block_number = block_number
self.payload = payload
def __repr__(self) -> str:
return f"<{self.__class__.__name__}(blocknum={self.block_number}, {len(self.payload)} bytes of data)>"
def to_wire(self) -> bytes:
return b"".join(
(struct.pack(b"!HH", self.opcode, self.block_number), self.payload)
)
class ACKDatagram(Datagram):
"""An ACK datagram.
@ivar blocknum: Block number of the data chunk, which this datagram is supposed to acknowledge
@type blocknum: C{int}
"""
opcode = TFTPOpcode.ACK
block_number: int
@classmethod
def from_wire(cls, payload: bytes):
"""Parse the payload and return a L{ACKDatagram} object.
@param payload: Binary representation of the payload (without the opcode)
@type payload: C{bytes}
@return: An L{ACKDatagram} object
@rtype: L{ACKDatagram}
@raise PayloadDecodeError: if the format of payload is incorrect
"""
try:
block_number = struct.unpack(b"!H", payload)[0]
except struct.error:
raise PayloadDecodeError("Unable to extract the block number")
return cls(block_number)
def __init__(self, blocknum: int):
self.block_number = blocknum
def __repr__(self) -> str:
return f"<{self.__class__.__name__}(block_number={self.block_number})>"
def to_wire(self) -> bytes:
return struct.pack(b"!HH", self.opcode, self.block_number)
class ERRORDatagram(Datagram):
"""An ERROR datagram.
@ivar errorcode: A valid TFTP error code
@type errorcode: C{int}
@ivar errmsg: An error message, describing the error condition in which this
datagram was produced
@type errmsg: C{bytes}
"""
opcode = TFTPOpcode.ERROR
error_code: TFTPError
error_message: bytes
@classmethod
def from_wire(cls, payload: bytes):
"""Parse the payload and return a L{ERRORDatagram} object.
This method violates the standard a bit - if the error string was not
extracted, a default error string is generated, based on the error code.
@param payload: Binary representation of the payload (without the opcode)
@type payload: C{bytes}
@return: An L{ERRORDatagram} object
@rtype: L{ERRORDatagram}
@raise PayloadDecodeError: if the format of payload is incorrect
@raise InvalidErrorcodeError: a more specific exception, that is raised
if the error code was successfully, extracted, but it does not correspond
to any known/standartized error code values.
"""
try:
error_code = struct.unpack(b"!H", payload[:2])[0]
try:
error_code = TFTPError(error_code)
except ValueError as e:
raise InvalidErrorcodeError(error_code)
except struct.error:
raise PayloadDecodeError("Unable to extract the error code")
error_message = payload[2:].split(b"\x00")[0]
if not error_message:
error_message = error_code.message()
return cls(error_code, error_message)
@classmethod
def from_code(cls, error_code: TFTPError, error_message: bytes | str | None = None):
"""Create an L{ERRORDatagram}, given an error code and, optionally, an
error message to go with it. If not provided, default error message for
the given error code is used.
@param error_code: An error code
@type error_code: L{TFTPError}
@param error_message: An error message (optional)
@type error_message: C{bytes} or C{str} or C{NoneType}
@raise InvalidErrorcodeError: if the error code is not known
@return: an L{ERRORDatagram}
@rtype: L{ERRORDatagram}
"""
assert isinstance(error_code, TFTPError)
if isinstance(error_message, str):
error_message = error_message.encode("ascii", "replace")
elif error_message is None:
error_message = error_code.message()
assert isinstance(error_message, bytes)
return cls(error_code, error_message)
def __init__(self, error_code: TFTPError, error_message: bytes):
assert isinstance(error_message, bytes)
self.error_code = error_code
self.error_message = error_message
def to_wire(self) -> bytes:
return b"".join(
(
struct.pack(b"!HH", self.opcode, self.error_code),
self.error_message,
b"\x00",
)
)
class _DatagramFactory:
classes: dict[TFTPOpcode, Datagram] = {
TFTPOpcode.ACK: ACKDatagram,
TFTPOpcode.DATA: DATADatagram,
TFTPOpcode.ERROR: ERRORDatagram,
TFTPOpcode.OACK: OACKDatagram,
TFTPOpcode.RRQ: RRQDatagram,
TFTPOpcode.WRQ: WRQDatagram,
}
def __call__(self, datagram: bytes) -> Datagram:
opcode, payload = split_opcode(datagram)
try:
cls = self.classes[opcode]
except KeyError:
raise InvalidOpcodeError(opcode.value)
return cls.from_wire(payload)
datagram_factory = _DatagramFactory()

112
jtftp/errors.py Normal file
View File

@ -0,0 +1,112 @@
# JTFTP - Python/AsyncIO TFTP Server
# Copyright (C) 2022 Jeffrey C. Ollie
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
class TFTPError(Exception):
"""Base exception class for this package"""
class WireProtocolError(TFTPError):
"""Base exception class for wire-protocol level errors"""
class InvalidOpcodeError(WireProtocolError):
"""An invalid opcode was encountered"""
opcode: int
def __init__(self, opcode: int):
self.opcode = opcode
super().__init__(f"Invalid opcode: {opcode}")
class PayloadDecodeError(WireProtocolError):
"""Failed to parse the payload"""
class OptionsDecodeError(PayloadDecodeError):
"""Failed to parse options in the WRQ/RRQ datagram. It is distinct from
L{PayloadDecodeError} so that it can be caught and dealt with gracefully
(pretend we didn't see any options at all, perhaps).
"""
class InvalidErrorcodeError(PayloadDecodeError):
"""An ERROR datagram has an error code, that does not correspond to any known
error code values.
@ivar errorcode: The error code, that we were unable to parse
@type errorcode: C{int}
"""
error_code: int
def __init__(self, error_code: int):
self.error_code = error_code
super().__init__(f"unknown error code: {error_code}")
class BackendError(TFTPError):
"""Base exception class for backend errors"""
class Unsupported(BackendError):
"""Requested operation (read/write) is not supported"""
class AccessViolation(BackendError):
"""Illegal filesystem operation. Corresponds to the "(2) Access violation"
TFTP error code.
One of the prime examples of these is an attempt at directory traversal.
"""
class FileNotFound(BackendError):
"""File not found.
Corresponds to the "(1) File not found" TFTP error code.
@ivar file_path: Path to the file, that was requested
@type file_path: C{bytes} or L{twisted.python.filepath.FilePath}
"""
def __init__(self, file_path):
self.file_path = file_path
def __str__(self):
return f"File not found: {self.file_path}"
class FileExists(BackendError):
"""File exists.
Corresponds to the "(6) File already exists" TFTP error code.
@ivar file_path: Path to file
@type file_path: C{bytes} or L{twisted.python.filepath.FilePath}
"""
def __init__(self, file_path):
self.file_path = file_path
def __str__(self):
return f"File already exists: {self.file_path}"

53
jtftp/filesystem/__init__.py Normal file
View File

@ -0,0 +1,53 @@
# JTFTP - Python/AsyncIO TFTP Server
# Copyright (C) 2022 Jeffrey C. Ollie
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
import logging
from typing import Protocol
logger = logging.getLogger(__name__)
from enum import Enum
class FileMode(str, Enum):
BINARY_READ = "rb"
BINARY_WRITE = "wb"
class FileProtocol(Protocol):
closed: bool
async def length(self) -> int | None:
"""Return the length of the file, or None if the length cannot be determined."""
raise NotImplementedError
async def seek(self, offset: int, whence: int) -> int:
raise NotImplementedError
async def read(self, length: int) -> bytes:
raise NotImplementedError
async def write(self, data: bytes) -> int:
raise NotImplementedError
async def close(self, complete: bool) -> None:
raise NotImplementedError
class FilesystemProtocol(Protocol):
async def open(self, filename: bytes, mode: FileMode) -> FileProtocol:
raise NotImplementedError

102
jtftp/filesystem/inmemory.py Normal file
View File

@ -0,0 +1,102 @@
# JTFTP - Python/AsyncIO TFTP Server
# Copyright (C) 2022 Jeffrey C. Ollie
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
import io
import logging
from typing import Awaitable
from typing import Callable
from jtftp.filesystem import FileMode
logger = logging.getLogger(__name__)
class InMemoryFile:
filename: bytes
mode: FileMode
data: io.BytesIO
closed: bool
complete_callback: Callable[[bytes, bytes], Awaitable[None]] | None
incomplete_callback: Callable[[bytes, bytes], Awaitable[None]] | None
def __init__(
self,
filename: bytes,
mode: FileMode,
*,
initial_bytes: bytes | None = None,
complete_callback: Callable[[bytes, bytes], Awaitable[None]],
incomplete_callback: Callable[[bytes, bytes], Awaitable[None]],
):
logger.debug(f"myfile {filename} {mode}")
self.filename = filename
self.mode = mode
self.data = io.BytesIO(initial_bytes)
self.complete_callback = complete_callback
self.incomplete_callback = incomplete_callback
self.closed = False
async def length(self) -> int:
logger.debug("myfile length")
return len(self.data.getbuffer())
async def seek(self, offset: int, whence: int) -> int:
logger.debug(f"myfile seek {offset} {whence}")
return self.data.seek(offset, whence)
async def read(self, length: int) -> bytes:
logger.debug(f"myfile read {length}")
return self.data.read(length)
async def write(self, data: bytes) -> int:
logger.debug(f"myfile write {len(data)}")
return self.data.write(data)
async def close(self, complete: bool) -> None:
logger.debug(f"myfile close {complete}")
if complete:
await self.complete_callback(self.filename, self.data.getvalue())
else:
await self.incomplete_callback(self.filename, self.data.getvalue())
self.closed = True
class InMemoryFilesystem:
files: dict[bytes, bytes]
def __init__(self):
self.files = {}
async def open(self, filename: bytes, mode: FileMode) -> InMemoryFile:
logger.debug(f"InMemoryFilesystem open {filename} {mode}")
match mode:
case FileMode.BINARY_READ:
if filename not in self.files:
raise FileNotFoundError
return InMemoryFile(filename, mode, initial_bytes=self.files[filename])
case FileMode.BINARY_WRITE:
return InMemoryFile(
filename, mode, complete_callback=self._complete_callback
)
case _:
raise ValueError
async def _complete_callback(self, filename: bytes, data: bytes):
self.files[filename] = data

122
jtftp/filesystem/ondisk.py Normal file
View File

@ -0,0 +1,122 @@
# JTFTP - Python/AsyncIO TFTP Server
# Copyright (C) 2022 Jeffrey C. Ollie
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
#
# Warning!!! This does not actually work because aiofiles does not support
# usage outside of a context manager. See: https://github.com/Tinche/aiofiles/issues/139
#
import functools
import logging
import os
import pathlib
from typing import Callable
from typing import TypeVar
import aiofiles
import aiofiles.os
from jtftp.errors import AccessViolation
from jtftp.filesystem import FileMode
logger = logging.getLogger(__name__)
RT = TypeVar("RT")
def ensure_open(method: Callable[..., RT]) -> Callable[..., RT]:
@functools.wraps(method)
async def _impl(self, *args, **kwargs) -> RT:
logger.debug("ensure open")
if self.data is None:
await self.open()
return await method(self, *args, **kwargs)
return _impl
class OnDiskFile:
path: bytes
mode: FileMode
data: aiofiles.threadpool.binary.AsyncFileIO | None
closed: bool
def __init__(self, path: pathlib.PosixPath, mode: FileMode):
logger.debug(f"myfile {path} {mode}")
self.path = path
self.mode = mode
self.data = None
self.closed = True
async def open(self) -> None:
logger.debug("diskfile open")
self.data = aiofiles.open(self.path, self.mode.value)
self.closed = False
@ensure_open
async def length(self) -> int:
logger.debug("diskfile length")
cur = await self.data.seek(0, os.SEEK_CUR)
logger.debug(f"diskfile cur {cur}")
length = await self.data.seek(0, os.SEEK_END)
logger.debug(f"diskfile len {length}")
await self.data.seek(cur, os.SEEK_SET)
return length
@ensure_open
async def seek(self, offset: int, whence: int) -> int:
logger.debug(f"diskfile seek {offset} {whence}")
return await self.data.seek(offset, whence)
@ensure_open
async def read(self, length: int) -> bytes:
logger.debug(f"diskfile read {length}")
return await self.data.read(length)
@ensure_open
async def write(self, data: bytes) -> int:
logger.debug(f"diskfile write {len(data)}")
return await self.data.write(data)
@ensure_open
async def close(self, complete: bool) -> None:
logger.debug(f"diskfile close {complete}")
self.closed = True
if self.data is not None:
await self.data.close()
self.data = None
class ReadOnlyOnDiskFilesystem:
def __init__(self, root: pathlib.PosixPath):
self.root = root.resolve()
async def open(self, filename: bytes, mode: FileMode) -> OnDiskFile:
path = self.root.joinpath(filename.decode("ascii")).resolve()
try:
path.relative_to(self.root)
except ValueError:
raise AccessViolation("illegal directory traversal")
logger.debug(f"ro ondisk open {filename} {mode}")
match mode:
case FileMode.BINARY_READ:
return OnDiskFile(path, mode)
case FileMode.BINARY_WRITE:
raise AccessViolation("read-only")
case _:
raise ValueError

51
jtftp/filesystem/test.py Normal file
View File

@ -0,0 +1,51 @@
# JTFTP - Python/AsyncIO TFTP Server
# Copyright (C) 2022 Jeffrey C. Ollie
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
import io
import logging
import os
import random
from jtftp.errors import AccessViolation
from jtftp.filesystem import FileMode
from jtftp.filesystem.inmemory import InMemoryFile
logger = logging.getLogger(__name__)
class TestFilesystem:
async def open(self, filename: bytes, mode: FileMode) -> InMemoryFile:
logger.debug(f"TestFilesystem open {filename} {mode}")
match mode:
case FileMode.BINARY_READ:
if filename == b"random":
return InMemoryFile(
filename,
mode,
initial_bytes=os.urandom(random.randint(128, 16384)),
)
raise FileNotFoundError
case FileMode.BINARY_WRITE:
if filename.startswith(b"config"):
return InMemoryFile(filename, mode)
raise AccessViolation
case _:
raise ValueError

31
jtftp/log.py Normal file
View File

@ -0,0 +1,31 @@
"""Configure logging."""
# JTFTP - Python/AsyncIO TFTP Server
# Copyright (C) 2022 Jeffrey C. Ollie
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
import asyncio
import logging
logger = logging.getLogger(__name__)
def handle_task_result(task: asyncio.Task) -> None:
try:
task.result()
except asyncio.CancelledError:
pass
except Exception as e:
logger.exception(f"exception! {e}")

186
jtftp/netascii.py Normal file
View File

@ -0,0 +1,186 @@
# JTFTP - Python/AsyncIO TFTP Server
# Copyright (C) 2022 Jeffrey C. Ollie
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
import os
import re
from enum import Enum
from jtftp.filesystem import FileProtocol
class NetAsciiBase(bytes, Enum):
CR: bytes
LF: bytes
CRLF: bytes
NUL: bytes
CRNUL: bytes
NL: bytes
_re_from_netascii: re.Pattern[bytes]
_re_to_netascii: re.Pattern[bytes]
@classmethod
def _convert_from_netascii(cls, match_obj: re.Match) -> bytes | None:
match match_obj.group(1):
case cls.CRNUL:
return cls.CR
case cls.CRLF:
return cls.NL
@classmethod
def _convert_to_netascii(cls, match_obj: re.Match) -> bytes | None:
match match_obj.group(1):
case cls.NL:
return cls.CRLF
case cls.CR:
return cls.CRNUL
@classmethod
def from_netascii(cls, data: bytes) -> bytes:
"""Convert a netascii-encoded string into a string with platform-specific
newlines.
"""
if not hasattr(cls, "_re_from_netascii"):
cls._re_from_netascii = re.compile(rb"(\x0d\x0a|\x0d\x00)")
return cls._re_from_netascii.sub(cls._convert_from_netascii, data)
@classmethod
def to_netascii(cls, data: bytes) -> bytes:
"""Convert a string with platform-specific newlines into netascii."""
if not hasattr(cls, "_re_from_netascii"):
cls._re_to_netascii = re.compile(rb"(" + cls.NL + rb"|\x0d\x00)")
return cls._re_to_netascii.sub(cls._convert_to_netascii, data)
class NetAsciiCR(NetAsciiBase):
CR = b"\x0d"
LF = b"\x0a"
CRLF = b"\x0d\x0a" # CR + LF
NUL = b"\x00"
CRNUL = b"\x0d\x00" # CR + NUL
NL = b"\x0d"
class NetAsciiLF(NetAsciiBase):
CR = b"\x0d"
LF = b"\x0a"
CRLF = b"\x0d\x0a" # CR + LF
NUL = b"\x00"
CRNUL = b"\x0d\x00" # CR + NUL
NL = b"\x0a"
class NetAsciiCRLF(NetAsciiBase):
CR = b"\x0d"
LF = b"\x0a"
CRLF = b"\x0d\x0a" # CR + LF
NUL = b"\x00"
CRNUL = b"\x0d\x00" # CR + NUL
NL = b"\x0d\x0a"
NetAscii: NetAsciiBase
match os.linesep:
case "\x0d":
NetAscii = NetAsciiCR
case "\x0a":
NetAscii = NetAsciiLF
case "\x0d\x0a":
NetAscii = NetAsciiCRLF
case _:
raise RuntimeError(f"{os.linesep!r} is not a supported line separator")
class NetAsciiReceiverProxy:
writer: FileProtocol
netascii: NetAsciiBase
carry_cr: bool
def __init__(self, writer: FileProtocol, netascii: NetAsciiBase = NetAscii):
self.writer = writer
self.netascii = netascii
self.carry_cr = False
@property
def closed(self) -> bool:
return self.writer.closed
async def length(self) -> int | None:
return None
async def seek(self, offset: int, whence: int) -> int:
raise RuntimeError(f"{self.__class__.__name__} cannot seek")
async def read(self, length: int) -> bytes:
raise RuntimeError(f"{self.__class__.__name__} cannot read")
async def write(self, data: bytes) -> int:
if self.carry_cr:
data = self.netascii.CR + data
data = self.netascii.from_netascii(data)
if data.endswith(self.netascii.CR):
self.carry_cr = True
return await self.writer.write(data[:-1])
else:
self.carry_cr = False
return await self.writer.write(data)
async def close(self, complete: bool):
if self.carry_cr:
await self.writer.write(self.netascii.CR)
await self.writer.close(complete)
class NetAsciiSenderProxy:
reader: FileProtocol
netascii: NetAsciiBase
buffer: bytes
def __init__(self, reader: FileProtocol, netascii: NetAsciiBase = NetAscii):
self.reader = reader
self.netascii = netascii
self.buffer = b""
@property
def closed(self) -> bool:
return self.reader.closed
async def length(self) -> int | None:
return None
async def seek(self, offset: int, whence: int) -> int:
raise RuntimeError(f"{self.__class__.__name__} cannot seek")
async def read(self, length: int) -> bytes:
need_bytes = length - len(self.buffer)
if need_bytes <= 0:
data, self.buffer = self.buffer[:length], self.buffer[length:]
return data
data = await self.reader.read(need_bytes)
data = self.buffer + self.netascii.to_netascii(data)
data, self.buffer = data[:length], data[length:]
async def write(self, data: bytes) -> int:
raise RuntimeError(f"{self.__class__.__name__} cannot write")
async def close(self, complete: bool):
await self.reader.close(complete)

169
jtftp/protocol/__init__.py Normal file
View File

@ -0,0 +1,169 @@
# JTFTP - Python/AsyncIO TFTP Server
# Copyright (C) 2022 Jeffrey C. Ollie
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
import asyncio
import functools
import logging
from jtftp.datagram import Datagram
from jtftp.datagram import ERRORDatagram
from jtftp.datagram import RRQDatagram
from jtftp.datagram import TFTPError
from jtftp.datagram import TFTPMode
from jtftp.datagram import WRQDatagram
from jtftp.datagram import datagram_factory
from jtftp.errors import OptionsDecodeError
from jtftp.errors import PayloadDecodeError
from jtftp.filesystem import FileMode
from jtftp.filesystem import FilesystemProtocol
from jtftp.log import handle_task_result
from jtftp.netascii import NetAscii
from jtftp.netascii import NetAsciiReceiverProxy
from jtftp.netascii import NetAsciiSenderProxy
from jtftp.protocol.remote_origin_read import remote_origin_read_protocol
from jtftp.protocol.remote_origin_write import remote_origin_write_protocol
logger = logging.getLogger(__name__)
class TftpServerProtocol(asyncio.DatagramProtocol):
filesystem: FilesystemProtocol
loop: asyncio.AbstractEventLoop
def __init__(
self, filesystem: FilesystemProtocol, loop: asyncio.AbstractEventLoop = None
):
super().__init__()
self.filesystem = filesystem
if loop is None:
loop = asyncio.get_event_loop()
self.loop = loop
def connection_made(self, transport: asyncio.transports.DatagramTransport) -> None:
logger.debug(f"listening on made {transport.get_extra_info('sockname')[:2]}")
self.transport = transport
async def send(self, datagram: Datagram, tid: tuple[str, int]) -> None:
self.transport.sendto(datagram.to_wire(), tid)
def datagram_received(
self, data: bytes, addr: tuple[str, int] | tuple[str, int, int, int]
) -> None:
logger.debug(f"datagram received: {data!r} {addr!r}")
tid = addr[:2]
task = self.loop.create_task(self._datagram_received(data, tid))
task.add_done_callback(handle_task_result)
async def _datagram_received(self, data: bytes, tid: tuple[str, int]) -> None:
try:
datagram = datagram_factory(data)
except OptionsDecodeError as e:
await self.send(
ERRORDatagram.from_code(TFTPError.ILLEGAL_OPERATION, str(e)),
tid,
)
return
except PayloadDecodeError as e:
await self.send(
ERRORDatagram.from_code(TFTPError.ILLEGAL_OPERATION, str(e)),
tid,
)
return
if not isinstance(datagram, (RRQDatagram, WRQDatagram)):
logger.warning(
f"Datagram with unexpected opcode {datagram.opcode} was received without establishing the session. Ignoring."
)
return
if datagram.mode == TFTPMode.MAIL:
errmsg = f"Usupported transfer mode '{datagram.mode.decode('ascii')}'"
await self.send(
ERRORDatagram.from_code(TFTPError.ILLEGAL_OPERATION, errmsg),
tid,
)
return
match datagram:
case WRQDatagram():
try:
file = await self.filesystem.open(
datagram.filename, FileMode.BINARY_WRITE
)
if datagram.mode != TFTPMode.OCTET:
file = NetAsciiReceiverProxy(file)
protocol = functools.partial(
remote_origin_write_protocol,
file=file,
options=datagram.options,
loop=self.loop,
)
except PermissionError:
await self.send(
ERRORDatagram.from_code(TFTPError.ACCESS_VIOLATION),
tid,
)
return
except FileExistsError:
await self.send(
ERRORDatagram.from_code(TFTPError.FILE_NOT_FOUND),
tid,
)
return
case RRQDatagram():
try:
file = await self.filesystem.open(
datagram.filename, FileMode.BINARY_READ
)
if datagram.mode != TFTPMode.OCTET:
file = NetAsciiSenderProxy(file)
protocol = functools.partial(
remote_origin_read_protocol,
file=file,
options=datagram.options,
loop=self.loop,
)
except PermissionError:
await self.send(
ERRORDatagram.from_code(TFTPError.ACCESS_VIOLATION),
tid,
)
return
except FileNotFoundError:
await self.send(
ERRORDatagram.from_code(TFTPError.FILE_NOT_FOUND),
tid,
)
return
await self.loop.create_datagram_endpoint(
protocol,
local_addr=None,
remote_addr=tid,
)
def tftp_server_protocol_factory(
*, filesystem: FilesystemProtocol, loop: asyncio.AbstractEventLoop = None
) -> TftpServerProtocol:
return TftpServerProtocol(filesystem=filesystem, loop=loop)

191
jtftp/protocol/remote_origin_read.py Normal file
View File

@ -0,0 +1,191 @@
# JTFTP - Python/AsyncIO TFTP Server
# Copyright (C) 2022 Jeffrey C. Ollie
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
import asyncio
import functools
import itertools
import logging
from collections import OrderedDict
from jtftp.datagram import ACKDatagram
from jtftp.datagram import DATADatagram
from jtftp.datagram import Datagram
from jtftp.datagram import ERRORDatagram
from jtftp.datagram import OACKDatagram
from jtftp.datagram import TFTPError
from jtftp.datagram import TFTPMode
from jtftp.datagram import TFTPOption
from jtftp.datagram import datagram_factory
from jtftp.filesystem import FileProtocol
from jtftp.log import handle_task_result
from jtftp.util import timed_caller
logger = logging.getLogger(__name__)
class RemoteOriginReadProtocol(asyncio.DatagramProtocol):
block_size: int
timeout: tuple[int, int, int]
transfer_size: int | None
retransmit_task: asyncio.Task | None
last_block_number: int
last_block_sent: False
offered_options: dict[TFTPOption, bytes]
accepted_options: dict[TFTPOption, bytes]
local_tid = tuple[str, int]
remote_tid = tuple[str, int]
def __init__(
self,
*,
file: FileProtocol,
options: dict[TFTPOption, bytes],
loop: asyncio.AbstractEventLoop,
) -> None:
super().__init__()
self.file = file
self.loop = loop
self.block_size = 512
self.timeout = (1, 3, 7)
self.transfer_size = None
self.last_block_number = 0
self.last_block_sent = False
self.offered_options = options
self.accepted_options = OrderedDict()
self.remote_tid = tuple[str, int]
def connection_made(self, transport: asyncio.transports.DatagramTransport) -> None:
self.transport = transport
self.local_tid = transport.get_extra_info("sockname")[:2]
self.remote_tid = transport.get_extra_info("peername")[:2]
task = self.loop.create_task(self._connection_made())
task.add_done_callback(handle_task_result)
async def _connection_made(self):
logger.debug(f"new session between {self.local_tid} → {self.remote_tid}")
for name, value in self.offered_options.items():
logger.debug(f"{name!r} {value!r}")
match name:
case TFTPOption.BLOCKSIZE:
if value >= 8 and value <= 65464:
self.block_size = value
self.accepted_options[name] = value
case TFTPOption.TIMEOUT:
self.timeout = (value,) * 3
self.accepted_options[name] = value
case TFTPOption.TRANSFER_SIZE:
self.transfer_size = await self.file.length()
if self.transfer_size is not None:
self.accepted_options[name] = self.transfer_size
case _:
logger.warning(f"unknown option {name}: {value}")
if len(self.offered_options) != 0:
data = OACKDatagram(self.accepted_options)
else:
data = await self._get_next_block()
self.retransmit_task = self.loop.create_task(
timed_caller(
itertools.chain((0,), self.timeout),
functools.partial(self.send, data),
self._timed_out,
)
)
self.retransmit_task.add_done_callback(handle_task_result)
def connection_lost(self, exc: Exception | None) -> None:
return super().connection_lost(exc)
async def send(self, datagram: Datagram):
self.transport.sendto(datagram.to_wire())
def datagram_received(
self, datagram: bytes, addr: tuple[str, int] | tuple[str, int, int, int]
) -> None:
tid = addr[:2]
if self.remote_tid != tid:
logger.error(f"packet from unknown sender {tid}")
return
task = self.loop.create_task(self._datagram_received(datagram))
task.add_done_callback(handle_task_result)
async def _datagram_received(self, datagram: bytes) -> None:
datagram = datagram_factory(datagram)
if isinstance(datagram, ACKDatagram):
if datagram.block_number == self.last_block_number:
if (
self.retransmit_task is not None
and not self.retransmit_task.cancelled()
):
self.retransmit_task.cancel()
self.retransmit_task = None
if self.last_block_sent:
await self.file.close(complete=True)
self.transport.close()
return
data = await self._get_next_block()
self.retransmit_task = asyncio.create_task(
timed_caller(
itertools.chain((0,), self.timeout),
functools.partial(self.send, data),
self._timed_out,
)
)
self.retransmit_task.add_done_callback(handle_task_result)
else:
logger.warning(
f"received ack for block number {datagram.block_number} - was expecting {self.last_block_number}"
)
else:
await self.send(ERRORDatagram.from_code(TFTPError.ILLEGAL_OPERATION))
async def _get_next_block(self) -> Datagram:
payload = await self.file.read(self.block_size)
if len(payload) < self.block_size:
self.last_block_sent = True
self.last_block_number = (self.last_block_number + 1) % 65536
return DATADatagram(self.last_block_number, payload)
async def _timed_out(self):
logger.debug("timed out")
if self.retransmit_task is not None and not self.retransmit_task.cancelled():
self.retransmit_task.cancel()
self.retransmit_task = None
await self.file.close(complete=False)
self.transport.close()
def __del__(self):
logger.debug("RemoteOriginReadProtocol __del__")
def remote_origin_read_protocol(
*,
file: FileProtocol,
options: dict[bytes, bytes],
loop: asyncio.AbstractEventLoop,
) -> RemoteOriginReadProtocol:
return RemoteOriginReadProtocol(file=file, options=options, loop=loop)

202
jtftp/protocol/remote_origin_write.py Normal file
View File

@ -0,0 +1,202 @@
# JTFTP - Python/AsyncIO TFTP Server
# Copyright (C) 2022 Jeffrey C. Ollie
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
import asyncio
import functools
import itertools
import logging
from collections import OrderedDict
from jtftp.datagram import ACKDatagram
from jtftp.datagram import DATADatagram
from jtftp.datagram import Datagram
from jtftp.datagram import ERRORDatagram
from jtftp.datagram import OACKDatagram
from jtftp.datagram import TFTPError
from jtftp.datagram import TFTPMode
from jtftp.datagram import TFTPOption
from jtftp.datagram import datagram_factory
from jtftp.filesystem import FileProtocol
from jtftp.log import handle_task_result
from jtftp.util import timed_caller
logger = logging.getLogger(__name__)
class RemoteOriginWriteProtocol(asyncio.DatagramProtocol):
block_size: int
timeout: tuple[int, int, int]
transfer_size: int | None
retransmit_task: asyncio.Task | None
offered_options: dict[TFTPOption, bytes]
accepted_options: dict[TFTPOption, bytes]
local_tid: tuple[str, int]
remote_tid: tuple[str, int]
def __init__(
self,
*,
file: FileProtocol,
options: dict[TFTPOption, bytes],
loop: asyncio.AbstractEventLoop,
) -> None:
super().__init__()
self.file = file
self.offered_options = options
self.loop = loop
self.block_size = 512
self.timeout = (1, 3, 7)
self.transfer_size = None
self.retransmit_task = None
self.accepted_options = OrderedDict()
self.local_tid = None
self.remote_tid = None
def connection_made(self, transport: asyncio.transports.DatagramTransport) -> None:
self.transport = transport
self.local_tid = transport.get_extra_info("sockname")[:2]
self.remote_tid = self.transport.get_extra_info("peername")[:2]
task = self.loop.create_task(self._connection_made())
task.add_done_callback(handle_task_result)
async def _connection_made(self):
logger.debug(f"new session between {self.local_tid} → {self.remote_tid}")
for name, value in self.offered_options.items():
logger.debug(f"{name!r} {value!r}")
match name:
case TFTPOption.BLOCKSIZE:
self.block_size = int(value)
self.accepted_options[name] = value
case TFTPOption.TIMEOUT:
self.timeout = (int(value),) * 3
self.accepted_options[name] = value
case TFTPOption.TRANSFER_SIZE:
self.transfer_size = int(value)
self.accepted_options[name] = value
case _:
logger.warning(f"unknown option {name}: {value}")
if len(self.offered_options) == 0:
data = ACKDatagram(0).to_wire()
else:
data = OACKDatagram(self.accepted_options).to_wire()
self.retransmit_task = asyncio.create_task(
timed_caller(
itertools.chain((0,), self.timeout),
functools.partial(self.transport.sendto, data),
self._timed_out,
)
)
def connection_lost(self, exc: Exception | None) -> None:
logger.debug(f"closed session between {self.local_tid} → {self.remote_tid}")
return super().connection_lost(exc)
async def send(self, datagram: Datagram) -> None:
self.transport.sendto(datagram.to_wire())
def datagram_received(
self, datagram: bytes, addr: tuple[str, int] | tuple[str, int, int, int]
) -> None:
logger.debug(
f"RemoteOriginWriteProtocol data_received {len(datagram)} {addr!r}"
)
tid = addr[:2]
task = self.loop.create_task(self._datagram_received(datagram, tid))
task.add_done_callback(handle_task_result)
async def _datagram_received(self, datagram: bytes, tid: tuple[str, int]) -> None:
if self.remote_tid != tid:
logger.error(f"received packet from wrong address: {tid}")
if (
self.retransmit_task is not None
and not self.retransmit_task.cancelled()
):
self.retransmit_task.cancel()
self.retransmit_task = None
await self.file.close(complete=False)
self.transport.close()
return
datagram = datagram_factory(datagram)
if not isinstance(datagram, DATADatagram):
if (
self.retransmit_task is not None
and not self.retransmit_task.cancelled()
):
self.retransmit_task.cancel()
self.retransmit_task = None
await self.file.close(complete=False)
await self.send(ERRORDatagram.from_code(TFTPError.ILLEGAL_OPERATION))
self.transport.close()
return
logger.debug(f"RemoteOriginWriteProtocol data_received {datagram!r} {tid!r}")
if self.retransmit_task is not None and not self.retransmit_task.cancelled():
logger.debug("cancelling old timeout task")
self.retransmit_task.cancel()
self.retransmit_task = None
# need to check block numbers
if len(datagram.payload) == self.block_size:
self.file.write(datagram.payload)
self.retransmit_task = asyncio.create_task(
timed_caller(
itertools.chain((0,), self.timeout),
functools.partial(
self.send,
ACKDatagram(datagram.block_number),
),
self._timed_out,
)
)
self.retransmit_task.add_done_callback(handle_task_result)
else:
logger.debug(f"last data packet received")
await self.file.write(datagram.payload)
await self.file.close(complete=True)
await self.send(ACKDatagram(datagram.block_number))
self.transport.close()
async def _timed_out(self):
logger.debug("timed out")
if self.retransmit_task is not None and not self.retransmit_task.cancelled():
self.retransmit_task.cancel()
self.retransmit_task = None
await self.file.close(complete=False)
self.transport.close()
def __del__(self):
logger.debug("RemoteOriginWriteProtocol __del__")
def remote_origin_write_protocol(
*,
file: FileProtocol,
options: dict[TFTPOption, bytes],
loop: asyncio.AbstractEventLoop,
) -> RemoteOriginWriteProtocol:
return RemoteOriginWriteProtocol(file=file, options=options, loop=loop)

85
jtftp/util.py Normal file
View File

@ -0,0 +1,85 @@
# JTFTP - Python/AsyncIO TFTP Server
# Copyright (C) 2022 Jeffrey C. Ollie
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
import asyncio
import itertools
import logging
from typing import Annotated
from typing import Awaitable
from typing import Callable
from typing import Iterable
from typing import TypeVar
from annotated_types import Ge
logger = logging.getLogger(__name__)
T = TypeVar("T")
def iterlast(iterable: Iterable[T]) -> Iterable[tuple[bool, T]]:
"""Generate C{(is_last, item)} tuples from C{iterable}.
On each iteration this peeks ahead to see if the most recent iteration
will be the last, and returns this information as the C{is_last} element
of each tuple.
"""
iterable, peekable = itertools.tee(iterable)
try:
# advance the peekable iterator
next(peekable)
except StopIteration:
# the iterator is zero length
return
for item in iterable:
try:
next(peekable)
except StopIteration:
yield True, item
else:
yield False, item
async def timed_caller(
timings: Iterable[Annotated[int, Ge(0)]],
call: Callable[[None], Awaitable[None]],
last: Callable[[None], Awaitable[None]],
) -> None:
"""Call C{call} or C{last} according to C{timings}.
The given C{timings} is an iterable of numbers. Each is a delay in seconds
that will be taken before making the next call to C{call} or C{last}.
The call to C{last} will happen after the last delay. If C{timings} is an
infinite iterable then C{last} will never be called.
@raise ValueError: if no timings are specified; there must be at least
one, even if it specifies a zero seconds delay.
@raise ValueError: if a negative timing is specified.
"""
no_timings = True
for is_last, timing in iterlast(timings):
no_timings = False
if timing < 0:
raise ValueError("negative timing")
await asyncio.sleep(timing)
if is_last:
await last()
else:
await call()
if no_timings:
raise ValueError("no timings specified")

1035
poetry.lock generated Normal file
View File

File diff suppressed because it is too large Load Diff

28
pyproject.toml Normal file
View File

@ -0,0 +1,28 @@
[tool.poetry]
name = "jtftp"
version = "0.1.0"
description = "Jeff's TFTP"
authors = ["Jeffrey C. Ollie <jeff@ocjtech.us>"]
[tool.poetry.dependencies]
python = "^3.10"
arrow = "^1.2.2"
prometheus-async = {extras = ["aiohttp"], version = "^22.2.0"}
annotated-types = "^0.2.0"
aiofiles = "^0.8.0"
[tool.poetry.dev-dependencies]
black = "^22.6.0"
flake8 = "^4.0.1"
flake8-bugbear = "^22.6.22"
hypothesis = "^6.48.2"
pytest = "^7.1.2"
pytest-asyncio = "^0.18.3"
pytest-cov = "^3.0.0"
[tool.poetry.scripts]
serve = 'examples.main:serve'
[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

2
pytest.ini Normal file
View File

@ -0,0 +1,2 @@
[pytest]
asyncio_mode = strict

214
test/test_datagram.py Normal file
View File

@ -0,0 +1,214 @@
# JTFTP - Python/AsyncIO TFTP Server
# Copyright (C) 2022 Jeffrey C. Ollie
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
from typing import OrderedDict
from hypothesis import given
from hypothesis.strategies import integers
from jtftp.datagram import RQDatagram
from jtftp.datagram import RRQDatagram
from jtftp.datagram import TFTPError
from jtftp.datagram import TFTPMode
from jtftp.datagram import TFTPOpcode
from jtftp.datagram import TFTPOption
from jtftp.datagram import datagram_factory
from jtftp.datagram import decode_options
from jtftp.datagram import split_opcode
from jtftp.errors import InvalidOpcodeError
from jtftp.errors import OptionsDecodeError
from jtftp.errors import PayloadDecodeError
from jtftp.errors import WireProtocolError
from pytest import raises
@given(integers(min_value=1, max_value=6))
def test_tftp_opcode_normal(opcode: int):
assert TFTPOpcode(opcode).value == opcode
def test_tftp_opcode_abnormal():
with raises(ValueError):
TFTPOpcode(7)
@given(integers(min_value=0, max_value=8))
def test_tftperror_normal(error_code: int):
assert TFTPError(error_code).value == error_code
def test_option_wrong_case():
assert TFTPOption(b"BLKSIZE") == TFTPOption.BLOCKSIZE
def test_option_wrong_type():
assert TFTPOption("blksize") == TFTPOption.BLOCKSIZE
def test_mode_wrong_case():
assert TFTPMode(b"OCTET") == TFTPMode.OCTET
def test_mode_wrong_type():
assert TFTPMode("octet") == TFTPMode.OCTET
def test_datagram_zero_length():
with raises(WireProtocolError):
split_opcode(b"")
def test_datagram_incomplete_opcode():
with raises(WireProtocolError):
split_opcode(b"\x00")
def test_datagram_invalid_opcode():
with raises(InvalidOpcodeError):
split_opcode(b"\x00\xff")
def test_datagram_empty_payload():
assert split_opcode(b"\x00\x01") == (1, b"")
def test_datagram_non_empty_payload():
assert split_opcode(b"\x00\x01foo") == (1, b"foo")
def test_datagram_unknown_opcode():
with raises(WireProtocolError):
datagram_factory(b"\x00\x0ffoobar")
def test_rq_datagram():
with raises(WireProtocolError):
RQDatagram.from_wire(b"foobar")
def test_rq_datagram_invalid_mode():
with raises(PayloadDecodeError):
RQDatagram.from_wire(b"foo\x00bar\x00")
def test_rq_datagram_valid_mode():
dgram = RQDatagram.from_wire(b"foo\x00octet")
dgram.opcode = TFTPOpcode.RRQ
assert dgram.to_wire() == b"\x00\x01foo\x00octet\x00"
def test_decode_options_missing_value():
with raises(OptionsDecodeError):
decode_options([b"blksize"])
def test_decode_options_duplicate_value():
with raises(OptionsDecodeError):
decode_options([b"blksize", b"1024", b"blksize", b"2048"])
def test_rq_datagam_invalid_option_name():
with raises(PayloadDecodeError):
RQDatagram.from_wire(b"foo\x00octet\x00spam\x00baz\x00")
def test_rq_datagam_blksize_invalid_option_value_1():
with raises(PayloadDecodeError):
RQDatagram.from_wire(b"foo\x00octet\x00blksize\x00baz\x00")
def test_rq_datagam_blksize_invalid_option_value_2():
with raises(OptionsDecodeError):
RQDatagram.from_wire(b"foo\x00octet\x00blksize\x001\x00")
def test_rq_datagam_blksize_invalid_option_value_3():
with raises(OptionsDecodeError):
RQDatagram.from_wire(b"foo\x00octet\x00blksize\x0072384\x00")
def test_rq_datagram_blksize_valid_option():
dgram = RQDatagram.from_wire(b"foo\x00octet\x00blksize\x001024\x00")
assert dgram.filename == b"foo"
assert dgram.mode == TFTPMode.OCTET
assert dgram.options == OrderedDict({TFTPOption.BLOCKSIZE: 1024})
def test_rq_datagam_timeout_invalid_option_value_1():
with raises(PayloadDecodeError):
RQDatagram.from_wire(b"foo\x00octet\x00timeout\x000\x00")
def test_rq_datagam_timeout_invalid_option_value_2():
with raises(OptionsDecodeError):
RQDatagram.from_wire(b"foo\x00octet\x00timeout\x00-1\x00")
def test_rq_datagram_timeout_valid_option():
dgram = RQDatagram.from_wire(b"foo\x00octet\x00timeout\x005\x00")
assert dgram.filename == b"foo"
assert dgram.mode == TFTPMode.OCTET
assert dgram.options == OrderedDict({TFTPOption.TIMEOUT: 5})
def test_rq_datagam_tsize_invalid_option_value_1():
with raises(PayloadDecodeError):
RQDatagram.from_wire(b"foo\x00octet\x00tsize\x00-1\x00")
def test_rq_datagram_timeout_valid_option_1():
dgram = RQDatagram.from_wire(b"foo\x00octet\x00tsize\x000\x00")
assert dgram.filename == b"foo"
assert dgram.mode == TFTPMode.OCTET
assert dgram.options == OrderedDict({TFTPOption.TRANSFER_SIZE: 0})
def test_rq_datagram_timeout_valid_option_2():
dgram = RQDatagram.from_wire(b"foo\x00octet\x00tsize\x00512\x00")
assert dgram.filename == b"foo"
assert dgram.mode == TFTPMode.OCTET
assert dgram.options == OrderedDict({TFTPOption.TRANSFER_SIZE: 512})
def test_rrq_datagram_to_wire_1():
dgram = RRQDatagram(
b"foo", TFTPMode.OCTET, OrderedDict({TFTPOption.TRANSFER_SIZE: 512})
)
assert dgram.opcode == TFTPOpcode.RRQ
assert dgram.filename == b"foo"
assert dgram.mode == TFTPMode.OCTET
assert dgram.options == OrderedDict({TFTPOption.TRANSFER_SIZE: 512})
assert dgram.to_wire() == b"\x00\x01foo\x00octet\x00tsize\x00512\x00"
def test_rrq_datagram_to_wire_2():
with raises(AssertionError):
dgram = RRQDatagram(b"foo", TFTPMode.OCTET, OrderedDict({b"foo": 512}))
# assert dgram.opcode == TFTPOpcode.RRQ
# assert dgram.filename == b"foo"
# assert dgram.mode == TFTPMode.OCTET
# assert dgram.options == OrderedDict({TFTPOption.TRANSFER_SIZE: 512})
# assert dgram.to_wire() == b"\x00\x01foo\x00octet\x00tsize\x00512\x00"
def test_rrq_datagram_to_wire_3():
dgram = RRQDatagram(b"foo", TFTPMode.OCTET, OrderedDict({}))
dgram.options = OrderedDict({b"baz": 512})
assert dgram.opcode == TFTPOpcode.RRQ
assert dgram.filename == b"foo"
assert dgram.mode == TFTPMode.OCTET
assert dgram.options == OrderedDict({b"baz": 512})
with raises(WireProtocolError):
dgram.to_wire()

58
test/test_netascii.py Normal file
View File

@ -0,0 +1,58 @@
# JTFTP - Python/AsyncIO TFTP Server
# Copyright (C) 2022 Jeffrey C. Ollie
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
from jtftp.netascii import NetAsciiCR
from jtftp.netascii import NetAsciiLF
def test_from_netascii_cr_1():
assert NetAsciiCR.from_netascii(b"\x0d\x00") == b"\x0d"
def test_from_netascii_cr_1():
assert NetAsciiCR.from_netascii(b"\x0d\x0a") == b"\x0d"
def test_from_netascii_cr_2():
assert NetAsciiCR.from_netascii(b"foo\x0d\x0a\x0abar") == b"foo\x0d\x0abar"
def test_from_netascii_cr_3():
assert NetAsciiCR.from_netascii(b"foo\x0d\x00\x0abar") == b"foo\x0d\x0abar"
def test_from_netascii_cr_4():
assert NetAsciiCR.from_netascii(b"foo\x0d\x0a\x0dbar") == b"foo\x0d\x0dbar"
def test_from_netascii_lf_1():
assert NetAsciiLF.from_netascii(b"\x0d\x00") == b"\x0d"
def test_from_netascii_lf_1():
assert NetAsciiLF.from_netascii(b"\x0d\x0a") == b"\x0a"
def test_from_netascii_lf_2():
assert NetAsciiLF.from_netascii(b"foo\x0d\x0a\x0abar") == b"foo\x0a\x0abar"
def test_from_netascii_lf_3():
assert NetAsciiLF.from_netascii(b"foo\x0d\x00\x0abar") == b"foo\x0d\x0abar"
def test_from_netascii_lf_4():
assert NetAsciiLF.from_netascii(b"foo\x0d\x0a\x0dbar") == b"foo\x0a\x0dbar"

85
test/test_util.py Normal file
View File

@ -0,0 +1,85 @@
# JTFTP - Python/AsyncIO TFTP Server
# Copyright (C) 2022 Jeffrey C. Ollie
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
import time
from itertools import count
from itertools import islice
import pytest
from jtftp.util import iterlast
from jtftp.util import timed_caller
def test_iterlast_3():
assert list(iterlast([1, 2, 3])) == [(False, 1), (False, 2), (True, 3)]
def test_iterlast_0():
assert list(iterlast([])) == []
def test_iterlast_1():
assert list(iterlast([1])) == [(True, 1)]
def test_iterlast_infinite():
assert list(islice(iterlast(count(1)), 3)) == [(False, 1), (False, 2), (False, 3)]
@pytest.mark.asyncio
async def test_timed_caller():
latency = 250000
r = []
t = [time.monotonic_ns()]
async def c():
end = time.monotonic_ns()
r.append(("c", (end - t[-1]) < latency))
t.append(end)
async def l():
end = time.monotonic_ns()
r.append(("l", (end - t[-1]) < latency))
t.append(end)
await timed_caller((0, 0, 0), c, l)
assert r == [("c", True), ("c", True), ("l", True)]
@pytest.mark.asyncio
async def test_timed_caller_no_timings():
with pytest.raises(ValueError):
async def c():
pass
async def l():
pass
await timed_caller([], c, l)
@pytest.mark.asyncio
async def test_timed_caller_negative_timings():
with pytest.raises(ValueError):
async def c():
pass
async def l():
pass
await timed_caller([0, -1, 0], c, l)