react-native-nitro-tor

Features

Installation

# Using npm
npm install react-native-nitro-tor
# Using yarn
yarn add react-native-nitro-tor

npm install react-native-nitro-modules
# or
yarn add react-native-nitro-modules

Platform Support

Usage

Basic Example

import { RnTor } from 'react-native-nitro-tor';
// Start Tor with a hidden service
const startTor = async () => {
 const result = await RnTor.startTorIfNotRunning({
 data_dir: '/path/to/tor/data',
 socks_port: 9050,
 target_port: 8080,
 timeout_ms: 60000,
 });
 if (result.is_success) {
 console.log(`Tor started successfully!`);
 console.log(`Onion address: ${result.onion_address}`);
 console.log(`Control: ${result.control}`);
 } else {
 console.error(`Failed to start Tor: ${result.error_message}`);
 }
};
// Shut down the Tor service
const shutdown = async () => {
 const result = await RnTor.shutdownService();
 console.log(`Tor shutdown ${result ? 'successful' : 'failed'}`);
};

HTTP Methods Over Tor

import { RnTor } from 'react-native-nitro-tor';
// Make an HTTP GET request through Tor
const makeGetRequest = async () => {
 const result = await RnTor.httpGet({
 url: 'http://example.com',
 headers: '',
 timeout_ms: 2000,
 });
 console.log(`Status code: ${result.status_code}`);
 console.log(`Response body: ${result.body}`);
 if (result.error) {
 console.error(`Error: ${result.error}`);
 }
};
// Make an HTTP POST request through Tor
const makePostRequest = async () => {
 const result = await RnTor.httpPost({
 url: 'http://httpbin.org/post',
 body: '{"test":"data"}',
 headers: '{"Content-Type":"application/json"}',
 timeout_ms: 2000,
 });
 console.log(`Status code: ${result.status_code}`);
 console.log(`Response body: ${result.body}`);
 if (result.error) {
 console.error(`Error: ${result.error}`);
 }
};
// Make an HTTP PUT request through Tor
const makePutRequest = async () => {
 const result = await RnTor.httpPut({
 url: 'http://httpbin.org/put',
 body: '{"updated":"value"}',
 headers: '{"Content-Type":"application/json"}',
 timeout_ms: 2000,
 });
 console.log(`Status code: ${result.status_code}`);
 console.log(`Response body: ${result.body}`);
 if (result.error) {
 console.error(`Error: ${result.error}`);
 }
};
// Make an HTTP DELETE request through Tor
const makeDeleteRequest = async () => {
 const result = await RnTor.httpDelete({
 url: 'http://httpbin.org/delete',
 headers: '{"Content-Type":"application/json"}',
 timeout_ms: 2000,
 });
 console.log(`Status code: ${result.status_code}`);
 console.log(`Response body: ${result.body}`);
 if (result.error) {
 console.error(`Error: ${result.error}`);
 }
};

Advanced Usage

import { RnTor } from 'react-native-nitro-tor';
// Initialize Tor service
const initTor = async () => {
 const initialized = await RnTor.initTorService({
 socks_port: 9050,
 data_dir: '/path/to/tor/data',
 timeout_ms: 60000,
 });
 if (initialized) {
 console.log('Tor service initialized successfully');
 return true;
 }
 return false;
};
// Create a hidden service
const createService = async () => {
 const serviceResult = await RnTor.createHiddenService({
 port: 9055,
 target_port: 9056,
 // Optionally provide key_data for persistent services
 });
 if (serviceResult.is_success) {
 console.log(`Created hidden service at: ${serviceResult.onion_address}`);
 }
};
// Get the current status of the Tor service.
// 0: Tor is in the process of starting.
// 1: Tor is running.
// 2: Stopped/Not running/error.
// Check service status
const checkStatus = async () => {
 const status = await RnTor.getServiceStatus();
 console.log(`Current Tor service status: ${status}`);
};
// Shutdown Tor service
const shutdown = async () => {
 const result = await RnTor.shutdownService();
 console.log(`Tor shutdown ${result ? 'successful' : 'failed'}`);
};

API Reference

Types

type ByteArray64 = number[];
interface TorConfig {
 socks_port: number;
 data_dir: string;
 timeout_ms: number;
}
interface HiddenServiceParams {
 port: number;
 target_port: number;
 key_data?: ByteArray64;
}
interface StartTorParams {
 data_dir: string;
 key_data?: ByteArray64;
 socks_port: number;
 target_port: number;
 timeout_ms: number;
}
interface StartTorResponse {
 is_success: boolean;
 onion_address: string;
 control: string;
 error_message: string;
}
interface HiddenServiceResponse {
 is_success: boolean;
 onion_address: string;
 control: string;
}
interface HttpGetParams {
 url: string;
 headers: string;
 timeout_ms: number;
}
interface HttpPostParams {
 url: string;
 body: string;
 headers: string;
 timeout_ms: number;
}
interface HttpPutParams {
 url: string;
 body: string;
 headers: string;
 timeout_ms: number;
}
interface HttpDeleteParams {
 url: string;
 headers: string;
 timeout_ms: number;
}
interface HttpResponse {
 status_code: number;
 body: string;
 error: string;
}

Methods

Binary Files

Architecture Support

Running the example app

# Install dependencies
yarn install
# Generate native interfaces
yarn nitrogen
# Start metro
yarn example start
# For android
yarn example android
# For ios
yarn example ios
# IF ABOVE STEP FOR IOS THROWS ERRORS, you can also try:
cd example/ios && pod install
- Open the NitroTorExample.xcworkspace inside of xcode.
- Drag the Tor.xcframework from the root of the project to xcode project and select the "Copy files to destination" option.
- Build and run from inside of xcode.

License

Credits

Contributing