172 lines
5.6 KiB
Markdown
172 lines
5.6 KiB
Markdown
# ProxyResolver
|
|
|
|
[](https://travis-ci.org/rinold/ProxyResolver)
|
|
|
|
[](https://cocoapods.org/pods/ProxyResolver)
|
|
|
|
|
|
[](https://cocoapods.org/pods/ProxyResolver)
|
|
[](https://cocoapods.org/pods/ProxyResolver)
|
|
|
|
ProxyResolver allows simply resolve the actual proxy information from users
|
|
system configuration and could be used for setting up Stream-based connections,
|
|
for example for Web Sockets.
|
|
|
|
Usage example:
|
|
|
|
```swift
|
|
import ProxyResolver
|
|
|
|
let proxy = ProxyResolver()
|
|
let url = URL(string: "https://github.com")!
|
|
proxy.resolve(for: url) { result in
|
|
switch result {
|
|
case .direct:
|
|
// Direct connection allowed - no proxy required
|
|
break
|
|
case .proxy(let proxy):
|
|
// here you can establish connection to proxy or whatever you want
|
|
// proxy.type - one of ProxyType enum: .http, .https or .socks
|
|
// proxy.host - host name of proxy to use
|
|
// proxy.port - port number
|
|
break
|
|
case .error(let error):
|
|
// Handle error
|
|
break
|
|
}
|
|
}
|
|
```
|
|
|
|
## Features
|
|
|
|
#### Supported system configurations
|
|
- [x] Auto Proxy Discovery*
|
|
- [x] Automatic Proxy Configuration URL*
|
|
- [x] Web Proxy (HTTP)
|
|
- [x] Secure Web Proxy (HTTPS)
|
|
- [x] SOCKS Proxy
|
|
- [ ] ~~FTP Proxy~~
|
|
- [ ] ~~Streaming Proxy (RTSP)~~
|
|
- [ ] ~~Gopher Proxy~~
|
|
|
|
\* due to ATS protection auto-configuration url should be HTTPS or have \*.local or unresolvable globally domain, otherwise you will need to set the `NSAllowsLocalNetworking` key in plist. More info could be found in [NSAppTransportSecurity reference](https://developer.apple.com/library/content/documentation/General/Reference/InfoPlistKeyReference/Articles/CocoaKeys.html#//apple_ref/doc/uid/TP40009251-SW33).
|
|
|
|
|
|
#### Other features
|
|
- [x] Proxy with required password support
|
|
|
|
`Proxy.credentials` will automatically access `Proxy` keychain to retrieve configured for proxy account and password. As it would require permission from user the credentials are retrieved lazily only when you try to get them.
|
|
|
|
---
|
|
|
|
- [x] Configurable
|
|
|
|
You can use custom proxy configuration provider instead of system one, or provide your own fetcher for downloading auto-configuration scripts instead of default one based on NSURLSession.
|
|
|
|
---
|
|
|
|
- [x] Aligned with Apple recommendations
|
|
|
|
> "In general, you should try to download a URL using the first proxy in the array, try the second proxy if the first one fails, and so on." - as described in documentation for used [CFNetworkCopyProxiesForURL](https://developer.apple.com/documentation/cfnetwork/1426639-cfnetworkcopyproxiesforurl) method.
|
|
|
|
Using the `ProxyResolverDelegate` you can try connection to resolved proxy and in case of any issue or if your just want to retrieve all - continue resolution if any proxy configuration are still available.
|
|
|
|
```swift
|
|
class CustomDelegate: ProxyResolverDelegate {
|
|
func proxyResolver(_ proxyResolver: ProxyResolver, didResolve result: ProxyResolutionResult, for url: URL, resolveNext: ResolveNextRoutine?) {
|
|
switch result {
|
|
case .direct:
|
|
// no proxy required - try to connect to your 'url' directly
|
|
break
|
|
case .proxy(let proxy):
|
|
// try connect to your 'url' using resolved 'proxy'
|
|
yourConnectMethod(to: url, using: proxy) { (response, error) in
|
|
if let error = error {
|
|
// If connection failed we will try to resolve next proxy if
|
|
// available and retry connection
|
|
resolveNext?()
|
|
}
|
|
}
|
|
case .error(let error):
|
|
// handle error
|
|
break
|
|
}
|
|
}
|
|
```
|
|
---
|
|
- [ ] Documentation
|
|
|
|
TBD
|
|
|
|
## Requirements
|
|
- Swift: 4+
|
|
- macOS: 10.10+
|
|
|
|
## Installation
|
|
|
|
#### [CocoaPods](https://cocoapods.org)
|
|
To install it add the following line to `Podfile`:
|
|
|
|
```ruby
|
|
pod 'ProxyResolver'
|
|
```
|
|
|
|
For example:
|
|
```ruby
|
|
use_frameworks!
|
|
|
|
target 'TestPackagesForProxyResolver' do
|
|
platform :osx, '10.12'
|
|
pod 'ProxyResolver'
|
|
end
|
|
```
|
|
|
|
#### [Carthage](https://github.com/Carthage)
|
|
To install it add following line to `Cartfile`:
|
|
|
|
```
|
|
GitHub "rinold/ProxyResolver"
|
|
```
|
|
|
|
#### [Swift Package Manager](https://swift.org/package-manager/)
|
|
To install it add following package to needed `Packages.swift` dependencies:
|
|
|
|
```swift
|
|
.package(url: "https://github.com/rinold/ProxyResolver.git", from: "0.3.0")
|
|
```
|
|
|
|
For example:
|
|
```swift
|
|
// swift-tools-version:4.0
|
|
import PackageDescription
|
|
|
|
let package = Package(
|
|
name: "TestPackagesForProxyResolver",
|
|
products: [
|
|
.executable(name: "TestPackagesForProxyResolver", targets: ["TestPackagesForProxyResolver"]),
|
|
],
|
|
dependencies: [
|
|
.package(url: "https://github.com/rinold/ProxyResolver.git", from: "0.3.0"),
|
|
],
|
|
targets: [
|
|
.target(
|
|
name: "TestPackagesForProxyResolver",
|
|
dependencies: ["ProxyResolver.git"]),
|
|
]
|
|
)
|
|
```
|
|
|
|
## Versioning
|
|
|
|
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/rinold/ProxyResolver/tags).
|
|
|
|
## Author
|
|
|
|
ProxyResolver was initially inspired by the web sockets [Starscream](https://github.com/daltoniam/Starscream) proxy support [PR](https://github.com/daltoniam/Starscream/pull/202).
|
|
|
|
Mikhail Churbanov, mihail.churbanov@gmail.com
|
|
|
|
## License
|
|
|
|
ProxyResolver is available under the MIT license. See the LICENSE file for more info.
|