1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
<?php
/*
* xmlrpc_client.php
*
* part of pfSense (https://www.pfsense.org)
* Copyright (c) 2016 Rubicon Communications, LLC (Netgate)
* All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
require_once("XML/RPC2/Client.php");
class pfsense_xmlrpc_client {
private $username, $password, $url, $logurl, $filenotice, $error;
public function __construct() {
global $config;
$hasync = $config['hasync'];
if (empty($hasync['username'])) {
$username = "admin";
} else {
$username = $hasync['username'];
}
/* if port is empty lets rely on the protocol selection */
$port = $config['system']['webgui']['port'];
if (empty($port)) {
if ($config['system']['webgui']['protocol'] == "http") {
$port = "80";
} else {
$port = "443";
}
}
$this->setConnectionData($hasync['synchronizetoip'], $port, $username, $hasync['password']);
}
public function setConnectionData($syncip, $port, $username, $password, $scheme = "") {
global $config;
$this->username = $username;
$this->password = $password;
$this->filenotice = "sync_settings";
if (empty($scheme)) {
$scheme = "http";
if ($port == "443") {
$scheme = "https";
} else if (is_array($config['system']) &&
is_array($config['system']['webgui']) &&
!empty($config['system']['webgui']['protocol']) &&
$config['system']['webgui']['protocol'] == "https") {
$scheme = "https";
}
}
if (is_ipaddrv6($syncip)) {
$syncip = "[{$syncip}]";
}
$user = urlencode($this->username);
$pass = urlencode($this->password);
$this->logurl = "{$scheme}://{$syncip}:{$port}/xmlrpc.php";
$this->url = "{$scheme}://{$user}:{$pass}@{$syncip}:{$port}/xmlrpc.php";
}
public function set_noticefile($noticefile) {
$this->filenotice = $noticefile;
}
private function xmlrpc_internal($method, $parameter, $timeout = 240) {
$this->error = null;
$options = array(
'prefix' => 'pfsense.',
'sslverify' => false,
'connectionTimeout' => $timeout
);
$numberofruns = 0;
while ($numberofruns < 2) {
$numberofruns++;
log_error(sprintf(gettext("Beginning XMLRPC sync data to %s."), $this->logurl));
$cli = XML_RPC2_Client::create($this->url, $options);
if (!is_object($cli)) {
$this->error = sprintf(gettext("A communications error occurred while attempting XMLRPC sync with %s (pfsense.%s)."), $this->log, $method);
log_error($this->error);
file_notice($this->filenotice, $this->error, "Settings Sync", "");
continue;
}
try {//restore_config_section
$REQUEST_URI = $_SERVER['REQUEST_URI'];
unset($_SERVER['REQUEST_URI']); // force use of 'toText()' when setting XML_RPC2_CurlException message
$resp = $cli->$method($parameter);
} catch (XML_RPC2_FaultException $e) {
// The XMLRPC server returns a XMLRPC error
$this->error = "Exception calling XMLRPC method {$method} #" . $e->getFaultCode() . ' : ' . $e->getFaultString();
log_error($this->error);
file_notice($this->filenotice, $this->error, "Communications error occurred", "");
continue;
} catch (XML_RPC2_CurlException $e) {
$previouserror = $e->getPrevious();// HTTP_Request2_ConnectionException
if ($previouserror == null) {
// CurlException doesnt get filled with PreviousError,
// however we dont want to show the stacktrace included in the 'message' to non sysadmin users
preg_match("/HTTP_Request2_ConnectionException: (.*) in \/.*/", $e->getMessage(), $errormsg);
$this->error = "A communications error occurred while attempting to call XMLRPC method {$method}: " . $errormsg[1];
} else {
$this->error = "CurlException calling XMLRPC method {$method} #" . $previouserror->getMessage();
}
log_error($this->error);
file_notice($this->filenotice, $this->error, "Communications error occurred", "");
continue;
} catch (Exception $e) {
// Other errors (HTTP or networking problems...)
$this->error = "Exception calling XMLRPC method {$method} # " . $e->getMessage();
log_error($this->error);
file_notice($this->filenotice, $this->error, gettext("Error code received"), "");
continue;
} finally {
if (isset($REQUEST_URI)) {
// restore the unset variable to its previous state.
$_SERVER['REQUEST_URI'] = $REQUEST_URI;
}
}
if (!is_array($resp) && trim($resp) == "Authentication failed") {
$this->error = "An authentication failure occurred while trying to access {$this->logurl} ({$method}).";
log_error($this->error);
file_notice($this->filenotice, $this->error, "Settings Sync", "");
continue;
}
log_error(sprintf(gettext("XMLRPC reload data success with %s (pfsense.{$method})."), $this->logurl));
return $resp;
}
return null;
}
public function xmlrpc_exec_php($execcmd, $timeout = 240) {
$resp = $this->xmlrpc_internal("exec_php", $execcmd, $timeout);
return $resp;
}
public function xmlrpc_method($method, $parameter = "", $timeout = 240) {
$resp = $this->xmlrpc_internal($method, $parameter, $timeout);
return $resp;
}
public function get_error() {
return $this->error;
}
public function getUrl() {
return $this->logurl;
}
}
|
