capirca_acl.py

# -*- coding: utf-8 -*-
'''
Capirca ACL
===========

Generate ACL (firewall) configuration for network devices.

.. versionadded:: 2017.7.0

:codeauthor: Mircea Ulinic <mircea@cloudflare.com> & Robert Ankeny <robankeny@google.com>
:maturity:   new
:depends:    capirca
:platform:   unix

Dependencies
------------

The firewall configuration is generated by Capirca_.

.. _Capirca: https://github.com/google/capirca

To install Capirca, execute: ``pip install capirca``.
'''
from __future__ import absolute_import

import re
import inspect
import logging
import datetime

log = logging.getLogger(__file__)

# Import third party libs
from salt.ext import six
try:
    import capirca
    import capirca.aclgen
    import capirca.lib.policy
    import capirca.lib.aclgenerator
    HAS_CAPIRCA = True
except ImportError:
    HAS_CAPIRCA = False

# Import Salt libs
try:
    from salt.utils import fopen
except ImportError:
    from salt.utils.files import fopen

# ------------------------------------------------------------------------------
# module properties
# ------------------------------------------------------------------------------

__virtualname__ = 'capirca'
__proxyenabled__ = ['*']
# allow any proxy type

# ------------------------------------------------------------------------------
# property functions
# ------------------------------------------------------------------------------


def __virtual__():
    '''
    This module requires at least Capirca to work.
    '''
    if HAS_CAPIRCA:
        return __virtualname__
    else:
        return (False, 'The capirca module (capirca_acl) cannot be loaded.')

# ------------------------------------------------------------------------------
# module globals
# ------------------------------------------------------------------------------

# define the default values for all possible term fields
# This mapping is currently built dynamically using the Term class from the
# underlying library, Capirca
_TERM_FIELDS = {}


# IP-type fields
# when it comes to IP fields, Capirca does not ingest raw text
# but they need to be converted to `nacaddr.IP`
# this pre-processing is done in `_clean_term_opts`
_IP_FILEDS = [
    'source_address',
    'source_address_exclude',
    'destination_address',
    'address',
    'address_exclude',
    'flattened_addr',
    'flattened_saddr',
    'flattened_daddr',
    'next_ip'
]

_SERVICES = {}

# ------------------------------------------------------------------------------
# helper functions -- will not be exported
# ------------------------------------------------------------------------------


if HAS_CAPIRCA:
    _TempTerm = capirca.lib.policy.Term

    def _add_object(self, obj):
        return

    setattr(_TempTerm, 'AddObject', _add_object)
    dumy_term = _TempTerm(None)
    for item in dir(dumy_term):
        if hasattr(item, '__func__') or item.startswith('_') or item != item.lower():
            continue
        _TERM_FIELDS[item] = getattr(dumy_term, item)

    class _Policy(capirca.lib.policy.Policy):
        '''
        Extending the Capirca Policy class to allow inserting custom filters.
        '''
        def __init__(self):
            self.filters = []
            self.filename = ''

    class _Term(capirca.lib.policy.Term):
        '''
        Extending the Capirca Term class to allow setting field valued on the fly.
        '''
        def __init__(self):
            for field, default in six.iteritems(_TERM_FIELDS):
                setattr(self, field, default)


def _import_platform_generator(platform):
    '''
    Given a specific platform (under the Capirca conventions),
    return the generator class.
    The generator class is identified looking under the <platform> module
    for a class inheriting the `ACLGenerator` class.
    '''
    log.debug('Using platform: {plat}'.format(plat=platform))
    for mod_name, mod_obj in inspect.getmembers(capirca.aclgen):
        if mod_name == platform and inspect.ismodule(mod_obj):
            for plat_obj_name, plat_obj in inspect.getmembers(mod_obj):  # pylint: disable=unused-variable
                if inspect.isclass(plat_obj) and issubclass(plat_obj, capirca.lib.aclgenerator.ACLGenerator):
                    log.debug('Identified Capirca class {cls} for {plat}'.format(
                        cls=plat_obj,
                        plat=platform))
                    return plat_obj
    log.error('Unable to identify any Capirca plaform class for {plat}'.format(plat=platform))


