本文主要内容
由于OPNsense 24.1默认配置备份只支持本地和Goolge Drive两种备份方式，本文主要是给OPNSense添加WebDAV备份功能。

配置流程#

添加WebDAV备份插件#

进入OPNSense，打开安全shell设置，ssh连接进入系统shell。

创建文件夹 mkdir -p /usr/local/opnsense/mvc/app/models/OPNsense/Backup/ 后，添加核心实现逻辑代码。

1
cat << 'EOF' > /usr/local/opnsense/mvc/app/library/OPNsense/Backup/WebDAV.php
2
<?php
3
/*
4
 * Copyright (C) 2018 Deciso B.V.
5
 * Copyright (C) 2018 Fabian Franz
6
 * All rights reserved.
7
 *
8
 * Redistribution and use in source and binary forms, with or without
9
 * modification, are permitted provided that the following conditions are met:
10
 *
11
 * 1. Redistributions of source code must retain the above copyright notice,
12
 *    this list of conditions and the following disclaimer.
13
 *
14
 * 2. Redistributions in binary form must reproduce the above copyright
15
 *    notice, this list of conditions and the following disclaimer in the
16
 *    documentation and/or other materials provided with the distribution.
17
 *
18
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
19
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
20
 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
21
 * AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
22
 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27
 * POSSIBILITY OF SUCH DAMAGE.
28
 */
29

30
namespace OPNsense\Backup;
31

32
use OPNsense\Core\Config;
33

34
/**
35
 * Class WebDAV backup
36
 * @package OPNsense\Backup
37
 */
