1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
Metadata-Version: 2.1
Name: http-relay
Version: 2.1.3
Summary: Relay for HTTP messages (reverse proxy)
Home-page: https://github.com/ctu-vras/http_relay
Author: Martin Pecka
Author-email: Martin Pecka <peci1@seznam.cz>
Maintainer: Martin Pecka
Maintainer-email: Martin Pecka <peci1@seznam.cz>
License: BSD 3-Clause License
Copyright (c) 2023, Czech Technical University in Prague
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Project-URL: Homepage, https://github.com/ctu-vras/http_relay
Keywords: http,proxy
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Topic :: Communications
Classifier: Topic :: Internet
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: System :: Networking
Classifier: Topic :: Utilities
Requires-Python: >=2.7
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
<!--
SPDX-License-Identifier: BSD-3-Clause
SPDX-FileCopyrightText: Czech Technical University in Prague
-->
# http-relay
Relay HTTP requests from localhost to a remote host (act as reverse HTTP proxy).
This HTTP relay properly processes also the nonstandard HTTP responses like `ICY 200 OK` produced by Shoutcast or NTRIP streaming servers.
The relay works properly with hostnames, IPv4 and IPv6 addresses. IPv6 addresses can be specified with or without `[]`.
## Usage
```
usage: http-relay [-h] [-n NUM_THREADS] [-b BUFFER_SIZE] [-t SIGKILL_TIMEOUT] [-s] host [port] [local_port] [local_addr]
positional arguments:
host The remote host to connect to (e.g. "cvut.cz")
port The remote host's port to connect to (e.g. 80).
local_port The local port to be used for the relay. If left out, will be the same as remote port.
local_addr Local interface (IP or hostname) to run the relay on. By default, it runs on all IPv4 interfaces (0.0.0.0).
optional arguments:
-h, --help show this help message and exit
-n NUM_THREADS, --num-threads NUM_THREADS
Number of threads servicing the incoming requests.
-b BUFFER_SIZE, --buffer-size BUFFER_SIZE
Size of the buffer used for reading responses. Generally, a larger buffer should be more efficient, but if it is too large, the local clients may time out before they receive any data.
-t SIGKILL_TIMEOUT, --sigkill-timeout SIGKILL_TIMEOUT
If specified, the relay will be sigkilled in this number of seconds.
-s, --sigkill-on-stream-stop
If True, --sigkill-timeout will not be counted when no requests are active, and during requests, each successful data transmission will reset the timeout. This can be used to detect
stale streams if you expect an application to be constantly receiving data.
```
## Python module
This package also provides Python module `http_relay`. You can start the relay as a part of your application like this:
```python
from http_relay import run
# ...
run("0.0.0.0", 80, "cvut.cz", 80)
```
## Examples
```bash
http-relay cvut.cz 80 8080 # redirects local port 8080 to cvut.cz:80
http-relay cvut.cz 2101 # redirects local port 2101 to cvut.cz:2101
http-relay cvut.cz 80 8080 localhost # redirects localhost:8080 to cvut.cz:80 (i.e. no external access to the 8080 port)
http-relay stream.cz 2101 -t 10 -s # redirects local port 2101 to stream.cz and kills the relay after 10 secs if a stream is being downloaded and becomes stale
```
|