def _get_services_mapping():
    '''
    Build a map of services based on the IANA assignment list:
    http://www.iana.org/assignments/port-numbers

    It will load the /etc/services file and will build the mapping on the fly,
    similar to the Capirca's SERVICES file:
    https://github.com/google/capirca/blob/master/def/SERVICES.svc

    As this module is be available on Unix systems only,
    we'll read the services from /etc/services.
    In the worst case, the user will not be able to specify the
    services shortcut and they will need to specify the protocol / port combination
    using the source_port / destination_port & protocol fields.
    '''
    if _SERVICES:
        return _SERVICES
    services_txt = ''
    try:
        with fopen('/etc/services', 'r') as srv_f:
            services_txt = srv_f.read()
    except IOError as ioe:
        log.error('Unable to read from /etc/services:')
        log.error(ioe)
        return _SERVICES  # no mapping possible, sorry
        # will return the default mapping
    service_rgx = re.compile(r'^([a-zA-Z0-9-]+)\s+(\d+)\/(tcp|udp)(.*)$')
    for line in services_txt.splitlines():
        service_rgx_s = service_rgx.search(line)
        if service_rgx_s and len(service_rgx_s.groups()) == 4:
            srv_name, port, protocol, _ = service_rgx_s.groups()
            if srv_name not in _SERVICES:
                _SERVICES[srv_name] = {
                    'port': [],
                    'protocol': []
                }
            try:
                _SERVICES[srv_name]['port'].append(int(port))
            except ValueError as verr:
                log.error(verr)
                log.error('Did not read that properly:')
                log.error(line)
                log.error('Please report the above error: {port} does not seem a valid port value!'.format(port=port))
            _SERVICES[srv_name]['protocol'].append(protocol)
    return _SERVICES


def _translate_port(port):
    '''
    Look into services and return the port value using the
    service name as lookup value.
    '''
    services = _get_services_mapping()
    if port in services and services[port]['port']:
        return services[port]['port'][0]
    return port


def _make_it_list(dict_, field_name, value):
    '''
    Return the object list.
    '''
    prev_value = []
    # firsly we'll collect the prev value
    if field_name in dict_:
        prev_value = dict_[field_name]
    if value is None:
        return prev_value
    elif isinstance(value, (tuple, list)):
        # other type of iterables
        if field_name in ('source_port', 'destination_port'):
            # port fields are more special
            # they can either be a list of integers, either a list of tuples
            # list of integers = a list of ports
            # list of tuples = a list of ranges,
            # e.g.: [(1000, 2000), (3000, 4000)] means the 1000-2000 and 3000-4000 ranges
            portval = []
            for port in value:
                if not isinstance(port, (tuple, list)):
                    # to make sure everything is consistent,
                    # we'll transform indivitual ports into tuples
                    # thus an individual port e.g. 1000 will be transormed into the port range 1000-1000
                    # which is the equivalent
                    # but assures consistency for the Capirca parser
                    portval.append((port, port))
                else:
                    portval.append(port)
            translated_portval = []
            # and the ports sent as string, e.g. ntp instead of 123
            # needs to be translated
            # again, using the same /etc/services
            for port_start, port_end in portval:
                if not isinstance(port_start, int):
                    port_start = _translate_port(port_start)
                if not isinstance(port_end, int):
                    port_end = _translate_port(port_end)
                translated_portval.append(
                    (port_start, port_end)
                )
            return list(set(prev_value + translated_portval))
        return list(set(prev_value + list(value)))
    if field_name in ('source_port', 'destination_port'):
        if not isinstance(value, int):
            value = _translate_port(value)
        return list(set(prev_value + [(value, value)]))  # a list of tuples
    # anything else will be enclosed in a list-type
    return list(set(prev_value + [value]))


