File Manager

003 File Manager

Current Path: /usr/local/lib/python3.8/site-packages/salt/utils

usr / local / lib / python3.8 / site-packages / salt / utils /

📁 ..
📄 __init__.py(237 B)
📁 __pycache__
📄 aggregation.py(5.17 KB)
📄 args.py(19.86 KB)
📄 asynchronous.py(4.07 KB)
📄 atomicfile.py(5.33 KB)
📄 aws.py(19.38 KB)
📄 azurearm.py(11.38 KB)
📄 beacons.py(517 B)
📄 boto3_elasticsearch.py(3.73 KB)
📄 boto3mod.py(8.36 KB)
📄 boto_elb_tag.py(3.02 KB)
📄 botomod.py(7.98 KB)
📄 cache.py(9.81 KB)
📄 cloud.py(117.04 KB)
📄 color.py(2.72 KB)
📄 compat.py(1.81 KB)
📄 configcomparer.py(3.88 KB)
📄 configparser.py(10.82 KB)
📄 context.py(6.8 KB)
📄 crypt.py(4.71 KB)
📄 ctx.py(1.42 KB)
📄 data.py(49.28 KB)
📄 dateutils.py(2.31 KB)
📄 debug.py(4.19 KB)
📁 decorators
📄 dictdiffer.py(14.16 KB)
📄 dicttrim.py(3.9 KB)
📄 dictupdate.py(11.33 KB)
📄 dns.py(35.17 KB)
📄 doc.py(2.25 KB)
📁 dockermod
📄 entrypoints.py(2.28 KB)
📄 environment.py(2.2 KB)
📄 error.py(1.18 KB)
📄 etcd_util.py(14.22 KB)
📄 event.py(52.3 KB)
📄 extend.py(8.87 KB)
📄 extmods.py(5.67 KB)
📄 filebuffer.py(3.15 KB)
📄 files.py(27.6 KB)
📄 find.py(22.09 KB)
📄 fsutils.py(3.29 KB)
📄 functools.py(5.02 KB)
📄 gitfs.py(124.49 KB)
📄 github.py(1.52 KB)
📄 gzip_util.py(2.86 KB)
📄 hashutils.py(5.91 KB)
📄 http.py(34.36 KB)
📄 iam.py(1.22 KB)
📄 icinga2.py(754 B)
📄 idem.py(1.22 KB)
📄 immutabletypes.py(2.46 KB)
📄 itertools.py(2.36 KB)
📄 jid.py(3 KB)
📄 jinja.py(31.33 KB)
📄 job.py(6.01 KB)
📄 json.py(3.78 KB)
📄 kickstart.py(41.04 KB)
📄 kinds.py(493 B)
📄 lazy.py(3.06 KB)
📄 listdiffer.py(10.9 KB)
📄 locales.py(2.06 KB)
📄 mac_utils.py(14.01 KB)
📄 mako.py(3.63 KB)
📄 master.py(29.57 KB)
📄 mattermost.py(1.77 KB)
📄 memcached.py(3.56 KB)
📄 migrations.py(1.46 KB)
📄 mine.py(3.68 KB)
📄 minion.py(4.13 KB)
📄 minions.py(43.11 KB)
📄 mount.py(1.15 KB)
📄 msazure.py(5.36 KB)
📄 msgpack.py(4.69 KB)
📄 nacl.py(13.58 KB)
📄 namecheap.py(4.32 KB)
📄 napalm.py(23.79 KB)
📄 nb_popen.py(7.24 KB)
📄 network.py(71.06 KB)
📄 nxos.py(12.94 KB)
📄 nxos_api.py(4 KB)
📄 odict.py(13.16 KB)
📁 openstack
📄 oset.py(6.41 KB)
📄 pagerduty.py(3.03 KB)
📄 parsers.py(125.31 KB)
📄 path.py(10.78 KB)
📄 pbm.py(9.81 KB)
📁 pkg
📄 platform.py(5.16 KB)
📄 powershell.py(4.15 KB)
📄 preseed.py(2.64 KB)
📄 process.py(43.34 KB)
📄 profile.py(3.21 KB)
📄 proxy.py(331 B)
📄 psutil_compat.py(3.65 KB)
📄 pushover.py(4.51 KB)
📄 pycrypto.py(5.39 KB)
📄 pydsl.py(13.74 KB)
📄 pyobjects.py(10.75 KB)
📄 reactor.py(19.09 KB)
📄 reclass.py(752 B)
📄 roster_matcher.py(3.55 KB)
📄 rsax931.py(8.07 KB)
📄 s3.py(8.78 KB)
📄 saltclass.py(14.27 KB)
📄 sanitizers.py(2.51 KB)
📄 schedule.py(70.67 KB)
📄 schema.py(54.26 KB)
📄 sdb.py(4.04 KB)
📄 slack.py(3.57 KB)
📄 smb.py(11.16 KB)
📄 smtp.py(3.27 KB)
📄 ssdp.py(14.75 KB)
📄 ssh.py(769 B)
📄 state.py(8.43 KB)
📄 stringio.py(355 B)
📄 stringutils.py(16.63 KB)
📄 systemd.py(5.51 KB)
📄 templates.py(23.92 KB)
📄 textformat.py(5.03 KB)
📄 thin.py(31.64 KB)
📄 timed_subprocess.py(4.06 KB)
📄 timeout.py(1.53 KB)
📄 timeutil.py(2.4 KB)
📄 url.py(4.96 KB)
📄 user.py(10.92 KB)
📁 validate
📄 value.py(247 B)
📄 vault.py(19.23 KB)
📄 verify.py(26.97 KB)
📄 versions.py(16.32 KB)
📄 virt.py(3.24 KB)
📄 virtualbox.py(22.43 KB)
📄 vmware.py(129.74 KB)
📄 vsan.py(17.18 KB)
📄 vt.py(30.25 KB)
📄 vt_helper.py(4.4 KB)
📄 win_chcp.py(3.7 KB)
📄 win_dacl.py(94.69 KB)
📄 win_dotnet.py(4.75 KB)
📄 win_functions.py(12.69 KB)
📄 win_lgpo_auditpol.py(8.48 KB)
📄 win_lgpo_netsh.py(17.87 KB)
📄 win_network.py(12.41 KB)
📄 win_osinfo.py(2.83 KB)
📄 win_pdh.py(13.85 KB)
📄 win_reg.py(30.05 KB)
📄 win_runas.py(10.55 KB)
📄 win_service.py(5.2 KB)
📄 win_system.py(14.47 KB)
📄 win_update.py(40.36 KB)
📄 winapi.py(818 B)
📄 xdg.py(316 B)
📄 xmlutil.py(13.91 KB)
📄 yaml.py(348 B)
📄 yamldumper.py(3.38 KB)
📄 yamlencoding.py(1.55 KB)
📄 yamlloader.py(6.21 KB)
📄 yamlloader_old.py(8.33 KB)
📄 yast.py(619 B)
📄 zeromq.py(1.65 KB)
📄 zfs.py(19.2 KB)

