Project

General

Profile

Download (13.1 KB) Statistics
| Branch: | Tag: | Revision:
1
<?php
2
/*
3
	$Id$
4

    
5
        xmlrpc.php
6
        Copyright (C) 2009, 2010 Scott Ullrich
7
        Copyright (C) 2005 Colin Smith
8
        All rights reserved.
9

    
10
        Redistribution and use in source and binary forms, with or without
11
        modification, are permitted provided that the following conditions are met:
12

    
13
        1. Redistributions of source code must retain the above copyright notice,
14
           this list of conditions and the following disclaimer.
15

    
16
        2. Redistributions in binary form must reproduce the above copyright
17
           notice, this list of conditions and the following disclaimer in the
18
           documentation and/or other materials provided with the distribution.
19

    
20
        THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
21
        INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
22
        AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23
        AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
24
        OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25
        SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26
        INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27
        CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28
        ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29
        POSSIBILITY OF SUCH DAMAGE.
30
*/
31

    
32
##|+PRIV
33
##|*IDENT=page-xmlrpclibrary
34
##|*NAME=XMLRPC Library page
35
##|*DESCR=Allow access to the 'XMLRPC Library' page.
36
##|*MATCH=xmlrpc.php*
37
##|-PRIV
38

    
39
require("config.inc");
40
require("functions.inc");
41
require("filter.inc");
42
require("shaper.inc");
43
require("xmlrpc_server.inc");
44
require("xmlrpc.inc");
45
require("array_intersect_key.inc");
46

    
47
/* grab sync to ip if enabled */
48
if($config['installedpackages']['carpsettings']) {
49
	if ($config['installedpackages']['carpsettings']['config']) {
50
		foreach ($config['installedpackages']['carpsettings']['config'] as $carp) {
51
			$synchronizetoip = $carp['synchronizetoip'];
52
		}
53
	}
54
}
55

    
56
if($synchronizetoip) {
57
	if($synchronizetoip == $_SERVER['REMOTE_ADDR']) {
58
		log_error(gettext("Disallowing CARP sync loop."));
59
		die;	
60
	}
61
}
62

    
63
$xmlrpc_g = array(
64
			"return" => array(
65
						"true" => new XML_RPC_Response(new XML_RPC_Value(true, $XML_RPC_Boolean)),
66
						"false" => new XML_RPC_Response(new XML_RPC_Value(false, $XML_RPC_Boolean)),
67
						"authfail" => new XML_RPC_Response(new XML_RPC_Value(gettext("Authentication failed"), $XML_RPC_String))
68
				)
69
		);
70

    
71
/*
72
 *   pfSense XMLRPC errors
73
 *   $XML_RPC_erruser + 1 = Auth failure
74
 */
75
$XML_RPC_erruser = 200;
76

    
77
/* EXPOSED FUNCTIONS */
78

    
79
$exec_php_doc = gettext("XMLRPC wrapper for eval(). This method must be called with two parameters: a string containing the local system\'s password followed by the PHP code to evaluate.");
80
$exec_php_sig = array(
81
					array(
82
						$XML_RPC_Boolean, // First signature element is return value.
83
						$XML_RPC_String, // password
84
						$XML_RPC_String, // shell code to exec
85
					)
86
				);
87

    
88
function exec_php_xmlrpc($raw_params) {
89
	global $config, $xmlrpc_g;
90
	$params = xmlrpc_params_to_php($raw_params);
91
	if(!xmlrpc_auth($params)) return $xmlrpc_g['return']['authfail'];
92
	$exec_php = $params[0];
93
	eval($exec_php);
94
	if($toreturn) {
95
		$response = XML_RPC_encode($toreturn);
96
		return new XML_RPC_Response($response);
97
	} else
98
		return $xmlrpc_g['return']['true'];
99
}
100

    
101
/*****************************/
102

    
103
$exec_shell_doc = gettext("XMLRPC wrapper for mwexec(). This method must be called with two parameters: a string containing the local system\'s password followed by an shell command to execute.");
104
$exec_shell_sig = array(
105
					array(
106
						$XML_RPC_Boolean, // First signature element is return value.
107
						$XML_RPC_String, // password
108
						$XML_RPC_String, // shell code to exec
109
					)
110
				);
