NetShears
NetShears is a Network interceptor framework written in Swift.
NetShears adds a Request interceptor mechanisms to be able to modify the HTTP/HTTPS Request before being sent . This mechanism can be used to implement authentication policies, add headers to a request , add log trace or even redirect requests.
Features
- Intercept HTTP/HTTPS request header
- Intercept HTTP/HTTPS request endpoint
- View traffic logs
- Intercept HTTP/HTTPS response body
- Block HTTP requets
How it works
NetShears working by swizzling the URLProtocol.
How to use
Start NetShears by calling startRecording() in didFinishLaunchingWithOptions
import NetShears
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]? = nil) -> Bool {
NetShears.startRecording()
}
Interceptor
Header Modification:
let header = HeaderModifyModel(key: "API-Version", value: "123")
let headerModifier = RequestEvaluatorModifierHeader(header: header)
NetShears.shared.modify(modifier: headerModifier)
Endpoint Modification:
let endpoint = RedirectedRequestModel(originalUrl: "/register", redirectUrl: "/login")
let endpointModifier = RequestEvaluatorModifierEndpoint(redirectedRequest: endpoint)
NetShears.shared.modify(modifier: endpointModifier)
Traffic Monitoring
In order to show network traffics in your app simply call presentNetworkMonitor method and then a view will present containing traffic logs.
NetShears.shared.presentNetworkMonitor()
gRPC
You can view gRPC calls by constructing the Request and Response from GRPC models:
public func addGRPC(url: String,
host: String,
requestObject: Data?,
responseObject: Data?,
success: Bool,
statusCode: Int,
statusMessage: String?,
duration: Double?,
HPACKHeadersRequest: [String: String]?,
HPACKHeadersResponse: [String: String]?)
Example
// Your GRPC services that is generated from SwiftGRPC
private let client = NoteServiceServiceClient.init(address: "127.0.0.1:12345", secure: false)
func insertNote(note: Note, completion: @escaping(Note?, CallResult?) -> Void) {
_ = try? client.insert(note, completion: { (createdNote, result) in
// Add to atlantis and show it on Proxyman app
NetShears.shared.addGRPC(url: "https://test.com/grpc",
requestObject: try? note.jsonUTF8Data(),
responseObject: try? createdNote.jsonUTF8Data(),
success: result.success,
statusCode: result.statusCode.rawValue,
statusMessage: result.statusMessage)
})
}
Installation
Swift Package Manager
Create a Package.swift file.
// swift-tools-version:5.0
import PackageDescription
let package = Package(
name: "YourProject",
dependencies: [
.package(url: "https://github.com/divar-ir/NetShears.git", from: "1.0.0"),
],
targets: [
.target(name: "YourProject", dependencies: ["NetShears"])
]
)
$ swift build
CocoaPods
# Podfile
use_frameworks!
target 'YOUR_TARGET_NAME' do
pod 'NetShears'
end
Replace YOUR_TARGET_NAME and then, in the Podfile directory, type:
$ pod install
Contributing
Please see our Contributing Guide.
4 Dec 2, 2022
89 Dec 26, 2022
5 Oct 17, 2022
19 Nov 19, 2022
2 Sep 16, 2022
15 Sep 25, 2022
14.4k Jan 1, 2023
17 Oct 11, 2021
7 Aug 8, 2022
27 Nov 11, 2022
5 Nov 4, 2022
12 Dec 9, 2022
528 Dec 26, 2022
2.8k Jan 2, 2023
3.4k Dec 28, 2022
2.1k Jan 8, 2023
139 Dec 10, 2022
459 Dec 11, 2022