Editing: win_lgpo_netsh.py

r"""
A salt util for modifying firewall settings.

.. versionadded:: 2018.3.4
.. versionadded:: 2019.2.0

This util allows you to modify firewall settings in the local group policy in
addition to the normal firewall settings. Parameters are taken from the
netsh advfirewall prompt.

.. note::
    More information can be found in the advfirewall context in netsh. This can
    be access by opening a netsh prompt. At a command prompt type the following:

c:\>netsh
    netsh>advfirewall
    netsh advfirewall>set help
    netsh advfirewall>set domain help

Usage:

.. code-block:: python

import salt.utils.win_lgpo_netsh

# Get the inbound/outbound firewall settings for connections on the
    # local domain profile
    salt.utils.win_lgpo_netsh.get_settings(profile='domain',
                                           section='firewallpolicy')

# Get the inbound/outbound firewall settings for connections on the
    # domain profile as defined by local group policy
    salt.utils.win_lgpo_netsh.get_settings(profile='domain',
                                           section='firewallpolicy',
                                           store='lgpo')

# Get all firewall settings for connections on the domain profile
    salt.utils.win_lgpo_netsh.get_all_settings(profile='domain')

# Get all firewall settings for connections on the domain profile as
    # defined by local group policy
    salt.utils.win_lgpo_netsh.get_all_settings(profile='domain', store='lgpo')

# Get all firewall settings for all profiles
    salt.utils.win_lgpo_netsh.get_all_settings()

# Get all firewall settings for all profiles as defined by local group
    # policy
    salt.utils.win_lgpo_netsh.get_all_settings(store='lgpo')

# Set the inbound setting for the domain profile to block inbound
    # connections
    salt.utils.win_lgpo_netsh.set_firewall_settings(profile='domain',
                                                    inbound='blockinbound')

# Set the outbound setting for the domain profile to allow outbound
    # connections
    salt.utils.win_lgpo_netsh.set_firewall_settings(profile='domain',
                                                    outbound='allowoutbound')

# Set inbound/outbound settings for the domain profile in the group
    # policy to block inbound and allow outbound
    salt.utils.win_lgpo_netsh.set_firewall_settings(profile='domain',
                                                    inbound='blockinbound',
                                                    outbound='allowoutbound',
                                                    store='lgpo')
"""

