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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
#!/usr/bin/env python3
#
# Copyright VyOS maintainers and contributors <maintainers@vyos.io>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 or later as
# published by the Free Software Foundation.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
import os
import shutil
from sys import exit
from vyos.base import Warning
from vyos.config import Config
from vyos.configverify import verify_vrf
from vyos.configverify import verify_pki_certificate
from vyos.configverify import verify_pki_ca_certificate
from vyos.defaults import systemd_services
from vyos.utils.network import is_addr_assigned
from vyos.utils.process import call
from vyos.utils.dict import dict_search
from vyos.utils.file import write_file
from vyos.pki import wrap_certificate
from vyos.pki import wrap_private_key
from vyos.template import render
from vyos.template import is_ipv4
from vyos.template import is_ipv6
from vyos import ConfigError
from vyos import airbag
airbag.enable()
cert_dir = '/etc/rsyslog.d/certs'
rsyslog_conf = '/run/rsyslog/rsyslog.conf'
logrotate_messages_conf = '/etc/logrotate.d/vyos-rsyslog'
systemd_socket = 'syslog.socket'
systemd_service = systemd_services['syslog']
def _cleanup_tls_certs():
if os.path.exists(cert_dir):
shutil.rmtree(cert_dir, ignore_errors=True)
def _remote_has_tls(remote_options):
return 'tls' in remote_options
def _verify_tls_remote_options(remote, remote_options, syslog):
auth_mode = dict_search('tls.auth_mode', remote_options)
certificate = dict_search('tls.certificate', remote_options)
ca_certificate = dict_search('tls.ca_certificate', remote_options)
if auth_mode != "anon" and not ca_certificate:
raise ConfigError(
f'Option "ca-certificate" is required for remote "{remote}" when TLS is enabled with auth-mode "{auth_mode}"!'
)
if certificate:
verify_pki_certificate(syslog, certificate, no_password_protected=True)
if ca_certificate:
verify_pki_ca_certificate(syslog, ca_certificate)
permitted_peers = dict_search('tls.permitted_peer', remote_options)
if not permitted_peers:
if auth_mode == "fingerprint":
raise ConfigError(
f'Auth mode "fingerprint" for remote "{remote}" requires "permitted-peer" to be configured!'
)
elif auth_mode == "name":
raise ConfigError(
f'Auth mode "name" for remote "{remote}" requires "permitted-peer" to specify allowed subject names!'
)
def _save_tls_certificates_for_remote(syslog, remote_options):
ca_certificate = remote_options['tls'].get('ca_certificate')
ca_cert_file_path = None
if ca_certificate:
ca_cert_file_path = os.path.join(cert_dir, f'{ca_certificate}.pem')
pki_ca = syslog['pki']['ca'][ca_certificate]
ca_cert = wrap_certificate(pki_ca['certificate'])
write_file(ca_cert_file_path, ca_cert)
remote_options['tls']['ca_certificate_path'] = ca_cert_file_path
cert_name = remote_options['tls'].get('certificate')
cert_file_path = cert_key_path = None
if cert_name:
cert_file_path = os.path.join(cert_dir, f'{cert_name}.pem')
cert_key_path = os.path.join(cert_dir, f'{cert_name}.key')
pki_cert = syslog['pki']['certificate'][cert_name]
write_file(cert_file_path, wrap_certificate(pki_cert['certificate']))
write_file(cert_key_path, wrap_private_key(pki_cert['private']['key']))
remote_options['tls']['certificate_path'] = cert_file_path
remote_options['tls']['certificate_key_path'] = cert_key_path
def get_config(config=None):
if config:
conf = config
else:
conf = Config()
base = ['system', 'syslog']
if not conf.exists(base):
return None
syslog = conf.get_config_dict(
base,
key_mangling=('-', '_'),
get_first_key=True,
no_tag_node_value_mangle=True,
with_pki=True,
)
syslog.update({ 'logrotate' : logrotate_messages_conf })
logs_config = conf.get_config_dict(
['system', 'logs'],
key_mangling=('-', '_'),
get_first_key=True,
with_recursive_defaults=True,
)
max_size_mb = dict_search('logrotate.messages.max_size', logs_config)
syslog['logrotate_size_limit'] = int(max_size_mb) * 1024 * 1024
syslog = conf.merge_defaults(syslog, recursive=True)
if syslog.from_defaults(['local']):
del syslog['local']
if 'preserve_fqdn' in syslog:
if conf.exists(['system', 'host-name']):
tmp = conf.return_value(['system', 'host-name'])
syslog['preserve_fqdn']['host_name'] = tmp
if conf.exists(['system', 'domain-name']):
tmp = conf.return_value(['system', 'domain-name'])
syslog['preserve_fqdn']['domain_name'] = tmp
# prune 'remote <remote> tls' if it was not set by user
for remote in syslog.get('remote', {}):
if syslog.from_defaults(['remote', remote, 'tls']):
del syslog['remote'][remote]['tls']
return syslog
def verify(syslog):
if not syslog:
return None
if 'preserve_fqdn' in syslog:
if 'host_name' not in syslog['preserve_fqdn']:
Warning('No "system host-name" defined - cannot set syslog FQDN!')
if 'domain_name' not in syslog['preserve_fqdn']:
Warning('No "system domain-name" defined - cannot set syslog FQDN!')
if 'remote' in syslog:
for remote, remote_options in syslog['remote'].items():
if 'protocol' in remote_options and remote_options['protocol'] == 'udp':
if 'format' in remote_options and 'octet_counted' in remote_options['format']:
Warning(f'Syslog UDP transport for "{remote}" should not use octet-counted format!')
if 'vrf' in remote_options:
verify_vrf(remote_options)
if 'source_address' in remote_options:
vrf = None
if 'vrf' in remote_options:
vrf = remote_options['vrf']
if not is_addr_assigned(remote_options['source_address'], vrf):
raise ConfigError('No interface with given address specified!')
source_address = remote_options['source_address']
if ((is_ipv4(remote) and is_ipv6(source_address)) or
(is_ipv6(remote) and is_ipv4(source_address))):
raise ConfigError(f'Source-address "{source_address}" does not match '\
f'address-family of remote "{remote}"!')
if _remote_has_tls(remote_options):
_verify_tls_remote_options(remote, remote_options, syslog)
if 'protocol' in remote_options and remote_options['protocol'] == 'udp':
raise ConfigError(
f'TLS is enabled for remote "{remote}", but protocol is set to UDP. TLS is only supported with protocol TCP!'
)
def generate(syslog):
_cleanup_tls_certs()
if not syslog:
if os.path.exists(rsyslog_conf):
os.unlink(rsyslog_conf)
return None
if 'remote' in syslog:
for _, remote_options in syslog['remote'].items():
if _remote_has_tls(remote_options):
_save_tls_certificates_for_remote(syslog, remote_options)
render(rsyslog_conf, 'rsyslog/rsyslog.conf.j2', syslog)
return None
def apply(syslog):
if not syslog:
call(f'systemctl stop {systemd_service} {systemd_socket}')
return None
call(f'systemctl reload-or-restart {systemd_service}')
return None
if __name__ == '__main__':
try:
c = get_config()
verify(c)
generate(c)
apply(c)
except ConfigError as e:
print(e)
exit(1)
|
