一、开源项目简介

简介

• 中微子代理（neutrino-proxy）是一个基于netty的、开源的java内网穿透项目。
• 技术栈：Solon、MybatisPlus、Netty
• 遵循MIT许可，因此您可以对它进行复制、修改、传播并用于任何个人或商业行为。

二、开源协议

使用MIT开源协议

三、界面展示

运行示例

四、功能概述

一款基于netty的内网穿透神器。

名称由来

中微子，是轻子的一种，是组成自然界的最基本的粒子之一。它十分微小、不带电，可自由穿过地球，以接近光速运动，与其他物质的相互作用十分微弱，号称宇宙间的“隐身人”。

中微子是宇宙中穿透能力最强的物质,只有粒子之间的间隙小于10的负19次方米时,才能够阻挡住中微子。

因此以中微子命名，寓意着中微子代理拥有中微子"安全"、"快速"、"穿透力强"的特点。

五、技术选型

项目结构

• neutrino-proxy
• neutrino-proxy-core 与代理相关的公共常量、编解码器
• neutrino-proxy-client 代理客户端项目
• neutrino-proxy-server 代理服务端项目
• neutrino-proxy-admin 代理监控项目（基于vue-element-admin开发）

5、运行

5.1、使用keytool工具生成ssl证书, 若不需要ssl加密可跳过

keytool -genkey -alias test1 -keyalg RSA -keysize 1024 -validity 3650 -keypass 123456 -storepass 123456 -keystore  "./test.jks"

5.2、修改服务端配置（app.yml）

application:
  name: neutrino-proxy-server

neutrino:
  proxy:
    protocol:
      max-frame-length: 2097152
      length-field-offset: 0
      length-field-length: 4
      initial-bytes-to-strip: 0
      length-adjustment: 0
      read-idle-time: 60
      write-idle-time: 40
      all-idle-time-seconds: 0
    tunnel:
      boss-thread-count: 2
      work-thread-count: 10
      # 服务端端口，用于保持与客户端的连接，非SSL
      port: ${OPEN_PORT:9000}
      # 服务端端口，用于保持与客户端的连接，SSL,需要jks证书文件，若不需要ssl支持，可不配置
      ssl-port: ${SSL_PORT:9002}
      # 证书配置，用于隧道通信SSL加密
      key-store-password: ${STORE_PASS:123456}
      key-manager-password: ${MGR_PASS:123456}
      jks-path: ${JKS_PATH:classpath:/test.jks}
    server:
      boss-thread-count: 5
      work-thread-count: 20
      # HTTP代理端口，默认80，也可以用其他端口，走nginx转发
      http-proxy-port: ${HTTP_PROXY_PORT:80}
      # HTTPS代理端口，默认443，也可以用其他端口，走nginx转发
      https-proxy-port: ${HTTPS_PROXY_PORT:443}
      # 如果不配置，则不支持域名映射
      domain-name: ${DOMAIN_NAME:}
      # 证书配置，用于支持HTTPS
      key-store-password: ${HTTPS_STORE_PASS:}
      jks-path: ${HTTPS_JKS_PATH:}
    data:
      # 数据库配置（支持mysql）
        type: sqlite
        url: jdbc:sqlite:data.db
        driver-class: org.sqlite.JDBC
        username:
        password:

5.3、启动服务端

java -jar neutrino-proxy-server.jar

5.4、修改客户端配置

application:
  name: neutrino-proxy-client

proxy:
  protocol:
    max-frame-length: 2097152
    length-field-offset: 0
    length-field-length: 4
    initial-bytes-to-strip: 0
    length-adjustment: 0
    read-idle-time: 60
    write-idle-time: 30
    all-idle-time-seconds: 0
  client:
    # ssl证书密码
    key-store-password: 123456
    # ssl证书存放位置
    jks-path: classpath:/test.jks
    # 服务端ip，若部署到服务器，则配置服务器的ip
    server-ip: localhost
    # 服务端端口，若使用ssl，则需要配置为服务端的"ssl-port"
    server-port: 9000
    # 是否启用ssl，启用则必须配置ssl相关参数
    ssl-enable: false

5.5、代理示意图

5.6、启动客户端

5.6.1、启动参数直接指定配置

java -jar neutrino-proxy-client.jar serverIp=localhost serverPort=9000 licenseKey=b0a907332b474b25897c4dcb31fc7eb6

5.6.2、启动参数指定外部配置文件

java -jar neutrino-proxy-client.jar config=app.properties

配置文件格式如下：

neutrino.proxy.client.server-ip=localhost
neutrino.proxy.client.server-port=9002
neutrino.proxy.client.ssl-enable=true
neutrino.proxy.client.key-store-password=123456
neutrino.proxy.client.jks-path=classpath:/test.jks
neutrino.proxy.client.license-key=b0a907332b474b25897c4dcb31fc7eb6

5.7、Docker快速启动

 # 一键部署前端和后端，客户端按上方部署即可
    docker run -it -p 9000-9200:9000-9200/tcp -p 8888:8888 -d --name neutrino registry.cn-hangzhou.aliyuncs.com/asgc/aoshiguchen-docker-images:1.64
    # 如没docker环境，可以一键部署docker环境（centos 7.8）系统
    curl http://www.wangke666.cn/static/createDocker.sh | bash

未来迭代方向

• 优化代码、增强稳定性
• 服务端增加管理页面，提供报表、授权、限流等功能
• 从项目中分离、孵化出另一个开源项目(neutrino-framework)

感谢

• Solon
• Hutool
• JetBrains