Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nmoinvaz/proxyres
Cross-platform proxy resolution library written in C.
https://github.com/nmoinvaz/proxyres
c cross-platform curl gnome3 linux macosx proxy resolver ubuntu windows winhttp wsh
Last synced: 21 days ago
JSON representation
Cross-platform proxy resolution library written in C.
- Host: GitHub
- URL: https://github.com/nmoinvaz/proxyres
- Owner: nmoinvaz
- License: mit
- Created: 2022-10-25T03:41:35.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-14T21:35:53.000Z (3 months ago)
- Last Synced: 2024-08-15T22:37:34.969Z (3 months ago)
- Topics: c, cross-platform, curl, gnome3, linux, macosx, proxy, resolver, ubuntu, windows, winhttp, wsh
- Language: C
- Homepage:
- Size: 619 KB
- Stars: 11
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# proxyres - proxy resolution library in C
[](https://www.codefactor.io/repository/github/nmoinvaz/proxyres) [](https://codecov.io/gh/nmoinvaz/proxyres) [](https://github.com/nmoinvaz/proxyres/blob/master/LICENSE.md)
Cross-platform proxy resolution with support for Linux, macOS, & Windows.
[Read the Documentation](doc/README.md)
## Features
* Read the user's proxy configuration from the operating system.
* Execute a PAC script using `JavaScriptCore` or `Windows Script Host`.
* Get the proxies for a URL asynchronously using `WinHTTP`, `ProxyConfiguration`, and `CFNetwork`.
* Or with a fallback proxy resolver featuring:
* Support for `WPAD` using `DHCP` and `DNS`.
* Support for PAC file execution using system scripting libraries.
* Support for downloading PAC scripts using HTTPS with [curl](https://github.com/curl/curl).
* Example command line utility.
## Supported Platforms
* Windows XP+, RT (UWP)
* Ubuntu 18
* macOS 10.13
## Example
Source code examples can be found in the docs for each class or in the command line test application [proxycli](./test/proxycli.c).
## Build
Use CMake to generate project and solution files for your environment:
```bash
cmake -S . -B build
cmake --build build
```
To run CMake tests use the following command:
```bash
ctest --verbose -C Debug
```
### Options
|Name|Description|Default|
|:-|:-|:-:|
|PROXYRES_CURL|Enables downloading PAC scripts using [curl](https://github.com/curl/curl). Without this option set, PAC scripts will only be downloaded using HTTP 1.0.|OFF|
|PROXYRES_EXECUTE|Enables support for PAC script execution. Required on Linux due to the lack of a system level proxy resolver.|ON|
|PROXYRES_BUILD_CLI|Build command line utility.|ON|
|PROXYRES_BUILD_TESTS|Build Googletest unit tests project.|ON|
|PROXYRES_CODE_COVERAGE|Build for code coverage.|OFF|
## History & Motivation
Portions of the code for this library started many years ago as part of a custom HTTP/HTTPS stack we developed at [Solid State Networks](https://solidstatenetworks.com/). Recently we made the decision to switch over to `libcurl` but realized that we still needed to retain our own proxy resolution code. We investigated using `libproxy`, however it did not allow us to statically link the library for closed source commerical purposes. In the end we decided to separate parts of our proxy implementation to its own library.
## Resources
* [Wikipedia - Proxy Auto-config](https://en.wikipedia.org/wiki/Proxy_auto-config)
* [Mozilla - Proxy Auto-Configuration (PAC)](https://developer.mozilla.org/en-US/docs/Web/HTTP/Proxy_servers_and_tunneling/Proxy_Auto-Configuration_PAC_file)
* RFC Drafts
* [Web Proxy Auto-Discovery Protocol](https://datatracker.ietf.org/doc/html/draft-ietf-wrec-wpad-01)
* [Generalize Client UDP Port Number of DHCP Relay](https://datatracker.ietf.org/doc/html/draft-shen-dhc-client-port-00)
* [Windows Proxy Setting "Bypass proxy server for local addresses"](https://bugzilla.mozilla.org/show_bug.cgi?id=1028195#c14)