Merge pull request #17 from NodePassProject/main

feat: add a new mechanism for server-side verification of client IP

Author: yosebyte

LICENSE

@@ -25,4 +25,4 @@ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -4,6 +4,7 @@
 [![GitHub release](https://img.shields.io/github/v/release/yosebyte/nodepass)](https://github.com/yosebyte/nodepass/releases)
 [![GitHub downloads](https://img.shields.io/github/downloads/yosebyte/nodepass/total.svg)](https://github.com/yosebyte/nodepass/releases)
 [![Go Report Card](https://goreportcard.com/badge/github.com/yosebyte/nodepass)](https://goreportcard.com/report/github.com/yosebyte/nodepass)
+[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
 ![GitHub last commit](https://img.shields.io/github/last-commit/yosebyte/nodepass)
 
 English | [简体中文](README_zh.md)
@@ -32,13 +33,11 @@ English | [简体中文](README_zh.md)
   - Smart connection pooling with real-time capacity adaptation
   - Dynamic interval adjustment based on network conditions
   - Minimal resource footprint even under heavy load
-  - Automatic recovery from network disruptions
 
 - **🧰 Simple Configuration**
   - Zero configuration files required
   - Simple command-line parameters
   - Environment variables for fine-tuning performance
-  - Intelligent defaults for most use cases
 
 ## 📋 Quick Start
 

README_zh.md

@@ -4,6 +4,7 @@
 [![GitHub release](https://img.shields.io/github/v/release/yosebyte/nodepass)](https://github.com/yosebyte/nodepass/releases)
 [![GitHub downloads](https://img.shields.io/github/downloads/yosebyte/nodepass/total.svg)](https://github.com/yosebyte/nodepass/releases)
 [![Go Report Card](https://goreportcard.com/badge/github.com/yosebyte/nodepass)](https://goreportcard.com/report/github.com/yosebyte/nodepass)
+[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
 ![GitHub last commit](https://img.shields.io/github/last-commit/yosebyte/nodepass)
 
 [English](README.md) | 简体中文
@@ -32,13 +33,11 @@
   - 智能连接池，具备实时容量自适应功能
   - 基于网络状况的动态间隔调整
   - 高负载下保持最小资源占用
-  - 网络中断后自动恢复连接
 
 - **🧰 简单配置**
   - 零配置文件设计
   - 简洁的命令行参数
   - 环境变量支持性能精细调优
-  - 为大多数使用场景提供智能默认值
 
 ## 📋 快速开始
 

cmd/nodepass/core.go

@@ -5,8 +5,8 @@ import (
 	"net/url"
 	"time"
 
+	"github.com/NodePassProject/cert"
 	"github.com/yosebyte/nodepass/internal"
-	x "github.com/yosebyte/x/tls"
 )
 
 // 根据URL方案分派到不同的运行模式
@@ -47,7 +47,7 @@ func runMaster(parsedURL *url.URL) {
 // 获取TLS配置
 func getTLSProtocol(parsedURL *url.URL) (string, *tls.Config) {
 	// 生成基本TLS配置
-	tlsConfig, err := x.GenerateTLSConfig("yosebyte/nodepass:" + version)
+	tlsConfig, err := cert.NewTLSConfig("yosebyte/nodepass:" + version)
 	if err != nil {
 		logger.Error("Generate failed: %v", err)
 		logger.Warn("TLS code-0: nil cert")
@@ -102,7 +102,7 @@ func getTLSProtocol(parsedURL *url.URL) (string, *tls.Config) {
 		if cert.Leaf != nil {
 			logger.Info("TLS code-2: %v with TLS 1.3", cert.Leaf.Subject.CommonName)
 		} else {
-			logger.Warn("TLS code-2: unknown with TLS 1.3")
+			logger.Warn("TLS code-2: unknown cert name with TLS 1.3")
 		}
 		return tlsCode, tlsConfig
 

cmd/nodepass/main.go

@@ -5,12 +5,12 @@ import (
 	"os"
 	"runtime"
 
-	"github.com/yosebyte/x/log"
+	"github.com/NodePassProject/logs"
 )
 
 var (
 	// 全局日志记录器
-	logger = log.NewLogger(log.Info, true)
+	logger = logs.NewLogger(logs.Info, true)
 	// 程序版本
 	version = "dev"
 )
@@ -41,26 +41,26 @@ func getParsedURL(args []string) *url.URL {
 func initLogLevel(level string) {
 	switch level {
 	case "debug":
-		logger.SetLogLevel(log.Debug)
+		logger.SetLogLevel(logs.Debug)
 		logger.Debug("Init log level: DEBUG")
 	case "warn":
-		logger.SetLogLevel(log.Warn)
+		logger.SetLogLevel(logs.Warn)
 		logger.Warn("Init log level: WARN")
 	case "error":
-		logger.SetLogLevel(log.Error)
+		logger.SetLogLevel(logs.Error)
 		logger.Error("Init log level: ERROR")
 	case "fatal":
-		logger.SetLogLevel(log.Fatal)
+		logger.SetLogLevel(logs.Fatal)
 		logger.Fatal("Init log level: FATAL")
 	default:
-		logger.SetLogLevel(log.Info)
+		logger.SetLogLevel(logs.Info)
 		logger.Info("Init log level: INFO")
 	}
 }
 
 // 输出帮助信息并退出程序
 func getExitInfo() {
-	logger.SetLogLevel(log.Info)
+	logger.SetLogLevel(logs.Info)
 	logger.Info(`Version: %v %v/%v
 
 ╭─────────────────────────────────────────────────────────────╮

docs/en/api.md

@@ -634,8 +634,6 @@ For example:
 http://localhost:9090/api/v1/docs
 ```
 
-![np-api](https://cdn.yobc.de/assets/np-api.png)
-
 The Swagger UI provides a convenient way to explore and test the API directly in your browser. You can execute API calls against your running NodePass Master instance and see the actual responses.
 
 ## Best Practices

docs/en/configuration.md

@@ -57,6 +57,7 @@ NodePass behavior can be fine-tuned using environment variables. Below is the co
 | `NP_MAX_POOL_CAPACITY` | Maximum connection pool size | 1024 | `export NP_MAX_POOL_CAPACITY=4096` |
 | `NP_UDP_DATA_BUF_SIZE` | Buffer size for UDP packets | 8192 | `export NP_UDP_DATA_BUF_SIZE=16384` |
 | `NP_UDP_READ_TIMEOUT` | Timeout for UDP read operations | 5s | `export NP_UDP_READ_TIMEOUT=10s` |
+| `NP_TCP_READ_TIMEOUT` | Timeout for TCP read operations | 5s | `export NP_TCP_READ_TIMEOUT=10s` |
 | `NP_UDP_DIAL_TIMEOUT` | Timeout for establishing UDP connections | 5s | `export NP_UDP_DIAL_TIMEOUT=10s` |
 | `NP_TCP_DIAL_TIMEOUT` | Timeout for establishing TCP connections | 5s | `export NP_TCP_DIAL_TIMEOUT=10s` |
 | `NP_MIN_POOL_INTERVAL` | Minimum interval between connection creations | 1s | `export NP_MIN_POOL_INTERVAL=500ms` |
@@ -116,6 +117,20 @@ For applications relying heavily on UDP traffic:
   - Increase for high-latency networks or applications with slow response times
   - Decrease for low-latency applications requiring quick failover
 
+### TCP Settings
+
+For optimizing TCP connections:
+
+- `NP_TCP_READ_TIMEOUT`: Timeout for TCP read operations
+  - Increase for high-latency networks or servers with slow response times
+  - Decrease for applications that need to detect disconnections quickly
+  - Affects wait time during data transfer phases
+
+- `NP_TCP_DIAL_TIMEOUT`: Timeout for establishing TCP connections
+  - Increase for unstable network conditions
+  - Decrease for applications that need quick connection success/failure determination
+  - Affects initial connection establishment phase
+
 ### Service Management Settings
 
 - `NP_REPORT_INTERVAL`: Controls how frequently health status is reported

docs/en/installation.md

@@ -96,8 +96,6 @@ After installation, verify that NodePass is correctly installed by checking the
 nodepass
 ```
 
-![np-cli](https://cdn.yobc.de/assets/np-cli.png)
-
 ## Next Steps
 
 Now that you have NodePass installed, you can: