Project

General

Profile

Download (8.24 KB) Statistics
| Branch: | Tag: | Revision:
1 7c172009 Scott Ullrich
<packagegui>
2
	<name>openvpnclient</name>
3
	<title>OpenVPN: Client</title>
4
	<include_file>openvpn.inc</include_file>
5
	<delete_string>An OpenVPN client has been deleted.</delete_string>
6
	<addedit_string>An OpenVPN client has been created/modified.</addedit_string>
7
	<tabs>
8
		<tab>
9
			<text>Server</text>
10
			<url>/pkg.php?xml=openvpn.xml</url>
11
		</tab>
12
		<tab>
13
			<text>Client</text>
14
			<url>/pkg.php?xml=openvpn_cli.xml</url>
15
			<active/>
16
		</tab>
17 8dc3ef67 Scott Ullrich
		<tab>
18 a007827a Scott Ullrich
			<text>Client-specific overrides</text>
19 8dc3ef67 Scott Ullrich
			<url>/pkg.php?xml=openvpn_csc.xml</url>
20
		</tab>
21 a007827a Scott Ullrich
        <tab>
22
			<text>Certificate Authority</text>
23
			<url>/vpn_openvpn_certs.php</url>
24
        </tab>
25
        <tab>
26
			<text>Users</text>
27
			<url>/vpn_openvpn_users.php</url>
28
        </tab>
29 7c172009 Scott Ullrich
	</tabs>
30
	<adddeleteeditpagefields>
31
		<columnitem>
32
			<fieldname>disable</fieldname>
33
			<fielddescr>Disabled</fielddescr>
34
			<type>checkbox</type>
35
		</columnitem>
36
		<columnitem>
37
			<fieldname>serveraddr</fieldname>
38
			<fielddescr>Server</fielddescr>
39
		</columnitem>
40
		<columnitem>
41
			<fieldname>protocol</fieldname>
42
			<fielddescr>Protocol</fielddescr>
43
		</columnitem>
44
		<columnitem>
45
			<fieldname>description</fieldname>
46
			<fielddescr>Description</fielddescr>
47
		</columnitem>
48
	</adddeleteeditpagefields>
49
	<fields>
50
		<field>
51
			<fieldname>disable</fieldname>
52
			<fielddescr>Disable this tunnel</fielddescr>
53
			<description>This allows you to disable this tunnel without removing it from the list.</description>
54 a077d420 Scott Ullrich
			<required/>
55 7c172009 Scott Ullrich
			<type>checkbox</type>
56
		</field>
57
		<field>
58
			<fieldname>protocol</fieldname>
59
			<fielddescr>Protocol</fielddescr>
60
			<description>The protocol to be used for the VPN.</description>
61 a077d420 Scott Ullrich
			<required/>
62 7c172009 Scott Ullrich
			<type>select</type>
63
			<options>
64
				<option>
65
					<value>TCP</value>
66
					<name>TCP</name>
67
				</option>
68 a077d420 Scott Ullrich
				<option>
69
					<value>UDP</value>
70
					<name>UDP</name>
71
				</option>
72 7c172009 Scott Ullrich
			</options>
73 a077d420 Scott Ullrich
			<default_value>UDP</default_value>
74 7c172009 Scott Ullrich
		</field>
75
		<field>
76 a077d420 Scott Ullrich
			<fieldname>serveraddr</fieldname>
77
			<fielddescr>Server address</fielddescr>
78
			<description>This is the address OpenVPN will try to connect to in order to establish the tunnel. Set it to the remote endpoint's address.</description>
79
			<required/>
80 7c172009 Scott Ullrich
			<type>input</type>
81
		</field>
82
		<field>
83 a077d420 Scott Ullrich
			<fieldname>serverport</fieldname>
84
			<fielddescr>Server port</fielddescr>
85
			<description>The port OpenVPN will use to connect to the server. Most people would want to use 1194 here.</description>
86
			<required/>
87 7c172009 Scott Ullrich
			<type>input</type>
88 a077d420 Scott Ullrich
			<default_value>1194</default_value>
89
			<size>5</size>
90 7c172009 Scott Ullrich
		</field>
91
		<field>
