Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pakerwreah/inspector
Tool to inspect SQLite databases and intercept network requests from mobile applications.
https://github.com/pakerwreah/inspector
android cpp cross-platform database debug debugging flipper http inspect ios jni mobile ndk okhttp socket sqlcipher sqlite stetho websocket
Last synced: 30 days ago
JSON representation
Tool to inspect SQLite databases and intercept network requests from mobile applications.
- Host: GitHub
- URL: https://github.com/pakerwreah/inspector
- Owner: pakerwreah
- License: mit
- Created: 2020-03-19T20:25:36.000Z (almost 5 years ago)
- Default Branch: develop
- Last Pushed: 2022-09-11T21:22:40.000Z (over 2 years ago)
- Last Synced: 2024-11-12T09:08:47.341Z (about 1 month ago)
- Topics: android, cpp, cross-platform, database, debug, debugging, flipper, http, inspect, ios, jni, mobile, ndk, okhttp, socket, sqlcipher, sqlite, stetho, websocket
- Language: C++
- Homepage: https://pakerwreah.github.io/InspectorWeb
- Size: 9.2 MB
- Stars: 18
- Watchers: 6
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Inspector
[](https://github.com/pakerwreah/Inspector/releases/latest)
[](https://codecov.io/gh/pakerwreah/Inspector)
[](https://github.com/pakerwreah/Inspector/actions)
[](https://github.com/pakerwreah/Inspector/actions)
[](https://github.com/pakerwreah/Inspector/actions)
### Tool to inspect SQLite databases and intercept network requests from mobile applications.
Project targeting Android, iOS and Web using C/C++, Java, Objective-C, Vue.js, WebSocket, SQLite and IndexedDB.
The data is shown in a web interface and uses WebSocket to communicate directly with the app via local network.
To keep network log history the web system uses the built-in IndexedDB from the browser.
#### Frontend repository
https://github.com/pakerwreah/InspectorWeb
## Android
[](https://jitpack.io/#pakerwreah/Inspector)
Setup
#### Gradle
```gradle
repositories {
maven { url "https://jitpack.io" }
}
```
```gradle
dependencies {
implementation "com.github.pakerwreah:Inspector:"
}
```
#### Proguard
```
-keep class br.newm.inspector.* { *; }
```
Usage
#### Application
```java
import br.newm.inspector.Inspector;
public class Application extends android.app.Application {
@Override
public void onCreate() {
super.onCreate();
Inspector.initializeWith(this);
// SQLCipher support
// database name, password, sqlcipher major version
Inspector.setCipherKey("database_cipher3.db", "123456", 3);
Inspector.setCipherKey("database_cipher4.db", "123456", 4);
}
// Optional: if you want to specify databases names to show
@Override
public String[] databaseList() {
return new String[]{"database.db", "database_cipher3.db", "database_cipher4.db"};
}
}
```
#### Intercept network requests
:warning: if you use addNetworkInterceptor it won't intercept timeouts
```java
import br.newm.inspector.NetworkInterceptor;
new OkHttpClient.Builder().addInterceptor(new NetworkInterceptor());
```
#### Static plugins
Accepts returning JSON, HTML or plain text
```java
Inspector.addPlugin("prefs", "Shared Preferences", new PluginAction() {
@Override
public String action() {
return new JSONObject(prefs.getAll()).toString();
}
});
```
#### Live plugins
Accepts complex HTML frontend with javascript support
Check ExplorerPlugin.java for a full example
```java
Inspector.addLivePlugin("explorer", "Explorer", new PluginAction() {
@Override
public String action() {
// return plugin frontend
}
});
```
#### Plugin API
Route with parameters to be used as a plugin or standalone api
Check ExplorerPlugin.java for a full example
```java
Inspector.addPluginAPI("GET", "filesystem/list", new PluginAPIAction() {
@Override
public String action(Map params) {
// return json array with list of files
}
});
Inspector.addPluginAPI("GET", "filesystem/open", new PluginAPIActionBinary() {
@Override
public byte[] action(Map params) {
// return file contents
}
});
```
#### Websockets
Send messages to your live plugins
```javascript
new WebSocket(`ws://${location.hostname}:${location.port}/plugins/ws/mykey`)
```
```java
Inspector.sendMessage("mykey", "Hello world!");
```
#
:warning: You should run this command to work with emulators
```bash
# same port number used to initialize the plugin
adb forward tcp:30000 tcp:30000
```
Or configure its network as bridge and use the device's IP
## iOS
[](https://cocoapods.org/pods/IOSInspector)
Setup
#### CocoaPods
```gradle
target 'MyApp' do
pod "IOSInspector"
end
```
Usage
#### AppDelegate
```swift
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate, IOSInspectorProtocol {
func applicationDidFinishLaunching(_ application: UIApplication) {
IOSInspector.initialize(withDelegate: self)
// SQLCipher support
IOSInspector.setCipherKey("database_cipher3.db", password: "123456", version: 3)
IOSInspector.setCipherKey("database_cipher4.db", password: "123456", version: 4)
}
// Required: specify databases paths
func databaseList() -> [String] {
let documentsPathURL = FileManager.default.urls(for: .documentDirectory, in: .userDomainMask).first!
return ["database.db", "database_cipher3.db", "database_cipher4.db"].map {
documentsPathURL.appendingPathComponent($0).absoluteString
}
}
}
```
#### Intercept network requests
```swift
let uid = UUID().uuidString
let request = URLRequest(url: url)
// send request to the frontend
IOSInspector.sendRequest(withUID: uid, request: request)
URLSession.shared.dataTask(with: request) { data, response, error in
if let data = data, let response = response as? HTTPURLResponse {
// send response to the frontend
IOSInspector.sendResponse(withUID: uid, response: response, body: data)
}
}.resume()
```
#### Static plugins
Accepts returning JSON, HTML or plain text
```swift
IOSInspector.addPlugin("prefs", name: "User Defaults") {
let dict = UserDefaults.standard.dictionaryRepresentation()
if let data = try? JSONSerialization.data(withJSONObject: dict),
let json = String(data: data, encoding: .utf8) {
return json
}
return "No data"
}
```
#### Live plugins
Accepts complex HTML frontend with javascript support
Check ExplorerPlugin.swift for a full example
```swift
IOSInspector.addLivePlugin("explorer", name: "Explorer") {
// return plugin frontend
}
```
#### Plugin API
Route with parameters to be used as a plugin or standalone api
Check ExplorerPlugin.swift for a full example
```swift
IOSInspector.addPluginAPI(forMethod: "GET", path: "filesystem/list") { params -> String in
// return json array with list of files
}
IOSInspector.addPluginAPI(forMethod: "GET", path: "filesystem/open") { params -> Data? in
// return file contents
}
```
#### Websockets
Send messages to your live plugins
```javascript
new WebSocket(`ws://${location.hostname}:${location.port}/plugins/ws/mykey`)
```
```swift
IOSInspector.sendMessage(to: "mykey", message: "Hello world!")
```