Skip to content

Latest commit

 

History

History
54 lines (40 loc) · 2.04 KB

README.md

File metadata and controls

54 lines (40 loc) · 2.04 KB
Raw

tftp-http-proxy

tftp-http-proxy is a simple TFTP server that proxies all read requests to a backing HTTP server, and serves the response.

Modifications by ebik

This modification is intended to run as systemd service of type notify. It notifies system daemon that it is up and listening. (It does not check that base url is available.)

This modification is shipped as debian package.

Usage

Usage of dist/tftp-http-proxy:
  -http-base-url string
            HTTP base URL (default "http://127.0.0.1/tftp")
  -http-append-path
            Append path to url (add slash and then requested path), warning
            no path sanitization is done, so it may contain /../ or other
            wild characters.
  -tftp-timeout duration
            TFTP timeout (default 5s)
  -tftp-bind-address address
            UDP address to bind to

You can set these arguments in /etc/default/tftp-http-proxy in variable DAEMON\_ARGS. This file is NOT shipped in debian package for easier orchestration using, e.g., ansible.

Details

When tftp-http-proxy is started, it will listen on (UDP) port 69 as a normal TFTP server. Whenever a new TFTP read request is received, the request will be forwarded as an HTTP request to the configured HTTP URL (-http-base-url flag). The HTTP request will have some additional HTTP headers containing information about the TFTP request:

  • X-TFTP-IP: The IP of the requesting TFTP client
  • X-TFTP-Port: The port used by the requesting TFTP client
  • X-TFTP-File: The filename requested by the TFTP client

If the HTTP request returns a status 200 response, the contents of the response will be sent as the file contents for the TFTP read request. The HTTP response should contain an accurate ContentLength header, as it will be used to set the TFTP TSize option on the read response.

If the HTTP response status is not 200, an error response will be sent to the TFTP client instead.

License

tftp-http-proxy is released under the MIT License.