111

    
112

    
113
function exec_shell_xmlrpc($raw_params) {
114
	global $config, $xmlrpc_g;
115
	$params = xmlrpc_params_to_php($raw_params);
116
	if(!xmlrpc_auth($params)) return $xmlrpc_g['return']['authfail'];
117
	$shell_cmd = $params[0];
118
	mwexec($shell_cmd);
119
	return $xmlrpc_g['return']['true'];
120
}
121

    
122

    
123

    
124
/*****************************/
125

    
126

    
127
$backup_config_section_doc = gettext("XMLRPC wrapper for backup_config_section. This method must be called with two parameters: a string containing the local system\'s password followed by an array containing the keys to be backed up.");
128
$backup_config_section_sig = array(
129
								array(
130
									$XML_RPC_Struct, // First signature element is return value.
131
									$XML_RPC_String,
132
									$XML_RPC_Array
133
								)
134
							);
135

    
136
function backup_config_section_xmlrpc($raw_params) {
137
	global $config, $xmlrpc_g;
138
	$params = xmlrpc_params_to_php($raw_params);
139
	if(!xmlrpc_auth($params)) return $xmlrpc_g['return']['authfail'];
140
	$val = array_intersect_key($config, array_flip($params[0]));
141
	return new XML_RPC_Response(XML_RPC_encode($val));
142
}
143

    
144
/*****************************/
145

    
146
$restore_config_section_doc = gettext("XMLRPC wrapper for restore_config_section. This method must be called with two parameters: a string containing the local system\'s password and an array to merge into the system\'s config. This function returns true upon completion.");
147
$restore_config_section_sig = array(
148
								array(
149
									$XML_RPC_Boolean,
150
									$XML_RPC_String,
151
									$XML_RPC_Struct
152
								)
153
							);
154

    
155
function restore_config_section_xmlrpc($raw_params) {
156
	global $config, $xmlrpc_g;
157
	$params = xmlrpc_params_to_php($raw_params);
158
	if(!xmlrpc_auth($params))
159
		return $xmlrpc_g['return']['authfail'];
160
	$vipbackup = array();
161
	if (isset($params[0]['virtualip'])) {
162
		if(is_array($config['virtualip']['vip'])) {
163
			foreach ($config['virtualip']['vip'] as $vip)
164
				interface_vip_bring_down($vip);
165
		}
166
        	$vipbackup = $config['virtualip']['vip'];
167
	}
168
        // For vip section, first keep items sent from the master
169
	$config = array_merge($config, $params[0]);
170
        // Then add ipalias and proxyarp types already defined on the backup
171
        foreach ($vipbackup as $vip) {
172
                if (($vip['mode'] == 'ipalias') || ($vip['mode'] == 'proxyarp'))
173
                        $config['virtualip']['vip'][]=$vip ;
174
	}
175
	$mergedkeys = implode(",", array_keys($params[0]));
176
	write_config(sprintf(gettext("Merged in config (%s sections) from XMLRPC client."),$mergedkeys));
177
	interfaces_vips_configure();
178
	return $xmlrpc_g['return']['true'];
179
}
180

    
181

    
182
/*****************************/
183

    
184

    
185
$merge_config_section_doc = gettext("XMLRPC wrapper for merging package sections. This method must be called with two parameters: a string containing the local system\'s password and an array to merge into the system\'s config. This function returns true upon completion.");
186
$merge_config_section_sig = array(
187
								array(
188
									$XML_RPC_Boolean,
189
									$XML_RPC_String,
190
									$XML_RPC_Struct
191
								)
192
							);