def _clean_term_opts(term_opts):
    '''
    Cleanup the term opts:

    - strip Null and empty valuee, defaulting their value to their base definition from _TERM_FIELDS
    - convert to `nacaddr.IP` fields from `_IP_FILEDS`
    - create lists for those fields requiring it
    '''
    clean_opts = {}
    _services = _get_services_mapping()
    for field, value in six.iteritems(term_opts):
        # firstly we'll process special fields like source_service or destination_services
        # which will inject values directly in the source or destination port and protocol
        if field == 'source_service' and value:
            if isinstance(value, six.string_types):
                value = _make_it_list(clean_opts, field, value)
            log.debug('Processing special source services:')
            log.debug(value)
            for service in value:
                if service and service in _services:
                    # if valid source_service
                    # take the port and protocol values from the global and inject in the term config
                    clean_opts['source_port'] = _make_it_list(clean_opts,
                                                              'source_port',
                                                              _services[service]['port'])
                    clean_opts['protocol'] = _make_it_list(clean_opts,
                                                           'protocol',
                                                           _services[service]['protocol'])
            log.debug('Built source_port field, after processing special source services:')
            log.debug(clean_opts.get('source_port'))
            log.debug('Built protocol field, after processing special source services:')
            log.debug(clean_opts.get('protocol'))
        elif field == 'destination_service' and value:
            if isinstance(value, six.string_types):
                value = _make_it_list(clean_opts, field, value)
            log.debug('Processing special destination services:')
            log.debug(value)
            for service in value:
                if service and service in _services:
                    # if valid destination_service
                    # take the port and protocol values from the global and inject in the term config
                    clean_opts['destination_port'] = _make_it_list(clean_opts,
                                                                   'destination_port',
                                                                   _services[service]['port'])
                    clean_opts['protocol'] = _make_it_list(clean_opts,
                                                           'protocol',
                                                           _services[service]['protocol'])
            log.debug('Built source_port field, after processing special destination services:')
            log.debug(clean_opts.get('destination_service'))
            log.debug('Built protocol field, after processing special destination services:')
            log.debug(clean_opts.get('protocol'))
        # not a special field, but it has to be a valid one
        elif field in _TERM_FIELDS and value and value != _TERM_FIELDS[field]:
            # if not a special field type
            if isinstance(_TERM_FIELDS[field], list):
                value = _make_it_list(clean_opts, field, value)
            if field in _IP_FILEDS:
                # IP-type fields need to be transformed
                ip_values = []
                for addr in value:
                    if six.PY2:
                        addr = six.text_type(addr)
                        # Adding this, as ipaddress would complain about valid
                        # addresses not being valid. #pythonIsFun
                    ip_values.append(capirca.lib.policy.nacaddr.IP(addr))
                value = ip_values[:]
            clean_opts[field] = value
    return clean_opts


def _lookup_element(lst, key):
    '''
    Find an dictionary in a list of dictionaries, given its main key.
    '''
    if not lst:
        return {}
    for ele in lst:
        if not ele or not isinstance(ele, dict):
            continue
        if ele.keys()[0] == key:
            return ele.values()[0]
    return {}


def _get_pillar_cfg(pillar_key,
                    pillarenv=None,
                    saltenv=None):
    '''
    Retrieve the pillar data from the right environment.
    '''
    pillar_cfg = __salt__['pillar.get'](pillar_key,
                                        pillarenv=pillarenv,
                                        saltenv=saltenv)
    return pillar_cfg


def _cleanup(lst):
    '''
    Return a list of non-empty dictionaries.
    '''
    clean = []
    for ele in lst:
        if ele and isinstance(ele, dict):
            clean.append(ele)
    return clean


def _merge_list_of_dict(first, second, prepend=True):
    '''
    Merge lists of dictionaries.
    Each element of the list is a dictionary having one single key.
    That key is then used as unique lookup.
    The first element list has higher priority than the second.
    When there's an overlap between the two lists,
    it won't change the position, but the content.
    '''
    first = _cleanup(first)
    second = _cleanup(second)
    if not first and not second:
        return []
    if not first and second:
        return second
    if first and not second:
        return first
    # Determine overlaps
    # So we dont change the position of the existing terms/filters
    overlaps = []
    merged = []
    appended = []
    for ele in first:
        if _lookup_element(second, ele.keys()[0]):
            overlaps.append(ele)
        elif prepend:
            merged.append(ele)
        elif not prepend:
            appended.append(ele)
    for ele in second:
        ele_key = ele.keys()[0]
        if _lookup_element(overlaps, ele_key):
            # If theres an overlap, get the value from the first
            # But inserted into the right position
            ele_val_first = _lookup_element(first, ele_key)
            merged.append({ele_key: ele_val_first})
        else:
            merged.append(ele)
    if not prepend:
        merged.extend(appended)
    return merged


