developer.intra2net.com Git - pyi2ncommon/blob - src/cnfvar/templates.py

   1 # The software in this package is distributed under the GNU General
   2 # Public License version 2 (with a special exception described below).
   3 #
   4 # A copy of GNU General Public License (GPL) is included in this distribution,
   5 # in the file COPYING.GPL.
   6 #
   7 # As a special exception, if other files instantiate templates or use macros
   8 # or inline functions from this file, or you compile this file and link it
   9 # with other works to produce a work based on this file, this file
  10 # does not by itself cause the resulting work to be covered
  11 # by the GNU General Public License.
  12 #
  13 # However the source code for this file must still be made available
  14 # in accordance with section (3) of the GNU General Public License.
  15 #
  16 # This exception does not invalidate any other reasons why a work based
  17 # on this file might be covered by the GNU General Public License.
  18 #
  19 # Copyright (c) 2016-2018 Intra2net AG <info@intra2net.com>
  20
  21 """
  22 Module for one-step dynamic cnfvar generation from default value templates.
  23
  24 .. codeauthor:: Intra2net
  25
  26 These templates contain the bare defaults the UI adds upon
  27 creation of each major and frequently used cnfvar.
  28 """
  29
  30 import time
  31 import logging
  32
  33 # custom imports
  34 from .model import Cnf, CnfList
  35
  36
  37 log = logging.getLogger('pyi2ncommon.cnfvar.templates')
  38
  39
  40 ###############################################################################
  41 # MAJOR CNF DEFAULTS
  42 ###############################################################################
  43
  44
  45 #: UI defaults for a user instance
  46 user_defaults = {
  47     "USER_DISABLED": "0",
  48     "USER_FULLNAME": "",
  49     "USER_GROUPWARE_FOLDER_CALENDAR": "INBOX/Kalender",
  50     "USER_GROUPWARE_FOLDER_CONTACTS": "INBOX/Kontakte",
  51     "USER_GROUPWARE_FOLDER_DRAFTS": "INBOX/Entwürfe",
  52     "USER_GROUPWARE_FOLDER_NOTES": "INBOX/Notizen",
  53     "USER_GROUPWARE_FOLDER_OUTBOX": "INBOX/Gesendete Elemente",
  54     "USER_GROUPWARE_FOLDER_TASKS": "INBOX/Aufgaben",
  55     "USER_GROUPWARE_FOLDER_TRASH": "INBOX/Gelöschte Elemente",
  56     # always a member of the 'Alle' group
  57     "USER_GROUP_MEMBER_REF": "2",
  58     "USER_LOCALE": "",
  59     "USER_PASSWORD": "",
  60     "USER_TRASH_DELETEDAYS": "30",
  61     "USER_WEBMAIL_MESSAGES_PER_PAGE": "25",
  62     "USER_WEBMAIL_SIGNATURE": "",
  63 }
  64 #: UI defaults for a group instance
  65 group_defaults = {
  66     "GROUP_COMMENT": "",
  67     "GROUP_ACCESS_GO_ONLINE_ALLOWED": "1",
  68     "GROUP_EMAILFILTER_BAN_FILTERLIST_REF": "-1",
  69     "GROUP_EMAIL_RELAY_RIGHTS": "RELAY_FROM_INTRANET",
  70     "GROUP_PROXY_PROFILE_REF": "1",
  71 }
  72 #: UI defaults for an intraclient instance
  73 intraclient_defaults = {
  74     "INTRACLIENT_COMMENT": "",
  75     "INTRACLIENT_DNS_RELAYING_ALLOWED": "1",
  76     "INTRACLIENT_EMAIL_RELAYING_ALLOWED": "1",
  77     "INTRACLIENT_FIREWALL_RULESET_REF": "5",
  78     "INTRACLIENT_IP": "",
  79     "INTRACLIENT_MAC": "",
  80     "INTRACLIENT_PROXY_PROFILE_REF": "-1",
  81 }
  82 #: UI defaults for a NIC instance
  83 nic_defaults = {
  84     "NIC_COMMENT": "",
  85     "NIC_DRIVER": "",
  86     "NIC_MAC": "",
  87     "NIC_TYPE": "UNUSED",
  88 }
  89 #: UI defaults for a provider instance
  90 provider_defaults = {
  91     "PROVIDER_PROXY_SERVER": "",
  92     "PROVIDER_PROXY_PORT": "",
  93     "PROVIDER_PROXY_PASSWORD": "",
  94     "PROVIDER_PROXY_LOGIN": "",
  95     "PROVIDER_NIC_REF": "1",
  96     "PROVIDER_NETMASK": "255.255.0.0",
  97     "PROVIDER_MTU_SIZE": "1500",
  98     "PROVIDER_MODE": "ROUTER",
  99     "PROVIDER_MAILTRANSFER_MODE": "IMMEDIATE",
 100     "PROVIDER_LOCALIP": "",
 101     "PROVIDER_IP": "",
 102     "PROVIDER_FIREWALL_RULESET_REF": "7",
 103     "PROVIDER_FALLBACK_TIMEOUT": "60",
 104     "PROVIDER_FALLBACK_PROVIDER_REF": "-1",
 105     "PROVIDER_EMAIL_RELAY_REF": "-1",
 106     "PROVIDER_DYNDNS_WEBCHECKIP": "0",
 107     "PROVIDER_DYNDNS_ENABLE": "1",
 108     "PROVIDER_DNS_MODE": "ROOT",
 109     "PROVIDER_DNS": "",
 110     "PROVIDER_BWIDTH_MANAGEMENT_UPSTREAM_SPEED": "",
 111     "PROVIDER_BWIDTH_MANAGEMENT_ENABLE": "0",
 112     "PROVIDER_BWIDTH_MANAGEMENT_DOWNSTREAM_SPEED": "",
 113     "PROVIDER_PINGCHECK_SERVERLIST_REF": "-2",
 114 }
 115 #: UI defaults for a port forwarding instance
 116 port_forwarding_defaults = {
 117     "PORT_FORWARDING_DST_IP_REF": "1",
 118     "PORT_FORWARDING_DST_PORT": "",
 119     "PORT_FORWARDING_DST_PORT_END": "",
 120     "PORT_FORWARDING_PROTOCOL_TYPE": "TCP",
 121     "PORT_FORWARDING_SRC_PORT": "",
 122     "PORT_FORWARDING_SRC_PORT_END": "",
 123 }
 124 #: UI defaults for a firewall ruleset instance
 125 firewall_ruleset_defaults = {
 126     "FIREWALL_RULESET_PROFILE_TYPE": "FULL",
 127 }
 128 #: UI defaults for a proxy accesslist instance
 129 proxy_accesslist_defaults = {
 130     "PROXY_ACCESSLIST_ENTRY_COUNT": "123",
 131     "PROXY_ACCESSLIST_MODE": "1",
 132     "PROXY_ACCESSLIST_SIZETYPE": "1",
 133     "PROXY_ACCESSLIST_TYPE": "0",
 134 }
 135 #: UI defaults for a key instance
 136 key_own_defaults = {
 137     "KEY_OWN_FINGERPRINT_MD5": "",
 138     "KEY_OWN_FINGERPRINT_SHA1": "",
 139     "KEY_OWN_ID_X509": "CN=net.lan",
 140     "KEY_OWN_ISSUER": "CN=, C=, L=, ST=, O=, OU=",
 141     "KEY_OWN_KEYSIZE": "2048",
 142     "KEY_OWN_HASH_ALGO": "SHA2_256",
 143     # TODO: the key own creation is currently too hacky for better sanitized defaults
 144     "KEY_OWN_PRIVATE_KEY": "<CREATE_HACK>",
 145     # TODO: the key own creation is currently too hacky for better sanitized defaults
 146     "KEY_OWN_PUBLIC_KEY": "<CREATE_HACK>",
 147     # TODO: the key own creation is currently too hacky for better sanitized defaults
 148     "KEY_OWN_REQUEST": "<CREATE_HACK>",
 149     "KEY_OWN_SUBJECT": "CN=net.lan",
 150     # TODO: the key own creation is currently too hacky for better sanitized defaults
 151     "KEY_OWN_VALIDFROM": "00001122T445566",
 152     # TODO: the key own creation is currently too hacky for better sanitized defaults
 153     "KEY_OWN_VALIDTILL": "99991122T445566",
 154     "KEY_OWN_TYPE": "SELF",
 155     # the ones bellow should be set when using 'generate' to create the key
 156     "KEY_OWN_CREATE_CN": "",
 157     "KEY_OWN_CREATE_EMAIL": ""
 158 }
 159 #: UI defaults for a VPN connection instance
 160 vpnconn_defaults = {
 161     "VPNCONN_ACTIVATION": "ALWAYS",
 162     "VPNCONN_DISABLED": "0",
 163     "VPNCONN_DNS_RELAYING_ALLOWED": "1",
 164     "VPNCONN_EMAIL_RELAYING_ALLOWED": "1",
 165     "VPNCONN_ENCRYPTION_PROFILE_REF": "0",
 166     "VPNCONN_FIREWALL_RULESET_REF": "5",
 167     "VPNCONN_IKE_VERSION": "1",
 168     "VPNCONN_KEY_FOREIGN_REF": "1",
 169     "VPNCONN_KEY_OWN_REF": "1",
 170     "VPNCONN_KEY_TYPE": "PUBLIC",
 171     "VPNCONN_LAN_NAT_IP": "",
 172     "VPNCONN_LAN_NAT_MODE": "UNMODIFIED",
 173     "VPNCONN_LAN_NAT_NETWORK": "",
 174     "VPNCONN_LAN_NIC_REF": "2",
 175     "VPNCONN_LAN_NET": "",
 176     "VPNCONN_LAN_NETMASK": "255.255.0.0",
 177     "VPNCONN_LAN_TYPE": "NIC",
 178     "VPNCONN_LIFETIME_IKE": "480",
 179     "VPNCONN_LIFETIME_IPSECSA": "60",
 180     "VPNCONN_OFFLINE_DETECTION_SEC": "60",
 181     "VPNCONN_PEER_DNS": "",
 182     "VPNCONN_PEER_IP": "",
 183     "VPNCONN_PEER_TYPE": "IP",
 184     "VPNCONN_PROXY_PROFILE_REF": "-2",
 185     "VPNCONN_PSK": "",
 186     "VPNCONN_PSK_FOREIGN_ID": "",
 187     "VPNCONN_PSK_FOREIGN_ID_TYPE": "IP",
 188     "VPNCONN_PSK_OWN_ID": "",
 189     "VPNCONN_PSK_OWN_ID_TYPE": "IP",
 190     "VPNCONN_REMOTE_INET_NAT": "1",
 191     "VPNCONN_REMOTE_MODECONFIG_IP": "",
 192     "VPNCONN_REMOTE_NAT_ENABLE": "0",
 193     "VPNCONN_REMOTE_NAT_NETWORK": "",
 194     "VPNCONN_REMOTE_NET": "",
 195     "VPNCONN_REMOTE_NETMASK": "255.255.0.0",
 196     "VPNCONN_REMOTE_TYPE": "CUSTOM",
 197     "VPNCONN_RETRIES": "3",
 198     "VPNCONN_SECURED": "ESP",
 199     "VPNCONN_XAUTH_SERVER_ENABLE": "0"
 200 }
 201
 202
 203 ###############################################################################
 204 # MINOR CONFIGURATION
 205 ###############################################################################
 206
 207
 208 def template(name, value, instance=-1, defaults=None, **kwargs):
 209     """
 210     Generate a template cnf variable from provided defaults.
 211
 212     :param str name: cnf variable name
 213     :param str value: cnf variable data value
 214     :param int instance: cnf variable instance number
 215     :param defaults: default child variables to populate the cnf variable with
 216     :type defaults: {str, str or {}} or None
 217     :returns: generated cnf variable
 218     :rtype: :py:class:`Cnf`
 219
 220     All additional keyword arguments will be used to overwrite the defaults.
 221     """
 222     log.info(f"Generating a template {name} cnfvar")
 223     cnf = Cnf(name, value=value, instance=instance)
 224     defaults = {} if defaults is None else defaults
 225     cnf.add_children(*[(key, value) for key, value in defaults.items()])
 226     for key in kwargs.keys():
 227         cnf.children.single_with_name(f"{name}_{key}").value = kwargs[key]
 228     return cnf
 229
 230
 231 def user(name, instance=-1, **kwargs):
 232     """
 233     Generate a user cnf variable.
 234
 235     :param str name: username for the user
 236     :param int instance: instance number for the user
 237     :returns: generated cnf variable
 238     :rtype: :py:class:`Cnf`
 239     """
 240     log.info(f"Generating a user {name} cnfvar")
 241     user_cnf = template("user", name, instance=instance, defaults=user_defaults, **kwargs)
 242     user_cnf.children.single_with_name("user_fullname").value = name.capitalize()
 243     return user_cnf
 244
 245
 246 def group(name, instance=-1, **kwargs):
 247     """
 248     Generate a group cnf variable.
 249
 250     :param str name: name for the group
 251     :param int instance: instance number for the group
 252     :returns: generated cnf variable
 253     :rtype: :py:class:`Cnf`
 254     """
 255     log.info(f"Generating a group {name} cnfvar")
 256     group_cnf = template("group", name, instance=instance, defaults=group_defaults, **kwargs)
 257     return group_cnf
 258
 259
 260 def nic(name, instance=-1, **kwargs):
 261     """
 262     Generate a nic cnf variable.
 263
 264     :param str name: tag or comment for the nic describing its use
 265     :param int instance: instance number for the nic
 266     :returns: generated cnf variable
 267     :rtype: :py:class:`Cnf`
 268     """
 269     log.info(f"Generating a nic cnfvar")
 270     nic_cnf = template("nic", "", instance=instance, defaults=nic_defaults, **kwargs)
 271     nic_cnf.children.single_with_name("nic_comment").value = name
 272     if nic_cnf.children.single_with_name("nic_type").value in ["NATLAN", "PUBLICLAN", "PROXYARP"]:
 273         nic_cnf.add_child("nic_lan_ip", "192.168.1.1")
 274         nic_cnf.add_child("nic_lan_netmask", "255.255.255.0")
 275         nic_cnf.add_child("nic_lan_dns_relaying_allowed", "0")
 276         nic_cnf.add_child("nic_lan_email_relaying_allowed", "0")
 277         nic_cnf.add_child("nic_lan_nat_into", "0")
 278         nic_cnf.add_child("nic_lan_proxy_profile_ref", "-1")
 279         nic_cnf.add_child("nic_lan_firewall_ruleset_ref", "1")
 280     return nic_cnf
 281
 282
 283 def intraclient(name, instance=-1, **kwargs):
 284     """
 285     Generate an intraclient cnf variable.
 286
 287     :param str name: name for the intraclient
 288     :param int instance: instance number for the intraclient
 289     :returns: generated cnf variable
 290     :rtype: :py:class:`Cnf`
 291     """
 292     log.info(f"Generating an intraclient {name} cnfvar")
 293     intraclient_cnf = template("intraclient", name, instance=instance,
 294                                defaults=intraclient_defaults, **kwargs)
 295     return intraclient_cnf
 296
 297
 298 def provider(name, instance=-1, **kwargs):
 299     """
 300     Generate a provider cnf variable.
 301
 302     :param str name: name for the provider
 303     :param int instance: instance number for the provider
 304     :returns: generated cnf variable
 305     :rtype: :py:class:`Cnf`
 306     """
 307     log.info(f"Generating a provider {name} cnfvar")
 308     provider_cnf = template("provider", name, instance=instance,
 309                             defaults=provider_defaults, **kwargs)
 310     # the validation of the LOCALIP will not be ignored despite choosing a different mode
 311     if provider_cnf.children.single_with_name("provider_mode").value not in ["ROUTER", "GWINLAN"]:
 312         provider_cnf.children.remove_where(lambda c: c.name == "provider_ip")
 313         provider_cnf.children.remove_where(lambda c: c.name == "provider_netmask")
 314     if provider_cnf.children.single_with_name("provider_mode").value != "ROUTER":
 315         provider_cnf.children.remove_where(lambda c: c.name == "provider_localip")
 316     if provider_cnf.children.single_with_name("provider_dns_mode").value != "IP":
 317         provider_cnf.children.remove_where(lambda c: c.name == "provider_dns")
 318     return provider_cnf
 319
 320
 321 def port_forwarding(name, instance=-1, **kwargs):
 322     """
 323     Generate a port forwarding cnf variable.
 324
 325     :param str name: name for the port forwarding mapping
 326     :param int instance: instance number for the port forwarding mapping
 327     :returns: generated cnf variable
 328     :rtype: :py:class:`Cnf`
 329     """
 330     log.info(f"Generating a port forwarding {name} cnfvar")
 331     port_forwarding_cnf = template("port_forwarding", name, instance=instance,
 332                                    defaults=port_forwarding_defaults, **kwargs)
 333     if port_forwarding_cnf.children.single_with_name("port_forwarding_protocol_type").value == "OTHER":
 334         port_forwarding_cnf.children.remove_where(lambda c: c.name == "port_forwarding_src_port")
 335         port_forwarding_cnf.children.remove_where(lambda c: c.name == "port_forwarding_dst_port")
 336         port_forwarding_cnf.children.remove_where(lambda c: c.name == "port_forwarding_src_port_end")
 337         port_forwarding_cnf.children.remove_where(lambda c: c.name == "port_forwarding_dst_port_end")
 338         port_forwarding_cnf.add_child("port_forwarding_protocol_num", "47")
 339     return port_forwarding_cnf
 340
 341
 342 def firewall_ruleset(name, instance=-1, **kwargs):
 343     """
 344     Generate a firewall ruleset cnf variable.
 345
 346     :param str name: name for the firewall ruleset
 347     :param int instance: instance number for the firewall ruleset
 348     :returns: generated cnf variable
 349     :rtype: :py:class:`Cnf`
 350     """
 351     log.info(f"Generating a firewall ruleset {name} cnfvar")
 352     firewall_ruleset_cnf = template("firewall_ruleset", name, instance=instance,
 353                                     defaults=firewall_ruleset_defaults, **kwargs)
 354     return firewall_ruleset_cnf
 355
 356
 357 def proxy_accesslist(name, instance=-1, **kwargs):
 358     """
 359     Generate a proxy accesslist cnf variable.
 360
 361     :param str name: name for the proxy accesslist
 362     :param int instance: instance number for the proxy accesslist
 363     :returns: generated cnf variable
 364     :rtype: :py:class:`Cnf`
 365     """
 366     log.info(f"Generating a proxy accesslist {name} cnfvar")
 367     proxy_accesslist_cnf = template("proxy_accesslist", name, instance=instance,
 368                                     defaults=proxy_accesslist_defaults, **kwargs)
 369     return proxy_accesslist_cnf
 370
 371
 372 def key_own(name, instance=-1, **kwargs):
 373     """
 374     Generate an own key cnf variable.
 375
 376     :param str name: name for the own key
 377     :param int instance: instance number for the own key
 378     :returns: generated cnf variable
 379     :rtype: :py:class:`Cnf`
 380     """
 381     log.info(f"Generating an own key {name} cnfvar")
 382     key_own_cnf = template("key_own", name, instance=instance,
 383                            defaults=key_own_defaults, **kwargs)
 384     return key_own_cnf
 385
 386
 387 def vpnconn(name, instance=-1, **kwargs):
 388     """
 389     Generate a vpn connection cnf variable.
 390
 391     :param str name: name for the vpn connection
 392     :param int instance: instance number for the vpn connection
 393     :returns: generated cnf variable
 394     :rtype: :py:class:`Cnf`
 395     """
 396     log.info(f"Generating a vpn connection {name} cnfvar")
 397     vpnconn_cnf = template("vpnconn", name, instance=instance,
 398                            defaults=vpnconn_defaults, **kwargs)
 399     if vpnconn_cnf.children.single_with_name("vpnconn_lan_type").value not in ["NIC", "CUSTOM"]:
 400         vpnconn_cnf.children.remove_where(lambda c: c.name == "vpnconn_lan_net")
 401     if vpnconn_cnf.children.single_with_name("vpnconn_remote_type").value != "CUSTOM":
 402         vpnconn_cnf.children.remove_where(lambda c: c.name == "vpnconn_remote_net")
 403     if vpnconn_cnf.children.single_with_name("vpnconn_remote_type").value != "MODECONFIG":
 404         vpnconn_cnf.children.remove_where(lambda c: c.name == "vpnconn_remote_modeconfig_ip")
 405     return vpnconn_cnf