193

    
194
function merge_installedpackages_section_xmlrpc($raw_params) {
195
	global $config, $xmlrpc_g;
196
	$params = xmlrpc_params_to_php($raw_params);
197
	if(!xmlrpc_auth($params)) return $xmlrpc_g['return']['authfail'];
198
	$config['installedpackages'] = array_merge($config['installedpackages'], $params[0]);
199
	$mergedkeys = implode(",", array_keys($params[0]));
200
	write_config(sprintf(gettext("Merged in config (%s sections) from XMLRPC client."),$mergedkeys));
201
	return $xmlrpc_g['return']['true'];
202
}
203

    
204

    
205
/*****************************/
206

    
207

    
208
$merge_config_section_doc = gettext("XMLRPC wrapper for merge_config_section. This method must be called with two parameters: a string containing the local system\'s password and an array to merge into the system\'s config. This function returns true upon completion.");
209
$merge_config_section_sig = array(
210
								array(
211
									$XML_RPC_Boolean,
212
									$XML_RPC_String,
213
									$XML_RPC_Struct
214
								)
215
							);
216

    
217
function merge_config_section_xmlrpc($raw_params) {
218
	global $config, $xmlrpc_g;
219
	$params = xmlrpc_params_to_php($raw_params);
220
	if(!xmlrpc_auth($params))
221
		return $xmlrpc_g['return']['authfail'];
222
	if (isset($params[0]['virtualip'])) {
223
                if(is_array($config['virtualip']['vip'])) {
224
                        foreach ($config['virtualip']['vip'] as $vip)
225
                                interface_vip_bring_down($vip);
226
                }
227
        }
228
	$config = array_merge_recursive_unique($config, $params[0]);
229
	$mergedkeys = implode(",", array_keys($params[0]));
230
	write_config("Merged in config ({$mergedkeys} sections) from XMLRPC client.");
231
	interfaces_vips_configure();
232
	return $xmlrpc_g['return']['true'];
233
}
234

    
235
/*****************************/
236

    
237
$filter_configure_doc = gettext("Basic XMLRPC wrapper for filter_configure. This method must be called with one paramater: a string containing the local system\'s password. This function returns true upon completion.");
238
$filter_configure_sig = array(
239
							array(
240
								$XML_RPC_Boolean,
241
								$XML_RPC_String
242
							)
243
						);
244

    
245
function filter_configure_xmlrpc($raw_params) {
246
	global $xmlrpc_g;
247
	$params = xmlrpc_params_to_php($raw_params);
248
	if(!xmlrpc_auth($params)) return $xmlrpc_g['return']['authfail'];
249
	filter_configure();
250
	system_routing_configure();
251
	setup_gateways_monitor();
252
	relayd_configure();
253
	require_once("openvpn.inc");
254
	openvpn_resync_all();
255
	services_dhcpd_configure();
256
	services_dnsmasq_configure();
257
	local_sync_accounts();
258
	return $xmlrpc_g['return']['true'];
259
}
260

    
261
/*****************************/
262

    
263
$carp_configure_doc = gettext("Basic XMLRPC wrapper for configuring CARP interfaces.");
264
$carp_configure_sig = array(
265
							array(
266
								$XML_RPC_Boolean,
267
								$XML_RPC_String
268
							)
269
						);
270

    
271
function interfaces_carp_configure_xmlrpc($raw_params) {
272
	global $xmlrpc_g;
273
	$params = xmlrpc_params_to_php($raw_params);
274
	if(!xmlrpc_auth($params)) return $xmlrpc_g['return']['authfail'];
275
	interfaces_vips_configure();
276
	return $xmlrpc_g['return']['true'];
277
}
278

    
279
/*****************************/
280

    
281
$check_firmware_version_doc = gettext("Basic XMLRPC wrapper for check_firmware_version. This function will return the output of check_firmware_version upon completion.");
282
$check_firmware_version_sig = array(
283
								array(
284
									$XML_RPC_String,
285
									$XML_RPC_String
286
								)
287
							);