92 a077d420 Scott Ullrich
			<fieldname>interface_ip</fieldname>
93
			<fielddescr>Interface IP</fielddescr>
94
			<description>This specifies the IPs to be assigned to the local interface. Expressed as a CIDR range. The first address in the range will be set to the remote endpoint of the interface, and the second will be assigned to the local endpoint. For TLS VPNs, the interface IPs are assigned by the server pool.</description>
95 7c172009 Scott Ullrich
			<type>input</type>
96
		</field>
97
		<field>
98 a077d420 Scott Ullrich
			<fieldname>remote_network</fieldname>
99
			<fielddescr>Remote network</fielddescr>
100
			<description>This is the network that will be accessable from your endpoint. Expressed as a CIDR range. You may leave this blank if all you want is to access the VPN clients. You normally want this set to the remote endpoint's LAN network.</description>
101 8dc3ef67 Scott Ullrich
			<type>input</type>
102
		</field>
103
		<field>
104
			<fieldname>proxy_hostname</fieldname>
105
			<fielddescr>Proxy Host</fielddescr>
106
			<description>Proxy server hostname.</description>
107 a077d420 Scott Ullrich
                        <type>input</type>
108 7c172009 Scott Ullrich
		</field>
109 8dc3ef67 Scott Ullrich
		<field>
110
			<fieldname>proxy_port</fieldname>
111
			<fielddescr>Proxy port</fielddescr>
112
			<description>The port OpenVPN will use on the proxy server.</description>
113
			<type>input</type>
114
			<default_value>3128</default_value>
115
			<size>5</size>
116
		</field>
117 7c172009 Scott Ullrich
		<field>
118
			<fieldname>crypto</fieldname>
119
			<fielddescr>Cryptography</fielddescr>
120
			<description>Here you can choose the cryptography algorithm to be used.</description>
121 a077d420 Scott Ullrich
			<required/>
122 7c172009 Scott Ullrich
			<type>select</type>
123 a077d420 Scott Ullrich
			<default_value>BF-CBC</default_value>
124
		</field>
125
		<field>
126
			<fieldname>auth_method</fieldname>
127
			<fielddescr>Authentication method</fielddescr>
128
			<description>The authentication method to be used.</description>
129
			<required/>
130
			<type>select</type>
131
			<options>
132
				<option>
133
					<value>shared_key</value>
134
					<name>Shared key</name>
135
				</option>
136
				<option>
137
					<value>pki</value>
138
					<name>PKI (Public Key Infrastructure)</name>
139
				</option>
140
			</options>
141
			<onchange>onAuthMethodChanged()</onchange>
142 7c172009 Scott Ullrich
		</field>
143
		<field>
144
			<fieldname>shared_key</fieldname>
145
			<fielddescr>Shared key</fielddescr>
146
			<description>Paste your shared key here.</description>
147
			<type>textarea</type>
148
			<encoding>base64</encoding>
149
			<rows>8</rows>
150
			<cols>40</cols>
151
		</field>
152 a077d420 Scott Ullrich
		<field>
153 267ab13f Ermal Luçi
			<fieldname>ca.crt</fieldname>
154 a077d420 Scott Ullrich
			<fielddescr>CA certificate</fielddescr>
155
			<description>Paste the server's CA certificate in X.509 format here.</description>
156
			<type>textarea</type>
157
			<encoding>base64</encoding>
158
			<rows>8</rows>
159
			<cols>40</cols>
160
		</field>
161
		<field>
162 267ab13f Ermal Luçi
			<fieldname>client.crt</fieldname>
163 a077d420 Scott Ullrich
			<fielddescr>Client certificate</fielddescr>
164
			<description>Paste your client certificate in X.509 format here.</description>
165
			<type>textarea</type>
166
			<encoding>base64</encoding>
167
			<rows>8</rows>
168
			<cols>40</cols>
169
		</field>
170
		<field>
171 267ab13f Ermal Luçi
			<fieldname>client.key</fieldname>
172 a077d420 Scott Ullrich
			<fielddescr>Client key</fielddescr>
173
			<description>Paste your client key in RSA format here.</description>
174
			<type>textarea</type>
175
			<encoding>base64</encoding>
