Skip to content

Commit

Permalink
tinc-vpn: T766: Fix some inappropriate descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
@jack9603301
jack9603301 committed Aug 14, 2023
1 parent b04aaf6 commit 26518cd
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 46 deletions.
1 change: 0 additions & 1 deletion debian/control
View file
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,6 @@ Depends:
zabbix-agent2,
ndppd,
miniupnpd-nftables,
wpasupplicant (>= 0.6.7),
tinc
Description: VyOS configuration scripts and data
VyOS configuration scripts, interface definitions, and everything
Expand Down
42 changes: 21 additions & 21 deletions interface-definitions/interfaces-tinc.xml.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,26 @@
<children>
<tagNode name="tinc" owner="${vyos_conf_scripts_dir}/interfaces-tinc.py">
<properties>
<help>Tinc VPN Tunnel Interface</help>
<help>tinc VPN Tunnel Interface</help>
<priority>460</priority>
<constraint>
<regex>^tinc[0-9]+$</regex>
</constraint>
<constraintErrorMessage>Tinc VPN tunnel interface must be named vtincN</constraintErrorMessage>
<constraintErrorMessage>tinc VPN tunnel interface must be named vtincN</constraintErrorMessage>
<valueHelp>
<format>tincN</format>
<description>Tinc VPN interface name</description>
<description>tinc VPN interface name</description>
</valueHelp>
</properties>
<children>
<leafNode name="node-name">
<properties>
<help>Local Node Name options(require)</help>
<help>Local node name options(require)</help>
</properties>
</leafNode>
<leafNode name="subnets">
<properties>
<help>Declare network segment</help>
<help>Subnet settings</help>
<valueHelp>
<format>ipv4net</format>
<description>IPv4 address and prefix length</description>
Expand Down Expand Up @@ -129,21 +129,21 @@
<children>
<leafNode name="cipher">
<properties>
<help>Standard Data Encryption Algorithm(default:aes-256-cbc)</help>
<help>Standard Data Encryption algorithm(default: aes-256-cbc)</help>
</properties>
<defaultValue>aes-256-cbc</defaultValue>
</leafNode>
<leafNode name="digset">
<properties>
<help>UDP Digest settings(default:sha256)</help>
<help>UDP Digest settings(default: sha256)</help>
</properties>
<defaultValue>sha256</defaultValue>
</leafNode>
</children>
</node>
<leafNode name="bridge">
<properties>
<help>Tinc VPN interface device Bridge Mode(If this option is not specified, tinc will run in routing mode)</help>
<help>tinc VPN interface device Bridge Mode(If this option is not specified, tinc will run in routing mode)</help>
<completionHelp>
<list>switch hub</list>
</completionHelp>
Expand Down Expand Up @@ -235,7 +235,7 @@
</leafNode>
<leafNode name="key-expire">
<properties>
<help>Key expiration time(seconds,default:3600)</help>
<help>Key expiration time(seconds, default: 3600)</help>
</properties>
<defaultValue>3600</defaultValue>
</leafNode>
Expand All @@ -247,25 +247,25 @@
</leafNode>
<leafNode name="mac-expire">
<properties>
<help>MAC expiration time(seconds,default:600)</help>
<help>MAC expiration time(seconds, default: 600)</help>
</properties>
<defaultValue>600</defaultValue>
</leafNode>
<leafNode name="max-timeout">
<properties>
<help>Max Timeout(seconds,default:900)</help>
<help>Max Timeout(seconds, default: 900)</help>
</properties>
<defaultValue>900</defaultValue>
</leafNode>
<leafNode name="ping-interval">
<properties>
<help>Ping Interval(seconds,default:60)</help>
<help>Ping Interval(seconds, default: 60)</help>
</properties>
<defaultValue>60</defaultValue>
</leafNode>
<leafNode name="ping-timeout">
<properties>
<help>Ping Timeout(seconds,default:5)</help>
<help>Ping Timeout(seconds, default: 5)</help>
</properties>
<defaultValue>5</defaultValue>
</leafNode>
Expand Down Expand Up @@ -334,7 +334,7 @@
</valueHelp>
<valueHelp>
<format>exec</format>
<description>Executes the given command which should set up the outgoing connection. The environment variables NAME, NODE, REMOTEADDRES and REMOTEPORT are available</description>
<description>Command to execute on connection setup</description>
</valueHelp>
<constraint>
<regex>(socks4|socks5|http|exec)</regex>
Expand Down Expand Up @@ -369,26 +369,26 @@
</leafNode>
<leafNode name="exec">
<properties>
<help>Executes the given command which should set up the outgoing connection. The environment variables NAME, NODE, REMOTEADDRES and REMOTEPORT are available</help>
<help>Command to execute on connection setup</help>
</properties>
</leafNode>
</children>
</node>
<leafNode name="replay-window">
<properties>
<help>ReplayWindow(Bytes,default:16)</help>
<help>ReplayWindow(Bytes, default: 16)</help>
</properties>
<defaultValue>16</defaultValue>
</leafNode>
<leafNode name="strict-subnets">
<properties>
<help>When this option is enabled tinc will only use Subnet statements which are present in the host config files in the local /etc/tinc/netname/hosts/ directory. Subnets learned via connections to other nodes and which are not present in the local host config files are ignored</help>
<help>Ignore connections from unknown networks</help>
<valueless/>
</properties>
</leafNode>
<leafNode name="tunnel-server">
<properties>
<help>When this option is enabled tinc will no longer forward information between other tinc daemons, and will only allow connections with nodes for which host config files are present in the local /etc/tinc/netname/hosts/ directory, Setting this options also implicitly sets StrictSubnets</help>
<help>Declare the node as a tunnel server</help>
<valueless/>
</properties>
</leafNode>
Expand Down Expand Up @@ -428,19 +428,19 @@
</leafNode>
<leafNode name="compression-level">
<properties>
<help>Compression Level Option(default:9)</help>
<help>Compression Level Option(default: 9)</help>
</properties>
<defaultValue>9</defaultValue>
</leafNode>
<leafNode name="mac-length">
<properties>
<help>MAC Length(Bytes,default:4)</help>
<help>MAC Length(Bytes, default: 4)</help>
</properties>
<defaultValue>4</defaultValue>
</leafNode>
<leafNode name="mtu">
<properties>
<help>MTU(Bytes,default:1514)</help>
<help>MTU(Bytes, default: 1514)</help>
</properties>
<defaultValue>1514</defaultValue>
</leafNode>
Expand Down
28 changes: 4 additions & 24 deletions op-mode-definitions/tinc.xml.in
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,20 @@
<children>
<node name="tinc">
<properties>
<help>Show Tinc VPN interface information</help>
<help>Show tinc VPN interface information</help>
</properties>
<children>
<leafNode name="detail">
<properties>
<help>Show detailed Tinc VPN interface information</help>
<help>Show detailed tinc VPN interface information</help>
</properties>
<command>${vyos_op_scripts_dir}/show_interfaces.py --intf-type=tinc --action=show</command>
</leafNode>
</children>
</node>
<tagNode name="tinc">
<properties>
<help>Show Tinc VPN interface information</help>
<help>Show tinc VPN interface information</help>
<completionHelp>
<script>sudo ${vyos_completion_dir}/list_interfaces.py --type tinc</script>
</completionHelp>
Expand All @@ -28,7 +28,7 @@
<children>
<leafNode name="brief">
<properties>
<help>Show summary of specified Tinc VPN interface information</help>
<help>Show summary of specified tinc VPN interface information</help>
</properties>
<command>${vyos_op_scripts_dir}/show_interfaces.py --intf="$4" --action=show-brief</command>
</leafNode>
Expand All @@ -38,24 +38,4 @@
</node>
</children>
</node>
<node name="generate">
<children>
<tagNode name="tinc">
<properties>
<help>Generate tinc vpn tunnel configuration</help>
<completionHelp>
<script>sudo ${vyos_completion_dir}/list_interfaces.py --type tinc</script>
</completionHelp>
</properties>
<children>
<leafNode name="host-conf">
<properties>
<help>Generate tinc vpn tunnel host configuration path</help>
</properties>
<command>scp "$5" "/etc/tinc/$3/hosts/"</command>
</leafNode>
</children>
</tagNode>
</children>
</node>
</interfaceDefinition>

0 comments on commit 26518cd

Please sign in to comment.