import logging
import os
import re
import socket
import tempfile
from textwrap import dedent

import salt.modules.cmdmod
from salt.exceptions import CommandExecutionError

log = logging.getLogger(__name__)
__hostname__ = socket.gethostname()
__virtualname__ = "netsh"

# Although utils are often directly imported, it is also possible to use the
# loader.
def __virtual__():
    """
    Only load if on a Windows system
    """
    if not salt.utils.platform.is_windows():
        return False, "This utility only available on Windows"

return __virtualname__

def _netsh_file(content):
    """
    helper function to get the results of ``netsh -f content.txt``

Running ``netsh`` will drop you into a ``netsh`` prompt where you can issue
    ``netsh`` commands. You can put a series of commands in an external file and
    run them as if from a ``netsh`` prompt using the ``-f`` switch. That's what
    this function does.

Args:

content (str):
            The contents of the file that will be run by the ``netsh -f``
            command

Returns:
        str: The text returned by the netsh command
    """
    with tempfile.NamedTemporaryFile(
        mode="w", prefix="salt-", suffix=".netsh", delete=False, encoding="utf-8"
    ) as fp:
        fp.write(content)
    try:
        log.debug("%s:\n%s", fp.name, content)
        return salt.modules.cmdmod.run("netsh -f {}".format(fp.name), python_shell=True)
    finally:
        os.remove(fp.name)

def _netsh_command(command, store):
    if store.lower() not in ("local", "lgpo"):
        raise ValueError("Incorrect store: {}".format(store))
    # set the store for local or lgpo
    if store.lower() == "local":
        netsh_script = dedent(
            """\
            advfirewall
            set store local
            {}
        """.format(
                command
            )
        )
    else:
        netsh_script = dedent(
            """\
            advfirewall
            set store gpo = {}
            {}
        """.format(
                __hostname__, command
            )
        )
    return _netsh_file(content=netsh_script).splitlines()

def get_settings(profile, section, store="local"):
    """
    Get the firewall property from the specified profile in the specified store
    as returned by ``netsh advfirewall``.

Args:

profile (str):
            The firewall profile to query. Valid options are:

- domain
            - public
            - private

section (str):
            The property to query within the selected profile. Valid options
            are:

- firewallpolicy : inbound/outbound behavior
            - logging : firewall logging settings
            - settings : firewall properties
            - state : firewalls state (on | off)

store (str):
            The store to use. This is either the local firewall policy or the
            policy defined by local group policy. Valid options are:

- lgpo
            - local

Default is ``local``

Returns:
        dict: A dictionary containing the properties for the specified profile

Raises:
        CommandExecutionError: If an error occurs
        ValueError: If the parameters are incorrect
    """
    # validate input
    if profile.lower() not in ("domain", "public", "private"):
        raise ValueError("Incorrect profile: {}".format(profile))
    if section.lower() not in ("state", "firewallpolicy", "settings", "logging"):
        raise ValueError("Incorrect section: {}".format(section))
    if store.lower() not in ("local", "lgpo"):
        raise ValueError("Incorrect store: {}".format(store))
    command = "show {}profile {}".format(profile, section)
    # run it
    results = _netsh_command(command=command, store=store)
    # sample output:
    # Domain Profile Settings:
    # ----------------------------------------------------------------------
    # LocalFirewallRules                    N/A (GPO-store only)
    # LocalConSecRules                      N/A (GPO-store only)
    # InboundUserNotification               Disable
    # RemoteManagement                      Disable
    # UnicastResponseToMulticast            Enable