def _get_term_object(filter_name,
                     term_name,
                     pillar_key='acl',
                     pillarenv=None,
                     saltenv=None,
                     merge_pillar=True,
                     **term_fields):
    '''
    Return an instance of the ``_Term`` class given the term options.
    '''
    log.debug('Generating config for term {tname} under filter {fname}'.format(
        tname=term_name,
        fname=filter_name
    ))
    term = _Term()
    term.name = term_name
    term_opts = {}
    if merge_pillar:
        term_opts = get_term_pillar(filter_name,
                                    term_name,
                                    pillar_key=pillar_key,
                                    saltenv=saltenv,
                                    pillarenv=pillarenv)
        log.debug('Merging with pillar data:')
        log.debug(term_opts)
        term_opts = _clean_term_opts(term_opts)
        log.debug('Cleaning up pillar data:')
        log.debug(term_opts)
    log.debug('Received processing opts:')
    log.debug(term_fields)
    log.debug('Cleaning up processing opts:')
    term_fields = _clean_term_opts(term_fields)
    log.debug(term_fields)
    log.debug('Final term opts:')
    term_opts.update(term_fields)
    log.debug(term_fields)
    for field, value in six.iteritems(term_opts):
        # setting the field attributes to the term instance of _Term
        setattr(term, field, value)
    log.debug('Term config:')
    log.debug(str(term))
    return term


def _get_policy_object(platform,
                       filters=None,
                       pillar_key='acl',
                       pillarenv=None,
                       saltenv=None,
                       merge_pillar=True):
    '''
    Return an instance of the ``_Policy`` class given the filters config.
    '''
    policy = _Policy()
    policy_filters = []
    if not filters:
        filters = []
    for filter_ in filters:
        if not filter_ or not isinstance(filter_, dict):
            continue  # go to the next filter
        filter_name = filter_.keys()[0]
        filter_config = filter_.values()[0]
        header = capirca.lib.policy.Header()  # same header everywhere
        target_opts = [
            platform,
            filter_name
        ]
        filter_options = filter_config.pop('options', None)
        if filter_options:
            filter_options = _make_it_list({}, filter_name, filter_options)
            # make sure the filter options are sent as list
            target_opts.extend(filter_options)
        target = capirca.lib.policy.Target(target_opts)
        header.AddObject(target)
        filter_terms = []
        for term_ in filter_config.get('terms', []):
            if term_ and isinstance(term_, dict):
                term_name = term_.keys()[0]
                term_fields = term_.values()[0]
                term = _get_term_object(filter_name,
                                        term_name,
                                        pillar_key=pillar_key,
                                        pillarenv=pillarenv,
                                        saltenv=saltenv,
                                        merge_pillar=merge_pillar,
                                        **term_fields)
            filter_terms.append(term)
        policy_filters.append(
            (header, filter_terms)
        )
    policy.filters = policy_filters
    log.debug('Policy config:')
    log.debug(str(policy))
    platform_generator = _import_platform_generator(platform)
    policy_config = platform_generator(policy, 2)
    log.debug('Generating policy config for {platform}:'.format(
        platform=platform))
    log.debug(str(policy_config))
    return policy_config


def _revision_tag(text,
                  revision_id=None,
                  revision_no=None,
                  revision_date=True,
                  revision_date_format='%Y/%m/%d'):
    '''
    Refactor revision tag comments.
    Capirca generates the filter text having the following tag keys:

    - $Id:$
    - $Revision:$
    - $Date:$

    This function goes through all the config lines and replaces
    those tags with the content requested by the user.
    If a certain value is not provided, the corresponding tag will be stripped.
    '''
    timestamp = datetime.datetime.now().strftime(revision_date_format)
    new_text = []
    for line in text.splitlines():
        if '$Id:$' in line:
            if not revision_id:  # if no explicit revision ID required
                continue  # jump to next line, ignore this one
            line = line.replace('$Id:$', '$Id: {rev_id} $'.format(rev_id=revision_id))
        if '$Revision:$' in line:
            if not revision_no:  # if no explicit revision number required
                continue  # jump to next line, ignore this one
            line = line.replace('$Revision:$', '$Revision: {rev_no} $'.format(rev_no=revision_no))
        if '$Date:$' in line:
            if not revision_date:
                continue  # jump
            line = line.replace('$Date:$', '$Date: {ts} $'.format(ts=timestamp))
        new_text.append(line)
    return '\n'.join(new_text)