38
class WebDAV extends Base implements IBackupProvider
39
{
40
    /**
41
     * get required (user interface) fields for backup connector
42
     * @return array configuration fields, types and description
43
     */
44
    public function getConfigurationFields()
45
    {
46
        $fields = array(
47
            array(
48
                "name" => "enabled",
49
                "type" => "checkbox",
50
                "label" => gettext("Enable"),
51
                "value" => null
52
            ),
53
            array(
54
                "name" => "url",
55
                "type" => "text",
56
                "label" => gettext("URL"),
57
                "help" => gettext("The Base URL to WebDAV without trailing slash. For example: https://dav.example.com"),
58
                "value" => null
59
            ),
60
            array(
61
                "name" => "user",
62
                "type" => "text",
63
                "label" => gettext("User Name"),
64
                "help" => gettext("The name you use for logging into your WebDAV account"),
65
                "value" => null
66
            ),
67
            array(
68
                "name" => "password",
69
                "type" => "password",
70
                "label" => gettext("Password"),
71
                "help" => gettext("The password you use for logging into your WebDAV account"),
72
                "value" => null
73
            ),
74
            array(
75
                "name" => "password_encryption",
76
                "type" => "password",
77
                "label" => gettext("Encryption Password (Optional)"),
78
                "help" => gettext("A password to encrypt your configuration"),
79
                "value" => null
80
            ),
81
            array(
82
                "name" => "backupdir",
83
                "type" => "text",
84
                "label" => gettext("Directory Name without leading slash, starting from user's root"),
85
                "value" => 'OPNsense-Backup'
86
            )
87
        );
88
        $webdav = new WebDAVSettings();
89
        foreach ($fields as &$field) {
90
            $field['value'] = (string)$webdav->getNodeByReference($field['name']);
91
        }
92
        return $fields;
93
    }
94

95
    /**
96
     * backup provider name
97
     * @return string user friendly name
98
     */
99
    public function getName()
100
    {
101
        return gettext("WebDAV");
102
    }
103

104
    /**
105
     * validate and set configuration
106
     * @param array $conf configuration array
107
     * @return array of validation errors when not saved
108
     * @throws \OPNsense\Base\ModelException
109
     * @throws \ReflectionException
110
     */
111
    public function setConfiguration($conf)
112
    {
113
        $webdav = new WebDAVSettings();
114
        $this->setModelProperties($webdav, $conf);
115
        $validation_messages = $this->validateModel($webdav);
116
        if (empty($validation_messages)) {
117
            $webdav->serializeToConfig();
118
            Config::getInstance()->save();
119
        }
120
        return $validation_messages;
121
    }
122

123
    /**
124
     * perform backup
125
     * @return array filelist
126
     * @throws \OPNsense\Base\ModelException
127
     * @throws \ReflectionException
128
     */
129
    public function backup()
130
    {
131
        $cnf = Config::getInstance();
132
        $webdav = new WebDAVSettings();
133
        if ($cnf->isValid() && !empty((string)$webdav->enabled)) {
134
            $config = $cnf->object();
135
            $url = (string)$webdav->url;
136
            $username = (string)$webdav->user;
137
            $password = (string)$webdav->password;
138
            $backupdir = (string)$webdav->backupdir;
139
            $crypto_password = (string)$webdav->password_encryption;
140
            $hostname = $config->system->hostname . '.' . $config->system->domain;
141
            $configname = 'config-' . $hostname . '-' .  date('Y-m-d_H_i_s') . '.xml';
142
            // backup source data to local strings (plain/encrypted)
143
            $confdata = file_get_contents('/conf/config.xml');
144
            if (!empty($crypto_password)) {
145
                $confdata = $this->encrypt($confdata, $crypto_password);
146
            }
147
            // Check if destination directory exists, create (full path) if not
148
            try {
149
                $this->create_directory($url, $username, $password, $backupdir);
150
            } catch (\Exception $e) {
151
                return array();
152
            }
153
            try {
154
                $this->upload_file_content(
155
                    $url,
156
                    $username,
157
                    $password,
158
                    $backupdir,
159
                    $configname,
160
                    $confdata
161
                );
162
                // do not list directories
163
                return array_filter(
164
                    $this->listFiles($url, $username, $password, "/$backupdir/", false),
165
                    function ($filename) {
166
                        return (substr($filename, -1) !== '/');
167
                    }
168
                );
169
            } catch (\Exception $e) {
170
                return array();
171
            }
172
        }
173
    }
174

175
    /**
176
     * dir listing
177
     * @param string $url remote location
178
     * @param string $username username
179
     * @param string $password password to use
180
     * @param string $directory location to list
181
     * @param bool $only_dirs only list directories
182
     * @return array
183
     * @throws \Exception
184
     */
185
    public function listFiles($url, $username, $password, $directory = '/', $only_dirs = true)
186
    {
187
        $result = $this->curl_request(
188
            "$url$directory",
189
            $username,
190
            $password,
191
            'PROPFIND',
192
            "Error while fetching filelist from WebDAV '{$directory}' path"
193
        );
194
        //remove line breaks from xml string
195
        $xml = preg_replace("/\r?\n/", '', $result['response']);
196

197
        // workaround - simplexml seems to be broken when using namespaces - remove them.
198
        //$xml = str_replace(['<D:', '</D:', '<d:', '</d:', '<lp1:', '</lp1:'], ['<', '</', '<', '</', '<', '</'], $xml);
199
        // better workaround: remove any namespace
200
        $xml = preg_replace('/\s+xmlns:[^=]+="[^"]*"/', '', $xml);
201
        $xml = preg_replace('/\b(\w+)\:/i', '', $xml);
202

203
        $xml = simplexml_load_string($xml);
204
        $ret = array();
205

206
        //parse URL for a check if path exists
207
        $parsedUrl = parse_url($url);
208

209
        foreach ($xml->children() as $response) {
210
            // d:response
211
            if ($response->getName() == 'response') {
212

213
                $fileurl = (string)$response->href;
214

215
                //check if URL has a path
216
                if (isset($parsedUrl['path'])) {
217
                    //URL DOES have a path - extracting path from fileurl
218
                    $dirname = explode($parsedUrl['path'], $fileurl, 2)[1];
219
                }
220
                else {
221
                    //URL does NOT have a path
222
                    $dirname = $fileurl;
223
                }
224

225
                if (
226
                    $response->propstat->prop->resourcetype->children()->count() > 0 &&
227
                    $response->propstat->prop->resourcetype->children()[0]->getName() == 'collection' &&
228
                    $only_dirs
229
                ) {
230

231
                    $ret[] = $dirname;
232

233
                } elseif (!$only_dirs) {
234

235
                    $ret[] = $dirname;
236

237
                }
238
            }
239
        }
240
        return $ret;
241
    }
242

243
    /**
244
     * upload file
245
     * @param string $url remote location
246
     * @param string $username remote user
247
     * @param string $password password to use
248
     * @param string $backupdir remote directory
249
     * @param string $filename filename to use
250
     * @param string $local_file_content contents to save
251
     * @throws \Exception when upload fails
252
     */
253
    public function upload_file_content($url, $username, $password, $backupdir, $filename, $local_file_content)
254
    {
255
        $this->curl_request(
256
            $url . "/$backupdir/$filename",
257
            $username,
258
            $password,
259
            'PUT',
260
            'cannot execute PUT',
261
            $local_file_content
262
        );
263
    }
264

265
    /**
266
     * create new remote directory if doesn't exist
267
     * @param string $url remote location
268
     * @param string $username remote user
269
     * @param string $password password to use
270
     * @param string $backupdir remote directory
271
     * @throws \Exception when create dir fails
272
     */
273
    public function create_directory($url, $username, $password, $backupdir)
274
    {
275
        $parent_path = dirname($backupdir);
276

277
        try {
278
            $directories = $this->listFiles($url, $username, $password, "/{$parent_path}");
279
        } catch (\Exception $e) {
280
            if ($backupdir == ".") {
281
                // We cannot create root, if we reached here there's some other problem
282
                syslog(LOG_ERR, "Check WebDAV configuration parameters");
283
                return false;
284
            }
285
            // If error assume dir doesn't exist. Create parent folder
286
            if ($this->create_directory($url, $username, $password, $parent_path) === false) {
287
                throw new \Exception();
288
            }
289
        }
290

291
        // if path exists ok
292
        if (in_array("/{$backupdir}/", $directories)) {
293
            return;
294
        }
295

296
        // create backupdir, because path does not exist
297
        $this->curl_request(
298
            $url . "/{$backupdir}",
299
            $username,
300
            $password,
301
            'MKCOL',
302
            'cannot execute MKCOL'
303
        );
304
    }
305

306
    /**
307
     * @param string $url remote location
308
     * @param string $username remote user
309
     * @param string $password password to use
310
     * @param string $method http method, PUT, GET, ...
311
     * @param string $error_message message to log on failure
312
     * @param null|string $postdata http body
313
     * @param array $headers HTTP headers
314
     * @return array response status
315
     * @throws \Exception when request fails
316
     */
317
    public function curl_request(
318
        $url,
319
        $username,
320
        $password,
321
        $method,
322
        $error_message,
323
        $postdata = null,
324
        $headers = array('User-Agent: OPNsense Firewall')
325
    ) {
326
        //workaround for Hetzner Storagebox
327
        if ($method == "PROPFIND") {
328
        array_push($headers, 'Depth: 1');
329
        }
330
    $curl = curl_init();
331
        curl_setopt_array($curl, array(
332
            CURLOPT_URL => $url,
333
            CURLOPT_CUSTOMREQUEST => $method, // Create a file in WebDAV is PUT
334
            CURLOPT_RETURNTRANSFER => true, // Do not output the data to STDOUT
335
            CURLOPT_VERBOSE => 0,           // same here
336
            CURLOPT_MAXREDIRS => 0,         // no redirects
337
            CURLOPT_TIMEOUT => 60,          // maximum time: 1 min
338
            CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
339
            CURLOPT_USERPWD => $username . ":" . $password,
340
            CURLOPT_HTTPHEADER => $headers
341
        ));
342
        if ($postdata != null) {
343
            curl_setopt($curl, CURLOPT_POSTFIELDS, $postdata);
344
        }
345
        $response = curl_exec($curl);
346
        $err = curl_error($curl);
347
        $info = curl_getinfo($curl);
348
        if (!($info['http_code'] == 200 || $info['http_code'] == 207 || $info['http_code'] == 201) || $err) {
349
            syslog(LOG_ERR, $error_message);
350
            syslog(LOG_ERR, json_encode($info));
351
            throw new \Exception();
352
        }
353
        curl_close($curl);
354
        return array('response' => $response, 'info' => $info);
355
    }
356

357
    /**
358
     * Is this provider enabled
359
     * @return boolean enabled status
360
     * @throws \OPNsense\Base\ModelException
361
     * @throws \ReflectionException
362
     */
363
    public function isEnabled()
364
    {
365
        $webdav = new WebDAVSettings();
366
        return (string)$webdav->enabled === "1";
367
    }
368
}
369
'EOF'