# if it's less than 3 lines it failed
    if len(results) < 3:
        raise CommandExecutionError("Invalid results: {}".format(results))
    ret = {}
    # Skip the first 2 lines. Add everything else to a dictionary
    for line in results[3:]:
        ret.update(dict(list(zip(*[iter(re.split(r"\s{2,}", line))] * 2))))

# Remove spaces from the values so that `Not Configured` is detected
    # correctly
    for item in ret:
        ret[item] = ret[item].replace(" ", "")

# special handling for firewallpolicy
    if section == "firewallpolicy":
        inbound, outbound = ret["Firewall Policy"].split(",")
        return {"Inbound": inbound, "Outbound": outbound}

return ret

def get_all_settings(profile, store="local"):
    """
    Gets all the properties for the specified profile in the specified store

Args:

profile (str):
            The firewall profile to query. Valid options are:

- domain
            - public
            - private

store (str):
            The store to use. This is either the local firewall policy or the
            policy defined by local group policy. Valid options are:

- lgpo
            - local

Default is ``local``

Returns:
        dict: A dictionary containing the specified settings
    """
    ret = dict()
    ret.update(get_settings(profile=profile, section="state", store=store))
    ret.update(get_settings(profile=profile, section="firewallpolicy", store=store))
    ret.update(get_settings(profile=profile, section="settings", store=store))
    ret.update(get_settings(profile=profile, section="logging", store=store))
    return ret

def get_all_profiles(store="local"):
    """
    Gets all properties for all profiles in the specified store

Args:

store (str):
            The store to use. This is either the local firewall policy or the
            policy defined by local group policy. Valid options are:

- lgpo
            - local

Default is ``local``

Returns:
        dict: A dictionary containing the specified settings for each profile
    """
    return {
        "Domain Profile": get_all_settings(profile="domain", store=store),
        "Private Profile": get_all_settings(profile="private", store=store),
        "Public Profile": get_all_settings(profile="public", store=store),
    }

def set_firewall_settings(profile, inbound=None, outbound=None, store="local"):
    """
    Set the firewall inbound/outbound settings for the specified profile and
    store

Args:

profile (str):
            The firewall profile to configure. Valid options are:

- domain
            - public
            - private

inbound (str):
            The inbound setting. If ``None`` is passed, the setting will remain
            unchanged. Valid values are:

- blockinbound
            - blockinboundalways
            - allowinbound
            - notconfigured

Default is ``None``

outbound (str):
            The outbound setting. If ``None`` is passed, the setting will remain
            unchanged. Valid values are:

- allowoutbound
            - blockoutbound
            - notconfigured

Default is ``None``

store (str):
            The store to use. This is either the local firewall policy or the
            policy defined by local group policy. Valid options are:

- lgpo
            - local

Default is ``local``

Returns:
        bool: ``True`` if successful

# You have to specify inbound and outbound setting at the same time
    # If you're only specifying one, you have to get the current setting for the
    # other
    if not inbound or not outbound:
        ret = get_settings(profile=profile, section="firewallpolicy", store=store)
        if not inbound:
            inbound = ret["Inbound"]
        if not outbound:
            outbound = ret["Outbound"]

command = "set {}profile firewallpolicy {},{}".format(profile, inbound, outbound)

results = _netsh_command(command=command, store=store)

if results:
        raise CommandExecutionError("An error occurred: {}".format(results))

return True

def set_logging_settings(profile, setting, value, store="local"):
    """
    Configure logging settings for the Windows firewall.

