docs: add comments for wgQuickString and wgUserSpaceString

celzero · Oct 12, 2024 · a33539f · a33539f
1 parent eb544cb
commit a33539f
Showing 1 changed file with 45 additions and 0 deletions.
diff --git a/app/src/main/java/com/celzero/bravedns/wireguard/WgInterface.kt b/app/src/main/java/com/celzero/bravedns/wireguard/WgInterface.kt
@@ -154,6 +154,34 @@ class WgInterface private constructor(builder: Builder) {
      * file.
      *
      * @return The `Interface` represented as a series of "Key = Value" lines
+     *
+     * below is the sample file content for the Interface section, similar will be stored in the
+     * wg[0-9].conf file
+     * [Interface]
+     * Address = 100.80.213.126/32
+     * DNS = 10.255.255.3
+     * PrivateKey = KBdV2Iv+poXZkCOZukSo30modVHqyO5+GCdfhP4n40I=
+     *
+     * [Peer]
+     * AllowedIPs = 0.0.0.0/0, ::/0
+     * Endpoint = yul-359-wg.whiskergalaxy.com:443
+     * Endpoint = yul-359-wg.whiskergalaxy.com:443
+     * PreSharedKey = VQoBVQxMmgttgGh9JCBwOPiwnFYV6/Py1tRi/f38DEI=
+     * PublicKey = nfFRpFZ0ZXWVoz8C4gP5ti7V1snFT1gV8EcIxTWJtB4=
+     *
+     * below is converted to wg-quick format
+     * [Interface]
+     * Address = 100.80.213.126/32
+     * DNS = 10.255.255.3
+     * PrivateKey = KBdV2Iv+poXZkCOZukSo30modVHqyO5+GCdfhP4n40I=
+     *
+     * [Peer]
+     * AllowedIPs = 0.0.0.0/0, ::/0
+     * Endpoint = yul-359-wg.whiskergalaxy.com:443
+     * Endpoint = yul-359-wg.whiskergalaxy.com:443
+     * PreSharedKey = VQoBVQxMmgttgGh9JCBwOPiwnFYV6/Py1tRi/f38DEI=
+     * PublicKey = nfFRpFZ0ZXWVoz8C4gP5ti7V1snFT1gV8EcIxTWJtB4=
+     *
      */
     fun toWgQuickString(): String {
         val sb = StringBuilder()
@@ -187,6 +215,23 @@ class WgInterface private constructor(builder: Builder) {
      * not all attributes are included in this representation.
      *
      * @return the `Interface` represented as a series of "KEY=VALUE" lines
+     *
+     * see #toWgQuickString() for more details on the format
+     *
+     * below is the converted format for the userspace string
+     *
+     * private_key=281755d88bfea685d9902399ba44a8df49a87551eac8ee7e18275f84fe27e342
+     * address=100.80.213.126/32
+     * dns=10.255.255.3
+     * mtu=1280
+     * replace_peers=true
+     * public_key=9df151a45674657595a33f02e203f9b62ed5d6c9c54f5815f04708c53589b41e
+     * allowed_ip=0.0.0.0/0
+     * allowed_ip=::/0
+     * endpoint=172.98.68.207:443
+     * endpoint=yul-359-wg.whiskergalaxy.com:443
+     * preshared_key=550a01550c4c9a0b6d80687d24207038f8b09c5615ebf3f2d6d462fdfdfc0c42
+     *
      */
     fun toWgUserspaceString(skipListenPort: Boolean): String {
         val dnsServerStrings =