yast/yast-yast2

#
# ***************************************************************************
#
# Copyright (c) 2018 SUSE LLC.
# All Rights Reserved.
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of version 2 or 3 of the GNU General
# Public License 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, contact SUSE LLC.
#
# To contact SUSE about this file by physical or electronic mail,
# you may find current contact information at www.suse.com
#
# ***************************************************************************

module Y2Firewall
  class Firewalld
    class Api
      # This module contains specific API methods for handling zones
      # configuration.
      module Zones
        # @return [Array<String>] List of firewall zones
        def zones
          string_command("--get-zones").split
        end

        # Create the given zone in firewalld. New zones must be created
        # permanently
        #
        # @param zone [String] The firewall zone name
        def create_zone(zone)
          modify_command("--new-zone=#{zone}", permanent: !offline?)
        end

        # Delete the given zone from firewalld. Deleted zones must be deleted
        # permanently
        #
        # @param zone [String] The firewall zone name to be deleted
        def delete_zone(zone)
          modify_command("--delete-zone=#{zone}", permanent: !offline?)
        end

        # @param zone [String] The firewall zone
        # @param permanent [Boolean] if true and firewalld is running it
        #   reads the permanent configuration
        # @return [Array<String>] list of zone's interfaces
        def list_interfaces(zone, permanent: permanent?)
          string_command("--zone=#{zone}", "--list-interfaces", permanent: permanent).split
        end

        # @param zone [String] The firewall zone
        # @param permanent [Boolean] if true and firewalld is running it
        #   reads the permanent configuration
        # @return [Arrray<String>] list of zone's services
        def list_services(zone, permanent: permanent?)
          string_command("--zone=#{zone}", "--list-services", permanent: permanent).split
        end

        # @param zone [String] The firewall zone
        # @param permanent [Boolean] if true and firewalld is running it
        #   reads the permanent configuration
        # @return [Array<String>] list of zone's ports
        def list_ports(zone, permanent: permanent?)
          string_command("--zone=#{zone}", "--list-ports", permanent: permanent).split
        end

        # @param zone [String] The firewall zone
        # @param permanent [Boolean] if true and firewalld is running it
        #   reads the permanent configuration
        # @return [Array<String>] list of zone's protocols
        def list_protocols(zone, permanent: permanent?)
          string_command("--zone=#{zone}", "--list-protocols", permanent: permanent).split
        end

        # @param zone [String] The firewall zone
        # @param permanent [Boolean] if true and firewalld is running it
        #   reads the permanent configuration
        # @return [Array<String>] list of all information for given zone
        def list_all(zone, permanent: permanent?, verbose: false)
          args = ["--zone=#{zone}", "--list-all"]
          args << "--verbose" if verbose

          string_command(*args, permanent: permanent).split
        end

        # @param permanent [Boolean] if true and firewalld is running it
        #   reads the permanent configuration
        # @return [Array<String>] list of all information for all firewall zones
        def list_all_zones(permanent: permanent?, verbose: false)
          args = ["--list-all-zones"]
          args << "--verbose" if verbose

          string_command(*args, permanent: permanent).split("\n")
        end

        ### Interfaces ###

        # Return the name of the zone the interface belongs to or nil.
        #
        # @param interface [String] interface name
        # @param permanent [Boolean] if true and firewalld is running it
        #   reads the permanent configuration
        # @return [String, nil] the interface zone or nil
        def interface_zone(interface, permanent: permanent?)
          string_command("--get-zone-of-interface=#{interface}", permanent: permanent)
        end

        # @param zone [String] The firewall zone
        # @param permanent [Boolean] if true and firewalld is running it
        #   reads the permanent configuration
        # @param interface [String] The network interface
        # @return [Boolean] True if interface is assigned to zone
        def interface_enabled?(zone, interface, permanent: permanent?)
          query_command("--zone=#{zone}", "--query-interface=#{interface}", permanent: permanent)
        end

        # @param zone [String] The firewall zone
        # @param interface [String] The network interface
        # @param permanent [Boolean] if true and firewalld is running it
        #   modifies the permanent configuration
        # @return [Boolean] True if interface was added to zone
        def add_interface(zone, interface, permanent: permanent?)
          modify_command("--zone=#{zone}", "--add-interface=#{interface}",
            permanent: permanent)
        end

        # @param zone [String] The firewall zone
        # @param interface [String] The network interface
        # @param permanent [Boolean] if true and firewalld is running it
        #   modifies the permanent configuration
        # @return [Boolean] True if the interface was removed from the zone
        def remove_interface(zone, interface, permanent: permanent?)
          modify_command("--zone=#{zone}", "--remove-interface=#{interface}", permanent: permanent)
        end

        # @param zone [String] The firewall zone
        # @param interface [String] The network interface
        # @param permanent [Boolean] if true and firewalld is running it
        #   modifies the permanent configuration
        # @return [Boolean] True if interface was changed
        def change_interface(zone, interface, permanent: permanent?)
          modify_command("--zone=#{zone}", "--change-interface=#{interface}",
            permanent: permanent)
        end

        # @param zone [String] The firewall zone
        # @param service [String] The firewall service
        # @return [Boolean] True if service is enabled in zone
        def service_enabled?(zone, service, permanent: permanent?)
          query_command("--zone=#{zone}", "--query-service=#{service}", permanent: permanent)
        end

        # @param zone [String] The firewall zone
        # @param port [String] The firewall port
        # @return [Boolean] True if port is enabled in zone
        def port_enabled?(zone, port, permanent: permanent?)
          query_command("--zone=#{zone}", "--query-port=#{port}", permanent: permanent)
        end

        # @param zone [String] The firewall zone
        # @param protocol [String] The zone protocol
        # @return [Boolean] True if protocol is enabled in zone
        def protocol_enabled?(zone, protocol, permanent: permanent?)
          query_command("--zone=#{zone}", "--query-protocol=#{protocol}", permanent: permanent)
        end

        # @param zone [String] The firewall zone
        # @param service [String] The firewall service
        # @param permanent [Boolean] if true and firewalld is running it
        #   modifies the permanent configuration
        # @return [Boolean] True if service was added to zone
        def add_service(zone, service, permanent: permanent?)
          modify_command("--zone=#{zone}", "--add-service=#{service}", permanent: permanent)
        end

        # @param zone [String] The firewall zone
        # @param port [String] The firewall port
        # @param permanent [Boolean] if true and firewalld is running it
        #   modifies the permanent configuration
        # @return [Boolean] True if port was added to zone
        def add_port(zone, port, permanent: permanent?)
          modify_command("--zone=#{zone}", "--add-port=#{port}", permanent: permanent)
        end

        # @param zone [String] The firewall zone
        # @param protocol [String] The firewall protocol
        # @param permanent [Boolean] if true and firewalld is running it
        #   modifies the permanent configuration
        # @return [Boolean] True if protocol was added to zone
        def add_protocol(zone, protocol, permanent: permanent?)
          modify_command("--zone=#{zone}", "--add-protocol=#{protocol}", permanent: permanent)
        end

        # @param zone [String] The firewall zone
        # @param service [String] The firewall service
        # @param permanent [Boolean] if true and firewalld is running it
        #   modifies the permanent configuration
        # @return [Boolean] True if service was removed from zone
        def remove_service(zone, service, permanent: permanent?)
          remove_arg = offline? ? "--remove-service-from-zone" : "--remove-service"
          modify_command("--zone=#{zone}", "#{remove_arg}=#{service}", permanent: permanent)
        end

        # @param zone [String] The firewall zone
        # @param port [String] The firewall port
        # @param permanent [Boolean] if true and firewalld is running it
        #   modifies the permanent configuration
        # @return [Boolean] True if port was removed from zone
        def remove_port(zone, port, permanent: permanent?)
          modify_command("--zone=#{zone}", "--remove-port=#{port}", permanent: permanent)
        end

        # @param zone [String] The firewall zone
        # @param protocol [String] The firewall protocol
        # @param permanent [Boolean] if true and firewalld is running it
        #   modifies the permanent configuration
        # @return [Boolean] True if protocol was removed from zone
        def remove_protocol(zone, protocol, permanent: permanent?)
          modify_command("--zone=#{zone}", "--remove-protocol=#{protocol}", permanent: permanent)
        end

        # @param zone [String] The firewall zone
        # @param permanent [Boolean] if true and firewalld is running it
        #   reads the permanent configuration
        # @return [Boolean] True if masquerade is enabled in zone
        def masquerade_enabled?(zone, permanent: permanent?)
          query_command("--zone=#{zone}", "--query-masquerade", permanent: permanent)
        end

        # @param zone [String] The firewall zone
        # @param permanent [Boolean] if true and firewalld is running it
        #   modifies the permanent configuration
        # @return [Boolean] True if masquerade was enabled in zone
        def add_masquerade(zone, permanent: permanent?)
          return true if masquerade_enabled?(zone, permanent: permanent)

          modify_command("--zone=#{zone}", "--add-masquerade", permanent: permanent)
        end

        # @param zone [String] The firewall zone
        # @param permanent [Boolean] if true and firewalld is running it
        #   modifies the permanent configuration
        # @return [Boolean] True if masquerade was removed in zone
        def remove_masquerade(zone, permanent: permanent?)
          return true unless masquerade_enabled?(zone, permanent: permanent)

          modify_command("--zone=#{zone}", "--remove-masquerade", permanent: permanent)
        end

        # Enable or disable masquerade in the zone
        #
        # @param zone [String] The firewall zone
        # @param enabled [Boolean] whether masquerade should be enabled or not
        # @return [Boolean] whether masquerade was modified or not
        def modify_masquerade(zone, enabled)
          method = enabled ? "add_masquerade" : "remove_masquerade"

          public_send(method, zone, permanent: !offline?)
        end

        # Full name or short description of the zone
        #
        # @param zone [String] The firewall zone
        def short(zone)
          string_command("--zone=#{zone}", "--get-short", permanent: !offline?)
        end

        # Modify the full name or short description of the zone
        #
        # @param zone [String] The firewall zone
        # @param short_description [String] the new zone name or description
        # @return [Boolean] true if the short description was modified
        def modify_short(zone, short_description)
          modify_command("--zone=#{zone}", "--set-short=#{short_description}",
            permanent: !offline?)
        end

        # Long description of the zone
        #
        # @param zone [String] The firewall zone
        def description(zone)
          string_command("--zone=#{zone}", "--get-description", permanent: !offline?)
        end

        # Modify the long description of the zone
        #
        # @param zone [String] The firewall zone
        # @param long_description [String] the new zone description
        # @return [Boolean] true if the long description was modified
        def modify_description(zone, long_description)
          modify_command("--zone=#{zone}", "--set-description=#{long_description}",
            permanent: !offline?)
        end

        # The target of the zone
        #
        # @param zone [String] The firewall zone
        def target(zone)
          string_command("--zone=#{zone}", "--get-target", permanent: !offline?)
        end

        # Modify the current target of the zone
        #
        # @param zone [String] The firewall zone
        # @param target [String] the new target
        # @return [Boolean] true if the zone target was modified
        def modify_target(zone, target)
          modify_command("--zone=#{zone}", "--set-target=#{target}", permanent: !offline?)
        end
      end
    end
  end
end