NSIS Simple Firewall Plugin

From NSIS Wiki
Jump to navigationJump to search

This plugin can be used to configure the Windows firewall. This plugin contains functions to enable, check, add or remove programs or ports to the firewall exception list. It also contains functions for checking the firewall status, enable or disable the firewall and so on.


This plugin is using the MPL License or alternatively the LGPL License.


Links

The ZIP file containing a precompiled plugin DLL (to be saved in NSIS' plugin directory) and the sources. If you update from a previous version it is strongly recommend to take look at the changelog.

Donation

If you believe that I am doing a good job and you want to support me please donate any amount via PayPal.

Short Reference

SimpleFC::EnableDisableFirewall [status]
SimpleFC::IsFirewallEnabled  
 
SimpleFC::AllowDisallowExceptionsNotAllowed [status]
SimpleFC::AreExceptionsNotAllowed  
 
SimpleFC::EnableDisableNotifications [status]
SimpleFC::AreNotificationsEnabled  
 
SimpleFC::StartStopFirewallService [status]
SimpleFC::IsFirewallServiceRunning  
 
SimpleFC::AddPort [port] [name] [protocol] [scope] [ip_version] [remote_addresses] [status]
SimpleFC::IsPortAdded [port] [protocol]
SimpleFC::RemovePort [port] [protocol]
 
SimpleFC::IsPortEnabled [port] [protocol]
SimpleFC::EnableDisablePort [port] [protocol]
 
SimpleFC::AddApplication [name] [path] [scope] [ip_version] [remote_addresses] [status]
SimpleFC::IsApplicationAdded [path]
SimpleFC::RemoveApplication [path]
 
SimpleFC::IsApplicationEnabled [path]
SimpleFC::EnableDisableApplication [path]
 
SimpleFC::RestoreDefaults

SimpleFC::AllowDisallowIcmpOutboundDestinationUnreachable [status]
SimpleFC::AllowDisallowIcmpRedirect [status]
SimpleFC::AllowDisallowIcmpInboundEchoRequest [status]
SimpleFC::AllowDisallowIcmpOutboundTimeExceeded [status]
SimpleFC::AllowDisallowIcmpOutboundParameterProblem [status]
SimpleFC::AllowDisallowIcmpOutboundSourceQuench [status]
SimpleFC::AllowDisallowIcmpInboundRouterRequest [status]
SimpleFC::AllowDisallowIcmpInboundTimestampRequest [status]
SimpleFC::AllowDisallowIcmpInboundMaskRequest [status]
SimpleFC::AllowDisallowIcmpOutboundPacketTooBig [status]
SimpleFC::IsIcmpTypeAllowed [ip_version] [local_address] [icmp_type]
 
SimpleFC::AdvAddRule [name] [description] [protocol] [direction] 
  [status] [profile] [action] [application] [service_name] [icmp_types_and_codes] 
  [group] [local_ports] [remote_ports] [local_address] [remote_address]
SimpleFC::AdvRemoveRule [name]
SimpleFC::AdvExistsRule [name]


Parameters:

  • port - TCP/UDP port which should be opened/closed
  • name - The name of the application/port/rule
  • description - Description of the rule
  • protocol - One of the following protocol
    • 1 - ICMPv4
    • 6 - TCP
    • 17 - UDP
    • 58 - ICMPv6
    • 256 - Any protocol
  • scope - One of the following scope
    • 0 - All networks
    • 1 - Only local subnets
    • 2 - Custom scope
    • 3 - Max scope
    • NOTE: If you use custom you must define remote_addresses
  • ip_version
    • 0 - IPv4
    • 1 - IPv6
    • 2 - Any version
  • icmp_type
    • 3 - Outbound Destination Unreachable (ICMPv4)
    • 4 - Outbound Source Quench (ICMPv4)
    • 5 - Redirect (ICMPv4)
    • 8 - Inbound Echo Request (ICMPv4)
    • 9 - Inbound Router Request (ICMPv4)
    • 11 - Outbound Time Exceeded (ICMPv4)
    • 12 - Outbound Parameter Problem (ICMPv4)
    • 13 - Inbound Timespamp Request (ICMPv4)
    • 17 - Inbound Mask Request (ICMPv4)
    • 1 - Outbound Destination Unreachable (ICMPv6)
    • 2 - Outbound Packet Too Big (ICMPv6)
    • 3 - Outbound Time Exceeded (ICMPv6)
    • 4 - Outbound Parameter Problem (ICMPv6)
    • 128 - Inbound Echo Request (ICMPv6)
    • 137 - Redirect (ICMPv6)
  • direction
    • 1 - In
    • 2 - Out
  • profile
    • 1 - Domain
    • 2 - Private
    • 4 - Public
    • 2147483647 - All profiles
  • action
    • 0 - Block
    • 1 - Allow
  • application - Path of the application (can be empty)

servicename - Specifies the service name property of the application (can be empty).

    • Note: A serviceName value of "*" indicates that a service, not an application, must be sending or receiving traffic.
  • icmp_types_and_codes - Specified icmp types and codes (can be empty)
  • group - Put the rule in this specified group (can be empty)
    • Note: On Vista the group must the a resource string in a exe/dll e.g. "@C:\Program Files\My Application\myapp.exe,-10000". On all other supported operating systems it can be a string value.
  • local_ports - Local ports (The protocol property must be set before - Otherwise can be empty)
    • Note: The following port keywords are valid addionally: "RPC", "RPC-EPMap", "Teredo", "IPTLSIn", "IPHTTPSIn" and "Ply2Disc"
  • remote_ports - Remote ports (The protocol property must be set before - Otherwise can be empty)
    • Note: The following port keywords are valid addionally: "RPC", "RPC-EPMap", "Teredo", "IPTLSIn", "IPHTTPSIn" and "Ply2Disc"
  • local_address - Local addresses from which the port can listen for traffic (can be empty)
  • remote_address - Remote addresses from which the port can listen for traffic (can be empty)
  • status - Status of the port, application, rule, firewall or service for example enabled/disabled, start/stop or allow/disallow
    • 0 - Disabled, stop or disallow
    • 1 - Enabled, start, or allow

The Sample Script

In this script you can find the two most used functions. If you are searching for some special firewall exceptions please look at "The Sample Script (All Functions)". 

; Add an application to the firewall exception list - All Networks - All IP Version - Enabled
  SimpleFC::AddApplication "My Application" "PathToApplication" 0 2 "" 1
  Pop $0 ; return error(1)/success(0)
 
; Remove an application from the firewall exception list
  SimpleFC::RemoveApplication "PathToApplication"
  Pop $0 ; return error(1)/success(0)

The Sample Script (All Functions)

In this script you can find the examples of all functions provided by this plugin. 

; Add the port 37/TCP to the firewall exception list - All Networks - All IP Version - Enabled
  SimpleFC::AddPort 37 "My Application" 6 0 2 "" 1
  Pop $0 ; return error(1)/success(0)
 
; Check if the port 37/TCP is added to the firewall exception list
  SimpleFC::IsPortAdded 37 6
  Pop $0 ; return error(1)/success(0)
  Pop $1 ; return 1=Added/0=Not added
 
; Remove the port 37/TCP from the firewall exception list
  SimpleFC::RemovePort 37 6
  Pop $0 ; return error(1)/success(0)
 
; Check if the port 37/TCP is enabled/disabled
  SimpleFC::IsPortEnabled 37 6
  Pop $0 ; return error(1)/success(0)
  Pop $1 ; return 1=Enabled/0=Not enabled
 
; Disable the port 37/TCP
  SimpleFC::EnableDisablePort 37 6 0
  Pop $0 ; return error(1)/success(0)
 
; Enable the port 37/TCP
  SimpleFC::EnableDisablePort 37 6 1
  Pop $0 ; return error(1)/success(0)
 
; Check if an application is enabled/disabled
  SimpleFC::IsApplicationEnabled "PathToApplication" 
  Pop $0 ; return error(1)/success(0)
  Pop $1 ; return 1=Enabled/0=Not enabled
 
; Disable the application
  SimpleFC::EnableDisableApplication "PathToApplication" 0
  Pop $0 ; return error(1)/success(0)
 
; Enable the application
  SimpleFC::EnableDisableApplication "PathToApplication" 1
  Pop $0 ; return error(1)/success(0)
 
; Add an application to the firewall exception list - All Networks - All IP Version - Enabled
  SimpleFC::AddApplication "My Application" "PathToApplication" 0 2 "" 1
  Pop $0 ; return error(1)/success(0)
 
; Check if the application is added to the firewall exception list
  SimpleFC::IsApplicationAdded "PathToApplication"
  Pop $0 ; return error(1)/success(0)
  Pop $1 ; return 1=Added/0=Not added
 
; Remove an application from the firewall exception list
  SimpleFC::RemoveApplication "PathToApplication"
  Pop $0 ; return error(1)/success(0)
 
; Disable the windows firewall
  SimpleFC::EnableDisableFirewall 0
  Pop $0 ; return error(1)/success(0)
 
; Enable the windows firewall
  SimpleFC::EnableDisableFirewall 1
  Pop $0 ; return error(1)/success(0)
 
; Check if the firewall is enabled
  SimpleFC::IsFirewallEnabled 
  Pop $0 ; return error(1)/success(0)
  Pop $1 ; return 1=Enabled/0=Disabled
 
; Enable exceptions are not allowed on the windows firewall
  SimpleFC::AllowDisallowExceptionsNotAllowed 1
  Pop $0 ; return error(1)/success(0)
 
; Disable exceptions are not allowed on the windows firewall
  SimpleFC::AllowDisallowExceptionsNotAllowed 0
  Pop $0 ; return error(1)/success(0)
 
; Check if exceptions are not allowed
  SimpleFC::AreExceptionsNotAllowed
  Pop $0 ; return error(1)/success(0)
  Pop $1 ; return 1=Exceptions are not allowed is 
         ; activated/0=Exception are not allowed is deactivated
 
; Enable notifications on the windows firewall
  SimpleFC::EnableDisableNotifications 1
 
; Disable notifications on the windows firewall
  SimpleFC::EnableDisableNotifications 0
  Pop $0 ; return error(1)/success(0)
 
; Check if notifications are enabled/disabled
  SimpleFC::AreNotificationsEnabled 
  Pop $0 ; return error(1)/success(0)
  Pop $1 ; return 1=Enabled/0=Disabled
 
; Starts the windows firewall service
  SimpleFC::StartStopFirewallService 1
  Pop $0 ; return error(1)/success(0)
 
; Stops the windows firewall service
  SimpleFC::StartStopFirewallService 0
  Pop $0 ; return error(1)/success(0)
 
; Check if windows firewall service is running
  SimpleFC::IsFirewallServiceRunning
  Pop $0 ; return error(1)/success(0)
  Pop $1 ; return 1=IsRunning/0=Not Running
 
; Sets the windows firewall to default settings
  SimpleFC::RestoreDefaults
  Pop $0 ; return error(1)/success(0)
 
; Enable ICMP outbound destination unreachable state
  SimpleFC::AllowDisallowIcmpOutboundDestinationUnreachable 1
  Pop $0 ; return error(1)/success(0)
 
; Enable ICMP redirect state
  SimpleFC::AllowDisallowIcmpRedirect 1
  Pop $0 ; return error(1)/success(0)
 
; Enable ICMP inbound echo request 
  SimpleFC::AllowDisallowIcmpInboundEchoRequest 1
  Pop $0 ; return error(1)/success(0)
 
; Enable ICMP outbound time exceeded
  SimpleFC::AllowDisallowIcmpOutboundTimeExceeded 1
  Pop $0 ; return error(1)/success(0)
 
; Enable ICMP outbound parameter problem
  SimpleFC::AllowDisallowIcmpOutboundParameterProblem 1
  Pop $0 ; return error(1)/success(0)
 
; Enable ICMP outbound source quench
  SimpleFC::AllowDisallowIcmpOutboundSourceQuench 1
  Pop $0 ; return error(1)/success(0)
 
; Enable ICMP inbound router request
  SimpleFC::AllowDisallowIcmpInboundRouterRequest 1
  Pop $0 ; return error(1)/success(0)
 
; Enable ICMP inbound timestamp request
  SimpleFC::AllowDisallowIcmpInboundTimestampRequest 1
  Pop $0 ; return error(1)/success(0)
 
; Enable ICMP inbound mask request
  SimpleFC::AllowDisallowIcmpInboundMaskRequest 1
  Pop $0 ; return error(1)/success(0)
 
; Enable ICMP outbound packet too big
  SimpleFC::AllowDisallowIcmpOutboundPacketTooBig 1
  Pop $0 ; return error(1)/success(0)
 
; Check if ICMPv4 echo request is allowed
  SimpleFC::IsIcmpTypeAllowed "0" "" "8"
  Pop $0 ; return error(1)/success(0)
  Pop $1 ; return 1=Restricted/0=Not restricted
  Pop $2 ; return 1=Allowed/0=Not allowed 
 
 
; Some example rules for the windows firewall with advanced security.
; Please note this functions are very powerful, so for a detailed 
; description please read the windows firewall with advanced 
; security api reference:
; http://msdn2.microsoft.com/en-us/library/aa365309.aspx
 
; Adds an ICMPv4 rule to allow incoming echo reply messages (IcmpCodeAndType = 0:0)
  SimpleFC::AdvAddRule "Echo-Reply (ICMPv4 incoming)" \
    "Allows incoming Echo Replies messages." "1" "1" "1" "7" "1" "" \ 
    "" "0:0" "@PathToApplication,-10000" "" "" "" ""
  Pop $0 ; return error(1)/success(0)
 
; Adds an ICMPv4 rule to allow incoming echo request messages (IcmpCodeAndType = 8:0)
  SimpleFC::AdvAddRule "Echo-Request (ICMPv4 incoming)" \
    "Allows incoming ICMP Echo messages." "1" "1" "1" "7" "1" "" \
    "" "8:0" "@PathToApplication,-10000" "" "" "" ""
  Pop $0 ; return error(1)/success(0)
 
; Add an application rule to allow incoming TCP access on this application
  SimpleFC::AdvAddRule "Incoming requests (TCP incoming)" \ 
    "Allows incoming requests." "6" "1" "1" "7" "1" "PathToApplication" \ 
    "" "" "@PathToApplication,-10000" "" "" "" ""
  Pop $0 ; return error(1)/success(0)
 
; Add an application rule to allow incoming UDP access on this application
  SimpleFC::AdvAddRule "Incoming requests (UDP incoming)" \
    "Allows incoming requests." "17" "1" "1" "7" "1" "PathToApplication" \ 
    "" "" "@PathToApplication,-10000" "" "" "" ""
  Pop $0 ; return error(1)/success(0)
 
; Removes a firewall rule
  SimpleFC::AdvRemoveRule "Incoming requests (UDP incoming)"
  Pop $0 ; return error(1)/success(0)
 
; Check if the firewall exists
  SimpleFC::AdvExistsRule "Incoming requests (UDP incoming)"
  Pop $0 ; return error(1)/success(0)
  Pop $1 ; return 1=Exists/0=Doesn´t exists

Changelog

  • Version 1.21 (Unicode) (2021-05-04)
    • Unicode Version added with the same functions like the ANSI version.
  • Version 1.21 (ANSI) (2021-05-04)
    • SimpleFC::StartStopFirewallService return now correct false if the service cannot be stopped / started. Hint: In Windows 10 the firewall service is part of the Windows Defender and cannot be stopped / started.
  • Version 1.20 (ANSI) (2014-06-12)
    • Added "ServiceName" parameter to function "AdvAddRule"
    • Documentation updated
  • Version 1.19 (ANSI) (2012-07-16)
    • Documentation updated
  • Version 1.18 (ANSI) (2010-02-23)
    • Documentation updated
  • Version 1.17 (ANSI) (2009-09-05)
    • Added changes from the service manager
    • The following functions are now case insensitive:
      • SimpleFC::IsApplicationAdded
      • SimpleFC::IsApplicationEnabled
      • SimpleFC::EnableDisableApplication
      • SimpleFC::AdvExistsRule
  • Version 1.16 (ANSI) (2009-04-13)
    • Added changes from the service manager
  • Version 1.15 (ANSI) (2008-08-18)
    • Added changes from the service manager and checked removed compiler optimization to avoid a false-positive virusscan.
  • Version 1.14 (ANSI) (2008-02-05)
    • Added changes from the service manager
  • Version 1.13 (ANSI) (2008-01-29)
    • Added changes from the service manager
  • Version 1.12 (ANSI) (2007-11-13)
    • Fixed wrong documentation about SimpleFC::AdvExistsRule
  • Version 1.11 (ANSI) (2007-08-07)
    • Fixed potential endless loop bug in SimpleFC::StartStopFirewallService
  • Version 1.10 (ANSI) (2007-08-02)
    • Added default firewall functions:
      • SimpleFC::RestoreDefaults
      • SimpleFC::AllowDisallowIcmpOutboundDestinationUnreachable
      • SimpleFC::AllowDisallowIcmpRedirect
      • SimpleFC::AllowDisallowIcmpInboundEchoRequest
      • SimpleFC::AllowDisallowIcmpOutboundTimeExceeded
      • SimpleFC::AllowDisallowIcmpOutboundParameterProblem
      • SimpleFC::AllowDisallowIcmpOutboundSourceQuench
      • SimpleFC::AllowDisallowIcmpInboundRouterRequest
      • SimpleFC::AllowDisallowIcmpInboundTimestampRequest
      • SimpleFC::AllowDisallowIcmpInboundMaskRequest
      • SimpleFC::AllowDisallowIcmpOutboundPacketTooBig
      • SimpleFC::IsIcmpTypeAllowed
    • Added functions for Windows Firewall with Advanced Security
      • SimpleFC::AdvAddRule
      • SimpleFC::AdvRemoveRule
      • SimpleFC::AdvExistsRule
  • Version 1.01 (ANSI) (2007-07-05)
    • Changed missing documentation about the function SimpleFC::IsFirewallEnabled
  • Version 1.0 (ANSI) (2007-05-02)
    • First offical version

Important Notes

  • This plugin is running on Windows XP SP2, Windows 2003, Windows Vista, Windows 7, Windows 8, Windows Server 2012, Windows Server 8.1, Windows Server 2012 R2
  • Before you execute some plugin commands it is recommend to check for windows firewall service is running (SimpleFC::IsFirewallServiceRunning).
  • All functions with the prefix "Adv" are only for Windows Firewall with Advanced Security (Windows Vista and above). It is recommend to use these functions on the operating systems which supports the Windows Firewall with Advanced Security. Nethertheless, the default functions without the prefix "Adv" can be used.
  • If you have any suggestions, comments or questions please mail me: mailto:rainer@speed-soft.de
Retrieved from "https://nsis.sourceforge.io/mediawiki/index.php?title=NSIS_Simple_Firewall_Plugin&oldid=25681"