ProxyC/ProxyBuilder/builder.py

#!/usr/bin/python
# -*- coding:utf-8 -*-

import os
import time
import ctypes
import random
import socket
import subprocess

from ProxyBuilder import Shadowsocks
from ProxyBuilder import ShadowsocksR

libcPaths = [
    '/usr/lib64/libc.so.6', # CentOS
    '/lib/i386-linux-gnu/libc.so.6', # Debian / Ubuntu
    '/lib/x86_64-linux-gnu/libc.so.6',
    '/lib/aarch64-linux-gnu/libc.so.6',
    '/lib/libc.musl-x86_64.so.1', # Alpine
]

def __checkPortAvailable(port): # 检测端口可用性
    try:
        ipv4_tcp = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
        ipv4_udp = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
        ipv4_tcp.bind(('0.0.0.0', port))
        ipv4_udp.bind(('0.0.0.0', port))
        ipv4_tcp.close()
        ipv4_udp.close()
        ipv6_tcp = socket.socket(socket.AF_INET6, socket.SOCK_STREAM)
        ipv6_udp = socket.socket(socket.AF_INET6, socket.SOCK_DGRAM)
        ipv6_tcp.bind(('::', port))
        ipv6_udp.bind(('::', port))
        ipv6_tcp.close()
        ipv6_udp.close()
        return True # IPv4 TCP / IPv4 UDP / IPv6 TCP / IPv6 UDP 均无占用
    except:
        return False
    finally: # 关闭socket
        try:
            ipv4_tcp.close()
        except: pass
        try:
            ipv4_udp.close()
        except: pass
        try:
            ipv6_tcp.close()
        except: pass
        try:
            ipv6_udp.close()
        except: pass

def __genTaskFlag(length = 16): # 生成任务代号
    flag = ""
    for i in range(0, length):
        tmp = random.randint(0, 15)
        if tmp >= 10:
            flag += chr(tmp + 87) # a ~ f
        else:
            flag += str(tmp) # 0 ~ 9
    return flag

def __getAvailablePort(rangeStart, rangeEnd): # 获取一个空闲端口
    if rangeStart > rangeEnd:
        return None
    while True:
        port = random.randint(rangeStart, rangeEnd) # 随机选取
        if __checkPortAvailable(port):
            return port
        time.sleep(0.1) # 100ms

def build(proxyInfo, configDir, portRangeStart = 1024, portRangeEnd = 65535):
    '''
    创建代理节点客户端

        程序内部错误:
            return None, {reason}

        代理节点无效:
            return False, {reason}

        代理工作正常:
            return True, {
                'flag': taskFlag,
                'port': socksPort,
                'file': configFile,
                'process': process
            }
    '''
    taskFlag = __genTaskFlag() # 生成测试标志
    socksPort = __getAvailablePort(portRangeStart, portRangeEnd) # 获取Socks5测试端口
    if not 'type' in proxyInfo: # 未指定节点类型
        return False, 'Proxy type not specified'
    proxyType = proxyInfo['type'] # 节点类型
    proxyInfo.pop('type')

    configFile = configDir + '/' + taskFlag + '.json' # 配置文件路径
    if proxyType == 'ss': # Shadowsocks节点
        startCommand, fileContent = Shadowsocks.load(proxyInfo, socksPort, configFile)
    elif proxyType == 'ssr': # ShadowsocksR节点
        startCommand, fileContent = ShadowsocksR.load(proxyInfo, socksPort, configFile)
    else: # 未知类型
        return False, 'Unknown proxy type'
    if startCommand == None: # 格式出错
        return False, 'Format error with ' + str(proxyType)
    try:
        with open(configFile, 'w') as fileObject:
            fileObject.write(fileContent) # 保存配置文件
    except: # 配置文件写入失败
        return None, "Unable write to file " + str(configFile)

    try: # 子进程形式启动
        for libcPath in libcPaths:
            if os.path.exists(libcPath): # 定位libc.so文件
                break
        exitWithMe = lambda: ctypes.CDLL(libcPath).prctl(1, 15) # SIGTERM
        process = subprocess.Popen(startCommand,
            stdout = subprocess.DEVNULL,
            stderr = subprocess.DEVNULL,
            preexec_fn = exitWithMe) # 子进程跟随退出
    except:
        try:
            process = subprocess.Popen(startCommand,
                stdout = subprocess.DEVNULL,
                stderr = subprocess.DEVNULL) # prctl失败 回退正常启动
        except: pass
    if not 'process' in vars(): # 启动失败
        return None, 'Subprocess start failed by `' + ' '.join(startCommand) + '`'

    return True, { # 返回连接参数
        'flag': taskFlag,
        'port': socksPort,
        'file': configFile,
        'process': process
    }

def check(client):
    '''
    检查客户端是否正常运行

        检测出错: return None

        工作异常: return False

        工作正常: return True
    '''
    if client == None:
        return None
    try:
        if client['process'].poll() != None:
            return False # 死亡
        else:
            return True # 正常
    except:
        return None # 异常

def destroy(client):
    '''
    结束客户端并清理

        销毁异常: return None

        客户端退出: return True
    '''
    if client == None:
        return None
    try:
        process = client['process']
        if process.poll() == None: # 未死亡
            process.terminate() # SIGTERM
            while process.poll() == None: # 等待退出
                time.sleep(1)
                process.terminate()
    except:
        return None

    try:
        file = client['file']
        if os.path.exists(file) and os.path.isfile(file):
            os.remove(file) # 删除配置文件
        else:
            return None
    except:
        return None

    return True # 销毁完成