1
cat << 'EOF' > /usr/local/opnsense/mvc/app/models/OPNsense/Backup/WebDAVSettings.php
2
<?php
3
/**
4
 *    Copyright (C) 2018 Fabian Franz
5
 *
6
 *    All rights reserved.
7
 *
8
 *    Redistribution and use in source and binary forms, with or without
9
 *    modification, are permitted provided that the following conditions are met:
10
 *
11
 *    1. Redistributions of source code must retain the above copyright notice,
12
 *       this list of conditions and the following disclaimer.
13
 *
14
 *    2. Redistributions in binary form must reproduce the above copyright
15
 *       notice, this list of conditions and the following disclaimer in the
16
 *       documentation and/or other materials provided with the distribution.
17
 *
18
 *    THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
19
 *    INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
20
 *    AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
21
 *    AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
22
 *    OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23
 *    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24
 *    INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
25
 *    CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26
 *    ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27
 *    POSSIBILITY OF SUCH DAMAGE.
28
 *
29
 */
30

31
namespace OPNsense\Backup;
32

33
use OPNsense\Base\BaseModel;
34

35
/**
36
 * Class WebDAV
37
 * @package Backup
38
 */
39
class WebDAVSettings extends BaseModel
40
{
41
}
42
'EOF'

添加WebDAVSettings.xml，这一步让在OPNSense备份中显示WebDAV配置界面。

