✨ feat: 支持字符串形式的 .ovpn 配置

Author: ccnnde

README.md

@@ -144,6 +144,7 @@ export default App;
 ```ts
 interface VpnOptions {
   remoteAddress?: string;
+  ovpnString?: string;
   ovpnFileName?: string;
   assetsPath?: string;
   providerBundleIdentifier: string;
@@ -155,6 +156,12 @@ interface VpnOptions {
 
 VPN server address, the format is `<ip> <port>`, use the address in the configuration file of `xxx.ovpn` when it is not passed in
 
+#### ovpnString
+
+The string format of the content of the OpenVPN configuration file. When it is not passed in or an empty string `''` is passed, the module will look for the `xxx.ovpn` configuration file string format
+
+String format reference [example.ovpn](example/android/app/src/main/assets/Japan.ovpn)
+
 #### ovpnFileName
 
 The name of the OpenVPN configuration file, without extensions, using the default name `client` if not passed in
@@ -188,7 +195,7 @@ interface VpnEventParams {
 
 ### `xxx.ovpn` configuration file
 
-Don't forget to add the configuration file to your project
+If you don’t use [ovpnString](#ovpnstring), don’t forget to add the configuration file to your project
 
 - The Android path is `android/app/src/main/assets/`，create a new `assets` folder if you don't have one
 - The iOS path is the main bundle, just drag and drop the file into the project
@@ -227,7 +234,7 @@ The following items were used in this project
 
 ## License
 
-react-native-simple-openvpn is available under the GPLv2 license. See the [LICENSE](LICENSE) file for more information
+[GPLv2](LICENSE) © Nor Cod
 
 <!-- badge url -->
 

README.zh-CN.md

@@ -144,6 +144,7 @@ export default App;
 ```ts
 interface VpnOptions {
   remoteAddress?: string;
+  ovpnString?: string;
   ovpnFileName?: string;
   assetsPath?: string;
   providerBundleIdentifier: string;
@@ -155,6 +156,12 @@ interface VpnOptions {
 
 VPN 服务端地址，格式为 `<ip> <port>`，未传入时使用 `xxx.ovpn` 配置文件中的地址
 
+#### ovpnString
+
+OpenVPN 配置文件内容的字符串形式，未传入时或传递空字符串 `''`，模块将寻找 `xxx.ovpn` 配置文件
+
+字符串格式参考 [example.ovpn](example/android/app/src/main/assets/Japan.ovpn)
+
 #### ovpnFileName
 
 OpenVPN 配置文件的名称，不含扩展名，未传入时使用默认名称 `client`
@@ -188,7 +195,7 @@ interface VpnEventParams {
 
 ### `xxx.ovpn` 配置文件
 
-不要忘记将配置文件添加你的项目中
+如果你不使用 [ovpnString](#ovpnstring)，不要忘记将配置文件添加你的项目中
 
 - Android 路径 `android/app/src/main/assets/`，没有 `assets` 文件夹就新建一个
 - iOS 路径为 main bundle，将文件拖拽到工程下即可
@@ -222,7 +229,7 @@ remote <IP address> <port>
 
 ## License
 
-react-native-simple-openvpn 是在 GPLv2 许可证下提供的。参见 [LICENSE](LICENSE) 文件以了解更多信息
+[GPLv2](LICENSE) © Nor Cod
 
 <!-- badge url -->
 

android/src/main/java/com/norcod/rnovpn/RNSimpleOpenvpnModule.java

@@ -164,22 +164,9 @@ private void startVpn(Promise promise) {
 
     try {
       String remoteAddress = ovpnOptions.getOrDefault("remoteAddress", "").toString();
-      String assetsPath = ovpnOptions.getOrDefault("assetsPath", "").toString();
-      String ovpnFileName = ovpnOptions.getOrDefault("ovpnFileName", "client").toString();
-      String ovpnFilePath = assetsPath + ovpnFileName + ".ovpn";
-
-      InputStream conf = reactContext.getAssets().open(ovpnFilePath);
-      InputStreamReader isr = new InputStreamReader(conf);
-      BufferedReader br = new BufferedReader(isr);
-      String line;
-
-      while (true) {
-        line = br.readLine();
-        if (line == null) {
-          break;
-        }
-        config += line + "\n";
-      }
+      String ovpnString = ovpnOptions.getOrDefault("ovpnString", "").toString();
+
+      config = ovpnString.isEmpty() ? getOvpnFileContent() : ovpnString;
 
       if (config.isEmpty()) {
         throw new Exception("ovpn config is empty");
@@ -215,6 +202,28 @@ private void startVpn(Promise promise) {
     promise = null;
   }
 
+  private String getOvpnFileContent() throws Exception {
+    String content = "";
+    String assetsPath = ovpnOptions.getOrDefault("assetsPath", "").toString();
+    String ovpnFileName = ovpnOptions.getOrDefault("ovpnFileName", "client").toString();
+    String ovpnFilePath = assetsPath + ovpnFileName + ".ovpn";
+
+    InputStream conf = reactContext.getAssets().open(ovpnFilePath);
+    InputStreamReader isr = new InputStreamReader(conf);
+    BufferedReader br = new BufferedReader(isr);
+    String line;
+
+    while (true) {
+      line = br.readLine();
+      if (line == null) {
+        break;
+      }
+      content += line + "\n";
+    }
+
+    return content;
+  }
+
   private String getModifiedOvpnConfig(String ovpnConfig, String remoteAddress) {
     final String regex =
         "^remote\\s(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\s((6553[0-5])|(655[0-2][0-9])|(65[0-4][0-9]{2})|(6[0-4][0-9]{3})|([1-5][0-9]{4})|([0-5]{0,5})|([0-9]{1,4}))$";

index.d.ts

@@ -19,6 +19,7 @@
 
 interface VpnOptions {
   remoteAddress?: string;
+  ovpnString?: string;
   ovpnFileName?: string;
   assetsPath?: string;
   providerBundleIdentifier: string;

ios/RNSimpleOpenvpn.m

@@ -81,7 +81,6 @@ - (void)prepareVpn:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlo
 }
 
 - (void)startVpn:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock)reject {
-  NSString *const ovpnFileName = self.ovpnOptions[@"ovpnFileName"] ? self.ovpnOptions[@"ovpnFileName"] : @"client";
   NSString *const providerBundleIdentifier = self.ovpnOptions[@"providerBundleIdentifier"];
   NSString *const localizedDescription =
       self.ovpnOptions[@"localizedDescription"] ? self.ovpnOptions[@"localizedDescription"] : RN_OPEN_VPN;
@@ -91,14 +90,22 @@ - (void)startVpn:(RCTPromiseResolveBlock)resolve rejecter:(RCTPromiseRejectBlock
     return;
   }
 
-  NSURL *url = [[NSBundle mainBundle] URLForResource:ovpnFileName withExtension:@"ovpn"];
+  NSString *const ovpnString = self.ovpnOptions[@"ovpnString"] ? self.ovpnOptions[@"ovpnString"] : @"";
+  NSData *data;
 
-  if (url == nil) {
-    reject(@"E_NO_OVPN_FILE_ERROR", @"There are no ovpn file", nil);
-    return;
-  }
+  if ([ovpnString length] != 0) {
+    data = [ovpnString dataUsingEncoding:NSUTF8StringEncoding];
+  } else {
+    NSString *const ovpnFileName = self.ovpnOptions[@"ovpnFileName"] ? self.ovpnOptions[@"ovpnFileName"] : @"client";
+    NSURL *url = [[NSBundle mainBundle] URLForResource:ovpnFileName withExtension:@"ovpn"];
+
+    if (url == nil) {
+      reject(@"E_NO_OVPN_FILE_ERROR", @"There are no ovpn file", nil);
+      return;
+    }
 
-  NSData *data = [[NSData alloc] initWithContentsOfURL:url];
+    data = [[NSData alloc] initWithContentsOfURL:url];
+  }
 
   NETunnelProviderProtocol *tunel = [NETunnelProviderProtocol new];
   tunel.providerConfiguration = @{@"ovpn" : data};