Page MenuHomeVyOS Platform
Files F4979152

service_webproxy.py
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

service_webproxy.py
View Options

#!/usr/bin/env python3
#
# Copyright (C) 2020 VyOS maintainers and contributors
#
# 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
from sys import exit
from vyos.config import Config
from vyos.configdict import dict_merge
from vyos.template import render
from vyos.util import call
from vyos.util import dict_search
from vyos.validate import is_addr_assigned
from vyos.xml import defaults
from vyos import ConfigError
from vyos import airbag
airbag.enable()
config_file = '/etc/squid/squid.conf'
def get_config(config=None):
if config:
conf = config
else:
conf = Config()
base = ['service', 'webproxy']
if not conf.exists(base):
return None
proxy = conf.get_config_dict(base, key_mangling=('-', '_'), get_first_key=True)
# We have gathered the dict representation of the CLI, but there are default
# options which we need to update into the dictionary retrived.
default_values = defaults(base)
# if no authentication method is supplid, no need to add defaults
if not dict_search('authentication.method', proxy):
default_values.pop('authentication')
proxy = dict_merge(default_values, proxy)
import pprint
pprint.pprint(proxy)
return proxy
def verify(proxy):
if not proxy:
return None
if 'listen_address' not in proxy:
raise ConfigError('listen-address needs to be configured!')
ldap_auth = dict_search('authentication.method', proxy) == 'ldap'
for address, config in proxy['listen_address'].items():
if not is_addr_assigned(address):
raise ConfigError(
f'listen-address "{address}" not assigned on any interface!')
if ldap_auth and 'disable_transparent' not in config:
raise ConfigError('Authentication can not be configured when ' \
'proxy is in transparent mode')
if 'outgoing_address' in proxy:
address = proxy['outgoing_address']
if not is_addr_assigned(address):
raise ConfigError(
f'outgoing-address "{address}" not assigned on any interface!')
if 'authentication' in proxy:
if 'method' not in proxy['authentication']:
raise ConfigError('proxy authentication method required!')
if ldap_auth:
ldap_config = proxy['authentication']['ldap']
if 'server' not in ldap_config:
raise ConfigError(
'LDAP authentication enabled, but no server set')
if 'password' in ldap_config and 'bind_dn' not in ldap_config:
raise ConfigError(
'LDAP password can not be set when base-dn is undefined!')
if 'bind_dn' in ldap_config and 'password' not in ldap_config:
raise ConfigError(
'LDAP bind DN can not be set without password!')
if 'base_dn' not in ldap_config:
raise ConfigError('LDAP base-dn must be set!')
def generate(proxy):
if not proxy:
return None
render(config_file, 'squid/squid.conf.tmpl', proxy)
return None
def apply(proxy):
if not proxy:
# proxy is removed in the commit
call('systemctl stop squid.service')
if os.path.exists(config_file):
os.unlink(config_file)
return None
call('systemctl restart squid.service')
return None
if __name__ == '__main__':
try:
c = get_config()
verify(c)
generate(c)
apply(c)
except ConfigError as e:
print(e)
exit(1)

File Metadata

Mime Type
text/x-script.python
Expires
Thu, Oct 31, 8:00 PM (1 d, 18 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
895229
Default Alt Text
service_webproxy.py (4 KB)

Event Timeline