288

    
289
function check_firmware_version_xmlrpc($raw_params) {
290
	global $xmlrpc_g, $XML_RPC_String;
291
	$params = xmlrpc_params_to_php($raw_params);
292
	if(!xmlrpc_auth($params)) return $xmlrpc_g['return']['authfail'];
293
	return new XML_RPC_Response(new XML_RPC_Value(check_firmware_version(false), $XML_RPC_String));
294
}
295

    
296
/*****************************/
297

    
298
$reboot_doc = gettext("Basic XMLRPC wrapper for rc.reboot.");
299
$reboot_sig = array(array($XML_RPC_Boolean, $XML_RPC_String));
300

    
301
function reboot_xmlrpc($raw_params) {
302
	global $xmlrpc_g;
303
	$params = xmlrpc_params_to_php($raw_params);
304
	if(!xmlrpc_auth($params)) return $xmlrpc_g['return']['authfail'];
305
	mwexec_bg("/etc/rc.reboot");
306
	return $xmlrpc_g['return']['true'];
307
}
308

    
309
/*****************************/
310

    
311
$get_notices_sig = array(
312
					array(
313
						$XML_RPC_Array,
314
						$XML_RPC_String
315
					),
316
					array(
317
						$XML_RPC_Array
318
					)
319
				);
320

    
321
function get_notices_xmlrpc($raw_params) {
322
	global $g, $xmlrpc_g;
323
	$params = xmlrpc_params_to_php($raw_params);
324
	if(!xmlrpc_auth($params)) return $xmlrpc_g['return']['authfail'];
325
	require("notices.inc");
326
	if(!$params) {
327
		$toreturn = get_notices();
328
	} else {
329
		$toreturn = get_notices($params);
330
	}
331
	$response = new XML_RPC_Response(XML_RPC_encode($toreturn));
332
	return $response;
333
}
334

    
335
/*****************************/
336

    
337
$server = new XML_RPC_Server(
338
        array(
339
            'pfsense.exec_shell' 		=> array('function' => 'exec_shell_xmlrpc',
340
							'signature' => $exec_shell_sig,
341
							'docstring' => $exec_shell_doc),
342
            		 'pfsense.exec_php'	=> array('function' => 'exec_php_xmlrpc',
343
							'signature' => $exec_php_sig,
344
							'docstring' => $exec_php_doc),	
345
			 'pfsense.filter_configure' => 	array('function' => 'filter_configure_xmlrpc',
346
							'signature' => $filter_configure_sig,
347
							'docstring' => $filter_configure_doc),
348
            'pfsense.interfaces_carp_configure' => array('function' => 'interfaces_carp_configure_xmlrpc',
349
							'docstring' => $carp_configure_sig),
350
            'pfsense.backup_config_section' => 	array('function' => 'backup_config_section_xmlrpc',
351
							'signature' => $backup_config_section_sig,
352
							'docstring' => $backup_config_section_doc),
353
			'pfsense.restore_config_section' => array('function' => 'restore_config_section_xmlrpc',
354
							'signature' => $restore_config_section_sig,
355
							'docstring' => $restore_config_section_doc),
356
			'pfsense.merge_config_section' => array('function' => 'merge_config_section_xmlrpc',
357
							'signature' => $merge_config_section_sig,
358
							'docstring' => $merge_config_section_doc),
359
			'pfsense.merge_installedpackages_section_xmlrpc' => array('function' => 'merge_installedpackages_section_xmlrpc',
360
							'signature' => $merge_config_section_sig,
361
							'docstring' => $merge_config_section_doc),							
362
			'pfsense.check_firmware_version' =>	array('function' => 'check_firmware_version_xmlrpc',
363
							'signature' => $check_firmware_version_sig,
364
							'docstring' => $check_firmware_version_doc),
365
			'pfsense.reboot' =>			array('function' => 'reboot_xmlrpc',
366
							'signature' => $reboot_sig,
367
							'docstring' => $reboot_doc),
368
			'pfsense.get_notices' =>		array('function' => 'get_notices_xmlrpc',
369
							'signature' => $get_notices_sig)
370
        )
371
);
372

    
373
?>
(220-220/220)