eoan-ermine/tftp_common

A simple header-only Trivial File Transfer Protocol (TFTP) packets parsing and serialization library

TFTP Common

A simple header-only Trivial File Transfer Protocol (TFTP) packets parsing and serialization library.

RFC 1350 (TFTP Protocol Revision 2) compilant, RFC 2347 (TFTP Option Extension) support.

Supported platforms

Platform name	Windows	Linux	MacOS
Minimum required version	98	---	---

Dependencies

Dependency name	Minimum required version	Ubuntu 22.04
C++	C++17	sudo apt-get install build-essential
Doxygen (optional)	---	sudo apt-get install doxygen
ClangFormat (development, optional)	---	sudo apt-get install clang-format

Quick start

1. Download and install CMake. Version 3.12.0 is the minimum required.
2. Open a shell. Your development tools must be reachable from this shell through the PATH environment variable.
3. Create a build directory, go to this directory:

mkdir build
cd build

4. Execute this command in the shell replacing path/to/tftp_common/source/root with the path to the root of your tftp_common source tree:

cmake path/to/tftp_common/source/root

5. After CMake has finished running, proceed to use IDE project files, or start the build from the build directory:

cmake --build .

The --build option tells cmake to invoke the underlying build tool (make, ninja, xcodebuild, msbuild, etc.)

The underlying build tool can be invoked directly, of course, but the --build option is portable.

6. After tftp_common has finished building, install it from the build directory:

cmake --build . --target install

The --target option with install parameter in addition to the --build option tells cmake to build the install target.

Options and variables

Variables customize how the build will be generated. Options are boolean variables, with possible values ON/OFF. Options and variables are defined on the CMake command line like this:

cmake -DVARIABLE=value path/to/tftp_common/source

CMake variables

• BUILD_TESTS: BOOL

Adds test build targets as a dependencies of the default build target. Defaults to OFF.

• BUILD_EXAMPLES: BOOL

Adds examples build targets as a dependencies of the default build target. Defaults to OFF.

CMake targets

• The format target (i.e ninja format) will run clang-format on all project files
• The check-format target (i.e ninja check-format) will verify that project's code follows formatting conventions
• The docs target (i.e ninja docs) will generate documentation using doxygen

tftp_common's Issues

Abscense of `TransferMode` enumeration

Add support of TFTP Option Extension

Document: https://datatracker.ietf.org/doc/html/rfc2347

Publish conan package

Build packages

As soon as we have stable release, we should build deb, rpm packages and release it somehow.

Add usage examples

Possible examples:

• TFTP Client
• TFTP Server

Implement C API

Add static/shared library build option

Add support of TFTP Blocksize Option

Dependencies: #7
Document: https://datatracker.ietf.org/doc/html/rfc2348

`OptionAcknowledgment` API is leaking it's internal structure

getOptions method

tftp_common/tftp_common/packets.hpp

Line 286 in de7d715

const std::unordered_map<std::string, std::string> &getOptions() const { return Options; }

Should be replaced with begin() and end() or something

Make parse functions free

There actually no state in parser class. Current step can be stored as local variable in every parse function.

Absence of `Error` enumeration

Rename `parser.hpp` to `parsers.hpp` or something

Implement tests for all existing methods

Inefficient serialization functions: too many copies

Efficiently get option by its name is impossible with current design

Lack of no-exceptions environments support

Add support of TFTP Timeout Interval and Transfer Size Options

Dependencies: #7
Document: https://datatracker.ietf.org/doc/html/rfc2349

Unscoped enumerations are messing up with namespaces

Generate doxygen documentation as a part of CI

Hide request's fields from users

They ended up in the public scope by accident. Of course, they shouldn't be there :)

Change signature of parse methods

Return all arguments by value, for example, with something like this:

struct ParseResult {
    bool success;
    size_t bytes_read;
};

With all methods to support structured bindings.

Absence of no-options rvalue constructor in request class

tftp_common/tftp_common/packets.hpp

Lines 44 to 60 in de7d715

	Request(Type Type, std::string_view Filename, std::string_view Mode)
	: Type_(Type), Filename(Filename.begin(), Filename.end() + 1), Mode(Mode.begin(), Mode.end() + 1) {
	assert(Type == Type::ReadRequest || Type == Type::WriteRequest);
	assert(Filename[Filename.size()] == '\0');
	assert(Mode[Mode.size()] == '\0');
	}
	Request(Type Type, std::string_view Filename, std::string_view Mode, const std::vector<std::string> &OptionsNames,
	const std::vector<std::string> &OptionsValues)
	: Request(Type, Filename, Mode) {
	this->OptionsNames = OptionsNames;
	this->OptionsValues = OptionsValues;
	}
	Request(Type Type, std::string &&Filename, std::string &&Mode, std::vector<std::string> &&OptionsNames,
	std::vector<std::string> &&OptionsValues)
	: Type_(Type), Filename(std::make_move_iterator(Filename.begin()), std::make_move_iterator(Filename.end())),
	Mode(std::make_move_iterator(Mode.begin()), std::make_move_iterator(Mode.end())),
	OptionsNames(std::move(OptionsNames)), OptionsValues(std::move(OptionsValues)) {}

Absence of qualifiers: noexcept, final