Args:

profile (str):
            The firewall profile to configure. Valid options are:

- domain
            - public
            - private

setting (str):
            The logging setting to configure. Valid options are:

- allowedconnections
            - droppedconnections
            - filename
            - maxfilesize

value (str):
            The value to apply to the setting. Valid values are dependent upon
            the setting being configured. Valid options are:

allowedconnections:

- enable
                - disable
                - notconfigured

droppedconnections:

- enable
                - disable
                - notconfigured

filename:

- Full path and name of the firewall log file
                - notconfigured

maxfilesize:

- 1 - 32767 (Kb)
                - notconfigured

store (str):
            The store to use. This is either the local firewall policy or the
            policy defined by local group policy. Valid options are:

- lgpo
            - local

Default is ``local``

Returns:
        bool: ``True`` if successful

Raises:
        CommandExecutionError: If an error occurs
        ValueError: If the parameters are incorrect
    """
    # Input validation
    if profile.lower() not in ("domain", "public", "private"):
        raise ValueError("Incorrect profile: {}".format(profile))
    if setting.lower() not in (
        "allowedconnections",
        "droppedconnections",
        "filename",
        "maxfilesize",
    ):
        raise ValueError("Incorrect setting: {}".format(setting))
    if setting.lower() in ("allowedconnections", "droppedconnections"):
        if value.lower() not in ("enable", "disable", "notconfigured"):
            raise ValueError("Incorrect value: {}".format(value))
    # TODO: Consider adding something like the following to validate filename
    # https://stackoverflow.com/questions/9532499/check-whether-a-path-is-valid-in-python-without-creating-a-file-at-the-paths-ta
    if setting.lower() == "maxfilesize":
        if value.lower() != "notconfigured":
            # Must be a number between 1 and 32767
            try:
                int(value)
            except ValueError:
                raise ValueError("Incorrect value: {}".format(value))
            if not 1 <= int(value) <= 32767:
                raise ValueError("Incorrect value: {}".format(value))
    # Run the command
    command = "set {}profile logging {} {}".format(profile, setting, value)
    results = _netsh_command(command=command, store=store)

# A successful run should return an empty list
    if results:
        raise CommandExecutionError("An error occurred: {}".format(results))

return True

def set_settings(profile, setting, value, store="local"):
    """
    Configure firewall settings.

Args:

profile (str):
            The firewall profile to configure. Valid options are:

- domain
            - public
            - private

setting (str):
            The firewall setting to configure. Valid options are:

- localfirewallrules
            - localconsecrules
            - inboundusernotification
            - remotemanagement
            - unicastresponsetomulticast

value (str):
            The value to apply to the setting. Valid options are

- enable
            - disable
            - notconfigured

store (str):
            The store to use. This is either the local firewall policy or the
            policy defined by local group policy. Valid options are:

- lgpo
            - local

Default is ``local``

Returns:
        bool: ``True`` if successful

# Run the command
    command = "set {}profile settings {} {}".format(profile, setting, value)
    results = _netsh_command(command=command, store=store)

# A successful run should return an empty list
    if results:
        raise CommandExecutionError("An error occurred: {}".format(results))

return True

def set_state(profile, state, store="local"):
    """
    Configure the firewall state.

Args:

profile (str):
            The firewall profile to configure. Valid options are:

- domain
            - public
            - private

state (str):
            The firewall state. Valid options are:

- on
            - off
            - notconfigured

store (str):
            The store to use. This is either the local firewall policy or the
            policy defined by local group policy. Valid options are:

- lgpo
            - local

Default is ``local``

Returns:
        bool: ``True`` if successful

# Run the command
    command = "set {}profile state {}".format(profile, state)
    results = _netsh_command(command=command, store=store)

# A successful run should return an empty list
    if results:
        raise CommandExecutionError("An error occurred: {}".format(results))

return True

003 File Manager

Editing: win_lgpo_netsh.py

Upload File

Create Folder