176
			<rows>8</rows>
177
			<cols>40</cols>
178
		</field>
179 54816afd Martin Fuchs
		<field>
180
			<fieldname>tls</fieldname>
181
			<fielddescr>TLS</fielddescr>
182
			<description>Paste your HMAC signature (TLS) here (optional).</description>
183
			<type>textarea</type>
184
			<encoding>base64</encoding>
185
			<rows>8</rows>
186
			<cols>40</cols>
187
		</field>
188 7c172009 Scott Ullrich
		<field>
189
			<fieldname>use_lzo</fieldname>
190
			<fielddescr>LZO compression</fielddescr>
191
			<description>Checking this will compress the packets using the LZO algorithm before sending them.</description>
192
			<type>checkbox</type>
193
		</field>
194 db9aabe2 Scott Ullrich
		<field>
195
			<fieldname>use_shaper</fieldname>
196 6d61e0a0 Martin Fuchs
			<fielddescr>Limit outgoing bandwidth</fielddescr>
197 c1a4aaca Martin Fuchs
			<description>Maximum outgoing bandwidth for this tunnel. Leave empty for no limit. The input value has to be something between 100 bytes/sec and 100 Mbytes/sec (entered as bytes per second).</description>
198 db9aabe2 Scott Ullrich
			<type>input</type>
199
		</field>
200 a73f01f1 Scott Ullrich
		<field>
201
			<fieldname>use_dynamicport</fieldname>
202
			<fielddescr>Dynamic sourceport</fielddescr>
203
			<description>Checking this will let the openvpn client choose a dynamic sourceport for this connection.</description>
204
			<type>checkbox</type>
205
		</field>
206 8fc63cd8 Martin Fuchs
		<field>
207
			<fieldname>passtos</fieldname>
208
			<fielddescr>Pass Type-Of-Service</fielddescr>
209
			<description>Checking this will set the TOS field of the tunnel packet to what the payload's TOS is.</description>
210
			<type>checkbox</type>
211
		</field>
212 e4342843 Martin Fuchs
		<field>
213
			<fieldname>infiniteresolvretry</fieldname>
214
			<fielddescr>Infinitely resolve server</fielddescr>
215
			<description>Infinitely retry to resolve the host name of the OpenVPN server. Useful for not permanently internet-connected machines.</description>
216
			<type>checkbox</type>
217
		</field>
218 8dc3ef67 Scott Ullrich
		<field>
219
			<fieldname>custom_options</fieldname>
220
			<fielddescr>Custom options</fielddescr>
221
			<description>You can put your own custom options here, separated by semi-colons (;). They'll be added to the client configuration.</description>
222 975a40cc Scott Ullrich
			<type>textarea</type>
223
			<cols>65</cols>
224
			<rows>5</rows>
225 8dc3ef67 Scott Ullrich
		</field>
226 7c172009 Scott Ullrich
		<field>
227
			<fieldname>description</fieldname>
228
			<fielddescr>Description</fielddescr>
229
			<description>You may enter a description here. This is optional and is not parsed.</description>
230
			<type>input</type>
231
		</field>
232
	</fields>
233 a31a4582 Scott Ullrich
	<custom_delete_php_command>
234
		openvpn_delete('client', $id);
235
	</custom_delete_php_command>	
236 7c172009 Scott Ullrich
	<custom_php_command_before_form>
237
		openvpn_get_ciphers(&amp;$pkg);
238
	</custom_php_command_before_form>
239 a077d420 Scott Ullrich
	<custom_php_after_head_command>
240
		openvpn_print_javascript('client');
241
	</custom_php_after_head_command>
242
	<custom_php_after_form_command>
243
		openvpn_print_javascript2();
244
	</custom_php_after_form_command>
245 7c172009 Scott Ullrich
	<custom_php_validation_command>
246
		openvpn_validate_input('client', $_POST, &amp;$input_errors);
247
	</custom_php_validation_command>
248
	<custom_php_resync_config_command>
249 a077d420 Scott Ullrich
		openvpn_resync('client', $id);
250 7c172009 Scott Ullrich
	</custom_php_resync_config_command>
251 54816afd Martin Fuchs
</packagegui>