# ------------------------------------------------------------------------------
# callable functions
# ------------------------------------------------------------------------------


def get_term_config(platform,
                    filter_name,
                    term_name,
                    filter_options=None,
                    pillar_key='acl',
                    pillarenv=None,
                    saltenv=None,
                    merge_pillar=True,
                    revision_id=None,
                    revision_no=None,
                    revision_date=True,
                    revision_date_format='%Y/%m/%d',
                    source_service=None,
                    destination_service=None,
                    **term_fields):
    '''
    Return the configuration of a single policy term.

    platform
        The name of the Capirca platform.

    filter_name
        The name of the policy filter.

    term_name
        The name of the term.

    filter_options
        Additional filter options. These options are platform-specific.
        E.g.: ``inet6``, ``bridge``, ``object-group``,
        See the complete list of options_.

        .. _options: https://github.com/google/capirca/wiki/Policy-format#header-section

    pillar_key: ``acl``
        The key in the pillar containing the default attributes values. Default: ``acl``.
        If the pillar contains the following structure:

        .. code-block:: yaml

            firewall:
              - my-filter:
                  terms:
                    - my-term:
                        source_port: 1234
                        source_address:
                            - 1.2.3.4/32
                            - 5.6.7.8/32

        The ``pillar_key`` field would be specified as ``firewall``.

    pillarenv
        Query the master to generate fresh pillar data on the fly,
        specifically from the requested pillar environment.

    saltenv
        Included only for compatibility with
        :conf_minion:`pillarenv_from_saltenv`, and is otherwise ignored.

    merge_pillar: ``True``
        Merge the CLI variables with the pillar. Default: ``True``.

    revision_id
        Add a comment in the term config having the description for the changes applied.

    revision_no
        The revision count.

    revision_date: ``True``
        Boolean flag: display the date when the term configuration was generated. Default: ``True``.

    revision_date_format: ``%Y/%m/%d``
        The date format to be used when generating the perforce data. Default: ``%Y/%m/%d`` (<year>/<month>/<day>).

    source_service
        A special service to choose from. This is a helper so the user is able to
        select a source just using the name, instead of specifying a source_port and protocol.

        As this module is available on Unix platforms only,
        it reads the IANA_ port assignment from ``/etc/services``.

        If the user requires additional shortcuts to be referenced, they can add entries under ``/etc/services``,
        which can be managed using the :mod:`file state <salt.states.file>`.

        .. _IANA: http://www.iana.org/assignments/port-numbers

    destination_service
        A special service to choose from. This is a helper so the user is able to
        select a source just using the name, instead of specifying a destination_port and protocol.
        Allows the same options as ``source_service``.

    term_fields
        Term attributes.
        To see what fields are supported, please consult the list of supported keywords_.
        Some platforms have few other optional_ keywords.

        .. _keywords: https://github.com/google/capirca/wiki/Policy-format#keywords
        .. _optional: https://github.com/google/capirca/wiki/Policy-format#optionally-supported-keywords

    .. note::
        The following fields are accepted:

        - action
        - address
        - address_exclude
        - comment
        - counter
        - expiration
        - destination_address
        - destination_address_exclude
        - destination_port
        - destination_prefix
        - forwarding_class
        - forwarding_class_except
        - logging
        - log_name
        - loss_priority
        - option
        - policer
        - port
        - precedence
        - principals
        - protocol
        - protocol_except
        - qos
        - pan_application
        - routing_instance
        - source_address
        - source_address_exclude
        - source_port
        - source_prefix
        - verbatim
        - packet_length
        - fragment_offset
        - hop_limit
        - icmp_type
        - ether_type
        - traffic_class_count
        - traffic_type
        - translated
        - dscp_set
        - dscp_match
        - dscp_except
        - next_ip
        - flexible_match_range
        - source_prefix_except
        - destination_prefix_except
        - vpn
        - source_tag
        - destination_tag
        - source_interface
        - destination_interface
        - flattened
        - flattened_addr
        - flattened_saddr
        - flattened_daddr
        - priority

    .. note::
        The following fields can be also a single value and a list of values:

        - action
        - address
        - address_exclude
        - comment
        - destination_address
        - destination_address_exclude
        - destination_port
        - destination_prefix
        - forwarding_class
        - forwarding_class_except
        - logging
        - option
        - port
        - precedence
        - principals
        - protocol
        - protocol_except
        - pan_application
        - source_address
        - source_address_exclude
        - source_port
        - source_prefix
        - verbatim
        - icmp_type
        - ether_type
        - traffic_type
        - dscp_match
        - dscp_except
        - flexible_match_range
        - source_prefix_except
        - destination_prefix_except
        - source_tag
        - destination_tag
        - source_service
        - destination_service

        Example: ``destination_address`` can be either defined as:

        .. code-block:: yaml

            destination_address: 172.17.17.1/24

        or as a list of destination IP addresses:

        .. code-block:: yaml

            destination_address:
                - 172.17.17.1/24
                - 172.17.19.1/24

        or a list of services to be matched:

        .. code-block:: yaml

            source_service:
                - ntp
                - snmp
                - ldap
                - bgpd

    .. note::
        The port fields ``source_port`` and ``destination_port`` can be used as above to select either
        a single value, either a list of values, but also they can select port ranges. Example:

        .. code-block:: yaml

            source_port:
                - [1000, 2000]
                - [3000, 4000]

        With the configuration above, the user is able to select the 1000-2000 and 3000-4000 source port ranges.

    CLI Example:

    .. code-block:: bash

        salt '*' capirca.get_term_config arista filter-name term-name source_address=1.2.3.4 destination_address=5.6.7.8 action=accept

    Output Example:

    .. code-block:: text

        ! $Date: 2017/03/22 $
        no ip access-list filter-name
        ip access-list filter-name
         remark term-name
         permit ip host 1.2.3.4 host 5.6.7.8
        exit
    '''
    terms = []
    term = {
        term_name: {
        }
    }
    term[term_name].update(term_fields)
    term[term_name].update({
        'source_service': _make_it_list({}, 'source_service', source_service),
        'destination_service': _make_it_list({}, 'destination_service', destination_service),
    })
    terms.append(term)
    if not filter_options:
        filter_options = []
    return get_filter_config(platform,
                             filter_name,
                             filter_options=filter_options,
                             terms=terms,
                             pillar_key=pillar_key,
                             pillarenv=pillarenv,
                             saltenv=saltenv,
                             merge_pillar=merge_pillar,
                             only_lower_merge=True,
                             revision_id=revision_id,
                             revision_no=revision_no,
                             revision_date=revision_date,
                             revision_date_format=revision_date_format)