1
cat << 'EOF' > /usr/local/opnsense/mvc/app/models/OPNsense/Backup/WebDAVSettings.xml
2
<model>
3
    <mount>//system/backup/webdav</mount>
4
    <version>1.0.0</version>
5
    <description>OPNsense WebDAV Backup Settings</description>
6
    <items>
7
        <enabled type="BooleanField">
8
            <default>0</default>
9
            <Required>Y</Required>
10
        </enabled>
11
        <url type="TextField">
12
            <Required>N</Required>
13
            <mask>/^https?:\/\/.*[^\/]$/</mask>
14
            <ValidationMessage>The URL must be valid without a trailing slash. For example: https://dav.example.com</ValidationMessage>
15
            <Constraints>
16
                <check001>
17
                    <ValidationMessage>A URL for the WebDAV server must be set.</ValidationMessage>
18
                    <type>DependConstraint</type>
19
                    <addFields>
20
                        <field1>enabled</field1>
21
                    </addFields>
22
                </check001>
23
            </Constraints>
24
        </url>
25
        <user type="TextField">
26
            <Constraints>
27
                <check001>
28
                    <ValidationMessage>A user for the WebDAV server must be set.</ValidationMessage>
29
                    <type>DependConstraint</type>
30
                    <addFields>
31
                        <field1>enabled</field1>
32
                    </addFields>
33
                </check001>
34
            </Constraints>
35
        </user>
36
        <password type="TextField">
37
            <Constraints>
38
                <check001>
39
                    <ValidationMessage>A password for the WebDAV server must be set.</ValidationMessage>
40
                    <type>DependConstraint</type>
41
                    <addFields>
42
                        <field1>enabled</field1>
43
                    </addFields>
44
                </check001>
45
            </Constraints>
46
        </password>
47
        <password_encryption type="TextField">
48
            <Required>N</Required>
49
        </password_encryption>
50
        <backupdir type="TextField">
51
            <Required>Y</Required>
52
            <mask>/^([\w%+\-]+\/)*[\w+%\-]+$/</mask>
53
            <default>OPNsense-Backup</default>
54
            <ValidationMessage>The Backup Directory can only consist of alphanumeric characters, dash, underscores and slash. No leading or trailing slash.</ValidationMessage>
55
        </backupdir>
56
    </items>
57
</model>
58
'EOF'

进入OPNSense，系统 -> 配置 -> 备份 -> 滑到最后。按需配置即可。

OPNSense添加WebDAV备份插件

配置流程#

添加WebDAV备份插件#

评论区

目录