libXray

README

libXray

简体中文

This is a wrapper around Xray-core to improve the client development experience.

Note

1. This repository has few maintainers. If you do not report a bug or initiate a PR, your issue will be ignored.
2. This repository does not guarantee API stability, you need to adapt it yourself.
3. This repository is only compatible with the latest release of Xray-core.

Features

build

Compile script. It is recommended to always use this script to compile libXray. We will not answer questions caused by using other compilation methods.

Usage

# Android (min Android API level is 21)
python3 build/main.py android

# Apple (gomobile or go)
python3 build/main.py apple gomobile
python3 build/main.py apple go

# Linux
python3 build/main.py linux

# Windows
python3 build/main.py windows

Android

use gomobile .

iOS && macOS

1. use gomobile

Need "iOS Simulator Runtime".

This is the best choice for general scenarios and will not conflict with other frameworks.

Supports iOS, iOSSimulator, macOS, macCatalyst.

But it is not possible to set the minimum macOS version, which will cause some warnings when compiling. And it does not support tvOS.

2. use cgo

Need "iOS Simulator Runtime" and "tvOS Simulator Runtime".

Support more compilation options, output c header files.

This works well when you use ffi for integration. For example, integration with swift, kotlin, dart.

Support iOS, iOSSimulator, macOS, tvOS.

Note: The product LibXray.xcframework does not contain module.modulemap. When using swift, you need to create a bridge file.

Linux

depend on gcc and g++.

Windows

depend on MinGW.

you can use winget to install LLVM MinGW or WinLibs .

winget install MartinStorsjo.LLVM-MinGW.UCRT
winget install BrechtSanders.WinLibs.POSIX.UCRT

controller

Used to solve the socket protect problem on Android.

dns

Used to solve server address resolution issues on Android, Linux, and Windows. If not handled, the DNS traffic will be resent to the tun device, resulting in failure to initiate a connection.

geo

count

Read geo files and count the categories and rules.

read

Read the Xray Json configuration and extract the geo file name used.

main

Download geosite.dat and geoip.dat and count them.

memory

Only executed on iOS, GC is initiated once a second. This can alleviate memory pressure on iOS.

nodep

file

Write data to a file.

measure

Speed ​​test the Xray configuration.

model

The response body of the wrapper interface.

port

Get free ports.

share

libXray uses sendThrough to store outbound names.

clash_meta

Parse Clash.Meta configuration.

generate_share

convert Xray Json to VMessAEAD/VLESS sharing protocol.

parse_share

convert VMessAEAD/VLESS sharing protocol to Xray Json.

convert VMessQRCode to Xray Json.

vmess

convert VMessQRCode to Xray Json.

xray_json

Some tools used to parse shared links.

xray

ping

Latency testing.

stats

Refer to the following configuration:

{
  "metrics" : {
    "tag" : "metrics",
    "listen": "[::1]:49227",
  },
  "policy" : {
    "system" : {
      "statsInboundDownlink" : true,
      "statsInboundUplink" : true,
      "statsOutboundDownlink" : true,
      "statsOutboundUplink" : true
    }
  },
  "stats" : {}
}

Note:

1. When testing latency or validating configuration, make sure metrics is null.

2. When enabling metrics, the Xray-core instance needs to be run in a child process.

validation

Verify the Xray configuration.

xray

Start and stop Xray instances.

nodep_wrapper

export nodep.

xray_wrapper

export xray.

Credits

Project X

VMessPing

FreePort

License

This repository is based on the MIT License.

Documentation

Overview

libXray is an Xray wrapper focusing on improving the experience of Xray-core mobile development.

Index

• func ConvertShareLinksToXrayJson(base64Text string) string
• func ConvertXrayJsonToShareLinks(base64Text string) string
• func CountGeoData(base64Text string) string
• func GetFreePorts(count int) string
• func GetXrayState() bool
• func InitDns(base64Text string) string
• func NewInitDnsRequest(dns, deviceName string) (string, error)
• func NewXrayRunFromJSONRequest(datDir, configJSON string) (string, error)
• func NewXrayRunRequest(datDir, configPath string) (string, error)
• func Ping(base64Text string) string
• func QueryStats(base64Text string) string
• func ReadGeoFiles(base64Text string) string
• func ResetDns() string
• func RunXray(base64Text string) string
• func RunXrayFromJSON(base64Text string) string
• func StopXray() string
• func TestXray(base64Text string) string
• func XrayVersion() string
• type CountGeoDataRequest
• type InitDnsRequest
• type RunXrayFromJSONRequest
• type RunXrayRequest
• type TestXrayRequest

Functions

func ConvertShareLinksToXrayJson

func ConvertShareLinksToXrayJson(base64Text string) string

Convert share text to XrayJson support XrayJson, v2rayN plain text, v2rayN base64 text, Clash.Meta yaml

func ConvertXrayJsonToShareLinks

func ConvertXrayJsonToShareLinks(base64Text string) string

Convert XrayJson to share links. VMess will generate VMessAEAD link.

func CountGeoData

func CountGeoData(base64Text string) string

Read geo data and write all codes to text file.

func GetFreePorts

func GetFreePorts(count int) string

Wrapper of nodep.GetFreePorts count means how many ports you need.

func GetXrayState

func GetXrayState() bool

Get Xray State

func InitDns

func InitDns(base64Text string) string

Init Dns.

func NewInitDnsRequest

func NewInitDnsRequest(dns, deviceName string) (string, error)

Init Dns Request

func NewXrayRunFromJSONRequest

func NewXrayRunFromJSONRequest(datDir, configJSON string) (string, error)

Create Xray Run From JSON Request

func NewXrayRunRequest

func NewXrayRunRequest(datDir, configPath string) (string, error)

Create Xray Run Request

func Ping

func Ping(base64Text string) string

Ping Xray config and get the delay of its outbound.

func QueryStats

func QueryStats(base64Text string) string

query inbound and outbound stats.

func ReadGeoFiles

func ReadGeoFiles(base64Text string) string

thin geo data

func ResetDns

func ResetDns() string

func RunXray

func RunXray(base64Text string) string

Run Xray instance.

func RunXrayFromJSON

func RunXrayFromJSON(base64Text string) string

Run Xray instance with JSON configuration.

func StopXray

func StopXray() string

Stop Xray instance.

func TestXray

func TestXray(base64Text string) string

Test Xray Config.

func XrayVersion

func XrayVersion() string

Xray's version

Types

type CountGeoDataRequest

type CountGeoDataRequest struct {
	DatDir  string `json:"datDir,omitempty"`
	Name    string `json:"name,omitempty"`
	GeoType string `json:"geoType,omitempty"`
}

type InitDnsRequest

type InitDnsRequest struct {
	Dns        string `json:"dns,omitempty"`
	DeviceName string `json:"deviceName,omitempty"`
}

type RunXrayFromJSONRequest

type RunXrayFromJSONRequest struct {
	DatDir     string `json:"datDir,omitempty"`
	ConfigJSON string `json:"configJSON,omitempty"`
}

type RunXrayRequest

type RunXrayRequest struct {
	DatDir     string `json:"datDir,omitempty"`
	ConfigPath string `json:"configPath,omitempty"`
}

type TestXrayRequest

type TestXrayRequest struct {
	DatDir     string `json:"datDir,omitempty"`
	ConfigPath string `json:"configPath,omitempty"`
}