def get_filter_config(platform,
                      filter_name,
                      filter_options=None,
                      terms=None,
                      prepend=True,
                      pillar_key='acl',
                      pillarenv=None,
                      saltenv=None,
                      merge_pillar=True,
                      only_lower_merge=False,
                      revision_id=None,
                      revision_no=None,
                      revision_date=True,
                      revision_date_format='%Y/%m/%d'):
    '''
    Return the configuration of a policy filter.

    platform
        The name of the Capirca platform.

    filter_name
        The name of the policy filter.

    filter_options
        Additional filter options. These options are platform-specific.
        See the complete list of options_.

        .. _options: https://github.com/google/capirca/wiki/Policy-format#header-section

    terms
        List of terms for this policy filter.
        If not specified or empty, will try to load the configuration from the pillar,
        unless ``merge_pillar`` is set as ``False``.

    prepend: ``True``
        When ``merge_pillar`` is set as ``True``, the final list of terms generated by merging
        the terms from ``terms`` with those defined in the pillar (if any): new terms are prepended
        at the beginning, while existing ones will preserve the position. To add the new terms
        at the end of the list, set this argument to ``False``.

    pillar_key: ``acl``
        The key in the pillar containing the default attributes values. Default: ``acl``.

    pillarenv
        Query the master to generate fresh pillar data on the fly,
        specifically from the requested pillar environment.

    saltenv
        Included only for compatibility with
        :conf_minion:`pillarenv_from_saltenv`, and is otherwise ignored.

    merge_pillar: ``True``
        Merge the CLI variables with the pillar. Default: ``True``.

    only_lower_merge: ``False``
        Specify if it should merge only the terms fields. Otherwise it will try
        to merge also filters fields. Default: ``False``.

    revision_id
        Add a comment in the filter config having the description for the changes applied.

    revision_no
        The revision count.

    revision_date: ``True``
        Boolean flag: display the date when the filter configuration was generated. Default: ``True``.

    revision_date_format: ``%Y/%m/%d``
        The date format to be used when generating the perforce data. Default: ``%Y/%m/%d`` (<year>/<month>/<day>).

    CLI Example:

    .. code-block:: bash

        salt '*' capirca.get_filter_config ciscoxr my-filter pillar_key=netacl

    Output Example:

    .. code-block:: text

        ! $Id:$
        ! $Date:$
        ! $Revision:$
        no ipv4 access-list my-filter
        ipv4 access-list my-filter
         remark $Id:$
         remark my-term
         deny ipv4 any eq 1234 any
         deny ipv4 any eq 1235 any
         remark my-other-term
         permit tcp any range 5678 5680 any
        exit

    The filter configuration has been loaded from the pillar, having the following structure:

    .. code-block:: yaml

        netacl:
          - my-filter:
              terms:
                - my-term:
                    source_port: [1234, 1235]
                    action: reject
                - my-other-term:
                    source_port:
                      - [5678, 5680]
                    protocol: tcp
                    action: accept
    '''
    if not filter_options:
        filter_options = []
    if not terms:
        terms = []
    if merge_pillar and not only_lower_merge:
        acl_pillar_cfg = _get_pillar_cfg(pillar_key,
                                         saltenv=saltenv,
                                         pillarenv=pillarenv)
        filter_pillar_cfg = _lookup_element(acl_pillar_cfg, filter_name)
        filter_options = filter_options or filter_pillar_cfg.pop('options', None)
        if filter_pillar_cfg:
            # Only when it was able to find the filter in the ACL config
            pillar_terms = filter_pillar_cfg.get('terms', [])  # No problem if empty in the pillar
            terms = _merge_list_of_dict(terms, pillar_terms, prepend=prepend)
            # merge the passed variable with the pillar data
            # any filter term not defined here, will be appended from the pillar
            # new terms won't be removed
    filters = []
    filters.append({
        filter_name: {
            'options': _make_it_list({}, filter_name, filter_options),
            'terms': terms
        }
    })
    return get_policy_config(platform,
                             filters=filters,
                             pillar_key=pillar_key,
                             pillarenv=pillarenv,
                             saltenv=saltenv,
                             merge_pillar=merge_pillar,
                             only_lower_merge=True,
                             revision_id=revision_id,
                             revision_no=revision_no,
                             revision_date=revision_date,
                             revision_date_format=revision_date_format)


