3 releases (breaking)
0.3.0 | Dec 17, 2021 |
---|---|
0.2.0 | Jun 19, 2020 |
0.1.0 | May 13, 2020 |
#9 in #cors
28KB
629 lines
warp-cors
warp-cors is a proxy server which enables CORS for the proxied request.
The path of the request is validated and then used as the url to proxy. Only http and https protocols are allowed and must be specified.
Preflight requests will allow any methods and headers. All proxied requests will have any origin allowed and allow all headers in the request to be exposed in the reponse.
Installation
Binaries
Archives of precompiled binaries are available for Linux, macOS, and Windows.
The Windows binaries require Microsoft Visual C++ 2015 Redistributable to be installed.
Cargo
The minimum supported Rust version is 1.56.0, warp-cors will not work with versions lower than this.
$ cargo install warp-cors
Docker
Docker images are published in the bassetts/warp-cors repository.
$ docker run -dp 3030:3030 bassetts/warp-cors
Usage
By default warp-cors will listen on port 3030
and use the package name
(warp-cors
) as the pseudonym in the Via
header sent with the proxied
request. These can be overwritten by using the --port <PORT>
and
--hostname <HOST>
flags respectively.
If you are running warp-cors on a pubicly accessible hostname it is
recommended to set the --hostname
flag to match.
Example
$ warp-cors --port 3000 --hostname cors.example.org
Example requests
http://localhost:3030/ # 404 Not Found
http://localhost:3030/http://example.org # Proxied HTTP response with CORS headers
http://localhost:3030/https://example.org # Proxied HTTPS response with CORS headers
http://localhost:3030/example.org # 404 Not Found (no scheme provided)
http://localhost:3030/ftp://example.org # 404 Not Found (invalid scheme provided)
Logging
warp-cors uses pretty_env_logger
, so you can control log levels by setting
the RUST_LOG
environment variable. This is useful for both developing and
for running warp-cors.
# Output all info level logs, including those from libraries used by warp-cors
$ RUST_LOG=info warp-cors
# Output info level logs for only warp-cors
$ RUST_LOG=warp_cors=info warp-cors
# Filter logging by module, useful for development or debugging
$ RUST_LOG=warp_cors::filters::request=trace warp-cors
Dependencies
~20–35MB
~645K SLoC