def get_policy_config(platform,
                      filters=None,
                      prepend=True,
                      pillar_key='acl',
                      pillarenv=None,
                      saltenv=None,
                      merge_pillar=True,
                      only_lower_merge=False,
                      revision_id=None,
                      revision_no=None,
                      revision_date=True,
                      revision_date_format='%Y/%m/%d'):
    '''
    Return the configuration of the whole policy.

    platform
        The name of the Capirca platform.

    filters
        List of filters for this policy.
        If not specified or empty, will try to load the configuration from the pillar,
        unless ``merge_pillar`` is set as ``False``.

    prepend: ``True``
        When ``merge_pillar`` is set as ``True``, the final list of filters generated by merging
        the filters from ``filters`` with those defined in the pillar (if any): new filters are prepended
        at the beginning, while existing ones will preserve the position. To add the new filters
        at the end of the list, set this argument to ``False``.

    pillar_key: ``acl``
        The key in the pillar containing the default attributes values. Default: ``acl``.

    pillarenv
        Query the master to generate fresh pillar data on the fly,
        specifically from the requested pillar environment.

    saltenv
        Included only for compatibility with
        :conf_minion:`pillarenv_from_saltenv`, and is otherwise ignored.

    merge_pillar: ``True``
        Merge the CLI variables with the pillar. Default: ``True``.

    only_lower_merge: ``False``
        Specify if it should merge only the filters and terms fields. Otherwise it will try
        to merge everything at the policy level. Default: ``False``.

    revision_id
        Add a comment in the policy config having the description for the changes applied.

    revision_no
        The revision count.

    revision_date: ``True``
        Boolean flag: display the date when the policy configuration was generated. Default: ``True``.

    revision_date_format: ``%Y/%m/%d``
        The date format to be used when generating the perforce data. Default: ``%Y/%m/%d`` (<year>/<month>/<day>).

    CLI Example:

    .. code-block:: bash

        salt '*' capirca.get_policy_config juniper pillar_key=netacl

    Output Example:

    .. code-block:: text

        firewall {
            family inet {
                replace:
                /*
                ** $Id:$
                ** $Date:$
                ** $Revision:$
                **
                */
                filter my-filter {
                    term my-term {
                        from {
                            source-port [ 1234 1235 ];
                        }
                        then {
                            reject;
                        }
                    }
                    term my-other-term {
                        from {
                            protocol tcp;
                            source-port 5678-5680;
                        }
                        then accept;
                    }
                }
            }
        }
        firewall {
            family inet {
                replace:
                /*
                ** $Id:$
                ** $Date:$
                ** $Revision:$
                **
                */
                filter my-other-filter {
                    interface-specific;
                    term dummy-term {
                        from {
                            protocol [ tcp udp ];
                        }
                        then {
                            reject;
                        }
                    }
                }
            }
        }

    The policy configuration has been loaded from the pillar, having the following structure:

    .. code-block:: yaml

        netacl:
          - my-filter:
              options:
                - not-interface-specific
              terms:
                - my-term:
                    source_port: [1234, 1235]
                    action: reject
                - my-other-term:
                    source_port:
                      - [5678, 5680]
                    protocol: tcp
                    action: accept
          - my-other-filter:
              terms:
                - dummy-term:
                    protocol:
                      - tcp
                      - udp
                    action: reject
    '''
    if not filters:
        filters = []
    if merge_pillar and not only_lower_merge:
        # the pillar key for the policy config is the `pillar_key` itself
        policy_pillar_cfg = _get_pillar_cfg(pillar_key,
                                            saltenv=saltenv,
                                            pillarenv=pillarenv)
        # now, let's merge everything witht the pillar data
        # again, this will not remove any extra filters/terms
        # but it will merge with the pillar data
        # if this behaviour is not wanted, the user can set `merge_pillar` as `False`
        filters = _merge_list_of_dict(filters, policy_pillar_cfg, prepend=prepend)
    policy_object = _get_policy_object(platform,
                                       filters=filters,
                                       pillar_key=pillar_key,
                                       pillarenv=pillarenv,
                                       saltenv=saltenv,
                                       merge_pillar=merge_pillar)
    policy_text = str(policy_object)
    return _revision_tag(policy_text,
                         revision_id=revision_id,
                         revision_no=revision_no,
                         revision_date=revision_date,
                         revision_date_format=revision_date_format)


def get_filter_pillar(filter_name,
                      pillar_key='acl',
                      pillarenv=None,
                      saltenv=None):
    '''
    Helper that can be used inside a state SLS,
    in order to get the filter configuration given its name.

    filter_name
        The name of the filter.

    pillar_key
        The root key of the whole policy config.

    pillarenv
        Query the master to generate fresh pillar data on the fly,
        specifically from the requested pillar environment.

    saltenv
        Included only for compatibility with
        :conf_minion:`pillarenv_from_saltenv`, and is otherwise ignored.
    '''
    pillar_cfg = _get_pillar_cfg(pillar_key,
                                 pillarenv=pillarenv,
                                 saltenv=saltenv)
    return _lookup_element(pillar_cfg, filter_name)


def get_term_pillar(filter_name,
                    term_name,
                    pillar_key='acl',
                    pillarenv=None,
                    saltenv=None):
    '''
    Helper that can be used inside a state SLS,
    in order to get the term configuration given its name,
    under a certain filter uniquely identified by its name.

    filter_name
        The name of the filter.

    term_name
        The name of the term.

    pillar_key: ``acl``
        The root key of the whole policy config. Default: ``acl``.

    pillarenv
        Query the master to generate fresh pillar data on the fly,
        specifically from the requested pillar environment.

    saltenv
        Included only for compatibility with
        :conf_minion:`pillarenv_from_saltenv`, and is otherwise ignored.
    '''
    filter_pillar_cfg = get_filter_pillar(filter_name,
                                          pillar_key=pillar_key,
                                          pillarenv=pillarenv,
                                          saltenv=saltenv)
    term_pillar_cfg = filter_pillar_cfg.get('terms', [])
    term_opts = _lookup_element(term_pillar_cfg, term_name)
    return term_opts