Fortiweb v6.0.2 Cli Reference
Fortiweb v6.0.2 Cli Reference
Fortiweb v6.0.2 Cli Reference
VERSION 6.0.2
FORTINET DOCUMENT LIBRARY
http://docs.fortinet.com
FORTINET VIDEO GUIDE
http://video.fortinet.com
FORTINET BLOG
https://blog.fortinet.com
CUSTOMER SERVICE & SUPPORT
https://support.fortinet.com
http://cookbook.fortinet.com/how-to-work-with-fortinet-support/
FORTIGATE COOKBOOK
http://cookbook.fortinet.com
FORTINET TRAINING SERVICES
http://www.fortinet.com/training
FORTIGUARD CENTER
http://www.fortiguard.com
FEEDBACK
Email: [email protected]
1st Edition
Change log 3
Change log
Change log 3
Introduction 31
Scope 31
Conventions 32
IP addresses 32
Cautions, notes, & tips 32
Typographic conventions 32
Command syntax 33
What’s new 34
Using the CLI 39
Connecting to the CLI 39
Connecting to the CLI using a local console 39
Enabling access to the CLI through the network (SSH or Telnet or CLI Console widget) 40
Connecting to the CLI using SSH 42
Connecting to the CLI using Telnet 43
Command syntax 44
Terminology 44
Indentation 45
Notation 45
Command syntax notation 46
Subcommands 48
Table commands 49
Example of table commands 50
Field commands 50
Example of field commands 51
Permissions 51
Access profile permissions 51
Tips & tricks 54
Help 54
Shortcuts & key commands 54
Command abbreviation 55
Special characters 55
Entering special characters 56
Language support & regular expressions 56
Screen paging 57
Baud rate 58
Editing the configuration file in a text editor 58
Pipeline 'grep' command 59
This document describes how to use the command line interface (CLI) of FortiWeb. It assumes that you have already
successfully deployed FortiWeb and completed basic setup by following the instructions in the FortiWeb Administration
Guide: http://docs.fortinet.com/fortiweb/admin-guides.
Scope
At this stage:
(Undefined variable:
FortinetVariables.ProductName) FortiWeb 5.5 Fortinet Technologies, Inc.
Patch 4 CLI Reference
32
Conventions
IP addresses
To avoid IP conflicts that would occur if you used examples in this document with public IP addresses that belong to a
real organization, the IP addresses used in this document are fictional. They belong to the private IP address ranges
defined by these RFCs.
https://tools.ietf.org/html/rfc1918
RFC 5737: IPv4 Address Blocks Reserved for Documentation
https://tools.ietf.org/html/rfc5737
RFC 3849: IPv6 Address Prefix Reserved for Documentation
https://tools.ietf.org/html/rfc3849
For example, even though a real network’s Internet-facing IP address would be routable on the public Internet, in this
document’s examples, the IP address would be shown as a non-Internet-routable IP such as 192.0.2.108,
198.51.100.155, or 203.0.113.79.
Warn you about procedures or feature behaviors that could have unexpected or
undesirable results including loss of data or damage to equipment.
Typographic conventions
Convention Example
Button, menu, text box, field, From Minimum log level, select Notification.
or check box label
Emphasis HTTP connections are not secure and can be intercepted by a third party.
Hyperlink https://support.fortinet.com
Keyboard entry Enter a name for the remote VPN peer or client, such as Central_
Office_1.
Command syntax
The CLI requires that you use valid syntax, and conform to expected input constraints. It will reject invalid commands.
For command syntax conventions such as braces, brackets, and command constraints such as <address_ipv4>, see
"Notation" on page 45.
What’s new
The tables below list commands newly added commands for FortiWeb 6.0.2.
Command Change
New.
set admin-lockout-threshold "<admin- Configure the number of invalid logon attempts
lockout-threshold_int>" before the account is locked out.
set admin-lockout-duration "<minutes_int>" Configure the length of time the account remains
locked.
New.
set force-password-change {enable |
disable} Configure force password change for next login.
New.
set dynamic_dns1 "<dynamic_dns1_str>"
set dynamic_dns2 "<dynamic_dns2_str>"
When the mode is dhcp, configure the DNS server IP
address.
Command Change
New.
set network-type {flat | udp-tunnel} Configure the common HA mode flat or udp-tunnel
mode on OpenStack platform.
New.
set engine-id "<engine-id_str>"
Configure the SNMP engineID string.
Command Change
edit "<websocket-security_rule_name>"
set host-status {enable | disable}
set host <host_str>
set url-type {enable | disable}
set url <url_str>
set block-websocket-traffic {enable
| disable}
set action {alert | deny_no_log | alert_
deny}
New.
set max-frame-size <max-frame-size_int>
set max-message-size <max-message-size_
Configure WebSocket security rule settings.
int>
set block-extensions {enable | disable}
set enable-attack-signatures {enable
| disable}
set allow-plain-text {enable | disable}
set allow-binary-text {enable | disable}
set allowed-origin-list <allowed-origin-
list_id>
Command Change
edit "<policy_name>"
New.
config rule-list id
set rule "<rule_name>" Configure WebSocket secuity policy.
New.
edit "<openapi-file_name>"
Edit OpenAPI file name.
edit "<openapi-validation-policy_name>"
set action {alert | alert_deny |
block-period | redirect | send_
403_forbidden | deny_no_log}
set block-period "<seconds_int>"
New.
set severity {Low | Medium | High |
Info} Configure OpenAPI validation policy related
set trigger "<trigger-policy_name>" settings.
config schema-file
edit schema-file name
set openapi-file <datasource>
end
edit mitb-rule_name
set action {alert| alert_deny}
set severity {High | Medium | Low |
Info}
set trigger "<trigger-policy_name>"
set host-status {enable | disable}
set host "<host_str>"
set request-url "<request-url_str>"
set request-type {regular | plain} New.
set post-url "<post-url_str>" Configure MiTB rule related settings.
edit protected-parameter-list_name
set type {regular-input | password-
input}
set obfuscate {enable | disable}
set encrypt {enable | disable}
set anti-keyLogger {enable | disable}
edit allowed-external-domains-list_id
set domain "<domain_str>"
edit "<mitb-policy_name>"
config rule list New.
edit "<rule-list_id>" Configure the MiTB policy.
set "<mitb-rule_name>"
Command Change
New.
set mitb-protection Configure MiTB protection parameter list name.
set openapi-validation-policy Configure OpenAPI validation policy name.
set websocket-security-policy Configure WebSocket security policy name.
New.
set openapi-validation-policy
Configure the OpenAPI validation policy name.
You can use either interface or both to configure the FortiWeb appliance. In the web UI, you use buttons, icons, and
forms. In the CLI, you either type text commands or upload batches of commands from a text file, like a configuration
script.
If you are new to FortiWeb, or if you are new to the CLI, this section can help you to become familiar with using it.
l Locally—Connect your computer, terminal server, or console directly to the FortiWeb appliance’s console port.
l Through the network—Connect your computer through any network attached to one of the FortiWeb appliance’s
network ports. To connect using a Secure Shell (SSH) or Telnet client, enable the network interface for Telnet or SSH
administrative access. Enable HTTP/HTTPS administrative access to connect using the CLI Console widget in the web
UI.
Local access is required in some cases, including when you're:
l Installing FortiWeb for the first time and it's not yet configured to connect to your network, unless you reconfigure
your computer’s network settings for a peer connection, you may only be able to connect to the CLI using a local
console connection. For details, see the FortiWeb Administration Guide:
http://docs.fortinet.com/fortiweb/admin-guides
l Restoring the firmware and FortiWeb utilizes a boot interrupt. Network access to the CLI is not available until after the
boot process completes, and therefore local CLI access is the only viable option.
Before you can access the CLI through the network, you must enable SSH, HTTP/HTTPS, and/or Telnet on the network
interface through which you will access the CLI.
Requirements
The following instructions describe connecting to the CLI using PuTTY; steps may vary
with other terminal emulators.
1. Using the null modem or RJ-45-to-DB-9 cable, connect the FortiWeb appliance’s console port to the serial
communications (COM) port on your management computer.
Serial line to connect to COM1 (or, if your computer has multiple serial ports, the name of the connected
serial port)
Data bits 8
Stop bits 1
Parity None
4. In the Category tree on the left, go to Session (not the sub-node, Logging).
5. From Connection type, select Serial.
6. Click Open.
7. Press the Enter key to initiate a connection.
8. Enter a valid administrator account name (such as admin) then press Enter.
9. Enter the password for that administrator account and press Enter. By default, there is no password for the admin
account.
The CLI displays the following text, followed by a command line prompt:
Welcome!
You can now enter CLI commands, and configure access to the CLI through SSH or Telnet. For details, see
"Enabling access to the CLI through the network (SSH or Telnet or CLI Console widget)" on page 40.
If you do not want to use an SSH/Telnet client and you have access to the web UI, you
can alternatively access the CLI through the network using the CLI Console widget
in the web UI. For details, see the FortiWeb Administration Guide:
http://docs.fortinet.com/fortiweb/admin-guides
You must enable SSH and/or Telnet on the network interface associated with that physical network port. If your
computer is not connected directly or through a switch, you must also configure the FortiWeb appliance with a static
route to a router that can forward packets from the FortiWeb appliance to your computer. For details, see "router static"
on page 106.
Requirements
l A computer with an available serial communications (COM) port and RJ-45 port
l Terminal emulation software such as PuTTY (http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html)
l The RJ-45-to-DB-9 or null modem cable included in your FortiWeb package
l A crossover Ethernet cable (if connecting directly) or straight-through Ethernet cable (if connecting through a switch or
router)
l Prior configuration of the operating mode, network interface, and static route
To enable SSH or Telnet access to the CLI using a local console connection
1. Using the network cable, connect the FortiWeb appliance’s network port either directly to your computer’s network
port, or to a network through which your computer can reach the FortiWeb appliance.
where:
l <interface_name> is the name of the network interface associated with the physical network port, such as port1
l {http https ping snmp ssh telnet} is the complete, space-delimited list of permitted administrative
access protocols, such as https ssh telnet; omit protocols that you do not want to permit
For example, to exclude HTTP, SNMP, and Telnet, and allow only HTTPS, ICMP ECHO (ping), and SSH
administrative access on port1:
config system interface
edit "port1"
set allowaccess ping https ssh
next
end
Telnet is not a secure access method. SSH should be used to access the CLI from the
Internet or any other untrusted network.
5. To confirm the configuration, enter the command to view the access settings for the interface.
show system interface <interface_name>
The CLI displays the settings, including the management access settings, for the interface.
6. If you will be connecting indirectly, through one or more routers or firewalls, configure the appliance with at least one
static route so that replies from the CLI can reach your client. See "router static" on page 106.
To connect to the CLI through the network interface, see "Connecting to the CLI using SSH" on page 42 or
"Connecting to the CLI using Telnet" on page 43.
Secure Shell (SSH) provides both secure authentication and secure communications to the CLI. Supported SSH
protocol versions, ciphers, and bit strengths vary by whether or not you have enabled FIPS-CC mode or are using a low
encryption (LENC) version, but generally include SSH version 2 with AES-128, 3DES, Blowfish, and SHA-1.
Requirements
The following procedure describes connection using PuTTY software; steps may vary
with other terminal emulators.
2. In Host Name (or IP Address), enter the IP address of a network interface on which you have enabled SSH
administrative access.
The SSH client may display a warning if this is the first time you are connecting to the FortiWeb appliance and its
SSH key is not yet recognized by your SSH client, or if you have previously connected to the FortiWeb appliance but
it used a different IP address or SSH key. If your management computer is directly connected to the FortiWeb
appliance with no network hosts between them, this is normal.
6. Click Yes to verify the fingerprint and accept the FortiWeb appliance’s SSH key. You will not be able to log in until
you have accepted the key.
7. Enter a valid administrator account name (such as admin) and press Enter.
Alternatively, you can log in using an SSH key. For details, see "system admin" on page 201.
8. Enter the password for this administrator account and press Enter.
If three incorrect login or password attempts occur in a row, you will be disconnected.
Wait one minute, then reconnect to attempt the login again.
The FortiWeb appliance displays a command prompt—its host name followed by a #. You can now enter CLI
commands.
Telnet is not a secure access method. SSH should be used to access the CLI from the
Internet or any other untrusted network.
Requirements
The following procedure describes connection using PuTTY software; steps may vary with
other terminal emulators.
The FortiWeb appliance displays a command prompt—its host name followed by a #. You can now enter CLI
commands.
If three incorrect login or password attempts occur in a row, you will be disconnected. Wait
one minute, then reconnect to attempt the login again.
Command syntax
When entering a command, the CLI requires that you use valid syntax and conform to expected input constraints. It will
reject invalid commands.
For example, if you do not type the entire object that will receive the action of a command operator such as config,
the CLI will return an error message such as:
Command fail. CLI parsing error
This document uses the following conventions to describe valid command syntax.
Terminology
Each command line consists of a command word followed by words for the configuration data or other specific item that
the command uses or affects, for example:
get system admin
This document uses the below terms to describe the function of each word in the command line.
l Command—A word that begins the command line and indicates an action that FortiWeb should perform on a part of
the configuration or host on the network, such as config or execute. Together with other words, such as fields or
values, that you terminate by pressing the Enter key, it forms a command line. Exceptions include multi-line
command lines, which can be entered using an escape sequence. For details, see "Shortcuts & key commands" on
page 54.
Valid command lines must be unambiguous if abbreviated. For details, see "Command abbreviation" on page 55.
Optional words or other command line permutations are indicated by syntax notation. For details, see "Notation" on
page 45.
If you do not enter a known command, the CLI will return an error message such as:
Unknown action 0
l Subcommand—A kind of command that is available only when nested within the scope of another command. After
entering a command, its applicable subcommands are available to you until you exit the scope of the command, or
until you descend an additional level into another subcommand. Indentation is used to indicate levels of nested
commands. For details, see "Indentation" on page 45.
Not all top-level commands have subcommands. Available subcommands vary by their containing scope. For details,
see "Subcommands" on page 48.
l Object—A part of the configuration that contains tables and/or fields. Valid command lines must be specific enough
to indicate an individual object.
l Table—A set of fields that is one of possibly multiple similar sets that each have a name or number, such as an
administrator account, policy, or network interface. These named or numbered sets are sometimes referenced by
other parts of the configuration that use them. For details, see "Notation" on page 45.
l Field—The name of a setting, such as ip or hostname. Fields in some tables must be configured with values.
Failure to configure a required field will result in an invalid object configuration error message, and the FortiWeb
appliance will discard the invalid table.
l Value—A number, letter, IP address, or other type of input that is usually the configuration setting held by a field.
Some commands, however, require multiple input values which may not be named but are simply entered in
sequential order in the same command line. Valid input types are indicated by constraint notation. For details, see
"Notation" on page 45.
l Option—A kind of value that must be one or more words from a fixed set of options. For details, see "Notation" on
page 45.
Indentation
Indentation indicates levels of nested commands, which indicate what other subcommands are available from within
the scope.
For example, the edit subcommand is available only within a command that affects tables, and the next
subcommand is available only from within the edit subcommand:
config system interface
edit port1
set status up
next
end
Notation
Brackets, braces, and pipes are used to denote valid permutations of the syntax. Constraint notations, such as
<address_ipv4>, indicate which data types or string patterns are acceptable value input.
If you do not use the expected data type, the CLI returns an error message such as:
object set operator error, -4003 discard the setting
The request URL must start with "/" and without domain name.
or:
invalid unsigned integer value :-:
and may either reject or discard your settings instead of saving them when you type
end.
indicates that you may either omit or type both the verbose word and its
accompanying option, such as:
verbose 3
indicates that you may enter all or a subset of those options, in any order,
in a space-delimited list, such as:
Options delimited ping https ssh
by spaces
Note: To change the options, you must re-type the entire list. For
example, to add snmp to the previous example, you would type:
ping https snmp ssh
If the option adds to or subtracts from the existing list of options, instead
Subcommands
Each command line consists of a command word that is usually followed by words for the configuration data or other
specific item that the command uses or affects, for example:
get system admin
Subcommands are available from within the scope of some commands. When you enter a subcommand level, the
command prompt changes to indicate the name of the current command scope. For example, after entering:
config system admin
Applicable subcommands are available to you until you exit the scope of the command, or until you descend an
additional level into another subcommand.
For example, the edit subcommand is available only within a command that affects tables; the next subcommand is
available only from within the edit subcommand:
config system interface
edit port1
set status up
next
end
Available subcommands vary by command. From a command prompt within config, two types of subcommands
might become available:
Syntax examples for each top-level command in this CLI Reference Guide do not
show all available subcommands. However, when nested scope is demonstrated, you
should assume that subcommands applicable for that level of scope are available.
Table commands
l Edit the settings for the default admin administrator account by typing edit
admin.
l Add a new administrator account with the name newadmin and edit
edit <table_name> newadmin‘s settings by entering edit newadmin.
edit is an interactive subcommand: further subcommands are available
from within edit.
edit changes the prompt to reflect the table you are currently editing.
end Save the changes to the current object and exit the config command. This
returns you to the top-level command prompt.
l In objects, get lists the table names (if present), or fields and their values.
get
l In a table, get lists the fields and their values.
For more information on get commands, see "get" on page 657.
The CLI acknowledges the new table, and changes the command prompt to show that you are now within the admin_1
table:
new entry 'admin_1' added
(admin_1)#
Field commands
abort Exit both the edit and/or config commands without saving the fields.
Save the changes made to the current table or object fields, and exit the
end
config command. To exit without saving, use abort instead.
l In objects, get lists the table names (if present), or fields and their values.
l In a table, get lists the fields and their values.
Save the changes you have made in the current table’s fields, and exit the
edit command to the object prompt. To save and exit completely to the
root prompt, use end instead.
next next is useful when you want to create or edit several tables in the same
object, without leaving and re-entering the config command each time.
Display changes to the default configuration. Changes are listed in the form of
show
configuration commands.
to assign the value my1stExamplePassword to the password field. You might then enter the next command to
save the changes and edit the next administrator’s table.
Permissions
Depending on the account that you use to log in to the FortiWeb appliance, you may not have complete access to all
CLI commands or areas of the web UI.
Access profiles control which commands and areas an administrator account can access. Access profiles assign either:
Autolearn Auto Learn > Auto Learn Profile > Auto Learn Profile Web UI
Configuration
System System ... except Network, Admin, and Maintenance tabs Web UI
Configuration
* For each config command, there is an equivalent get/show command, unless otherwise noted.
config access requires write permission.
Unlike other administrator accounts, the administrator account named admin exists by default and cannot be deleted.
The admin administrator account is similar to a root administrator account. This administrator account always has full
permission to view and change all FortiWeb configuration options, including viewing and changing all other
administrator accounts. Its name and permissions cannot be changed. It is the only administrator account that can reset
another administrator’s password without being required to enter that administrator’s existing password.
Set a strong password for the admin administrator account, and change the
password regularly. By default, this administrator account has no password. Failure to
maintain the password of the admin administrator account could compromise the
security of your FortiWeb appliance.
For complete access to all commands, you must log in with the admin administrator account.
Basic features and characteristics of the CLI environment provide support and ease of use for many CLI tasks.
l "Help" on page 54
l "Shortcuts & key commands" on page 54
l "Command abbreviation" on page 55
l "Special characters" on page 55
l "Language support & regular expressions" on page 56
l "Screen paging" on page 57
l "Baud rate" on page 58
l "Editing the configuration file in a text editor" on page 58
l "Pipeline 'grep' command" on page 59
Help
To display brief help during command entry, enter the question mark (?) key:
l At the command prompt to display a list of the commands available and a description of each.
l After a command keyword to display a list of the objects available with that command and a description of each.
l After entering a word or part of a word to display a list of valid word completions or subsequent words, and to display a
description of each.
If multiple words could complete your entry, display all possible completions with
helpful descriptions of each.
Down arrow, or
Recall the next command.
Ctrl + N
Move the cursor left or right within the command line. Left or Right arrow
Action Keys
Abort current interactive commands, such as when entering multiple lines. Ctrl + C
If you are not currently within an interactive command such as config or edit, this
closes the CLI connection.
For each line that you want to continue, terminate it with a backslash ( \ ). To \ then Enter
complete the command line, terminate it by pressing the spacebar and then the Enter
key, without an immediately preceding backslash.
Command abbreviation
You can abbreviate words in the command line to their smallest number of non-ambiguous characters. For example, the
command get system status could be abbreviated to:
g sy st
If you enter an ambiguous command, the CLI returns an error message such as:
ambiguous command before 's'
Value conflicts with system settings.
Special characters
Special characters <, >, (, ), #, ', and " are usually not permitted in CLI. If you use them, the CLI will often return an
error message such as:
The string contains XSS vulnerability characters
Character Key
? Ctrl + V then ?
(to be interpreted as part of Enclose the string in single quotes: 'Security Administrator'
a string value, not to end
Precede the space with a backslash: Security\ Administrator
the string)
'
" \"
\ \\
l English
l Japanese
l Simplified Chinese
l Traditional Chinese
Characters such as ñ, é, symbols, and ideographs are sometimes acceptable input. Support varies by the nature of the
item being configured. CLI commands, objects, field names, and options must use their exact ASCII characters, but
some items with arbitrary names or values may be input using your language of choice.
For example, the host name must not contain special characters, and so the web UI and CLI will not accept most
symbols and other non-ASCII encoded characters as input when configuring the host name. This means that languages
other than English often are not supported. However, some configuration items, such as names and comments, may be
able to use the language of your choice.
To use other languages in those cases, you must use the correct encoding.
FortiWeb stores inputs using Unicode UTF-8 encoding, but it is not normalized from other encodings into UTF-8 before
stored. If your input method encodes some characters differently than in UTF-8, your configured items may not display
or operate as expected.
Regular expressions are especially impacted. Matching uses the UTF-8 character values. If you enter a regular
expression using another encoding, or if an HTTP client sends a request in an encoding other than UTF-8, matches may
not be what you expect.
For example, with Shift-JIS, backslashes ( \ ) could be inadvertently interpreted as yen symbols ( ¥ ) and vice versa. A
regular expression intended to match HTTP requests containing money values with a yen symbol therefore may not
work it if the symbol is entered using the wrong encoding.
l UTF-8 encoding.
l Only the characters whose numerically encoded values are the same in UTF-8, such as the US-ASCII characters that are
also encoded using the same values in ISO 8859-1, Windows code page 1252, Shift-JIS and other encodings.
l Regular expressions that match HTTP requests.
l The same encoding as your HTTP clients.
HTTP clients may send requests in encodings other than UTF-8. Encodings usually vary by the client’s operating system
or input language. If you cannot predict the client’s encoding, you may only be able to match any parts of the request
that are in English, because regardless of the encoding, the values for English characters tend to be encoded identically.
For example, English words may be legible regardless of interpreting a web page as either ISO 8859-1 or as GB2312,
whereas simplified Chinese characters might only be legible if the page is interpreted as GB2312.
To configure your FortiWeb appliance using other encodings, you may need to switch language settings on your
management computer, including for your web browser or Telnet or SSH client. For instructions on how to configure
your management computer’s operating system language, locale, or input method, see its documentation.
If you choose to configure parts of the FortiWeb appliance using non-ASCII characters, verify that all systems
interacting with the FortiWeb appliance also support the same encodings. You should also use the same encoding
throughout the configuration if possible in order to avoid needing to switch the language settings of your web browser or
Telnet or SSH client while you work.
Similarly to input, your web browser or CLI client should usually interpret display output as encoded using UTF-8. If it
does not, your configured items may not display correctly in the web UI or CLI. Exceptions include items such as regular
expressions that you may have configured using other encodings in order to match the encoding of HTTP requests that
the FortiWeb appliance receives.
l CLI access via the web UI—Configure your web browser to interpret the page as
UTF-8 encoded. The console will then display non-ASCII characters in commands
in their character code equivalent.
l CLI access via a Telnet or SSH client—Configure the client to send and
receive characters using UTF-8 encoding. Depending on the client, you may have
to enter non-ASCII characters in commands in their character code equivalent.
Screen paging
When output spans multiple pages, you can configure the CLI to pause after each page. When the display pauses, the
last line displays --More--. You can then either:
This may be useful when displaying lengthy output, such as the list of possible matching commands for command
completion, or a long list of settings. Rather than scrolling through or possibly exceeding the buffer of your terminal
emulator, you can simply display one page at a time.
Baud rate
You can change the default baud rate of the local console connection. For details, see "system console" on page 238.
Do not use a rich text editor such as Microsoft Word. Rich text editors insert special
characters into the file in order to apply formatting, which may corrupt the configuration
file.
1. Use execute backup cli-config (page 626) or execute backup full-config (page 627) to
download the configuration file to a TFTP server, such as your management computer.
2. Edit the configuration file using a plain text editor that supports Unix-style line endings.
Do not edit the first line. The first lines of the configuration file (preceded by a # character)
contains information about the firmware version and FortiWeb model. If you change the
model number, the FortiWeb appliance will reject the configuration file when you attempt
to restore it.
3. Use execute restore config (page 647) to upload the modified configuration file back to the FortiWeb
appliance.
The FortiWeb appliance downloads the configuration file and checks that the model information is correct. If it is,
the FortiWeb appliance loads the configuration file and checks each command for errors. If a command is invalid,
the FortiWeb appliance ignores the command. If the configuration file is valid, the FortiWeb appliance restarts and
loads the new configuration.
For example:
Administrative domains (ADOMs) enable the admin administrator to constrain other FortiWeb administrators’ access
privileges to a subset of policies and protected host names. This can be useful for large enterprises and multi-tenant
deployments such as web hosting.
ADOMs are not enabled by default. Enabling and configuring administrative domains can only be performed by the
admin administrator.
Enabling ADOMs alters the structure of and the available functions in the GUI and CLI according to whether you're
logging in as the admin administrator, and, if you are not logging in as the admin administrator, the administrator
account’s assigned access profile.
If ADOMs are enabled and you log in as admin, a superset of the typical CLI commands appear, allowing unrestricted
access and ADOM configuration.
config global contains settings used by the FortiWeb itself and settings shared by ADOMs, such as RAID and
administrator accounts. It does not include ADOM-specific settings or data, such as logs and reports. When configuring
other administrator accounts, an additional option appears allowing you to restrict other administrators to an ADOM.
If ADOMs are enabled and you log in as any other administrator, you enter the ADOM assigned to your account. A
subset of the typical menus or CLI commands appear, allowing access only to only logs, reports, policies, servers, and
LDAP queries specific to your ADOM. You cannot access global configuration settings or enter other ADOMs.
By default, administrator accounts other than the admin account are assigned to the root ADOM, which includes all
policies and servers. By creating ADOMs that contain a subset of policies and servers, and assigning them to
administrator accounts, you can restrict other administrator accounts to a subset of the FortiWeb’s total protected
servers.
The admin administrator account cannot be restricted to an ADOM. Other administrators are restricted to their ADOM,
and cannot configure ADOMs or global settings.
To enable ADOMs
Back up your configuration. Enabling ADOMs changes the structure of your configuration,
and moves non-global settings to the root ADOM. For details about how to back up the
configuration, see "backup full-config" on page 627.
3. Log in again.
When ADOMs are enabled, and if you log in as admin, the top level of the shell changes: the two top level items are
config global and config vdom.
l config global contains settings that only admin or other accounts with the prof_admin access profile can
change.
l config vdom contains each ADOM and its respective settings.
This menu and CLI structure change is not visible to non-global accounts; ADOM administrators’ navigation menus
continue to appear similar to when ADOMs are disabled, except that global settings such as network interfaces, HA,
and other global settings do not appear.
4. Continue by defining ADOMs. For details, see "Defining ADOMs" on page 62.
To disable ADOMs
Back up your configuration. Disabling ADOMs changes the structure of your configuration,
and deletes most ADOM-related settings. It keeps settings from the root ADOM only. For
details about how to back up the configuration, see "backup full-config" on page 627.
3. Continue by reconfiguring the appliance. For details, see the FortiWeb Administration Guide:
http://docs.fortinet.com/fortiweb/admin-guides
See also
l "Permissions" on page 51
l "Defining ADOMs" on page 62
l "Assigning administrators to an ADOM" on page 63
l "system admin" on page 201
l "system accprofile" on page 198
Defining ADOMs
Some settings can only be configured by the admin account—they are global. Global settings apply to the appliance
overall regardless of ADOM, such as:
l Operation mode
l Network interfaces
l System time
l Backups
l Administrator accounts
l Access profiles
l FortiGuard connectivity settings
l HA and configuration sync
l SNMP
l RAID
l X.509 certificates
l TCP SYN flood anti-DoS setting
l Vulnerability scans
l "ping" on page 638 and other global operations that exist only in the CLI
Only the admin account can configure global settings.
In the current release, some settings, such as user accounts for HTTP authentication,
anti-defacement, and logging destinations are read-only for ADOM administrators.
Future releases will allow ADOM administrators to configure these settings separately
for their ADOM.
Other settings can be configured separately for each ADOM. They essentially define each ADOM. For example,
the policies of adom-A are separate from adom-B.
Initially, only the root ADOM exists, and it contains settings such as policies that were global before ADOMs were
enabled. Typically, you will create additional ADOMs, and few if any administrators will be assigned to the root
ADOM.
After ADOMs are created, the admin account usually assigns other administrator accounts to configure their ADOM-
specific settings. However, as the root account, the admin administrator does have permission to configure all settings,
including those within ADOMs.
To create an ADOM
where <adom_name> is the name of your new ADOM. Alternatively, to configure the default root ADOM, type
root.
The maximum number of ADOMs you can add varies by your FortiWeb model. The
number of ADOMs is limited by available physical memory (RAM), and therefore also
limits the maximum number of policies and sessions per ADOM. For details, see the
FortiWeb Administration Guide:
http://docs.fortinet.com/fortiweb/admin-guides
The new ADOM exists, but its settings are not yet configured.
3. Either:
l Assign another administrator account to configure the ADOM (continue with "Assigning administrators to an ADOM"
on page 63), or
l Configure the ADOM yourself by entering commands such as:
config log...
config server-policy...
config system...
config waf...
See also
1. If you have not yet created any administrator access profiles, create at least one. For details, see "system accprofile"
on page 198.
2. In the administrator account’s accprofile "<access-profile_name>" (page 202) setting, select the new
access profile.
(Administrators assigned to the prof_admin access profile will have global access. They cannot be restricted to an
ADOM.)
3. In the administrator account’s domains "<adom_name>" (page 203) setting, select the account’s assigned
ADOM. Currently, in this version of FortiWeb, administrators cannot be assigned to more than one ADOM.
See also
l "Permissions" on page 51
l "system admin" on page 201
l "system accprofile" on page 198
l "Defining ADOMs" on page 62
config
waf exclude-url
waf file-
compress-rule
waf file-upload-
restriction-
policy
Although not usually explicitly shown in each config command’s “Syntax” section, for all
config commands, there are related get (page 657) and show (page 663) commands
which display that part of the configuration, either in the form of a list of settings and
values, or commands that are required to achieve that configuration from the firmware’s
default state, respectively. get and show commands use the same syntax as their related
config command, unless otherwise mentioned.
log alertMail
Use this command to enable or disable alert emails, and to choose which email policy to use with them. Alert emails
notify administrators or other personnel when an alert condition occurs, such as a system failure or network attack.
The email address information and the alert message intervals are configured separately for each email policy. For
details about the severity levels of log messages associated with an email policy, see "log email-policy" on page 75.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
loggrp area. For details, see "Permissions" on page 51.
Syntax
config log alertMail
set status {enable | disable}
set email-policy "<policy_name>"
end
status {enable | disable} Enable to generate an alert email when the FortiWeb appliance disable
records a log message, if that log message meets or exceeds the
severity level configured in "log email-policy" on page 75.
set email-policy ?
Example
This example enables alert email when either a system event or attack log message is logged. The alert email is sent
using the recipients configured in emailpolicy1.
config log alertMail
set status enable
set email-policy "emailpolicy1"
end
Related topics
l "log email-policy" on page 75
log attack-log
Use this command to configure recording of attack log messages on the local FortiWeb disk.
You must enable disk log storage and select log severity levels using config log disk
(page 73) before any attack logs can be stored on disk.
Also use this command to define specific packet payloads to retain when storing attack logs.
Packet payloads can be retained for specific attack types or validation failures detected by the FortiWeb appliance.
Packet payloads supplement the log message by providing the actual data that triggered the attack log, which may help
you to fine-tune your regular expressions to prevent false positives. You can also examine changes to attack behavior
for subsequent forensic analysis. Alternatively, for more extensive packet logging, you can run a packet trace. For
details, see "network sniffer" on page 607.
If the offending HTTP request exceeds 4 kilobytes (KB), the FortiWeb appliance retains only 4 KB’ of the part of the
payload that triggered the log message.
You can view attack log packet payloads from the Packet Log column using the web UI. For details, see the FortiWeb
Administration Guide:
http://docs.fortinet.com/fortiweb/admin-guides
Packet payloads can contain sensitive information. You can prevent sensitive data from display in the packet payload by
applying sensitivity rules that detect and obscure sensitive information. For details, see "log sensitive" on page 92.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
loggrp area. For details, see "Permissions" on page 51.
Syntax
config log attack-log
setstatus {enable | disable}
sethttp-parse-error-output {enable | disable}
setpacket-log {account-lockout-detection | anti-virus-detection | cookie-
security | credential-db-detection | csrf-detection | custom-access | custom-
protection-rule | fsa-detection | hidden-fields-failed | http-protocol-
constraints | illegal-file-type | illegal-filesize | illegal-json-format |
illegal-xml-format | ip-intelligence | padding-oracle | parameter-rule-failed
| signature-detection | trojan-detection | user-tracking-detection | xml-
protection | machine-learning | openapi-validation | websocket-security}
set no-ssl-error {enable | disable}
end
status {enable | disable} Enable to record attack log messages on the disk. enable
http-parse-error-output Enable while debugging only, to log errors of the HTTP protocol
disable
{enable | disable} parser.
packet-log {account- Select one or more detected attack types or validation failures. No
lockout-detection | anti- FortiWeb keeps packet payloads from its HTTP parser buffer default.
virus-detection | cookie-
security | credential-db- with their associated attack log message.
detection | csrf-
Separate each attack type with a space. To add or remove a
detection | custom-access
| custom-protection-rule packet payload type, re-type the entire space-delimited list
with the new option included or omitted.
| fsa-detection | hidden- Some options have historical names. Correlations with current
fields-failed | http- feature names are:
protocol-constraints |
illegal-file-type | l custom-protection-rule—Custom signature detection
illegal-filesize |
(not predefined)
illegal-json-format |
illegal-xml-format | ip- To empty this list and keep no packet payloads, effectively
intelligence | padding- disabling the feature, enter unset packet-log.
oracle | parameter-rule-
failed | signature-
detection | trojan-
detection | user-
tracking-detection | xml-
protection | machine-
learning | openapi-
validation | websocket-
security}
Example
This example enables log storage on the hard disk and sets information as the minimum severity level that a log
message must meet in order for the log to be stored. It also enables retention of packet payloads that triggered custom
protection rules along with their correlating attack logs. Conversely, it disables any other packet payload retention that
may have been enabled before, because it completely replaces the list each time it is configured.
config log disk
set status enable
set severity information
end
config log attack-log
set status enable
set packet-log custom-protection-rule
end
Related topics
l "log sensitive" on page 92
l "log custom-sensitive-rule" on page 71
l "log event-log" on page 78
l "log traffic-log" on page 100
l "debug application miglogd" on page 569
l "log " on page 601
log custom-sensitive-rule
Use this command to configure custom rules to obscure sensitive information that is not obscured in log message
packet payloads by the predefined sensitivity rules.
Use this command in conjunction with config log sensitive (page 92).
If enabled to do so, a FortiWeb appliance will obscure predefined data types, including user names and passwords in
log message packet payloads. If other sensitive data in the packet payload is not obscured by the predefined data types,
you can create your own data type sensitivity rules, such as ages or other identifying numbers.
Sensitive data definitions are not retroactive. They will hide strings in subsequent log
messages, but will not affect existing log messages.
This command is relevant only if you have enabled the FortiWeb appliance to keep packet payloads along with their
associated log messages, and have selected to obscure logs according to custom data types. For details, see "log
attack-log" on page 68 and "log sensitive" on page 92.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
loggrp area. For details, see "Permissions" on page 51.
Syntax
config log custom-sensitive-rule
edit "<custom-sensitive-rule_name>"
set expression "<sensitive-type_pattern>"
set field-name "<parameter-name_pattern>"
set field-value "<parameter-value_pattern>"
set type {field-mas-rule | general-mask-rule}
next
end
"<custom-sensitive-rule_ Enter the name of a new or existing rule. The maximum No default.
name>" length is 63 characters.
Enter a regular expression that matches all and only the input
field-name "<parameter- names whose values you want to obscure. The input name itself
No default.
name_pattern>" will not be obscured. If you wish to do this, use general-
mask-rule instead. The maximum length is 255 characters.
field-value "<parameter- Enter a regular expression that matches all and only the No default.
value_pattern>" input values that you want to obscure. The maximum length
is 255 characters.
Example
This example enables the FortiWeb appliance to keep all types of packet payloads with their associated log messages.
It also enables and defines a custom sensitive data type (applies to age 13 or less) that will be obscured in logs.
config log attack-log
set status enable
set packet-log anti-virus-detection cookie-poison custom-access custom-protection-rule
hidden-fields-failed http-protocol-constraints illegal-file-type illegal-xml-format ip-
intelligence padding-oracle parameter-rule-failed signature-detection
end
config log sensitive
set type custom-rule
end
config log custom-sensitive-rule
edit rule1
set type general-mask-rule
set expression "age\\=[1-13]*$"
next
end
Related topics
l "log sensitive" on page 92
l "log attack-log" on page 68
l "log traffic-log" on page 100
log disk
Use this command to enable and configure recording of log messages to the local hard disk.
Logging must be enabled for each individual log type before log messages are recorded to
disk. For details, see "log attack-log" on page 68, "log event-log" on page 78, and "log
traffic-log" on page 100 for details.
You can use SNMP traps to notify you when disk space usage exceeds 80%. For details, see "system snmp community"
on page 299.
You can generate reports based on log messages that you save to the local hard disk. For details, see "log reports" on
page 83.
Syntax
config log disk
set diskfull overwrite
set severity {alert | critical | debug | emergency | error | information |
notification | warning}
set status {enable | disable}
set log-used-disk <log-used-disk_int>
end
status {enable | Enable to store log messages on the local hard disk. Log enable
disable} messages are stored only if logging is enabled for the
individual log types using config log attack-log
(page 68), config log event-log (page 78), and
config log traffic-log (page 100). Also
configure diskfull overwrite (page 74) and
severity {alert | critical | debug |
emergency | error | information |
notification | warning} (page 74).
severity {alert | Select the severity level that a log message must meet or information
critical | debug | exceed in order to cause the FortiWeb appliance to record it.
emergency | error |
information |
notification | warning}
log-used-disk <log-used- This field is unique for Docker platform. Enter the log disk size.
10 G
disk_int> The valid range is 10–500 G.
Example
This example enables logging of event and attack logs and recording of the log messages to the local hard disk. Only
the log messages with a severity of notification or higher are recorded. If all free space on the hard disk is
consumed and a new log message is generated, the diskfull option determines that the FortiWeb will overwrite the
oldest log message. The log messages are saved to a separated log file for each message type.
config log disk
set status enable
set severity notification
set diskfull overwrite
end
Related topics
l "log attack-log" on page 68
l "log event-log" on page 78
l "log traffic-log" on page 100
l "system snmp community" on page 299
l "log reports" on page 83
l "formatlogdisk" on page 634
log email-policy
Use this command to create an email policy. An email policy identifies email recipients, email address, email
connection requirements and authentication information, if required.
You can configure multiple email policies and apply those policies as required in different situations. The FortiWeb
appliance can be configured to send email for different situations, such as to alert administrators when certain system
events or rule violations occur, or when log reports are available for distribution.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
loggrp area. For details, see "Permissions" on page 51.
Syntax
config log email-policy
edit "<email-policy_name>"
set mailfrom "<address_str>"
set mailto1 "<recipient_email>"
set mailto2 "<recipient_email>"
set mailto3 "<recipient_email>"
set smtp-server {"<smtp_ipv4>" | "<smtpfqdn>"}
set smtp-port <smtp-port_int>
set smtp-auth {enable | disable}
set smtp-username "<auth_str>"
set smtp-password "<password_str>"
set severity {alert | critical | debug | emergency | error | information |
notification | warning}
set interval <interval_int>
set connection-security {NONE | STARTTLS | SSL/TLS}
set attach-compression {enable | disable}
set send-email-based-on-interval-time {enable | disable}
set company-logo "<company-logo_str>"
set company-name "<company-name_str>"
next
end
"<email-policy_name>" Enter the name of an email policy. The maximum length is 63 No default.
characters.
mailto1 "<recipient_ Enter the email address of the first recipient, such as No default.
email>" [email protected], to which the FortiWeb appliance will
send email. You must enter one email address for alert email to
function. The maximum length is 63 characters.
mailto2 "<recipient_ Enter the email address of the second recipient, if any, to which No default.
mailto3 "<recipient_ Enter the email address of the third recipient, if any, to which the No default.
email>" FortiWeb appliance will send alert email. The maximum length is
63 characters.
smtp-port <smtp-port_ Enter the port on the SMTP server that listens for alerts and 25
int> generated reports from FortiWeb.
severity {alert | Select the severity threshold that log messages must meet or emergency
critical | debug | exceed in order to cause an email alert.
emergency | error |
information |
notification | warning}
company-name "<company- Set the company name in the email policy. The maximum length No default.
name_str>" is 63 characters.
Example
This example creates email policy for use in multiple situations. When the email policy is attached to rule violations or
log reports, FortiWeb sends an email from [email protected], to [email protected] and
[email protected], using an SMTP server mail.example.com. The SMTP server requires authentication.
The FortiWeb appliance authenticates as fortiweb when connecting to the SMTP server.
FortiWeb logs messages more severe than a notification. As long as events continue to trigger notification-level log
messages, FortiWeb sends an alert email every 10 minutes. (Log messages of other severity levels trigger alert email at
their default intervals.) All the related log messages will be attached to the emails in ZIP format.
When the configuration is complete, log in to the web UI to send a sample alert email to test the configuration and the
email system.
config log email-policy
edit "Email_Policy1"
set mailfrom "[email protected]"
set mailto1 "[email protected]"
set mailto2 "[email protected]"
set smtp-server "mail.example.com"
set smtp-auth enable
set smtp-username "fortiweb"
set smtp-password "fortiWebPassworD2"
set severity notification
set interval 10
set attach-compression enable
next
end
Related topics
l "log alertMail" on page 67
l "log trigger-policy" on page 101
l "system dns" on page 242
l "router static" on page 106
log event-log
Use this command to configure recording of event log messages, and then use other commands to store those
messages on the local FortiWeb disk, in local FortiWeb memory, or both. Use other commands to configure a traffic log
and attack log.
You must enable disk and/or memory log storage and select log severity levels before
FortiWeb will store any event logs.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
loggrp area. For details, see "Permissions" on page 51.
Syntax
config log event-log
set status {enable | disable}
set cpu-high <percentage_int>
set mem-high <percentage_int>
set logdisk-high <percentage_int>
set trigger-policy "<trigger-policy_name>"
end
trigger-policy "<trigger- Enter the name of the trigger to apply when the CPU, memory, No
policy_name>" log disk usage, or number of sessions meets or exceeds the default.
threshold (see "log trigger-policy" on page 101). The maximum
length is 63 characters.
Example
This example enables recording of event logs, enables disk log storage and memory log storage, and sets alert as the
minimum severity level that a log message must achieve for storage.
config log disk
set status enable
set severity alert
end
config log event-log
set status enable
end
Related topics
l "log disk" on page 73
l "log attack-log" on page 68
l "log traffic-log" on page 100
l "debug application miglogd" on page 569
l "log " on page 601
log forti-analyzer
Use this command to configure the FortiWeb appliance to send its log messages to a remote FortiAnalyzer appliance.
You must first define one or more FortiAnalyzer policies using config log fortianalyzer-policy (page 81).
Logs sent to FortiAnalyzer are controlled by FortiAnalyzer policies and trigger actions that you configure on the FortiWeb
appliance, and are associated with various types of violations.
Logs stored remotely cannot be viewed from the web UI, and cannot be used by FortiWeb to build reports. If you require
these features, record logs locally as well as remotely.
Usually, you should set trigger actions for specific types of violations. Failure to do so will
result in the FortiWeb appliance logging every occurrence, which could result in high log
volume and reduced system performance. Excessive logging for an extended period of
time may cause premature hard disk failure.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
loggrp area. For details, see "Permissions" on page 51.
Syntax
config log forti-analyzer
set fortianalyzer-policy "<policy_name>"
set status {enable | disable}
set severity {alert | critical | debug | emergency | error | information |
notification | warning}
end
severity {alert | Select the severity level that a log message must meet or information
critical | debug | exceed in order to cause the FortiWeb appliance to save it to
emergency | error |
FortiAnalyzer.
information |
notification | warning}
Example
This example enables FortiAnalyzer logging and recording of the log messages. Only the log messages with a severity
of error or higher are recorded.
config log forti-analyzer
set status enable
set severity error
end
Related topics
l "log fortianalyzer-policy" on page 81
log fortianalyzer-policy
Use this command to create policies for use by protection rules to store log messages remotely on a FortiAnalyzer
appliance. For example, once you create a FortiAnalyzer policy, you can include it in a trigger policy, which in turn can
be applied to a trigger action in a protection rule.
You need to create a FortiAnalyzer policy if you also plan to send log messages to a FortiAnalyzer appliance.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
loggrp area. For details, see "Permissions" on page 51.
Syntax
config log fortianalyzer-policy
edit "<policy_name>"
config fortianalyzer-server-list
edit <entry_index>
set ip-address "<forti-analyzer_ipv4>"
set enc-algorithm {disable | default}
end
next
end
No
<entry_index> Enter the index number of the individual entry in the table.
default.
Example
This example creates a policy entry and assigns an IP address, then enables FortiAnalyzer logging for log messages
with a severity of error or higher.
config log fortianalyzer-policy
edit "fa-policy1"
config fortianalyzer-policy
edit 1
set ip-address "192.0.2.133"
end
next
end
config log forti-analyzer
set fortianalyzer-policy "fa-policy1"
set status enable
set severity error
end
Related topics
l "log forti-analyzer" on page 79
log ftp-policy
Use this command to configure a connection to an FTP or TFTP server. The config log reports configuration
uses this policy to specify a server that FortiWeb sends reports to.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
loggrp area. For details, see "Permissions" on page 51.
Syntax
config log ftp-policy
edit "<policy_name>"
set type {ftp | tftp}
set server "<ftp-server_ipv4>"
set ftp_auth {enable | disable}
set ftp_user "<ftp-user_str>"
set ftp_passwd "<ftp_pswd>"
set ftp-dir "<ftp-dir_str>"
end
type {ftp | tftp} Specify whether the server is FTP or TFTP. ftp
Specify whether the server requires a user name and password for
ftp_auth {enable | authentication, rather than allowing anonymous connections.
disable
disable}
Available only if type {ftp | tftp} (page 82) is ftp.
ftp_user "<ftp-user_str>" Enter the user name that FortiWeb uses to authenticate with the No
server. default.
ftp-dir "<ftp-dir_str>" Enter the location on the server where FortiWeb stores reports. No
default.
Related topics
l "log reports" on page 83
log reports
When generating a report, FortiWeb appliances collate information collected from their log files and present the
information in tabular and graphical format.
In addition to log files, your FortiWeb appliance requires a report profile to generate a report. A report profile is a group
of settings that contains the report name, file format, subject matter, and other aspects that the FortiWeb appliance
considers when generating the report.
FortiWeb appliances can generate reports automatically, according to the schedule that you configure in the report
profile, or manually in the web UI when you click the Run now icon in the report profile list. You may want to create one
report profile for each type of report that you will generate on demand or periodically, by schedule.
The number of results in a section’s table or graph varies by the report type.
Ranked reports (top x, or top y of top x) can include a different number of results per cross-section, then combine
remaining results under “Others.” For example, in “Top Attack Severity by Hour of Day,” the report includes the top x
hours, and their top y attacks, then groups the remaining results.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
loggrp area. For details, see "Permissions" on page 51.
Syntax
config log reports
edit "<report_name>"
set custom_company "<org_str>"
set custom_footer_options {custom | report-title}
set custom_header "<header_str>"
set custom_header_logo "<filename_hex_str>"
set custom_title_logo "<filename_hex_str>"
set email_attachment_compress {enable | disable}
set email_attachment_name "<filename_str>"
set email_body "<message_str>"
set email_subject "<subject_str>"
set filter_string "<log-filter_str>"
set include_nodata {yes | no}
set on_demand {enable | disable}
set output_email {html mht pdf rtf txt}
set output_email_policy "<policy_name>"
set output_file {html mht pdf rtf txt}
set output_ftp {html pdf rtf txt mht}
set output_ftp_policy "<ftp-policy_name>"
set period_end "<time_str>" "<date_str>"
set period_last_n <n_int>
set period_start "<time_str>" "<date_str>"
set period_type {last-14-days | last-2-weeks | last-30-days | last-7-days |
lastmonth | last-n-days | last-n-hours | last-n-weeks | last-quarter |
last-week | other | this-month | this-quarter | this-week | thiyear |
today | yesterday}
set report_desc "<comment_str>"
set report_title "<title_str>"
set report_attack_activity {attacks-type attacks-url attacks-date-type attacks-
month-type attacks-day-type attacks-hour-type attacks-type-dev attacks-dst-
type attacks-dst-ip attacks-type-ip attacks-method-type attacks-cat
attacks-policy attacks-day attacks-ts attacks-td attacks-proto attacks-
date-severity attacks-month-severity attacks-day-severity attacks-hour-
severity attacks-sessionid attacks-srccountry attacks-signature-id attacks-
type-signature-id attacks-fortisandbox attacks-httphost attacks-username
attacks-httprefer attacks-httpversion threat-weight-client-device attacks-
client-device cat-client-device attack-summary attack-details}
set report_event_activity {ev-all ev-all-cat ev-all-type ev-crit-hour ev-crit-
day ev-warn-hour ev-warn-day ev-info-hour ev-info-day ev-emer-hour ev-emer-
day ev-aler-hour ev-aler-day ev-err-hour ev-err-day ev-noti-hour ev-noti-
day ev-hour ev-hour-cat ev-day ev-day-cat ev-stat ev-day-login ev-week-
login ev-user-logint}
set report_traffic_activity {net-pol net-srv net-src net-dst net-src-dst net-
dst-src net-date-dst net-hour-dst net-day-dst net-month-dst net-date-src
net-hour-src net-day-src net-month-src net-srccountry net-httphost net-
username net-httprefer net-httpversion net-client-device}
Enter the text, if any, that you want to include at the bottom of
each report page. If the text is more than one word or contains
custom_footer "<footer_ special characters, enclose it in double quotes ( " ). The No
str>" maximum length is 127 characters. default.
This setting is available only if custom_footer_options
{custom | report-title} (page 85) is custom.
custom_header "<header_ Enter the text, if any, that you want to include at the top of each No
str>" report page. If the text is more than one word or contains special default.
characters, enclose it in double quotes ( " ). The maximum length
is 127 characters.
Enter the file name of a custom logo that you have previously
custom_header_logo uploaded to the FortiWeb appliance. The logo image will be No
"<filename_hex_str>" included in the report header. The maximum length is 255 default.
characters.
custom_title_logo Enter the file name of a custom logo that you have previously No
"<filename_hex_str>" uploaded to the FortiWeb appliance. The logo image will be default.
included in the report title. The maximum length is 255 characters.
email_attachment_name Enter the file name that will be used for the reports attached No
"<filename_str>" to the email. The maximum length is 63 characters. default.
email_subject "<subject_ Enter the subject line of the email. The maximum length is No
str>" 191 characters. default.
include_nodata {yes | no} Select whether to include (yes) or hide (no) reports which are no
empty because there is no matching log data.
Enable to run the report one time only. After the FortiWeb
on_demand {enable |
disable} appliance completes the report, it removes the report profile disable
from its hard disk.
output_email {html mht Select one or more file types for the report when mailing generated No
pdf rtf txt} reports. default.
output_file {html mht pdf Select one or more file types for the report when saving to the html
rtf txt} FortiWeb hard disk.
output_ftp {html pdf rtf Select one or more file types for the report when FortiWeb sends No
txt mht} reports to an FTP or TFTP server. default.
output_ftp_policy "<ftp- Enter the policy that defines a connection to the appropriate server. No
policy_name>" For details, see "log ftp-policy" on page 82. default.
Enter the time and date that define the end of the span of
time whose log messages you want to use when generating
the report.
Enter the time and date that defines the beginning of the
span of time whose log messages you want to use when
generating the report.
period_type {last-14- Select the span of time whose log messages you want to use last-7-
days | last-2-weeks | when generating the report. days
last-30-days | last-7-
days | lastmonth | last- If you select last-n-days, last-n-hours, or last-
n-days | last-n-hours |
nweeks, you must also define n by entering period_last_
last-n-weeks | last-
quarter | last-week | n <n_int> (page 87).
other | this-month |
this-quarter | this-
If you select other, you must also define the start and end of
week | thiyear | today | the report’s time range by entering period_start
yesterday} "<time_str>" "<date_str>" (page 88) and period_
end "<time_str>" "<date_str>" (page 87).
report_title "<title_ Enter a title, if any, that you want to include in the report No
str>" summary. If the text is more than one word or contains special default.
characters, enclose it in double quotes ( " ). The maximum
length is 127 characters.
report_attack_activity
{attacks-type attacks-url
attacks-date-type
attacks-month-type
attacks-day-type attacks-
hour-type attacks-type-
dev attacks-dst-type
attacks-dst-ip attacks-
type-ip attacks-method-
type attacks-cat attacks-
policy attacks-day
attacks-ts attacks-td Enter zero or more options to indicate which charts based
attacks-proto attacks-
upon attack logs to include in the report.
date-severity attacks-
month-severity attacks- For example, to include “Attacks By Policy,” enter a list of No
day-severity attacks- default.
charts that includes attacks-policy. To include “Top
hour-severity attacks-
sessionid attacks- Attacked HTTP Methods by Type,” enter a list of charts that
srccountry attacks- includes attacks-method-type.
signature-id attacks-
type-signature-id
attacks-fortisandbox
attacks-httphost attacks-
username attacks-
httprefer attacks-
httpversion threat-
weight-client-device
attacks-client-device
cat-client-device attack-
summary attack-details}
report_traffic_activity
{net-pol net-srv net-src
net-dst net-src-dst net-
dst-src net-date-dst net-
Enter zero or more options to indicate which charts based
hour-dst net-day-dst net-
month-dst net-date-src upon traffic logs to include in the report. No
net-hour-src net-day-src default.
For example, to include “Top Sources By Day of Week”, enter
net-month-src net-
srccountry net-httphost a list of charts that includes net-day-src.
net-username net-
httprefer net-httpversion
net-client-device}
report_pci_activity {pci- Enter zero or more options to indicate which charts based upon PCI No
attacks-date-type pci- attack logs to include in the report. default.
attacks-month-type pci-
attacks-day-type pci-
attacks-hour-type}
scope_include_table_of_ Enter yes to include a table of contents at the beginning of the yes
content {yes | no} report. The table of contents includes links to each chart in the
report.
For some report types, you can set the top ranked items for
scope_top1 <topX_int> the report. These reports have “Top” in their name, and will 6
always show only the top x entries. Reports that do not
include “Top” in their name show all information. Changing
the values for top field will not affect these reports.
scope_top2 <topY_int> Enter y number of items (up to 30) to include in the second 3
cross-section of ranked reports.
For some report types, you can set the number of ranked
items to include in the report. These reports have “Top” in
their name, and will always show only the top x entries. Some
report types have two levels of ranking: the top y sub-entries
for each top x entry.
Example
This example configures a report to be generated every Saturday at 1 PM. The report, whose title is Report 1,
includes all available charts, and covers the last 14 days’ worth of event, traffic, and attack logs. However, it only uses
logs where the source IP address was 192.0.2.20. Each time it is generated, it will be saved to the hard disk in both
HTML and PDF file formats and will be sent by email in PDF format to recipients defined within the “Log report analysis”
email policy.
config log reports
edit "eport_1"
set Report_attack_activity attacks-type attacks-url attacks-date-type attacks-month-type
attacks-day-type attacks-hour-type attacks-type-dev attacks-dst-type attacks-dst-ip
attacks-type-ip attacks-method-type attacks-cat attacks-policy attacks-day attacks-ts
attacks-td attacks-proto attacks-date-severity attacks-month-severity attacks-day-
severity attacks-hour-severity attacks-sessionid attacks-signature-id attacks-
srccounty attacks-type-signature-id
set Report_event_activity ev-all ev-all-cat ev-all-type ev-crit-hour ev-crit-day ev-warn-
hour ev-warn-day ev-info-hour ev-info-day ev-emer-hour ev-emer-day ev-aler-hour ev-
aler-day ev-err-hour ev-err-day ev-noti-hour ev-noti-day ev-hour ev-hour-cat ev-day
ev-day-cat ev-stat
set Report_traffic_activity net-pol net-srv net-src net-dst net-src-dst net-dst-src net-
date-dst net-hour-dst net-day-dst net-month-dst net-date-src net-hour-src net-day-src
net-month-src
set custom_company "Example, Inc."
set custom_footer_options custom
set custom_header "A fictitious corporation."
set custom_title_logo "titlelogo.jpg"
set filter_string (and src==\'192.0.2.20\')
set include_nodata yes
set output_file html pdf
set output_email html
set output_email_policy log_report_analysis
set period_type last-n-days
set report_desc "A sample report."
set report_title Report 1
set schedule_type days
set custom_footer "Weekly report for Example, Inc."
set period_last_n 14
set schedule_days sat
set schedule_time 01:00
next
end
Related topics
l "log attack-log" on page 68
l "log disk" on page 73
l "log email-policy" on page 75
l "log ftp-policy" on page 82
log sensitive
Use this command to configure whether the FortiWeb appliance will obscure sensitive information, such as user names
and passwords, in log messages for which packet payloads are enabled. Each packet payload has predefined sensitivity
rules based on the payload data type. If needed, you can also create custom sensitivity rules to obscure other payload
data types using config log custom-sensitive-rule (page 71).
This command is relevant only if you have enabled the FortiWeb appliance to keep packet payloads along with their
associated log messages. For details, see "log attack-log" on page 68 and "log traffic-log" on page 100.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
loggrp area. For details, see "Permissions" on page 51.
Syntax
config log sensitive
set type {custom-rule | pre-defined-rule}
end
type {custom-rule | pre- Select whether the FortiWeb appliance will obscure packet No
defined-rule} payloads according to predefined data types and/or custom default.
data types.
Example
This example enables the FortiWeb appliance to use a custom sensitive rule to obscure packet payload information that
displays information about users that are age 13 and under.
config log sensitive
set type custom-rule
end
config log custom-sensitive-rule
edit "custom-sensitive-rule1"
set type general-mask-rule
set expression "age\\=[1-13]*$"
next
end
Related topics
l "log custom-sensitive-rule" on page 71
l "log attack-log" on page 68
l "log traffic-log" on page 100
log siem-message-policy
Use this command to configure the FortiWeb appliance to send its log messages to one or more a remote ArcSight
SIEM (security information and event management) servers.
You must first define one or more SIEM policies using config log siem-policy (page 95).
Logs sent to the ArcSight server are controlled by SIEM policies and trigger actions that you configure on the FortiWeb
appliance, and are associated with various types of violations.
Logs stored remotely cannot be viewed from the web UI, and cannot be used by FortiWeb to build reports. If you require
these features, record logs locally as well as remotely.
Usually, you should set trigger actions for specific types of violations. Failure to do so will
result in the FortiWeb appliance logging every occurrence, which could result in high log
volume and reduced system performance. Excessive logging for an extended period of
time may cause premature hard disk failure.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
loggrp area. For details, see "Permissions" on page 51.
Syntax
config log siem-message-policy
set siem-policy "<policy_name>"
set severity {alert | critical | debug | emergency | error | information |
notification | warning}
set status {enable | disable}
end
siem-policy "<policy_ Enter the name of an existing SIEM policy to use when No default.
name>" storing log information remotely. The maximum length is
63 characters.
severity {alert |
critical | debug | Select the severity level that a log message must meet or
emergency | error | exceed in order to cause the FortiWeb appliance to save it to information
information | the ArcSight server.
notification | warning}
status {enable | Enable to record event log messages to the ArcSight server if it disable
disable} meets or exceeds the severity level specified by severity
{alert | critical | debug | emergency |
error | information | notification |
warning} (page 94).
Example
This example enables ArcSight SIEM logging and recording of the log messages. Only the log messages with a severity
of error or higher are recorded.
config log siem-message-policy
set status enable
set severity error
set siem-policy SIEM_Policy1
end
Related topics
l "log siem-policy" on page 95
log siem-policy
Use this command to configure a connection to one or more ArcSight SIEM (security information and event
management) servers, IBM QRadar servers or Azure Security Center (if your FortiWeb-VM is deployed on Microsoft
Azure). The policy is used by the log syslogd configuration to define the specific ArcSight server, QRadar server or
Azure Event Hub on which log messages are stored. For details, see "log syslogd" on page 97.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
loggrp area. For details, see "Permissions" on page 51.
Syntax
config log siem-policy
edit "<policy_name>"
config siem-server-list
edit <entry_index>
set type <arcsight-cef | qradar-leef | azure-cef>
set port <port_int>
set server "<siem_ipv4>"
end
next
end
"<policy_name>" Enter the name of a new or existing SIEM policy. The No default.
maximum length is 63 characters.
<entry_index> Enter the index number of the individual entry in the table. No default.
Enter the port where the ArcSight or QRadar server listens for
port <port_int> 514
log output.
server "<siem_ipv4>" Enter the IP address of the ArcSight or QRadar server. No default.
Example
This example creates SIEM_Policy1. FortiWeb contacts the ArcSight server using its IP address, 192.0.2.10.
Communications occur over the standard port number for ArcSight, UDP port 514. The FortiWeb appliance sends log
messages to the server in CEF format.
config log siem-policy
edit "SIEM_Policy1"
config siem-server-list
edit 1
set type arcsight-cef
set port 514
set server "192.0.2.10"
end
next
end
Related topics
l "log siem-policy" on page 95
l "system dns" on page 242
l "router static" on page 106
log syslogd
Use this command to configure the FortiWeb appliance to send log messages to a Syslog server defined by config
log syslog-policy (page 98) .
For improved performance, unless necessary, avoid logging highly frequent log types.
While logs sent to your Syslog server do not persist in FortiWeb’s local RAM, FortiWeb still
must use bandwidth and processing resources while sending the log message.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
loggrp area. For details, see "Permissions" on page 51.
Syntax
config log syslogd
set status {enable | disable}
set facility {alert | audit | auth | authpriv | clock | cron | daemon | ftp |
kernel | local0 | local1 | local2 | local3 | local4 | local5 | local6 |
local7 | mail | ntp | user}
set severity {alert | critical | debug | emergency | error | information |
notification | warning}
set policy "<syslogd-policy_name>"
end
status {enable | Enable to send log messages to the Syslog server defined disable
disable} by config log syslog-policy (page 98). Also
configure:
facility {alert |
audit | auth | Enter the facility identifier that the FortiWeb appliance will
authpriv | clock | use to identify itself when sending log messages to the first
cron | daemon | ftp | Syslog server.
kernel | local0 |
To easily identify log messages from the FortiWeb local7
local1 | local2 |
local3 | local4 | appliance when they are stored on the Syslog server, enter
local5 | local6 | a unique facility identifier, and verify that no other network
local7 | mail | ntp |
user}
devices use the same facility identifier.
severity {alert | Select the severity level that a log message must meet or information
critical | debug | exceed in order to cause the FortiWeb appliance to send it to
emergency | error |
the first Syslog server.
information |
notification | warning}
Example
This example enables storage of log messages with the notification severity level and higher on the Syslog server.
The network connections to the Syslog server are defined in Syslog_Policy1. The FortiWeb appliance uses the
facility identifier local7 when sending log messages to the Syslog server to differentiate its own log messages from
those of other network devices using the same Syslog server.
config log syslogd
set status enable
set severity notification
set facility local7
set policy "Syslog_Policy1"
end
log syslog-policy
Use this command to configure a connection to one or more Syslog servers. Each policy can specify connections for up
to three Syslog servers. The log syslogd configuration uses the policy to define the specific Syslog server or servers
on which log messages are stored. For details, see config log syslogd (page 97).
To use this command, your administrator account’s access control profile must have either w or rw permission to the
loggrp area. For details, see "Permissions" on page 51.
Syntax
config log syslog-policy
edit "<policy_name>"
config syslog-server-list
edit <entry_index>
set csv {enable | disable}
set port <port_int>
set server "<syslog_ipv4>"
set tls {enable | disable}
end
next
end
"<policy_name>" Enter the name of a new or existing Syslog policy. The No default.
maximum length is 63 characters.
csv {enable | disable} Enable if the Syslog server requires the FortiWeb appliance to disable
send log messages in comma-separated value (CSV) format,
instead of the standard Syslog format.
Example
This example creates Syslog_Policy1. The Syslog server is contacted by its IP address, 192.168.1.10.
Communications occur over the standard port number for Syslog, UDP port 514. The FortiWeb appliance sends log
messages to the Syslog server in CSV format.
config log syslog-policy
edit "Syslog_Policy1"
config log-server-list
edit 1
set server "192.168.1.10"
set port 514
set csv enable
end
next
end
Related topics
l "log syslogd" on page 97
l "system dns" on page 242
l "router static" on page 106
log traffic-log
Use this command to have the FortiWeb appliance record traffic log messages on its local disk. This command also lets
you save packet payloads with the traffic logs.
You must enable disk log storage and select log severity levels using config log disk
(page 73) before any traffic logs are stored on disk.
Packet payloads supplement the log message by providing the actual data associated with the traffic log, which may
help you to analyze traffic patterns.
You can view packet payloads in the Packet Log column when viewing a traffic logs using the web UI. For details, see
the FortiWeb Administration Guide:
http://docs.fortinet.com/fortiweb/admin-guides
To use this command, your administrator account’s access control profile must have either w or rw permission to the
loggrp area. For details, see "Permissions" on page 51.
Syntax
config log traffic-log
set packet-log {enable | disable}
set status {enable | disable}
end
status {enable | disable} Enable to record traffic log messages if disk log storage is enabled, disable
and the logs meet or exceed the severity levels selected using
config log disk (page 73).
Example
This example enables disk log storage, sets information as the minimum severity level that a log message must
achieve for storage, enables recording of traffic logs and retention of all packet payloads along with the traffic logs.
config log disk
set status enable
set severity information
end
Related topics
l "log attack-log" on page 68
l "log event-log" on page 78
l "log disk" on page 73
l "log sensitive" on page 92
l "debug application miglogd" on page 569
l "log " on page 601
log trigger-policy
Use this command to configure a trigger policy for use in the notification process.
You apply trigger policies to individual conditions that have an associated action and severity, such as attacks and rule
violations. A trigger policy has the following components:
l An email policy (contains the details associated with the recipient email account)
l A Syslog policy (contains details required to communicate with the Syslog server)
l A FortiAnalyzer policy (contains the IP address of the remote FortiAnalyzer appliance)
The trigger policy determines whether an email is sent to administrators when a certain condition occurs and whether
the log messages associated with the condition are stored on a Syslog server or FortiAnalyzer.
You define the email, Syslog, and FortiAnalyzer policies before you apply the trigger policy to an individual condition.
For details, see "log email-policy" on page 75, "log syslog-policy" on page 98, and "log fortianalyzer-policy" on page 81.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
loggrp area. For details, see "Permissions" on page 51.
Syntax
config log trigger-policy
edit "<trigger-policy_name>"
set email-policy "<email-policy_name>"
set syslog-policy "<syslog-policy_name>"
set analyzer-policy "<fortianalyzer-policy_name>"
set siem-policy "<siem-policy_name>"
next
end
Variable Description Default
"<trigger-policy_name>" Enter the name of a new or existing trigger policy. The maximum No
length is 63 characters. default.
Enter the name of the email policy to be used with the trigger
policy. The maximum length is 63 characters.
email-policy "<email- If the conditions associated with the trigger policy occur, the No
policy_name>" email policy determines the recipients of the notification email default.
messages associated with the condition.
syslog-policy "<syslog- Enter the name of the Syslog policy to be used with the trigger No
policy_name>" policy. The maximum length is 63 characters. default.
analyzer-policy
Enter the name of an existing FortiAnalyzer policy to be used
with the trigger policy. The maximum length is 63 characters. No
"<fortianalyzer-policy_
name>" default.
For details, see "log fortianalyzer-policy" on page 81.
siem-policy "<siem- Enter the name of an existing SIEM policy to be used with the No
policy_name>" trigger policy. The maximum length is 63 characters. default.
Example
This example creates Trigger_policy1, which uses emailpolicy1 to send email notifications about the
condition to specific recipients, and Syslog_Policy1 to submit the log messages to a specific Syslog server.
config log trigger-policy
edit "Trigger_policy1"
set syslog-policy "Syslog_Policy1"
set email-policy "emailpolicy1"
next
end
Related topics
l "log email-policy" on page 75
l "log syslog-policy" on page 98
l "log fortianalyzer-policy" on page 81
l "log siem-policy" on page 95
l "waf http-protocol-parameter-restriction" on page 418
l "waf signature" on page 462
router policy
Use this command to configure policy routes that redirect traffic away from a static route.
For example, you can divert traffic for intrusion protection scanning (IPS). It is also useful if your FortiWeb protects web
servers for different customers (for example, the clients of a Managed Security Service Provider).
Policy routes can direct traffic to a specific network interface and gateway based on the packet’s source and destination
IP address.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
netgrp area. For details, see "Permissions" on page 51.
Syntax
config router policy
edit <policy_index>
set iif "<incoming_interface_name>"
set src "<source_ip>"
set dst "<destination_ip>"
set oif "<outgoing_interface_name>"
set gateway "<router_ip>"
set priority <priorty_int>
next
end
src "<source_ip>" Enter the source IP address and netmask to match, separated 0.0.0.0
with a space. 0.0.0.0
"<outgoing_interface_ Enter the name of the interface, such as port2, through which No
name>" FortiWeb routes packets that match the specified IP address default.
information.
gateway "<router_ip>" A gateway address is not required for the particular routing 0.0.0.0
policies used as static routes in an one-arm topology. Leave
this blank for a one-arm network topology.
priority <priorty_int> Enter a value between 1 and 200 that specifies the priority of the 200
route.
When packets match more than one policy route, FortiWeb directs
traffic to the route with the lowest value.
Related topics
l "router static" on page 106
l "router setting" on page 104
router setting
Use this command to change how FortiWeb handles non-HTTP/HTTPS traffic (for example, SSH and FTP) when it is
operating in Reverse Proxy mode.
When this setting is disabled (the default) and FortiWeb is operating in Reverse Proxy mode, the appliance drops any
non-HTTP/HTTPS traffic.
When this setting is enabled and FortiWeb is operating in Reverse Proxy mode, the appliance handles non-
HTTP/HTTPS protocols in the following ways:
l Any non-HTTP/HTTPS traffic destined for a virtual server on the appliance is dropped.
l For any non-HTTP/HTTPS traffic destined for another destination (for example, a back-end server), FortiWeb acts as a
router and forwards it based in its destination address.
This command has no effect when FortiWeb is operating in transparent modes, which allow and forward non-
HTTP/HTTPS packets by default.
Use this setting only if necessary. For security and performance reasons, if you
have a FortiGate with an Internet/public address virtual IP (VIP) that forwards traffic to
your FortiWeb, and your FortiWeb is on the same subnet as your web servers, do not
use this setting. Instead, configure the VIP to forward:
Routing is best effort. Not all protocols may be supported, such as Citrix Receiver
(formerly ICA).
FortiWeb appliances are designed to provide in-depth protection specifically for the HTTP and HTTPS protocols.
Because of this, when in Reverse Proxy mode, by default, FortiWeb does not forward non-HTTP/HTTPS
protocols to your protected web servers. That is, IP-based forwarding is disabled. Traffic is only forwarded if picked up
and scanned by the HTTP Reverse Proxy. This provides a secure default configuration by blocking traffic to services that
might have been unintentionally left open and should not be accessible to the general public.
In some cases, however, a web server provides more services, not just HTTP or HTTPS. A typical exception is a server
that also allows SFTP and SSH access. In these cases, enable routing to allow FortiWeb to route the non-HTTP/HTTPS
traffic to the server using the server’s IP address. For HTTP/HTTPS services, direct traffic to the IP address of the
FortiWeb virtual server, which forwards requests to the back-end server after inspection.
Use the following commands to retrieve information about current static route values:
config router setting
get route static
end
To use this command, your administrator account’s access control profile must have either w or rw permission to the
netgrp area. For details, see "Permissions" on page 51.
Syntax
config router setting
set ip-forward {enable | disable}
set ip6-forward {enable | disable}
end
ip-forward {enable | Enable to forward non-HTTP/HTTPS traffic if its IPv4 IP address disable
disable} matches a static route.
Example
This example enables forwarding of non-HTTP/HTTPS traffic, based upon whether the IP address matches a route for
the web servers’ subnet, and regardless of HTTP proxy pickup.
config router setting
set ip-forward enable
end
Related topics
l "router static" on page 106
l "router policy" on page 103
l "router all" on page 1
router static
Use this command to configure static routes, including the default gateway.
Static routes direct traffic existing the FortiWeb appliance—you can specify through which network interface a packet
will leave, and the IP address of a next-hop router that is reachable from that network interface. The router is aware of
which IP addresses are reachable through various network pathways, and can forward those packets along pathways
capable of reaching the packets’ ultimate destinations.
A default route is a special type of static route. A default route matches all packets, and defines a gateway router that
can receive and route packets if no more specific static route is defined for the packet’s destination IP address.
During installation and setup, you should have configured at least one static route, a default route, that points to your
gateway. You may configure additional static routes if you have multiple gateway routers, each of which should receive
packets destined for a different subset of IP addresses.
For example, if a web server is directly attached to one of the network interfaces, but all other destinations, such as
connecting clients, are located on distant networks such as the Internet, you might need to add only one route: a default
route for the gateway router through which the FortiWeb appliance connects to the Internet.
The FortiWeb appliance examines the packet’s destination IP address and compares it to those of the static routes. If
more than one route matches the packet, the FortiWeb appliance applies the route with the smallest index number. For
this reason, you should give more specific routes a smaller index number than the default route.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
netgrp area. For details, see "Permissions" on page 51.
Syntax
config router static
edit <route_index>
set device "<interface_name>"
set dst "<destination_ip>"
set gateway "<router_ip>"
next
end
<route_index> Enter the index number of the static route. If multiple routes No
match a packet, the one with the smallest index number is default.
applied.
dst "<destination_ip>" Enter the destination IP address and netmask of traffic that 0.0.0.0
will be subject to this route, separated with a space. 0.0.0.0
Example
This example configures a default route that forwards all packets to the gateway router 192.0.2.1, through the
network interface named port1.
config router static
edit 0
set dst "0.0.0.0 0.0.0.0"
set gateway "192.0.2.1"
set device port1
next
end
Related topics
l "router setting" on page 104
l "router policy" on page 103
l "system interface" on page 280
l "log syslog-policy" on page 98
l "server-policy policy" on page 146
l "system admin" on page 201
l "system dns" on page 242
l "system snmp community" on page 299
l "wad website" on page 332
l "traceroute" on page 655
l "network arp" on page 602
l "network ip" on page 603
server-policy allow-hosts
A protected host group contains one or more IP addresses and/or fully qualified domain names (FQDNs). Each entry in
the protected host group defines a virtual or real web host, according to the Host: field in the HTTP header of requests
from clients, that you want the FortiWeb appliance to protect.
For example, if your web servers receive requests with HTTP headers such as:
GET /index.php HTTP/1.1
Host: www.example.com
you might define a protected host group with an entry of www.example.com and select it in the policy. This would
reject requests that are not for that host.
Unlike a physical server, which is a single IP at the network layer, a protected host group should contain all network IPs,
virtual IPs, and domain names that clients use to access the web server at the application (HTTP) layer.
For example, clients often access a web server via a public network such as the Internet. Therefore the protected host
group contains domain names, public IP addresses, and public virtual IPs on a network edge router or firewall that are
routable from that public network. But the physical server is only the IP address that the FortiWeb appliance uses to
forward traffic to the server and, therefore, is often a private network address (unless the FortiWeb appliance operates
in Offline Protection or either of the transparent modes).
l Policies
l Input rules
l Server protection exceptions
l Start page rules
l Page access rules
l URL access rules
l Allowed method exceptions
l HTTP authentication rules
l Hidden fields rules
l Many others
Rules can use protected host definitions to apply rules only to requests for a protected host. If you do not specify a
protected host group in the rule, the rule will be applied based upon other criteria such as the URL, but regardless of the
Host: field.
Policies can use protected host definitions to block connections that are not destined for a protected host. If you do not
select a protected host group in a policy, connections will be accepted or blocked regardless of the Host: field.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
traroutegrp area. For details, see "Permissions" on page 51.
Syntax
config server-policy allow-hosts
edit "<protected-hosts_name>"
set default-action {allow | deny | deny_no_log}
config host-list
edit <protected-host_index>
set action {allow | deny | deny_no_log}
set host {"<host_ipv4>" | "<host_fqdn>" | "<host_ipv6>"}
next
end
next
end
<protected-host_index> Enter the index number of a protected host within its group. No
Each host-list can contain up to 64 IP addresses and/or fully default.
qualified domain names (FQDNs).
host {"<host_ipv4>" | Enter the IP address or FQDN of a virtual or real web host, as No
"<host_fqdn>" | "<host_ it appears in the Host: field of HTTP headers, such as default.
ipv6>"}
www.example.com. The maximum length is 255 characters.
Example
This example configures a protected hosts group named example_com_hosts that contains a website’s domain
names and its IP address in order to match HTTP requests regardless of which form they use to identify the host.
config server-policy allow-hosts
set default-action deny
edit "example_com_hosts"
config host-list
edit 0
set host "example.com"
next
edit 1
set host "www.example.com"
next
edit 2
set host "10.0.0.1"
next
end
next
end
Related topics
l "server-policy policy" on page 146
l "waf allow-method-exceptions" on page 337
l "server-policy custom-application application-policy" on page 110
l "waf input-rule" on page 424
l "waf signature" on page 462
l "waf start-pages" on page 485
l "waf page-access-rule" on page 457
l "waf hidden-fields-rule" on page 399
Some web applications build URLs differently than expected by FortiWeb, which causes FortiWeb to create incorrect
auto-learning data.
To solve this kind of problem, FortiWeb uses application policy plug-ins that recognize the non-standard application
URLs so that the auto-learning profile can work properly.
First create a URL interpreter and then use this command to create an application policy to use it. For details, see
"server-policy custom-application url-replacer" on page 112.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
traroutegrp area. For details, see "Permissions" on page 51.
Syntax
config server-policy custom-application application-policy
edit "<policy_name>"
config rule-list
edit <entry_index>
set plugin-name "<url-replacer_name>"
set type {URL_Replacer}
next
end
next
end
"<policy_name>" Enter the name of a new or existing application policy. The No default.
maximum length is 63 characters.
Enter the index number of the individual rule in the table. The
<entry_index> No default.
valid range is 1–9,999,999,999,999,999,999.
plugin-name "<url- Enter the name of an existing URL interpreter. The maximum No default.
replacer_name>" length is 63 characters.
Enter the name of the plug-in type. Currently, only the URL_ URL_
type {URL_Replacer}
Replacer option is supported. Replacer
Example
This example adds two existing URL replacer plug-ins to an application policy.
config server-policy custom-application application-policy
edit "replacer-policy1"
config rule-list
edit 1
set plugin-name "url-replacer1"
next
edit 2
set plugin-name "url-replacer2"
next
end
next
end
Related topics
l "server-policy custom-application url-replacer" on page 112
l "waf web-protection-profile autolearning-profile" on page 516
When web applications have dynamic URLs or unusual parameter styles, you must adapt auto-learning to recognize
them.
By default, auto-learning assumes that your web applications use the most common URL structure:
l All parameters follow a question mark ( ? ). They do not follow a hash ( # ) or other separator character.
l If there are multiple name-value pairs, each pair is separated by an ampersand ( & ). They are not separated by a semi-
colon ( ; ) or other separator character.
l All paths before the question mark ( ? ) are static—they do not change based upon input, blending the path with
parameters (sometimes called a dynamic URL).
For example, the page at:
/app/main
always has that same path. After a person logs in, the page’s URL doesn’t become:
/app/marco/main
or
/app#deepa
For another example, the URL does not dynamically reflect inventory, such as:
/app/sprockets/widget1024894
Some web applications, however, embed parameters within the path structure of the URL, or use unusual or non-
uniform parameter separator characters. If you do not configure URL replacers for such applications, it can
cause your FortiWeb appliance to gather auto-learning data incorrectly. This can cause the following
symptoms:
l When you generate a protection profile from auto-learning, it contains many more URLs than actually exist, because auto-
learning cannot predict that the URL is actually dynamic.
l Parameter data is not complete, despite the face that the FortiWeb appliance has seen traffic containing the parameter.
For example, with Microsoft Outlook Web App (OWA), the user’s login name could be embedded within the path
structure of the URL, such as:
/owa/tom/index.html
/owa/mary/index.html
Auto-learning would continue to create new URLs as new users are added to OWA. Auto-learning would also expend
extra resources learning about URLs and parameters that are actually the same. Additionally, auto-learning may not be
able to fully learn the application structure, as each user may not request the same URLs.
To solve this, you would use this command and config server-policy custom-application
application-policy (page 110) to apply a URL replacer that recognizes the user name within the OWA URL as if
it were a standard, suffixed parameter value so that auto-learning can function properly.
3. Apply the custom application policy in an auto-learning profile. For details, see "waf web-protection-profile
autolearning-profile" on page 516.
4. Finally, apply the auto-learning profiles in a server policy. For details, see "server-policy policy" on page 146.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
traroutegrp area. For details, see "Permissions" on page 51.
Syntax
config server-policy custom-application url-replacer
edit "<interpreter_name>"
set type {pre-defined | custom-defined}
set app-type {jsp | owa-2003}
set url "<original-url_str>"
set new-url "<new-url_str>"
set param "<value_str>"
set new-param "<replaced-param_name>"
next
end
Select either:
app-type {jsp | owa-2003} If type is pre-defined, select which predefined URL jsp
interpreter to use, either:
Example
This example assumes the HTTP request URL from a client is /mary/login.asp. The URL replacer interprets the
URL to be /login.asp?username=mary.
config server-policy custom-application url-replacer
edit "url-replacer1"
set type custom-defined
set url "^/(.*)/(.*)$"
set new-url "/$1"
set param "$0"
set new-param "username"
next
end
Related topics
l "server-policy custom-application application-policy" on page 110
server-policy health
Tests for server responsiveness (called “server health checks” in the web UI) poll web servers that are members of a
server pool to determine their availability before forwarding traffic. Server health checks can use TCP, HTTP/HTTPS,
ICMP ECHO_REQUEST (ping), TCP SSL, or TCP half-open.
The FortiWeb appliance polls the server at the frequency set in the interval <seconds_int> (page 119) option.
If the appliance does not receive a reply within the timeout period, and you have configured the health check to retry, it
attempts a health check again; otherwise, the server is deemed unresponsive. The FortiWeb appliance reacts to
unresponsive servers by disabling traffic to that server until it becomes responsive.
If a back-end server will be unavailable for a long period, such as when a server is
undergoing hardware repair, it is experiencing extended downtime, or when you have
removed a server from the server pool, you can improve the performance of your FortiWeb
appliance by disabling the back-end server, rather than allowing the server health check to
continue to check for responsiveness. For details, see "server-policy server-pool" on page
170.
To apply server health checks, select them in a server pool configuration. For details, see "server-policy server-pool" on
page 170.
To use this command, your administrator account’s access control profile requires either w or rw permission to the
traroutegrp area. For details, see "Permissions" on page 51.
Syntax
config server-policy health
edit "<health-check_name>"
set trigger-policy "<trigger-policy_name>"
set relationship {and |or}
configure health-list
edit <entry_index>
set type {icmp | tcp | http | https | tcp-ssl | tcp-half-open}
set timeout <seconds_int>
set retry-times <retries_int>
set interval <seconds_int>
set url-path "<request_str>"
set method {get | head | post}
set host "<host_str>"
set match-type {response-code | match-content | all}
set response-code {response-code_int}
set match-content "<match-content_str>"
next
end
"<health-check_name>" Enter the name of the server health check. The No default.
maximum length is 63 characters.
retry-times <retries_ Enter the number of times, if any, a failed health check will 3
int> be retried before the server is determined to be
unresponsive. The valid range is 1–10.
host "<host_str>" Optionally, enter the HTTP host header name of a specific No default.
host.
response-code {response- Enter the response code that you require the server to 200
code_int} return to confirm that it is available, if match-type
is response-code or all.
Example
This example configures a server health check that periodically requests the main page of the website, /index. If a
physical server does not successfully return that page (which contains the word “About”) every 10 seconds (the default),
and fails the check at least three times in a row, FortiWeb considers it unresponsive and forwards subsequent HTTP
requests to other physical servers in the server farm.
config server-policy health
edit "status_check1"
set trigger-policy "notification-servers1"
configure health-list
edit 1
set type http
set retry-times 3
set url-path "/index"
set method get
set match-type match-content
set regular About
next
end
Related topics
l "server-policy server-pool" on page 170
l "server-policy policy" on page 146
l "log trigger-policy" on page 101
server-policy http-content-routing-policy
Instead of dynamically routing requests to a server pool simply based upon load or connection distribution at the TCP/IP
layers, as basic load balancing does, you can forward them based on headers in the HTTP layer.
HTTP header-based routes define how FortiWeb routes requests to server pools. They are based on one or more of the
following HTTP header elements:
l Host
l URL
l Parameter
l Referer
l Cookie
l Header
l Source IP
l X.509 certificate
This type of routing can be useful if, for example, a specific web server or group of servers on the back end support
specific web applications, functions, or host names. That is, your web servers or server pools are not identical, but
specialized. For example:
To apply your HTTP-based routes, select them when you configure the server policy. For details, see "server-policy
policy" on page 146.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
traroutegrp area. For details, see "Permissions" on page 51.
Syntax
config server-policy http-content-routing-id
edit "<routing-policy_name>"
set server-pool "<server-pool_name>"
config content-routing-match-list
edit <entry_index>
set match-object {http-host | http-request | url-parameter | http-referer
| http-cookie | http-header | source-ip | x509-certificate-Subject |
x509-certificate-Extension | https-sni}
set match-condition {match-begin | match-end | match-sub | match-domain |
match-dir | match-reg | ip-range | ip-range6 | equal}
set x509-subject-name {E | CN | OU | O | L | ST | C}
set match-expression "<match-expression_str>"
set name "<name_str>"
"<routing-policy_name>" Enter the name of the HTTP content routing policy. The No
maximum length is 63 characters. default.
<entry_index> Enter the index number of the individual rule in the table. The valid No
range is 1–9,999,999,999,999,999,999. default.
l http-host—Host: field
l http-request—A URL
l url-parameter—A URL parameter and value
match-object {http-host | l http-referer—Referer: field
http-request | url- l http-cookie—A cookie name and value
parameter | http-referer
| http-cookie | http- l http-header—A header name and value No
header | source-ip | l source-ip—An IPv4 address or address range or IPv6 address default.
x509-certificate-Subject
or address range
| x509-certificate-
Extension | https-sni} l x509-certificate-Subject—A specified Relative
Distinguished Name (RDN) in the X509 certificate Subject field.
Also specify x509-subject-name.
l x509-certificate-Extension—Additional fields that the
extensions field adds to the X509 certificate
l https-sni— Select this option so that FortiWeb will forward
requests based on the SNI in the SSL handshake.
match-condition {match- Enter the type of value to match. Values can be a literal value No
dname1.abc.com
dname1.dname2.abc.com
However, the same Match Simple String value does not match
the following hostnames:
abc.com No
dname.abc default.
If match-object is http-request:
test.com/abc/
test.com/dir1/abc/
test.com/abc
test.abc.com
If match-object is source-ip:
name "<name_str>" Enter the name of the object to match. The value can be a No
literal value or a regular expression. default.
value "<value_str>" Enter the object value to match. The value can be a literal No
value or a regular expression. default.
reverse {enable | When enabled, FortiWeb will route requests to the server pool that
disable} do not match the specified values for the Match Object.
Select either:
Example
This HTTP content routing policy routes requests for www.example.com/school to the server pool school-site.
The content routing has three rules: one matches the host (www.example.com), a second matches the sessid
cookie, and a third matches the /school URL. In combination, the first and third rules match the request for
www.example.com/school.
config server-policy http-content-routing-policy
edit "content_routing_policy1"
set server-pool school-site
config content-routing-match-list
edit 1
set match-condition match-reg
set match-expression "www.example.com "
next
edit 2
set match-object http-cookie
set name sessid
set value "hash[a-fA-F0-7]*"
set name-match-condition match-reg
set value-match-condition match-reg
next
edit 3
set match-object http-request
set match-expression "/school"
next
end
next
end
Related topics
l "server-policy server-pool" on page 170
l "server-policy policy" on page 146
l "waf url-rewrite url-rewrite-policy" on page 496
Use this command to configure custom data types to augment the predefined data types. You can add custom data
types to input rules to define the data type of an input, and to auto-learning profiles to detect valid input parameters.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
traroutegrp area. For details, see "Permissions" on page 51.
Syntax
config server-policy pattern custom-data-type
edit "<custom-data-type_name>"
set expression "<regex_pattern>"
next
end
"<custom-data-type_name>" Enter the name of the custom data type. The maximum length No
is 63 characters. default.
Example
This example configures two custom data types.
config server-policy pattern custom-data-type
edit "Level 3 Password-custom"
set expression "^aaa"
next
edit "Custom Data Type 1"
set expression "^555"
next
end
Related topics
l "server-policy pattern data-type-group" on page 132
Use this command to configure objects that will be exempt from scans.
When enabled, whitelisted items are not flagged as potential problems, nor incorporated into auto-learning data. This
feature reduces false positives and improves performance.
To include white list items during policy enforcement and auto-learning reports, you must first disable them in the global
white list.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
traroutegrp area. For details, see "Permissions" on page 51.
Syntax
config server-policy pattern custom-global-white-list-group
edit <entry_index>
set status {enable | disable}
set type {Cookie | Parameter | URL}
set domain "<cookie_fqdn>"
set name "<name_str>"
set path "<url_str>"
set request-type {plain | regular}
set request-file "<url_str>"
next
end
<entry_index> Enter the index number of the individual rule in the table. The valid No
range is 1–9,223,372,036,854,775,807. default.
status {enable | disable} Enable to exempt this object from all scans. enable
type {Cookie | Indicate the type of the object. Depending on your selection, the URL
Parameter | URL} remaining settings vary.
Example
This example exempts requests for robots.txt from most scans.
config server-policy pattern custom-global-white-list-group
edit 1
set request-file "/robots.txt"
next
end
Related topics
l "waf web-protection-profile inline-protection" on page 518
l "waf web-protection-profile autolearning-profile" on page 516
Use this command to configure custom suspicious URL requests to augment the list of predefined suspicious URL
requests. You can add custom suspicious URLs to a custom suspicious URL rule.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
traroutegrp area. For details, see "Permissions" on page 51.
Syntax
config server-policy pattern custom-susp-url
edit "<custom-susp-url_name>"
set expression "<url_pattern>"
next
end
"<custom-susp-url_name>" Enter the name of the custom URL. The maximum length is No
63 characters. default.
Example
This example configures a custom suspicious URL named Suspicious-URL 1 and defines the custom expression
associated with that suspicious URL.
config server-policy pattern custom-susp-url
edit "Suspicious URL 1"
Related topics
l "server-policy pattern suspicious-url-rule" on page 137
Use this command to add one or more existing custom suspicious URLs to a custom suspicious URL rule.
Custom suspicious URL rules can augment the predefined suspicious URL rules. You can add custom suspicious URL
rules to input rules.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
traroutegrp area. For details, see "Permissions" on page 51.
Syntax
config server-policy pattern custom-susp-url-rule
edit "<rule_name>"
config type-list
edit <entry_index>
set custom-susp-url "<suspicious-url_name>"
next
end
next
end
"<rule_name>" Enter the name of a new or existing rule. The maximum length No
is 63 characters. default.
Enter the index number of the individual entry in the table. The valid No
<entry_index>
range is 1–9,999,999,999,999,999,999. default.
Example
This example configures a custom suspicious URL rule using an existing custom suspicious URL.
config server-policy pattern custom-susp-url-rule
edit "Suspicious Rule 1"
config type-list
edit 1
set custom-susp-url "Suspicious URL 1"
next
end
next
end
Related topics
l "server-policy pattern custom-susp-url" on page 130
A data type group selects a subset of one or more predefined data types. Each of those entries in the data type group
defines a type of input that the FortiWeb appliance should attempt to recognize and track in HTTP sessions when
gathering data for an auto-learning profile.
For example, if you include the Email data type in the data type group, auto-learning profiles that use the data type
group might discover that your web applications use a parameter named username whose value is an email address.
If you know that your network’s HTTP sessions do not include a specific data type, omit it from the data type group to
improve performance. The FortiWeb appliance will not expend resources scanning traffic for that data type.
Data type groups are used by auto-learning profiles. For details, see "server-policy policy" on page 146.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
traroutegrp area. For details, see "Permissions" on page 51.
Syntax
config server-policy pattern data-type-group
edit "<data-type-group_name>"
config type-list
edit <entry_index>
set data-type {Address | Canadian_Post_code | Canadian_Province_Name |
Canadian_SIN | China_Post_Code | Country_Name | Credit_Card_Number |
Danmark_Postalcode | Dates_and_Times | Email | GPA | GUID | ip_
address | Indian_Vehicle_Number | Italian_mobile_phone | Kuwait_Civil_
ID | L1_Password | L2_Password | Markup_or_Code | Microsoft_product_
key | NINO | Netherlands_Postcode | Num | personal_name | Phone |
Quebec_Postal_Code | String | Swedish_personal_number | Swedish_
Postalcode | UAE_land_phone | UK_Bank_code | UK_postcode | US_SSN |
US_State_Name | US_Street_Address | US_Zip_Code | Unix_device_name |
Uri | Windows_file_name}
next
end
next
end
"<data-type-group_ Enter the name of the data type group. The maximum length is No
name>" 63 characters. default.
Enter the index number of the individual entry in the table. The valid No
<entry_index>
range is 1–9,999,999,999,999,999,999. default.
data-type {Address | For each data-type entry, enter one of the following No
Canadian_Post_code | predefined data types exactly as shown (available options may default.
Canadian_Province_
Name | Canadian_SIN | vary due to FortiGuard updates):
China_Post_Code |
l Address—Canadian postal codes and United States ZIP code and
Country_Name | Credit_
Card_Number | Danmark_ ZIP + 4 codes.
Postalcode | Dates_and_ l Canadian_Post_code—Canadian postal codes such as
Times | Email | GPA | K2H 7B8 or k2h7b8. Does not match hyphenations such as K2H-
GUID | ip_address |
Indian_Vehicle_Number |
7B8.
Italian_mobile_ l Canadian_Province_Name—Modern and older names and
phone | Kuwait_Civil_ abbreviations of Canadian provinces in English, as well as some
ID | L1_Password | L2_ abbreviations in French, such as Quebec, IPE, Sask, and Nunavut.
Password | Markup_or_
Code | Microsoft_ Does not detect province names in French, such as Québec.
product_key | NINO | l Canadian_SIN—Canadian Social Insurance Numbers (SIN) such
Netherlands_Postcode | as 123-456-789.
Num | personal_name |
Phone | Quebec_ l China_Post_Code—Chinese postal codes such as 610000.
Postal_Code | l Country_Name—Country names, codes, and abbreviations in
String | Swedish_ English characters, such as CA, Cote d’Ivoire, Brazil, Russian
personal_number |
Swedish_Postalcode | Federation, Brunei, and Dar el Salam.
UAE_land_phone | UK_ l Credit_Card_Number—American Express, Carte Blanche,
Bank_code | UK_ Diners Club, enRoute, Japan Credit Bureau (JCB), Master Card,
postcode | US_SSN | US_ Novus, and Visa credit card numbers.
State_Name | US_Street_
Address | US_Zip_Code | l Danmark_Postalcode—Danish postal code (“postnumre”) such
Unix_device_name | as DK-1499 and dk-1000. Does not match codes that are not
Uri | Windows_file_ prefixed by “DK-”, nor numbers that do not belong to the range of
name}
valid codes, such as 123456 or dk 12.
l Dates_and_Times—Dates and times in various formats such as
+13:45 for time zone offsets, 1:01 AM, 1am, 23:01:01, and
01.01.30 AM for times, and 31.01.2009, 31/01/2009, 01/31/2000,
2009-01-3, 31-01-2009, 1-31-2009, 01 Jan 2009, 01 JAN 2009, 20-
Jan-2009 and February 29, 2009 for dates.
l Email—Email addresses such as
[email protected]
http://docs.fortinet.com/fortiweb/admin-guides
Example
This example configures a data type group named data-type-group1 that detects addresses and phone numbers
when an auto-learning profile uses it.
config server-policy pattern data-type-group
edit "data-type-group1"
config type-list
edit 1
set data-type Address
next
edit 2
set data-type Phone
next
end
next
end
Related topics
l "waf web-protection-profile autolearning-profile" on page 516
Use this command to add one or more predefined suspicious URL rules to a suspicious URL rule group.
Each entry in a suspicious URL group defines a type of URL that the FortiWeb appliance considers to be possibly
malicious when gathering data for an auto-learning profile.
HTTP requests for URLs typically associated with administrative access to your web applications or web server, for
example, may be malicious if they originate from the Internet instead of your management LAN. You may want to
discover such requests for the purpose of designing blacklist page rules to protect your web server.
If you know that your network’s web servers are not vulnerable to a specific type of suspicious URL, such as if the URL is
associated with attacks on Microsoft IIS web servers but all of your web servers are Apache web servers, omit it from the
suspicious URL group to improve performance. The FortiWeb appliance will not expend resources scanning traffic for
that type of suspicious URLs.
To see the regular expressions used in the predefined suspicious URL rules, in the web UI, go to Auto Learn >
Predefined Pattern > URL Pattern.
Suspicious URL groups are used by auto-learning profiles. For details, see "server-policy policy" on page 146.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
traroutegrp area. For details, see "Permissions" on page 51.
Syntax
config server-policy pattern suspicious-url-rule
edit "<rule-group_name>"
config type-list
edit <entry_index>
set server-type { Abyss | Apache | Appweb | BadBlue | Blazix | Cherokee |
ColdFusion | IIS | JBoss | Jetty | Jeus_WebContainer | LotusDomino |
Tomcat | WebLogic | WebSEAL | WebSiphon | Xerver | ZendServer |
aolserver | ghttpd | lighttpd | lilhttpd | localweb2000 |
mywebserver | ngnix | omnihttpd | samba | squid | svn | webshare |
xeneo | xitami | zeus | zope}
next
end
set custom-susp-url-rule "<rule_name>"
next
end
next
end
"<rule-group_name>" Enter the name of the suspicious URL rule group. The No
maximum length is 63 characters. default.
Enter the index number of the individual entry in the table. The valid No
<entry_index>
range is 1–9,999,999,999,999,999,999. default.
server-type { Abyss | For each rule index, select the type of the web server, application, No
Apache | Appweb | or servlet. FortiWeb will detect attempts to access URLs that are default.
BadBlue | Blazix |
usually sensitive for that software.
Cherokee | ColdFusion |
IIS | JBoss | Jetty |
Jeus_WebContainer |
LotusDomino | Tomcat |
WebLogic | WebSEAL |
WebSiphon | Xerver |
ZendServer | aolserver |
ghttpd | lighttpd |
lilhttpd | localweb2000 |
mywebserver | ngnix |
omnihttpd | samba |
squid | svn | webshare |
xeneo | xitami | zeus |
zope}
Enter the name of a custom suspicious URL rule. For details, see
"<rule_name>"
"server-policy pattern custom-susp-url-rule" on page 131.
Example
This example configures a suspicious URL rule group named suspicious-url-group1 that detects HTTP requests
for administratively sensitive URLs for some common web servers that could represent attack attempts and includes a
custom suspicious URL rule.
config server-policy pattern suspicious-url-rule
edit "suspicious-url-group1"
config type-list
edit 1
set server-type Apache
next
edit 2
set server-type Apache
next
edit 3
set server-type Tomcat
next
edit 4
set server-type WebLogic
next
end
set custom-susp-url-rule Suspicious URL 1
next
end
Related topics
l "waf web-protection-profile autolearning-profile" on page 516
l "server-policy pattern custom-susp-url" on page 130
Use this command to configure the global threat weight of security violations. When a security violation is detected, the
threat weight of the security violation is used to calculate the reputation of the device that launched the event. Access to
networks and servers can be managed according to a device's reputation calculated using the total threat weight of the
device.
For details about Threat Weight, see the FortiWeb Administration Guide:
http://docs.fortinet.com/fortiweb/admin-guides
To use this command, your administrator account’s access control profile must have either w or rw permission to the
admingrp area. For details, see "Permissions" on page 51.
Syntax
config server-policy pattern threat-weight
set allow-method {off | low | med | high | crit}
set brute-force-login {off | low | med | high | crit}
set cookie-security-policy {off | low | med | high | crit}
set crit <value_int>
set csrf-protection {off | low | med | high | crit}
set custom-policy {off | low | med | high | crit}
set custom-signature {off | low | med | high | crit}
set dos-protection {off | low | med | high | crit}
set file-upload-restriction {off | low | med | high | crit}
set ftp-security {off | low | med | high | crit}
set geo-ip {off | low | med | high | crit}
set hidden-field-protection {off | low | med | high | crit}
set high <value_int>
set http-protocol-constraints {enable | disable}
set illegal-json-format {off | low | med | high | crit}
set illegal-xml-format {off | low | med | high | crit}
set ip-list {off | low | med | high | crit}
set ip-reputaton {off | low | med | high | crit}
set low <value_int>
set med <value_int>
set padding-oracle-protection {off | low | med | high | crit}
set page-access {off | low | med | high | crit}
set parameter-validation {off | low | med | high | crit}
allow-method {off | low Set the threat weight for HTTP request method violations. med
| med | high | crit}
brute-force-login {off
| low | med | high | Set the threat weight for attempted brute force logins. crit
crit}
cookie-security-policy Set the threat weight for cookie poisoning and other cookie-based high
{off | low | med | high | attacks.
crit}
Set the value for a critical threat weight. The range of accepted
crit <value_int> values is 0-100. The value of higher levels must be larger than 50
lower levels.
csrf-protection {off Set the threat weight for cross-site request forgery attacks. high
| low | med | high |
crit}
custom-signature {off Set the threat weight for attack signature and data leak signatures. high
| low | med | high |
crit}
file-upload-restriction Set the threat weight for violations of upload restriction policies. high
{off | low | med | high |
crit}
geo-ip {off | low | med | Set the threat weight for requests from blocked countries or regions
high
high | crit} based on the associated source IP address.
hidden-field-protection Set the threat weight for attempts to tamper with hidden field rules. high
{off | low | med | high |
crit}
Set the value for a high threat weight. The range of accepted values
high <value_int> is 0-100. The value of higher levels must be larger than lower 30
levels.
http-protocol-constraints Set to enable threat weights for HTTP protocol constraints. Once enable
{enable | disable}
enabled, the threat weight for each HTTP protocol constraint may
be set using config waf http-protocol-parameter-
restriction (page 418).
illegal-json-format {off
| low | med | high | Set the threat weight for illegal formatting in JSON data. high
crit}
illegal-xml-format {off Set the threat weight for illegal XML formatting. high
| low | med | high |
crit}
ip-reputaton {off | low Set the threat weight for requests from IP addresses with a poor crit
| med | high | crit} reputation.
Set the value for a low threat weight. The range of accepted values
low <value_int> is 0-100. The value of higher levels must be larger than lower 5
levels.
med <value_int> Set the value for a medium threat weight. The range of accepted 10
values is 0-100. The value of higher levels must be larger than
lower levels.
padding-oracle-protection
{off | low | med | high | Set the threat weight for padding oracle attacks. crit
crit}
page-access {off | low Set the threat weight for page order rule violations. med
| med | high | crit}
parameter-validation {off
| low | med | high | Set the threat weight for input rule violations. high
crit}
signature {enable Set to enable threat weights for signatures. Once enabled, the enable
| disable} threat weight for each signature may be set using config waf
signature (page 462).
url-access {off | low Set the threat weight for URL access rule violations. med
| med | high | crit}
ftp-security {off | low Set the threat weight for ftp security rule violations. med
| med | high | crit}
Example
This example adjusts the threat weight of DOS attacks.
config server-policy pattern threat-weight
set dos-protection crit
end
This example adjusts the risk level value of critical security violations.
config server-policy-pattern threat-weight
set crit 60
end
Related Topics
server-policy persistence-policy
Use this command to configure a persistence method and timeout that you can apply to server pools. The persistence
policy applies to all members of the server pool.
After FortiWeb has forwarded the first packet from a client to a pool member, some protocols require that subsequent
packets also be forwarded to the same back-end server until a period of time passes or the client indicates that it has
finished transmission.
To apply a persistence policy, select it when you configure a server pool. For details, see "server-policy server-pool" on
page 170.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
traroutegrp area. For details, see "Permissions" on page 51.
Syntax
config server-policy persistence-policy
edit "<persistence-policy_name>"
set type { source-ip | persistent-cookie | asp-sessionid | php-sessionid | jsp-
sessionid | insert-cookie | http-header | url-parameter | rewrite-cookie |
embedded-cookie | ssl-session-id }
set cookie-name "<cookie-name_str>"
set timeout "<timeout_int>"
set ipv4-netmask "<v4mask>"
set ipv6-mask-length "<v6mask>"
set http-header "<http-header_str>"
l url-parameter—Forwards subsequent
requests with the same value for a URL parameter
as the initial request to the same pool member.
Also configure url-parameter.
l rewrite-cookie—If the HTTP response has a
Set-Cookie: value that matches the value
specified by cookie-name "<cookie-name_
str>" (page 144), FortiWeb replaces the value
with a randomly generated cookie value. FortiWeb
forwards all subsequent requests with this
generated cookie value to the same pool member.
l embedded-cookie—If the HTTP response
contains a cookie with the name specified by
cookie-name "<cookie-name_str>" (page
144), FortiWeb preserves the original cookie value
and adds a randomly generated cookie value and a
~ (tilde) as a prefix. FortiWeb forwards all
subsequent requests with this cookie and prefix to
the same pool member.
l ssl-session-id—If a cookie in the initial
request contains an SSL session ID value,
FortiWeb forwards subsequent requests with the
same session ID value to the same pool member
as the initial request. FortiWeb preserves the
original cookie name.
For persistence types that use cookies, you can use
the sessioncookie-enforce setting to maintain
persistence for transactions within a session. For
details, see "server-policy policy" on page 146.
timeout "<timeout_ Enter the maximum amount of time between requests 300
int>" that FortiWeb maintains persistence, in seconds.
ipv6-mask-length Enter the IPv6 network prefix used for session persistence. 128
"<v6mask>"
http-header "<http- Enter the name of the HTTP header that the persistence
header_str>" No default.
feature uses to route requests.
url-parameter "<url- Enter the name of the URL parameter that the persistence No default.
parameter_str>" feature uses to route requests.
cookie-domain Enter a domain attribute for the cookie that FortiWeb No default.
"<cookie-domain_str>" inserts, if type { source-ip | persistent-
cookie | asp-sessionid | php-sessionid |
jsp-sessionid | insert-cookie | http-
header | url-parameter | rewrite-cookie |
embedded-cookie | ssl-session-id } (page
143) is insert-cookie.
Example
This example creates the persistence policy ip-persistence. When this policy is applied to a server pool, FortiWeb
forwards initial requests from an IP address using the load-balancing algorithm configured for the pool. It forwards any
subsequent requests with the same client IP address as the initial request to the same pool member. After FortiWeb
has not received a request from the IP address for 400 seconds, it forwards any subsequent initial requests from the IP
address using the load-balancing algorithm.
config server-policy persistence-policy
edit "ip-persistence"
set type source-ip
set timeout 400
next
end
Related topics
l "server-policy server-pool" on page 170
server-policy policy
HTTP policy behavior varies by the operation mode. FTP server policies are available only in Reverse Proxy mode. For
details, see the FortiWeb Administration Guide:
http://docs.fortinet.com/fortiweb/admin-guides
When you switch the operation mode, FortiWeb deletes server policies from the
configuration file if they are not applicable in the current operation mode.
To determine which type of server policy to create, configure protocol {HTTP | FTP} (page 159). If you're
planning to configure an FTP server policy, you'll need to confirm that system feature-visibility (page 247) is
enabled. For details, see "system feature-visibility" on page 247.
Before you configure an HTTP server policy, you can configure several policies and profiles:
l Configure a virtual server and server pool. For details, see "server-policy vserver" on page 196 and "server-policy server-
pool" on page 170.
l To route traffic based on headers in the HTTP layer, configure one or more HTTP content routing policies. For details, see
"server-policy http-content-routing-policy" on page 121.
l To restrict traffic based upon which hosts you want to protect, configure a group of protected host names. For details, see
"server-policy allow-hosts" on page 108.
l If you want the FortiWeb appliance to gather auto-learning data, generate or configure an auto-learning profile and its
required components. For details, see "waf web-protection-profile autolearning-profile" on page 516 and "server-policy
custom-application application-policy" on page 110.
l If you plan to authenticate users, you need to configure users, user groups, and authentication rules and policy, and
include the policy in an inline web protection profile. For details, see "user ldap-user" on page 318, "user local-user" on
page 322, "user ntlm-user" on page 323, "user user-group" on page 329, "waf http-authen http-authen-rule" on page 406,
and "waf http-authen http-authen-policy" on page 403.
l To apply a web protection profile to a server policy, you must first configure them. For details, see "waf web-protection-
profile inline-protection" on page 518 (Reverse Proxy mode or either of the transparent modes), or "waf web-protection-
profile offline-protection" on page 531 (Offline Protection mode) .
l If you want to use the FortiWeb appliance to apply SSL to connections instead of using physical servers, you must also
import a server certificate or create a Server Name Indication (SNI) configuration. For details, see "system certificate local"
on page 226, "system certificate sni" on page 231. , and "system certificate urlcert" on page 233.
l If you want the FortiWeb appliance to verify the certificate provided by an HTTP client to authenticate themselves, you
must also define a certificate verification rule. If you want to specify whether a client is required to present a personal
certificate or not based on the request URL, create a URL-based client certificate group. For details, see "system
certificate verify" on page 234.
You can also use SNMP traps to notify you of policy status changes, or when a policy enforces your network usage
policy. For details, see "system snmp community" on page 299.
Before you configure an FTP server policy, you can configure several policies and profiles:
l Configure an FTP command restriction rule. For details, see "waf ftp-command-restriction-rule" on page 390.
l Configure an FTP file check rule. For details, see "waf ftp-file-security" on page 393.
l Enable IP reputation intelligence. For details, see "waf ip-intelligence" on page 429.
l Create a geo IP rule. For details, see "waf geo-block-list" on page 395.
l Create an IP list. For details, see "waf ip-list" on page 433.
l Configure an FTP security inline profile. For details, see waf ftp-propredefined-global-white-listtection-profile.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
traroutegrp area. For details, see "Permissions" on page 51.
Syntax
config server-policy policy
edit "<policy_name>"
set allow-hosts "<hosts_name>"
set block-port <port_int>
set case-sensitive {enable | disable}
set certificate "<certificate_name>"
set client-certificate-forwarding {enable | disable}
set server-policy policy
set client-certificate-forwarding-sub-header "<header_str>"
set client-real-ip {enable | disable}
set client-timeout <seconds_int>
set comment "<comment_str>"
set data-capture-port <port_int>
set deployment-mode {server-pool | http-content-routing | offline-protection |
transparent-servers | wccp-servers}
set ftp-protection-profile <profile_name>
set half-open-threshold <packets_int>
set hpkp-header "<hpkp_name>"
set hsts-header {enable | disable}
set hsts-max-age <timeout_int>
set hsts-header {enable | disable}
set http-header-timeout <seconds_int>
l server-pool—Forwards
connections to a server pool.
Depending on the pool configuration,
FortiWeb either forwards connections
to a single physical server or domain
server or distributes the connection
among the pool members. Also
configure server-pool
"<server-pool_name>" (page
159). This option is available only if
the operating mode is Reverse Proxy
mode.
l http-content-routing—Use
HTTP content routing to route HTTP
requests to a specific server pool. This
option is available only if the FortiWeb
appliance is operating in Reverse
Proxy mode.
l offline-detection — Allows
connections to pass through the
FortiWeb appliance and applies an
Offline Protection profile. Also
configure server-pool
"<server-pool_name>" (page
159). This is the only option available
if operating mode is Offline
Protection.
l transparent-servers—Allows
connections to pass through the
FortiWeb appliance and applies a
protection profile. Also configure
server-pool "<server-pool_
name>" (page 159). This is the only
option available when the operating
mode is either True Transparent
Proxy or Transparent Inspection.
l wccp-servers—FortiWeb is a Web
Cache Communication Protocol
(WCCP) client that receives traffic
includeSubDomains
content-routing | offline-
protection | transparent-
servers | wccp-servers} (page
152) is set to server-pool and
https-service "<service_
name>" (page 156) is set correctly.
FortiWeb supports HTTP/2 only for
HTTPS connections and HTTP Content
Routing is not supported for HTTP/2.
http://docs.fortinet.com/fortiweb/admin-
guides
http-to-https {enable | disable} FortiWeb does not apply the protection disable
profile for this policy (specified by web-
protection-profile
"<profile_name>" (page 168)) to
the redirected traffic.
ocspstapling {enable | disable} Enable OCSP stapling for the certificate disable
you specified in certificate
"<certificate_name>" (page 150).
is Reverse Proxy.
l Not be expired
l Not be revoked by either the certificate
revocation list (CRL) (see "system certificate
verify" on page 234)
l Be signed by a certificate authority (CA)
whose certificate you have imported into the
FortiWeb appliance; if the certificate has
been signed by a chain of intermediate CAs,
those certificates must be included in an
intermediate CA group (see
intermediate-certificate-group
"<CA-group_name>" (page 156))
l Contain a CA field whose value matches the
CA certificate
l Contain an Issuer field whose value
matches the Subject field in the CA
certificate
Personal certificates, sometimes also
called user certificates, establish the
identity of the person connecting to the
website.
http://docs.fortinet.com/fortiweb/admin-
guides
The maximum length is 63 characters.
DHE-RSA-AES256-CCM8
DHE-RSA-AES256-CCM
ECDHE-ECDSA-AES128-GCM-SHA256
ECDHE-RSA-AES128-GCM-SHA256
DHE-DSS-AES128-GCM-SHA256
DHE-RSA-AES128-GCM-SHA256
ECDHE-ECDSA-AES128-CCM8
ECDHE-ECDSA-AES128-CCM
DHE-RSA-AES128-CCM8
DHE-RSA-AES128-CCM
ECDHE-ECDSA-AES256-SHA384 ECDHE-RSA-
ECDHE-RSA-AES256-SHA384 AES128-
DHE-RSA-AES256-SHA256 GCM-SHA256
DHE-DSS-AES256-SHA256 ECDHE-
ECDSA-
ECDHE-ECDSA-CAMELLIA256-SHA384
AES256-
ECDHE-RSA-CAMELLIA256-SHA384 SHA384
DHE-RSA-CAMELLIA256-SHA256 ECDHE-RSA-
DHE-DSS-CAMELLIA256-SHA256 AES256-
ECDHE-ECDSA-AES128-SHA256 SHA384
ECDHE-RSA-AES128-SHA256 ECDHE-
DHE-RSA-AES128-SHA256 ECDSA-
DHE-DSS-AES128-SHA256 AES128-
ECDHE-ECDSA-CAMELLIA128-SHA256 SHA256
ECDHE-RSA-CAMELLIA128-SHA256 ECDHE-RSA-
DHE-RSA-CAMELLIA128-SHA256 AES128-
DHE-DSS-CAMELLIA128-SHA256 SHA256
ECDHE-ECDSA-AES256-SHA ECDHE-
ECDHE-RSA-AES256-SHA ECDSA-
DHE-RSA-AES256-SHA AES256-SHA
DHE-DSS-AES256-SHA ECDHE-RSA-
DHE-RSA-CAMELLIA256-SHA AES256-SHA
DHE-DSS-CAMELLIA256-SHA ECDHE-
ECDHE-ECDSA-AES128-SHA ECDSA-
ECDHE-RSA-AES128-SHA AES128-SHA
DHE-RSA-AES128-SHA ECDHE-RSA-
AES128-SHA
DHE-DSS-AES128-SHA
AES256-
DHE-RSA-CAMELLIA128-SHA
GCM-SHA384
DHE-DSS-CAMELLIA128-SHA
AES128-
AES256-GCM-SHA384 GCM-SHA256
AES256-CCM8 AES256-
AES256-CCM SHA256
AES128-GCM-SHA256 AES128-
AES128-CCM8 SHA256
AES128-CCM
AES256-SHA256
CAMELLIA256-SHA256
AES128-SHA256
CAMELLIA128-SHA256
AES256-SHA
CAMELLIA256-SHA
AES128-SHA
CAMELLIA128-SHA
DHE-RSA-SEED-SHA
ECDHE_RSA_DES_CBC3_SHA
DES_CBC3_SHA
edit ?
http://docs.fortinet.com/fortiweb/admin-
guides
This option appears only if
deployment-mode {server-
pool | http-content-
routing | offline-
protection | transparent-
servers | wccp-servers} (page
152) is offline-detection.
is-default {yes | no} Enter yes to specify that FortiWeb applies No default.
the protection profile to any traffic that does
not match conditions specified in the HTTP
content routing policies.
Example
This example configures a web protection server policy. FortiWeb forwards HTTPS connections received by the virtual
server named virtual_ip1 to a server pool named apache1, which contains a single physical server. FortiWeb uses
the certificate named certificate1 during SSL negotiations with the client, then forwards traffic to the server pool.
config server-policy policy
edit "https-policy"
set deployment-mode server-pool
set vserver "virtual_ip1"
set server-pool "apache1"
Related topics
l "server-policy allow-hosts" on page 108
l "system certificate local" on page 226
l "system certificate remote" on page 229
l "server-policy http-content-routing-policy" on page 121
l "server-policy server-pool" on page 170
l "server-policy service custom" on page 192
l "server-policy vserver" on page 196
l "system snmp community" on page 299
l "system settings" on page 296
l "system v-zone" on page 310
l "waf web-protection-profile autolearning-profile" on page 516
l "waf web-protection-profile inline-protection" on page 518
l "waf web-protection-profile offline-protection" on page 531
l "debug application dssl" on page 564
l "debug application http" on page 569
l "debug application ssl" on page 573
l "debug application ustack" on page 575
l "debug flow filter" on page 581
l "policy" on page 614
server-policy server-pool
Server pools define a group of one or more physical or domain servers (web servers) that FortiWeb distributes
connections among, or where the connections pass through to, depending on the operation mode. Reverse Proxy mode
actively distributes connections; Offline Protection and either of the transparent modes do not actively distribute
connections.
To determine which type of server policy to create, configure protocol {HTTP | FTP} (page 175). If you're
planning to configure an FTP server policy, you'll need to confirm that system feature-visibility (page 247) is
enabled. For details, see "system feature-visibility" on page 247.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
traroutegrp area. For details, see "Permissions" on page 51.
Syntax
config server-policy server-pool
edit "<server-pool_name>"
set comment "<comment_str>"
set health "<health-check_name>"
set http-reuse {aggressive | always | never | safe}
set lb-algo {least-connections | round-robin | weighted-round-robin | uri-hash
| full-uri-hash | host-hash | host-domain-hash | src-ip-hash}
set persistence "<persistence-policy_name>"
set protocol {HTTP | FTP}
set reuse-conn-idle-time <int>
set reuse-conn-max-count <int>
set reuse-conn-max-request <int>
set reuse-conn-total-time <int>
set server-balance {enable | disable}
set server-pool-id
set type {offline-protection | reverse-proxy | transparent-servers-for-ti |
transparent-servers-for-tp | transparent-servers-for-wccp}
config pserver-list
edit <entry_index>
set analyzer-policy "<fortianalyzer-policy_name>"
set backup-server {enable | disable}
set certificate "<certificate_name>"
set certificate-verify "<verifier_name>"
set client-certificate "<client-certificate_name>"
set client-certificate-forwarding {enable | disable}
set client-certificate-forwarding-cert-header "<header_str>"
set client-certificate-forwarding-sub-header "<header_str>"
set client-certificate-proxy {enable | disable}
set client-certificate-proxy-sign-ca <sign_ca>
set conn-limit <conn-limit_int>
set domain "<server_fqdn>"
set health-check-inherit {enable | disable}
set hlck-domain <hlck-domain_str>
set hpkp-header "<hpkp_name>"
set hsts-header {enable | disable}
set hsts-max-age <timeout_int>
set http2 {enable | disable}
set implicit_ssl {enable | disable}
set intermediate-certificate-group "<CA-group_name>"
set ip {"address_ipv4" | "address_ipv6"}
set ocspstapling {enable | disable}
set ocspstapling-group "<group_name>"
set port <port_int>
set server-certificate-verify {enable | disable}
set server-certificate-verify-action {alert | alert_deny | redirect}
set server-certificate-verify-policy "<policy_name>"
set recover <recover_int>
set server-side-sni {enable | disable}
next
end
next
end
"<server-pool_name>" Enter the name of the server pool. The maximum length is No default.
63 characters.
health "<health-check_ Enter the name of a server health check FortiWeb uses to No default.
name>" determine the responsiveness of server pool members. The
maximum length is 63 characters.
When you specify a health check for the pool, by default, all
pool members use that health check. To select a different
health check for a pool member, in the pool member
configuration, specify disable for health-check-
inherit and the health check to use for health.
edit ?
lb-algo {least- Select the load-balancing algorithms that FortiWeb uses round-
connections | round- when it distributes new connections among server pool robin
robin | weighted-round-
robin | uri-hash | full- members.
uri-hash | host-hash |
l least-connections—Distributes new connections
host-domain-hash | src-
ip-hash} to the member with the fewest number of existing, fully-
formed connections.
l round-robin—Distributes new connections to the
next member of the server pool, regardless of weight,
response time, traffic load, or number of existing
connections. Unresponsive servers are avoided.
l weighted-round-robin—Distributes new
connections using the round robin method, except that
members with a higher weight value receive a larger
percentage of connections.
l uri-hash—Distributes new TCP connections using a
hash algorithm based on the URI found in the HTTP
header, excluding hostname.
l full-uri-hash—Distributes new TCP connections
using a hash algorithm based on the full URI string found
in the HTTP header. The full URI string includes the
hostname and path.
l host-hash—Distributes new TCP connections using a
hash algorithm based on the hostname in the HTTP
Request header Host field.
l host-domain-hash—Distributes new TCP
connections using a hash algorithm based on the domain
name in the HTTP Request header Host field.
l src-ip-hash—Distributes new TCP connections
using a hash algorithm based on the source IP address
of the request.
Note: When protocol {HTTP | FTP} (page 175) is
set to FTP, only round-robin, weighted-round-
robin, least-connections, and src-ip-hash are
available.
reuse-conn-total-time Enter the maximum time limit in which a cached server 100
<int> connection may be reused. If a cached server connection
exists for longer than the set limit, it will be closed. The
valid range is 1–1000.
ti | transparent-servers-for-tp |
transparent-servers-for-wccp} (page 176) is
reverse-proxy.
<entry_index> Enter the index number of the member entry within the No default.
server pool. The valid range is 1–
9,223,372,036,854,775,807.
backup-server {enable | Enter enable to configure this pool member as a backup server.
disable}
FortiWeb only routes connections for the pool to a backup server
when all the other members of the server pool fail their server
health check.
disable
The backup server mechanism does not work if you do not
specify server health checks for the pool members.
If you select this option for more than one pool member,
FortiWeb uses the load balancing algorithm to determine which
member to use.
certificate Enter the name of the certificate that FortiWeb uses to No default.
"<certificate_name>" decrypt SSL-secured connections.
Note: The client must support TLS 1.0, TLS 1.1, or TLS
1.2.
client-certificate Enter the client certificate that FortiWeb uses to connect to disable
"<client-certificate_ this server pool member.
name>"
Used when connections to this pool member require a valid
client certificate.
client-certificate- Enter a custom certificate header that will include the x-client-
forwarding-cert-header Base64 certificate of the X.509 personal certificate cert
"<header_str>"
presented by the client during the SSL/TLS handshake
when it forwards the traffic to the protected web server.
client-certificate- Enter a custom subject header that will include the subject
forwarding-sub-header of the X.509 personal certificate presented by the client
"<header_str>"
during the SSL/TLS handshake when it forwards the traffic x-client-
to the protected web server. dn
client-certificate-proxy- Select a Sign CA FortiWeb will use to verify and resign new
sign-ca <sign_ca> client certificates.
No default.
Note: This option is available only when the protocol
{HTTP | FTP} (page 175) is HTTP.
domain "<server_fqdn>" Enter the fully-qualified domain name of the web server to
include in the pool, such as www.example.com.
hlck-domain <hlck-
Enter the domain name of the server pool. No default.
domain_str>
hsts-max-age <timeout_ Enter the time to live in seconds for the HSTS header. 7776000
int>
This setting applies only if hsts-header {enable |
disable} (page 180) is enable.
Note: Make sure that this back web server really supports
HTTP/2 before you enable this, or connections will go failed.
2. disable—Make FortiWeb to converse HTTP/2 to HTTP/1.x
for this web server, or converse HTTP/1.x to HTTP/2 for the
clients, if this web server does not support HTTP/2.
When FortiWeb operates in True Transparent Proxy
mode( see opmode {offline-protection |
reverse-proxy | transparent |
transparent-inspection | wccp} (page 298)):
1. enable—Enable HTTP/2 security inspection. It only
requires this option to be enabled and the SSL be well-
configured to enable the HTTP/2 security inspection. No
HTTP/2 configuration is required for config server-
policy policy (page 146). When HTTP/2 inspection is
enabled in True Transparent Proxy mode, FortiWeb performs
no protocol conversions between HTTP/1.x and HTTP/2,
which means HTTP/2 connections will not be established
between clients and back-end web servers if the web servers
do not support HTTP/2.
2. disable—Disable HTTP/2 security inspection.
Note:
1. This option is available only if type {offline-
protection | reverse-proxy | transparent-
servers-for-ti | transparent-servers-for-
tp | transparent-servers-for-wccp} (page 176)
is set to reverse-proxy or transparent-servers-
for-tp; and when type is transparent-servers-
for-tp, this option is available only if ssl {enable |
disable} (page 185) is enable.
2. Please confirm your FortiWeb operation mode and the HTTP
versions your back-end web servers are running first to make
appropriate configuration here, so that HTTP/2 inspection
can work correctly with your web servers.
3. For details about HTTP/2 support, see the FortiWeb
Administration Guide:
http://docs.fortinet.com/fortiweb/admin-guides
Note: This option is available only when the protocol
{HTTP | FTP} (page 175) is HTTP.
implicit_ssl {enable Enable so that FortiWeb will communicate with the pool disable
| disable} member using implicit SSL.
http://docs.fortinet.com/fortiweb/admin-guides
Available only if type {offline-protection |
reverse-proxy | transparent-servers-for-
ti | transparent-servers-for-tp |
transparent-servers-for-wccp} (page 176) is
transparent-servers-for-tp and ssl
{enable | disable} (page 185) is enable. For
Reverse Proxy mode, configure this setting in the server
policy instead. For details, see intermediate-
certificate-group "<CA-group_name>" (page
156).
ip {"address_ipv4" | Enter the IP address of the web server to include in the No default.
"address_ipv6"} pool.
ocspstapling {enable | Enable OCSP stapling for the certificate you specified in
disable} certificate "<certificate_name>" (page 176).
ocspstapling-group Enter the custom OCSP group that defines the CA No default.
"<group_name>" certificate and URL of the OCSP server corresponding to
the certificate specified in certificate
"<certificate_name>" (page 176). For details, see
"system certificate remote" on page 229.
port <port_int> 80
Enter the TCP port number where the pool member listens for
(HTTP)/21
connections. The valid range is 1–65,535.
(FTP)
recover <recover_int> Specify the number of seconds that FortiWeb waits before it 0
forwards traffic to this pool member after a health check
indicates that this server is available again.
server-type {physical | Specify whether to specify the pool member by IP address or physical
domain} domain.
session-ticket-reuse Enable so that FortiWeb reuses the session ticket when disable
{enable | disable} establishing an SSL connection to a pserver. If the SSL
connection has a server name, FortiWeb can only reuse a
session ticket for the specified pserver.
sni {enable | disable} Enable to use a Server Name Indication (SNI) configuration
instead of or in addition to the server certificate specified by
certificate "<certificate_name>" (page 176).
sni-certificate "<sni_ Enter the name of the Server Name Indication (SNI) No default.
name>" configuration that specifies which certificate FortiWeb uses
when encrypting or decrypting SSL-secured connections for
a specified domain.
ssl {enable | disable} For Reverse Proxy, Offline Protection, and Transparent No default.
Inspection modes, specifies whether connections between
FortiWeb and the pool member use SSL/TLS.
ssl-cipher {medium | high For Reverse Proxy mode, specifies whether secure
| custom} connections between FortiWeb and the server pool member
use a medium-security, high-security, or custom set of
cipher suites.
http://docs.fortinet.com/fortiweb/admin-guides
Available only if type {offline-protection |
reverse-proxy | transparent-servers-for-
ti | transparent-servers-for-tp |
transparent-servers-for-wccp} (page 176) is
reverse-proxy, transparent-servers-for-tp,
or transparent-servers-for-wccp, and ssl
{enable | disable} (page 185) is enable.
ssl-custom-cipher Specify one or more cipher suites that FortiWeb allows. ECDHE-
{<cipher_1> <cipher2> ECDSA-
<cipher3> ...} Separate the name of each cipher with a space. To remove AES256-
from or add to the list of ciphers, retype the entire list. GCM-SHA384
ECDHE-RSA-
Valid values are: AES256-
GCM-SHA384
ECDHE-ECDSA-AES256-GCM-SHA384 ECDHE-
ECDHE-RSA-AES256-GCM-SHA384 ECDSA-
DHE-DSS-AES256-GCM-SHA384 CHACHA20-
DHE-RSA-AES256-GCM-SHA384 POLY1305
ECDHE-ECDSA-CHACHA20-POLY1305 ECDHE-RSA-
ECDHE-RSA-CHACHA20-POLY1305 CHACHA20-
DHE-RSA-CHACHA20-POLY1305 POLY1305
ECDHE-ECDSA-AES256-CCM8 ECDHE-
ECDHE-ECDSA-AES256-CCM ECDSA-
DHE-RSA-AES256-CCM8 AES128-
DHE-RSA-AES256-CCM GCM-SHA256
ECDHE-ECDSA-AES128-GCM-SHA256 ECDHE-RSA-
ECDHE-RSA-AES128-GCM-SHA256 AES128-
GCM-SHA256
DHE-DSS-AES128-GCM-SHA256
ECDHE-
DHE-RSA-AES128-GCM-SHA256
ECDSA-
ECDHE-ECDSA-AES128-CCM8 AES256-
ECDHE-ECDSA-AES128-CCM SHA384
DHE-RSA-AES128-CCM8 ECDHE-RSA-
DHE-RSA-AES128-CCM AES256-
ECDHE-ECDSA-AES256-SHA384 SHA384
ECDHE-RSA-AES256-SHA384 ECDHE-
DHE-RSA-AES256-SHA256 ECDSA-
DHE-DSS-AES256-SHA256 AES128-
ECDHE-ECDSA-CAMELLIA256-SHA384 SHA256
ECDHE-RSA-CAMELLIA256-SHA384 ECDHE-RSA-
DHE-RSA-CAMELLIA256-SHA256 AES128-
DHE-DSS-CAMELLIA256-SHA256 SHA256
ECDHE-ECDSA-AES128-SHA256 ECDHE-
ECDHE-RSA-AES128-SHA256 ECDSA-
DHE-RSA-AES128-SHA256 AES256-SHA
DHE-DSS-AES128-SHA256 ECDHE-RSA-
ECDHE-ECDSA-CAMELLIA128-SHA256 AES256-SHA
ECDHE-RSA-CAMELLIA128-SHA256 ECDHE-
DHE-RSA-CAMELLIA128-SHA256 ECDSA-
AES128-SHA
DHE-DSS-CAMELLIA128-SHA256
ECDHE-RSA-
ECDHE-ECDSA-AES256-SHA
AES128-SHA
ECDHE-RSA-AES256-SHA
AES256-
DHE-RSA-AES256-SHA GCM-SHA384
DHE-DSS-AES256-SHA AES128-
DHE-RSA-CAMELLIA256-SHA GCM-SHA256
DHE-DSS-CAMELLIA256-SHA AES256-
ECDHE-ECDSA-AES128-SHA SHA256
ECDHE-RSA-AES128-SHA AES128-
DHE-RSA-AES128-SHA SHA256
DHE-DSS-AES128-SHA
DHE-RSA-CAMELLIA128-SHA
DHE-DSS-CAMELLIA128-SHA
AES256-GCM-SHA384
AES256-CCM8
AES256-CCM
AES128-GCM-SHA256
AES128-CCM8
AES128-CCM
AES256-SHA256
CAMELLIA256-SHA256
AES128-SHA256
CAMELLIA128-SHA256
AES256-SHA
CAMELLIA256-SHA
AES128-SHA
CAMELLIA128-SHA
DHE-RSA-SEED-SHA
ECDHE_RSA_DES_CBC3_SHA
DES_CBC3_SHA
status {disable |enable | To specify the status of the pool member, enter one of the enable
maintain} following values:
reverse-proxy | transparent-servers-for-
ti | transparent-servers-for-tp |
transparent-servers-for-wccp} (page 176) is
reverse-proxy, transparent-servers-for-tp,
or transparent-servers-for-wccp, and ssl
{enable | disable} (page 185) is enable.
tls-v11 {enable | For Reverse Proxy mode, specifies whether secure enable
disable} connections between FortiWeb and the server pool member
can use the TLS 1.1 cryptographic protocol.
urlcert-hlen <len_int> Enter the maximum allowed length for an HTTP request No default.
with a URL that matches an entry in the URL-based client
certificate group, in kilobytes.
warm-rate <warm-rate_int> Specify the maximum connection rate (per second) while
the pool member is starting up.
warm-up <warm-up_int> Specify for how long (in seconds) FortiWeb forwards traffic 0
at a reduced rate after a health check indicates that this
pool member is available again but it cannot yet handle a
full connection load.
weight <weight_int> If the server pool uses the weighted round robin load-
balancing algorithm, type the numerical weight of the pool
member. Members with a greater weight receive a greater 0
proportion of connections.
ssl-session-timeout When FortiWeb is configured as an SSL server, you can set SSL No default.
<ssl-session-timeout_ session timeout intervals via the CLI. This is available only in
int> Reverse Proxy and True Transparent Proxy modes.
ssl-quiet-shutdown For HTTPS connection, when disabled, FortiWeb sends ssl alert
{enable | disable} message to the client or server pool first, and then FIN.
Disable
When enabled, FortiWeb directly sends FIN message instead of
sending ssl alert message.
server-certificate-
verify-policy Enter the certificate verity policy name. No default.
"<policy_name>"
server-certificate- Select which action the FortiWeb appliance will take when it No default.
verify-action {alert detects a certificate violation.
| alert_deny |
redirect}
Example
This example configures a server pool named server-pool1. It consists of two physical servers: 192.0.2.10 and
192.0.2.11.
When both servers are available, FortiWeb forwards connections to the server with the smallest number of connections.
config server-policy server-pool
edit "server-pool1"
set type reverse-proxy
set server-balance enable
set lb-algo least-connections
config pserver-list
edit 1
set status enable
set server-type physical
set ip "192.0.2.10"
set ssl disable
set port 8081
next
edit 2
set status enable
set server-type physical
set ip "192.0.2.11"
set ssl disable
set port 8082
next
end
next
end
Related topics
l "server-policy policy" on page 146
l "server-policy http-content-routing-policy" on page 121
l "system certificate local" on page 226
l "server-policy health" on page 116
l "server-policy persistence-policy" on page 142
l waf ftp-propredefined-global-white-listtection-profile
l "system feature-visibility" on page 247
You can add a custom services to a policy to define the protocol and listening port of a virtual server. For details, see
"server-policy policy" on page 146.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
traroutegrp area. For details, see "Permissions" on page 51.
Syntax
config server-policy service custom
edit "<service_name>"
set port <port_int>
set protocol TCP
next
end
"<service_name>" Enter the name of the new or existing custom network service. No
The maximum length is 63 characters. default.
Enter the port number on which a virtual server will receive TCP/IP
No
port <port_int> connections for HTTP or HTTPS requests. The valid range is 1–
default.
65,535.
Example
This example configures a service definition named SOAP1.
config server-policy service custom
edit "SOAP1"
set port 8081
set protocol TCP
next
end
Related topics
l "server-policy vserver" on page 196
l "server-policy policy" on page 146
l "server-policy custom-application application-policy" on page 110
This command only displays predefined services. It cannot be used to modify them. If you
attempt to edit the port number and protocol, the appliance will discard your settings.
Predefined Internet services can be selected in a policy in order to define the protocol and listening port of a virtual
server. For details, see "server-policy policy" on page 146.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
traroutegrp area. For details, see "Permissions" on page 51.
Syntax
config server-policy service predefined
edit "<service_name>"
show
next
end
Example
This example shows the default settings for all of the predefined services.
config server-policy service predefined
show
Output:
config server-policy service predefined
edit HTTP
set port 80
set protocol TCP
next
edit HTTPS
set port 443
set protocol TCP
next
end
Related topics
l "server-policy vserver" on page 196
l "server-policy policy" on page 146
l "server-policy service custom" on page 192
server-policy setting
Syntax
config server-policy setting
set core-file-count <core-file-count_int>
set enable-core-file {enable | disable}
set enable-session-statistics {enable | disable}
set enable-single-worker {enable | disable}
set hsm {enable | disable}
set no-session-limit {enable | disable}
set no-ssl-encrypt-then-mac {enable | disable}
set offline-session-timeout {seconds_int}
set use-first-ack-mac {enable | disable}
set dpdk {enable | disable}
set high-compatibility-mode {enable | disable}
end
Variable Description Default
core-file-count <core- The maximum core dump file number. The valid values are 3 No
file-count_int> and 5. default
enable-core-file {enable No
| disable} Enable/disable generating the core dump files.
default
enable-single-worker No
{enable | disable} Enable/disable single worker mode.
default
hsm {enable | disable} Specifies whether the settings you use to integrate FortiWeb with No
an HSM (hardware security module) are displayed in the web UI. default
no-session-limit {enable Enable not to limit the maximum concurrency sessions of virtual No
| disable} machine. default
high-compatibility-mode
{enable | disable} Enable to accelerate SSL transport. disable
offline-session-timeout Enter the offline session timeout. The valid range is seconds 30– No
{seconds_int} 1200 seconds. default
Related topics
l "server-policy vserver" on page 196
l "server-policy policy" on page 146
server-policy vserver
Before you can create a policy, you must first configure a virtual server which defines the network interface or bridge and
IP address on which traffic destined for an individual physical server or server farm will arrive.
When the FortiWeb appliance receives traffic destined for a virtual server, it can then forward the traffic to a physical
server or a server farm. The FortiWeb appliance identifies traffic as being destined for a specific virtual server if:
l The traffic arrives on the network interface or bridge associated with the virtual server
l For Reverse Proxy mode, the destination address is the IP address of a virtual server (the destination IP address is ignored
in other operation modes, except that it must not be identical with the physical server’s IP address)
Virtual servers can be on the same subnet as physical servers. This configuration
creates a one-arm HTTP proxy. For example, the virtual server 192.0.2.1/24
could forward to the physical server 192.0.2.2.
To apply virtual servers, select them within a server policy. For details, see "server-policy policy" on page 146.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
traroutegrp area. For details, see "Permissions" on page 51.
Syntax
config server-policy vserver
edit "<virtual-server_name>"
set status {enable | disable}
set interface "<interface_name>"
set vip "<virtual-ip_ipv4mask>"
set vip6 "<virtual-ip_ipv6mask>"
set use-interface-ip {enable | disable}
next
end
"<virtual-server_name>" Enter the name of the new or existing virtual server. The disable
maximum length is 63 characters.
edit ?
No
status {enable | disable} Enable to accept traffic destined for this virtual server.
default.
interface "<interface_ Enter the name of the network interface or bridge, such as No
name>" port1 or bridge1, to which the virtual server is bound, and default.
on which traffic destined for the virtual server will arrive. The
maximum length is 63 characters.
vip6 "<virtual-ip_ Enter the IPv6 address and subnet of the virtual server. ::/0
ipv6mask>"
Example
This example configures a virtual server named inline_vip1 on the network interface named port1.
The port number on which the virtual server will receive traffic is defined separately, in the policies that use this virtual
server definition.
config server-policy vserver
edit "inline_vip1"
set status enable
set interface port1
set vip "192.0.2.1 255.255.255.0"
next
end
Related topics
l "system interface" on page 280
l "server-policy policy" on page 146
l "server-policy service custom" on page 192
l "ping" on page 638
l "network ip" on page 603
system accprofile
When an administrator has only read access to a feature, the administrator can access the web UI page for that feature,
and can use the get and show CLI command for that feature, but cannot make changes to the configuration. There are
no Create or Apply buttons, or config CLI commands. Lists display only the View icon instead of icons for Edit,
Delete or other modification commands. Write access is required for modification of any kind.
In larger companies where multiple administrators divide the share of work, access profiles often reflect the specific job
that each administrator does (“role”), such as user account creation or log auditing. Access profiles can limit each
administrator account to their assigned role. This is sometimes called role-based access control (RBAC).
The prof_admin access profile, a special access profile assigned to the admin administrator account and required by
it, does not appear in the list of access profiles. It exists by default and cannot be changed or deleted, and consists of
essentially UNIX root-like permissions.
If you create more administrator accounts, whether to harden security or simply to prevent accidental modification,
create other access profiles with the minimal degrees and areas of access that each role requires. Then assign each
administrator account the appropriate role-based access profile.
For example, for a person whose only role is to audit the log messages, you might make an access profile named
auditor that only has Read permissions to the Log & Report area.
For information on how each access control area correlates to which CLI commands that administrators can access, see
"Permissions" on page 51
To use this command, your administrator account’s access control profile must have both r and w permissions to items
in the admingrp category.
Syntax
config system accprofile
edit "<access-profile_name>"
set admingrp {none | r | rw | w}
set authusergrp {none | r | rw | w}
set learngrp {none | r | rw | w}
set loggrp {none | r | rw | w}
set mlgrp {none | r | rw | w}
set mntgrp {none | r | rw | w}
set netgrp {none | r | rw | w}
set sysgrp {none | r | rw | w}
set traroutegrp {none | r | rw | w}
set syncookie {enable | disable}
set webgrp {none | r | rw | w}
set wvsgrp {none | r | rw | w}
next
end
Variable Description Default
"<access-profile_name>" Enter the name of the access profile. The maximum length is No
63 characters. default.
authusergrp {none | r | Enter the degree of access that administrator accounts using this none
rw | w} access profile will have to the HTTP authentication user
configuration.
loggrp {none | r | rw | Enter the degree of access that administrator accounts using this none
w} access profile will have to the logging and alert email configuration.
mlgrp {none | r | rw | Enter the degree of access that administrator accounts using this
none
w} access profile will have to the machine learning configuration.
mntgrp {none | r | rw | Enter the degree of access that administrator accounts using none
w} this access profile will have to maintenance commands.
sysgrp {none | r | rw | Enter the degree of access that administrator accounts using this none
w} access profile will have to the basic system configuration (except for
areas included in other access control areas such as admingrp).
wadgrp {none | r | rw | Enter the degree of access that administrator accounts using this none
w} access profile will have to the web anti-defacement configuration.
webgrp {none | r | rw | Enter the degree of access that administrator accounts using this
none
w} access profile will have to the web protection profile configuration.
wvsgrp {none | r | rw | Enter the degree of access that administrator accounts using this none
w} access profile will have to the web vulnerability scanner.
Example
This example configures an administrator access profile named full_access, which permits both read and write
access to all special operations and parts of the configuration.
Even though this access profile configures full access, administrator accounts using this
access profile will not be fully equivalent to the admin administrator. The admin
administrator has some special privileges that are inherent in that account and cannot be
granted through an access profile, such as the ability to reset other administrators’
passwords without knowing their current password. Other accounts should therefore not be
considered a substitute, even if they are granted full access.
Related topics
l "system admin" on page 201
l "server-policy custom-application application-policy" on page 110
l "Permissions" on page 51
system admin
Use this command to configure FortiWeb administrator accounts. In its factory default configuration, a FortiWeb
appliance has one administrator account, named admin. That administrator has permissions that grant full access to
the FortiWeb configuration and firmware. After connecting to the web UI or the CLI using the admin administrator
account, you can configure additional administrator accounts with various levels of access to different parts of the
FortiWeb configuration.
Administrators can access the web UI and the CLI through the network, depending on administrator account’s trusted
hosts, ADOMs, and the administrative access protocols enabled for each of the FortiWeb appliance’s network
interfaces. For details, see "system interface" on page 280, , and "Connecting to the CLI" on page 39.
To prevent multiple administrators from logging in simultaneously, which could allow them
to inadvertently overwrite each other’s changes, enable . For details, see .
To use this command, your administrator account’s access control profile must have either w or rw permission to the
admingrp area. For details, see "Permissions" on page 51.
Syntax
config system admin
edit "<administrator_name>"
set accprofile "<access-profile_name>"
set accprofile-override {enable | disable}
set domains "<adom_name>"
set password "<password_str>"
set email-address "<contact_email>"
set first-name "<name_str>"
set last-name "<surname_str>"
set mobile-number "<cell-phone_str>"
set phone-number "<phone_str>"
set trusthost1 "<management-computer_ipv4mask>"
set trusthost2 "<management-computer_ipv4mask>"
set trusthost3 "<management-computer_ipv4mask>"
set ip6trusthost1 "<management-computer_ipv6mask>"
set ip6trusthost2 "<management-computer_ipv6mask>"
set ip6trusthost3 "<management-computer_ipv6mask>"
set type {local-user | remote-user}
set admin-usergroup "<remote-auth-group_name>"
set wildcard {enable | disable}
set sshkey "<sshkey_str>"
set force-password-change {enable | disable}
next
end
Variable Description Default
ATTRIBUTE FortiWeb-Access-Profile 7
then set its value to be the name of the access profile that you
want to assign to this account. Finally, in the CLI, use
accprofile-override {enable | disable} (page
202) to enable the override.
accprofile-override Enable to use the access profile indicated by the RADIUS disable
{enable | disable} query response, and ignore accprofile "<access-
email-address "<contact_ Enter an email address that can be used to contact this No
email>" administrator. The maximum length is 63 characters. default.
first-name "<name_str>" Enter the first name of the administrator. The maximum length is No
63 characters. default.
mobile-number "<cell- Enter a cell phone number that can be used to contact this No
phone_str>" administrator. The maximum length is 63 characters. default.
phone-number "<phone_ Enter a phone number that can be used to contact this No
str>" administrator. The maximum length is 63 characters. default.
The public key used for connecting to the CLI using a public-
private key pair.
Example
This example configures an administrator account with an access profile that grants only permission to read logs. This
account can log in only from an IP address on the management LAN (192.0.2.1/24), or from one of two specific IP
Related topics
l "system accprofile" on page 198
l "system global" on page 258
l "user admin-usergrp" on page 315
system admin-certificate ca
When FortiWeb's certificate-based Web UI login is applied. Besides the administrators' certificates information, the
corresponding certificate authority (CA) certificates are required to be stored on the FortiWeb appliance. Certificate
authorities validate and sign other certificates in order to indicate to third parties that those other certificates are
authentic and can be trusted. FortiWeb authorizes the administrator's login by verifying its certificate with the
corresponding CA.
Use this command to show the names of the CA certificates that are relative to the administrators' certificates. You use
the web UI to upload these certificates.
CA certificates are not used directly here (no set operations are defined), but they are required when you create a PKI
user (an administrator that FortiWeb authorizes base on his certificate) on the FortiWeb. For details, see "user pki-user"
on page 324.
For information about certificate-based Web UI login, see the FortiWeb Administration Guide:
http://docs.fortinet.com/fortiweb/admin-guides
To use this command, your administrator account’s access control profile must have either w or rw permission to the
admingrp area. For details, see "Permissions" on page 51.
Syntax
show system admin-certificate ca
Example
config system admin-certificate ca
edit "CA_Cert_1"
next
edit "CA_Cert_2"
next
end
The FortiWeb appliance presents its own HTTPS server certificate for secure connections (HTTPS) to its Web UI. By
default, A Fortinet factory certificate is used as the certificate, which is named defaultcert in FortiWeb. You can
also import other certifications to FortiWeb and replace the defaultcert with any of them for secure Web UI
connections.
Use this command to edit the comment associated with the these FortiWeb's administration certificates that are stored
locally on the FortiWeb appliance.
To replace the certificate that FortiWeb uses for the secure accesses to its Web UI, see .
For information on how to upload a certificate file to change FortiWeb's default certificate, see the FortiWeb
Administration Guide:
http://docs.fortinet.com/fortiweb/admin-guides
To use this command, your administrator account’s access control profile must have either w or rw permission to the
admingrp area. For details, see "Permissions" on page 51.
Syntax
config system admin-certificate local
edit "<certificate_name>"
set comment "<comment_str>"
set certificate "<certificate_str>"
set passwd "<passwd_str>"
set private-key "<private-key_str>"
set flag 0
set status ok
set type certificate
next
end
"<certificate_name>" Enter the name of a certificate file. The maximum length is 63 No default.
characters.
passwd "<passwd_str>" When exporting the private key file from certificate factories,
you can choose to enter a password to encrypt the file. Thus
No default.
when you import the file into FortiWeb, you shall enter this
password. This is optional.
private-key "<private- Enter the sequence number of the key file. No default.
key_str>"
Example
This example adds a comment to the certificate named certificate1.
config system admin-certificate local
edit "certificate1"
set comment "This is a certificate that FortiWeb uses for secure Web UI connections."
next
end
system advanced
Use this command to configure several system-wide options that determine how FortiWeb scans traffic.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config system advanced
set circulate-url-decode {enable | disable}
set decoding-enhancement {enable | disable}
set max-cache-size <cache_int>
set max-dlp-cache-size <percentage_int>
set max-dos-alert-interval <seconds_int>
set share-ip {enable | disable}
set anypktstream {enable | disable}
end
max-cache-size <cache_ Type the maximum size (in KB) of the body of the HTTP 512
int> response from the web server that FortiWeb will cache per
URL for body compression, decompression, rewriting, and
XML detection.
max-dos-alert-interval Type the maximum amount of time that FortiWeb will converge 180
<seconds_int> into a single log message during a DoS attack or padding oracle
attack.
anypktstream {enable | Enable to configure FortiWeb to scan partial TCP connections. disable
disable}
In some cases, FortiWeb is deployed after a client has already
created a connection with a back-end server. If this option is
disabled, FortiWeb ignores any traffic that is part of a pre-existing
session.
Related topics
l "server-policy policy" on page 146
l "system certificate local" on page 226
l "system ip-detection" on page 287
l "waf brute-force-login" on page 344
l "waf application-layer-dos-prevention" on page 341
l "waf http-protocol-parameter-restriction" on page 418
system antivirus
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config system antivirus
set default-db {basic | extended}
set scan-bzip2 {enable | disable}
set uncomp-size-limit <limit_int>
set uncomp-nest-limit <limit_int>
set use-fsa {enable | disable}
end
default-db {basic | Select which of the antivirus signature databases to use when basic
extended} scanning HTTP POST requests for viruses, either:
uncomp-size-limit <limit_ Type the maximum size in kilobytes (KB) of the memory 5000
int> buffer that FortiWeb will use to temporarily undo the
compression that a client or web server has applied to traffic,
in order to inspect and/or modify it. For details, see "waf file-
uncompress-rule" on page 382.
use-fsa {enable Enable to use the Signature Database from FortiSandbox to disable
| disable} supplement the AV Signature Database. If enabled, FortiWeb will
Use this command to override the default Fortiguard Distribution Server (FDS).
If you cannot connect to the FortiGuard Distribution Network (FDN) or if your organization provides updates using their
own FortiGuard server, you can override the FDS server setting so that the FortiWeb appliance connects to this server
instead of the default server on Fortinet’s public FDN.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
mntgrp area. For details, see "Permissions" on page 51.
Syntax
config system autoupdate override
set status {enable | disable}
set address {"<fds_fqdn>" | "<fds_ipv4>"}
set fail-over {enable | disable}
end
status {enable | disable} Enable to override the default list of FDN servers, and connect to a disable
specific server.
address {"<fds_fqdn>" | Enter either the IP address or fully qualified domain name (FQDN) No
"<fds_ipv4>"} of the FDS override. default.
fail-over {enable | Enable to fail over to one of the public FDN servers if FortiWeb enable
disable} cannot reach the server specified in your FDS override.
Related topics
l "system autoupdate schedule" on page 212
Use this command to configure how the FortiWeb appliance will access the Fortinet Distribution Network (FDN) to
retrieve updates. The FDN is a world-wide network that delivers FortiGuard service updates of predefined robots, data
types, suspicious URLS, IP address reputations, and attack signatures used to detect attacks such as:
l Common exploits
Alternatively, you can manually upload update packages. For details, see the
FortiWeb Administration Guide:
http://docs.fortinet.com/fortiweb/admin-guides
FortiWeb appliances connect to the FDN by connecting to the Fortinet Distribution Server (FDS) nearest to the
FortiWeb appliance based on its configured time zone.
In addition to manual update requests, FortiWeb appliances support an automatic scheduled updates, by which the
FortiWeb appliance periodically polls the FDN to determine if there are any available updates.
If you want to connect to a specific FDS, you must enter config system autoupdate override (page 212). If
your FortiWeb appliance must connect through a web proxy, you must also enter config system autoupdate
tunneling (page 214).
To use this command, your administrator account’s access control profile must have either w or rw permission to the
mntgrp area. For details, see "Permissions" on page 51.
Syntax
config system autoupdate schedule
set status {enable | disable}
set frequency {daily | every | weekly}
set time "<time_str>"
set day {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}
end
status {enable | disable} Enable to periodically request signature updates from the FDN. disable
frequency {daily | Select the frequency with which the FortiWeb appliance will
every
every | weekly} request signature updates.
time "<time_str>" Enter the time at which the FortiWeb appliance will request 00:00
signature updates.
Example
This example configures weekly signature update requests on Sunday at 2:00 PM.
config system autoupdate schedule
Related topics
l "system autoupdate override" on page 212
l "system autoupdate tunneling" on page 214
Use this command to configure the FortiWeb appliance to use a proxy server to connect to the Fortinet Distribution
Network (FDN).
The FortiWeb appliance will connect to the proxy using the HTTP CONNECT method, as described in RFC 2616
(http://tools.ietf.org/rfc/rfc2616.txt).
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config system autoupdate tunneling
set status {enable | disable}
set address {"<proxy_fqdn>" | "<proxy_ipv4>"}
set port <port_int>
set username "<proxy-user_str>"
set password "<proxy-password_str>"
end
status {enable | disable} Enable to connect to the FDN through a web proxy. disable
address {"<proxy_fqdn>" | Enter either the IP address or fully qualified domain name (FQDN) No
"<proxy_ipv4>"} of the web proxy. The maximum length is 63 characters. default.
port <port_int> Enter the port number on which the web proxy listens for 0
connections. The valid range is 0–65,535.
password "<proxy- If the proxy requires authentication, enter the password for the No
password_str>" FortiWeb appliance’s login name on the web proxy. The maximum default.
length is 49 characters.
Example
This example configures the FortiWeb appliance to connect through a web proxy that requires authentication.
config system autoupdate tunneling
set status enable
set address "192.168.1.10"
set port 1443
set username "fortiweb"
set password "myPassword1"
end
Related topics
l "system autoupdate schedule" on page 212
system backup
Use this command to configure automatic backups of the system configuration to an FTP or SFTP server. You can
either run the backup immediately or schedule it to run periodically.
The backup can include all uploaded files such as error pages, WSDL files, certificates, and private keys. Fortinet
recommends that if you have many such files, that you include them in the backup. This saves you valuable time if you
need to restore the configuration in an emergency.
Fortinet strongly recommends that you password-encrypt this backup, and store it in a
secure location. This backup method includes sensitive data such as your HTTPS
certificates’ private keys. Unauthorized access to private keys compromises the security of
all HTTPS requests using those certificates.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
mntgrp area. For details, see "Permissions" on page 51.
Syntax
config system backup
edit "<backup_name>"
set config-type {full-config |cli-config | waf-config}
set encryption {enable | disable}
set encryption-passwd "<password_str>"
set ftp-auth {enable | disable}
set ftp-user "<user_str>"
set ftp-passwd "<password_str>"
set ftp-dir "<directory-path_str>"
set ftp-server {"<server_ipv4>" | "<server_fqdn>"}
set protocol-type {ftp | sftp}
set schedule_type {now | days}
set schedule_days {sun mon tue wed thu fri sat}
set schedule_time "<time_str>"
next
end
Variable Description Default
Select either:
encryption {enable | Enable to encrypt the backup file with a .zip extension. disable
disable}
Caution: Unlike when downloading a backup from the web UI
to your computer, this does include all certificates and private
keys. Fortinet strongly recommends that you password-
encrypt this backup, and store it in a secure location.
ftp-auth {enable | Enable if the server requires that you provide a user name and disable
disable} password for authentication, rather than allowing anonymous
connections. When enabled, you must also configure ftp-
user "<user_str>" (page 216) and ftp-passwd
"<password_str>" (page 216).
Enter the user name that the FortiWeb appliance will use to
authenticate with the server. The maximum length is 127
characters. No
ftp-user "<user_str>"
default.
This variable is not available unless ftp-auth {enable |
disable} (page 216) is enable.
ftp-dir "<directory-path_ Enter the directory path on the server where you want to store the No
str>" backup file. The maximum length is 127 characters. default.
ftp-server {"<server_ Enter either the IP address or fully qualified domain name (FQDN) No
ipv4>" | "<server_fqdn>"} of the server. The maximum length is 127 characters. default.
protocol-type {ftp |
sftp} Select whether to connect to the server using FTP or SFTP. ftp
Enter one or more days of the week when you want to run a
periodic backup. Separate each day with a blank space.
schedule_time "<time_ Enter the time of day to run the backup. 00:00
str>"
The time format is hh:mm, where:
Example
This example configures a scheduled, full configuration backup every Sunday and Friday at 1:15 AM. The FortiWeb
appliance authenticates with the FTP server using an account named fortiweb1 and its password, P@ssword1. It
does not encrypt the backup file.
config system backup
edit "Scheduled_Backup"
set config-type full-config
set protocol-type ftp
set ftp-auth enable
Related topics
l "restore config" on page 647
l "backup cli-config" on page 626
system central-management
Use this command to enable cross domain access feature for central management in the web UI and CLI.
Syntax
config system central management
set cm-access {enable | disable}
set system central-management
end
cm-access {enable | disable} Enable/disable the cross domain access feature disable
for central management.
Example
This example shows enabling central management feature.
config system central-management
set cm-accsss enable
set allow-origin https://10.200.111.100
end
system certificate ca
Use this command to show the names of certificates for a certificate authority (CA). You use the web UI to upload these
certificates.
Certificate authorities validate and sign other certificates in order to indicate to third parties that those other certificates
are authentic and can be trusted
CA certificates are not used directly, but must first be grouped in order to be selected in a certificate verification rule. For
details, see "system certificate ca-group" on page 220.
For information on how to upload a certificate file, see the FortiWeb Administration Guide:
http://docs.fortinet.com/fortiweb/admin-guides
To use this command, your administrator account’s access control profile must have either w or rw permission to the
admingrp area. For details, see "Permissions" on page 51.
Syntax
show system certificate ca
config system certificate ca
edit "<certificate_name>"
set certificate "<certificate_ str>"
next
end
certificate "<certificate_ No
str>" Set the certificate. Only certificates in PEM format may be set.
default.
Example
Zm9ydGluZXQuY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArvHH
eXZJilTr4TbH/5O5jFxKQ5dILr/561JOJ5UZWtgs9VhXSuCzmrs6FX35vyc7NR+9
tCbMrl7qA68MxBMuu6phf2r77M9bsp3rOZE2nFR+lhjpWrXBk7/puFLBbI2yqh8d
7DB25m5pI0ClmbdJ5GGlc/1wHULQhFQSYCMSVjc34esvaLE8oAVFWHAZX14dbAbj
gC4CMbayzJZaYEfh/7suMwvdwS3sYjOwZYq6DFEF5ZPpKN+ji9J+8EmAvaZS2m3M
fFdPFf4eEAgsHmYasqxH7s4Ksc2zTm3cG5srRCqEsEddhoblI1JvmApoN2JiNiYJ
hYiEPyJdf2z+dADwXwIDAQABMA0GCSqGSIb3DQEBBQUAA4IBAQCbA8kKwVRPri/d
L8okLny6FygJ0auPbuRQCUGAWpfdKdXn6iyMlLuR066j82o2yrQ0ddgRcdaExT0I
RCoC2NqhzZvy8JJW2A+KTXutwdGGg8ckHQ5UVRtNo/lPZ6Quz8AsswzNk2Qx6OtF
FcTEBNxVTHKabQR46ChIa3sG032Wiuj6Y2Rv77mTmmDRZnrY8QGZd2zMm3riAqUf
IGil0/yg0AhA+ZBt5rer3X+GTknhDAPJ+yU2WS1c8pPj3A3DI0+xwTOq/sNCqTmc
xb7Q1VM/1kiOE9YaPasAJuQ7WHmnd8J0vHw1/e+whf/lsKxV0ClBNL/JdlyNAMvy
isnZYL58
-----END CERTIFICATE-----"
next
end
Related topics
l "system certificate ca-group" on page 220
l "system certificate verify" on page 234
To use this command, your administrator account’s access control profile must have either w or rw permission to the
admingrp area. For details, see "Permissions" on page 51.
Syntax
config system certificate ca-group
edit "<ca-group_name>"
config members
edit <ca_index>
set type {CA | TSL}
set publish-dn {enable | disable}
set tsl "<tsl_name>"
set name "<ca_name>"
next
end
next
end
"<ca-group_name>" Enter the name of a certificate authority (CA) group. The maximum No
length is 63 characters. default.
Enter the index number of a CA within its group. The valid range is No
<ca_index>
1–999,999,999,999,999,999. default.
Example
This example groups two CA certificates into a CA group named caVEndors1.
config system certificate ca-group
edit "caVendors1"
config members
edit 1
set name "CA_Cert_1"
next
edit 2
set "name CA_Cert_2"
next
end
next
end
Related topics
l "certificate ca" on page 1
l "system certificate local" on page 226
l "system certificate verify" on page 234
Use this command to edit the URL associated with a previously uploaded certificate revocation list (CRL).
To ensure that your FortiWeb appliance validates only certificates that have not been revoked, you should periodically
upload a current certificate revocation list, which may be provided by certificate authorities (CA).
For information on how to upload a CRL, see the FortiWeb Administration Guide:
http://docs.fortinet.com/fortiweb/admin-guides
To use this command, your administrator account’s access control profile must have either w or rw permission to the
admingrp area. For details, see "Permissions" on page 51.
Syntax
config system certificate crl
edit "<crl_name>"
set certificate "<certificate_str>"
set type {http | local | scep}
set url "<crl_str>"
next
end
certificate No
"<certificate_str>" Set the certificate. Only certificates in PEM format may be set.
default.
type {http | local | Specify how you set the certificate. local
scep}
http—query for the certificate from a HTTP server
Related topics
l "certificate ca" on page 1
l "system certificate local" on page 226
l "system certificate crl-group" on page 222
l "system certificate verify" on page 234
Use this command to create a group of CRLs that you have already uploaded to FortiWeb.
To ensure that FortiWeb validates only certificates that have not been revoked, you should periodically upload current
certificate revocation lists (CRL) that may be provided by certificate authorities (CA). Once you've uploaded the CRL(s)
you want to use, create CRL groups to include in your FortiWeb configuration.
For more information about CRLs and CRL groups, see the FortiWeb Administration Guide:
http://docs.fortinet.com/fortiweb/admin-guides
To use this command, your administrator account’s access control profile must have either w or rw permission to the
admingrp area. For details, see "Permissions" on page 51.
Syntax
config system certificate crl-group
edit <crl_group_name>
config members
edit <entry_index>
set <crl_name>
next
end
next
end
<crl_group_name> Type the name of the CRL group. You will use this name to select No
the CRL group in other parts of the configuration. The maximum default.
length is 63 characters.
No
<entry_index> Type the index number of the individual entry in the table.
default.
<crl_name> Type the name of a CRL that you want to include in the group. The No
maximum length is 63 characters. For details, see "system default.
certificate crl" on page 221.
Related topics
l "system certificate crl" on page 221
l "system certificate verify" on page 234
Use this command to show the names of uploaded intermediate CA certificate. You upload these certificates using the
web UI.
For information on how to upload an intermediate certificate file, see the FortiWeb Administration Guide:
http://docs.fortinet.com/fortiweb/admin-guides
To use this command, your administrator account’s access control profile must have either w or rw permission to the
admingrp area. For details, see "Permissions" on page 51.
Syntax
show system certificate intermediate-certificate
config system certificate intermediate-certificate
edit "<certificate_name>"
set certificate "<certificate_str>"
next
end
certificate "<certificate_ No
str>" Set the certificate. Only certificates in PEM format may be set.
default.
Example
This example creates three intermediate certificate items, Inter_Cert_1, Inter_Cert_2 and Inter_Cert_3.
config system certificate intermediate-certificate
edit "Inter_Cert_1"
next
edit "Inter_Cert_2"
next
edit "Inter_Cert_3"
next
end
IGil0/yg0AhA+ZBt5rer3X+GTknhDAPJ+yU2WS1c8pPj3A3DI0+xwTOq/sNCqTmc
xb7Q1VM/1kiOE9YaPasAJuQ7WHmnd8J0vHw1/e+whf/lsKxV0ClBNL/JdlyNAMvy
isnZYL58
-----END CERTIFICATE-----"
next
end
Related topics
l "certificate inter-ca" on page 1
l "system certificate intermediate-certificate-group" on page 225
l "server-policy policy" on page 146
Intermediate CAs must belong to a group in order to be selected in a certificate verification rule.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
admingrp area. For details, see "Permissions" on page 51.
Syntax
config system certificate intermediate-certificate-group
edit "<intermediate-ca-group_name>"
config members
edit <intermediate-ca_index>
set name "<ca_name>"
next
end
next
end
Related topics
l "certificate inter-ca" on page 1
l "system certificate intermediate-certificate" on page 223
Use this command to edit the comment associated with a server certificate that is stored locally on the FortiWeb
appliance.
You can also configure settings for a certificate that works with an HSM (hardware security module). For details about
HSM integration, see "system hsm info" on page 278 and the FortiWeb Administration Guide:
http://docs.fortinet.com/fortiweb/admin-guides
FortiWeb appliances require these certificates to present when clients request secure connections, including when:
l For connections to the web UI, the FortiWeb appliance presents its default certificate. The FortiWeb appliance’s default
certificate does not appear in the list of local certificates. It's used only for connections to the web UI and cannot be
removed.
l For SSL off-loading or SSL decryption, upload certificates that do not belong to the FortiWeb appliance, but instead
belong to the protected hosts. Then, select which one the FortiWeb appliance will use when configuring the SSL option in
a policy or server farm.
For information on how to upload a certificate file, see the FortiWeb Administration Guide:
http://docs.fortinet.com/fortiweb/admin-guides
To use this command, your administrator account’s access control profile must have either w or rw permission to the
admingrp area. For details, see "Permissions" on page 51.
Syntax
config system certificate local
edit "<certificate_name>"
set comment "<comment_str>"
set status {na | ok | pending}
set type {certificate | csr}
set flag {0 | 1}
set is-hsm {no | yes}
set partition-number "<partition_name>"
set certificate "<certificate_str>"
set private-key "<private_key_str>"
set passwd "<password>"
next
end
flag {0 | 1} Indicate if a password was saved. This is used by FortiWeb for No
backwards compatibility. default.
Specify whether you configured the CSR for this certificate to work
is-hsm {no | yes} no
with an integrated HSM.
partition-number Enter the name of the HSM partition you selected when you created No
"<partition_name>" the CSR for this certificate. default.
certificate No
"<certificate_str>" Set the certificate. Only certificates in PEM format may be set.
default.
private-key "<private_ Set the private key for the certificate. Only private keys in PEM No
key_str>" format may be set. default.
No
passwd "<password>" Enter the password for the certificate.
default.
Example
This example adds a comment to the certificate named certificate1.
config system certificate local
edit "certificate1"
set comment "This is a certificate for the host www.example.com."
next
end
Related topics
l "certificate local" on page 1
l "server-policy policy" on page 146
l "server-policy server-pool" on page 170
Once an OCSP server is configured, OCSP stapling may be enabled. When OCSP stapling is enabled, FortiWeb
periodically fetches the revocation status of the specified certificate from the OCSP server and caches the response for
a period if the revocation status is contained in the response.
For more information on OCSP stapling, see the FortiWeb Administration Guide:
http://docs.fortinet.com/fortiweb/admin-guides
To use this command, your administrator account’s access control profile must have either w or rw permission to the
admingrp area. For details, see "Permissions" on page 51.
Syntax
config system certificate remote
edit "<ocsp_name>"
set certificate "<certificate_name>"
set comment "<comment_str>"
set ocsp_url "<url>"
next
end
certificate "<certificate_ No
name>" A CA certificate that has been imported in FortiWeb.
default
Example
This example creates an OCSP group for the CA certificate CA_Cert_1.
Related topics
l "system certificate local" on page 226
l "system certificate ca" on page 218
l "server-policy policy" on page 146
l "server-policy server-pool" on page 170
Use this command to configure how the FortiWeb appliance will verify certificates presented by HTTP server.
Syntax
config system certificate server-certificate-verify
edit "<certificate_verificator_name>"
set ca "<ca-group_name>"
set crl "<crl-group_name>"
next
end
crl "<crl-group_name>" Enter the name of an existing CRL Group, if any, to use to verify the No
revocation status of client certificates. default.
Related topics
l "system certificate ca-group" on page 220
l "system certificate crl" on page 221
In some cases, the members of a server pool or a single pool member host multiple secure websites that use different
certificates. Use this command to create a Server Name Indication (SNI) configuration that identifies the certificate to
use by domain.
You can select a SNI configuration in a server policy only when the operating mode is Reverse Proxy mode and an
HTTPS configuration is applied to the policy.
Not all web browsers support SNI. Go to the following location for a list of web browsers that support SNI:
http://en.wikipedia.org/wiki/Server_Name_Indication#Browsers_with_support_for_TLS_server_name_
indication.5B10.5D
To use this command, your administrator account’s access control profile must have either w or rw permission to the
admingrp area. For details, see "Permissions" on page 51.
Syntax
config system certificate sni
edit "<sni_name>"
config members
edit <entry_index>
set domain-type {plain | regular}
set domain "<server_fqdn>"
set local-cert "<local-cert_name>"
set inter-group "<intermediate-cagroup_name>"
set verify "<certificate_verificator_name>"
end
next
end
<entry_index> Enter the index number of an SNI configuration entry. The valid No
range is 1–9,999,999,999,999,999,999. default.
domain-type {plain | Specify plain to match a domain to certificates using a literal plain
regular} domain specified in domain. Specify regular to match multiple
domains to certificates using a regular expression specified in
domain.
domain "<server_fqdn>" Enter the domain of the secure website (HTTPS) that uses the
certificate specified by local-cert "<local-cert_
name>" (page 232). No
default.
Enter a literal domain if domain-type {plain |
regular} (page 231) is set to plain; or enter a regular
local-cert "<local-cert_ Enter the name of the server certificate that FortiWeb uses to
name>" encrypt or decrypt SSL-secured connections for the website
specified by domain "<server_fqdn>" (page 231).
http://docs.fortinet.com/fortiweb/admin-guides
verify "<certificate_ Enter the name of a certificate verifier, if any, that FortiWeb
verificator_name>" uses when an HTTP client presents its personal certificate. If
you do not select one, the client is not required to present a
personal certificate.
Related topics
l "system certificate local" on page 226
l "system certificate intermediate-certificate-group" on page 225
l "system certificate verify" on page 234
Use this command to show the names of Trust Service Lists (TSL) for a certificate authority (CA). You use the web UI to
upload the TSL.
For information on how to upload a TSL, see the FortiWeb Administration Guide:
http://docs.fortinet.com/fortiweb/admin-guides
To use this command, your administrator account’s access control profile must have either w or rw permission to the
admingrp area. For details, see "Permissions" on page 51.
Syntax
config system certificate tsl-ca
edit "<tsl-ca_name>"
set type {file | url}
set distribute-url
next
end
No
type {file | url} Select the way to upload a TSL.
default
Related topics
l system certificate ca
l system certificate ca-group
Use this command to configure the URL-based client certificate feature for a server policy or server pool. This feature
allows you to require a certificate for some requests and not for others. Whether a client is required to present a
personal certificate or not is based on the requested URL and the rules you specify in the URL-based client certificate
group.
A URL-based client certificate group specifies the URLs to match and whether the matched request is required to
present a certificate or exempt from presenting a certificate.
When the URL-based client certificate feature is enabled, clients are not required to present a certificate if the request
URL is specified as exempt in the URL-based client certificate group rule or URL of the request does not match a rule.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
admingrp area. For details, see "Permissions" on page 51.
Syntax
config system certificate urlcert
edit "<url-cert-group_name>"
config list
edit <entry_index>
set url "<url_str>"
set require {enable | disable}
end
next
end
"<url-cert-group_name>" Enter the name for the URL-based client certificate group. No
default.
Related topics
l "server-policy policy" on page 146
l "server-policy server-pool" on page 170
Use this command to configure how the FortiWeb appliance will verify certificates presented by HTTP clients.
To apply a certificate verification rule, select it in a policy. For details, see "server-policy policy" on page 146.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
admingrp area. For details, see "Permissions" on page 51.
Syntax
config system certificate verify
edit "<certificate_verificator_name>"
set ca "<ca-group_name>"
set crl "<crl-group_name>"
set publish-dn {enable | disable}
set strictly-need-cert {enable | disable}
next
end
crl "<crl-group_name>" Enter the name of an existing CRL Group, if any, to use to verify the No
revocation status of client certificates. default.
Related topics
l "system certificate ca-group" on page 220
l "system certificate crl" on page 221
l "server-policy policy" on page 146
l "server-policy server-pool" on page 170
system conf-sync
This command configures, but does not execute, the synchronization. To do this, use
the web UI.
This command works only when administrative domains (ADOMs) are disabled.
This type of synchronization is used between FortiWeb appliances that are not part of a native FortiWeb high availability
(HA) pair, such as when you need to clone the configuration once, or when HA is provided by an external device.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config system conf-sync
set ip "<remote-fortiweb_ipv4>"
set password "<password_str>"
set sync-type {full-sync | partial-sync}
set server-port <port_int>
set auto-sync {enable | disable}
set frequency {daily | every | weekly}
set day {Friday | Monday | Saturday | Sunday | Thursday | Tuesday | Wednesday}
set time "<hh:mm>"
end
ip "<remote-fortiweb_ Enter the IP address of the remote FortiWeb appliance that you 0.0.0.0
ipv4>" want to synchronize with the local FortiWeb appliance.
password "<password_ Type the administrator password for the remote FortiWeb
str>" No default.
appliance. The maximum length is 63 characters.
l Administrator accounts
l Access profiles
l HA settings
For all operation modes, partial-sync updates the
configuration of the peer FortiWeb appliance, except for
the following items:
router ...
server-policy health
server-policy http-content-routing-policy
server-policy persistence-policy
server-policy policy
server-policy server-pool
server-policy service custom
server-policy service predefined
server-policy vserver
system ...
Related topics
l "system settings" on page 296
system console
Use this command to configure the management console settings. Usually this is set during the early stages of
installation and needs no adjustment.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config system console
set baudrate {9600 | 19200 | 38400 | 57600 | 115200}
set mode {batch | line}
set output {more | standard}
set shell {cli | sh}
end
baudrate {9600 | 19200 | Select the baud rate of the console connection. The rate should 9600
38400 | 57600 | 115200} conform to the specifications of your specific FortiWeb appliance.
mode {batch | line} Select the console input mode: either batch or line. line
Select either:
shell {cli | sh} l cli—Command-line shell. cli
l sh—Busybox shell.
Example
This example configures the local console connection to operate at 9,600 baud, and to show long output in a paged
format.
config system console
set baudrate 9600
set output more
end
Related topics
l "system admin" on page 201
Use this command to configure decoding enhancement. You can decode cookies and parameters using base64 or CSS
for specified URLs.
To configure decoding enhancement, you must first enable the feature. For details, see "system advanced" on page
208.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config system decoding-enhancement
edit <entry_index>
set url-type {plain | regular}
set url-pattern "<url_string>"
config field-list
edit <entry_index>
set base64-decoding {enable | disable}
set css-decoding {enable | disable}
set field-name "<parameter_cookie_str>"
set field-name-type {plain | regular}
set field-type {parameter | cookie}
next
end
next
end
<entry_index> Enter the index number of the decoding rule that you want to No
create or modify. default.
url-pattern "<url_ Enter the URL path for which you want the decoding rule to No
string>" apply. default.
<entry_index> Enter the index number of the field that you want to create or No
modify. default.
base64-decoding {enable Configure to enable Base64 decoding for the field. disable
| disable}
css-decoding {enable
| disable} Configure to enable CSS decoding for the field. disable
field-name "<parameter_ Enter the parameter or cookie string for the field. No
cookie_str>" default.
Example
This example enables decoding enhancement and creates a decoding rule with a parameter field type.
config system advanced
set decoding-enhancement enable
end
config system decoding-enhancement
edit 1
Related Topic(s)
l "system advanced" on page 208
system device-tracking
Use this command to adjust device tracking settings. FortiWeb's device tracking feature identifies suspected attackers
based on the computers they are using.
http://docs.fortinet.com/fortiweb/admin-guides
To use this command, your administrator account’s access control profile must have either w or rw permission to the
admingrp area. For details, see "Permissions" on page 51.
Syntax
config system device-tracking
set block-duration <hours_int>
set cleanup-historical-threat-weight-period {1-week | 3-days | 12-hours | 24-
hours | never}
set database-query-timeout <seconds_int>
set delete-inactive-device-interval {days_int}
set fingerprinting-interval <minutes_int>
end
block-duration <hours_int> Enter the amount of time (in hours) that FortiWeb will block No
a device within a single cleanup-historical- default.
threat-weight-period.
cleanup-historical-threat- Select the amount of time that FortiWeb will store threat weight
weight-period {1-week | 3-
days | 12-hours | 24-hours
information for a device. Once threat weight information has never
| never} been stored for longer than the selected amount of time,
database-query-timeout Enter the maximum amount of time (in seconds) that FortiWeb 3
<seconds_int> will wait for a response when it queries the database for threat
weight information for a device. The default value is 4. The valid
range is 1–30.
Enter the amount of time (in days) that FortiWeb will store
delete-inactive-device-
interval {days_int} data for an inactive device before FortiWeb removes the 0
data for that device. The valid range is 0–30.
fingerprinting-interval Enter the interval (in minutes) in which FortiWeb will update the 60
<minutes_int> device fingerprint of a currently tracked device. The valid range is
60–1440.
Example
This example adjusts the device tracking settings.
config system device-tracking
set cleanup-historical-threat-weight-period 1-week
set block-duration 10
set database-query-timeout 15
set delete-inactive-device-interval 3
set fingerprinting-interval 70
end
Related Topics
system dns
Use this command to configure the FortiWeb appliance with its local domain name, and the IP addresses of the domain
name system (DNS) servers that the FortiWeb appliance will query to resolve domain names such as
www.example.com into IP addresses.
FortiWeb appliances require connectivity to DNS servers for DNS lookups. Use either the DNS servers supplied by your
Internet service provider (ISP) or the IP addresses of your own DNS servers. You must provide unicast, non-local
addresses for your DNS servers. Local host and broadcast addresses will not be accepted.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config system dns
set primary "<dns_ipv4>"
set secondary "<dns_ipv4>"
set domain "<local-domain_str>"
end
primary "<dns_ipv4>" Enter the IP address of the primary DNS server. 8.8.8.8
secondary "<dns_ipv4>" Enter the IP address of the secondary DNS server. 0.0.0.0
domain "<local-domain_ Enter the name of the local domain to which the FortiWeb No
str>" appliance belongs, if any. The maximum length is 127 default.
characters.
Note: You can also configure the host name. For details, see
.
Example
This example configures the FortiWeb appliance with the name of the local domain to which it belongs, example.com. It
also configures its host name, fortiweb. Together, this configures the FortiWeb appliance with its own fully qualified
domain name (FQDN), fortiweb.example.com.
config system global
set hostname "fortiweb"
end
config system dns
set domain "example.com"
end
Related topics
l "log syslog-policy" on page 98
l "router static" on page 106
l "system interface" on page 280
l
system eventhub
When FortiWeb-VM is deployed on Azure, use this command to manually configure the FortiWeb appliance to send log
messages to Azure Event Hubs.
Alternatively, you can create the configuration automatically using a PowerShell script. For details, see the FortiWeb-
VM Azure Install Guide:
https://docs.fortinet.com/fortiweb/hardware
When the event hub configuration is complete, FortiWeb sends health logs to Azure Event Hub.
If you also create a corresponding Azure CEF SIEM policy (see config log siem-policy (page 95)), FortiWeb
also sends security logs to Azure Event Hub.
You can use the Azure classic portal to obtain the values that the config system eventhub settings require. For
detailed instructions, see the FortiWeb-VM Azure Install Guide:
https://docs.fortinet.com/fortiweb/hardware
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config system eventhub
set status {enable | disable}
set appliance_id "<subscription_str>"
set policy_saskey "<primary-key_str>"
set policy_name "<policy-name_str>"
set eventhub_name "<ehub-name_str>"
set servicebus_namespace "<servicebus-namespace_str>"
end
status {enable | disable} Enter enable to activate the Azure event hub configuration. disable
appliance_id Enter the subscription (ID) that has the access to the Azure Event No
"<subscription_str>" Hub default.
policy_saskey "<primary- Enter the primary shared access key that the specified policy No
key_str>" (by policy_name <policy-name_str>) uses for default.
Shared Access Signature authentication on the Azure Event
Hub.
policy_name "<policy- Enter the name of the Shared Access policy created for the No
name_str>" Azure Event Hub. default.
eventhub_name "<ehub- Enter the name of the Azure Event Hub that is associated with No
name_str>" the specified service bus (by servicebus_namespace default.
<servicebus-namespace_str>).
servicebus_namespace
Enter the Service Bus Namespace that the Event Hub is No
"<servicebus-namespace_
str>" created at. default.
Related topics
l "log siem-policy" on page 95
l "log siem-message-policy" on page 93
system fail-open
If your appliance’s hardware model, network cabling, and configuration supports it, you can configure fail-to-wire/bypass
behavior. This allows traffic to pass through unfiltered between 2 ports (a link pair) while the FortiWeb appliance is shut
down, rebooting, or has unexpectedly lost power such as due to being accidentally unplugged or PSU failure.
l when the operation mode is True Transparent Proxy, Transparent Inspection, or WCCP
l in standalone mode (not HA)
l for a bridge (V-zone) between ports wired to a CP7 processor or other hardware which provides support for fail-to-wire
l FortiWeb 600D: port1 + port2
l FortiWeb1000C: port3 + port4
l FortiWeb 1000D: port3 + port4 or port5 + port6
l FortiWeb 1000E: port3 + port4 + port5 + port6
l FortiWeb 2000E: port1 + port2 or port3 + port4
l FortiWeb3000C/D: port5 + port6
l FortiWeb3000E/4000E: port9 + port10, port11 + port12, port13 + port14, or port15 + port16
l FortiWeb 3010E: port3 + port4, port9 + port10, port11 + port12, port13 + port14 or port15 + port16
l FortiWeb4000C/D: port5 + port6 or port7 + port8
l FortiWeb3000CFsx/DFsx: port5 + port6 or port7 + port8
FortiWeb-400B/400C, FortiWeb HA clusters, and ports not wired to a CP7/fail-open chip do not support fail-to-wire.
Bypass results in degraded security while FortiWeb is shut down, and therefore HA is
usually a better solution: it ensures that degraded security does not occur if one of the
appliances is shut down. If it is possible that both of your HA FortiWeb appliance
could simultaneously lose power, you can add an external bypass device such as
FortiBridge.
Fail-to-wire may be useful if you are required by contract to provide uninterrupted connectivity, or if you consider
connectivity interruption to be a greater risk than being open to attack during the power interruption.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config system fail-open
set port3-port4 {poweroff-bypass | poweroff-cutoff}
end
Related topics
l "system ha" on page 265
Use this command to configure the FortiWeb proxy to override the default list of FDN servers and connect to a specific
FDS IP address.
Before using this command, you must configure FortiWeb to act as a proxy server. To do so, set fds-proxy to
enable. See system global for how to enable fds-proxy.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config system fds proxy override
set override_switch {enable | disable}
set address "<fds_IPv4>"
end
end
override_switch {enable | disable} Enable to override the default list of FDN servers disable
and connect to a specific server.
status {enable | disable} Enable to schedule updating the database per certain disable
frequency.
time Set the hour and minute ranges; hh: 0–23, mm 0–59 No
or 60=random. default.
Example
This example enables configuration of the FDS proxy and configures a proxy at 192.0.2.1 with a port of 8989.
config system global
set fds-proxy enable
end
system feature-visibility
Use this command to enable or disable the ability to view configuration options for these features in the web UI and CLI:
l Device tracking
l FTP security
l Auto learn
When enabled, device tracking options will be available for these commands:
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config system feature-visibility
set ftp-security (enable | disable}
set device-tracking {enable | disable}
set auto-learn {enable | disable}
end
ftp-security (enable | disable} Enable to display FTP security rule, profile, and disable
policy configuration options.
device-tracking {enable | disable} Enable to display device tracking rule, profile, and
disable
policy configuration options.
auto-learn {enable | disable} Enable to display auto learn rule, profile, and disable
policy configuration options.
Related Topics
l "system device-tracking" on page 241
l "waf web-protection-profile inline-protection" on page 518
l "waf device-reputation" on page 375
l waf ftp-propredefined-global-white-listtection-profile
l "waf ftp-command-restriction-rule" on page 390
l "waf ftp-file-security" on page 393
l "server-policy policy" on page 146
l "server-policy server-pool" on page 170
system fips-cc
Use this command to enable and configure Federal Information Processing Standards (FIPS) and Common Criteria
(CC) compliant mode.
Syntax
config system fips-cc
set status {enable | disable}
set entropy-token {dynamic | enable | disable}
set reseed-interval <reseed-interval_int>
set ssl-client-restrict {enable | disable}
end
status {enable | disable} Enable/disable FIPS operation mode. This can be disable
done only by the console.
entropy-token {dynamic | enable Use the entropy token to seed the RNG in FIPS-CC
| disable} mode.
l When the status is enable, the entropy token
is used to seed or reseed the RNG, and it
must be inserted to FortiWeb.
l When the status is disable, the entropy token
is not used to seed or reseed the RNG, but
the old method will be used to seed or reseed
disable
the RNG.
l When the status is dynamic, it means when
entropy token is present, the entropy token
will be used to seed or reseed the RNG; if the
token is not present, the old method will be
used to seed or reseed the RNG.
reseed-interval <reseed-interval_ Set the interval to reseed the RNG. The valid range is 1440
int> 0–1440 minutes.
ssl-client-restrict {enable
| disable} Enable/disable ciphers restriction. disable
Use this command to configure IP addresses and address ranges that FortiWeb's built-in stateful firewall uses. You use
the address configuration in a firewall policy. For details, see "system firewall firewall-policy" on page 251.
Syntax
config system firewall address
edit "<firewall-address_name>"
set type {ip-netmask | ip-range}
set ip-netmask "<firewall-address_ipv4mask>"
set ip-address-value "<firewall-address_ipv4>"
end
Related topics
l "system firewall firewall-policy" on page 251
l "system firewall service" on page 250
Use this command to configure the protocols and ports that FortiWeb's built-in stateful firewall uses. You use the service
configuration in a firewall policy. For details, see "system firewall firewall-policy" on page 251.
Syntax
config system firewall service
edit "<firewall-service_name>"
set protocol {TCP | UDP | ICMP}
set source-port-min <source-port-min_int>
set source-port-max <source-port-max_int>
set destination-port-min <source-port-min_int>
set destination-port-max <source-port-max_int>
end
source-port-min <source- Enter the start port in the range of source ports for this firewall 0
port-min_int> service.
source-port-max <source- Enter the end port in the range of source ports for this firewall
65535
port-max_int> service
destination-port-min Enter the start port in the range of destination ports for this 0
<source-port-min_int> firewall service.
destination-port-max Enter the end port in the range of destination ports for this firewall
65535
<source-port-max_int> service
Related topics
l "system firewall address" on page 249
l "system firewall firewall-policy" on page 251
Use this command to configure the policies that FortiWeb's built-in stateful firewall uses to determine which traffic to
allow and deny.
The firewall policy uses address and service configurations that you create separately. For details, see "system firewall
address" on page 249 and "system firewall service" on page 250.
Syntax
config system firewall firewall-policy
set default-action {deny | accept}
config firewall-policy-match-list
edit <entry_index>
set in-interface "<incoming_interface_name>"
set out-interface "<outgoing_interface_name>"
set src-address "<firewall-address_name>"
set dest-address "<firewall-address_name>"
set service "<firewall-service_name>"
set action {deny | accept}
set vzone-enable {enable | disable}
set vzone "<vzone_name>"
end
No
<entry_index> Enter the index number of the policy rule in the table.
default.
in-interface "<incoming_ Enter the name of the interface (for example, port1) on No
interface_name>" which FortiWeb receives packets it applies this firewall policy default.
rule to.
src-address "<firewall- Enter the name of the firewall address configuration that No
address_name>" specifies the source IP address or addresses to which this default.
policy applies.
service "<firewall- Enter the name of the firewall service configuration that No
service_name>" specifies the protocols and ports to which this policy rule default.
applies.
Enter either:
vzone-enable {enable | Select to enable a V-zone (bridge). If this option is enabled, disable
disable} select a V-zone to use. V-zones allow network connections to
travel through FortiWeb's physical network ports without
explicitly connecting to one of its IP addresses.
Example
This example configures a firewall policy to deny any HTTP services but coming from specified sources.
config system firewall address
edit "alloowed_source"
set type ip-range
set ip-address-value "172.22.203.100-172.22.203.115"
end
config system firewall address
edit "site1"
set type ip-netmask
set ip-netmask "206.11.0.2/24"
end
config system firewall service
edit "http"
set protocol TCP
set destination-port-min 80
set destination-port-max 80
end
config system firewall firewall-policy
set default-action deny
config firewall-policy-match-list
edit 1
set in-interface port1
set out-interface port2
set src-address site1
set dest-address site1
set service http
set action accept
next
end
end
Related topics
l "system firewall address" on page 249
l "system firewall service" on page 250
Use this command to configure a firewall SNAT policy. Firewall SNAT policies translate a matching source IP address to
a single IP address or an IP address in an address pool.
Firewall SNAT policies are available in Reverse Proxy, True Transparent Proxy, and Transparent Inspection operating
modes.
FortiWeb applies a firewall SNAT policy only if IP forwarding is enabled. For details
about IP forwarding, see "router setting" on page 104.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config system firewall snat-policy
edit policy_name
set from “<source_ipv4_mask>”
set out-interface “<egress_port>”
set to “<destination_ipv4_mask>”
set trans-to-ip “<translation_ipv4>”
set trans-to-ip-end “<last_ipv4>”
set trans-to-ip-start “<first_ipv4>”
set trans-to-type {ip | pool}
policy_name Enter a name that identifies the firewall SNAT policy. Don't No
use spaces or special characters. The maximum length is default.
63 characters.
out-interface “<egress_ Select the interface that FortiWeb will use to forward traffic No
port>” that matches the from “<source_ipv4_mask>” default.
(page 254).
trans-to-ip Enter the IP address that you want to translate the from 0.0.0.0
“<translation_ipv4>”
Related Topic
l "router setting" on page 104
system fortigate-integration
FortiGate appliances can maintain a list of source IPs that it prevents from interacting with the network and protected
systems. You can configure FortiWeb to receive this list of IP addresses at intervals you specify. Then, you configure an
inline protection profile to detect the IP addresses in the list and take an appropriate action.
This feature is available only if the operating mode is Reverse Proxy or True Transparent Proxy.
This command configures a FortiGate appliance that provides banned source IPs. To configure FortiWeb to detect the
quarantined IP addresses and take the appropriate action, configure the FortiGate Quarantined IPs settings in an inline
protection profile. For details, see "waf web-protection-profile inline-protection" on page 518.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config system fortigate-integration
set address "<address_ipv4>"
set port <port_int>
set protocol {HTTP | HTTPS}
set username "<username_str>"
set password "<password_str>"
set schedule-frequency <schedule-frequency_int>
set flag {enable | disable}
end
address "<address_ipv4>" Enter the FortiGate IP address that is used for administrative No
access. default.
protocol {HTTP | HTTPS} Specify whether the FortiGate and FortiWeb communicate HTTP
securely using HTTPS.
password "<password_str>" Enter the password for the FortiGate administrator account No
that FortiWeb uses. default.
flag {enable | disable} Enables or disables the transmission of quarantined source IP disable
address information from the specified FortiGate.
Related topics
l "waf file-upload-restriction-policy" on page 384
l "log reports" on page 83
l "system fortisandbox-statistics" on page 658
system fortisandbox
Use this command to configure FortiWeb to submit all files that match your upload restriction rules to FortiSandbox.
FortiSandbox evaluates whether the file poses a threat and returns the result to FortiWeb. If FortiSandbox determines
that the file is malicious, FortiWeb performs the following tasks:
Syntax
config system fortisandbox
set type {fsa | cloud}
set server "<server_ipv4>"
set ssl {enable | disable}
set cache-timeout <timeout_int>
set email "<email_str>"
set interval <interval_int>
set elog {enable | disable}
end
type {fsa | cloud} Specify whether FortiWeb submits files that match the upload fsa
restriction rules to a FortiSandbox physical appliance (or
FortiSandbox-VM) or to FortiSandbox Cloud.
ssl {enable | disable} Enter enable to communicate with the specified disable
FortiSandbox using SSL.
Enter how long FortiWeb waits before it clears the hash table
entry for an uploaded file that was evaluated by
FortiSandbox, in hours.
cache-timeout <timeout_
72
int>
The valid range is 1–168.
email "<email_str>" Enter the email address that FortiSandbox sends weekly No
reports and notifications to. default.
elog {enable | disable} Enter so that FortiWeb will report event logs when it successfully disable
submits files to FortiSandbox.
Example
This example creates a connection to a FortiSandbox at 192.0.2.2 that retrieves statistics at the default interval (5
minutes) and sends a weekly report to [email protected].
config system fortisandbox
set server "192.0.2.2"
set ssl enable
set email "[email protected]"
end
Related topics
l "waf file-upload-restriction-policy" on page 384
l "log reports" on page 83
l "system fortisandbox-statistics" on page 658
system global
Use this command to configure system-wide settings such as language, display refresh rate and listening ports of the
web UI, the time zone and host name of the FortiWeb appliance, and NTP time synchronization.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config system global
set admin-port <port_int>
set admin-sport <port_int>
set admin-lockout-threshold <admin-lockout-threshold_int>
set admin-lockout-duration <minutes_int>
confsync-port <port_int> Enter the port number the local FortiWeb 8333
uses to listen for a remote (peer)
FortiWeb.
dh-params {1024 | 1536 | 2048 | Specifies the key length that FortiWeb
3072 | 4096 | 6144 | 8192} presents in Diffie-Hellman exchanges. Most
2048
web browsers require a key length of at least
2048.
ie6workaround {enable | disable} Enable to use the work around for a navigation disable
bar freeze issue caused by using the web UI
with Microsoft Internet Explorer 6.
page.
http://www.ntp.org/
pre-login-banner {enable | disable} Enable to add a login disclaimer message for disable
administrators logging in to FortiWeb.
timezone "<time-zone-code_str>" Enter the two-digit code for the time zone
in which the FortiWeb appliance is
located. 04
Example
This example configures time synchronization with a public NTP server pool. The FortiWeb appliance is located in the
Pacific Time zone (code 04) and will synchronize its time with the NTP server pool every 60 minutes.
config system global
set timezone 08
set ntpsync enable
set ntpserver "pool.ntp.org"
set syncinterval 30
end
For an example that includes a hostname, see "system dns" on page 242.
Related topics
l "system admin" on page 201
l "system autoupdate schedule" on page 212
l "system interface" on page 280
l "system dns" on page 242
l "system advanced" on page 208
l "router static" on page 106
l "date" on page 632
l "time" on page 654
l "system status" on page 660
system ha
Use this command to configure the FortiWeb appliance to act as a member of a high availability (HA) cluster in order to
improve availability.
By default, FortiWeb appliances are each a single, standalone appliance and operate independently.
If you have purchased more than one FortiWeb appliance, you can configure them to form an active-passive or active-
active high availability (HA) FortiWeb cluster. This improves availability so that you can achieve your service level
agreement (SLA) uptimes even if hardware failures occur or maintenance periods are required.
If you have multiple FortiWeb appliances but do not need failover, you can still synchronize
the configuration. This can be useful for cloned network environments and externally load-
balanced active-active HA. For details, see "server-policy custom-application application-
policy" on page 110.
HA requirements
l Two (for active-passive mode and active-active mode) or more (for active-active mode) identical physical FortiWeb
appliances and firmware versions
l Redundant network topology: if the active appliance fails, physical network cabling and routes must redirect web traffic to
the standby appliance
l At least one physical port on both HA appliances connected directly, via crossover cables, or through switches
FortiWeb-VM now supports HA. However, if you do not wish to use the native HA, you can
use your hypervisor or VM environment manager to install your virtual appliances over a
hardware cluster to improve availability. For example, VMware clusters can use vMotion or
VMware HA.
If FortiWeb HA is active-passive: one appliance is selected to be the active appliance (also called the primary, main, or
master), applying the policies for all connections. The other is a passive standby (also called the secondary, standby, or
slave), which assumes the role of the active appliance and begins processing connections only if the active appliance
fails.
If FortiWeb HA is active-active: all the cluster members are operating as active appliances together to simultaneously
handle the traffic between clients and the back web servers. In an active-active HA cluster, one of the member
appliances will be selected as the master appliance to centrally receive traffic from clients and back web servers to
distribute the traffic to all the cluster members (including itself) according to the specified load balancing algorithm.
An active-active HA cluster requires heartbeat detection and configuration and session synchronization between
the cluster members. If the master appliance fails, one of the slaves will take it over. An active-active HA cluster can be
created only in Reverse Proxy and True Transparent Proxy mode, and at most eight FortiWeb appliances are
allowed in the cluster.
For more information on HA, including troubleshooting, failover behavior, synchronized data, and network topology, see
the FortiWeb Administration Guide:
https://docs.fortinet.com/fortiweb/admin-guides
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config system ha
set mode {active-passive | active-active | standalone}
set group-id <group_int>
set group-name "<pair-name_str>"
set priority <level_int>
set override {enable | disable}
set network-type {flat | udp-tunnel}
group-name "<pair-name_ Enter a name to identify the HA pair if you have more than No default.
str>" one.
priority <level_int> Enter the priority of the appliance when electing the 5
primary appliance in the HA pair. On standby devices, this
setting can be reconfigured using the CLI command
config ha manage (page 636).
network-type {flat | udp- Select the common HA mode flat or udp-tunnel mode on flat
tunnel} OpenStack platform.
hbdev "<interface_name>" Select which port on this appliance that the main and No default.
standby appliances will use to send heartbeat signals and
synchronization data between each other (i.e. the HA
heartbeat link). The maximum length is 15 characters.
hbdev-backup "<interface_ Select a secondary, standby port on this appliance that No default.
name>" the main and standby appliances will use to send
heartbeat signals and synchronization data between each
other (i.e. the HA heartbeat link).
lacp-ha-slave {enable Enable to provide support for 2 LACP interfaces, also disable
| disable} known as "bridges," "V-zones," or "aggregated links." For
more information about configuring bridges, see the
FortiWeb Administration Guide:
http://docs.fortinet.com/fortiweb/admin-guides
arps <arp_int> Enter the number of times that the FortiWeb appliance 3
will broadcast address resolution protocol (ARP) packets
(IPv4 environment) or Neighbor Solicitation (NS) packets
(IPv6 environment) when it takes on the main role. Even
though a new NIC has not actually been connected to the
network, FortiWeb does this to notify the network that a
different physical port has become associated with the IP
address and virtual MAC of the HA pair.
The valid range is 1–20 (that is, between 100 and 2,000
milliseconds).
monitor {"<interface_ Enter the name of one or more network interfaces that No default.
name>" ...} each directly correlate with a physical link. These ports will
be monitored for link failure.
ha-mgmt-status {enable | Specifies whether the network interface you select disable
disable} provides administrative access to this appliance when it is
a member of the HA cluster.
ha-mgmt-interface-gateway Enter the IPv4 address of a next-hop router. Use this No default.
"<router_ipv4>" command so that the management port can manage
each unit in the cluster even if a client or reserve interface
is in a different subnet.
ha-mgmt-interface- Enter the IPv6 address of a next-hop router. Use this No default.
gateway6 "<router_ipv6>" command so that the management port can manage
each unit in the cluster even if a client or reserve interface
is in a different subnet.
session-sync-dev The master appliance use the heartbeat interface (hbdev No default.
{"<interface_name>" ...} "<interface_name>" (page 269)) to synchronize its
session table to other appliances in an active-active HA
cluster by default. However, you can use extra interfaces
(up to four interfaces) for the session synchronization
when the HA cluster is in heavy traffic.
Note:
l Only the master appliance in the active-active HA cluster is
allowed to set session-sync-dev. The configuration
here will be synchronized to all the slave appliance in the
cluster by the master, and all the appliances send or receive
session information with the same interface configuration.
l The heartbeat interface will not participate in the session
synchronization anymore if other interfaces are specified
here.
l It can not specify the heartbeat interface to session-
sync-dev.
l Available only when mode {active-passive |
active-active | standalone} (page 267) is
active-active.
weight-1 <weight_int> When the system ha (page 265) algorithm is ip, sets 1
the weight for the first unit in an active-active HA cluster.
weight-2 <weight_int> When the schedule algorithm is ip, sets the weight for 1
the second unit in an active-active HA cluster.
weight-3 <weight_int> When the system ha (page 265) algorithm is ip, sets 1
the weight for the third unit in an active-active HA cluster.
weight-4 <weight_int> When the system ha (page 265) algorithm is ip, sets 1
the weight for the fourth unit in an active-active HA
cluster.
weight-5 <weight_int> When the system ha (page 265) algorithm is ip, sets 1
the weight for the fifth unit in an active-active HA cluster.
weight-6 <weight_int> When the system ha (page 265) algorithm is ip, sets 1
the weight for the sixth unit in an active-active HA cluster.
weight-7 <weight_int> When the system ha (page 265) algorithm is ip, sets 1
the weight for the seventh unit in an active-active HA
cluster.
weight-8 <weight_int> When the system ha (page 265) algorithm is ip, sets 1
the weight for the eighth unit in an active-active HA
cluster.
session-pickup {enable Enable so that the master unit in the HA cluster disable
| disable} synchronizes the session table with all cluster units. If a
cluster unit fails, the HA session table information is
available to the remaining cluster units which can use the
session table to resume connections without interruption.
| disable}
ha-eth-type <ha-eth-type_ HA heartbeat packet Ethertype (4-digit hex). The range is No default.
str> 0x8890–0x889F.
Example
This example configures a FortiWeb appliance as one appliance in an active-passive HA pair whose group ID is 1. The
primary heartbeat occurs over port3, and the secondary heartbeat link is over port4. Priority is more important than
uptime when electing the main appliance. The appliance will wait 30 seconds after boot time for a heartbeat or
synchronization before assuming that it should be that main appliance. Aside from the heartbeat link, failover can also
be triggered by port monitoring of port1 and port2.
config system ha
set mode active-passive
set group-id 1
set priority 6
set override enable
set hbdev port3
set hbdev-backup port4
set arps 3
set arp-interval 2
set hb-interval 1
set hb-lost-threshold 3
set monitor port1 port2
set boot-time 30
end
Related topics
l "system interface" on page 280
l "debug application hasync" on page 566
l "debug application hatalk" on page 567
l "system ha status" on page 617
l "ha disconnect" on page 634
l "ha manage" on page 636
l "ha synchronize" on page 637
l "system status" on page 660
Use this command to edit the configuration so that FortiWeb will work with SafeNet Luna SA HSM (hardware security
module). The HSM integration allows FortiWeb to retrieve a per-connection SSL session key instead of loading the local
private key and certificate.
Because the HSM configuration requires you to upload a server certificate, you can
create it using the web UI only. After you create the configuration in the web UI, this
command allows you to edit it.
For detailed information on integrating HSM with FortiWeb, see the FortiWeb
Administration Guide:
https://docs.fortinet.com/fortiweb/admin-guides
Before you can show or edit HSM configuration in the CLI and access HSM settings in the web UI, use the following
command to enable the HSM settings:
config server-policy setting
set hsm enable
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config system hsm info
set ip "<hsm_ipv4>"
set port <port_int>
set timeout <timeout_int>
set filename "<filename_str>"
set action {register | unregister}
end
timeout <timeout_int> Enter a timeout value for the connection between HSM and No
FortiWeb. default.
Shows the name of the server certificate file from the HSM.
You cannot edit this option using the CLI. No
filename "<filename_str>"
default.
Related topics
l "system hsm partition" on page 279
l "system certificate local" on page 226
Use this command to edit information about the partition that the FortiWeb HSM client is assigned to. The partition
settings are part of the configuration that allows FortiWeb to work with SafeNet Luna SA HSM (hardware security
module).
Before you can show or edit HSM configuration in the CLI and access HSM settings in the web UI, use the following
command to enable the HSM settings:
config server-policy setting
set hsm enable
For additional HSM integration settings, see "system hsm info" on page 278.
For detailed information on integrating HSM with FortiWeb, see the FortiWeb Administration Guide:
https://docs.fortinet.com/fortiweb/admin-guides
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config system hsm partition
edit "<partition_name>"
set password <password_int>
end
"<partition_name>" Enter the name of a partition that the FortiWeb HSM client is No
assigned to. default.
No
password <password_int> Enter the partition password.
default.
Related topics
l system hsm info (page 278)
l system certificate local (page 226)
system interface
l The network interfaces associated with the physical network ports of the FortiWeb appliance
l VLAN subinterfaces or 802.3ad link aggregates associated with physical network interfaces
Both the network interfaces and VLAN subinterfaces can include administrative access.
You can restrict which IP addresses are permitted to log in as a FortiWeb administrator through the network interfaces
and VLAN subinterfaces. For details, see "system admin" on page 201.
When the FortiWeb appliance is operating in either of the transparent modes, VLANs do
not support Cisco discovery protocol (CDP).
You can use SNMP traps to notify you when a network interface’s configuration changes, or when a link is brought down
or brought up. For details, see "system snmp community" on page 299.
To use this command, your administrator account’s access control profile must have either rw permission to the
netgrp area. For details, see "Permissions" on page 51.
Syntax
config system interface
edit "<interface_name>"
set status {up | down}
set type {aggregate | physical | vlan | redundant}
set algorithm {layer2 | layer2_3 | layer3_4}
status {up | down} Enable (select up) to bring up the network interface so that it
is permitted to receive and/or transmit traffic.
algorithm {layer2 | Select the connectivity layers that will be considered when layer2
layer2_3 | layer3_4} distributing frames among the aggregated physical ports.
allowaccess {http https Enter the IPv4 protocols that will be permitted for
ping snmp ssh telnet FWB- administrative connections to the network interface or VLAN
manager}
subinterface.
ip6-allowaccess {http Enter the IPv6 protocols that will be permitted for ping
https ping snmp ssh administrative connections to the network interface or VLAN
telnet FWB-manager}
subinterface.
wccp {enable | disable} Specify whether FortiWeb uses the interface to communicate
with a FortiGate unit configured as a WCCP server. disable
Available only when the operation mode is WCCP.
description "<comment_ Enter a description or other comment. If the comment is more than No
str>" one word or contains an apostrophe, surround the comment with default.
interface "<interface_ Enter the name of the network interface with which the VLAN
name>" subinterface will be associated. The maximum length is 15
characters. No
default.
This field is available only if type {aggregate |
physical | vlan | redundant} (page 284) is vlan.
intf {"<port_name>" ...} Enter the names of 2 physical network interfaces or more that No
will be combined into the aggregate link. Only physical default.
network interfaces may be aggregated. The maximum length
is 15 characters each.
ip "<interface_ipv4mask>" Enter the IPv4 address and netmask of the network interface, if
any. The IP address must be on the same subnet as the network to
Varies by
which the interface connects. Two network interfaces cannot have
the
IP addresses on the same subnet. The default setting for port1 is
interface.
192.168.1.99 with a netmask of 255.255.255.0. Other
ports have no default.
ip6 "<interface_ Enter the IPv6 address and netmask of the network interface, if ::/0
ipv6mask>" any. The IP address must be on the same subnet as the network to
which the interface connects. Two network interfaces cannot have
IP addresses on the same subnet.
lacp-speed {fast | slow} Select the rate of transmission for the LACP frames (LACPUs)
between FortiWeb and the peer device at the other end of the
trunking cables, either:
Note: This must match the setting on the other device. If the
rates do not match, FortiWeb or the other device could
mistakenly believe that the other’s ports have failed,
effectively disabling ports in the trunk.
type {aggregate | Indicates whether the interface is directly associated with a Varies by
physical | vlan single physical network port, a group of redundant interfaces, the
| redundant}
or is instead a VLAN subinterface or link aggregate. interface.
mode {static | dhcp} Specify whether the interface obtains its IPv4 address and
static
netmask using DHCP.
ip6-mode {static | dhcp} Specify whether the interface obtains its IPv6 address and static
netmask using DHCP.
vlanid <vlan-id_int> Enter the VLAN ID of packets that belong to this VLAN
subinterface.
https://docs.fortinet.com/fortiweb/admin-guides
This field is available only when type {aggregate |
physical | vlan | redundant} (page 284) is vlan.
The valid range is between 1 and 4094 and must match the
VLAN ID added by the IEEE 802.1q-compliant router or switch
connected to the VLAN subinterface.
<entry_index> Enter the index number of the individual entry in the table. No
default.
ip {"<interface_ Type an additional IPv4 or IPv6 address and netmask for the
ipv4mask>" | "<interface_ network interface.
ipv6mask>"} No
Available only when ip-src-balance or ip6-src- default.
balance is enabled. For details, see "system network-
option" on page 287.
mtu <mtu_int> Enter the maximum transmission unit (MTU) that the 1500
interface supports.
dynamic_dns1 <dynamic_ This field applies only if the mode dhcp is selected. No
dns1_str> The primary DNS server IP address. default.
dynamic_dns2 <dynamic_ This field applies only if the mode dhcp is selected. No
dns2_str> The secondary DNS server IP address. default.
Example
This example configures the network interface named port1, associated with the first physical network port, with the IP
address and subnet mask 192.0.2.1/24. It also enables ICMP ECHO (ping) and HTTPS administrative access to that
network interface, and enables it.
config system interface
edit "port1"
set ip "192.0.2.1 255.255.255.0"
set allowaccess ping https
set status up
next
end
Example
This example configures the network subinterface named vlan_100, associated with the physical network interface
port1, with the IP address and subnet mask 192.0.2.1/24. It does not allow administrative access.
config system interface
edit "vlan_100"
set type vlan
set ip "192.0.2.1 255.255.255.0"
set status up
Related topics
l "system v-zone" on page 310
l "router static" on page 106
l "server-policy vserver" on page 196
l "system snmp community" on page 299
l "system admin" on page 201
l system ha
l "system network-option" on page 287
l "ping" on page 638
l "hardware nic" on page 597
l "network ip" on page 603
l "network sniffer" on page 607
system ip-detection
Use this command to configure how FortiWeb analyzes the identification (ID) field in IP packet headers in order to
distinguish source IP addresses that are actually Internet connections shared by multiple clients, not single clients.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config system ip-detection
set share-ip-detection-level {low | medium | high}
end
share-ip-detection-level Select how different packets’ ID fields can be before FortiWeb low
{low | medium | high} detects that an IP is shared by multiple clients.
Related topics
l "system advanced" on page 208
system network-option
To use this command, your administrator account’s access control profile must have either w or rw permission to the
netgrp area. For details, see "Permissions" on page 51.
Syntax
config system network-option
set tcp-timestamp {enable | disable}
set tcp-tw-recycle {enable | disable}
set ip-src-balance {enable | disable}
set ip6-src-balance {enable | disable}
set tcp-buffer {default | high | max}
set arp_ignore {enable | disable}
set loopback-mtu <loopback-mtu_int>
set tcp-usertimeout <tcp-usertimeout_int>
set tcp-keepcnt <tcp-keepcnt_int>
set tcp-keepidle <tcp-keepidle_int>
set tcp-keepintvl <tcp-keepintvl_int>
set loopback-tso-gso {enable | disable}
set route-priority {system | dhcp}
set dns-priority {system | dhcp}
end
ip-src-balance {enable | Enable to allow FortiWeb to connect to the back-end servers disable
disable} using more than one IPv4 address. FortiWeb uses a round-
robin load-balancing algorithm to distribute the connections
among the available IP addresses.
tcp-buffer {default | Specify high or max to increase the size of the TCP buffer. default
high | max}
This option is useful when amount of traffic between a server
pool member and FortiWeb is significantly larger than traffic
between FortiWeb and the client.
loopback-mtu <loopback- If the operation mode is True Transparent Proxy, specify a 65536
mtu_int> global MTU for v-zones.
tcp-usertimeout <tcp- Enter how long FortiWeb waits before it closes the connection 120
tcp-keepintvl <tcp- Enter how often FortiWeb sends a keepalive packet to a client 20
keepintvl_int> that keeps a connection open without sending data, in
seconds.
loopback-tso-gso {enable
| disable} Used for debugging. disable
route-priority {system | Configure the priority of route IP address obtained by the system No
dhcp} and dhcp, whose route IP address has the priority. default
dns-priority {system | Configure the priority of DNS obtained by the system and dhcp, No
dhcp} whose DNS has the priority. default
Example
This example assigns additional IP addresses to port1. FortiWeb uses a round-robin load-balancing algorithm to
distribute connections to back-end servers among the available IP addresses.
config system network-option
set ip-src-balance enable
end
Related topics
l "system interface" on page 280
l "ping" on page 638
l "network ip" on page 603
l "network sniffer" on page 607
system password-policy
Use this command to configure a password policy for administrator accounts that set rules for password characteristics.
Syntax
config system password-policy
set status {enable | disable}
set min-length-option {enable | disable}
set mini-length <mini-length_int>
set single-admin-mode {enable | disable}
set character-requirements {enable | disable}
set min-upper-case-letter <min-upper-case-letter_int>
set min-lower-case-letter <min-lower-case-letter_int>
set mini-number <mini_number_int>
set min-non-alphanumeric <min-non-alphanumeric_int>
set forbid-password-reuse {enable | disable}
set history-password-number <history-password-number_int>
set expire-status {enable | disable}
set expire-day <expire-day_int>
end
min-length-option {enable | disable} Enable/disable to set the minimum length for the
disable
password.
forbid-password-reuse {enable
| disable} Enable forbidding password re-use. disable
expire-day <expire-day_int> Enter the valid period for the password. The valid 90
range 1–999 days
Example
This example enables configuration of the password policy.
config system password-policy
set status enable
set system password-policy
set min-length 8
set single-admin-mode enable
set character-requirements enable
set min-upper-case-letter 2
set min-lower-case-letter 2
set min-number 2
set min-non-alphanumeric 3
set forbid-password-reuse enable
set history-password-number 2
set expire-status enable
set expire-day 100
end
system raid
Currently, only RAID level 1 is supported, and only on the following models shipped with FortiWeb 4.0 MR1 or later:
l FortiWeb-1000B
l FortiWeb-1000C
l FortiWeb-1000D
l FortiWeb-1000E
l FortiWeb-2000E
l FortiWeb-3000C
l FortiWeb-3000D
l FortiWeb-3000E
l FortiWeb-4000C
l FortiWeb-4000D
l FortiWeb-4000E
On older appliances that have been upgraded to FortiWeb 4.0 MR1 or later, RAID cannot be activated.
Back up the data regularly. RAID is not a substitute for regular backups. RAID 1 (mirroring)
is designed to improve hardware fault tolerance, but cannot negate all risks.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config system raid
set level {raid1}
end
level {raid1} Enter the RAID level. Currently, only RAID level 1 is supported. raid1
Example
This example sets RAID level 1.
config system raid
set level raid1
end
Related topics
l "create-raid level" on page 630
l "create-raid rebuild" on page 631
l "hardware raid list" on page 599
system replacemsg
l Pages that FortiWeb presents to clients when it authenticates users. FortiWeb uses these pages when you configure
a site publishing configuration to use HTML form authentication for its client authentication method. For details, see
"waf site-publish-helper rule" on page 475.
l The error page FortiWeb uses to respond to an HTTP request that violates a policy that responds to violations with
the action alert and deny or period block.
l The “Server Unavailable!” page that FortiWeb returns to the client when none of the server pool members are
available either because they are disabled or in maintenance more, or they have failed the configured health check.
When you specify the HTML code for the web pages using the buffer setting, you enter
the complete HTML code with changes, even if you are only changing a word or fixing a
typographical error. The web UI provides a more convenient editing method that allows you
to see the effect of your changes as you edit.
FortiWeb uses these pages for all server policies. If you require a page content that is customized for a specific policy,
create an ADOM that contains the custom pages for that policy.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config system replacemsg
edit {url-block | server-inaccessible | login | token | rsa-login | rsa-challenge
| pre-login-disclaimer}
setbuffer "<buffer_str>"
setcode <code_int>
setset format {html | none | text}
setset group {alert | site-publish}
setset header {8 bit | HTTP | no header type}
end
{url-block | server- Enter one of the following options to specify the page No default
inaccessible | login to modify:
| token | rsa-login
code <code_int> If you are editing the url-block item, specify the 500
HTTP page return code as an integer.
set group {alert | Specifies whether the replacement page is used for alert (url-
site-publish} security features (blocking and server unavailable) or block, server-
site publishing feature. inaccessible)
set header {8 bit | Specifies the header type for the message.
HTTP | no header HTTP
type} Cannot be changed from the default.
Related topics
l "system replacemsg-image" on page 296
system replacemsg-image
Use this command to add images that the FortiWeb HTML web pages can use. These pages are the ones that
FortiWeb uses for blocking, authentication, and unavailable servers.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config system replacemsgimage
edit "<image_name>"
set image-type {gif | jpg | png | tiff}
set image-base64 <image_code>
end
image-base64 <image_code> Enter the HTTP page return code as clear text, Base64- No
encoded. default
Related topics
l "system replacemsg" on page 294
system settings
Use this command to configure the operation mode and gateway of the FortiWeb appliance.
You will usually set the operation mode once, during installation. Exceptions include if you install the FortiWeb
appliance in Offline Protection mode for evaluation purposes, before deciding to switch to another mode for more
feature support in a permanent deployment.
Back up your configuration before changing the operation mode. Changing modes deletes
any policies not applicable to the new mode, TCP SYN flood protection settings, all static
routes, all V-zone (bridge) IPs, and all VLANs. You must re-cable your network topology to
suit the operation mode, unless you are switching between the two transparent modes,
which have similar network topology requirements.
The physical topology must match the operation mode. You may need to re-cable your deployment after changing this
setting. For details, see the FortiWeb Installation Guide.
l Reverse proxy—Requests are destined for a virtual server’s network interface and IP address on the FortiWeb
appliance. The FortiWeb appliance applies the first applicable policy, then forwards permitted traffic to a real web
server. The FortiWeb appliance logs, blocks, or modifies violations according to the matching policy and its
protection profile. Most features are supported.
l Offline Protection — Requests are destined for a real web server instead of the FortiWeb appliance; traffic is
duplicated to the FortiWeb through a span port. The FortiWeb appliance monitors traffic received on the virtual
server’s network interface (regardless of the IP address) and applies the first applicable policy. Because it is not inline
with the destination, it does not forward permitted traffic. The FortiWeb appliance logs or blocks violations according
to the matching policy and its protection profile. If FortiWeb detects a malicious request, it sends a TCP RST (reset)
packet to the web server and client to attempt to terminate the connection. It does not otherwise modify traffic. (It
cannot, for example, apply SSL, load-balance connections, or support user authentication.)
Unlike in Reverse Proxy mode or True Transparent Proxy mode, actions other than Alertcannot be guaranteed to be
successful in Offline Protection mode. The FortiWeb appliance will attempt to block traffic that violates the policy by
mimicking the client or server and requesting to reset the connection. However, the client or server may receive the
reset request after it receives the other traffic due to possible differences in routing paths.
Most organizations do not permanently deploy their FortiWeb appliances in Offline Protection mode. Instead, they
will use Offline Protection as a way to learn about their web servers’ protection requirements and to form some of the
appropriate configuration during a transition period, after which they will switch to one of the operation modes that
places the appliance inline between all clients and all web servers.
Switching out of Offline Protection mode when you are done with transition can prevent bypass problems that can
arise as a result of misconfigured routing. It also offers you the ability to offer some protection features that cannot
be supported in a span port topology used with offline detection.
l True transparent proxy — Requests are destined for a real web server instead of the FortiWeb appliance. The
FortiWeb appliance transparently proxies the traffic arriving on a network port that belongs to a Layer 2 bridge,
applies the first applicable policy, and lets permitted traffic pass through. The FortiWeb appliance logs, blocks, or
modifies violations according to the matching policy and its protection profile. No changes to the IP address
scheme of the network are required. This mode supports user authentication via HTTP but not HTTPS.
l Transparent Inspection — Requests are destined for a real web server instead of the FortiWeb appliance. The
FortiWeb appliance asynchronously inspects traffic arriving on a network port that belongs to a Layer 2 bridge,
applies the first applicable policy, and lets permitted traffic pass through. The FortiWeb appliance logs or blocks
traffic according to the matching policy and its protection profile, but does not otherwise modify it. (It cannot, for
example, apply SSL, load-balance connections, or support user authentication.
Unlike in Reverse Proxy mode or True Transparent Proxy mode, actions other than
Alertcannot be guaranteed to be successful in Transparent Inspection mode. The
FortiWeb appliance will attempt to block traffic that violates the policy. However, due to the
nature of asynchronous inspection, the client or server may have already received the
traffic that violated the policy.
Feature support varies by operation mode. For details, see the FortiWeb Administration Guide:
https://docs.fortinet.com/fortiweb/admin-guides
You can use SNMP traps to notify you if the operation mode changes. For details, see "system snmp community" on
page 299.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config system settings
set opmode {offline-protection | reverse-proxy | transparent | transparent-
inspection | wccp}
set gateway "<router_ipv4>"
set stop-guimonitor {enable | disable}
set enable-cache-flush {enable | disable}
set enable-debug-log {enable | disable}
set enable-machine-learning-debug {enable | disable}
set enable-file-upload {enable | disable}
end
opmode {offline- Select the operation mode of the FortiWeb appliance. reverse-
protection | reverse- proxy
proxy | transparent | If you have not yet adjusted the physical topology to suit the
transparent-inspection | new operation mode, see the FortiWeb
wccp}
Administration Guide:
https://docs.fortinet.com/fortiweb/admin-guides
You may also need to reconfigure IP addresses, VLANs,
static routes, bridges, policies, TCP SYN flood prevention,
and virtual servers, and on your web servers, enable or
disable SSL.
gateway "<router_ipv4>" Type the IPv4 address of the default gateway. none
stop-guimonitor {enable | Enable to configure FortiWeb to stop checking whether the enable
disable} process that generates the web UI (httpsd) is defunct.
enable-debug-log {enable Enable so that FortiWeb will record crash, daemon, kernel, enable
| disable} netstat, and core dump logs.
enable-machine-learning-
debug {enable | disable} Enable so that FortiWeb will record machine learning debug. enable
Related topics
l "server-policy policy" on page 146
l "server-policy vserver" on page 196
Use this command to configure the FortiWeb appliance’s SNMP agent to belong to an SNMP version 1 or 2c
community, and to select which events cause the FortiWeb appliance to generate SNMP traps.
To configure the SNMP agent as a member of a SNMP version 3 community, see "system snmp user" on page 306.
The FortiWeb appliance’s simple network management protocol (SNMP) agent allows queries for system information
can send traps (alarms or event messages) to the computer that you designate as its SNMP manager. In this way you
can use an SNMP manager to monitor the FortiWeb appliance. You can add the IP addresses of up to eight SNMP
managers to each community, which designate the destination of traps and which IP addresses are permitted to query
the FortiWeb appliance.
An SNMP community is a grouping of equipment for network administration purposes. You must configure your
FortiWeb appliance to belong to at least one SNMP community so that community’s SNMP managers can query the
FortiWeb appliance’s system information and receive SNMP traps from the FortiWeb appliance.
You can add up to three SNMP communities. Each community can have a different configuration for queries and traps,
and the set of events which trigger a trap. Use SNMP traps to notify the SNMP manager of a wide variety of types of
events. Event types range from basic system events, such as high usage of resources, to when an attack type is
detected or a specific rule is enforced by a policy.
Before you can use SNMP, you must activate the FortiWeb appliance’s SNMP agent and add it as a member of at least
one community. For details, see "system snmp sysinfo" on page 304. You must also enable SNMP access on the
network interface through which the SNMP manager will connect. For details, see "system interface" on page 280.
On the SNMP manager, you must also verify that the SNMP manager is a member of the community to which the
FortiWeb appliance belongs, and compile the necessary Fortinet proprietary management information blocks (MIBs)
and Fortinet-supported standard MIBs. For information on MIBs, see the FortiWeb Administration Guide:
https://docs.fortinet.com/fortiweb/admin-guides
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config system snmp community
edit <community_index>
set status {enable | disable}
set name "<community_str>"
set events {cpu-high | intf-ip | log-full | mem-low | netlink-down-status |
netlink-up-status | policy-start | policy-stop | pserver-failed | sys-ha-
cluster-status-change | sys-ha-member-join | sys-ha-member-leave | sys-
mode-change | waf-access-attack | waf-amethod-attack | waf-blogin-
attack |waf-hidden-fields | waf-pvalid-attack | waf-signature-detection |
waf-url-access-attack | waf-spage-attack}
set query-v1-port <port_int>
set query-v1-status {enable | disable}
set query-v2c-port <port_int>
set query-v2c-status {enable | disable}
set trap-v1-lport <port_int>
set trap-v1-rport <port_int>
set trap-v1-status {enable | disable}
set trap-v2c-lport <port_int>
set trap-v2c-rport <port_int>
set trap-v2c-status {enable | disable}
config hosts
edit <snmp-manager_index>
set ip {"<manager_ipv4>" | "<manager_ipv6>"}
next
end
next
end
name "<community_str>" Enter the name of the SNMP community to which the No
FortiWeb appliance and at least one SNMP manager belongs. default.
The maximum length is 63 characters.
Enter the port number on which the FortiWeb appliance will listen
query-v1-port <port_int> for SNMP v1 queries from the SNMP managers of the community. 161
The valid range is 1–65,535.
query-v1-status {enable | Enable to respond to queries using the SNMP v1 version of the enable
disable} SNMP protocol.
Enter the port number on which the FortiWeb appliance will listen
query-v2c-port <port_int> for SNMP v2c queries from the SNMP managers of the community. 161
The valid range is 1–65,535.
query-v2c-status Enable to respond to queries using the SNMP v2c version of the enable
{enable | disable} SNMP protocol.
Enter the port number that will be the source (also called local) port
trap-v1-lport <port_int> 162
number for SNMP v1 trap packets. The valid range is 1–65,535.
trap-v1-rport <port_int> Enter the port number that will be the destination (also called 162
remote) port number for SNMP v1 trap packets. The valid range is
1–65,535.
trap-v1-status {enable | Enable to send traps using the SNMP v1 version of the SNMP
enable
disable} protocol.
trap-v2c-lport <port_int> Enter the port number that will be the source (also called local) port 162
number for SNMP v2c trap packets. The valid range is 1–65,535.
Enter the port number that will be the destination (also called
trap-v2c-rport <port_int> remote) port number for SNMP v2c trap packets. The valid range is 162
1–65,535.
trap-v2c-status {enable | Enable to send traps using the SNMP v2c version of the SNMP enable
disable} protocol.
Example
For an example, see "system snmp sysinfo" on page 304.
Related topics
l "system snmp sysinfo" on page 304
l "system interface" on page 280
l "server-policy policy" on page 146
Use this command to enable and configure basic information for the FortiWeb appliance’s SNMP agent.
Before you can use SNMP, you must activate the FortiWeb appliance’s SNMP agent and add it as a member of at least
one community. For details, see "system snmp community" on page 299. You must also enable SNMP access on the
network interface through which the SNMP manager will connect. For details, see "system interface" on page 280.
On the SNMP manager, you must also verify that the SNMP manager is a member of the community to which the
FortiWeb appliance belongs, and compile the necessary Fortinet proprietary management information blocks (MIBs)
and Fortinet-supported standard MIBs. For information on MIBs, see the FortiWeb Administration Guide:
https://docs.fortinet.com/fortiweb/admin-guides
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config system snmp sysinfo
set contact-info "<contact_str>"
set description "<description_str>"
set location "<location_str>"
set status {enable | disable}
set engine-id "<engine-id_str>"
end
contact-info "<contact_ Type the contact information for the administrator or other person No
str>" responsible for this FortiWeb appliance, such as a phone number default.
or name. The contact information can contain only letters (a-z, A-
Z), numbers, hyphens ( - ) and underscores ( _ ). The maximum
length is 63 characters.
location "<location_str>" Type the physical location of the FortiWeb appliance. The string No
can contain only letters (a-z, A-Z), numbers, hyphens ( - ) and default.
underscores ( _ ). The maximum length is 63 characters.
Example1234
This example enables the SNMP agent, configures it to belong to a community named public whose SNMP manager is
192.0.2.20. The SNMP manager is not directly attached, but can be reached through the network interface named
port3.
This example also configures the SNMP agent to send traps using SNMP v2c for high CPU or memory usage, and when
the primary appliance fails; it also enables responses to SNMP v2c queries through the network interface named port3
(along with the previously enabled administrative access protocols, ICMP ping, HTTPS, and SSH).
config system snmp sysinfo
set contact-info "admin_example_com"
set description "FortiWeb-1000E"
set location "Rack_2"
set status enable
set engine-id 246
end
Related topics
l "system snmp community" on page 299
l "system interface" on page 280
Use this command to configure the FortiWeb appliance’s SNMP agent to belong to an SNMP version 3 community, and
to select which events cause the FortiWeb appliance to generate SNMP traps.
To configure the SNMP agent as a member of a SNMP version version 1 or 2c community and for more information on
the SNMP agent, see "system snmp community" on page 299.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config system snmp user
edit name "<user_str>"
set status {enable | disable}
set security-level { noauthnopriv | authnopriv | authpriv >
set auth-proto {sha1 | md5}
set auth-pwd "<auth-password_str>"
set priv-proto {aes | des}
set priv-pwd "<priv-password_str>"
set query-status {enable | disable}
set query-port <port_int>
set trap-status {enable | disable}
set trapport-local <port_int>
set trapport-remote <port_int>
set trapevent {cpu-high | intf-ip | log-full | mem-low | netlink-down-status |
netlink-up-status | policy-start | policy-stop | pserver-failed | sys-ha-
cluster-status-change | sys-ha-member-join | sys-ha-member-leave | sys-
mode-change | waf-access-attack | waf-amethod-attack | waf-blogin-
attack |waf-hidden-fields | waf-pvalid-attack | waf-signature-detection |
waf-url-access-attack | waf-spage-attack}
set "<snmp-manager_index>"
config hosts
edit "<snmp-manager_index>"
set {"<manager_ipv4> | <manager_ipv6>"}
next
end
next
end
name "<user_str>" Enter the name of the SNMP user to which the FortiWeb No
appliance and at least one SNMP manager belongs. The default.
maximum length is 63 characters.
query-status {enable | Enable to respond to queries using the SNMP v3 version of the
enable
disable} SNMP protocol.
query-port <port_int> Enter the port number on which the FortiWeb appliance listens for 161
SNMP v3 queries from the SNMP managers of the community. The
valid range is 1–65,535.
trap-status {enable | Enable to send traps using the SNMP v3 version of the SNMP
enable
disable} protocol.
trapport-local <port_int> Enter the port number that is the source (also called local) port 162
number for SNMP v3 trap packets. The valid range is 1–65,535.
Enter the port number that is the destination (also called remote)
trapport-remote <port_
int> port number for SNMP v3 trap packets. The valid range is 1– 162
65,535.
trapevent {cpu-high | Enter the name of one or more the SNMP events. When No
intf-ip | log-full | mem- FortiWeb detects the specified events, it sends traps to the default.
low | netlink-down-
status | netlink-up- SNMP managers in this community. Also enable trap-
status | policy-start | status.
policy-stop | pserver-
failed | sys-ha-cluster- l cpu-high—CPU usage has exceeded 80%.
status-change | sys-ha- l intf-ip—A network interface’s IP address has changed. See
member-join | sys-ha- "system interface" on page 280.
member-leave | sys-mode-
change | waf-access- l log-full—Local log disk space usage has exceeded 80%. If
attack | waf-amethod- the space is consumed and a new log message is triggered, the
attack | waf-blogin- FortiWeb appliance will either drop it or overwrite the oldest log
attack |waf-hidden- message, depending on your configuration. For details, see "log
fields | waf-pvalid-
attack | waf-signature- disk" on page 73.
detection | waf-url- l mem-low—Memory (RAM) usage has exceeded 80%.
access-attack | waf-
l netlink-down-status—A network interface has been
spage-attack}
brought down (disabled). This could be due to either an
administrator changing the network interface’s settings, or due to
HA executing a failover.
l netlink-up-status—A network interface has been brought
up (enabled). This could be due to either an administrator
changing the network interface’s settings, or due to HA executing
a failover.
l policy-start—A policy was enabled. For details, see "server-
policy policy" on page 146.
l policy-stop—A policy was disabled. For details, see "server-
policy policy" on page 146.
l pserver-failed—A server health check has determined that
a physical server that is a member of a server farm is now
unavailable. For details, see "server-policy policy" on page 146.
l sys-ha-cluster-status-change—HA cluster status was
changed.
l sys-ha-member-join—HA member has joined.
l sys-ha-member-leave—HA member has left.
l sys-mode-change—The operation mode was changed. For
details, see "system settings" on page 296.
"<snmp-manager_index>" Enter the index number of an SNMP manager for the community. No
The valid range is 1–9,999,999,999,999,999,999. default.
Example
For an example, see "system snmp sysinfo" on page 304.
Related topics
l "system snmp sysinfo" on page 304
l "system interface" on page 280
l "server-policy policy" on page 146
system tcpdump
To use this command, your administrator account’s access control profile must have rw permission to the netgrp
area. For details, see "Permissions" on page 51.
Syntax
config system tcpdump
edit file id
set "<filter_str>"
set {any | "<interface_str>"}
set "<max-packet-count_int>"
end
"<filter_str>" Specify which protocols and port numbers that you do No default.
or do not want to capture, such as 'tcp and port
80 and host IP1 and ( IP2 or IP3 )', or
leave this field blank for no filters.
Note that please use the same filter expression as
tcpdump for this filter, you can refer to the Linux main
page of TCPDUMP
(http://www.tcpdump.org/manpages/tcpdump.1.html).
"<max-packet-count_int>" Specify the maximum packets you want to capture for 4000
the policy. Capture will stop automatically if the total
captured packets hit the count.
Related topics
l "debug" on page 559
system v-zone
Use this command to configure bridged network interfaces, also called v-zones.
Bridges allow network connections to travel through the FortiWeb appliance’s physical network ports without explicitly
connecting to one of its IP addresses.
For FortiWeb-VM, you must create vSwitches before you can configure a bridge. For
details, see the FortiWeb-VM Install Guide:
https://docs.fortinet.com/fortiweb/hardware
To use this command, your administrator account’s access control profile must have either w or rw permission to the
netgrp area. For details, see "Permissions" on page 51.
Syntax
config system v-zone
edit "<bridge_name>"
set interfaces {"<interface_name>" "<interface_name>" ...}
set monitor {enable | disable}
set mtu <mtu_int>
set use-interface-macs {"<interface_name>" "<interface_name>" ...}
set multicast-snooping {enable | disable}
next
end
mtu <mtu_int> Enter the maximum transmission unit (MTU) that the bridge 1500
supports.
multicast-snooping No
Enable/disable multicast snooping.
{enable | disable} default
monitor {enable | Specifies whether FortiWeb automatically brings down all disable
disable} members of this v-zone if one member goes down.
Example
This example configures a true bridge between port3 and port4. The bridge has no virtual network interface, and so it
cannot respond to pings.
config system v-zone
edit bridge1
set interfaces port3 port4
next
end
Related topics
l "system interface" on page 280
l "system settings" on page 296
system wccp
Use this command to configure FortiWeb as a Web Cache Communication Protocol (WCCP) client. This configuration
allows a FortiGate configured as a WCCP server to redirect HTTP and HTTPS traffic to FortiWeb for inspection.
If your WCCP configuration includes multiple WCCP clients, the WCCP server can balance the traffic load among the
clients. In addition, it detects when a client fails and redirects sessions to clients that are still available.
WCCP was originally designed to provide web caching with load balancing and fault tolerance and is described by the
Web Cache Communication Protocol Internet draft.
This feature requires the operation mode to be WCCP. For details, see "system settings" on page 296.
For information on connecting and configuring your network devices for WCCP mode, see the FortiWeb Administration
Guide:
https://docs.fortinet.com/fortiweb/admin-guides
For detailed information on configuring FortiGate and other Fortinet devices to act as a WCCP service group, see the
FortiGate WCCP topic in the FortiOS Handbook:
https://docs.fortinet.com/fortigate/admin-guides
Syntax
config system wccp
edit service-id <service-id_int>
set cache-id "<cache-id_ipv4>"
set router-list "<router-list_ipv4>"
set group-address "<group-address_ipv4>"
set authentication {enable | disable}
set password "<passwd_str>"
set cache-engine-method {GRE | L2}
set ports <ports_int>
set primary-hash [src-ip | dst-ip | src-port | dst-port}
set priority <priority_int>
set protocol <priority_int>
set assignment-weight <assignment-weight_int>
set assignment-bucket-format {ciso-implementation | wccp-v2}
set return-to-sender {enable | disable}
end
service-id <service-id_ Enter the service ID of the WCCP service group that this 51
int> WCCP client belongs to.
router-list "<router- Enter the IP addresses of the WCCP servers in the WCCP No default.
list_ipv4>" service group.
authentication {enable Specify whether communication between the WCCP server disable
| disable} and client is encrypted using the MD5 cryptographic hash
function.
All servers and clients in the group use the same password.
password "<passwd_str>" No default.
The maximum password length is 8 characters. Available
only when authentication {enable | disable}
(page 314) is enabled.
primary-hash [src-ip | Enter the hashing scheme that the WCCP server uses src-ip dst-ip
dst-ip | src-port | in combination with assignment-weight to direct
dst-port}
traffic, when the WCCP service group has more than
one WCCP client.
l src-ip—Source IP address
l dst-ip—Destination IP address
l src-port—Source port
l dst-port—Destination port
server transmits all the traffic to the service group with the
highest priority value.
protocol <priority_int> Enter the protocol of the network traffic the WCCP service 6
group transmits. For TCP sessions, enter 6.
assignment-bucket- Enter the hash table bucket format for the WCCP ciso-
format {ciso- cache engine. implementation
implementation | wccp-
v2} l cisco-implementation—Source IP address
l wccp-v2—Web Cache Communication Protocol
version 2
Example
This example configures FortiWeb as a WCCP client that belongs to the WCCP service group 52 and specifies the
interface used for WCCP client functionality (192.0.2.100) and the WCCP server (192.0.2.1).
config system wccp
edit service-id 52
set cache-id "192.0.2.100"
set router-list "192.0.2.1"
set ports 80 443
set primary-hash src-ip dst-ip
Related topics
l "system settings" on page 296
l "system interface" on page 280
user admin-usergrp
Use this command to configure LDAP/RADIUS/PKI remote authentication groups that can be used when configuring a
FortiWeb administrator account.
Before you can add a remote authentication group, you must first define at least one query for either LDAP or RADIUS
accounts (see "user ldap-user" on page 318 or "server-policy custom-application application-policy" on page 110), or a
PKI user (see "user pki-user" on page 324).
For information about certificate-based Web UI login, see the FortiWeb Administration Guide:
https://docs.fortinet.com/fortiweb/admin-guides
To use this command, your administrator account’s access control profile must have either w or rw permission to the
authusergrp area. For details, see "Permissions" on page 51.
Syntax
config user admin-usergrp
edit "<group_name>"
config members
edit <entry_index>
set type {ldap | radius | pki}
set ldap-name "<query_name>"
set radius-name "<query_name>"
set pki-name "<pki_name>"
next
end
next
end
"<group_name>" Enter the name of the remote authentication group. The maximum No
length is 63 characters. default.
<entry_index> Enter the index number of the individual entry in the table. The valid No
range is 1–9,999,999,999,999,999,999. default.
type {ldap | radius | Select the protocol used for the query, either LDAP, RADIUS or ldap
pki} PKI.
ldap-name "<query_name>" Enter the name of an existing LDAP account query. The
maximum length is 63 characters.
No
To display the list of existing queries, enter: default.
edit ?
radius-name "<query_ Enter the name of an existing RADIUS account query. The No
name>" maximum length is 63 characters. default.
pki-name "<pki_name>" Enter the name of an existing PKI user. The maximum length No
is 63 characters. default.
Example
This example creates a remote authentication group using an existing LDAP user query named LDAP Users 1.
Because remote authentication groups use LDAP queries by default, the LDAP query type is not explicitly configured.
config user admin-usergrp
edit "Admin LDAP"
config members
edit 0
set ldap-name "LDAP Users 1"
next
end
next
end
Related topics
l "system admin" on page 201
l "user ldap-user" on page 318
l "server-policy custom-application application-policy" on page 110
user kerberos-user
Use this command to specify a Kerberos Key Distribution Center (KDC) that FortiWeb can use to obtain a Kerberos
service ticket for web applications on behalf of clients.
Because FortiWeb determines the KDC to use based on the realm of the web application, you do not have to specify the
KDC in the site publish rule.
For details, see "waf site-publish-helper rule" on page 475 and the FortiWeb Administration Guide:
https://docs.fortinet.com/fortiweb/admin-guides
To use this command, your administrator account’s access control profile must have either w or rw permission to the
authusergrp area. For details, see "Permissions" on page 51.
Syntax
config user kerberos-user
edit "<kdc_name>"
set realm "<realm_str>"
set server "<kdc-server_ip>"
set port <kdc-port_int>
set status <kdc_status>
next
end
Enter the domain of the domain controller (DC) that the Key No
realm "<realm_str>"
Distribution Center (KDC) belongs to. default.
No
port <kdc-port_int> Enter the port the KDC uses to listen for requests.
default.
Related topics
l "waf site-publish-helper rule" on page 475
l "waf site-publish-helper keytab_file" on page 472
user ldap-user
Use this command to configure queries that can be used for remote authentication of either FortiWeb administrators or
end users via an LDAP server.
To apply LDAP queries to end users, select a query in a user group that is then selected within an authentication rule,
which is in turn selected within an authentication policy, which is ultimately selected within an inline protection profile
used for web protection. For details, see "user user-group" on page 329.
To apply LDAP queries to administrators, select a query in an admin group and reference that group in a system
administrator configuration. For details, see "user admin-usergrp" on page 315.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
authusergrp area. For details, see "Permissions" on page 51.
Syntax
config user ldap-user
edit "<ldap-query_name>"
set bind-type {anonymous | simple | regular}
set common-name-id "<cn-attribute_str>"
set distinguished-name "<search-dn_str>"
set filter "<query-filter_str>"
set group_authentication {enable | disable}
set group_dn "<group-dn_str>"
set group-type {edirectory | open-ldap | windows-ad}
set password "<bind-password_str>"
set port <port_int>
"<ldap-query_name>" Enter the name of the LDAP user query. The maximum length No
is 63 characters. default.
common-name-id "<cn- Enter the identifier, often cn, for the common name (CN) No
attribute_str>" attribute whose value is the user name. The maximum length default.
is 63 characters.
filter "<query-filter_ Enter an LDAP query filter string, if any, that will be used to No
str>" filter out results from the query’s results based upon any default.
attribute in the record set. The maximum length is 255
characters.
group_authentication Enable to only include users that are members of an LDAP enable
group_dn "<group-dn_str>" Enter the distinguished name of the LDAP user group, such No
as ou=Groups,dc=example,dc=com. The maximum default.
length is 255 characters.
Enter the port number where the LDAP server listens. The
valid range is 1–65535.
protocol {ldaps | Select whether to secure the LDAP query using LDAPS or ldaps
starttls} STARTTLS. You may need to reconfigure port <port_int> to
correspond to the change in protocol.
server "<ldap_ipv4_
domain>" Type the server IP or domain address of the LDAP server. 0.0.0.0
ssl-connection {enable | Enable to connect to the LDAP servers using an encrypted enable
disable} connection, then select the style of the encryption in protocol
{ldaps | starttls} (page 320).
Example
This example configures an LDAP user query to the server at 192.0.2.100 on port 389. SSL and TLS are disabled.
To bind the query, the FortiWeb appliance will use the bind DN cn=Manager,dc=example,dc=com, whose
password is mySecretPassword. Once connected and bound, the query for search for user objects in
ou=People,dc=example,dc=com, comparing the user name supplied by the HTTP client to the value of each
object’s cn attribute. Group authentication is disabled.
config user ldap-user
edit "ldap-user1"
set server "192.0.2.100"
set ssl-connection disable
set port 389
set common-name-id "cn"
set distinguished-name "ou=People,dc=example,dc=com"
set bind-type regular
set username "cn=Manager,dc=example,dc=com"
set password "mySecretPassword"
set group-authentication disable
next
end
Related topics
l "user user-group" on page 329
l "system admin" on page 201
l "user admin-usergrp" on page 315
user local-user
Local user accounts are used by the HTTP authentication feature to authorize HTTP requests. For details, see the
FortiWeb Administration Guide:
https://docs.fortinet.com/fortiweb/admin-guides
To incorporate local user accounts, add them to a user group that is selected within an authentication rule, which is in
turn selected within an authentication policy. For details, see "user user-group" on page 329.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
authusergrp area. For details, see "Permissions" on page 51.
Syntax
config user local-user
edit "<local-user_name>"
set username "<user_str>"
set password "<password_str>"
next
end
Note: This is not the user name that the person must provide
when logging in to the CLI or web UI.
Enter the user name that the client must provide when logging
in, such as user1 or [email protected]. No
username "<user_str>"
default.
The maximum length is 63 characters.
password "<password_str>" Enter the password for the local user account. The maximum length No
is 63 characters. default.
Example
This example configures a local user account that can be used for HTTP authentication.
config user local-user
edit "local-user1"
set username "user1"
set password "myPassword"
next
end
Related topics
l "user user-group" on page 329
user ntlm-user
Use this command to configure user accounts that will authenticate with the FortiWeb appliance via an NT LAN
Manager (NTLM) server.
NTLM queries can be made to a Microsoft Windows or Active Directory server that has been configured for NTLM
authentication. Both NTLM v1 and NTLM v2 versions of the protocol are supported.
NTLM user queries are used by the HTTP authentication feature to authorize HTTP requests. For details, see the
FortiWeb Administration Guide:
https://docs.fortinet.com/fortiweb/admin-guides
To incorporate NTLM user account queries, add them to a user group that is selected within an authentication rule,
which is in turn selected within an authentication policy. For details, see "user user-group" on page 329.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
authusergrp area. For details, see "Permissions" on page 51.
Syntax
config user ntlm-user
edit "<ntlm-query_name>"
set port <port_int>
set server "<ntlm_ipv4>"
next
end
"<ntlm-query_name>" Enter the name of the NTLM user query. The maximum length No
is 63 characters. default.
Enter the port number where the NTLM server listens. The valid
port <port_int> 445
range is 1–65535.
Example
This example configures an NTLM query connection to a server at 192.0.2.101 on port 445.
config user ntlm-user
edit "ntlm-user1"
set server "192.0.2.101"
set port 445
next
end
Related topics
l "user user-group" on page 329
user pki-user
In FortiWeb's certificate-based Web UI login, a PKI user is the administrator that FortiWeb will authorizes his Web UI
access based on his PKI certificate. With this command, you can create a PKI user for FortiWeb to verify and authorize
the Web UI accesses from the user.
Before creating a PKI user, you must import the CA certificate (through FortiWeb Web UI) associated with the user to
the FortiWeb. For details, see "system admin-certificate ca" on page 206.
After the PKI user is created, include it in an admin group through "user admin-usergrp" on page 315.
For information about certificate-based Web UI login, see the FortiWeb Administration Guide:
https://docs.fortinet.com/fortiweb/admin-guides
To use this command, your administrator account’s access control profile must have either w or rw permission to the
admingrp area. For details, see "Permissions" on page 51.
Syntax
config user pki-user
edit "<pki-user_name>"
set cacert "<cacert_str>"
set subject "<subject_str>"
next
end
cacert "<cacert_str>" Specifies the CA certificate associated with the PKI user's
certificate. It must be one of the CA certificates stored on the No
FortiWeb for administration. For details, see "system admin- default.
certificate ca" on page 206.
subject "<subject_str>" Specifies the subject of the PKI user's certificate, such as C = US, No
ST = Washington, O = yourorganization, CN = default.
yourname.
Example
This example adds a PKI user associated with the CA certificate CA_Cert_1.
config user pki-user
edit "pki_user1"
set cacert "CA_Cert_1"
set subject "C = US, ST = Washington, O = oganization, CN = Bradley Avery"
next
end
user radius-user
Use this command to configure RADIUS queries used to authenticate end-users and/or administrators.
If you use a RADIUS query for administrators, separate it from the queries for regular
users. Do not combine administrator and user queries into a single entry. Failure
to separate queries will allow end-users to have administrative access the FortiWeb web UI
and CLI.
Remote Authentication and Dial-in User Service (RADIUS) servers provide authentication, authorization, and
accounting functions. The FortiWeb authentication feature uses RADIUS user queries to authenticate and authorize
HTTP requests. (The HTTP protocol does not support active logouts, and can only passively log out users when their
connection times out. Therefore FortiWeb does not fully support RADIUS accounting.) RADIUS authentication with
realms (e.g., the person logs in with an account such as [email protected]) are supported.
To authenticate a user, the FortiWeb appliance sends the user’s credentials to RADIUS for authentication. If RADIUS
authentication succeeds, the user is successfully authenticated with the FortiWeb appliance. If RADIUS authentication
fails, the appliance refuses the connection. To override the default authentication scheme, select a specific
authentication protocol or change the default RADIUS port.
To incorporate RADIUS users, they must be in a user group selected within an authentication rule, which is in turn
selected within an authentication policy. For details, see "server-policy custom-application application-policy" on page
110.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
authusergrp area. For details, see "Permissions" on page 51.
Syntax
config user radius-user
edit "<radius-query_name>"
set secret "<password_str>"
set server {radius_ipv4 | radius_ipv6 | domain name}
set server-port <port_int>
set auth-type {default | chap | ms_chap | ms_chap_v2 | pap}
set nas-ip "<nas_ipv4>"
set secondary-secret "<password_str>"
set secondary-server {radius2_ipv4 | domain name}
set secondary-server-port <port_int>
next
end
Enter the RADIUS server secret key for the primary RADIUS
No
secret "<password_str>" server. The primary server secret key should be a maximum of 16
default.
characters in length, but is allowed to be up to 63 characters.
server {radius_ipv4 | Enter the IP address or domain name of the RADIUS server to No
radius_ipv6 | domain query for users. default.
name}
Enter the port number where the RADIUS server listens. The valid
server-port <port_int> 1812
range is 1–65535.
auth-type {default | Enter the authentication method. The default option uses PAP, default
chap | ms_chap | ms_chap_ MS-CHAP-V2, and CHAP, in that order.
v2 | pap}
Enter the NAS IP address and called station ID. For details, see
RFC 2548 (http://www.ietf.org/rfc/rfc2548.txt). If you do not enter
nas-ip "<nas_ipv4>" an IP address, the IP address of the network interface that the 0.0.0.0
FortiWeb appliance uses to communicate with the RADIUS server
is applied.
secondary-secret Enter the RADIUS server secret key for the secondary RADIUS No
"<password_str>" server. The secondary server secret key should be a maximum of default.
16 characters in length, but is allowed to be up to 63 characters.
secondary-server
Enter the IP address or domain name of the secondary RADIUS No
{radius2_ipv4 | domain
name} server. default.
secondary-server-port Enter the port number where the secondary RADIUS server listens. 1812
<port_int> The valid range is 1–65535.
Related topics
l "user admin-usergrp" on page 315
l "user user-group" on page 329
user saml-user
Use this command to configure queries that can be used for remote authentication of either FortiWeb administrators or
end users via a Security Assertion Markup Language (SAML) server.
To use a SAML server for client authentication, select it in a site publish rule. For details, see "waf site-publish-helper
rule" on page 475.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
authusergrp area. For details, see "Permissions" on page 51.
Syntax
config user saml-user
edit "<saml_server_name>"
set entityID "<server_URL>"
set service-path "<server_URL_path>"
set slo-bind {post | redirect}
set slo-path "<slo_URL_path>"
set sso-bind <post>
set sso-path "<sso_URL_path>"
next
end
service-path "<server_ Enter a path for the SAML server at the URL you specified No
URL_path>" in entityID "<server_URL>" (page 327). default.
Select the binding that the server will use when the service
provider initiates a single logout request:
slo-path "<slo_URL_path>" Enter a partial URL that the IDP will use to confirm with the No
service provider that a user has been logged out. default.
Select the binding that the server will use to transport the SAML
sso-bind <post> POST
authentication request to the IDP.
sso-path "<sso_URL_path>" Enter a partial URL that the IDP will use to confirm with the No
service provider that a user has been authenticated. default.
Example
This example configures a SAML server at https://sp.example.com/samlsp. We specify the Service Path,
Assertion Consumer Service (ACS), and Single Logout Service (SLS). We use a POST binding for ACS and a
REDIRECT binding for SLS.
config user saml-user
edit "saml_example"
set entityID "https://sp.example.com/samlsp"
set service-path "/saml.sso"
set slo-bind redirect
set slo-path "/SLO/REDIRECT"
set sso-bind post
set sso-path "/SAML2/POST"
next
end
Related topic
l "waf site-publish-helper rule" on page 475
user user-group
User groups are used by the HTTP authentication feature to authorize HTTP requests. A group can include a mixture of
local user accounts, LDAP, RADIUS, and NTLM user queries.
Before you can configure a user group, you must first configure any local user accounts or user queries that you want to
include. For details, see "user local-user" on page 322, "user ldap-user" on page 318, "server-policy custom-application
application-policy" on page 110, or "user ntlm-user" on page 323.
To apply user groups, select them in within an authentication rule, which is in turn selected within an authentication
policy, which is ultimately selected within an inline protection profile used for web protection. For details, see "waf http-
authen http-authen-rule" on page 406.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
authusergrp area. For details, see "Permissions" on page 51.
Syntax
config user user-group
edit "<user-group_name>"
set auth-type {basic | digest | NTLM}
config members
edit <entry_index>
set type {ldap | local | ntlm | radius}
set ldap-name "<query_name>"
set local-name "<query_name>"
set ntlm-name "<query_name>"
set radius-name "<query_name>"
next
end
next
end
"<user-group_name>" Enter the name of the user group. The maximum length is 63 No
characters. default.
<entry_index> Enter the index number of the individual entry in the table. The valid No
range is 1–9,999,999,999,999,999,999. default.
Select which type of user or user query that you want to add to
the group.
type {ldap | local | Note: You can mix all user types in the group. However, if the
authentication rule’s auth-type {basic | digest | local
ntlm | radius}
NTLM} (page 329) does not support a given user type, all user
accounts of that type will be ignored, effectively disabling
them.
Example
For an example, see "waf http-authen http-authen-policy" on page 403.
Related topics
l "user ldap-user" on page 318
l "user local-user" on page 322
l "user ntlm-user" on page 323
l "waf http-authen http-authen-rule" on page 406
wad file-filter
Use this command to specify the names of directories and files that you want to exclude from anti-defacement
monitoring. Alternatively, you can specify the folders and files you want FortiWeb to monitor and it will exclude any
others.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wadgrp area. For details, see "Permissions" on page 51.
Syntax
config wad file-filter
edit "<wad-file-filter_name>"
set filter-type {black-file-list | white-file-list}
edit <entry_index>
set file-type {directory | regular-file}
set file-name "<file_str>"
next
end
"<wad-file-filter_name>" Enter the name of the file filter you can reference in other parts of No
the configuration. default.
<entry_index> Enter the index number of the individual entry in the table. No
default.
file-type {directory |
regular-file} Specify the type of item to add to the list: No
file-name "<file_str>" Enter the name of the folder or file to add to the list. No
default.
Ensure that the name exactly matches the folder or file that
you want to specify. If file-type {directory |
regular-file} (page 331) is directory, include the /
(forward slash).
Example
This example creates a filter video-folder that excludes the folder /abc from anti-defacement monitoring when it
is applied to an anti-defacement monitoring configuration.
config wad file-filter
edit "video-folder"
set filter-type black-file-list
edit 1
set file-type directory
set file-name "/abc"
next
end
Related topics
l "wad website" on page 332
wad website
Use this command to enable and configure website defacement attack detection and automatic repair.
The FortiWeb appliance monitors the website’s files for any changes and folder modifications at specified time
intervals. If it detects a change that could indicate a defacement attack, the FortiWeb appliance notifies you, and can
quickly react by automatically restoring the website contents to the previous backup revision.
Optionally, you can specify a filter that either defines which files and folders FortiWeb does not scan when it looks for
changes (blacklist) or the specific files and folders you want it to monitor (whitelist). For details, see "wad file-filter" on
page 331.
FortiWeb automatically backs up website files and creates a revision in the following cases:
l When the FortiWeb appliance initiates monitoring for the first time, the FortiWeb appliance downloads a backup copy of
the website’s files and stores it as the first revision.
l If the FortiWeb appliance could not successfully connect during a monitor interval, it creates a new revision the next time it
re-establishes the connection.
When you intentionally modify the website, you must disable the monitor option;
otherwise, the FortiWeb appliance sees your changes as a defacement attempt and
undoes them.
Backup copies omit files exceeding the file size limit and/or matching the file extensions that you have configured the
FortiWeb appliance to omit. For details, see backup-max-fsize <limit_int> (page 334) and backup-skip-
ftype "<extensions_str>" (page 334).
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wadgrp area. For details, see "Permissions" on page 51.
Syntax
config wad website
edit <entry_index>
set alert-email "<email-policy_name>"
set auto {disable | restore | acknowledge}
set backup-max-fsize <limit_int>
set backup-skip-ftype "<extensions_str>"
set connect-type {ftp | smb | ssh}
set description "<comment_str>"
set hostname-ip {"<host_ipv4>" | "<host_fqdn>"}
set interval-other <seconds_int>
set interval-root <seconds_int>
set monitor {enable | disable}
set monitor-depth <folders_int>
set name "<name_str>"
set password "<password_str>"
set port <port_int>
set share-name "<share_str>"
set user "<user_str>"
set web-folder "<path_str>"
set file-filter "wad-file-filter_name>"
next
end
<entry_index> Enter the index number of the individual entry in the table. The No
valid range is 1–16. default.
Enter the name of the email policy that specifies the email address
alert-email "<email- that FortiWeb sends an email to when it detects that the website No
policy_name>" changed. (See config log email-policy (page 75).)The default.
maximum length is 63 characters.
auto {disable | restore | Enter the action that FortiWeb takes when it detects that the disable
acknowledge} website has changed.
description "<comment_ Enter a description or other comment. If the comment is more than No
str>" one word or contains special characters, surround the comment default.
with double quotes ( " ). The maximum length is 255 characters.
hostname-ip {"<host_ This will be used when connecting by SSH or FTP to the No
ipv4>" | "<host_fqdn>"} website to monitor its contents and download backup default.
revisions, and therefore could be different from the real or
virtual web host name that may appear in the Host: field of
HTTP headers.
interval-other <seconds_ Enter the amount of time (in seconds) between each 600
int> monitoring connection from the FortiWeb appliance to the
web server. During this connection, the FortiWeb appliance
examines the website’s subfolders to see if any files have
been changed by comparing the files with the latest backup.
The valid range is 1–86,400.
monitor {enable | Enable to monitor the website’s files for changes, and to download enable
disable} backup revisions that can be used to revert the website to its
previous revision if the FortiWeb appliance detects a change
attempt.
Enter how many folder levels deep to monitor for changes to the
monitor-depth <folders_
int> website’s files. Files in subfolders deeper than this level will not be 5
backed up. The valid range is 1–10.
name "<name_str>" Enter a name for the website. The maximum length is 63 No
characters. default.
This name will not be used when monitoring the website, nor
will it be referenced in any other part of the configuration, and
therefore can be any identifier that is useful to you. It does not
need to be the website’s FQDN or virtual host name.
Enter the password for the user name you entered in user
No
password "<password_str>" "<user_str>" (page 336). The maximum length is 63
default.
characters.
port <port_int> Enter the port number on which the website’s physical server 21
listens. The standard port number for FTP is 21; the standard
port number for SSH is 22.
Enter the name of the shared folder on the web server. The
maximum length is 63 characters. No
share-name "<share_str>"
This variable appears only if connect-type {ftp | default.
smb | ssh} (page 334) is smb.
user "<user_str>" Enter the user name that the FortiWeb appliance will use to log in No
to the website’s physical server. The maximum length is 63 default.
characters.
file-filter "wad-file- Enter the filter that specifies either the files and folders that No
filter_name>" FortiWeb excludes from anti-defacement monitoring or the specific default.
files and folders to monitor.
Example
config wad website
edit 1
set alert-email "email_policy_1"
set connect-type ssh
set hostname-ip "192.0.2.10"
set monitor enable
set name "www.example.com"
set password "P@ssword1"
set port 22
set user "fortiweb"
set web-folder "public_html"
set file-filter "video-folder"
next
end
Related topics
l "wad file-filter" on page 331
l "system interface" on page 280
waf allow-method-exceptions
Use this command to configure the FortiWeb appliance with combinations of URLs and host names, which are
exceptions to HTTP request methods that are generally allowed or denied according to the inline or Offline Protection
profile.
While most URL and host name combinations controlled by a profile may require similar HTTP request methods, you
may have some that require different methods. Instead of forming separate policies and profiles for those requests, you
can configure allowed method exceptions. The exceptions define specific HTTP request methods that are allowed by
specific URLs and hosts.
To apply allowed method exceptions, select them within an inline or Offline Protection profile. For details, see "waf web-
protection-profile inline-protection" on page 518 or "waf web-protection-profile offline-protection" on page 531.
Before you configure an allowed method exception, if you want to apply it only to HTTP requests for a specific real or
virtual host, you must first define the web host in a protected hosts group. For details, see "server-policy allow-hosts" on
page 108.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf allow-method-exceptions
edit "<method-exception_name>"
config allow-method-exception-list
edit <entry_index>
set allow-request {get post head options trace connect delete put patch
webdav rpc others}
set host "<protected-hosts_name>"
set host-status {enable | disable}
set request-file "<url_str>"
set request-type {plain | regular}
next
end
next
end
Enter the index number of the individual entry in the table. The No
<entry_index>
valid range is 1–9,999,999,999,999,999,999. default.
allow-request {get post Select one or more of the allowed HTTP request methods No
head options trace that are an exception for that combination of URL and host. default.
connect delete put patch
webdav rpc others} Methods that you do not select will be denied.
host-status {enable | Enable to require that the Host: field of the HTTP request match disable
disable} a protected hosts entry in order to match the allowed method
exception. Also configure host "<protected-hosts_
name>" (page 338).
Example
This example adds an exception to the list of allowed methods (post) that can be used in HTTP requests. In addition to
the allowed methods already specified in protection profiles that use this exception, web hosts included in the protected
hosts group named example_com_hosts (such as example.com, www.example.com, and 192.0.2.10) are
allowed to receive POST requests to the Perl file that handles the guestbook.
config waf allow-method-exceptions
edit "auto-learn-profile2"
config allow-method-exception-list
edit 1
set allow-request post
set host "example_com_hosts"
set host-status enable
set request-file "/perl/guesbook.pl"
set request-type plain
next
end
next
end
Related topics
l "server-policy allow-hosts" on page 108
l "waf web-protection-profile inline-protection" on page 518
l "waf web-protection-profile offline-protection" on page 531
waf allow-method-policy
To define specific exceptions to this policy, use config waf allow-method-exceptions (page 337).
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf allow-method-policy
edit "<allowed-methods_name>"
set allow-method {get post head options trace connect delete put patch webdav
rpc}
set severity {High | Medium | Low | Info}
set triggered-action "<trigger-policy_name>"
set allow-method-exception "<method-exception_name>"
next
end
severity {High | Medium | Select the severity level to use in logs and reports generated when High
Low | Info} a violation of the policy occurs.
triggered-action Enter the name of the trigger policy you want FortiWeb to No
"<trigger-policy_name>" apply when a violation of the HTTP request method policy default.
Example
This example allows the HTTP GET and POST methods and rejects others, except according to the exceptions defined
in MethodExceptions1.
config waf allow-method-policy
edit "allowpolicy1"
set allow-method get post
set triggered-action "TriggerActionPolicy1"
set allow-method-exception "MethodExceptions1"
next
end
Related topics
l "waf allow-method-exceptions" on page 337
waf application-layer-dos-prevention
Use this command to create an HTTP-layer DoS protection policy. Once you create the policy, reference it in an inline
protection profile that is used by a server policy.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf application-layer-dos-prevention
edit "<app-dos-policy_name>"
set enable-http-session-based-prevention {enable | disable}
set http-connection-flood-check-rule "<rule_name>"
set http-request-flood-prevention-rule "<rule_name>"
set enable-layer4-dos-prevention {enable | disable}
http-connection-flood- Enter the name of an existing rule that sets the maximum No
check-rule "<rule_name>" number of HTTP requests per second to a specific URL. The default.
maximum length is 63 characters.
http-request-flood-
To display a list of the existing rules, enter:
No
prevention-rule "<rule_ set http-request-flood-prevention-rule ?
name>" default.
This setting applies only if enable-http-session-
based-prevention {enable | disable} (page 342)
is enabled.
enable-layer4-dos- Enable to use DoS protection that is not based on session cookies. disable
prevention {enable | Also configure layer4-access-limit-rule "<rule_
disable}
name>" (page 342) and layer4-connection-flood-
check-rule "<rule_name>" (page 343).
layer4-connection-flood- Enter the name of an existing rule that limits the number of No
check-rule "<rule_name>" TCP connections from the same source IP address. The default.
maximum length is 63 characters.
Example
This example shows the settings for a DoS protection policy that protects a web portal using existing DoS prevention
rules.
config waf application-layer-dos-prevention
edit "Web Portal DoS Policy"
set enable-http-session-based-prevention enable
set http-connection-flood-check-rule "Web Portal TCP Connect Limit"
set http-request-flood-prevention-rule "Web Portal HTTP Request Limit"
set enable-layer4-dos-prevention enable
set layer4-access-limit-rule "Web Portal HTTP Request Limit"
set layer4-connection-flood-check-rule "Web Portal Network Connect Limit"
next
end
Related topics
l "waf http-connection-flood-check-rule" on page 408
l "waf http-request-flood-prevention-rule" on page 421
l "waf layer4-access-limit-rule" on page 436
l "waf layer4-connection-flood-check-rule" on page 439
l "system advanced" on page 208
waf base-signature-disable
Use this command to disable individual or whole categories of data leak and attack signatures in every signature group
that currently exists.
For example, if you disable a certain signature ID with this command, the signature ID in every signature group you
have defined will be disabled.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf base-signature-disable
edit "<signature-ID_name>"
next
end
Example
This example globally disables the XSS signature whose ID is 010000001.
config waf base-signature-disable
edit "010000001"
next
end
Related topics
l "waf signature" on page 462
waf brute-force-login
Brute force attacks attempt to penetrate systems by the sheer number of clients, attempts, or computational power,
rather than by intelligent insight. For example, in brute force attacks on authentication, multiple web clients may rapidly
try one user name and password combination after another in an attempt to eventually guess a correct login and gain
access to the system. In this way, behavior differs from web crawlers, which typically do not focus on a single URL.
Brute force login attack sensors track the rate at which each source IP address makes requests for specific URLs. If the
source IP address exceeds the threshold, the FortiWeb appliance penalizes the source IP address by blocking additional
requests for the time period that you indicate in the sensor.
To apply a brute force login attack sensor, select it within an inline protection profile. For details, see "waf web-
protection-profile inline-protection" on page 518.
You can use SNMP traps to notify you when a brute force login attack is detected. For details, see "system snmp
community" on page 299.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf brute-force-login
edit "<brute-force-login_name>"
config login-page-list
edit <entry_index>
set severity {High | Medium | Low | Info}
set trigger "<trigger-policy_name>"
set access-limit-standalone-ip "<rate_int>"
set access-limit-share-ip "<rate_int>"
set block-period "<seconds_int>"
set host "<allowed-hosts_name>"
set host-status {enable | disable}
set request-file "<url_str>"
set ip-port-enable {enable | disable}
next
end
next
end
"<brute-force-login_ Enter the name of a new or existing brute force login attack No
name>" sensor. The maximum length is 63 characters. default.
severity {High | Medium | Select the severity level to use in logs and reports generated when
High
Low | Info} a violation of the rule occurs.
trigger "<trigger-policy_ Enter the name of the trigger to apply when this policy is No
name>" violated. For details, see "log trigger-policy" on page 101. The default.
maximum length is 63 characters.
access-limit-share-ip Enter the rate threshold for source IP addresses that are 1
"<rate_int>" shared by multiple clients behind a network address
Enter the length of time for which the FortiWeb appliance will
block additional requests after a source IP address exceeds a
block-period "<seconds_ rate threshold.
60
int>"
The block period is shared by all clients whose traffic
originates from the source IP address. The valid range is from
1 to 10,000 seconds.
<entry_index> Enter the index number of the individual entry in the table. The No
valid range is 1–9,999,999,999,999,999,999. default.
host-status {enable | Enable to require that the Host: field of the HTTP request match disable
disable} a protected hosts entry in order to be included in the brute force
login attack sensor’s rate calculations. Also configure host
"<allowed-hosts_name>" (page 346).
request-file "<url_str>" Enter the literal URL, such as /login.php, that the HTTP No
request must match to be included in the brute force login default.
attack sensor’s rate calculations.
The URL must begin with a slash ( / ). Do not include the
name of the web host, such as www.example.com, which is
configured separately in host "<allowed-hosts_
name>" (page 346). The maximum length is 255 characters.
ip-port-enable {enable |
disable}
Example
This example limits IP addresses of individual HTTP clients to 3 requests per second, and NAT IP addresses to 20
requests per second, when they request the file login.php on the host www.example.com on TCP port 8080.
config waf brute-force-login
edit "brute_force_attack_sensor"
config login-page-list
edit 1
set host "www.example.com:8080"
set host-status enable
set request-file "/login.php"
set access-limit-share-ip 20
set access-limit-standalone-ip 3
set block-period 120
next
end
next
end
Related topics
l "waf web-protection-profile inline-protection" on page 518
l "system snmp community" on page 299
l "waf application-layer-dos-prevention" on page 341
l "log trigger-policy" on page 101
waf cookie-security
Use this command to configure FortiWeb features that prevent cookie-based attacks.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config waf cookie-security
edit "<cookie-security_name>"
set security-mode {no |encrypted | signed}
set action {alert |alert_deny | block-period | remove_cookie | deny_no_log}
set block-period <block-period_int>
set severity {High |Medium | Low | Info}
set trigger "trigger-policy_name>"
set cookie-replay-protection-type {no | IP}
set max-age <max-age_int>
set secure-cookie {enable | disable}
set http-only {enable | disable}
set allow-suspicious-cookies{Never |Always | Custom}
set allow-time "<time_str>"
config cookie-security-exception-list
edit <entry_index>
set cookie-name "<cookie-name_str>"
set cookie-domain "<cookie-domain_str>"
set cookie-path "<cookie-path_str>"
end
next
end
"<cookie-security_name>" Enter the cookie security policy name. The maximum length is 63 No
characters. default.
security-mode {no Enter the security mode for the cookie security policy
|encrypted | signed}
l no—FortiWeb does not apply cookie tampering protection or
encrypt cookie values.
349).
action {alert |alert_deny Select one of the following actions that the FortiWeb
| block-period | remove_ appliance will perform when it detects cookie poisoning:
cookie | deny_no_log}
l alert—Accept the request and generate an alert email
and/or log message.
You can customize the web page that FortiWeb returns to the
client with the HTTP status code. For details, see "system
replacemsg" on page 294.
block-period <block- Enter the number of seconds to block a connection when action
period_int> {alert |alert_deny | block-period | remove_
60
cookie | deny_no_log} (page 349) is set to block-
period. The valid range is from 1 to 3,600 seconds.
severity {High |Medium | Select the severity level to use in logs and reports generated when
Low | Info} High
cookie poisoning is detected.
trigger "trigger-policy_ Enter the name of the trigger to apply when cookie poisoning
name>" is detected. For details, see "log trigger-policy" on page 101.
The maximum length is 63 characters. To display the list of No
existing trigger policies, type: default.
set trigger ?
max-age <max-age_int> Set the cookie security attributes. Enter the maximum age, in
minutes, permitted for cookies that do not have an “Expires”
0
or “Max-Age” attribute. To configure no expiry age for cookies,
enter 0.
secure-cookie {enable | Set the cookie security attributes. Enable to add the secure
disable} flag to cookies, which forces browsers to return the cookie disable
only when the request is for an HTTPS page.
http-only {enable | Set the cookie security attributes. Enable to add the HttpOnly flag
disable} to cookies, which prevents client-side scripts from accessing the enable
cookie.
cookies.
allow-time "<time_str>" Set the date on which FortiWeb starts to take the specified action
No
against suspicious cookies if allow-suspicious-cookies
default.
{Never |Always | Custom} (page 350) is Custom.
<entry_index> Enter the index number of a new or existing entry in the exception No
list of the cookie security policy. default.
cookie-name "<cookie- No
name_str>" Set the exception cookie entry name.
default.
Related topics
l "waf web-protection-profile inline-protection" on page 518
waf csrf-protection
Use this command to protect against cross-site request forgery (CSRF). CSRF is an attack that exploits the trust that a
site has in a user's browser to transmit unauthorized commands.
The CRSF protection feature is not supported when the operation mode is Offline Protection or Transparent Inspection.
To protect back-end servers from CSRF attacks, you create two lists of items: a list of web pages to protect against
CSRF attacks, and a corresponding list of the URLs found in the requests that the pages generate. For more
information on configuring CSRF protection, including troubleshooting and adding parameter filters, see the FortiWeb
Administration Guide:
https://docs.fortinet.com/fortiweb/admin-guides
To apply a CSRF protection rule, you select it in an inline protection profile. For details, see "waf web-protection-profile
inline-protection" on page 518.
Before you configure a CSRF protection rule, if you want to apply it only to HTTP requests for a specific real or virtual
host, you must first define the web host in a protected hosts group. For details, see "server-policy allow-hosts" on page
108.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf csrf-protection
edit "<csrf-rule_name>"
set action {alert | alert_deny | block-period | deny_no_log}
set block-period <seconds_int>
set severity {High | Medium | Low | Info}
set trigger <trigger-policy_name>
config csrf-page-list
edit <entry_index>
set host <host_name>
set request-url <url_str>
set host-status {enable | disable}
set request-type {plain | regular}
set parameter-filter {enable | disable}
set parameter-name <parameter-name_str>
set parameter-value-type {plain | regular}
set parameter-value <parameter-value_str>
next
end
config csrf-url-list
edit <entry_index>
set host <host_name>
set request-url <url_str>
set host-status {enable | disable}
set request-type {plain | regular}
set parameter-filter {enable | disable}
set parameter-name <parameter-name_str>
set parameter-value-type {plain | regular}
set parameter-value <parameter-value_str>
next
end
next
end
You can customize the web page that FortiWeb returns to the
client with the HTTP status code. For details, see "system
replacemsg" on page 294.
l block-period—Block subsequent requests from the client for
a number of seconds. Also configure block-period
<seconds_int> (page 353).
l deny_no_log—Deny a request. Do not generate a log
message.
block-period <seconds_ Enter the number of seconds that you want to block 60
int> subsequent requests from the client after the FortiWeb
appliance detects a CSRF attack.
severity {High | Medium | Select the severity level to use in any logs and reports that
Low
Low | Info} FortiWeb generates when a violation of this rule occurs.
trigger <trigger-policy_ Enter the name of the trigger to apply when this rule is No
name> violated. For details, see "log trigger-policy" on page 101. The default.
maximum length is 63 characters.
No
<entry_index> Enter the index number of the individual entry in the table.
default.
host <host_name> Enter a protected host name (either a web host name or IP No
address) that the Host: field of the HTTP request matches. default.
request-url <url_str> Enter either a literal URL or regular expression, depending on the No
host-status {enable | Enter enableto apply this rule only to HTTP requests for disable
disable} specific web hosts. Also configure host.
parameter-filter {enable Enter enable to specify a parameter name and value to match. disable
| disable}
The parameter can be located in either the URL or the HTTP body
of a request.
parameter-name No
<parameter-name_str> Enter the name of the parameter name to match.
default.
Example
The web page csrf_login.html contains the following HTML form:
<form name="do_some_action" id="form1" action="csrf_test2.php" method="GET">
<input type="text" name="username" value=""/>
<Input type="text" name="password" value=""/>
<input type="submit" value="do Action"/>
</form>
This form generates the following request when the page is added to the list of pages protected by a CSRF protection
policy:
http://target-site.com/csrf_
test2.php?username=test&password=123&tknfv=3DF5BDCCIG3DCXNTE3RUNCTKRS3E36AD
The CSRF protection feature adds the parameter tknfv with a value that matches the session ID.
To create this example, you add csrf_login.html to the list of pages and /csrf_check2.php to the list of
URLs.
Use this command to configure custom access policies. Custom access policies group custom access rules.
To apply a custom access policy, select it within an inline protection profile or Offline Protection profile. For details, see
"waf web-protection-profile inline-protection" on page 518 or "waf web-protection-profile offline-protection" on page 531.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf custom-access policy
edit "<custom-policy_name>"
config rule
edit <entry_index>
set rule-name "<custom-rule_name>"
next
end
next
end
Enter the index number of the individual entry in the table. The valid No
<entry_index>
range is 1–9,223,372,036,854,775,807. default.
rule-name "<custom-rule_ Enter the name of the existing custom access rule to add to the No
name>" policy. The maximum length is 63 characters. default.
Example
For an example, see "waf custom-access rule" on page 356.
Related topics
l "waf web-protection-profile inline-protection" on page 518
l "waf web-protection-profile offline-protection" on page 531
l "waf custom-access rule" on page 356
What if you want to allow a web crawler, but only if it is not too demanding, and comes from a source IP that is known to
be legitimate for that crawler? What if you want to allow only a client that is a senior manager’s IP, and only if it hasn’t
been infected by malware whose access rate is contributing to a DoS?
Advanced access control rules provide a degree of flexibility for these types of complex conditions. You can combine any
or all of these criteria:
l Source IP
l User
l Http Session
l Rate limit (including rate limiting for specific types of content)
l HTTP header or response code
l URL
l Predefined or custom attack or data leak signature violation
l Transaction or packet interval timeout
l Real browser enforcement
l CAPTCHA enforcement
In the rule, add all criteria that you require allowed traffic to match.
Before you can apply a custom access rule, you must first group it with any others that you want to apply in a custom
access policy. For details, see "waf custom-access policy" on page 355.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf custom-access rule
edit "<custom-access_name>"
config packet-interval
edit <entry_index>
set packet-interval-timeout <timeout_int>
end
config signature-class
edit {010000000 | 020000000 | 030000000 | 040000000 | 050000000 |
060000000 | 090000000| 100000000 | 110000000 | 120000000}
set status {enable | disable}
end
config custom-signature
edit <entry_index>
set custom-signature-enable {enable | disable}
set {custom-signature-group | custom-signature}
set "<custom-signature-name_str>"
end
config ftp-security
edit <entry_index>
set custom-signature-enable {enable | disable}
set {custom-signature-group | custom-signature}
set "<custom-signature-name_str>"
end
config occurrence
edit <entry_index>
set occurrence-num "<occurrence_int>"
set within "<within_int>"
set percentage-flag {enable | disable}
set percentage "<percentage_int>"
set traced-by {Source-IP | User | Http-Session}
end
next
end
l block-period—Block subsequent
requests from the client for a number of
seconds. Also configure block-
period <seconds_int> (page
359).
l deny_no_log—Deny a request. Do
not generate a log message.
severity {High | Medium | Low Select the severity level to use in logs and
| Info} reports generated when a violation of the rule High
occurs.
policies, enter:
set trigger ?
predefined-header {host | Select the name (key) of the HTTP header host
connection | authorization | such as Accept: that must be present in
http-method-value-type
Select a plain string or regular string. No default.
{plain | regular}
For example:
l 1.2.3.4
l 2001::1
l 1.2.3.4-1.2.3.40 No default.
l 2001::1-2001::100
Depending on your configuration of how
FortiWeb will derive the client’s IP (see
"waf x-forwarded-for" on page 542), this
may be the IP address that is indicated in
an HTTP header rather than the IP
header.
If percentage-flag {enable |
disable} (page 367) is enabled and the
number of matches exceeds this
threshold, the associated HTTP source
client IP address or client matches this
condition.
Example
This example allows access to URLs beginning with “/admin”, but only if they originate from 192.0.2.5, and only if
the client does not exceed 5 requests per second.
Clients that violate this rule will be blocked for 60 seconds (the default duration). The violation will be logged in the
attack log using severity_level=High, and all servers configured in notification-servers1 will be used to
notify the network administrator.
config waf custom-access rule
edit "combo-IP-rate-URL-rule1"
set action block-period
set severity High
set trigger "notification-servers1"
config access-limit-filter
edit 1
set access-rate-limit 5
next
end
config source-ip-filter
edit 1
set source-ip "192.0.2.5"
next
end
config url-filter
edit 1
set request-file "/admin*"
next
end
next
end
config waf custom-access policy
edit "combo-IP-rate-URL-policy1"
config rule
edit 1
set rule-name "combo-access-rate-rule1"
next
end
next
end
Related topics
l "waf custom-access policy" on page 355
l "log trigger-policy" on page 101
l "waf signature" on page 462
waf custom-protection-group
Use this command to configure custom protection groups, creating sets of custom protection rules that can be used with
attack signatures (“server protection rule”).
Before you can configure this command, you must first define your custom data leak and attack signatures. For details,
see "waf custom-protection-rule" on page 370.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf custom-protection-group
edit "<custom-protection group_name>"
config type-list
edit <entry_index>
set custom-protection-rule "<rule_name>"
next
end
next
end
Enter the index number of the individual entry in the table. The valid No
<entry_index>
range is 1–9,999,999,999,999,999,999. default.
custom-protection-rule Enter the name of the custom protection rule to associate with No
"<rule_name>" the custom protection group. The maximum length is 63 default.
characters.
Example
This example groups custom protection rule 1 and custom protection rule 3 together within
Custom Protection group 1.
config waf custom-protection-group
edit "Custom Protection group 1"
config type-list
edit 1
set custom-protection-rule "custom protection rule 3"
next
edit 3
set custom-protection-rule "custom protection rule 1"
next
end
next
end
Related topics
l "waf signature" on page 462
l "waf custom-protection-rule" on page 370
waf custom-protection-rule
Use this command to configure custom data leak and attack signatures.
Before you enter custom signatures via the CLI, first enable .
To use your custom signatures, you must first group them so that they can be included in a rule. For details, see "waf
custom-protection-group" on page 368.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf custom-protection-rule
edit "<custom-protection rule_name>"
set type {request | response}
set action {alert | alert_deny | alert_erase | redirect | block-period | send_
http_response | only_erase | deny_no_log}
set block-period <seconds_int>
set severity {High | Medium | Low | Info}
set trigger "<trigger-policy_"name>
config meet-condition
edit <entry_index>
set operator {RE | GT | LT | NE | EQ}
set request-target {REQUEST_FILENAME REQUEST_URI REQUEST_HEADERS_NAMES
REQUEST_HEADERS REQUEST_COOKIES_NAMES REQUEST_COOKIES ARGS_NAMES ARGS_
VALUE REQUEST_RAW_URI REQUEST_BODY CONTENT_LENGTH HEADER_LENGTH BODY_
LENGTH COOKIE_NUMBER ARGS_NUMBER HTTP_METHOD}
set response-target {RESPONSE_BODY RESPONSE_HEADER CONTENT_LENGTH HEADER_
LENGTH BODY_LENGTH RESPONSE_CODE}
set threshold <threshold_int>
set case-sensitive {enable | disable}
set expression <regex_pattern>
next
end
next
end
"<custom-protection rule_ Enter the name of the new or existing custom signature. The No
name>"
action {alert | alert_ Select the specific action to be taken when the request alert
deny | alert_erase | matches the this signature.
redirect | block-period |
send_http_response | l alert—Accept the request and generate an alert email
only_erase | deny_no_log}
and/or log message.
Note: Logging and/or alert email will occur only if enabled and
configured. For details, see "log disk" on page 73 and "log
alertMail" on page 67.
https://docs.fortinet.com/fortiweb/admin-guides
The valid range is 1–3,600.
severity {High | Medium | When rule violations are recorded in the attack log, each log
Low | Info} message contains a Severity Level (severity_level) field.
Medium
Select which severity level the FortiWeb appliance will use when it
logs a violation of the rule.
trigger "<trigger-policy_ Select which trigger policy, if any, that the FortiWeb appliance No
"name> will use when it logs and/or sends an alert email about a default.
violation of the rule. For details, see log trigger-
policy (page 101).
<entry_index> Enter the index number of the individual entry in the table. No
The valid range is from 1–9,999,999,999,999,999,999. default.
operator {RE | GT | LT | l RE—The signature matches when the value of a selected target RE
NE | EQ} in the request or response matches the value of expression.
l GT—The signature matches when specified target has a value
greater than the value of threshold.
l LT—The signature matches when specified target has a value
less than the value of threshold.
l NE— The signature matches when specified target has a
different value than threshold.
l EQ— The signature matches when specified target has the same
value as threshold.
request-target {REQUEST_
FILENAME REQUEST_URI Enter the name of one or more locations in the HTTP request
REQUEST_HEADERS_NAMES to scan for a signature match.
REQUEST_HEADERS REQUEST_ No
COOKIES_NAMES REQUEST_ For example, ARGS_NAMES for the names of parameters or default.
COOKIES ARGS_NAMES ARGS_ REQUEST_COOKIES for strings in the HTTP Cookie:
VALUE REQUEST_RAW_URI
header.
REQUEST_BODY CONTENT_
LENGTH HEADER_LENGTH
BODY_LENGTH COOKIE_NUMBER
ARGS_NUMBER HTTP_METHOD}
response-target Enter the name of one or more locations in the HTTP response to No
{RESPONSE_BODY RESPONSE_ scan for a signature match. default.
HEADER CONTENT_LENGTH
HEADER_LENGTH BODY_LENGTH
RESPONSE_CODE}
threshold <threshold_int> Enter the value that FortiWeb compares to the target value to No
determine if a request or response matches. default.
case-sensitive {enable | Enable to differentiate upper case and lower case letters disable
disable} when evaluating the web server’s response for data leaks
according to expression <regex_pattern> (page
374).
Example
This example configures a signature to detect and block an LFI attack that uses directory traversal through an
unsanitized controller parameter in older versions of Joomla. Each time it detects an attack, the trigger policy
named notification-servers1 sends an alert email and attack log messages whose severity level is High.
config waf custom-protection-rule
edit "Joomla_controller_LFI"
set type request
set action alert_deny
set severity High
set trigger "notification-servers1"
config meet-condition
edit 1
set request-target REQUEST_RAW_URI
set expression "^/index\.php\?option=com_ckforms\&controller=(\.\.\/)+?"
next
end
next
end
Related topics
l "waf custom-protection-group" on page 368
l "log trigger-policy" on page 101
waf device-reputation
When Device Tracking is enabled and a device reputation security policy is selected, FortiWeb evaluates the reputation
of client devices that trigger security violations. If a device triggers a security violation in a device reputation security
policy, it will acquire a lower device reputation. Access to networks and servers can be managed according to a device's
reputation.
For information on device reputation security policies, see the FortiWeb Administration Guide:
https://docs.fortinet.com/fortiweb/admin-guides
To use this command, your administrator account’s access control profile must have either w or rw permission to the
admingrp area. For details, see "Permissions" on page 51.
Syntax
config waf device-reputation reputation-security-policy
edit "<policy_name>"
set action-for-high-level {alert | alert_deny | block-period | deny_no_log}
set action-for-low-level {alert | alert_deny | block-period | deny_no_log}
set action-for-medium-level {alert | alert_deny | block-period | deny_no_log}
set action-for-unindentified {alert | alert_deny | block-period | using_local_
action | deny_no_log}
set high-level-score-begin <weight_int>
set low-level-score-end <weight_int>
Set the action for a device based on its risk level. The options
action-for-high-level are:
{alert | alert_deny alert_
| block-period | deny_no_ l alert—Accept the request and generate an alert email and/or deny
log}
log message.
l alert_deny—Block the request (or reset the connection) and
generate an alert email and/or log message.
action-for-low-level
You can customize the web page that returns to the
{alert | alert_deny
client with the HTTP status code. For details, see the alert
| block-period | deny_no_
log} FortiWeb Administration Guide:
https://docs.fortinet.com/fortiweb/admin-guides
l block-period—Block subsequent requests from the client for
action-for-medium-level
{alert | alert_deny a number of seconds. Also configure Block Period. alert_
| block-period | deny_no_ You can customize the web page that returns to the deny
log}
client with the HTTP status code. For details, see the
FortiWeb Administration Guide:
https://docs.fortinet.com/fortiweb/admin-guides
action-for-unindentified
{alert | alert_deny l using_local_action—Takes the local action specified in a using_
| block-period | using_ protection profile. local_
local_action | deny_no_ action
log} l deny_no_log—Deny a request. Do not generate a log
message.
high-level-score-begin Sets the weight range for a high risk level. The acceptable 200
<weight_int> range is 3–1000.
low-level-score-end Sets the weight range for a low risk level. The acceptable
<weight_int> 50
range is 2–1000.
"<rule_name>" default.
delete <ID_int> Deletes a security feature from the list of device reputation No
exceptions according to its ID. default.
No
purge <y/n> Deletes all security feature exceptions.
default.
Example
This example creates a device reputation security policy and defines a device reputation exception.
config waf device-reputation reputation-security-policy
edit "<policy1>"
set action-for-high-level alert_deny
set action-for-low-level alert
set action-for-medium-level alert
set action-for-unindentified block-period
set block-period-unindentified-level 60
set high-level-score-begin 300
set low-level-score-end 100
set reputation-exception-rule "<exception_rule1>"
next
end
config waf device-reputation reputation-exceptions
edit "<exception1>"
config reputation-exceptions-list
edit 1
set feature-name trojans
next
end
end
Related Topics
waf exclude-url
Use this command to configure URLs that are exempt from a file compression or file decompression rule.
To apply an exclusion, include it in a compression or decompression rule. For details, see "waf file-compress-rule" on
page 380 or "waf file-uncompress-rule" on page 382.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf exclude-url
edit "<rule_name>"
config exclude-rules
edit <entry_index>
set host "<protected-host_name>"
set host-status {enable | disable}
set request-file "<url_str>"
next
end
next
end
Enter the index number of the individual entry in the table. The No
<entry_index>
valid range is 1–9,999,999,999,999,999,999. default.
host "<protected-host_ Enter the name of a protected host that the Host: field of an No
name>" HTTP request must be in order to match the exception. The default.
maximum length is 255 characters.
request-file "<url_str>" Enter the literal URL, such as /archives, to which the exception No
applies. The URL must begin with a slash ( / ). Do not include the default.
name of the host, such as www.example.com, which is
configured separately using host. The maximum length is 255
characters.
Example
This example configures two exclusion rules, one for compression and the other for decompression. Either rule can be
referenced by name in a file compression or file decompression rule.
config waf exclude-url
edit "Compression Exclusion"
config exclude-rules
edit 1
set host "192.0.2.2"
set host-status enable
set request-file "/archives"
next
end
next
edit "Decompression Exclusion"
config exclude-rules
edit 1
Related topics
l "waf file-compress-rule" on page 380
l "waf file-uncompress-rule" on page 382
waf file-compress-rule
Compression can reduce bandwidth, which can reduce delivery time to end users. Modern browsers automatically
decompress files before they display web pages.
You can configure most web servers to compress files when they respond to a request. However, if you do not want to
configure each of your web servers separately, or if you want to offload compression for performance reasons, you can
configure FortiWeb to do the compression.
By default, the maximum pre-compressed file size is 64 KB. FortiWeb transmits files larger than the maximum without
compression. You can use the config system advanced command’s max-cache-size setting to adjust the
maximum files size. For details, see "system advanced" on page 208.
To apply a compression rule, select it in an inline protection profile. For details, see "waf web-protection-profile inline-
protection" on page 518.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf file-compress-rule
edit "<rule_name>"
set compression-type {gzip | brotli}
set compression-level {level1 | level2 | level3 | level4 | level5 | level6 |
level7 | level8 | level9 | level10 | level11}
set exclude-url "<exclusion-rule_name>"
next
end
config content-types
edit "<content-types_id>"
set content-type "<content-type_name>"
end
"<rule_name>" Enter the name of a new or existing rule. The maximum length No
is 63 characters. default.
Enter the index number of the individual entry in the table. The valid No
<entry_index>
range is 1–9,999,999,999,999,999,999. default.
compression-level {level1
| level2 | level3 |
level4 | level5 | level6 No
| level7 | level8 | Set the compression level for the file to be compressed.
default.
level9 | level10 |
level11}
content-type "<content- Enter one of the following content types to compress it: No
type_name>" default.
l text/plain
l text/html
l application/xml(or)text/xml
l application/soap+xml
l application/x-javascript
l text/css
l application/javascript
l text/javascript
l application/json
l application/rss+xml
Enter the name of an exclusion to use with the rule, if any. For
exclude-url "<exclusion- No
rule_name>" details, see "waf exclude-url" on page 378. The maximum length is
default.
63 characters.
Example
This example configures a file compression rule that compresses CSS and HTML files, unless they match one of the
URLs in the exception named “Compression Exclusion 1.”
config waf file-compress-rule
edit "file-compress-rule_name"
set compression-type gzip
set compression-level level2
set content-types
edit 1
set content-type text/css
next
edit 2
set content-type text/html
next
end
set exclude-url "Compression Exclusion 1"
next
end
Related topics
l "waf file-uncompress-rule" on page 382
l "waf exclude-url" on page 378
waf file-uncompress-rule
Use this command to decompress a file that was already compressed by a protected web server.
Since the FortiWeb appliance cannot scan compressed files in order to perform features such as data leak prevention,
you can configure the FortiWeb appliance to decompress files based on the file type.
By default, the maximum file size that FortiWeb can decompress is 64 KB. FortiWeb
does not scan files larger than the maximum.
All decompressed files are recompressed after being scanned. As such, unlike "waf file-compress-rule" on page 380, the
effects of this command will not be visible to end-users.
To apply a decompression rule, select it in an inline or Offline Protection profile. For details, see "waf web-protection-
profile inline-protection" on page 518 or "waf web-protection-profile offline-protection" on page 531.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf file-uncompress-rule
edit "<rule_name>"
config content-type
edit <entry_index>
set content-type "<content-type_name>"
next
end
set exclude-url "<exclusion-rule_name>"
next
end
"<rule_name>" Enter the name of a new or existing rule. The maximum length No
is 63 characters. default.
Enter the index number of the individual entry in the table. The valid No
<entry_index>
range is 1–9,999,999,999,999,999,999. default.
Enter the name of an exclusion to use with the rule, if any. For
exclude-url "<exclusion- No
rule_name>" details, see "waf exclude-url" on page 378. The maximum length is
default.
63 characters.
Example
The following example creates a decompression rule with two content types and one exclusion rule.
config waf file-uncompress-rule
edit "Online Store Uncompress Rule"
config content-types
edit 1
set content-type application/soap+xml
next
edit 2
set content-type application/xml(or)text/xml
next
end
set exclude-url "Uncompress Exclusion"
next
end
Related topics
l "waf file-compress-rule" on page 380
l "waf exclude-url" on page 378
waf file-upload-restriction-policy
Use this command to set file security policies that FortiWeb will use to manage the types of files that can be uploaded to
your web servers.
The policies are composed of individual rules set using the config server-policy custom-application
application-policy (page 110) command. Each rule identifies the host and/or URL to which the restriction
applies and the types of files allowed. To apply a file security policy, select it within an inline or Offline Protection profile.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf file-upload-restriction-policy
edit "<file-upload-restriction-policy_name>"
set action {alert | alert_deny | block-period | deny_no_log}
set block-period <seconds_int>
set severity {High | Medium | Low | Info}
set trigger <trigger-policy_name>
set trojan-detection {enable | disable}
set av-scan {enable | disable}
set fortisandbox-check {enable | disable}
set hold-session-while-scanning-file {enable | disable}
set exchange-mail-detection {enable | disable}
set owa-protocol {enable | disable}
set activesync-protocol {enable | disable}
set mapi-protocol {enable | disable}
config rule
edit <entry_index>
set file-upload-restriction-rule <rule_name>
next
end
next
end
"<file-upload- Enter the name of an existing or new file security policy. The No
restriction-policy_name>" maximum length is 63 characters. default.
severity {High | Medium | Select the severity level to use in logs and reports generated when Low
trigger <trigger-policy_ Enter the name of the trigger to apply when this policy is No
name> violated. For details, see "log trigger-policy" on page 101. The default.
maximum length is 63 characters.
av-scan {enable | Enter enable to scan for viruses, malware, and greyware. disable
disable}
exchange-mail-detection Enter enable so that FortiWeb will scan email attachments disable
{enable | disable} in applications using OWA or ActiveSync protocols. If
enabled, FortiWeb will perform Trojan detection, an antivirus
scan, and will send the attachments to FortiSandbox.
Enter the index number of the individual entry in the table. The No
<entry_index>
valid range is 1–9,999,999,999,999,999,999. default.
file-upload-restriction- Enter the name of an upload restriction rule to use with the No
rule <rule_name> policy, if any. For details, see "server-policy custom- default.
application application-policy" on page 110. The maximum
length is 63 characters.
mapi-protocol {enable FortiWeb will scan attachments in Email sent and received via the disable
| disable} Messaging Application Programming Interface (MAPI), a new
transport protocol implemented in Microsoft Exchange Server 2013
Service Pack 1 (SP1).
Available only when Scan attachments in Email is enabled.
Related topics
l "server-policy custom-application application-policy" on page 110
l "log trigger-policy" on page 101
l "system fortisandbox" on page 257
waf file-upload-restriction-rule
Use this command to define the specific host and request URL for which file upload restrictions apply, and define the
specific file types that can be uploaded to that host or URL.
To apply the rule, select it in a file security policy. For details, see "waf file-upload-restriction-policy" on page 384.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf file-upload-restriction-rule
edit "<file-upload-restriction-rule_name>"
set host-status {enable | disable}
set host "<protected-host_name>"
set request-file "<url_pattern>"
set request-type {regular | plain}
[set file-size-limit <size_int> ]
config file-types
edit <entry_index>
set file-type-id "<id_str>"
set file-type_name "<file-type-extension_str>"
next
end
next
end
host "<protected-host_ Enter the name of a protected host that the Host: field of an No
name>" HTTP request must be in order to match the rule. The default.
maximum length is 255 characters.
<entry_index> Enter the index number of the individual entry in the table. Each No
entry in the table can define one file type. The valid range is 1– default.
9,999,999,999,999,999,999.
l 00001 (GIF)
l 00002 (JPG)
l 00003 (PDF)
l 00004 (XML)
No
file-type-id "<id_str>"
l 00005 (MP3) default.
l 00006 (MIDI)
l 00007 (WAVE)
l 00009 (RAR)
l 00010 (ZIP)
l 00011 (BMP)
l 00014 (3GPP)
file-type_name "<file- Enter the extension, such as MP3, of the file type to allow to No
type-extension_str>" be uploaded. Recognized file types are updated by default.
FortiGuard services and may vary. For a list of available
names, use the GUI.
Example
This example allows both MPEG and FLV files uploaded to the URL /file-uploads on the host
www.example.com.
config waf file-upload-restriction-rule
edit "file-upload-rule1"
set host-status enable
set host "www.example.com"
set request-file "/file-uploads"
config file-types
edit 1
set file-type-id "00013"
set file-type-name "MPEG"
next
edit 2
set file-type-id "00008"
set file-type-name "FLV"
next
end
next
end
Related topics
l "server-policy custom-application application-policy" on page 110
waf ftp-command-restriction-rule
Use this command to create FTP command restriction rules to specify acceptable FTP commands that clients can use
to communicate with your server(s). Certain FTP commands can expose your server(s) to attack. For example, because
attackers can exploit the PORT command to carry out FTP bounce attacks, restricting the PORT command can harden
your network's security if you're using FTP.
For details about applying an FTP command restriction rule to an FTP server policy, see waf ftp-propredefined-global-
white-listtection-profile.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config waf ftp-command-restriction-rule
edit "<rule_name>"
set action {alert | alert_deny | block-period | deny_no_log}
set block-period <block_period_int>
set severity {High | Info | Low | Medium}
set trigger "<policy_name>"
next
end
config command-types
edit <entry_index>
set command-type <ftp_command>
next
end
command-type <ftp_ Enter an FTP command that you want to include in the rule. No
command> You can include these FTP commands in the rule: default.
block-period <block_ Enter the number of seconds that you want to block 60
period_int> subsequent requests from a client after FortiWeb detects
that the client has violated the rule. The valid range is 1–
3,600.
When rule violations are recorded in the attack log, each log
message contains a Severity Level (severity_level)
severity {High | Info
field. Select which severity level FortiWeb will use when it
logs a violation of the rule: Medium
| Low | Medium}
l Info
l Low
l Medium
l High
trigger "<policy_name>" Enter the name of a trigger policy, if any, that FortiWeb will No
use when it logs and/or sends an alert email about a default.
violation of the rule.
Related Topic
l waf ftp-propredefined-global-white-listtection-profile
l "system feature-visibility" on page 247
l "waf ftp-file-security" on page 393
waf ftp-file-security
Use this command to create FTP file check rules so that FortiWeb places restrictions on uploading or downloading files
and scans files that clients attempt to upload to or download from your server(s). When configured, FortiWeb can also
send files to FortiSandbox for analysis and perform an antivirus scan.
For details about applying an FTP file check rule to an FTP server policy, see waf ftp-propredefined-global-white-
listtection-profile.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config waf ftp-file security
edit "<rule_name>"
set action {alert | alert_deny | block-period | deny_no_log}
set block-period <block_period_int>
set severity {High | Info | Low | Medium}
set trigger "<policy_name>"
set check-dir {both | download | upload}
set "waf ftp-file-security" on page 395
set send-files-to-fortisandbox {enable | disable}
next
end
block-period <block_ Enter the number of seconds that you want to block 60
period_int> subsequent requests from a client after FortiWeb detects
that the client has violated the rule. The valid range is 1–
3,600.
When rule violations are recorded in the attack log, each log
message contains a Severity Level (severity_level)
field. Select which severity level FortiWeb will use when it
logs a violation of the rule:
severity {High | Info
Medium
| Low | Medium} l Info
l Low
l Medium
l High
trigger "<policy_name>" Enter the name of a trigger policy, if any, that FortiWeb will No
use when it logs and/or sends an alert email about a default.
violation of the rule.
av-scan {enable Enable so that FortiWeb performs an antivirus scan on files disable
| disable} that match the waf ftp-file-security (page 393).
Related Topic
l "system feature-visibility" on page 247
l "waf ftp-command-restriction-rule" on page 390
l waf ftp-propredefined-global-white-listtection-profile
waf geo-block-list
Use this command to define large sets of client IP addresses to block based upon their associated geographical
location.
Because network mappings may change as networks grow and shrink, if you use this
feature, be sure to periodically update the geography-to-IP mapping database. To
download the file, go to the Fortinet Customer Service & Support website:
https://support.fortinet.com
Optionally, you can also specify a list of IP addresses or IP address ranges that are exempt from this blacklist. For
details, see "waf geo-ip-except" on page 397.
Alternatively, you can block clients individually (see "server-policy custom-application application-policy" on page 110) or
based upon their reputation (see "waf ip-intelligence" on page 429).
To apply the rule, select it in a protection profile. For details, see "waf web-protection-profile inline-protection" on page
518 or "waf web-protection-profile offline-protection" on page 531.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf geo-block-list
edit "<geography-to-ip_name>"
set severity {High | Medium | Low | Info}
set trigger "<trigger-policy_name>"
set exception-rule "<geo-ip-except_name>"
config country-list
edit <entry_index>
set country-name "<region_name>"
next
end
next
end
"<geography-to-ip_name>" Enter the name of a new or existing rule. The maximum length No
is 63 characters. default.
severity {High | Medium | Select the severity level to use in logs and reports generated when
Low
Low | Info} a violation of the rule occurs.
trigger "<trigger-policy_ Enter the name of the trigger to apply when this rule is No
name>" violated. For details, see "log trigger-policy" on page 101. The default.
maximum length is 63 characters.
exception-rule "<geo-ip- No
except_name>" Enter the name of a list of exceptions to this blacklist.
default.
<entry_index> Enter the index number of the individual entry in the table. The valid No
range is 1–9,999,999,999,999,999,999. default.
Example
This example creates a set of North American IP addresses that a server policy can use to block clients with IP
addresses belonging to Belize and Canada. FortiWeb does not block the IP addresses specified by the allow-north-
america exception list.
config waf geo-block-list
edit "north-america"
set trigger "notification-servers1"
set exception rule "allow-north-america"
set severity Low
config country-list
edit 1
set country-name "Belize"
next
edit 2
set country-name "Canada"
next
end
next
end
Related topics
l "log trigger-policy" on page 101
l "waf geo-ip-except" on page 397
l "waf web-protection-profile inline-protection" on page 518
l "server-policy custom-application application-policy" on page 110
l "waf ip-intelligence" on page 429
l "debug flow trace" on page 583
waf geo-ip-except
Use this command to specify IP addresses or ranges of IP addresses that are exceptions to the list of client IP addresses
that FortiWeb blocks based on their geographic location.
For details about creating the blacklist by country or region, see "waf geo-block-list" on page 395.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf geo-ip-except
edit "<geo-ip-except_name>"
edit <entry_index>
set ip {"<address_ipv4>" | "<ip_range_ipv4>"}
next
end
next
end
Enter the index number of the individual entry in the table. The valid No
<entry_index>
range is 1–9,999,999,999,999,999,999. default.
Example
This example adds the IP address range 192.0.2.0 to 192.0.2.5 to the geo-location blacklist exception list allow-
north-america.
config waf geo-ip-except
edit "allow-north-america"
set ip "92.0.2.0-192.0.2.5"
end
next
end
Related topics
l "waf geo-block-list" on page 395
l "server-policy custom-application application-policy" on page 110
l "waf ip-intelligence" on page 429
l "debug flow trace" on page 583
waf hidden-fields-protection
To apply hidden field rule groups, select them within an inline protection profile. For details, see "waf web-protection-
profile inline-protection" on page 518.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf hidden-fields-protection
edit "<hidden-field-group_name>"
config hidden_fields_list
edit <entry_index>
set hidden-field-rule "<hidden-field-rule_name>"
next
end
next
end
"<hidden-field-group_ Enter the name of a new or existing hidden field rule group. No
name>" The maximum length is 63 characters. default.
Enter the index number of the individual entry in the table. The valid No
<entry_index>
range is 1–9,999,999,999,999,999,999. default.
hidden-field-rule Enter the name of an existing hidden field rule to add to the No
"<hidden-field-rule_ group. The maximum length is 63 characters. default.
name>"
To display the list of existing rules, enter:
set hidden-field-rule ?
Related topics
l "waf hidden-fields-rule" on page 399
l "waf web-protection-profile inline-protection" on page 518
waf hidden-fields-rule
Hidden form inputs, like other types of parameters and inputs, can be vulnerable to tampering and can be used as a
vector for other attacks.
Unlike other inputs, they are often written into an HTML page by the web server when it serves that page to the client,
and are not visible on the rendered web page. As such, they are difficult to for users to unintentionally modify, and are
often incorrectly perceived as relatively safe by website owners.
Like other inputs, however, they are accessible through the JavaScript document object model (DOM), and as inputs,
can be used to inject invalid data into your databases or attempt to tamper with the session state.
Hidden field rules prevent such tampering. The FortiWeb appliance caches the values of a session’s hidden inputs as
they pass to the HTTP client, and verifies that they remain unchanged when the HTTP client submits a form.
You apply hidden field constraints by first grouping them into a hidden field group. For details, see "waf hidden-fields-
protection" on page 398.
Before you configure a hidden field rule, if you want to apply it only to HTTP requests for a specific real or virtual host,
you must first define the web host in a protected hosts group. For details, see "server-policy allow-hosts" on page 108.
Alternatively, you can use the web UI to fetch the request URL from the server and
scan it for hidden inputs, using the results to configure the hidden input rule. For
details, see the FortiWeb Administration Guide:
https://docs.fortinet.com/fortiweb/admin-guides
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf hidden-fields-rule
edit "<hidden-field-rule_name>"
set action {alert | alert_deny | redirect | block-period | send_403_forbidden |
deny_no_log}
set block-period <seconds_int>
set host "<protected-hosts_name>"
set host-status {enable | disable}
set request-file "<url_str>"
set action-url0 "<url_str>"
set action-url1 "<url_str>"
set action-url2 "<url_str>"
set action-url3 "<url_str>"
set action-url4 "<url_str>"
set action-url5 "<url_str>"
set action-url6 "<url_str>"
set action-url7 "<url_str>"
set action-url8 "<url_str>"
set action-url9 "<url_str>"
set severity {High | Medium | Low | Info}
set trigger "<trigger-policy_name>"
config hidden-field-name
edit <entry_index>
set argument "<hidden-field_str>"
next
end
next
end
host-status {enable | Enable to apply this hidden field rule only to HTTP requests disable
disable} for specific web hosts. Also configure host
"<protected-hosts_name>" (page 402).
Disable to match the input rule based upon the other criteria,
such as the URL, but regardless of the Host: field.
The URL must begin with a slash ( / ). Do not include the No
request-file "<url_str>" name of the web host, such as www.example.com, which is default.
configured separately in host "<protected-hosts_
name>" (page 402). Regular expressions are not supported.
The maximum length is 255 characters.
action-url0 "<url_str>" Add up to 10 URLs that are valid to use with the HTTP POST No
method when the client submits the form containing the hidden default.
action-url1 "<url_str>" fields in this rule.
action-url2 "<url_str>"
action-url3 "<url_str>"
action-url4 "<url_str>"
action-url5 "<url_str>"
action-url6 "<url_str>"
action-url7 "<url_str>"
action-url8 "<url_str>"
action-url9 "<url_str>"
severity {High | Medium | Select the severity level to use in logs and reports generated when High
Low | Info} a violation of the rule occurs.
<entry_index> Enter the index number of the individual entry in the table. The No
valid range is 1–9,999,999,999,999,999,999. default.
argument "<hidden-field_ Enter the name of the hidden form input, such as No
str>" languagepref. The maximum length is 63 characters. default.
Example
This example blocks and logs requests from search.jsp if its hidden form input, whose name is “languagepref”, is posted
to any URL other than query.do.
config waf hidden-fields-rule
edit "hidden_fields_rule1"
set action alert_deny
set request-file "/search.jsp"
set action-url0 "/query.do"
config hidden-field-name
edit 1
set argument "languagepref"
next
end
next
end
Related topics
l "server-policy allow-hosts" on page 108
l "waf hidden-fields-protection" on page 398
l "log trigger-policy" on page 101
Use this command to group HTTP authentication rules into HTTP authentication policies.
The FortiWeb appliance uses authentication policies with the HTTP authentication feature to authorize HTTP requests.
For details, see the FortiWeb Administration Guide:
https://docs.fortinet.com/fortiweb/admin-guides
To apply HTTP authentication policies, select them in an inline protection profile. For details, see "waf web-protection-
profile inline-protection" on page 518.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf http-authen http-authen-policy
edit "<auth-policy_name>"
set cache {enable | disable}
set alert-type {none | fail | success | all}
set cache-timeout <timeout_int>
set auth-timeout <timeout_int>
config rule
edit <entry_index>
set http-authen-rule "<http-auth-rule_name>"
next
end
next
end
alert-type {none | fail | Enter the instances when alerts will be issued for HTTP none
success | all} authentication attempts:
auth-timeout <timeout_ Enter the connection timeout (in milliseconds) for the query to 2000
int> the FortiWeb’s query to the remote authentication server in
milliseconds.
Enter the index number of the individual entry in the table. The valid No
<entry_index>
range is 1–9,999,999,999,999,999,999. default.
http-authen-rule "<http- Enter the name of an existing HTTP authentication rule. The No
auth-rule_name>" maximum length is 63 characters. default.
Example
This example first configures a user group that contains both a local user account and an LDAP query.
config user user-group
edit "user-group1"
config members
edit 1
set type local
set local-name "user1"
next
edit 2
set ldap-name "user2"
set type ldap
next
end
next
end
Second, it configures a rule that requires basic HTTP authentication when requesting the URL
/employees/holidays.html on the host www.example.com. This URL will be identified as belonging to the
realm named “Restricted Area”. Users belonging to user-group1 can authenticate.
config waf http-authen http-authen-rule
edit "auth-rule1"
set host-status enable
set host "www.example.com"
config rule
edit 1
set request-url "/employees/holidays.html"
set authen-type basic
set user-group "user-group1"
set user-realm "Restricted Area"
next
end
next
end
Third, it groups two HTTP authentication rules into an HTTP authentication policy that can be applied in an inline
protection profile.
config waf http-authen http-authen-policy
edit "http-auth-policy1"
config rule
edit 1
set http-authen-rule "http-auth-rule1"
next
edit 2
set http-authen-rule "http-auth-rule2"
next
end
next
end
Related topics
l "waf http-authen http-authen-rule" on page 406
l "waf web-protection-profile inline-protection" on page 518
Authentication rules are used by the HTTP authentication feature to define sets of request URLs that will be authorized
for each user group.
You apply authentication rules by adding them to an authentication policy, which is ultimately selected within an inline
protection profile for use in web protection. For details, see "waf http-authen http-authen-policy" on page 403.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf http-authen http-authen-rule
edit "<auth-rule_name>"
set host "<protected-hosts_name>"
set host-status {enable | disable}
config rule
edit <entry_index>
set authen-type {basic | digest | ntlm}
set request-url "<path_str>"
set user-group "<user-group_name>"
set user-realm "<realm_str>"
next
end
next
end
"<auth-rule_name>" Enter the name of a new or existing rule. The maximum length is 63 No
characters. default.
Enter the name of a protected host that the Host: field of an HTTP
host "<protected-hosts_ request must be in order to match the HTTP authentication rule. No
name>" The maximum length is 255 characters. default.
This setting applies only if host-status is enable.
host-status {enable | Enable to apply this HTTP authentication rule only to HTTP disable
disable} requests for specific web hosts. Also configure host
"<protected-hosts_name>" (page 407).
Enter the index number of the individual entry in the table. The valid No
<entry_index>
range is 1–9,999,999,999,999,999,999. default.
authen-type {basic | Select which type of HTTP authentication to use, either: basic
digest | ntlm}
l basic—Clear text, Base64-encoded user name and password.
Supports local user accounts, and RADIUS and LDAP user queries.
NTLM user queries are not supported.
l digest—Hashed user name, realm, and password. RADIUS, LDAP
and NTLM user queries are not supported.
l ntlm—Encrypted user name and password. Local user accounts and
RADIUS and LDAP user queries are not supported.
user-group "<user-group_ Enter the name of a user group that is authorized to use the URL in No
name>" request-url "<path_str>" (page 407). The maximum default.
length is 63 characters.
Example
For an example, see "waf http-authen http-authen-policy" on page 403.
Related topics
l "user user-group" on page 329
l "waf http-authen http-authen-policy" on page 403
waf http-connection-flood-check-rule
Use this command to limit the number of TCP connections per HTTP session. This can prevent TCP connection floods
from clients operating behind a shared IP with innocent clients.
Excessive numbers of TCP connections per session can occur if a web application or client is malfunctioning, or if an
attacker is attempting to waste socket resources to produce a DoS.
This command is similar to "waf layer4-connection-flood-check-rule" on page 439. However, this feature counts TCP
connections per session cookie, while TCP flood prevention counts only TCP connections per IP address. Because it
uses session cookies at the application layer instead of only TCP/IP connections at the network layer, this feature can
differentiate multiple clients that may be behind the same source IP address, such as when the source IP address hides
a subnet that uses network address translation (NAT). However, in order to work, the client must support cookies.
To apply this rule, include it in an application-layer DoS-prevention policy. For details, see "waf application-layer-dos-
prevention" on page 341.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf http-connection-flood-check-rule
edit "<rule_name>"
set action {alert | alert_deny | block-period | deny_no_log}
set block-period <seconds_int>
set http-connection-threshold <limit_int>
set severity {High | Medium | Low | Info}
set trigger-policy "<trigger-policy_name>"
next
end
"<rule_name>" Enter the name of a new or existing rule. The maximum length No
is 63 characters. default.
Note: Logging and/or alert email will occur only if enabled and
configured. For details, see "log disk" on page 73 and "log
alertMail" on page 67.
block-period <seconds_ Enter the length of time (in seconds) for which the FortiWeb 1
int> appliance will block additional requests after a client exceeds
the rate threshold.
http-connection-threshold Enter the maximum number of TCP connections allowed from the
<limit_int> 1
same client. The valid range is 1–1,024.
severity {High | Medium | Select the severity level to use in logs and reports generated when Medium
Low | Info} a violation of the rule occurs.
Related topics
l "log trigger-policy" on page 101
l "waf application-layer-dos-prevention" on page 341
waf http-constraints-exceptions
Use set statements under this command to configure exceptions to existing HTTP protocol parameter constraints for
specific hosts.
Exceptions may be useful if you know that some HTTP protocol constraints, during normal use, will cause false positives
by matching an attack signature. Exceptions define HTTP constraints that will not be subject to HTTP protocol
constraint policy.
For example, if you enable max-http-header-length in a HTTP protocol constraint exception for a specific host,
FortiWeb ignores the HTTP header length check when executing the web protection profile for that host.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf http-constraints-exceptions
edit "<http-exception_name>"
config http_constraints-exception-list
edit <entry_index>
set request-file "<url_pattern>"
set request-type {plain | regular}
set host-status {enable | disable}
set block-malformed-request {enable | disable}
set Illegal-content-length-check {enable | disable}
set Illegal-content-type-check {enable | disable}
set Illegal-header-name-check {enable | disable}
set Illegal-header-value-check {enable | disable}
set Illegal-host-name-check {enable | disable}
set Illegal-http-request-method-check {enable | disable}
set Illegal-responese-code-check {enable | disable}
set max-cookie-in-request {enable | disable}
set max-header-line-request {enable | disable}
set max-http-body-length {enable | disable}
set max-http-body-parameter-length {enable | disable}
set max-http-content-length {enable | disable}
set max-http-header-length {enable | disable}
set max-http-header-line-length {enable | disable}
set max-http-header-name-length {enable | disable}
set max-http-header-value-length {enable | disable}
set max-http-parameter-length {enable | disable}
set max-http-request-filename-length {enable | disable}
set max-http-request-length {enable | disable}
set max-url-param-name-len {enable | disable}
set max-url-param-value-len {enable | disable}
set max-url-parameter {enable | disable}
set max-url-parameter-length {enable | disable}
set number-of-ranges-in-range-header {enable | disable}
set parameter-name-check {enable | disable}
set parameter-value-check {enable | disable}
set redundant-header-check {enable | disable}
set source-ip-status {enable|disable}
set source-ip "<ip_range>"
set url-param-name-check {enable | disable}
set url-param-value-check {enable | disable}
next
end
next
end
<entry_index> Enter the index number of the individual entry in the table. The No
valid range is 1–9,999,999,999,999,999,999. default.
host-status {enable | Enable to apply this exception only to HTTP requests for disable
disable} specific web hosts. Also configure analyzer-policy
"<fortianalyzer-policy_name>" (page 102).
Illegal-content-length- Enable to omit the constraint on the maximum acceptable size in disable
check {enable | disable} bytes of the request body.
Illegal-header-name-check Enable to omit the constraint on whether the HTTP header name disable
{enable | disable} contains illegal characters.
Illegal-header-value- Enable to omit the constraint on whether the HTTP header value
check {enable | disable} disable
contains illegal characters.
Illegal-host-name-check Enable to omit the constraint on host names with illegal disable
{enable | disable} characters.
Illegal-http-request- Enable to omit the constraint on illegal HTTP request methods. disable
method-check {enable |
disable}
Illegal-responese-code- Enable to omit the constraint on whether the HTTP response code disable
check {enable | disable} is a 3-digit number.
max-header-line-request Enable to omit the constraint on the maximum number of HTTP disable
{enable | disable} header lines.
max-http-body-length
{enable | disable} Enable to omit the constraint on the maximum HTTP body length. disable
max-http-body-parameter- Enable to omit the constraint on the maximum acceptable size in disable
length {enable | disable} bytes of all parameters in the HTTP body of HTTP POST requests.
max-http-header-length Enable to omit the constraint on the maximum HTTP header disable
{enable | disable} length.
max-http-header-line- Enable to omit the constraint on the maximum HTTP header line
length {enable | disable} disable
length.
max-http-header-name- Enable to omit the constraint on the maximum acceptable size in disable
length {enable | disable} bytes of a single HTTP header name.
max-http-request- Enable to omit the constraint on the maximum HTTP request disable
filename-length {enable | filename length.
disable}
max-http-request-length Enable to omit the constraint on the maximum HTTP request disable
{enable | disable} length.
max-url-param-value-len Enable to omit the constraint on the maximum acceptable length disable
{enable | disable} in bytes of the parameter value.
number-of-ranges-in-
Enable to omit the constraint on the maximum acceptable number
range-header {enable | disable
disable} of Range: fields of an HTTP header.
source-ip-status Enable to check requests for matching the HTTP constraint disable
{enable|disable} exceptions rule by their source IP addresses.
source-ip "<ip_range>" Enter the source IP of the protected requests to which this
exception applies. Only a single IPv4/IPv6 address, or a
IPv4/IPv6 range is acceptable.
For example:
l 1.2.3.4 No
l 2001::1 default.
l 1.2.3.4-1.2.3.40
l 2001::1-2001::100
Available only when source-ip-status
{enable|disable} (page 414) is enable.
url-param-name-check Enable to omit the constraint on illegal characters in the parameter disable
{enable | disable} name.
Example
This example omits header length limits for HTTP requests to www.example.com and 192.0.2.1 for
/login.asp.
config waf http-constraints-exceptions
edit "exception1"
config http_constraints-exception-list
edit 1
set host "www.example.com"
set host-status enable
set max-http-header-length enable
set request-file "/login.asp"
next
edit 2
set host "192.0.2.1"
set host-status enable
set max-http-body-length enable
set request-file "/login.asp"
next
end
next
end
Related topics
l "waf web-protection-profile inline-protection" on page 518
l "waf web-protection-profile offline-protection" on page 531
l "log trigger-policy" on page 101
l "waf http-protocol-parameter-restriction" on page 418
waf http-header-security
Use this command to insert special HTTP response headers to protect clients from certain attacks, including XSS,
clickjacking, and MIME sniffing attacks. The special HTTP response headers define security policies to client browsers
so that the browsers avoid exposure to known vulnerabilities when handling requests.
For more information on HTTP Header Security, see the FortiWeb Administration Guide:
https://docs.fortinet.com/fortiweb/admin-guides
To use this command, your administrator account’s access control profile must have either w or rw permission to the
admingrp area. For details, see "Permissions" on page 51.
Syntax
config waf http-header-security
edit "<http-header-security_name>"
config http-header-security-list
set name {x-content-type-options | x-frame-options | x-xss-protection |
content-security-policy}
set value {nosniff | allow-from | deny | sameorigin | sanitizing-mode |
block-mode}
set custom-value <custom-value_str>
set allow-from-source "<allow-from_str>"
set request-type {plain | regular}
set request-file "<request-file_str>"
set request-status {enable | disable}
next
end
next
end
request-status {enable |
disable} Enable to set a URL Filter. disable
request-type {plain | Defines the Request URL Type as a simple string (plain) No default.
regular} or a regular expression (regular) for the URL Filter.
value {nosniff | allow-from Defines the response according to the defined Secure No default.
| deny | sameorigin | Header Type.
sanitizing-mode | block-
mode} The x-frame-options header can be implemented
with one of the following options:
custom-value <custom-
value_str>
Example
This example creates a HTTP header security policy.
config waf http-header-security
edit http_header_security1
set request-status enable
set request-type plain
set request-file "/bWAPP/clickjacking.php"
config http-header-security-list
edit 1
set name x-content-type-options
set value nosniff
next
edit 2
set name x-frame-options
set value deny
next
edit 3
set name x-xss-protection
set value block-mode
next
next
end
waf http-protocol-parameter-restriction
HTTP constraints govern features such as the HTTP header fields in the protocol itself, as well as the length of the
HTML, XML, or other documents or encapsulated protocols carried in the content payload.
Use protocol constraints to prevent attacks such as buffer overflows in web servers that do not restrict elements of the
HTTP protocol to acceptable lengths, or mishandle malformed requests. Such errors can lead to security vulnerabilities.
You can also use protocol constraints to block requests that are too large for the memory
size you have configured for FortiWeb’s scan buffers. If your web applications do not
require large HTTP POST requests, enable waf http-protocol-parameter-
restriction (page 418) to harden your configuration. To configure the buffer size, see
system advanced (page 208).
You can configure each protocol parameter independently with a threat weight, action, severity, and trigger that
determines how an attack on that parameter is handled. For example, you can set the action for header constraints to
alert, the severity to high, and a trigger set to deliver an email each time FortiWeb detects a violation of these protocol
parameters.
To apply HTTP protocol constraints, select them in an inline or Offline Protection profile. For details, see "waf web-
protection-profile inline-protection" on page 518 and "waf web-protection-profile offline-protection" on page 531.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf http-protocol-parameter-restriction
edit "<http-constraint_name>"
set <constraint_name>-check {enable | disable}
set <constraint_name>-action {alert | alert_deny | block-period | deny_no_log}
set <constraint_name>-block-period <seconds_int>
set <parameter_name>-threat-weight {off | low | med | high | crit}
set <constraint_name>-severity {High | Medium | Low | Info}
set <constraint_name>-trigger "<trigger-policy_name>"
next
end
<constraint_name>-action {alert | Select one of the following actions that the alert
alert_deny | block-period | deny_no_ FortiWeb appliance will perform when an HTTP
log}
request violates one of the rules:
<constraint_name>-severity {High | Select the severity level to use in logs and Medium
Medium | Low | Info} reports generated when a violation of the rule
occurs.
<constraint_name>-trigger "<trigger- Enter the name of the trigger to apply when this No
policy_name>" rule is violated (see config log trigger- default.
policy (page 101)). The maximum length is 63
characters.
Example
This example limits the total size of the HTTP header, including all lines, to 2,048 bytes. If the HTTP header length
exceeds 2,048 bytes, the FortiWeb appliance takes an action to create a log message (alert), identifying the violation
as medium severity, and sends an email to the administrators defined within the trigger policy email-admin.
config waf http-protocol-parameter-restriction
edit "http-constraint1"
set max-http-header-length 2048
set max-http-header-length-action alert
set max-http-header-length-severity Medium
set max-http-header-length-trigger email-admin
next
end
Related topics
l "waf web-protection-profile inline-protection" on page 518
l "waf web-protection-profile offline-protection" on page 531
l "log trigger-policy" on page 101
l "server-policy custom-application application-policy" on page 110
l "debug application http" on page 569
l "debug flow trace" on page 583
waf http-request-flood-prevention-rule
Use this command to limit the maximum number of HTTP requests per second coming from any client to a specific URL
on one of your protected servers.
The FortiWeb appliance tracks the requests using a session cookie. If the count exceeds the request limit, FortiWeb
performs the specified action.
To apply this rule, include it in an application-layer DoS-prevention policy. This feature is effective only when http-
session-management {enable | disable} (page 521) is enabled in the inline protection profile that uses the
parent DoS-prevention policy.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf http-request-flood-prevention-rule
edit "<rule_name>"
set access-limit-in-http-session <limit_int>
set action {alert | alert_deny | block-period | deny_no_log}
set bot-recognition {captcha-enforcement | real-browser-enforcement |
disable}
set max-attempt-times <attempts_int>
set validation-timeout <seconds_int>
set block-period <seconds_int>
set severity {High | Medium | Low | Info}
set trigger-policy "<trigger-policy_name>"
next
end
action {alert | alert_ Select one of the following actions that the FortiWeb alert
deny | block-period | appliance will perform when the count exceeds the limit:
deny_no_log}
l alert—Accept the request and generate an alert email
and/or log message.
of this type.
If the client either fails the test or does not return results
bot-recognition {captcha- before the timeout specified by validation-timeout
enforcement | real-
browser-enforcement | <seconds_int> (page 423), FortiWeb applies the specified disable
disable} action. If the client appears to be a web browser, FortiWeb
allows the client to exceed the rate limit.
severity {High | Medium | Select the severity level to use in logs and reports generated when
Low | Info} Medium
a violation of the rule occurs.
trigger-policy "<trigger- Enter the name of the trigger to apply when this rule is No
policy_name>" violated. For details, see "log trigger-policy" on page 101. The default.
maximum length is 63 characters.
Example
This example illustrates a rule that imposes a two-minute blocking period on clients that exceed the set request limit.
config waf http-request-flood-prevention-rule
edit "Web Portal HTTP Request Limit"
set access-limit-in-http-session 10
set action block-period
set block-period 120
set severity Medium
set trigger-policy "Server_Policy_Trigger"
next
end
Related topics
l "log trigger-policy" on page 101
l "waf application-layer-dos-prevention" on page 341
waf input-rule
Input rules define whether or not parameters are required, and sets their maximum allowed length, for HTTP requests
matching the host and URL defined in the input rule.
Each input rule contains one or more individual rules. This enables you to define, within one input rule, all parameter
restrictions that apply to HTTP requests matching that URL and host name.
For example, one web page might have multiple inputs: a user name, password, and a preference for whether or not to
remember the login. Within the input rule for that web page, you could define separate rules for each parameter in the
HTTP request: one rule for the user name parameter, one rule for the password parameter, and one rule for the
preference parameter.
To apply input rules, select them within a parameter validation rule. For details, see "waf parameter-validation-rule" on
page 461.
Before you configure an input rule, if you want to apply it only to HTTP requests for a specific real or virtual host, you
must first define the web host in a protected hosts group. For details, see "server-policy allow-hosts" on page 108.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf input-rule
edit "<input-rule_name>"
set action {alert | alert_deny | redirect | send_403_forbidden | block-
period | deny_no_log}
set block-period <seconds_int>
set host "<protected-host_name>"
set host-status {enable | disable}
set request-file "<url_str>"
set request-type {plain | regular}
set severity {High | Medium | Low | Info}
set trigger "<trigger-policy_name>"
config rule-list
edit <entry_index>
set type-checked (enable | disable}
set argument-type <custom-data-type | data-type | regular-expression}
set argument-name-type {plain | regular}
set argument-name "<input_name>"
set argument-expression "<regex_pattern>"
set custom-data-type "<custom-data-type_name>"
set data-type "<predefined_name>"
set is-essential {yes | no}
set max-length <limit_int>
next
end
next
end
block-period <seconds_ Enter the number of seconds to block the source IP. The valid 60
int> range is 0–3,600.
host-status {enable | Enable to apply this input rule only to HTTP requests for disable
disable} specific web hosts. Also configure host "<protected-
host_name>" (page 426).
Disable to match the input rule based upon the other criteria,
such as the URL, but regardless of the Host: field.
severity {High | Medium | Select the severity level to use in logs and reports generated when
Low
Low | Info} a violation of the rule occurs.
trigger "<trigger-policy_ Enter the name of the trigger to apply when this rule is No
name>" violated. For details, see "log trigger-policy" on page 101. The default.
maximum length is 63 characters.
Enter the index number of the individual entry in the table. The No
<entry_index>
valid range is 1–9,999,999,999,999,999,999. default.
is-essential {yes | no} Select yes if the parameter is required for HTTP requests to this no
combination of Host: field and URL. Otherwise, select no.
type-checked (enable | Enable to use predefined or configured data types when enable
disable} validating parameters. Also configure argument-type
argument-type <custom-
No
data-type | data-type | Specify the type of argument.
regular-expression} default.
argument-expression Enter a regular expression that matches all valid values, and
"<regex_pattern>" no invalid values, for this input.
data-type "<predefined_ Select one of the predefined data types, if the input matches No
name>" one of them (available options vary by FortiGuard updates). default.
Example
This example blocks and logs requests for the file named login.php that do not include a user name and password, both
of which are required, or whose user name and password exceed the 64-character limit.
config waf input-rule
edit "input_rule1"
set action alert_deny
set request-file "/login.php?*"
request-type regular
config rule-list
edit 1
set argument-name "username"
set argument-type data-type
set data-type Email
set is-essential yes
set max-length 64
next
edit 2
set argument-name "password"
set data-type String
set is-essential yes
set max-length 64
next
end
next
end
Related topics
l "server-policy allow-hosts" on page 108
l "waf parameter-validation-rule" on page 461
waf ip-intelligence
Clients with suspicious behaviors or poor reputations include spammers, phishers, botnets, and anonymizing proxy
users. If you have purchased a subscription for the FortiGuard IP Reputation service, your FortiWeb can periodically
download an updated blacklist to keep your appliance current with changes in dynamic IPs, spreading virus infections,
and spammers changing service providers.
IP intelligence settings apply globally, to all policies that use this feature.
Before or after using this command, use "waf ip-intelligence-exception" on page 433 to configure any exemptions that
you want to apply. To apply IP reputation-based blocking, configuring these category settings first, then enable ip-
intelligence {enable | disable} (page 526) in the server policy’s protection profile.
Alternatively, you can block sets of many clients based upon their geographical origin (see "waf geo-block-list" on page
395) or manually by specific IPs (see "server-policy custom-application application-policy" on page 110).
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf ip-intelligence
edit <entry_index>
set action {alert | alert_deny | redirect | send_403_forbidden | block-period |
deny_no_log}
set block-period <seconds_int>
set category "<category_name>"
set severity {Low | Medium | High | Info}
set status {enable | disable}
set trigger "<trigger-policy_name>"
next
end
<entry_index> Enter the index number of the individual entry in the table entry in No
the table. default.
Note: Logging and/or alert email will occur only if enabled and
configured. For details, see "log disk" on page 73 and "log
alertMail" on page 67.
block-period <seconds_ Enter the number of seconds to block the source IP. The valid 60
int> range is 0–3,600.
status {enable | disable} Enable to block clients whose source IP belongs to this category enable
according to the FortiGuard IRIS service.
When rule violations are recorded in the attack log, each log
message contains a Severity Level (severity_level)
severity {Low | Medium |
High | Info} field. Select which severity level the FortiWeb appliance uses Low
when a blacklisted IP address attempts to connect to your web
servers:
l Low
l Medium
l High
l Info
trigger "<trigger-policy_ Select which trigger, if any, that the FortiWeb appliance uses No
name>" when it logs and/or sends an alert email about a blacklisted IP default.
address’s attempt to connect to your web servers. For details,
see "log trigger-policy" on page 101. The maximum length is
63 characters.
Example
The following command blacklists clients whose source IPs are currently known by Fortinet to be members of a botnet.
In the FortiGuard IRIS package for this example, “Botnet” is the first item in the list of categories.
When a botnet member makes a request, FortiWeb blocks the connection and continues to block it without re-
evaluating it for the next 6 minutes (360 seconds). FortiWeb logs the event with a high severity level and sends
notifications to the Syslog and email servers specified in notification-servers1.
config waf ip-intelligence
edit 1
set status enable
set action period_block
set block-period 360
set severity High
set trigger-policy "notification-servers1"
next
end
Related topics
l "waf ip-intelligence-exception" on page 433
l "log trigger-policy" on page 101
l "waf web-protection-profile inline-protection" on page 518
l "waf web-protection-profile offline-protection" on page 531
l "waf geo-block-list" on page 395
l "server-policy custom-application application-policy" on page 110
l "debug flow trace" on page 583
waf ip-intelligence-exception
Use this command to exempt IP addresses from reputation-based blocking. The settings apply globally, to all policies
that use this feature.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf ip-intelligence-exception
edit <entry_index>
set status {enable | disable}
set ip "<client_ipv4>"
next
end
<entry_index> Enter the index number of the individual entry in the table entry in No
the table. The valid range is 1–9,999,999,999,999,999,999. default.
status {enable | disable} Enable to exempt clients from IP reputation-based blocking. disable
Example
See "waf ip-intelligence" on page 429.
Related topics
l "waf ip-intelligence" on page 429
waf ip-list
Use this command to define which source IP addresses are trusted clients, undetermined, or distrusted.
l Trusted IPs—Almost always allowed to access to your protected web servers. Trusted IPs are exempt from many (but
not all) of the restrictions that would otherwise be applied by a server policy. To determine skipped scans, see "debug flow
trace" on page 583.
l Neither—If a source IP address is neither explicitly blacklisted or trusted by an IP list policy, the client can access your
web servers, unless it is blocked by any of your other configured, subsequent web protection scan techniques. For details,
see "debug flow trace" on page 583.
l Blacklisted IPs—Blocked and prevented from accessing your protected web servers. Requests from blacklisted IP
addresses receive a warning message in response. The warning message page includes ID: 70007, which is the ID of all
attack log messages about requests from blacklisted IPs.
Because FortiWeb evaluates trusted and blacklisted IP policies before many other
techniques, defining these IP addresses can improve performance.
Alternatively, you can block sets of many clients based upon their reputation (see "waf ip-intelligence" on page 429) or
geographical origin (see "waf geo-block-list" on page 395).
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf ip-list
edit "<ip-list_name>"
config members
edit <entry_index>
set ip "<client_ip>"
set type {trust-ip | black-ip}
set severity {Low | Medium | High | Info}
set trigger-policy "<trigger-policy_name>"
next
end
next
end
"<ip-list_name>" Enter the name of a new or existing rule. The maximum length No
is 63 characters. default.
Enter the index number of the individual entry in the table entry in No
<entry_index>
the table. The valid range is 1–9,999,999,999,999,999,999. default.
severity {Low | Medium | When rule violations are recorded in the attack log, each log No
High | Info} message contains a Severity Level (severity_level) default.
field. Select which severity level the FortiWeb appliance will
use when a blacklisted IP address attempts to connect to your
web servers:
l Low
l Medium
l High
Example
The following shows the configuration for a trusted host of 192.0.2.0 followed by a blacklisted client of 192.0.2.1.
config waf ip-list
edit "IP-List-Policy1"
config members
edit 1
set ip "192.0.2.0"
next
edit 2
set type black-ip
set ip "192.0.2.1"
set severity Medium
set trigger-policy "TriggerActionPolicy1"
next
end
next
end
Related topics
l "log trigger-policy" on page 101
l "waf web-protection-profile inline-protection" on page 518
l "waf web-protection-profile offline-protection" on page 531
l "waf geo-block-list" on page 395
l "waf ip-intelligence" on page 429
l "debug flow trace" on page 583
waf layer4-access-limit-rule
Use this command to limit the number of HTTP requests per second from any IP address to your web server. The
FortiWeb appliance tracks the number of requests. If the count of HTTP GET or POST requests exceeds the request
limit, FortiWeb performs the action you specified.
To apply this rule, include it in an application-layer DoS-prevention policy and include that policy in an inline protection
profile. For details, see "waf application-layer-dos-prevention" on page 341.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf layer4-access-limit-rule
edit "<rule_name>"
set access-limit-standalone-ip <limit_int>
set access-limit-share-ip <limit_int>
set action {alert | alert_deny | block-period | deny_no_log}
set bot-recognition {captcha-enforcement | real-browser-enforcement}
set max-attempt-times <attempts_int>
set block-period <seconds_int>
set severity {High | Medium | Low | Info}
set trigger-policy "<trigger-policy_name>"
set validation-timeout <seconds_int>
next
end
"<rule_name>" Enter the name of a new or existing rule. The maximum length No
is 63 characters. default.
access-limit-standalone- Enter the maximum number of HTTP requests allowed per second
0
ip <limit_int> from any source IP address representing a single client. The valid
access-limit-share-ip Enter the maximum number of HTTP requests allowed per second 0
<limit_int> from any source IP address shared by multiple clients behind a
network address translation (NAT) device, such as a firewall or
router. The valid range is 0–65,536. To disable the limit, enter 0.
Note: Logging and/or alert email will occur only if enabled and
configured. For details, see "log disk" on page 73 and "log
alertMail" on page 67.
block-period <seconds_ Enter the number of seconds to block access to the client. This 0
int> applies only when the action {alert | alert_deny |
block-period | deny_no_log} (page 437) setting is
block-period. The valid range is 0–10,000. To disable the limit,
enter 0.
severity {High | Medium | Select the severity level to use in logs and reports generated when
Medium
Low | Info} a violation of the rule occurs.
trigger-policy "<trigger- Enter the name of the trigger to apply when this rule is No
policy_name>" violated. For details, see "log trigger-policy" on page 101. The default.
maximum length is 63 characters.
Example
This examples includes two rules. One blocks connections for two minutes while the other creates an alert and denies
the connection.
config waf layer4-access-limit-rule
edit "Web Portal HTTP Request Limit"
set access-limit-share-ip 10
set access-limit-standalone-ip 10
set action block-period
set block-period 120
set severity Medium
set trigger-policy "Web_Protection_Trigger"
next
edit "Online Store HTTP Request Limit"
set access-limit-share-ip 5
set access-limit-standalone-ip 5
set action alert_deny
set severity High
set trigger-policy "Web_Protection_Trigger"
next
end
Related topics
l "log trigger-policy" on page 101
l "waf application-layer-dos-prevention" on page 341
l "waf layer4-connection-flood-check-rule" on page 439
waf layer4-connection-flood-check-rule
Use this command to limit the number of fully-formed TCP connections per source IP address. This effectively prevents
TCP flood-style denial-of-service (DoS) attacks.
TCP flood attacks exploit the fact that servers must consume memory to maintain the state of the open connection until
either the timeout, or the client or server closes the connection. This consumes some memory even if the client is not
currently sending any HTTP requests.
Normally, a legitimate client forms a single TCP connection, through which they may make several HTTP requests. As a
result, each client consumes a negligible amount of memory to track the state of the TCP connection. However, an
attacker opens many connections with perhaps zero or one request each, until the server is exhausted and has no
memory left to track the TCP states of new connections with legitimate clients.
This command is similar to config waf http-connection-flood-check-rule (page 408). However, this
feature counts TCP connections per IP, while the other command counts TCP connections per session cookie.
It is also similar to syncookie in "server-policy policy" on page 146. However, this feature counts fully-formed TCP
connections, while the anti-SYN flood feature counts partially-formed TCP connections.
To apply this rule, include it in an application-layer DoS-prevention policy and include that policy in an inline protection
profile. For details, see "waf application-layer-dos-prevention" on page 341.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf layer4-connection-flood-check-rule
edit "<rule_name>"
set layer4-connection-threshold <limit_int>
set action {alert | alert_deny | block-period | deny_no_log}
set block-period <seconds_int>
set severity {High | Medium | Low | Info}
set trigger-policy "<trigger-policy_name>"
next
end
"<rule_name>" Enter the name of a new or existing rule. The maximum length No
is 63 characters. default.
layer4-connection- Enter the maximum number of TCP connections allowed from the
threshold <limit_int> 0
same IP address. The valid range is 0–65,536.
action {alert | alert_ Select one of the following actions that the FortiWeb alert
deny | block-period | appliance will perform when the count exceeds the rate limit:
deny_no_log}
l alert—Accept the connection and generate an alert email
and/or log message.
l alert_deny—Block the connection and generate an alert email
and/or log message.
l block-period—Block subsequent requests from the client for
a number of seconds. Also configure block-period
<seconds_int> (page 441).
l deny_no_log—Deny a request. Do not generate a log
message.
Note: Logging and/or alert email will occur only if enabled and
configured. For details, see "log disk" on page 73 and "log
alertMail" on page 67.
Enter the length of time (in seconds) for which the FortiWeb
appliance will block additional requests after a source IP
block-period <seconds_ address exceeds the rate threshold.
1
int>
The block period is shared by all clients whose traffic
originates from the source IP address. The valid range is 1–
3,600.
severity {High | Medium | Select the severity level to use in logs and reports generated when Medium
Low | Info} a violation of the rule occurs.
Example
This example illustrates a basic TCP flood check rule.
config waf layer4-connection-flood-check-rule
edit "Web Portal Network Connect Limit"
set action alert_deny
set layer4-connection-threshold 10
set severity Medium
set trigger-policy "Server_Policy_Trigger"
next
end
Related topics
l "log trigger-policy" on page 101
l "waf application-layer-dos-prevention" on page 341
l "waf layer4-access-limit-rule" on page 436
waf machine-learning
Use this command to enable the machine learning feature and configure its settings.
Syntax
config waf machine-learning url-replacer-rule
edit url-replacer-rule_name
set type {pre-defined | custom-defined}
set app-type {jsp | owa-2003}
set url-replacer-policy_name
set url "<url_str>"
set new-url "<new-url_str>"
set param "<param_str>"
set new-param "<new-param_str>"
next
end
config waf machine-learning url-replacer-policy
edit url-replacer-policy_name
config rule list
edit rule-id "<rule_id>"
set type URL_Replacer
set plugin-name "<plugin-name_str>"
next
end
next
end
(^/public/)(.*)
(^/exchange/)([^/]+)/*(([^/]+)/
(.*))*
These two application types
are predefined URL interpreter
plug-ins used by popular web
applications.
Related Topic
l waf machine-learning-policy
waf machine-learning-policy
Use this command to create machine learning policies and configure related policy settings.
Syntax
config waf machine-learning-policy
edit waf machine-learning-policy
set hmm-engine {enable | disable}
setsample-collecting-mode {normal | fast}
set sample-limit-by-ip <sample-limit-by-ip_int>
set threat-model {enable | disable}
set svm-model {xss | sql-injection | code-injection | command-injection | lfi-
rfi | common-injection | remote-exploits}
set anomaly-detection-method {automatic | quantile}
set strictness-level-quantile-potential
set strictness-level-quantile-defnite
set strictness-level-automatic-potential
set strictness-level-automatic-defnite
set automatic-refresh-model {enable | disable}
set box-notch-count <box-notch-count_int>
set boxplot-checking-interval <boxplot-checking-interval_int>
set allow-method {enable | disable}
set allow-method-exceptions {none others get post head options trace connect
delete put patch webdav rpc}
set action-protential {alert | alert_deny | block-period}
set action-definitely {alert | alert_deny | block-period}
set action-page-method {alert | alert_deny | block-period}
set block-period-potential "<block-period-potential_int>"
set severity-page-method {High | Info | Low | Medium}
set block-period-definitely "<block-period-definitely_int>"
set severity-definitely {High | Info | Low | Medium}
set severity-potential {High | Info | Low | Medium}
set trigger-definitely "<policy_name>"
set trigger-potential "<policy_name>"
set block-period-page-method "<block-period-page-method_int>"
set severity-page-method {High | Info | Low | Medium}
set trigger-page-method "<policy_name>"
set app-change-sensitivity {High | Low | Medium}
set status {enable | disable}
set ip-list-type {Trust | Black}
set url-replacer-policy
config waf machine-learning-policy
edit "<allow-domain-name_id>"
set domain-name "<domain-name_str>"
set domain-index "<domain-index_id>"
set character-set {AUTO | ISO-8859-1 | ISO-8859-2 | ISO-8859-3 | ISO-8859-
4 | ISO-8859-5 | ISO-8859-6 | ISO-8859-7 | ISO-8859-8 | ISO-8859-9 |
ISO-8859-10 | ISO-8859-15 | GB2312 | BIG5 | ISO-2022-JP | ISO-2022-JP-
2 | Shift-JIS | ISO-2022-KR | UTF-8}
next
end
config source-ip-list
edit "<source-ip-list_id>"
set "<ip>"
next
end
machine-learning-policy_ Enter the ID of the machine learning policy. It's the number No default
id displayed in the "#" column of the machine learning policy table
on the Machine Learning Policy page. The valid range is 0–
65535.
hmm-engine {enable Enable to monitor access to the application and collect data to
enable
| disable} build a mathematical model behind every parameter.
sample-limit-by-ip The limitation number of samples collected from each IP. The
30
<sample-limit-by-ip_int> valid range is 0–5000.
threat-model {enable Enable to scan anomalies to verify whether they are attacks. It enable
| disable} provides a method to check whether an anomaly is a real attack
by the trained Support Vector Machine Model.
strictness-level- Enter the threshold value or choose the threshold numbers. The 0.1
quantile-defnite valid range is from 0 to 0.9. The higher the threshold, the more
anomalies will be triggered.
Enter the value for the strictness level. The valid range is from 0.1
strictness-level-
automatic-potential to 1.0. The higher the value is , the more potential anomalies will 0.3
be triggered.
strictness-level- Enter the value for the strictness level. The valid range is from 0.1 0.1
automatic-defnite to 0.9. The higher the value is , the more definite anomalies will
be triggered.
automatic-refresh-model Enable to let the system to relearn the argument related to the
enable
{enable | disable} HMM model.
box-notch-count <box- This option appears when you enable Dynamically update 2
notch-count_int> when parameters change.
The default value is 2, which means if 2 newly generated boxplots
don't overlap with any one of the sample boxplots, FortiWeb
automatically updates the machine learning model. You can set a
value from 1 to 3.
checking-interval_int>
allow-method {enable Enable to allow the system to learn and verify the HTTP method. enable
| disable}
allow-method-exceptions
{none others get post
Select the HTTP request method that is allowed to access the head,
head options trace
connect delete put patch URL. options
webdav rpc}
action-protential {alert Choose the action FortiWeb takes when potential attack is Alert
| alert_deny | block- verified.
period}
Alert—Accepts the connection and generates an alert email
and/or log message.
Alert & Deny—Blocks the request (or resets the connection) and
generates an alert and/or log message.
Period Block—Blocks the request for a certain period of time.
action-page-method Choose the action FortiWeb takes when HTTP method violation Alert &
{alert | alert_deny | is verified. Deny
block-period}
Alert—Accepts the connection and generates an alert email
and/or log message.
Alert & Deny—Blocks the request (or resets the connection) and
generates an alert and/or log message.
Period Block—Blocks the request for a certain period of time.
Enter the number of seconds that you want to block the requests.
block-period-potential
The valid range is 1–3,600 seconds.
"<block-period- 60
potential_int>" This option only takes effect when you choose Period Block in
Action.
severity-potential {High Select the severity level for this anomaly type. The severity level Medium
| Info | Low | Medium} will be displayed in the alert email and/or log message.
severity-definitely
Select the severity level for this anomaly type. The severity level
{High | Info | Low High
| Medium} will be displayed in the alert email and/or log message.
trigger-definitely Select a trigger policy that you have set in Log&Report > Log No default.
"<policy_name>" Policy > Trigger Policy. If definite anomaly is detected, it will
trigger the system to send email and/or log messages according
to the trigger policy.
Enter the number of seconds that you want to block the requests.
block-period-definitely
The valid range is 1–3,600 seconds.
"<block-period- 60
definitely_int>" This option only takes effect when you choose Period Block in
Action.
block-period-page-method Enter the number of seconds that you want to block the requests. 60
"<block-period-page- The valid range is 1–3,600 seconds. The default value is 60
method_int>"
seconds.
This option only takes effect when you choose Period Block in
Action.
severity-page-method
Select the severity level for this anomaly type. The severity level
{High | Info | Low High
| Medium} will be displayed in the alert email and/or log message.
trigger-page-method Select a trigger policy that you have set in Log&Report > Log No default
"<policy_name>" Policy > Trigger Policy. If HTTP Method Violation is detected, it
will trigger the system to send email and/or log messages
according to the trigger policy.
status {enable Enable to change the status to Running, while disable to change enable
| disable} the status to Stopped.
Select the name of the URL Replacer Policy that you have
created in Machine Learning Templates. If web applications have
url-replacer-policy No default.
dynamic URLs or unusual parameter styles, you must adapt URL
Replacer Policy to recognize them.
trigger-potential Select a trigger policy that you have set in Log&Report > Log
"<policy_name>" Policy > Trigger Policy. If potential anomaly is detected, it will
trigger the system to send email and/or log messages according
to the trigger policy.
"<allow-domain-name_id>" Enter the ID of the policy. The valid range is 1–65,535. No default.
ip-list-type {Trust Allow or deny sample collection from the Source IP list. Trust
| Black}
domain-name "<domain- Add full domain name or use wildcard '*' to cover multiple
name_str>" No default.
domains under one profile.
domain-index "<domain- The number automatically assigned by the system when the No default.
index_id>" domain name is created.
character-set {AUTO
| ISO-8859-1 | ISO-8859-
2 | ISO-8859-3 | ISO-
8859-4 | ISO-8859-5 |
ISO-8859-6 | ISO-8859-7
The corresponding character code when manually setting the
| ISO-8859-8 | ISO-8859- No default.
9 | ISO-8859-10 | ISO- domain.
8859-15 | GB2312 | BIG5
| ISO-2022-JP | ISO-
2022-JP-2 | Shift-JIS |
ISO-2022-KR | UTF-8}
"<source-ip-list_id>" Enter the ID of the source IP. The valid range is 1– No default.
9,223,372,036,854,775,807
Related Topics
waf mitb-policy
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf mitb-policy
edit "<mitb-rule_name>"
config rule list
edit "<rule-list_id>"
set "<mitb-rule_name>"
next
end
next
end
No
"<mitb-rule_name>" Enter the name of a MiTB policy.
default.
Related topics
l waf mitb-rule
waf mitb-rule
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf mitb-rule
edit mitb-rule_name
set action {alert| alert_deny}
set severity {High | Medium | Low | Info}
set trigger "<trigger-policy_name>"
set host-status {enable | disable}
set host "<host_str>"
set request-url "<request-url_str>"
set request-type {plain | regular}
set post-url "<post-url_str>"
edit protected-parameter-list_name
set type {regular-input | password-input}
set obfuscate {enable | disable}
set encrypt {enable | disable}
set anti-keyLogger {enable | disable}
next
end
config allowed-external-domains-list
edit allowed-external-domains-list_id
set domain "<domain_str>"
next
end
mitb-rule_name Enter a name that can be referenced by other parts of the No default.
configuration.
severity {High | Medium | Select which severity level the FortiWeb appliance will use when it Low
Low | Info} logs a violation of the rule.
Select which trigger, if any, that the FortiWeb appliance will use
trigger "<trigger-policy_
name>" when it logs and/or sends an alert email about a violation of the No default.
rule.
host-status {enable | Enable to compare the MiTB rule to the Host: field in the No default.
disable} HTTP header.
request-url "<request- The URL hosting the webpage which contains the parameters No default.
url_str>" (field names or passwords) you want to protect.
request-type {plain |
regular} Select either of the URL types. plain
post-url "<post-url_str>" Enter the URL triggered after you submit your access request. No default.
protected-parameter-list_
name Enter the protected parameter list name. No default.
type {regular-input | Select the input type to carry out the protection. regular-
password-input} input
obfuscate {enable |
disable} Enable to obfuscate the configured parameter name. No default.
Related topics
l waf mitb-policy
waf openapi-file
Syntax
config waf openapi-file
edit "<openapi-file_name>"
end
Related topics
l "waf openapi-validation-policy" on page 452
waf openapi-validation-policy
Use this command to create new openapi validation policy and configure related settings.
Syntax
config waf openapi-validation-policy
edit openapi-validation-policy_name
set action {alert | alert_deny | block-period | redirect | send_403_
forbidden | deny_no_log}
set block-period "<seconds_int>"
set severity {Low | Medium | High | Info}
set trigger "<trigger-policy>"
config schema-file
edit schema-file_id
set openapi-file <datasource>
end
block-period Type the number of seconds that you want to block subsequent 60
"<seconds_int>" requests from the client after the FortiWeb appliance detects that
the client has violated the rule. The valid range is 1–3600 seconds.
severity {Low | Select which severity level the FortiWeb appliance will use when it
Low
Medium | High | Info} logs a violation of the rule.
trigger "<trigger- Select which trigger, if any, that the FortiWeb appliance will use No
policy>" when it logs and/or sends an alert email about a violation of the default
rule.
No
schema-file_id The scheme file by the sequence number.
default.
Related topics
l waf openapi-file
waf padding-oracle
Use this command to create a policy that protects vulnerable block cipher implementations for web applications that
selectively encrypt inputs without using HTTPS.
To apply this policy, include it in an inline web or Offline Protection profile. For details, see "waf web-protection-profile
inline-protection" on page 518 and "waf web-protection-profile offline-protection" on page 531.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf padding-oracle
edit "<padding-oracle_rule_name>"
set action {alert | alert_deny | block-period | deny_no_log}
set block-period <block-period_int>
set severity {High | Medium | Low | Info}
set trigger "<trigger-policy_name>"
config protected-url-list
edit <entry_index>
"<padding-oracle_rule_ Enter the name of a new or existing rule. The maximum No default.
name>" length is 63 characters.
Note: Logging and/or alert email occur only when the these
features are enabled and configured. For details, see "log
attack-log" on page 68 and "log alertMail" on page 67.
When rule violations are recorded in the attack log, each log
severity {High | Medium | message contains a Severity Level (severity_level) field.
Medium
Low | Info} Specify the severity level FortiWeb uses when it logs a violation
of this rule.
trigger "<trigger-policy_ Enter the name of the trigger policy, if any, that the No default.
name>" FortiWeb appliance uses when it logs and/or sends an alert
email about a violation of the rule. For details, see "log
trigger-policy" on page 101.
Enter the index number of the individual entry in the table. The
<entry_index> No default.
valid range is 1–9,999,999,999,999,999,999.
host-status {enable | Specify enable to apply this rule only to HTTP requests disable
disable} for specific web hosts. Also specify host "<host_
str>" (page 455).
For example:
/profile.jsp
For example:
protected-url
"<protected-url_str>" No default.
^/*\.jsp\?uid\=(.*)
The pattern does not require a slash ( / ).; however, it must
at least match URLs that begin with a slash, such as
/profile.cfm.
target "<cookie parameter Specify which parts of the client’s requests FortiWeb parameter
url>" examines for padding attack attempts:
Example
This example illustrates a padding oracle rule that blocks requests to the host www.example.com when a parameter
appended in a traditional GET URL parameter or POST body matches the specified regular expression. When a request
matches the expression, FortiWeb logs or sends a high-severity message as specified in the notification-
servers1 trigger policy.
config waf padding-oracle
edit "padding-oracle1"
set action block-period
set block-period 3600
set severity High
set trigger "notification-servers1"
config protected-url-list
edit 1
set host-status enable
set host "www.example.com"
set url-type regular
set protected-url "\/profile\.jsp\?uid\=(.*)"
set target parameter
end
Related topics
l "waf web-protection-profile inline-protection" on page 518
l "waf web-protection-profile offline-protection" on page 531
waf page-access-rule
Page access rules define URLs that can be accessed only in a specific order, such as to enforce the business logic of a
web application. Requests for other, non-ordered URLs may interleave ordered URLs during the client’s session. Page
access rules may be specific to a web host.
For example, an e-commerce application might be designed to work properly in this order:
Sessions that begin at the shipping or payment stage should therefore be invalid. If the web application does not
enforce this rule itself, it could be open to cross-site request forgery (CSRF) attacks on the payment feature. To prevent
such abuse, the FortiWeb appliance could enforce the rule itself using a page access rule set with the following order:
1. /addToCart.do?item=*
2. /checkout.do?login=*
3. /shipment.do
4. /payment.do
Attempts to request /payment.do before those other URLs during a session would be denied, and generate an alert
and attack log message. For details, see "log disk" on page 73.
To apply page access rules, select them within an inline protection profile. For details, see "waf web-protection-profile
inline-protection" on page 518.
Before you configure a page access rule, if you want to apply it only to HTTP requests for a specific real or virtual host,
you must first define the web host in a protected hosts group. For details, see "server-policy allow-hosts" on page 108.
You can use SNMP traps to notify you when a page access rule is enforced. For details, see "system snmp community"
on page 299.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
In order for page access rules to be enforced, you must also enable http-session-
management {enable | disable} (page 521) in the inline protection profile.
Syntax
config waf page-access-rule
edit "<page-access-rule_name>"
set page-severity {Low | Medium | High | Info}
set page-trigger <page-trigger-policy_name>
config page-access-list
edit <entry_index>
set host "<protected-hosts_name>"
set host-status {enable | disable}
set request-file "<url_str>"
set request-type {plain | regular}
next
end
next
end
When rule violations are recorded in the attack log, each log
message contains a Severity Level (severity_level) field.
page-severity {Low |
Medium | High | Info} Select which severity level the FortiWeb appliance will use when it
logs a violation of the rule:
l Informative
l Low
l Medium
High
l
page-trigger <page- Select which trigger, if any, that the FortiWeb appliance will use
trigger-policy_name> when it logs and/or sends an alert email about a violation of the
rule.
host "<protected-hosts_ Enter the name of a protected host that the Host: field of an No
name>" HTTP request must be in order to match the page access default.
rule. The maximum length is 255 characters.
Example
This example allows any request to www.example.com, as long as it follows the expected sequence within a session for
the four key shopping cart URLs (/addToCart.do, /checkout.do, /shipment.do, then /payment.do).
config waf page-access-rule
edit "page-access-rule1"
config page-access-list
edit 1
set host "www.example.com"
set host-status enable
set request-file "/addToCart.do?item=*"
set request-type regular
next
edit 2
set host "www.example.com"
set host-status enable
set request-file "/checkout.do?login=*"
set request-type regular
next
edit 3
set host "www.example.com"
set host-status enable
set request-file "/shipment.do"
set request-type plain
next
edit 4
set host "www.example.com"
set host-status enable
set request-file "/payment.do"
set request-type plain
next
end
next
end
Related topics
l "server-policy allow-hosts" on page 108
l "system snmp community" on page 299
l "waf web-protection-profile inline-protection" on page 518
waf parameter-validation-rule
Use this command to configure parameter validation rules, each of which is a group of input rule entries.
To apply parameter validation rules, select them within an inline or Offline Protection profile. For details, see "waf web-
protection-profile inline-protection" on page 518 and "waf web-protection-profile offline-protection" on page 531.
Before you can configure parameter validation rules, you must first configure one or more input rules. For details, see
"waf input-rule" on page 424.
You can use SNMP traps to notify you when a parameter validation rule is enforced. For details, see "system snmp
community" on page 299.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf parameter-validation-rule
edit "<rule_name>"
config input-rule-list
edit <entry_index>
set input-rule "<input-rule_name>"
next
end
next
end
"<rule_name>" Enter the name of a new or existing rule. The maximum length No
is 63 characters. default.
Enter the index number of the individual entry in the table. The valid No
<entry_index>
range is 1–9,999,999,999,999,999,999. default.
input-rule "<input-rule_ Enter the name of an input rule to use in the parameter No
name>" validation rule. The maximum length is 63 characters. default.
Example
This example configures a parameter validation rule that applies two input rules.
config waf parameter-validation-rule
edit "parameter_validator1"
config input-rule-list
edit 1
set input-rule "input_rule1"
next
edit 2
set input-rule "input_rule2"
next
end
next
end
Related topics
l "waf input-rule" on page 424
l "waf web-protection-profile inline-protection" on page 518
l "waf web-protection-profile offline-protection" on page 531
waf signature
There are several security features specifically designed to protect web servers from known attacks. You can configure
defenses against:
In addition to scanning standard requests, signatures can also scan action message format 3.0 (AMF3) binary inputs
used by Adobe Flash clients to communicate with server-side software and XML. For details, see amf3-protocol-
detection {enable | disable} (page 522) and malformed-xml-check {enable | disable} (page
522) (for inline protection profiles) or amf3-protocol-detection {enable | disable} (page 534) (for
Offline Protection profiles).
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Updating signatures
Known attack signatures can be updated. For details about uploading a new set of attack definitions, see the FortiWeb
Administration Guide:
https://docs.fortinet.com/fortiweb/admin-guides
You can also create your own. For details, see "waf custom-protection-rule" on page 370.
Configuring signatures
Before configuring a server protection rule, if you want to configure your own attack or data leak signatures, you must
also configure custom server protection rules. For details, see "waf custom-protection-group" on page 368.
Each server protection rule can be configured with the severity and notification settings (“trigger”) that, in combination
with the action, determines how FortiWeb handles each violation.
For example, attacks categorized as cross-site scripting and SQL injection could have the action set to alert_
deny, the severity set to High, and a trigger set to deliver an alert email each time these rule violations are
detected. Specific signatures in those categories, however, might be disabled, set to log/alert instead, or exempt
requests to specific host names/URLs.
Alternatively, you can automatically configure a server protection rule that detects all
attack types by generating a default auto-learning profile. For details, see the
FortiWeb Administration Guide:
https://docs.fortinet.com/fortiweb/admin-guides
l config signature_disable_list (page 464)—Disable a specific signature ID (e.g. 040000007), even if the
category in general (e.g. SQL Injection (Extended)) is enabled.
l config sub_class_disable_list (page 464)—Disable a subcategory of signatures (e.g. Session Fixation),
even if the category in general (e.g. General Attacks) is enabled.
l config alert_only_list (page 464)—Only log/alert when detecting the attack, even if the category in general is
configured to block.
l config filter_list (page 464)—Exempt specific host name and/or URL combinations from scanning with this
signature.
To apply server protection rules, select them within an inline or Offline Protection profile. For details, see "waf web-
protection-profile inline-protection" on page 518 and "waf web-protection-profile offline-protection" on page 531.
You can use SNMP traps to notify you when an attack or data leak has been detected. For details, see "system snmp
community" on page 299.
Syntax
config waf signature
edit "<signature-set_name>"
set credit-card-detection-threshold <instances_int>
set custom-protection-group "<group_name>"
config main_class_list
edit {010000000 | 020000000 | 030000000 | 040000000 | 050000000 |
060000000 | 070000000 | 080000000 | 090000000 | 100000000 | 110000000 |
120000000}
set action {alert |alert_deny | block-period |only_erase | send_http_
response | alert_erase | redirect | deny_no_log}
set block-period <seconds_int>
set severity {Low | Medium | High | Info}
set trigger "trigger-policy_name>"
next
end
config signature_disable_list
edit "<signature-id_str>"
next
end
config sub_class_disable_list
edit {010000000 | 020000000 | 030000000 | 040000000 | 050000000 |
060000000 | 070000000 | 080000000 | 090000000 | 100000000 | 110000000 |
120000000}
next
end
config alert_only_list
edit "<alert-only-list_signature-id_str>"
next
end
config fpm_disable_list
edit "<fpm-disable-list_signature-id_str>"
next
end
config scoring_override_disable_list
edit "<scoring-override-disable-list_signature-id_str>"
next
end
config score_grade_list
edit "<score-grade-list_signature-id_str>"
set scoring-grade {off | low | med | high | crit}
next
end
config filter_list
edit <entry_index>
set signature_id "<signature-id_str>"
set match-target {HTTP_METHOD | CLIENT_IP | HOST | URI| FULL_URL |
PARAMETER| COOKIE}
set operator {STRING_MATCH | REGEXP_MATCH | EQ | NE| INCLUDE | EXCLUDE}
set http-method {get post head options trace connect delete put others
patch}
set ip {<ipv4> | <ipv6>}
set name {"<name_str>" | "<name_pattern>"}
"<signature-set_name>" Enter the name of a new or existing rule. The maximum No default.
length is 63 characters.
credit-card-detection- Enter the number of credit cards that triggers the credit
threshold <instances_ card number detection feature.
int>
For example, to ignore web pages with only one credit card
1
number, but to detect when a web page containing two or
more credit cards, enter 2.
custom-protection-group Enter the name of the custom signature group to be used, No default.
"<group_name>" if any. The maximum length is 63 characters.
{010000000 | 020000000 | Enter the ID of a signature class (or, for subclass overrides,
030000000 | 040000000 | the subclass ID).
050000000 | 060000000 |
070000000 | 080000000 | No default.
To display the list of signature classes, enter:
090000000 | 100000000 |
110000000 | 120000000} edit ?
action {alert |alert_ Select which action the FortiWeb appliance will take when alert
deny | block- it detects a signature match.
period |only_erase |
send_http_response | Note: This is not a single setting. Available actions may
alert_erase | redirect |
vary slightly, depending on what is possible for each
deny_no_log}
specific type of attack/information disclosure.
block-period <seconds_ Enter the number of seconds that you want to block 60
int> subsequent requests from the client after the FortiWeb
appliance detects that the client has violated the rule.
severity {Low | Medium | When rule violations are recorded in the attack log, each
High | Info} log message contains a Severity Level (severity_
level) field. Select which severity level the FortiWeb
appliance will use when it logs a violation of the rule:
l Low Medium
l Medium
l High
Note: This is not a single setting. You can configure the
severity separately for each signature category.
trigger "trigger-policy_ Enter the name of the trigger, if any, to apply when a No default.
name>" protection rule is violated. For details, see "log trigger-
policy" on page 101. The maximum length is 63
characters.
"<scoring-override- Enter the ID of a specific signature that will not be affected No default.
disable-list_signature- by the threat weight settings in a device reputation security
id_str>"
policy, if any. When traffic violates specified signature,
FortiWeb takes the local action specified for that signature.
scoring-grade {off | low Specify the threat weight that the signature adds to the No default.
| med | high | crit} combined threat weight in the selected device reputation
security policy.
<entry_index> Enter the index number of the individual entry in the table. The
valid range is 1–128. You can create up to 128 exceptions for No default.
each signature.
signature_id Enter the ID of a specific signature that you want to disable No default.
"<signature-id_str>" when the request matches the specified object.
match-target {HTTP_ Enter the type of object that FortiWeb examines for
METHOD | CLIENT_IP | matching values:
HOST | URI| FULL_URL |
PARAMETER| COOKIE} l HTTP_METHOD—One or more HTTP methods specified by
http-method {get post head options trace
connect delete put others patch} (page 469).
l CLIENT_IP—The IP address or IP range specified by ip
{<ipv4> | <ipv6>} (page 469).
value {"<value_str>" | Enter the value to match (for example, a Host: field
"<value_pattern>"} value). Whether the value is a literal value or a regular No default.
expression is determined by the value of operator.
concatenate-type {AND | l AND—A matching request matches this entry in addition to AND
OR} other entries in the list.
l OR—A matching request matches this entry or other entries in
the list.
Example
This example enables both the Trojans (070000000) and XSS (010000000) classes of signatures, setting them to
result in attack logs with a severity_level field of High, and using the email and SNMP settings defined in
notification-servers1. It also enables use of custom attack and data leak signatures in the set named
custom-signature-group1.
This example disables by ID a signature that is known to cause false positives (080200001). It also makes an
exception (config filter_list) by ID for a specific signature (070000001) for a URL (/virus-sample-
upload) on a host (www.example.com) that is used by security researchers to receive virus samples.
config waf signature
edit "attack-signatures1"
set custom-protection-group "custom-signature-group1"
config main_class_list
edit "010000000"
set severity High
set trigger "notification-servers1"
next
edit "070000000"
set severity High
set trigger "notification-servers1"
next
end
config signature_disable_list
edit "080200001"
next
end
config filter_list
edit 1
set signature_id "070000001"
set match-target HOST
set value "www.example.com"
next
edit 2
set signature_id "070000001"
set match-target URI
set value "/virus-sample-upload"
next
end
next
end
Related topics
l "waf web-protection-profile inline-protection" on page 518
l "waf web-protection-profile offline-protection" on page 531
l "system snmp community" on page 299
l "waf custom-protection-group" on page 368
l "log trigger-policy" on page 101
Use this command to create a pool of authentication server connections for use with a site publishing rule.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
config waf site-publish-helper authentication-server-pool
edit "<authentication-server-pool_name>"
edit <entry_index>
set server-type {ldap | radius}
set ldap-server "<ldap-query_name>"
set radius-server "<radius-query_name>"
set rsa-securid {enable | disable}
end
next
end
server-type {ldap | Set the server type to the server entry <entry_index>. Enter ldap
radius} ldap for a LDAP server or radius for a RADIUS server.
Set the name of the LDAP query to the server entry <entry_
ldap-server "<ldap-query_ No
name>" index> if you set the server entry as LDAP. For details, see "user
default.
ldap-user" on page 318.
radius-server "<radius- Set the name of the RADIUS query to the server entry <entry_ No
query_name>" index> if you set the server entry as RADIUS. For details, see default.
"user radius-user" on page 325.
Example
For an example, see "waf site-publish-helper rule" on page 475.
Related topics
l "waf site-publish-helper rule" on page 475
Use this command to group together web applications that you want to publish.z
Use this command to group together web applications that you want to publish.
Before you configure site publishing policies, you must first define the individual sites that will be a part of the group. For
details, see "waf site-publish-helper rule" on page 475.
To apply this policy, include it in an inline web protection profile. For details, see "waf web-protection-profile inline-
protection" on page 518.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf site-publish-helper policy
edit "<site-publish-policy_name>"
set account-lockout {enable | disable}
set max-login-failures <failures_int>
set account-block-period <account-block-period_int>
set within <within_int>
set credential-stuffing-protection {enable | disable}
set action {alert | alert_deny | block-period | deny_no_log}
set block-period <block_period_int>
set severity {high | medium | low | Info}
set trigger "<trigger_policy>"
config rule
edit <entry_index>
set rule-name "<site-publish-rule_name>"
next
end
next
end
account-lockout {enable | Enable to prevent account cracking by locking an account out after
disable
disable} several failures logging into FortiWeb.
max-login-failures Set the threshold of login failure. FortiWeb will trigger lockout to 5
<failures_int> the account if number of login failure exceeds the threshold during
the specified time period (within <within_int> (page 474)).
account-block-period Set the time period (in minutes) that FortiWeb locks out an account
<account-block-period_
60
for. No more login is accepted for the locked account during the
int> period.
within <within_int> Set the time period (in minutes) for FortiWeb counting the login 3
failures and judging lockout to accounts. Count of login failure of
an account will be reset when the time period is up.
credential-stuffing-
Enable to use FortiGuard's Credential Stuffing Defense database
protection {enable | disable
disable} to prevent against credential stuffing attacks.
You can customize the web page that returns to the client
with the HTTP status code.
trigger "<trigger_ Select the trigger policy, if any, to apply in the Site Publish policy. No
policy>" For details, see "log trigger-policy" on page 101. default.
<entry_index> Enter the index number of the individual entry in the table. The No
valid range is 1–9,999,999,999,999,999,999. default.
rule-name "<site-publish- No
rule_name>" Enter the name of an existing rule.
default.
Example
For an example, see "waf site-publish-helper rule" on page 475.
Related topics
l "waf site-publish-helper rule" on page 475
l "waf web-protection-profile inline-protection" on page 518
Use this command to configure access control, authentication, and, optionally, SSO for your web applications.
You may want to configure single sign-on (SSO) and combination access control and authentication (called “site
publishing” in the GUI) instead of configuring simple HTTP authentication rules if:
FortiWeb sends the client’s credentials in a query to the authentication server. Once the client is successfully
authenticated, if the web application supports HTTP authentication and you have configured delegation, FortiWeb
forwards the credentials to the web application. The server’s response is returned to the client. Until the session expires,
subsequent requests from the client to the same or other web applications in the same domain do not require the client
to authenticate..
For example, you may prefer SSO if you are using FortiWeb to replace your discontinued Microsoft Threat Management
Gateway, using it as a portal for multiple applications such as SharePoint, Outlook Web Application, and/or IIS. Your
users will only need to authenticate once while using those resources.
Before you configure site publishing, you must first define the queries to your authentication server. For details, see
"user ldap-user" on page 318 and "server-policy custom-application application-policy" on page 110.
l RADIUS authentication that requires users to provide a secondary password, PIN, or token code in addition to a username
and password (two-factor authentication)
l RADIUS authentication that allows users to authenticate using their username and RSA SecurID token code only (no
password)
l Regular Kerberos authentication delegation and Kerberos constrained delegation
For details about these options, see the descriptions of the individual site publishing rule settings and the FortiWeb
Administration Guide:
https://docs.fortinet.com/fortiweb/admin-guides
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf site-publish-helper rule
edit "<site-publish-rule_name>"
set status {enable | disable}
set req-type {plain | regular}
set saml-server "<server_name>"
set service-principal-name-pool "<pool_name>"
set published-site "<host_fqdn>"
set path "<url_str>"
set client-auth-method {html-form-auth | http-auth | client-cert-auth
| saml-auth}
set logoff-path-type {plain | regular}
set Published-Server-Logoff-Path "<url_str>"
set cookie-timeout <timeout_int>
set kerberos-type {krb5 | spnego}
set auth-server-pool "<authentication-server-pool_name>"
set auth-delegation {http-basic | kerberos | kerberos-constrained-
delegation | no-delegation | ntlm}
set field-name {subject | SAN}
set attribution-name {email | UPN}
set delegated-spn "<delegated-spn_str>"
set keytab-file <keytab_file>
set delegator-spn "<delegator-spn_str>"
set prefix-support {enable | disable}
set prefix-domain "<prefix-domain_str>"
set alert-type {all | fail | none | success}
set sso-support {enable | disable}
set sso-domain "<domain_str>"
set exchage-activesync {enable | disable}
next
end
"<site-publish-rule_ Enter the name of a new or existing rule. The maximum No default.
name>" length is 63 characters.
edit ?
service-principal-name- Select the SPN pool for the application that clients access No default.
pool "<pool_name>" using this site publish rule.
path "<url_str>" Enter the URL of the request for the web application, such as No default.
/owa. It must begin with a forward slash ( / ).
l The literal URL of the request that a client sends to log out of
the application (for example, /owa/auth/logoff.aspx .
l A regular expression that matches the request that a client
sends to log out of the application.
No default.
Ensure that the value is a sub-path of the path value. For
example, if path is /owa, /owa/auth/logoff.aspx
is a valid value.
cookie-timeout <timeout_ Specify the length of time (in minutes) that passes before 0
int> the cookie that the site publish rule adds expires and the
client must re-authenticate.
auth-server-pool Enter the name of the pool of servers that FortiWeb uses to
"<authentication-server- authenticate clients. For details, see "waf site-publish-helper No default.
pool_name>"
authentication-server-pool" on page 471.
l kerberos-constrained-delegation—After it
authenticates the client’s certificate, FortiWeb obtains a
Kerberos service ticket for the specified web application
on behalf of the client. It adds the ticket to the HTTP
Authorization: header of the client request with
Base64 encoding.
delegated-spn Specify the Service Principal Name (SPN) for the web
"<delegated-spn_str>" application that clients access using this site publish rule.
keytab-file <keytab_ Specify the keytab file configuration for the AD user that No default.
file> FortiWeb uses to obtain Kerberos service tickets for
clients. For details, see "waf site-publish-helper keytab_
file" on page 472.
delegator-spn Specify the Service Principal Name (SPN) that you used to
"<delegator-spn_str>" generate the keytab specified by keytab-file
<keytab_file> (page 481).
prefix-support {enable | Enable to allow users in environments that require users to enable
disable} log in using both a domain and username to log in with just
a username. Also specify prefix-domain
"<prefix-domain_str>" (page 482).
prefix-domain "<prefix- Enter a domain name that FortiWeb adds to the HTTP
domain_str>" Authorization: header before it forwards it to the web
application.
example, example.com).
sso-domain "<domain_ Enter the domain suffix of Host: names that will be allowed to No default.
str>" share this rule’s authentication sessions, such as
.example.com. Include the period ( . ) that precedes the
host’s name.
alert-type {all | fail | Specify which site publishing-related authentication events none
none | success} the FortiWeb appliance will log and/or send an alert email
about.
l all
l fail
l success
l none
Event log messages contain the user name,
authentication type, success or failure, and source address
(for example, User jdoe [Site Publish] login
successful from 172.0.2.5) when an end-user
successfully authenticates. A similar message is recorded
if the authentication fails (for example, User hackers
[Site Publish] login failed from
172.0.2.5).
Example
This example configures a site publisher with SSO for both Outlook and Sharepoint on the example.com domain.
config waf site-publish-helper authentication-server-pool
edit "LDAP server pool"
edit 1
set server-type ldap
set ldap-server "LDAP query 1"
end
next
end
config waf site-publish-helper authentication-server-pool
edit "RADIUS server pool"
edit 1
set server-type radius
set ldap-server "RADIUS query 1"
end
next
end
config waf site-publish-helper rule
edit "Outlook"
set published-site "^*\.example\.edu"
set auth-server-pool "LDAP server pool"
set auth-delegation http-basic
set sso-support enable
set sso-domain ".example.edu"
set path "/owa"
set alert-type fail
set Published-Server-Logoff-Path /owa/auth/logoff.aspx?Cmd=logoff
next
edit "Sharepoint"
Related topics
l "waf site-publish-helper policy" on page 473
l "waf site-publish-helper authentication-server-pool" on page 471
l "log trigger-policy" on page 101
l "server-policy allow-hosts" on page 108
l "waf web-protection-profile inline-protection" on page 518
waf start-pages
When a start page group is selected in the inline protection profile, HTTP clients must begin from a valid start page in
order to initiate a valid session.
For example, you may wish to specify that HTTP clients of an e-commerce website must begin their session from either
an item view or the first stage of the shopping cart checkout, and cannot begin a valid session from the third stage of the
shopping cart checkout.
To apply start pages, select them within an inline protection profile. For details, see "waf web-protection-profile inline-
protection" on page 518.
Before you configure a start page rule, if you want to apply it only to HTTP requests for a specific real or virtual host, you
must first define the web host in a protected hosts group. For details, see "server-policy allow-hosts" on page 108.
You can use SNMP traps to notify you when a start page rule is enforced. For details, see "system snmp community" on
page 299.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf start-pages
edit "<start-page-rule_name>"
set action {alert | alert_deny | block-period | redirect | send_403_
forbidden | deny_no_log}
set block-period <seconds_int>
set severity {Low | Medium | High | Info}
set trigger "<trigger-policy_name>"
config start-page-list
edit <entry_index>
set host "<protected-hosts_name>"
set host-status {enable | disable}
set request-file "<url_str>"
set request-type {plain | regular}
set default {yes | no}
next
end
next
end
severity {Low | Medium | Select the severity level to use in logs and reports generated when
Low
High | Info} a violation of the rule occurs.
trigger "<trigger-policy_ Enter the name of the trigger to apply when this rule is No
name>" violated. For details, see "log trigger-policy" on page 101. The default.
maximum length is 63 characters.
host "<protected-hosts_ Enter the name of a protected host that the Host: field of an No
name>" HTTP request must be in order to match the start page rule. default.
Enable to apply this start page rule only to HTTP requests for
specific web hosts. Also configure host "<protected-
host-status {enable | hosts_name>" (page 487). disable
disable}
Disable to match the start page rule based upon the other
criteria, such as the URL, but regardless of the Host: field.
default {yes | no} Enter yes to use the page as the default for HTTP requests no
that either:
Example
This example redirects clients to the default start page, /index.html, if clients request a page that is not one of the
valid start pages (/index.html or /cart/login.jsp). Redirection will occur only if the request is destined for one
of the virtual or real hosts defined in the protected hosts group named example_com_hosts.
config waf start-pages
edit "start-page-rule1"
edit 1
set host "example_com"
set host-status enable
set request-file "/index.html"
set default yes
next
edit 2
set host "example_com_hosts"
set host-status enable
set request-file "/cart/login.jsp"
set default no
next
next
end
Related topics
l "log trigger-policy" on page 101
l "server-policy allow-hosts" on page 108
l "waf web-protection-profile inline-protection" on page 518
l "system snmp community" on page 299
Use this command to configure a set of URL access rules that define HTTP requests that are allowed or denied.
Before using this command, you must first define your URL access rules. For details, see "waf url-access url-access-
rule" on page 490.
To apply URL access policies, select them within an inline or Offline Protection profile. For details, see "waf web-
protection-profile inline-protection" on page 518 or "waf web-protection-profile offline-protection" on page 531.
You can use SNMP traps to notify you when a URL access rule is enforced. For details, see "system snmp community"
on page 299.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf url-access url-access-policy
edit "<url-access-policy_name>"
config rule
edit <entry_index>
"<url-access-policy_ Enter the name of the new or existing URL access policy. The No
name>" maximum length is 63 characters. default.
Enter the index number of the individual entry in the table. The valid No
<entry_index>
range is 1–9,999,999,999,999,999,999. default.
url-access-rule-name Enter the name of the existing URL access rule to add to the policy. No
"<url-access-rule_name>" The maximum length is 63 characters. default.
Example
This example adds two rules to the policy, with the first one set to priority level 0, and the second one set to priority level
1. The rule with priority 0 would be applied first.
config waf url-access url-access-policy
edit "URL-access-set2"
config rule
edit 1
set url-access-rule-name "URL Access Rule 1"
next
edit 2
set url-access-rule-name "Blocked URL"
next
next
end
Related topics
l "waf url-access url-access-rule" on page 490
l "waf web-protection-profile inline-protection" on page 518
l "waf web-protection-profile offline-protection" on page 531
Use this command to configure URL access rules that define the HTTP requests that are allowed or denied based on
their host name and URL.
Typically, for example, access to administrative panels for your web application should only be allowed if the client’s
source IP address is an administrator’s computer on your private management network. Unauthenticated access from
unknown locations increases risk of compromise. Best practice dictates that such risk should be minimized.
To apply URL access rules, first group them within a URL access policy. For details see, "waf url-access url-access-
policy" on page 489.
You can use SNMP traps to notify you when a URL access rule is enforced. For details, see "system snmp community"
on page 299.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf url-access url-access-rule
edit "<url-access-rule_name>"
set action {alert_deny | continue | pass | deny_no_log}
set host "<protected-hosts_name>"
set host-status {enable | disable}
set severity {Informative | Low | Medium | High | Info}
set trigger "<trigger-policy_name>"
config match-condition
edit <entry_index>
set sip-address-check {enable | disable}
set sip-address-type {sip | sdomain | source-domain}
set sip-address-value "<client_ip>"
set sdomain-type {"<ipv4>" | "<ipv6>"}
set sip-address-domain "<fqdn_str>"
set source-domain-type {simple-string | regex-expression}
set source-domain "<source-domain_str>"
set type {regex-expression | simple-string}
set reg-exp "<object_pattern>"
set reverse-match {yes | no}
next
end
next
end
the client with the HTTP status code. For details, see
"system replacemsg" on page 294.
host "<protected-hosts_ Enter the name of a protected host that the Host: field of an No
name>" HTTP request must be in order to match the rule. The default.
maximum length is 255 characters.
Enable to require that the Host: field of the HTTP request match
host-status {enable |
disable} a protected hosts entry in order to match the rule. Also configure disable
host "<protected-hosts_name>" (page 492).
severity {Informative When rule violations are recorded in the attack log, each log Low
| Low | Medium | High | message contains a Severity Level (severity_level)
Info}
field. Select which severity level the FortiWeb appliance will
use when a blacklisted IP address attempts to connect to your
web servers:
l Informative
l Low
l Medium
l High
l Info
<entry_index> Enter the index number of the individual entry in the table. The No
valid range is 1–9,999,999,999,999,999,999. default.
sdomain-type {"<ipv4>" | Specifies the type of IP address FortiWeb retrieves from the No
"<ipv6>"} DNS lookup of the domain specified by sip-address- default.
domain "<fqdn_str>" (page 494).
reg-exp "<object_ For example, for the URL access rule to match all URLs that No
pattern>" begin with /wordpress, you could enter ^/wordpress, default.
then, for reverse-match, enter no.
Example
This example defines two sets of URL access rules.
The first set, Blocked URL, defines two URL match conditions: one uses a simple string to match an administrative
page, and the other uses a regular expression to match a set of dynamic URLs for statistics pages.
The second set, Allowed URL, defines a single match condition that uses a regular expression to match all dynamic
forms of the index page.
Actual blocking or allowing of the URLs, however, would not occur until a policy applies these URL access rules, and
sets an action that the FortiWeb appliance will perform when an HTTP request matches either rule set.
config waf url-access url-access-rule
edit "Blocked URL"
config match-condition
edit 1
set type simple-string
set reg-exp "/admin.php"
next
edit 2
set type regular-expression
set reverse-match no
set reg-exp "statistics.php*"
next
end
next
edit "Allowed URL"
config match-condition
edit 1
set type regular-expression
set reverse-match no
set reg-exp "index.php*"
next
end
next
end
Related topics
l "waf web-protection-profile inline-protection" on page 518
l "waf web-protection-profile offline-protection" on page 531
Before you can configure a URL rewrite group, you must first configure any URL rewriting rules that you want to include.
For details, see "waf url-rewrite url-rewrite-rule" on page 497.
To apply a URL rewriting group, select it in an inline protection profile. For details, see "waf web-protection-profile inline-
protection" on page 518.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf url-rewrite url-rewrite-policy
edit "<url-rewrite-group_name>"
config rule
edit <entry_index>
set url-rewrite-rule-name "<url-rewrite-rule_name>"
next
end
next
end
"<url-rewrite-group_ Enter the name of the URL rewriting rule group. The maximum No
name>" length is 63 characters. default.
Enter the index number of the individual entry in the table. The valid No
<entry_index>
range is 1–9,999,999,999,999,999,999. default.
url-rewrite-rule-name Enter the name of an existing URL rewriting rule that you want to No
"<url-rewrite-rule_name>" include in the group. The maximum length is 63 characters. default.
Related topics
l "waf url-rewrite url-rewrite-rule" on page 497
l "waf web-protection-profile inline-protection" on page 518
Rewriting or redirecting HTTP requests and responses is popular, and can be done for many reasons.
Similar to error message cloaking, URL rewriting can prevent the disclosure of underlying technology or website
structures to HTTP clients.
For example, when visiting a blog web page, its URL might be:
http://www.example.com/wordpress/?feed=rss2
Simply knowing the file name, that the blog uses PHP, its compatible database types, and the names of parameters via
the URL could help an attacker to craft an appropriate attack for that platform. By rewriting the URL to something more
human-readable and less platform-specific, the details can be hidden:
http://www.example.com/rss2
Aside from for security, rewriting and redirects can be for aesthetics or business reasons. Financial institutions can
transparently redirect customers that accidentally request HTTP:
http://bank.example.com/login
Rewrites/redirects are not supported in all modes. For details, see the FortiWeb
Administration Guide:
https://docs.fortinet.com/fortiweb/admin-guides
To use a URL rewriting rule, add it to a policy. For details, see "waf url-rewrite url-rewrite-policy" on page 496.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf url-rewrite url-rewrite-rule
edit "<url-rewrite-rule_name>"
set action {403-forbidden | redirect | redirect-301 | http-body-rewrite |
http-header-rewrite | location-rewrite}
set header-name "<header-name_str>"
set header-status {enable | disable}
set header-value "<header-value_str>"
set host {<server_fqdn> | <server_ipv4> | <host_pattern>}
set host-status {enable | disable}
set host-use-pserver {enable | disable}
set url "<replacement-url_str>"
set url-status {enable | disable}
set location "<location_str>"
set location_replace "<location_str>"
set referer-status {enable | disable}
set referer "<referer-url_str>"
set referer-use-pserver {enable | disable}
set body_replace "<replacement_str>"
config match-condition
edit <entry_index>
set content-filter {enable | disable}
set content-type-set {text/html text/plain text/javascript
application/xml(or)text/xml application/javascript
application/soap+xml application/x-javascript}
set HTTP-protocol {http | https}
set is-essential {yes | no}
set object {http-host | http-reference | http-url}
set protocol-filter {enable | disable}
set reg-exp "<object_pattern>"
set reverse-match {yes | no}
next
end
next
end
header-name "<header- Enter the name of the header field that you want to insert to a No
name_str>" request, such as "Myheader." default.
header-status {enable | Enable to insert the specified header and value to the matched
disable} HTTP requests. Specifies the header name and header value
through header-name "<header-name_str>" (page 499) disable
and header-value "<header-value_str>" (page 499),
respectively.
header-value "<header- Enter the value of the header field that you specified in header- No
value_str>" name "<header-name_str>" (page 499), such as "123." default.
Then, the customized header Myheader: 123 will be inserted to
the matched HTTP requests.
(a)(b)(c(d))(e)
(f)
l $0—a
l $1—b
l $2—cd
l $3—d
l $4—e
l $5—f
host-status {enable | Enable to rewrite the Host: field or host name part of the disable
disable} Referer: field.
host-use-pserver Enable this when you have a server farm for server balance or
{enable | disable} content routing. In this case you do not know which server in
the server farm the FortiWeb appliance will use. When
FortiWeb processes the request, it sets the value for the
actual host.
url "<replacement-url_ Enter the string, such as /catalog/item1, that will replace No
str>" the request URL. The maximum length is 255 characters. default.
https://docs.fortinet.com/fortiweb/admin-guides
location "<location_str>" Enter the replacement value for the Location: field in the No
HTTP header for the 302 response. The maximum length is default.
255 characters.
location_replace Enter the URL string that provides a location for use in a 302
"<location_str>" HTTP redirect response from a web server connected to
FortiWeb. The maximum length is 255 characters.
referer-status {enable | Enable to rewrite the Referer: field in the HTML header. Also disable
disable} configure referer "<referer-url_str>" (page 501) and
referer-use-pserver {enable | disable} (page 502).
referer "<referer-url_ Enter the replacement value for the Referer: field in the
str>" HTML header. The maximum length is 255 characters. No
This option is available only when referer-status default.
{enable | disable} (page 501) is enabled.
referer-use-pserver Enable this when you have a server farm for server balance or disable
{enable | disable} content routing. In this case you do not know which server in
the server farm the FortiWeb appliance will use. When
FortiWeb processes the request, it sets the value for the
actual referrer.
body_replace Enter the value that will replace matching HTTP content in the
"<replacement_str>" body of responses. The maximum is 255 characters.
https://docs.fortinet.com/fortiweb/admin-guides No
This option is available only when action {403- default.
forbidden | redirect | redirect-301 | http-
body-rewrite | http-header-rewrite |
location-rewrite} (page 498) is http-body-
rewrite.
<entry_index> Enter the index number of the individual entry in the table. The No
valid range is 1–9,999,999,999,999,999,999. default.
content-filter {enable | Enable if you want to match this condition only for specific HTTP
disable} content types (also called Internet or MIME file types) such as
text/html, as indicated in the Content-Type: HTTP header.
Also configure content-type-set {text/html
disable
text/plain text/javascript application/xml
(or)text/xml application/javascript
application/soap+xml application/x-javascript}
(page 502).
content-type-set Enter the HTTP content types that you want to match in a No
{text/html text/plain space-delimited list, such as: default.
text/javascript
application/xml set content-type-set text/html text/plain
(or)text/xml
application/javascript
application/soap+xml
application/x-javascript}
HTTP-protocol {http | Select which protocol will match this condition, either HTTP or
https} http
HTTPS.
is-essential {yes | no} Select what to do if there is no Referer: field, either: yes
object {http-host | http- Select which part of the HTTP request to test for a match:
reference | http-url}
l http-host
l http-url
l http-reference (the Referer: field) http-
host
If the request must match multiple conditions (for example, it
must contain both a matching Host: field and a matching
URL), add each object match condition to the condition table
separately.
protocol-filter {enable | Enable if you want to match this condition only for either disable
disable} HTTP or HTTPS. Also configure HTTP-protocol
{http | https} (page 502).
For example, for the URL rewriting rule to match all URLs that
begin with /wordpress, you could enter ^/wordpress,
then, in reverse-match {yes | no}, select no.
l no—If the regular expression does match the request object, the
condition is met.
l yes—If the regular expression does not match the request
object, the condition is met.
The effect is equivalent to preceding a regular expression with an
exclamation point ( ! ).
If all conditions are met, the FortiWeb appliance will do your
selected action {403-forbidden | redirect |
redirect-301 | http-body-rewrite | http-
header-rewrite | location-rewrite} (page 498).
Related topics
l "waf url-rewrite url-rewrite-policy" on page 496
Use this command to group user tracking rules, which track sessions by user and capture a username to reference in
traffic and attack log messages.
Before you configure a user-tracking policy, define the rules to add. For details, see "waf user-tracking rule" on page
505.
To apply a user tracking policy, you select it in an inline or Offline Protection profile. For details, see "waf web-
protection-profile inline-protection" on page 518 and "waf web-protection-profile offline-protection" on page 531.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf user-tracking policy
edit "<user-tracking-policy_name>"
config input-rule-list
edit <entry_index>
set input-rule "<input-rule_name>"
next
end
next
end
Enter the index number of the individual entry in the table. The valid No
<entry_index>
range is 1–9,999,999,999,999,999,999. default.
Use this command to configure FortiWeb to track sessions by user and capture a username to reference in traffic and
attack log messages.
When FortiWeb detects users that match the criteria that you specify in a user tracking policy, it stores the session ID
and username.
To apply a user tracking rule, add it to a user tracking policy that you can select in an inline or Offline Protection profile.
For details, see "waf user-tracking policy" on page 504.
You can apply a user tracking policy using either an inline or Offline Protection profile. However, in Offline Protection
mode, session-fixation-protection, session-timeout-enforcement, and the deny, redirect and
period block actions are not supported.
You can also use the user tracking feature to create a filter in a custom rule that matches specific users. This type of
custom rule requires you to create a user tracking policy and apply it to the protection profile that uses the custom rule.
For details, see "waf custom-access rule" on page 356.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf user-tracking rule
edit "<rule_name>"
set hostname-ip "<hostname-ip_str>"
set host-status { enable | disable}
set authentication-url "<url_str>"
set username-parameter "<username_str>"
"<rule_name>" Enter a name that identifies the rule. You will use this name No
to reference the rule in other parts of the configuration. The default.
maximum length is 63 characters.
hostname-ip "<hostname- No
ip_str>" default.
host-status { enable | No
disable} default.
session-id-name Enter the name of the session ID that is used to identify each No
"<session-id_str>" session. default.
session-timeout <timeout_ Enter the length of time in minutes that FortiWeb waits before 30
int> it stops tracking an inactive user session.
session-frozen-severity When the session timeout settings generate an attack log, Low
{High | Medium | Low | each log message contains a Severity Level (severity_
Info}
level) field. Select which severity level FortiWeb uses when
it takes the specified action:
l Low
l Medium
l High
Available only when session-timeout-enforcement
{enable | disable} (page 507) or credential-
stuffing-protection {enable | disable} (page
509) is set to enable.
default-action {failed | Enter the authentication result that FortiWeb associates with failed
success} requests that match the criteria but do not match an entry in
the Authentication Result Condition Table.
<entry_index> Enter the index number of the individual entry in the table. No
default.
HTTP-match-target Select the location of the value to match with the string or return-
{return-code | response- regular expression specified in this table item: return- code
body | redirect-url}
code, response-body, redirect-url.
Example
This example matches requests from clients using the URL /login2 with the parameters user and pass and a
session ID specified by jsessionid. FortiWeb tracks matching sessions by user and stops tracking if the client logs
out using the URL /logout2.
FortiWeb tracks only requests with the return code 200, which it classifies as successful. It does not track requests with
a response body that matches the regular expression deny. In addition, because the rule uses the default value for the
default authentication result, it does not track requests that do not match an item in the list of match conditions.
The rule enables both session fixation protection and session timeout enforcement for tracked sessions. If a session is
idle longer than the default session timeout, FortiWeb blocks requests from clients that use the session ID that has
timed out for the default period block time. It performs this action for 30 minutes after the session times out (the default
session freeze time).
config waf user-tracking
edit "rule1"
set authentication-url "/login2"
set username-parameter user
set password-parameter pass
set session-id-name "jsessionid"
set logoff-path "/logout2"
set session-fixation-protection enable
set timeout-enforcement enable
set session-frozen-action period-block
Related topics
l "server-policy allow-hosts" on page 108
l "waf web-protection-profile inline-protection" on page 518
l "waf web-protection-profile offline-protection" on page 531
waf web-cache-exception
Use this command to configure FortiWeb to cache responses from your servers.
Use web-cache-exception to cache all URLs except for a few. To cache only a few URLs, see "waf web-cache-
policy" on page 513.
To apply this policy, include it in an inline protection profile. For details, see "waf web-protection-profile inline-
protection" on page 518.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf web-cache-exception
edit "<web-cache-exception_rule_name>"
config exception-list
edit <entry_index>
set host-status {enable | disable}
set host "<host_str>"
set url-type {plain | regular}
set url-patten "<url-pattern_str>"
set cookie-name "<cookie-name_str>"
end
next
end
host-status {enable | Specify enable to require that the Host: field of the HTTP disable
disable} request match a protected host names entry in order to match
the exception. Also specify a value for host.
url-type {plain | Specify the type of value that is used for url-patten plain
regular} "<url-pattern_str>" (page 512):
Related topics
l "waf web-cache-policy" on page 513
l "waf web-protection-profile inline-protection" on page 518
waf web-cache-policy
Use this command to configure FortiWeb to cache responses from your servers.
Use web-cache-policy to cache only a few URLs. To cache all URLs except for a few, see config waf web-
cache-exception (page 511).
To apply this policy, include it in an inline protection profile. For details, see config waf web-protection-
profile inline-protection (page 518).
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf web-cache-policy
edit "<web-cache-policy_rule_name>"
set cache-buffer-size <cache-size_int>
set max-cached-page size <page-size_int>
set default-cache-timeout <cache-timeout_int>
set exception "<web-cache-exception_name>"
config url-match-list
edit <entry_index>
set host-status {enable | disable}
set host "<host_str>"
set url-type {plain | regular}
set url-pattern "<url-pattern_str>"
end
next
end
max-cached-page size Specify the maximum size of each URL that FortiWeb 2048
<page-size_int> caches, in kilobytes (KB). FortiWeb does not cache objects
such as high-resolution images, movies, or music that are
larger than this value.
Specify the time to live for each entry in the cache. FortiWeb
removes expired entries.
host-status {enable | Specify enable to require that the Host: field of the HTTP disable
disable} request match a protected host names entry in order to match
the policy. Also specify a value for host "<host_str>"
(page 515).
url-type {plain | Specify the type of value that is used for url-pattern plain
regular} "<url-pattern_str>" (page 515):
Related topics
l "waf web-cache-exception" on page 511
l "waf web-protection-profile inline-protection" on page 518
Auto-learning profiles are useful when you want to collect information about the HTTP sessions on your unique network
in order to design inline or Offline Protection profiles suited for them. This reduces much of the research and guesswork
about what HTTP request methods, data types, and other types of content that your websites and web applications use
when designing an appropriate defense.
Auto-learning profiles track your web servers’ response to each request, such as 401 Unauthorized or
500 Internal Server Error, to learn about whether the request is legitimate or a potential attack attempt. Such
data is used for auto-learning reports, and can serve as the basis for generating inline protection or Offline Protection
profiles.
Auto-learning profiles are designed to be used in conjunction with a protection or detection profile, which is used to
detect attacks. Only if attacks are detected can the auto-learning profile accumulate auto-learning data and generate its
report. As a result, auto-learning profiles require that you also select a protection or detection profile in the same policy.
To apply auto-learning profiles, select them within a policy. For details, see "waf web-protection-profile offline-
protection" on page 531. Once applied in a policy, the FortiWeb appliance will collect data and generate a report from it.
For details, see the FortiWeb Administration Guide:
https://docs.fortinet.com/fortiweb/admin-guides
Before configuring an auto-learning profile, first configure any of the following that you want to include in the profile:
You must also disable any globally whitelisted objects. These will be exempt from scans and autolearning data. For
details, see "server-policy pattern custom-global-white-list-group" on page 128.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
learngrp area. For details, see "Permissions" on page 51.
Syntax
config waf web-protection-profile autolearning-profile
edit "<auto-learning-profile_name>"
set data-type-group "<data-type-group_name>"
set suspicious-url-rule "<suspicious-url-rule-group_name>"
set attack-count-threshold <count_int>
set attack-percent-range <percent_int>
set application-policy "<policy_name>"
next
end
Enter the name of the data type group for the profile to use.
The maximum length is 63 characters. For details, see "server-
policy pattern data-type-group" on page 132.
suspicious-url-rule Enter the name of a suspicious URL rule group to use. The No
"<suspicious-url-rule- maximum length is 63 characters. For details, see "server- default.
group_name>"
policy pattern suspicious-url-rule" on page 137.
Related topics
l "server-policy pattern custom-global-white-list-group" on page 128
l "server-policy pattern data-type-group" on page 132
l "server-policy pattern suspicious-url-rule" on page 137
l "waf web-protection-profile inline-protection" on page 518
l "server-policy policy" on page 146
l "system settings" on page 296
Inline protection profiles are a set of attack protection settings. The FortiWeb appliance applies the profile when a
connection matches a server policy that includes the protection profile. You can use inline protection profiles in server
policies for any mode except Offline Protection.
To apply protection profiles, select them within a server policy. For details, see "server-policy policy" on page 146.
Before configuring an inline protection profile, first configure any of the following that you want to include in the profile:
Syntax
config waf web-protection-profile inline-protection
edit "<inline-protection-profile_name>"
set http-session-management {enable | disable}
set http-session-timeout <seconds_int>
set x-forwarded-for-rule "<x-forwarded-for_name>"
set signature-rule {"High Level Security" | "Medium Level Security" | "Alert
Only" | <signature-set_name>}
set amf3-protocol-detection {enable | disable}
set xml-protocol-detection {enable | disable}
set malformed-xml-check {enable | disable}
set malformed-xml-check-action {alert | alert_deny | block-period}
set malformed-xml-block-period <block-period_int>
set malformed-xml-check-severity {High | Low | Medium}
set malformed-xml-check-trigger "<trigger-policy_name>"
set json-protocol-detection {enable | disable}
set malformed-json-check {enable | disable}
set malformed-json-check-action {alert | alert_deny | block-period}
set malformed-json-block-period <block-period_int>
set malformed-json-check-severity {High | Medium | Low}
next
end
"<inline-protection- Enter the name of the inline protection profile. The maximum No
profile_name>" length is 63 characters. default.
http-session-timeout Enter the HTTP session timeout in seconds. The valid range 1200
<seconds_int> is 20–3,600.
x-forwarded-for-rule "<x- Specify the name of a rule that configures FortiWeb’s use of No
forwarded-for_name>" X-Forwarded-For: and X-Real-IP. The maximum length is 63 default.
xml-protocol-detection Enable to scan for matches with attack and data leak disable
{enable | disable} signatures in Web 2.0 (XML AJAX) and other XML submitted
by clients in the bodies of HTTP POST requests.
malformed-xml-check- Specify the action that FortiWeb takes when it detects a alert
action {alert | alert_ request that contains malformed XML:
deny | block-period}
l alert—Accept the request and generate an alert email, a log
message, or both.
l alert_deny—Block the request and generate an alert email, a
log message, or both.
l block-period—Block the XML traffic for a number of
seconds. Also configure malformed-xml-block-period
<block-period_int> (page 523).
malformed-xml-check- Select the severity level to use in logs and reports generated High
severity {High | Low | when illegal XML formats are detected.
Medium}
json-protocol-detection Enter enable to scan for matches with attack and data leak disable
{enable | disable} signatures in JSON data submitted by clients in HTTP
requests with Content-Type: values
application/json or text/json.
malformed-json-check
{enable | disable} Enter enable to scan for illegal formatting in JSON data. disable
malformed-json-check- Select the severity level to use in logs and reports that High
severity {High | Medium | FortiWeb generates when it detects malformed JSON
Low}
content.
csrf-protection "<rule_ Select the name of cross-site request forgery protection rule, if No
name>" any, to apply to matching requests. For details, see "waf csrf- default.
protection" on page 351.
Enter the name of a hidden field rule group that you want to
apply, if any. The maximum length is 63 characters. For
hidden-fields-protection details, see "waf hidden-fields-protection" on page 398. No
"<group_name>" default.
To display the list of existing groups, enter:
set hidden-fields-protection ?
file-upload-policy Enter the name of a file upload security policy to use, if any. No
"<policy_name>" The maximum length is 63 characters. For details, see default.
"server-policy custom-application application-policy" on page
110.
brute-force-login Enter the name of a brute force login attack sensor. The No
"<sensor_name>" maximum length is 63 characters. For details, see "waf brute- default.
force-login" on page 344.
page-access-rule "<rule_ Enter the name of a page order rule. The maximum length is No
name>" 63 characters. For details, see "waf page-access-rule" on default.
page 457.
set page-access-rule ?
ip-intelligence {enable | Enable to apply intelligence about the reputation of the disable
disable} client’s source IP. Blocking and logging behavior is configured
in "waf ip-intelligence" on page 429.
protected systems.
quarantined-ip-trigger Enter the name of the trigger to apply when FortiWeb detects No
"<trigger-policy_name>" a quarantined IP. For deails, see "log trigger-policy" on page default.
101.
url-rewrite-policy Enter the name of a URL rewriting rule set, if any, that will be No
"<group_name>" applied to matching HTTP requests. The maximum length is default.
63 characters.
web-cache-policy "<web- Enter the name of content caching policy. The maximum No
cache-policy_name>" length is 63 characters. For details, see "waf web-cache- default.
policy" on page 513.
redirect-url "<redirect_ Enter a URL, including the FQDN/IP and path, if any, to which No
fqdn>" an HTTP client will be redirected if their HTTP request default.
violates any of the rules in this profile.
rdt-reason {enable | The FortiWeb appliance also adds fortiwaf=1 to the URL No
disable} to detect and cancel a redirect loop when the redirect action default.
recursively triggers an attack event.
data-analysis {enable | Enable this to collect data for servers covered by this profile. disable
disable} To view the statistics for collected data, in the web UI, go to
Log&Report > Monitor > Data Analytics.
device-tracking {enable Enter to enable Device Tracking. When this feature is disable
| disable} enabled, if a device triggers a security violation, FortiWeb
generates a unique device ID according to a set of the
device's characteristics, including the time zone, source IP,
operating system, browser, language, CPU, color depth, and
screen size. For details, see "system device-tracking" on page
241.
profile-id "<profile-id_ No
str>" Enter the inline profile ID.
default.
openapi-validation-policy
No
"<openapi-validation- Enter the openapi validation policy name.
policy_name>" default.
Related topics
l "log trigger-policy" on page 101
l "server-policy pattern custom-global-white-list-group" on page 128
l "server-policy policy" on page 146
l "waf signature" on page 462
l "waf start-pages" on page 485
l "waf padding-oracle" on page 453
l "waf page-access-rule" on page 457
l "waf parameter-validation-rule" on page 461
l "waf http-protocol-parameter-restriction" on page 418
l "waf url-access url-access-policy" on page 489
l "waf allow-method-exceptions" on page 337
l "waf application-layer-dos-prevention" on page 341
l "waf file-compress-rule" on page 380
l "waf file-uncompress-rule" on page 382
l "waf brute-force-login" on page 344
l "waf geo-block-list" on page 395
l "waf hidden-fields-protection" on page 398
l "waf http-authen http-authen-policy" on page 403
l "waf http-protocol-parameter-restriction" on page 418
l "waf ip-intelligence" on page 429
l "server-policy custom-application application-policy" on page 110
l "waf web-cache-exception" on page 511
l "waf web-cache-policy" on page 513
l "system device-tracking" on page 241
Detection profiles are useful when you want to preview the effects of some web protection features without affecting
traffic, or without affecting your network topology.
Unlike protection profiles, a detection profile is designed for use in Offline Protection mode. Detection profiles cannot be
guaranteed to block attacks. They attempt to reset the connection, but due to variable speeds of different routing paths,
the reset request may arrive after the attack has been completed. Their primary purpose is to detect attacks, especially
for use in conjunction with auto-learning profiles. In fact, if used in conjunction with auto-learning profiles, you should
configure the detection profile to log only and not block attacks in order to gather complete session statistics for the
auto-learning feature. As a result, detection profiles can only be selected in policies whose deployment-mode is
offline-detection, and those policies will only be used by the FortiWeb appliance when its operation mode is
offline-detection.
Unlike inline protection profiles, Offline Protection profiles do not support HTTP conversion, cookie poisoning detection,
start page rules, and page access rules.
To apply detection profiles, select them within a server policy. For details, see "server-policy policy" on page 146.
Before configuring an Offline Protection profile, first configure any of the following that you want to include in the profile:
Syntax
config waf web-protection-profile offline-protection
edit "<offline-protection-profile_name>"
set http-session-management {enable | disable}
set http-session-timeout <seconds_int>
set x-forwarded-for-rule "<x-forwarded-for_name>"
set http-session-keyword "<key_str>"
set signature-rule {"High Level Security" | "Medium Level Security" | "Alert
Only" | "<signature-set_name>"}
set amf3-protocol-detection {enable | disable}
set xml-protocol-detection {enable | disable}
set malformed-xml-check {enable | disable}
set malformed-xml-check-action {alert | alert_deny | block-period}
set malformed-xml-block-period <block-period_int>
set malformed-xml-check-severity {High | Low | Medium}
set malformed-xml-check-trigger "<trigger-policy_name>"
set json-protocol-detection {enable | disable}
set malformed-json-check {enable | disable}
set malformed-json-check-action {alert | alert_deny | block-period}
set malformed-json-block-period <block-period_int>
set malformed-json-check-severity {High | Medium | Low}
set malformed-json-check-trigger "<trigger-policy_name>"
set custom-access-policy "<combo-access_name>"
set padding-oracle "<rule_name>"
set parameter-validation-rule "<rule_name>"
set hidden-fields-protection "<group_name>"
set file-upload-policy "<policy_name>"
set http-protocol-parameter-restriction "<constraint_name>"
set url-access-policy "<policy_name>"
http-session-timeout Enter the HTTP session timeout in seconds. The valid range 1200
<seconds_int> is 20–3,600.
amf3-protocol-detection Enable to scan requests that use the action message format disable
{enable | disable} 3.0 (AMF3) for these attacks if you have enabled those in the
set of signatures specified by signature-rule {"High
Level Security" | "Medium Level
Security" | "Alert Only" | "<signature-
set_name>"} (page 534):
malformed-xml-check Enable to validate that XML elements and attributes in the disable
{enable | disable} request’s body conforms to the W3C XML 1.1
(http://www.w3.org/TR/xml11) and/or XML 2.0
(http://www.w3.org/TR/xml-c14n2) standards. Malformed
XML, such as without the final > or with multiple >> in the
closing tag, is often an attempt to exploit an unhandled error
condition in a web application’s XHTML or XML parser.
malformed-xml-block- Enter the length of time (in seconds) that FortiWeb blocks 60
period <block-period_int> XML traffic that contains malformed XML, in seconds.
malformed-xml-check-
Select the severity level to use in logs and reports generated
severity {High | Low | High
Medium} when illegal XML formats are detected.
malformed-xml-check- Enter the name of the trigger to apply when illegal XML No
trigger "<trigger-policy_ formats are detected. The maximum length is 63 characters. default.
name>"
For details, see "log trigger-policy" on page 101.
set trigger ?
malformed-json-block- Enter the length of time (in seconds) that FortiWeb blocks 60
period <block-period_int> traffic that contains malformed JSON content.
malformed-json-check- Select the severity level to use in logs and reports that
severity {High | Medium | FortiWeb generates when it detects malformed JSON High
Low} content.
malformed-json-check- Enter the name of the trigger to apply when FortiWeb detects No
trigger "<trigger-policy_ malformed JSON content. The maximum length is 63 default.
name>"
characters.
padding-oracle "<rule_ Enter the name of a padding oracle protection rule. The No
name>" maximum length is 63 characters. For details, see "waf default.
padding-oracle" on page 453.
hidden-fields-protection Enter the name of a hidden field rule group that you want to No
"<group_name>" apply, if any. The maximum length is 63 characters. For default.
details, see "waf hidden-fields-protection" on page 398.
http-protocol-parameter- Enter the name of an HTTP protocol constraint that you want No
restriction "<constraint_ to apply, if any. The maximum length is 63 characters. For default.
name>"
details, see "waf http-protocol-parameter-restriction" on page
418.
ip-intelligence {enable | Enable to apply intelligence about the reputation of the disable
disable} client’s source IP. Blocking and logging behavior is configured
in "waf ip-intelligence" on page 429.
openapi-validation-
policy "<openapi- No
Enter the openapi validation policy name.
validation-policy_ default.
name>"
Related topics
l "server-policy policy" on page 146
l "waf signature" on page 462
l "waf padding-oracle" on page 453
l "waf parameter-validation-rule" on page 461
l "waf url-access url-access-rule" on page 490
l "waf allow-method-exceptions" on page 337
l "system settings" on page 296
l "waf file-uncompress-rule" on page 382
l "waf brute-force-login" on page 344
l "waf geo-block-list" on page 395
l "waf hidden-fields-protection" on page 398
l "waf http-protocol-parameter-restriction" on page 418
l "waf ip-intelligence" on page 429
l "server-policy custom-application application-policy" on page 110
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf websocket-security rule
edit websocket-security_rule_name
set host-status {enable | disable}
set host <host_str>
set url-type {plain | regular}
set url <url_str>
set block-websocket-traffic {enable | disable}
set action {alert | deny_no_log | alert_deny}
set max-frame-size <max-frame-size_int>
set max-message-size <max-message-size_int>
set block-extensions {enable | disable}
set enable-attack-signatures {enable | disable}
set allow-plain-text {enable | disable}
set allow-binary-text {enable | disable}
config allowed-origin-list
edit allowed-origin-list <allowed-origin-list_id>
set origin <origin_str>
end
host-status {enable Enable to compare the WebSocket security rule to the Host:
| disable} No default.
field in the HTTP header.
host <host_str> Select the IP address or fully qualified domain name (FQDN) of No default.
the protected host to which this rule applies.
This option is available only if Host Status is enabled.
Select whether the URL Pattern field will contain a literal URL
url-type {plain
| regular} (Simple String), or a regular expression designed to match Plain
multiple URLs (Regular Expression).
url <url_str> The URL which hosts the web page containing the user input No default.
fields you want to protect.
action {alert | deny_no_ Select which action the FortiWeb appliance will take when it Alert
log | alert_deny} detects a violation.
Alert—Accept the connection and generate an alert email and/or
log message.
Alert & Deny—Block the request (or reset the connection) and
generate an alert and/or log message.
Deny (no log)—Block the request (or reset the connection).
max-frame-size <max- Specifies the maximum acceptable frame header and body size
64
frame-size_int> in bytes. The valid range is 0–2147483647 bytes.
max-message-size <max- Specifies the maximum acceptable message header and body 1024
message-size_int> size in bytes. The valid range is 0–2147483647 bytes.
allow-plain-text {enable
| disable} Enable to allow detecting the plain text. Enable
allowed-origin-list
<allowed-origin-list_id> Enter the origin list ID in WebSocket handshake packet. No default.
origin <origin_str>
Related topics
l "waf http-constraints-exceptions" on page 410
l "waf http-protocol-parameter-restriction" on page 418
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf websocket-security policy
edit "<"<policy_name>"
config rule-list
edit rule-list_id
set rule "<rule_name>"
end
rule-list_id Enter the sequence number of the rule in the rule list.
rule "<rule_name>" Select the created WebSocket security rule name. No default.
Related topics
l waf websocket-security rule
waf x-forwarded-for
For behavior of this feature and requirements, see the FortiWeb Administration Guide:
https://docs.fortinet.com/fortiweb/admin-guides
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf x-forwarded-for
edit "<x-forwarded-for_name>"
set block-based-on-original-ip {enable | disable}
set ip-location {left | right}
set original-ip-header "<http-header-key_str>"
set tracing-original-ip {enable | disable}
set x-forwarded-proto {enable | disable}
set x-forwarded-for-support {enable | disable}
set x-real-ip {enable | disable}
config ip-list
edit <entry_index>
set ip "<load-balancer_ip>"
next
end
next
end
"<x-forwarded-for_name>" Enter the name of the new or existing group. The maximum No
length is 63 characters. default.
ip-location {left | Select whether to extract the original client’s IP from either left
right} the left or right end of the HTTP X-header line.
Most proxies put the request’s origin at the left end, which is
the default setting. Some proxies, however, place it on the
right end.
x-forwarded-proto Enable to add an HTTP header that indicates the service used disable
{enable | disable} in the client’s original request.
Example
The following example defines a X-Forwarded-For rule that adds X-Forwarded-For:, X-Real-IP:, and X-
Forwarded-Proto: headers to traffic that FortiWeb forwards to a back-end server. It enables FortiWeb to use the
HTTP X-Header to identify and block the original client's IP. To protect against XFF spoofing, it also specifies the
trusted load-balancer 192.0.2.105 in the X-Forwarded-For IP list.
config waf x-forwarded-for
edit "load-balancer1"
set x-forwarded-for-support enable
set tracing-original-ip enable
set original-ip-header X-FORWARDED-FOR
set x-real-ip enable
set x-forwarded-proto enable
config ip-list
edit 1
set ip "192.0.2.105"
next
end
set block-based-on-original-ip enable
next
end
waf xml-schema
Use this command to view XML schema files that have already been uploaded to FortiWeb. You can upload
XML schema files only in the web UI.
XML schema files specify the acceptable structure of an elements in an XML document. When you use XML schema
files to check XML content in HTTP requests, FortiWeb can determine whether content is allowed and validate that
content is well-formed.
XML schema files are included in XML protection rules. XML protection rules define acceptable parameters for XML
content in HTTP requests. Groups of XML protection rules are grouped into XML protection policies. For details, see
"waf xml-validation" on page 546.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf xml-schema file
edit "<xml_schema_file_name>"
end
Related topics
l "waf xml-validation" on page 546
waf xml-validation
Use this command to create XML protection rules and configure XML protection policies. You can create up to 256 rules
per policy.
XML is commonly used for data exchange, and hackers sometimes try to exploit security holes in XML to attack web
servers. Using this command, you can configure FortiWeb to examine lcient requests for anomalies in XML. Configuring
XML protection can help ensure that the content of HTTP requests containing XML does not contain any potential
attacks.
XML protection is available in Reverse Proxy, Offline Protection, True Transparent Proxy, Transparent Inspections, and
WCCP operating modes.
Syntax
config waf xml-validation rule
edit "<xml_rule_name>"
set action {alert | alert_deny | block-period | redirect | send_403_forbidden |
deny_no_log}
set block-period <period_int>
set expansion-entity-check {enable | disable}
set external-entity-check {enable | disable}
set host "<host_name_str>"
set host-status {enable | disable}
set request-file "<file_str>"
set request-type {plain | regular}
set schema-file "<schema_file_name>"
set severity {High Low | Medium | Info}
next
end
config waf xml-validation policy
edit "<xml_policy_name>"
config input-rule-list
edit <entry_index>
set "<xml_rule_1>"
next
end
next
end
block-period <period_int> Enter the amount of time (in seconds) that you want to 60
block subsequent requests from a client after FortiWeb
detects a rule violation. This setting is available only when
waf xml-validation (page 546) is block-period.
host-status {enable | Enable to compare the XML rule to the Host: field in the disable
disable} HTTP header. If enabled, also configure waf xml-
validation (page 546).
severity {High Low | When rule violations are recorded in the attack log, each log Low
Medium | Info} message contains a Severity Level field. Select which
severity level FortiWeb will use when it logs a violation of
the rule:
l Low
l Medium
l High
l Info
trigger "<trigger_policy_ Enter the name of the trigger, if any, to apply when the rule No
name>" is violated. The maximum length is 63 characters. For default.
xml-limit-attrname-len Enter the maximum attribute name length (in bytes) of each 64
<limit_int> element. The valid range is 1–1,024.
xml-limit-cdata-len Enter the maximum Character Data (CDATA) length (in 4,096
<limit_int> bytes) in XML. The valid range is 1–4,096.
xml-limit-check {enable |
disable} Enable to configure XML limits. disable
xml-limit-element-depth Enter the maximum element depth in XML. The valid range 20
<limit_int> is 1–256.
data-format {xml
Select the XML protection rule format. No default.
| soap}
wsdl-file <wsdl-file_ This field applies When the Data Format is SOAP. Enter a name No default.
name> for the WSDL file.
allow-additional-soap-
headers {enable Enable not to validate additional header elements. No default.
| disable}
validate-soap-body Enable to validate whether the body elements in SOAP protocol No default.
{enable | disable} comply with those in WSDL file.
Example
The below example creates an XML protection rule and applies the rule to a new XML protection policy.
config waf xml-validation rule
edit "example_rule_name_1"
set action block-period
set block-period 3000
set severity Medium
set trigger "example_trigger_policy_name"
set host-status enable
set host "example_host_name"
set request-type plain
set request-file "/index.php"
set schema-file "example_schema_file_name"
set xml-limit-check enable
set xml-limit-attr-num 64
set xml-limit-attrname-len 256
set xml-limit-attrvalue-len 1024
set xml-limit-cdata-len 2096
set xml-limit-element-depth 128
set xml-limit-element-name-len 128
set xml-entity-check enable
set expansion-entity-check enable
Related topics
l "waf xml-schema" on page 545
l "waf xml-wsdl" on page 552
l "waf web-protection-profile inline-protection" on page 518
waf xml-wsdl
Use this command to view XML wsdl files that have already been uploaded to FortiWeb. You can upload XML wsdl files
only in the web UI.
WSDL files are XML files that describe how to use SOAP to invoke web service. To configure FortiWeb to verify legality
of WSDL files and check the SOAP message against WSDL and SOAP protocol, create an XML protection rule and
select a WSDL file for that rule. You can select only one WSDL file for each XML protection rule, but you can configure
FortiWeb to enforce multiple rules in XML protection policies.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wafgrp area. For details, see "Permissions" on page 51.
Syntax
config waf xml-wsdl file
edit "<xml_wsdl_file_name>"
end
Related topics
l "waf xml-validation" on page 546
wvs policy
Use this command to define a web vulnerability scan policy. The policy enables you to set the frequency of the
vulnerability scan, schedule the scan, and choose a format for the scan report. The policy also enables you to select an
email policy that determines who receives the scan report.
Before you can complete a web vulnerability scan policy, you must first configure a scan profile using the FortiWeb web
UI and a scan schedule using either the web UI or the command config wvs schedule (page 556).
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wvsgrp area. For details, see "Permissions" on page 51.
Syntax
config wvs policy
edit "<wvs-policy_name>"
set type {runonce | schedule}
set schedule "<wvs-schedule_name>"
set profile "<wvs-profile_name>"
set email "<email-policy_name>"
set report_format {html mht pdf rtf text}
set runtime <count_int>
next
end
Select either:
set profile ?
email "<email-policy_ Enter the name of an existing email policy. When the scan No
name>" completes, the FortiWeb appliance will send email in the default.
specified format to the email addresses in the policy. The
maximum length is 63 characters. For details, see "log email-
policy" on page 75.
report_format {html mht Select one or more file formats of the report to attach when
html
pdf rtf text} emailing it.
Example
The following example defines a recurring vulnerability scan with email report output in RTF and text format.
config wvs policy
edit "wvs-policy1"
set type schedule
set schedule "wvs-schedule1"
set report_format rtf text
set profile "wvs-profile1"
set email "EmailPolicy1"
next
end
Related topics
l "wvs profile" on page 554
l "wvs schedule" on page 556
wvs profile
Use this command to display the names of web vulnerability scan profiles.
This command can only be used to display the names of the profiles. It cannot configure
the profiles. To create a web vulnerability scan profile, you must use the web UI.
A web vulnerability scan (WVS) profile defines the web server to scan, as well as the specific vulnerabilities to scan for.
The WVS profiles are associated with WVS policies, which determine when to perform the scan and how to publish the
results of the scan defined by the profile.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wvsgrp area. For details, see "Permissions" on page 51.
Syntax
config wvs profile
get
show
end
Example
This example displays the names of all configured web vulnerability scan profiles.
config wvs profile
get
Output:
== [ WVS-Profile1 ]
name: WVS-Profile1
== [ WVS-Profile2 ]
name: WVS-Profile2
This example displays the names of all configured web vulnerability scan profiles, using configuration file syntax.
config wvs profile
show
Output:
config wvs profile
edit "WVS-Profile1"
next
edit "WVS-Profile2"
next
end
Related topics
l "wvs policy" on page 553
l "wvs schedule" on page 556
wvs schedule
Vulnerability scanning can detect known vulnerabilities on your web servers and web applications, helping you to design
protection profiles. Vulnerability scans start from an initial directory, then scan for vulnerabilities in web pages located in
the same directory or subdirectory as the initial URL.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
wvsgrp area. For details, see "Permissions" on page 51.
Syntax
config wvs schedule
edit "<schedule_name>"
set type {recurring | onetime}
set date "<time_str>" "<date_str>"
set time "<time_str>"
set wday {Sunday Monday Tuesday Wednesday Thursday Friday Saturday}
next
end
Select either:
date "<time_str>" "<date_ For a one-time web vulnerability scan, enter the time and No
str>" date for the scan to run. default.
l dd is the day
The yyyy range is 2001–2050.
wday {Sunday Monday For a recurring scan only, enter one or more days of the week No
Tuesday Wednesday the scan is to be performed. default.
Thursday Friday Saturday}
This setting only applies if type {recurring |
onetime} (page 556) is recurring.
Example
The following example schedules a recurring vulnerability scan to run every Sunday and Thursday at 1:00 AM.
config wvs schedule
edit "WVS-schedule1"
set type recurring
set time 01:00
set wday Sunday Thursday
next
end
Related topics
l "wvs profile" on page 554
l "wvs policy" on page 553
diagnose
The diagnose commands display diagnostic information that help you troubleshoot problems. These commands do
not have an equivalent in the web UI.
debug trace
report
debug trace
tcpdump
hardware
cpu
debug reset
debug
upload
hardware
harddisk
hardware
interrupts
hardware
logdisk
info
hardware
mem
hardware
nic
debug
Debug logging can be very resource intensive. To minimize the performance impact on your FortiWeb appliance, use
packet capture only during periods of minimal traffic, with a local console CLI connection rather than a Telnet or SSH
CLI connection, and be sure to stop the command when you are finished.
By default, the most verbose logging that is available from the web UI for any log type is the Information severity level.
Due to their usually unnecessary nature, logs at the severity level of Debug are disabled and hidden. They can only be
enabled and viewed from the CLI. Typically this is done only if your configuration seems to be correct, you cannot
diagnose the problem without more information, and possibly suspect that you may have found either a hardware failure
or software bug.
1. Set the verbosity level for the specific module whose debugging information you want to view, via a debug log
command such as:
debug application hasync {0 | 1 | 2 | 3 | 4 | 5 | 6 | 7} (page 566)
2. If necessary configure any filters specific to the module whose debugging information you are viewing, such as:
debug flow filter server-ip "10.0.0.10"
5. View the debug logs. For convenience, debugging logs are immediately outputted to your local console display or
terminal emulator, but debug log files can also be uploaded to a server.
For more complex issues or bugs, this may be required in order to send debug information to Fortinet Customer
Service & Support (https://support.fortinet.com).
Debug logs will be generated only if the application is running. To verify this, use
diagnose system top (page 621). Otherwise, use diagnose debug
crashlog (page 579) instead.
6. The CLI will display debug logs as they occur until you either:
l Disable it by either typing:
diagnose debug disable
or setting all modules’ debug log verbosity back to 0. To reset all verbosity levels simultaneously, you can use
the command:
diagnose debug reset
To use this command, your administrator account’s access control profile requires only r permission in any
profile area.
Syntax
diagnose debug {enable | disable}
debug {enable | disable} Select whether to enable or disable recording of logs at the debug disable
severity level.
Related topics
l "debug application autolearn" on page 561
l "debug application detect" on page 563
l "debug application dssl" on page 564
l "debug application fds" on page 565
l "debug application hasync" on page 566
l "debug application hatalk" on page 567
l "debug application http" on page 569
l "debug application miglogd" on page 569
l "debug application mulpattern" on page 570
l "debug application proxy" on page 571
l "debug application proxy-error" on page 572
l "debug application snmp" on page 573
l "debug application ssl" on page 573
l "debug application sysmon" on page 574
l "debug application ustack" on page 575
l "debug application waf-fds-update" on page 576
l "debug cli" on page 577
l "debug crashlog" on page 579
l "debug flow trace" on page 583
l "debug upload" on page 590
l "log " on page 601
Use this command to view and set the verbosity level of debug logs for auto-learning.
Before you can see any debug logs, you must first enable debug log output using the command debug.
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug application autolearn <autolearn_int>
autolearn <autolearn_int> Specify the verbosity level to output to the CLI display after the 0
command executes.
The valid range is 0–7, where 0 disables debug logs for auto-
learning and 7 generates the most verbose logging.
If you omit the number, the CLI displays the current verbosity
level. For example:
autolearn debug level is 0
Related topics
l "debug" on page 559
l "debug console timestamp" on page 578
l "debug info" on page 586
l "debug reset" on page 589
l "debug upload" on page 590
Use this command to set the verbosity level and type of debug logs for HA synchronization.
Before you will be able to see any debug logs, you must first enable debug log output using the command diagnose
debug (page 1).
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 1.
Syntax
diagnose debug application confd-hamsg {0 | 1 | 2 | 3 | 4 | 5 | 6 | 7}
confd-hamsg {0 | 1 | Enter the number indicating the verbosity level and type of 0
2 | 3 | 4 | 5 | 6 | 7} debugging messages to output to the CLI display after the
command executes.
If you omit the number, the CLI displays the current verbosity
level:
hasync debug level is 0
Example
This example enables diagnostic debug logging in general, then specifically enables packet transmission logging of the
HA synchronization daemon, confd-hamsg.
diagnose debug enable
diagnose debug application confd-hamsg 5
The CLI displays output such as the following until the command is terminated:
(./lib/confd_generate_md5.c : 103 ) request generate md5sum!
(./lib/confd_generate_md5.c : 149 ) generate md5sum done!
(./sync/confd_md5.c : 158 ) send md5sum request to FVVM020000176885, now:548 pending:0 timeout
[60] sync_time:0
(./sync/confd_md5.c : 167 ) ---- <ha_check_confirm_members send by timeout> ----
(./sync/confd_md5.c : 168 ) ---- <local cli> 21E374585BFFBDD4A043951988FEDBE9 ----
(./sync/confd_md5.c : 169 ) ---- <member cli> 1335504BC818AC7702F0A8735DB290D0 ----
(./lib/confd_setup_rsc.c : 571 ) Received MD5SUM response from FVVM020000176885
(./lib/confd_setup_rsc.c : 254 ) get device's config file md5info, and compare them
(./lib/confd_setup_rsc.c : 336 ) the device FVVM020000176885 has fresh system config, don't
need update
(./lib/confd_setup_rsc.c : 384 ) the device FVVM020000176885 has fresh cli config, don't need
update
(./lib/confd_setup_rsc.c : 393 ) config file is same, send init_finished to slave device
FVVM020000176885
(./lib/confd_setup_rsc.c : 118 ) member FVVM020000176885 update confirme time: 550654
(./lib/confd_msg.c : 39 ) send msg to ha, msg len: 72 msg type: 1 sn: FVVM020000176885 status:
0
Related topics
l "debug" on page 1
l "debug console timestamp" on page 1
l "debug info" on page 1
l "debug reset" on page 1
l "debug upload" on page 1
Use this command to set the verbosity level of debug logs for intrusion detection.
Before you can see any debug logs, you must first enable debug log output using the command diagnose debug
(page 559).
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug application detect <detect_int>
detect <detect_int> Specify the verbosity level to output to the CLI display after the 0
command executes.
If you omit the number, the CLI displays the current verbosity
level:
detect debug level is 0
Related topics
l "debug" on page 559
l "debug console timestamp" on page 578
l "debug info" on page 586
l "debug reset" on page 589
l "debug upload" on page 590
Use this command to set the verbosity level of debug logs for SSL inspection (temporary decryption in order to enforce
policies). SSL inspection is used only when FortiWeb is operating in a mode that supports it, such as Transparent
Inspection mode or Offline Protection mode.
Before you will be able to see any debug logs, you must first enable debug log output using the command diagnose
debug (page 559).
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug application dssl <dssl_int>
dssl <dssl_int> Specify the verbosity level to output to the CLI display after the 0
command executes.
The valid range is 0–7, where 0 disables debug logs for SSL
inspection and 7 generates the most verbose logging.
If you omit the number, the CLI displays the current verbosity
level. For example:
dssl debug level is 0
Related topics
l "debug" on page 559
l "debug console timestamp" on page 578
l "debug info" on page 586
l "debug reset" on page 589
l "debug upload" on page 590
Use this command to set the verbosity level of debug logs for update requests to the Fortinet Distribution Network
(FDN).
Before you will be able to see any debug logs, you must first enable debug log output using the command diagnose
debug (page 559).
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug application fds <fds_int>
fds <fds_int> Specify the verbosity level to output to the CLI display after the 0
command executes.
The valid range is 0–7, where 0 disables debug logs for FDN
updates and 7 generates the most verbose logging.
If you omit the number, the CLI displays the current verbosity
level. For example:
fds debug level is 0
Related topics
l "debug" on page 559
l "debug console timestamp" on page 578
l "debug info" on page 586
l "debug reset" on page 589
l "debug upload" on page 590
Use this command to set the verbosity level and type of debug logs for HA synchronization.
Before you will be able to see any debug logs, you must first enable debug log output using the command diagnose
debug (page 559).
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug application hasync {0 | 1 | 2 | 3 | 4 | 5 | 6 | 7}
hasync {0 | 1 | 2 | 3 | Enter the number indicating the verbosity level and type of 0
4 | 5 | 6 | 7} debugging messages to output to the CLI display after the
command executes.
Example
This example enables diagnostic debug logging in general, then specifically enables packet transmission logging of the
HA synchronization daemon, hasyncd.
The CLI displays output such as the following until the command is terminated:
(./lib/confd_send_queue.c : 58 ) add request to ha sendqueue success len:626
(./lib/confd_send_queue.c : 171 ) Read send request from local, len = 626 element type:1
(./lib/confd_sync_data.c : 1243) Create session: 0x7f1a3b45f080 dstip: 169.254.0.2 dstsn:
FVVM020000176885 type :1 sd :13 filename : msglen :50
fortiweb # (./lib/confd_sync_data.c : 214 ) Send message hdr init, session :0x7f1a3b45f080
session id: 9219122 type: 1
fer: FV-VMB-6.0-FW-build0064 src_sn: FVVM020000176884 dst_sn: FVVM020000176885
(./lib/confd_sync_data.c : 732 ) Send single cfg message, session: 0x7f1a3b45f080 total len:
278 total_count: 1 current-count: 1 residue: 278 p_len: 278
send_len: 278
(./lib/confd_sync_data.c : 739 ) Send cfg message, session: 0x7f1a3b45f080 total_len: 278
msglen: 58 total_count: 1 current-count: 1residue: 278 retval: 278
(./lib/confd_sync_data.c : 1025) Release session: 0x7f1a3b45f080 type: 1 ctx status: 3 ctx_
file_status: 0 times :4 time out: 5000
Related topics
l "debug" on page 559
l "debug console timestamp" on page 578
l "debug info" on page 586
l "debug reset" on page 589
l "debug upload" on page 590
Use this command to set the verbosity level and type of debug logs for HA heartbeats.
Before you will be able to see any debug logs, you must first enable debug log output using the command diagnose
debug (page 559).
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug application hatalk {0 | 1 | 2 | 3 | 4 | 5 | 6 | 7}
{0 | 1 | 2 | 3 | 4 | 5 | Enter the number indicating the verbosity level and type of 0
6 | 7} debugging messages to output to the CLI display after the
command executes.
Example
This example enables diagnostic debug logging in general, then specifically enables complete debug logging of the HA
heartbeat daemon, hatalkd.
diagnose debug enable
diagnose debug application hatalk 6
The CLI displays output such as the following until the command is terminated:
FortiWeb # (ha_timer.c : 305) [87040]syncronized 2 nodes!
(ha_timer.c : 428) hamain[87040949] mode 2, role 1,1, phase 2, narps 0, skip 0
(ha_timer.c : 305) [87041]syncronized 2 nodes!
(ha_timer.c : 428) hamain[87041949] mode 2, role 1,1, phase 2, narps 0, skip 0
(ha_timer.c : 305) [87042]syncronized 2 nodes!
(ha_timer.c : 428) hamain[87042949] mode 2, role 1,1, phase 2, narps 0, skip 0
(ha_timer.c : 305) [87043]syncronized 2 nodes!
(ha_timer.c : 428) hamain[87043948] mode 2, role 1,1, phase 2, narps 0, skip 0
(ha_timer.c : 305) [87044]syncronized 2 nodes!
(ha_timer.c : 428) hamain[87044948] mode 2, role 1,1, phase 2, narps 0, skip 0
(ha_timer.c : 305) [87045]syncronized 2 nodes!
(ha_timer.c : 428) hamain[87045948] mode 2, role 1,1, phase 2, narps 0, skip 0
(ha_timer.c : 305) [87046]syncronized 2 nodes!
(ha_timer.c : 428) hamain[87046948] mode 2, role 1,1, phase 2, narps 0, skip 0
(ha_timer.c : 305) [87047]syncronized 2 nodes!
(ha_timer.c : 428) hamain[87047948] mode 2, role 1,1, phase 2, narps 0, skip 0
(ha_timer.c : 305) [87048]syncronized 2 nodes!
Related topics
l "debug" on page 559
l "debug console timestamp" on page 578
l "debug info" on page 586
l "debug reset" on page 589
l "debug upload" on page 590
Use this command to set the verbosity level of debug logs for the HTTP protocol parser. This parser module dissects the
HTTP headers and content body for analysis by other modules such as rewriting, HTTP protocol constraints, server
information disclosure, and attack signature matching.
If the debug logs indicate that the HTTP protocol parser may be encountering an error
condition, you can temporarily disable it and allow packets to bypass it to verify if this is the
case. For details, see noparse {enable | disable} (page 157).
Before you will be able to see any debug logs, you must first enable debug log output using the command diagnose
debug (page 559).
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug application http <http_int>
http <http_int> Specify the verbosity level to output to the CLI display after the 0
command executes.
The valid range is 0–7, where 0 disables debug logs for the
HTTP protocol parser and 7 generates the most verbose
logging.
If you omit the number, the CLI displays the current verbosity
level. For example:
http debug level is 0
Related topics
l "debug" on page 559
l "debug console timestamp" on page 578
l "debug info" on page 586
l "debug reset" on page 589
l "debug upload" on page 590
l "debug flow trace" on page 583
Use this command to set the verbosity level of debug logs for the log daemon, miglogd.
Before you will be able to see any debug logs, you must first enable debug log output using the command diagnose
debug (page 559).
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug application miglogd <miglogd_int>
miglogd <miglogd_int> Specify the verbosity level to output to the CLI display after the 0
command executes.
The valid range is 0–7, where 0 disables debug logs for the log
daemon and 7 generates the most verbose logging.
If you omit the number, the CLI displays the current verbosity
level. For example:
miglogd debug level is 0
Related topics
l "debug" on page 559
l "debug console timestamp" on page 578
l "debug info" on page 586
l "debug reset" on page 589
l "debug upload" on page 590
l "db rebuild" on page 632
Use this command to set the verbosity level of debug logs for the pattern matching module.
Before you will be able to see any debug logs, you must first enable debug log output using the command diagnose
debug (page 559).
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug application mulpattern <mulpattern_int>
mulpattern <mulpattern_ Specify the verbosity level to output to the CLI display after the 0
int> command executes.
The valid range is 0–7, where 0 disables debug logs for the
pattern matching module and 7 generates the most verbose
logging.
If you omit the number, the CLI displays the current verbosity
level. For example:
mulpattern debug level is 0
Related topics
l "debug" on page 559
l "debug console timestamp" on page 578
l "debug info" on page 586
l "debug reset" on page 589
l "debug upload" on page 590
Use this command to set the verbosity level of debug logs for flow through the XML application proxy.
Before you will be able to see any debug logs, you must first enable debug log output using the command diagnose
debug (page 559).
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug application proxy <proxy_int>
proxy <proxy_int> Specify the verbosity level to output to the CLI display after the 0
command executes.
The valid range is 0–7, where 0 disables debug logs for the
XML application proxy flow and 7 generates the most verbose
logging.
If you omit the number, the CLI displays the current verbosity
level. For example:
proxy debug level is 0
Related topics
l "debug" on page 559
l "debug console timestamp" on page 578
l "debug info" on page 586
l "debug reset" on page 589
l "debug upload" on page 590
Use this command to set the verbosity level of debug logs for errors in the XML application proxy.
Before you will be able to see any debug logs, you must first enable debug log output using the command diagnose
debug (page 559).
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug application proxy-error {-1 | 0}
proxy-error {-1 | 0} Specify the verbosity level to output to the CLI display after the 0
command executes.
The valid range is 0–7, where 0 disables debug logs for XML
application proxy errors and 7 generates the most verbose
logging.
If you omit the number, the CLI displays the current verbosity
level. For example:
proxy-error debug level is 0
Related topics
l "debug" on page 559
l "debug console timestamp" on page 578
l "debug info" on page 586
l "debug reset" on page 589
l "debug upload" on page 590
Before you will be able to see any debug logs, you must first enable debug log output using the command diagnose
debug (page 559).
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug application snmp <snmp_int>
snmp <snmp_int> Specify the verbosity level to output to the CLI display after the 0
command executes.
If you omit the number, the CLI displays the current verbosity
level:
snmp debug level is 0
Related topics
l "debug" on page 559
l "debug console timestamp" on page 578
l "debug info" on page 586
l "debug reset" on page 589
l "debug upload" on page 590
Use this command to set the verbosity level of debug logging for SSL/TLS offloading. SSL offloading is supported only
when the FortiWeb appliance is operating in Reverse Proxy or True Transparent Proxy mode.
Before you will be able to see any debug logs, you must first enable debug log output using the command diagnose
debug (page 559).
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug application ssl <ssl_int>
ssl <ssl_int> Specify the verbosity level to output to the CLI display after the 0
command executes.
If you omit the number, the CLI displays the current verbosity
level. For example:
ssl debug level is 0
Example
This example enables diagnostic debug logging overall, then specifically enables debug logging for SSL in Reverse
Proxy mode.
diagnose debug enable
diagnose debug application ssl
Related topics
l "debug" on page 559
l "debug console timestamp" on page 578
l "debug info" on page 586
l "debug reset" on page 589
l "debug upload" on page 590
Before you will be able to see any debug logs, you must first enable debug log output using the command diagnose
debug (page 559).
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug application sysmon <sysmon_int>
sysmon <sysmon_int> Specify the verbosity level to output to the CLI display after the 0
command executes.
If you omit the number, the CLI displays the current verbosity
level. For example:
sysmon debug level is 0
Related topics
l "debug" on page 559
l "debug console timestamp" on page 578
l "debug info" on page 586
l "debug reset" on page 589
l "debug upload" on page 590
Use this command to set the verbosity level of debug logs for the user-space TCP/IP connectivity stack.
Before you will be able to see any debug logs, you must first enable debug log output using the command diagnose
debug (page 559).
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug application ustack <ustack_int>
ustack <ustack_int> Specify the verbosity level to output to the CLI display after the 0
command executes.
If you omit the number, the CLI displays the current verbosity
level. For example:
ustack debug level is 0
Related topics
l "debug" on page 559
l "debug console timestamp" on page 578
l "debug info" on page 586
l "debug reset" on page 589
l "debug upload" on page 590
Before you will be able to see any debug logs, you must first enable debug log output using the command diagnose
debug (page 559).
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug application waf-fds-update <update_int>
waf-fds-update <update_ Specify the verbosity level to output to the CLI display after the 0
int> command executes.
If you omit the number, the CLI displays the current verbosity
level. For example:
waf-fds-update debug level is 0
Related topics
l "debug" on page 559
l "debug console timestamp" on page 578
l "debug info" on page 586
l "debug reset" on page 589
l "debug upload" on page 590
debug cli
Use this command to set the debug level for the command line interface (CLI).
Before you will be able to see any debug logs, you must first enable debug log output using the command diagnose
debug (page 559).
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug cli <cli_int>
cli <cli_int> Specify the verbosity level to output to the CLI display after the 3
command executes.
The valid range is 0–7, where 0 disables debug logs for the
CLI and 7 generates the most verbose logging.
If you omit the number, the CLI displays the current verbosity
level. For example:
cli debug level is 0
Related topics
l "debug" on page 559
l "debug console timestamp" on page 578
l "debug info" on page 586
l "debug reset" on page 589
l "debug upload" on page 590
debug cmdb
Use this command to enable the debug log for the configuration management database (CMDB).
Before you will be able to see any debug logs, you must first enable debug log output using the command diagnose
debug (page 559).
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug cmdb <cmdb_int>
cmdb <cmdb_int> Specify the verbosity level to output to the CLI display after the 0
command executes.
If you omit the number, the CLI displays the current verbosity
level:
cmdb debug level is 0
Related topics
l "debug" on page 559
l "debug console timestamp" on page 578
l "debug info" on page 586
l "debug reset" on page 589
l "debug upload" on page 590
Before you will be able to see any debug logs, you must first enable debug log output using the command diagnose
debug (page 559).
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug console timestamp {enable | disable}
Related topics
l "debug reset" on page 589
l "debug info" on page 586
debug coredumplog
Use this command to record the stack information in the core file of the proxyd program.
Before you will be able to see any debug logs, you must first enable debug log output using the command enable-
debug-log {enable | disable} (page 299).
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug coredumplog show
diagnose debug coredumplog clear
Related Topic
l "debug" on page 559
debug crashlog
Use this command to show crash logs from application proxies that have call back traces, segmentation faults, or
memory register dumps, or to delete the crash log.
Before you will be able to see any debug logs, you must first enable debug log output using the command enable-
debug-log {enable | disable} (page 299).
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug crashlog show
diagnose debug crashlog clear
Example
diagnose debug crashlog show
debug daemonlog
Before you will be able to see any debug logs, you must first enable debug log output using the command enable-
debug-log {enable | disable} (page 299).
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug daemonlog show
diagnose debug daemonlog clear
Related Topic
l "debug" on page 559
Use this command to display the DNS cache that stores the results of resolving all fully qualified domain names in the
server pools.
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug dnsproxy list
Example
diagnose debug dnsproxy list
If the domain specified for the server pool member is www.example.org and has resolved to 10.20.5.12,
output similar to the following is displayed:
www.example.org
10.20.5.12
10:20::5:12
Related topics
l "system dns" on page 242
debug emerglog
Before you will be able to see any debug logs, you must first enable debug log output using the command diagnose
debug (page 559).
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug emerglog {show | clear}
Variable Description Default
Use these commands to generate only packet flow debug logs that match your filter criteria, such as a specific
destination IP address. You can also use these commands to delete the packet flow debug log filter, so that all packet
flow debug logs are generated.
Before you will be able to see any debug logs, you must first enable debug log output using the command diagnose
debug (page 559).
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug flow filter reset
diagnose debug flow filter client-ip <source_ipv4 | source_ipv6>
diagnose debug flow filter server-ip <destination_ipv4 | destination_ipv6>
client-ip <source_ipv4 | Enter the source (SRC) IP address of connections. This will No
source_ipv6> generate only packet flow debug log messages involving that default.
source IP address.
Note: This filter operates at the IP layer, not the HTTP layer.
If a load balancer or other web proxy is deployed in front of
FortiWeb, and therefore all connections for HTTP requests
appear to originate from this IP address, configuring this filter
will have no effect.
Related topics
l "debug flow trace" on page 583
Use this command to include or exclude debug logs from each FortiWeb feature module as the packet is processed
when generating packet flow debug logs. This can be useful if you suspect that a module is encountering errors, or need
to know which module is dropping the packet.
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug flow filter module-detail {on | off}
module-detail {on | off} Select whether to include (on) or exclude (off) details from each No default.
module that processes the packet.
Related topics
l "debug flow trace" on page 583
l "debug flow reset" on page 583
Use this command to reset the configuration of packet flow debug log messages.
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug flow reset
Related topics
l "debug flow filter" on page 581
l "debug flow filter module-detail" on page 582
Use this command to trace the flow of packets through the FortiWeb appliance’s processing modules and network
stack.
Before you will be able to see any debug logs, you must first enable debug log output using the command diagnose
debug (page 559).
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug flow trace {start | stop}
trace {start | stop} Select whether to enable (start) or disable (stop) the recording No
of packet flow trace debug log messages. default.
Example
This example configures a filter based on the packet destination IP 192.0.2.48, enables messages from each packet
processing module, enables packet flow traces, then finally begins generating the debug logs that are enabled for
output (in this case, only packet trace debug logs).
Because the filters are configured before debug logging is enabled, the administrator can type the filter without being
interrupted by debug log output to the CLI.
diagnose debug flow filter server-ip 192.0.2.48
diagnose debug flow flow module-detail on
diagnose debug flow trace start
diagnose debug enable
Output:
FortiWeb # session_id=251 packet_id=0 policy_name=policy1 msg="Receive packet from client
172.20.120.225:49428"
session_id=251 packet_id=0 msg="HTTP parsing client packet success"
session_id=251 packet_id=0 policy_name="policy1" msg="
Module name:WAF_IP_LIST_CHECK, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_X_FORWARD_FOR_PROCESS, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_GEO_BLOCK_LIST, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_PROTECTED_SERVER_CHECK, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_ALLOW_METHOD_PROCESS, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_HTTP_ACTIVE_SCRIPT, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_HTTP_SESSION_MANAGEMENT, Execution:4, Process error:1, Action:ACCEPT
Module name:WAF_HTTP_DOS_PREVENTION, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_LAYER4_DOS_PREVENTION, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_HTTP_AUTHENTICATION, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_GLOBAL_WHITE_LIST, Execution:4, Process error:0, Action:ACCEPT
Module name:WAF_URL_ACCESS_POLICY, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_BRUCE_FORCE_LOGIN, Execution:3, Process error:0, Action:ACCEPT
Module name:HTTP_CONSTRAINTS, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_COOKIE_POISON, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_START_PAGES, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_PAGE_ACCESS_RULE, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_FILE_UPLOAD_RESTRICTION_POLICY, Execution:3, Process error:0, Action:ACCEPT
Module name:ROBOT_CONTROL_PROCESS, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_PARAMETWER_VALIDATION_PROCESS, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_CHUNK_DECODE, Execution:3, Process error:2, Action:ACCEPT
Module name:WAF_FILE_UNCOMPRESS, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_SIG_DETECT_PROCESS, Execution:4, Process error:1, Action:ACCEPT
Module name:WAF_HIDDEN_FIELD_PROCESS, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_URL_REWRITING, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_FILE_COMPRESS, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_CERTIFICATE_FORWARD, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_AUTOLEARN, Execution:4, Process error:0, Action:ACCEPT
Module name:WAF_HTTP_STATISTIC, Execution:3, Process error:0, Action:ACCEPT
"
session_id=502 packet_id=0 policy_name=policy1 msg="Receive packet from client
172.20.120.225:49429"
session_id=502 packet_id=0 msg="HTTP parsing client packet success"
session_id=502 packet_id=0 policy_name="policy1" msg="
Module name:WAF_IP_LIST_CHECK, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_X_FORWARD_FOR_PROCESS, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_GEO_BLOCK_LIST, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_PROTECTED_SERVER_CHECK, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_ALLOW_METHOD_PROCESS, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_HTTP_ACTIVE_SCRIPT, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_HTTP_SESSION_MANAGEMENT, Execution:4, Process error:1, Action:ACCEPT
Module name:WAF_HTTP_DOS_PREVENTION, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_LAYER4_DOS_PREVENTION, Execution:3, Process error:0, Action:ACCEPT
Module name:WAF_HTTP_AUTHENTICATION, Execution:3, Process error:0, Action:ACCEPT
FortiWeb #
Session lines contain the name of the matching server policy (policy_name), the packet identifier (packet_ID), and
TCP session ID (session_id), as well as a log message (msg) indicating one or more of the following:
l The source IP address and port number of the packet (e.g. Receive packet from client
192.0.2.225:49428)
l The success or failure of FortiWeb’s HTTP parser’s attempt to analyze the HTTP headers and payload of the packet into
pieces that can be scanned or modified by modules (e.g. HTTP parsing client packet success or Packet
dropped by detection module,and module number=11)
If the debug logs indicate that the HTTP protocol parser may be encountering an error
condition, you can temporarily disable it and allow packets to bypass it to verify if this is the
case. For details, see noparse {enable | disable} (page 157).
If enabled, module lines contain messages from each FortiWeb feature module as it processes the packet (e.g.
Module name:WAF_PROTECTED_SERVER_CHECK for the feature that tests for an allowed Host: name in the
request). The module logs are displayed in their order of execution; for details, see the FortiWeb Administration Guide:
https://docs.fortinet.com/fortiweb/admin-guides
These messages indicate:
l Whether or not the module executed, and if not, the reason (e.g. Execution:1)
l Processing errors, if any (e.g. Process error:0)
l Whether a module has allowed or blocked the packet (e.g. Action:ACCEPT or Action:FOLLOWUP_ACCEP)
For non-execution reasons, possible status codes are:
Related topics
l "server-policy policy" on page 146
l "server-policy server-pool" on page 170
l "server-policy custom-application application-policy" on page 110
l "waf url-access url-access-rule" on page 490
l "policy" on page 614
l "debug application http" on page 569
l "debug flow filter" on page 581
l "debug flow filter module-detail" on page 582
l "debug" on page 559
debug info
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug info
Example
diagnose debug application ssl 8
diagnose debug application dssl 8
diagnose debug application ustack 8
diagnose debug info
If you have not modified any verbosity levels, only this default output appears:
FortiWeb # diagnose debug info
debug output: disable
console timestamp: disable
CLI debug level: 3
Related topics
l "debug reset" on page 589
l "debug" on page 559
l "debug console timestamp" on page 578
l "debug application autolearn" on page 561
l "debug application detect" on page 563
l "debug application dssl" on page 564
l "debug application fds" on page 565
l "debug application hasync" on page 566
l "debug application hatalk" on page 567
l "debug application http" on page 569
l "debug application miglogd" on page 569
l "debug application mulpattern" on page 570
l "debug application proxy" on page 571
l "debug application proxy-error" on page 572
l "debug application ssl" on page 573
l "debug application ustack" on page 575
l "debug cli" on page 577
debug init
Before you will be able to see any debug logs, you must first enable debug log output using the command diagnose
debug (page 559).
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug init {enable | disable}
init {enable | disable} Select whether to enable (start) or disable (stop) the No
debug kernlog
Before you will be able to see any debug logs, you must first enable debug log output using the command enable-
debug-log {enable | disable} (page 299).
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug kernlog show
diagnose debug kernlog clear
Related Topic
l "debug" on page 559
debug netstatlog
Use this command to record the print information of the netstat -anlt when the proxyd program is overloaded.
Before you will be able to see any debug logs, you must first enable debug log output using the command enable-
debug-log {enable | disable} (page 299).
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug netstatlog show
diagnose debug netstatlog clear
Related Topic
l "debug" on page 559
debug reset
Use this command to reset all debug log settings to default settings for the currently installed firmware version. If you
have not upgraded or downgraded the firmware, this restores the factory default settings.
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug reset
Related topics
l "debug info" on page 586
l "debug console timestamp" on page 578
l "debug application autolearn" on page 561
l "debug application detect" on page 563
l "debug application dssl" on page 564
l "debug application fds" on page 565
l "debug application hasync" on page 566
l "debug application hatalk" on page 567
l "debug application http" on page 569
l "debug application miglogd" on page 569
l "debug application mulpattern" on page 570
l "debug application proxy" on page 571
l "debug application proxy-error" on page 572
l "debug application ssl" on page 573
l "debug application ustack" on page 575
l "debug cli" on page 577
Only administrators or users with the prof_admin access file have permission to this command.
Syntax
diagnose trace report {start | stop}
trace report {start | Select whether to enable (start) or disable (stop) collecting No
stop} debug logs. default
Related topics
l "debug" on page 559
Syntax
diagnose trace tcpdump "<filter_str>" {any | "<interface_str>"} "<max-packet-count_
int>" {reset}
"<max-packet-count_int>" Specify the maximum packets you want to capture for the 4000
policy. Capture will stop automatically if the total captured
packets hit the count.
No
{reset} Reset all the settings to default.
default
Related topics
l "debug" on page 559
debug upload
Use this command to upload debug logs to an FTP server. This can be used if you want to view logs outside of the CLI,
or if you need to provide debug log files to Fortinet Customer Service & Support:
https://support.fortinet.com
To use this command, your administrator account’s access control profile requires only r permission in any profile area.
For details, see "Permissions" on page 51.
Syntax
diagnose debug upload <ftp_ipv4> <user_str> <password_str> <upload-dir_str>
No
<user_str> Enter a valid user account name to log in to the FTP server.
default.
Enter the directory path on the FTP server where FortiWeb will No
<upload-dir_str>
upload files. default.
Example
diagnose debug upload 192.0.2.5 user1 1passw0Rd C:/uploads
Related topics
l "debug" on page 559
l "db rebuild" on page 632
hardware check
Use this command to check the appliance hardware for errors. In the case of FortiWeb, this command checks virtual
hardware—the vCPUs.
For example, to troubleshoot a logging problem, use the following command to check the log disk for errors:
diagnose hardware check logdisk
If the disk does not pass the check, it is likely the source of the problem.
Syntax
diagnose hardware check {all |cp8 |cpu |logdisk | memory |nic}
Variable Description Default
Example
The following command checks the log disk:
diagnose hardware check logdisk
hardware cpu
Use this command to display a list of hardware specifications on the FortiWeb appliance for CPUs. In the case of
FortiWeb-VM, this command displays virtual hardware information—the vCPUs.
To use this command, your administrator account’s access control profile must have at least r permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
diagnose hardware cpu [list]
Example
diagnose hardware cpu list
fpu : yes
fpu_exception : yes
cpuid level : 13
wp : yes
flags : fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge mca cmov pat pse36
clflush dts acpi mmx fxsr sse sse2 ss ht tm syscall nx lm constant_tsc pni monitor ds_cpl
vmx tm2 cx16 xtpr lahf_lm
bogomips : 3994.51
clflush size : 64
cache_alignment : 64
address sizes : 38 bits physical, 48 bits virtual
power management:
Related topics
l "system top " on page 621
l "hardware mem" on page 596
l "system performance" on page 659
hardware fail-open
Fail-to-wire/bypass behavior is available for specific models only. For details, see "system fail-open" on page 245.
hardware harddisk
Use this command to display a list of hard disks and their capacity in megabytes (MB) in the FortiWeb appliance. In the
case of FortiWeb-VM, this will instead be for virtual hardware.
To use this command, your administrator account’s access control profile must have at least r permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
diagnose hardware harddisk [list]
Example
diagnose hardware harddisk list
On a FortiWeb 1000C with a single properly functioning internal hard disk plus its internal flash disk, this command
should show two file systems:
name size(M)
sda 1000204.89
sdb 1971.32
where sda, the larger file system, is from the hard disk used to store non-configuration/firmware data. If it does not
appear, you can reboot and attempt to run a file system check to fix the file system and mount it.
Related topics
l "hardware logdisk info" on page 595
l "hardware raid list" on page 599
l "system flash" on page 615
l "system mount" on page 620
l "system performance" on page 659
hardware interrupts
Use this command to display input/output (I/O) interrupt requests (IRQs) on the FortiWeb appliance. (In the case of
FortiWeb-VM, this will instead be for virtual hardware.)
To use this command, your administrator account’s access control profile must have at least r permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
diagnose hardware interrupts list
Example
diagnose hardware interrupts list
Related topics
l "system performance" on page 659
Use this command to display the capacity, partitions, mount status, and RAID level (if any) of the hard disk FortiWeb
uses to store logs and other data. For FortiWeb-VM, information for virtual hardware (the vDisk) is displayed.
To use this command, your administrator account’s access control profile must have at least r permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
diagnose hardware logdisk info
Example
This example shows normal output for a FortiWeb-VM installation: there is no RAID, and it has been allocated a 40 GB
vDisk. If the disk were mounted as read-only, this would indicate that the disk had failed to mount normally, and would
be the cause if no new log messages were being recorded.
diagnose hardware logdisk info
Related topics
l "hardware harddisk" on page 593
l "log " on page 601
l "system mount" on page 620
l "system performance" on page 659
hardware mem
Use this command to display the usage statistics of ephemeral memory (RAM), including swap pages and shared
memory (Shmem), on the FortiWeb appliance. In the case of FortiWeb-VM, this will instead be for virtual hardware—the
vRAM.
To use this command, your administrator account’s access control profile must have at least r permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
diagnose hardware mem list
Example
diagnose hardware mem list
Related topics
l "policy" on page 614
l "system flash" on page 615
l "system top " on page 621
l "system performance" on page 659
hardware nic
Use this command to display a list of hardware specifications for the network interface card (NIC) physical ports on the
FortiWeb appliance. (In the case of FortiWeb-VM, this will instead be for virtual hardware—the vNICs—and therefore
the driver will be a virtual driver such as vmxnet, and the interrupt will be a virtual IRQ address.)
If the FortiWeb’s network hardware has failed, this command can help to detect it. For example, if you know that the
network cable is good and the configuration is correct, but this command displays Link detected: no), the
physical network port may be broken.
To use this command, your administrator account’s access control profile must have at least r permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
diagnose hardware nic list [<interface_name>]
If you omit the name of a NIC port, the CLI returns a list of all
physical network interfaces, as well as the loopback interface
(lo):
lo
port1
port2
port3
port4
Example
diagnose hardware nic list
Supported ports TP
Supported link modes 1000baseT/Full
Supports auto-negotiation: No
Advertised link modes: Not reported
Advertised auto-negotiation: No
Speed: 1000Mb/s
Duplex: Full
Port: Twisted Pair
PHYAD 0
Transceiver: internal
Auto-negotiation off
Link detected yes
Interrupt 18
Base address 0x1400
RX packets 171487
RX errors 167784
RX dropped 0
RX overruns 0
RX frame 0
TX packets 202724
TX errors 0
TX dropped 0
TX overruns 0
TX carrier 0
TX collisions 0
TX queuelen 1000
RX bytes 72772373 (69.4 Mb)
TX bytes 32288070 (30.7 Mb)
Related topics
l "system interface" on page 280
l "debug application ustack" on page 575
l "hardware interrupts" on page 594
l "network ip" on page 603
l "network sniffer" on page 607
l "network tcp list" on page 611
l "network udp list" on page 613
l "system ha mac" on page 617
l "traceroute" on page 655
l "system performance" on page 659
Use this command to run a diagnostic test of each hard disk in the RAID array that FortiWeb has. It also displays the
capacity and RAID level. Because FortiWeb-VM has no RAID, this command is not applicable to it.
To use this command, your administrator account’s access control profile must have at least r permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
diagnose hardware raid list
Example
diagnose hardware raid list
Output similar to the following (from a FortiWeb 3000D) appears in the CLI window:
disk-number size(M) level
0(OK),1(OK), 1877274 raid1
Related topics
l "system raid" on page 293
l "hardware harddisk" on page 593
l "system mount" on page 620
l "create-raid level" on page 630
l "create-raid rebuild" on page 631
l "system performance" on page 659
index
Use this command to view (list) or clear logs, or to examine (show) or configure logs.
To use this command, your administrator account’s access control profile must have rw or w permission to the loggrp
area. For details, see "Permissions" on page 51.
Syntax
diagnose index all show
diagnose index all clear
diagnose index {alog | dlog | elog | tlog} clear
diagnose index {alog | dlog | elog | tlog} list <index_int>
diagnose index {alog | dlog | elog | tlog} set <queue_int>
diagnose index {alog | dlog | elog | tlog} show
No
list <index_int> Enter the number of most recent logs to display.
default.
set <queue_int> Enter the maximum length of the log before it is flushed and written No
to disk. The valid range is 0–32,768. default.
Example
This example displays a list of logs processed.
diagnose index all show
Related topics
l "log attack-log" on page 68
l "log event-log" on page 78
l "log traffic-log" on page 100
l "debug" on page 559
l "hardware logdisk info" on page 595
log
Use this command to view (list) or clear log messages, or to examine (show) or configure logging queues.
To use this command, your administrator account’s access control profile must have rw or w permission to the loggrp
area. For details, see "Permissions" on page 51.
Syntax
diagnose log {all | alog | dlog | elog | tlog} [show | start | stop]
Example
This example sets a time to start the display of log messages, displays log information starting at that time, and stops
the display of log messages. The appliance’s responses are displayed in bold.
FortiWeb # dia log all start
start tracking log
FortiWeb # dia log all show
time span starts from 2014-07-31 18:31:53.000000
Total time span is 10.754097 seconds
Time spent on waiting is 10.527346 seconds
Time spent on preprocessing is 0.000000 seconds
event log processed: 0
traffic log processed: 0
attack log processed: 0
FortiWeb # dia log all stop
stop tracking log
Related topics
l "log attack-log" on page 68
l "log event-log" on page 78
l "log traffic-log" on page 100
l "debug" on page 559
l "hardware logdisk info" on page 595
network arp
Use this command to add or delete an address resolution protocol (ARP) table entry, or to display the ARP table. The
ARP table is used to resolve the IP addresses that correspond to a network interface card’s physical MAC address,
thereby determining which IP addresses can be reached directly through a link.
To use this command, your administrator account’s access control profile must have rw or w permission to the sysgrp
area. For details, see "Permissions" on page 51.
Syntax
diagnose network arp add <interface_name><mac-address_hex>
diagnose network arp delete network arp
diagnose network arp list
diagnose network arp flush
<interface_name> Enter the name of the interface to add or delete from the ARP No
table. default.
{<interface_ipv4> | No
interface_ipv6>} Enter the IP address of the interface.
default.
Example
This example displays a list of ARP table entries.
FortiWeb # diagnose network arp list
port_ha: 169.254.0.2 fc:aa:14:75:c0:e0 reachable
port1: 10.0.0.1 00:09:0f:77:11:1d stale
port2: 10.65.13.3 00:0c:29:02:f1:bb reachable
lo: 10::13:101 0: 0: 0: 0: 0: 0 noarp
port2: ff02::16 33:33: 0: 0: 0:16 noarp
vlan66: ff02::16 33:33: 0: 0: 0:16 noarp
port7: ff02::2 33:33: 0: 0: 0: 2 noarp
port_ha: ff02::2 33:33: 0: 0: 0: 2 noarp
port_tn: ff02::16 33:33: 0: 0: 0:16 noarp
port7: ff02::16 33:33: 0: 0: 0:16 noarp
port_ha: ff02::16 33:33: 0: 0: 0:16 noarp
gretap0: ff02::16 33:33: 0: 0: 0:16 noarp
Related topics
l "network route" on page 604
l "network ip" on page 603
network ip
Use these commands to add or delete a network interface, loopback interface, or virtual server (which functions
somewhat like a virtual network interface) IP address, or to list the table of network interface IPs.
Back up the configuration before deleting a network interface table entry. FortiWeb
presents no confirmation message, and in some cases such as the loopback
interface, provides no undelete mechanism.
To use this command, your administrator account’s access control profile must have rw or w permission to the sysgrp
area. For details, see "Permissions" on page 51.
Syntax
diagnose network ip add <interface_name> {<interface_ipv4> | interface_ipv6}
{<interface_ipv4mask> |<interface_v6mask>}
diagnose network ip delete <interface_name> {<interface_ipv4> | interface_ipv6}
diagnose network ip list
<interface_name> Enter the name of the interface to add or delete from the network No
interface table. default.
{<interface_ipv4> | No
interface_ipv6} Enter the IP address of the network interface.
default.
Example
This example displays a list of enabled network interfaces, including the loopback (lo).
FortiWeb # diagnose network ip list
lo: 127.0.0.1/24
port1: 10.200.123.2/16
lo: ::1/128
port1: fe80::20c:29ff:fec3:34a6/64
port5: fe80::20c:29ff:fec3:34ce/64
port9: fe80::20c:29ff:fec3:34f6/64
port2: fe80::20c:29ff:fec3:34b0/64
port6: fe80::20c:29ff:fec3:34d8/64
port10: fe80::20c:29ff:fec3:3400/64
port3: fe80::20c:29ff:fec3:34ba/64
port7: fe80::20c:29ff:fec3:34e2/64
port4: fe80::20c:29ff:fec3:34c4/64
port8: fe80::20c:29ff:fec3:34ec/64
port_tn: fe80::1854:64ff:fe68:fd55/64
Example
This example deletes the IP of a virtual server on port2.
diagnose network ip delete port1 192.0.2.221
Related topics
l "network route" on page 604
l "network arp" on page 602
l "system interface" on page 280
network route
Use this command to add or delete a route in the routing table, or to list the routing table.
This command displays all individual entries, including automatically configured routes for the loopback interface and
VLANs, and also displays each route’s priority. Unlike diagnose network rtcache (page 605), it displays all
known routes, regardless of whether they have been recently used.
Do not delete routes unless you are sure. FortiWeb does not ask you to confirm the
deletion, and there is no undelete mechanism. For example, if you accidentally delete a
loopback interface route, you must recreate it manually.
To use this command, your administrator account’s access control profile must have rw or w permission to the sysgrp
area. For details, see "Permissions" on page 51.
Syntax
diagnose network route add {<source_ipv4mask> | <source_ipv6mask>} <delay_int>
{<destination_ipv4mask> | <destination_ipv6mask>} <delay_int> <delay_
int><priority_int>
diagnose network route delete {<source_ipv4mask> | <source_ipv6mask>} <delay_int>
{<destination_ipv4mask> | <destination_ipv6mask>} <delay_int> <delay_int>
<priority_int>
diagnose network route list
Variable Description Default
{<source_ipv4mask> | Enter the IP address and network mask of the source, separated by No
<source_ipv6mask>} a space. default.
Enter the name of the interface to add or delete from the routing No
<interface_name>
table. default.
{<destination_ipv4mask> | Enter the IP address and network mask of the source, separated by No
{<gateway_ipv4> | Enter the IP address of the next hop router (sometimes called a No
<gateway_ipv6>} gateway) to which this route sends packets. default.
<priority_int> Enter the priority of the route in the routing table. The lower the 0
number, the higher the priority. The valid range is 1–255.
Example
This example displays the routing table.
FortiWeb # diagnose network route list
0.0.0.0/0(none)->10.200.0.0/16(port1) via 0.0.0.0, pri 0 prot 2 scope 253
::/0(none)->fe80::/64(port1) via ::, pri 256 prot 2 scope 0
::/0(none)->fe80::/64(port2) via ::, pri 256 prot 2 scope 0
::/0(none)->fe80::/64(port3) via ::, pri 256 prot 2 scope 0
::/0(none)->fe80::/64(port4) via ::, pri 256 prot 2 scope 0
::/0(none)->fe80::/64(port5) via ::, pri 256 prot 2 scope 0
::/0(none)->fe80::/64(port6) via ::, pri 256 prot 2 scope 0
::/0(none)->fe80::/64(port7) via ::, pri 256 prot 2 scope 0
::/0(none)->fe80::/64(port8) via ::, pri 256 prot 2 scope 0
::/0(none)->fe80::/64(port9) via ::, pri 256 prot 2 scope 0
::/0(none)->fe80::/64(port10) via ::, pri 256 prot 2 scope 0
::/0(none)->fe80::/64(port_tn) via ::, pri 256 prot 2 scope 0
Example
This example adds a route to the routing table.
diagnose network route add 10::/64 port1 10:200::1/64 port1 10::1 0
Related topics
l "router all" on page 1
l "ping" on page 638
l "ping6" on page 640
l "traceroute" on page 655
l "network rtcache" on page 605
l "router static" on page 106
network rtcache
Unlike diagnose network route (page 604), this command displays the cache of the most recently used routes,
not necessarily the entire configuration. (You may have configured many routes, and these configurations will be saved
to disk and appear in diagnose network route (page 604), but rarely used ones will not usually appear in the
route cache, which keeps recently used routes in RAM for performance reasons.)
To use this command, your administrator account’s access control profile must have rw or w permission to the sysgrp
area. For details, see "Permissions" on page 51.
Syntax
diagnose network rtcache list
Example
This example displays the ARP cache.
172.20.120.52(port1)->255.255.255.255(lo) via 0.0.0.0, pri 0 prot 0 scope 0, ref 0 lastuse 3181
expires 0 error 0 used 855
172.20.120.100(port3)->172.20.120.255(lo) via 0.0.0.0, pri 0 prot 0 scope 0, ref 0 lastuse 434
expires 0 error 0 used 0
172.20.120.230(port1)->255.255.255.255(lo) via 0.0.0.0, pri 0 prot 0 scope 0, ref 0 lastuse
47386 expires 0 error 0 used 7
10.0.1.1(none)->10.0.1.1(lo) via 0.0.0.0, pri 0 prot 0 scope 0, ref 0 lastuse 223 expires 0
error 0 used 29551
0.0.0.0(none)->10.0.1.1(lo) via 0.0.0.0, pri 0 prot 0 scope 0, ref 0 lastuse 223 expires 0
error 0 used 7387
::(none)->::1(lo) via ::, pri 0 prot 0 scope 0 ref 1 lastuse 155845 expires 0 error 0 used 417
::(none)->2607:f0b0:f:420:20c:29ff:fe4d:3ad3(lo) via ::, pri 0 prot 0 scope 0 ref 1 lastuse
354923 expires 0 error 0 used 1
::(none)->2607:f0b0:f:420:20c:29ff:fe4d:3ae7(lo) via ::, pri 0 prot 0 scope 0 ref 1 lastuse
2590615 expires 0 error 0 used 0
::(none)->2607:f0b0:f:420:20c:29ff:fe4d:3af1(lo) via ::, pri 0 prot 0 scope 0 ref 1 lastuse
2590615 expires 0 error 0 used 0
::(none)->2607:f0b0:f:420::(port1) via ::, pri 256 prot 0 scope 0 ref 0 lastuse 2590616 expires
214715722 error 0 used 0
::(none)->ff00::(port4) via ::, pri 256 prot 0 scope 0 ref 0 lastuse 2590615 expires 0 error 0
used 0
::(none)->ff00::(lo) via ::, pri -1 prot 0 scope 0 ref 1 lastuse 449431651 expires 0 error -101
used 1
Example
This example adds a route to the routing table.
diagnose network route add vlan2 160.1.12.0 255.0.0.0 172.20.01.169 32 3 verify
Related topics
l "router all" on page 1
l "ping" on page 638
l "ping6" on page 640
l "traceroute" on page 655
l "network route" on page 604
l "router static" on page 106
network sniffer
Use this command to perform a packet trace on one or more network interfaces.
Packet capture, also known as sniffing or packet analysis, records some or all of the packets seen by a network interface
(that is, the network interface is used in promiscuous mode). By recording packets, you can trace connection states to
the exact point at which they fail, which may help you to diagnose some types of problems that are otherwise difficult to
detect.
FortiWeb appliances have a built-in sniffer. Packet capture on FortiWeb appliances is similar to that of FortiGate
appliances. Packet capture output appears on your CLI display until you stop it by pressing Ctrl+C, or until it reaches the
number of packets that you have specified to capture.
Packet capture can be very resource intensive. To minimize the performance impact on
your FortiWeb appliance, use packet capture only during periods of minimal traffic, with a
local console CLI connection rather than a Telnet or SSH CLI connection, and be sure to
stop the command when you are finished.
If your FortiWeb model uses Data Plane Development Kit (DPDK) for packet processing
(for example, models 3000E, 3010E and 4000E) and is operating in Offline Protection
mode, you cannot use this command with ports that are configured as data capture ports.
To use the command with this type of port, disable the corresponding server policy or
configure the policy with a different data capture port.
To use this command, your administrator account’s access control profile must have at least r permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
diagnose network sniffer [{any | "<interface_name>"} [{none | "<filter_str>"} [{1 | 2 |
3} [<packets_int> ]]]]
{any | "<interface_ Enter the name of a network interface whose packets you No
name>"} want to capture, such as port1, or type any to capture default.
packets on all network interfaces.
press
Ctrl + C.
Example
The following example captures three packets of traffic from any port number or protocol and between any source and
destination (a filter of none), which passes through the network interface named port1. The capture uses a low level
of verbosity (indicated by 1).
Commands that you would type are highlighted in bold; responses from the FortiWeb appliance are not bolded.
FortiWeb# diagnose network sniffer port1 none 1 3
filters=[none]
0.918957 192.168.0.1.36701 -> 192.168.0.2.22: ack 2598697710
0.919024 192.168.0.2.22 -> 192.168.0.1.36701: psh 2598697710 ack 2587945850
0.919061 192.168.0.2.22 -> 192.168.0.1.36701: psh 2598697826 ack 2587945850
If you are familiar with the TCP protocol, you may notice that the packets are from the middle of a TCP connection.
Because port 22 is used (highlighted above in bold), which is the standard port number for SSH, the packets might be
from an SSH session.
Example
The following example captures packets traffic on TCP port 80 (typically HTTP) between two hosts, 192.168.0.1
and 192.168.0.2. The capture uses a low level of verbosity (indicated by 1). Because the filter does not specify either
host as the source or destination in the IP header (src or dst), the sniffer captures both forward and reply traffic.
Commands that you would type are highlighted in bold; responses from the FortiWeb appliance are not bolded.
FortiWeb# diagnose network sniffer packet port1 'host 192.168.0.2 or host 192.168.0.1 and tcp
port 80' 1
A specific number of packets to capture is not specified. As a result, the packet capture continues until the administrator
presses Ctrl+C. The sniffer then confirms that five packets were seen by that network interface. Below is a sample
output.
192.168.0.2.3625 -> 192.168.0.1.80: syn 2057246590
192.168.0.1.80 -> 192.168.0.2.3625: syn 3291168205 ack 2057246591
192.168.0.2.3625 -> 192.168.0.1.80: ack 3291168206
192.168.0.2.3625 -> 192.168.0.1.80: psh 2057246591 ack 3291168206
192.168.0.1.80 -> 192.168.0.2.3625: ack 2057247265
5 packets received by filter
0 packets dropped by kernel
Example
The following example captures TCP port 443 (typically HTTPS) traffic occurring through port1, regardless of its
source or destination IP address. The capture uses a high level of verbosity (indicated by 3).
The number of packets to capture is not specified, so the packet capture continues until the administrator presses
Ctrl+C. The sniffer then states how many packets were seen by that network interface.
Verbose output can be very long. As a result, output shown below is truncated after only one packet.
Commands that you would type are highlighted in bold; responses from the FortiWeb appliance are not bolded.
FortiWeb# diagnose network sniffer packet port1 'tcp port 443' 3
interfaces=[port1]
filters=[tcp port 443]
10.651905 192.168.0.1.50242 -> 192.168.0.2.443: syn 761714898
0x0000 0009 0f09 0001 0009 0f89 2914 0800 4500 ..........)...E.
0x0010 003c 73d1 4000 4006 3bc6 d157 fede ac16 .<s.@.@.;..W....
0x0020 0ed8 c442 01bb 2d66 d8d2 0000 0000 a002 ...B..-f........
0x0030 16d0 4f72 0000 0204 05b4 0402 080a 03ab ..Or............
Instead of reading packet capture output directly in your CLI display, you usually should save the output to a plain text
file using your CLI client. Saving the output provides several advantages. Packets can arrive more rapidly than you may
be able to read them in the buffer of your CLI display, and many protocols transfer data using encodings other than US-
ASCII. It is often, but not always, preferable to analyze the output by loading it into in a network protocol analyzer
application such as Wireshark (http://www.wireshark.org/).
For example, you could use PuTTY or Microsoft HyperTerminal to save the sniffer output to a file. Methods may vary.
See the documentation for your CLI client.
Requirements
4. In the upper left corner of the window, click the PuTTY icon to open its drop-down menu, then select
Change Settings.
5. In the Category tree on the left, go to Session > Logging.
6. Select Printable output.
7. In Log file name, click the Browse button, then choose a directory path and file name such as
C:\Users\MyAccount\packet_capture.txt to save the packet capture to a plain text file. You do not need
to save it with the .log file extension.
8. Click Apply.
9. Press Enter to send the CLI command to the FortiMail appliance, beginning packet capture.
10. If you have not specified a number of packets to capture, when you have captured all packets that you want to
analyze, press Ctrl + C to stop the capture.
These lines are a PuTTY timestamp and a command prompt, which are not part of the packet capture. If you do not
delete them, they could interfere with the script in the next step.
14. Convert the plain text file to a format recognizable by your network protocol analyzer application.
You can convert the plain text file to a format recognizable by Wireshark (.pcap) using the fgt2eth.pl Perl
script. To download fgt2eth.pl, see the Fortinet Knowledge Base article "Using the FortiOS built-in packet
sniffer:"
http://kb.fortinet.com/kb/documentLink.do?externalId=11186
The fgt2eth.pl script is provided as-is, without any implied warranty or technical support, and requires that you
first install a Perl module compatible with your operating system.
To use fgt2eth.pl, open a command prompt, then enter a command such as the following:
fgt2eth.pl -in packet_capture.txt -out packet_capture.pcap
where:
l fgt2eth.pl is the name of the conversion script; include the path relative to the current directory, which is indicated
by the command prompt
l packet_capture.txt is the name of the packet capture’s output file; include the directory path relative to your
current directory
l packet_capture.pcap is the name of the conversion script’s output file; include the directory path relative to your
current directory where you want the converted output to be saved
15. Open the converted file in your network protocol analyzer application. For further instructions, see the
documentation for that application.
Use this command to view a list of TCP raw socket details, including:
l rem_address—Remote host’s network interface and port number pair. If not connected, this will contain
00000000:0000.
l st—TCP state code (e.g. OA for listening, 01 for established, or 06 for timeout wait)
l tx_queue—Kernel memory usage by the transmission queue.
l rx_queue—Kernel memory usage by the retransmission queues.
l tr, tm-> when, retrnsmt—Kernel socket state debugging information.
l uid—User ID of the socket’s creator (on FortiWeb, always 0).
l timeout—Connection timeout.
l inode—Pseudo-file system i-node of the process.
To use this command, your administrator account’s access control profile must have at least r permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
diagnose network tcp list
Example
diagnose network tcp list
sl local_address rem_address st tx_queue rx_queue tr tm->when retrnsmt uid timeout inode
0: DD01010A:0050 00000000:0000 0A 00000000:00000000 00:00000000 00000000 0 0 333597 1
ffff88003b825880 299 0 0 2 -1
1: 2F7814AC:0050 00000000:0000 0A 00000000:00000000 00:00000000 00000000 0 0 228018 1
ffff88003b824680 299 0 0 2 -1
2: 1B01A8C0:0050 00000000:0000 0A 00000000:00000000 00:00000000 00000000 0 0 2692 1
ffff88003b6ec6c0 299 0 0 2 -1
3: 0100007F:0050 00000000:0000 0A 00000000:00000000 00:00000000 00000000 0 0 2691 1
ffff88003b6eccc0 299 0 0 2 -1
4: 00000000:0016 00000000:0000 0A 00000000:00000000 00:00000000 00000000 0 0 2433 1
ffff88003b489280 299 0 0 2 -1
5: 00000000:0017 00000000:0000 0A 00000000:00000000 00:00000000 00000000 0 0 2400 1
ffff88003b489880 299 0 0 2 -1
6: 0100007F:22B8 00000000:0000 0A 00000000:00000000 00:00000000 00000000 0 0 2687 1
ffff88003b488680 299 0 0 2 -1
7: DD01010A:01BB 00000000:0000 0A 00000000:00000000 00:00000000 00000000 0 0 333598 1
ffff88003bbf3940 299 0 0 2 -1
8: 2F7814AC:01BB 00000000:0000 0A 00000000:00000000 00:00000000 00000000 0 0 228017 1
ffff88003b824080 299 0 0 2 -1
9: 1B01A8C0:01BB 00000000:0000 0A 00000000:00000000 00:00000000 00000000 0 0 2689 1
ffff88003b6ed8c0 299 0 0 2 -1
10: 0100007F:01BB 00000000:0000 0A 00000000:00000000 00:00000000 00000000 0 0 2688 1
ffff88003b488080 299 0 0 2 -1
11: 00000000:208D 00000000:0000 0A 00000000:00000000 00:00000000 00000000 0 0 2441 1
ffff88003b488c80 299 0 0 2 -1
12: 2F7814AC:0016 E17814AC:FEF2 01 00000000:00000000 02:000909FE 00000000 0 0 272209 4
ffff88003bbf2d40 20 3 1 5 -1
Related topics
l "network arp" on page 602
l "network ip" on page 603
Use this command to view a list of UDP raw socket details, including:
Syntax
diagnose network udp list
Example
diagnose network udp list
sl local_address rem_address st tx_queue rx_queue tr tm->when retrnsmt uid timeout inode ref
pointer drops
307: 00000000:00A1 00000000:0000 07 00000000:00000000 00:00000000 00000000 0 0 2498 2
ffff88003acba080 0
447: 00000000:3F2D 00000000:0000 07 00000000:00000000 00:00000000 00000000 0 0 2874 2
ffff88003acbac80 0
Related topics
l "network arp" on page 602
l "network ip" on page 603
l "debug application ustack" on page 575
policy
Use this command to view the process ID, live sessions, and traffic statistics associated with a server policy.
To use this command, your administrator account’s access control profile must have at least r permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
diagnose policy pserver [list "<policy_name>"]
diagnose policy session [list "<policy_name>"]
diagnose policy traffic [list "<policy_name>"]
diagnose policy period-blockip [list "<policy_name>"]
diagnose policy period-blockip [delete "<policy_name>"]{ipv4 | ipv6}
diagnose policy "<policy_name>"
pserver [list "<policy_ Displays the status of physical servers covered by the policy. No
name>"] default.
period-blockip [delete Unblocks the specified client IP address that FortiWeb has blocked No
"<policy_name>"]{ipv4 | because it violated a rule in the specified policy with an Action default.
ipv6}
value of Period Block. (FortiWeb can still block the address
because it violates a rule in a different policy.)
No
"<policy_name>" Enter the name of an existing server policy.
default.
Example
This example shows the output of the pserver list command. The alive value indicates the status of the server
health check:
0 Failed Red
1 Passed Green
2 Disabled Grey
Related topics
l "server-policy policy" on page 146
l "network ip" on page 603
l "debug flow filter" on page 581
l "system performance" on page 659
system flash
Use this command to change the currently active firmware partition or to display partition information stored on the flash
drive.
FortiWeb appliances have 2 partitions that each contain a firmware image: one is the primary and one is the backup. If
the FortiWeb appliance is unable to successfully boot using the primary firmware partition, it may boot using the
alternative firmware partition. The second partition can contain another version of the firmware.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
mntgrp area. For details, see "Permissions" on page 51.
Syntax
diagnose system flash default <partition_int>
diagnose system flash list
<partition_int> Enter the number of the partition that will be used as the primary No
firmware partition during the next reboot or startup. The other default.
partition will become the backup firmware partition.
Example
This example lists the partition settings.
diagnose system flash list
Related topics
l "restore image" on page 648
l "system status" on page 660
system ha file-stat
Use this command to display the current status of FortiGuard subscription services files and the MD5 checksum for
system and configuration files.
Syntax
diagnose system ha file-stat
Example
Below is a sample output.
FortiWeb Security Service:
2021-01-03
Last Update Time: 2017-02-17 Method: Scheduled
Signature Build Number-0.00177
FortiWeb Antivirus Service:
2021-01-03
Last Update Time: 2017-02-17 Method: Scheduled
Regular Virus Database Version-42.00885
Extended Virus Database Version-42.00814
FortiWeb IP Reputation Service:
2021-01-03
Last Update Time: 2017-02-17 Method: Scheduled
Signature Build Number-3.00315
System files MD5SUM: 5660BD9FA1F6C86E8A31B2A139045F17
CLI files MD5SUM: 71BF206315679018536D9E19B37CBEAE
Related topics
l "ha disconnect" on page 634
l "ha manage" on page 636
system ha mac
Use this command to display the virtual MAC addresses and link statuses of each network interface of appliances in the
HA group.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
diagnose system ha mac
Example
This example indicates that the links are “up” (linkfail=0) for port1 and port3 on the currently active appliance in the
HA pair. While operating in HA, the network interfaces are using a Layer 1 data link (MAC) address that begins with the
hexadecimal string 00:09:0F:09:00:.
diagnose system ha mac
Related topics
l "ha disconnect" on page 634
l "ha manage" on page 636
l "system ha status" on page 617
l "system status" on page 660
l system ha
system ha status
Use this command to display the HA group ID, as well as the serial number, role (active or standby), and device priority
of each appliance belonging to the HA cluster.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
diagnose system ha status
Example
This example lists the HA group ID, serial numbers, and device priorities.
diagnose system ha status
In this example, in the information for FV-1KD3A13800012, 4 is the priority of the appliance and 0 is the number of
ports that have been down.
If the value of the priority or ports down is 100, the parameter is “invalid.” For example, if the appliance has not yet
joined the HA cluster.
Related topics
l "ha disconnect" on page 634
l "ha manage" on page 636
l "system ha status" on page 617
l "system status" on page 660
system ha sync-stat
Use this command to display the status of the high availability (HA) synchronization process.
Syntax
diagnose system ha sync-stat
Status Description
Status Description
Example
This example lists the HA synchronization status.
diagnose system ha sync-stat
Below is a sample output.
Image INIT
Config INIT
System INIT
CLI INIT
Signature SUCCESS
GeoDB SUCCESS
AV SUCCESS
IpReputation SUCCESS
HarvestCredentials SUCCESS
Related topics
l "ha disconnect" on page 634
l "ha manage" on page 636
l "system ha status" on page 617
l "system status" on page 660
l
system kill
Use this command to terminate a process currently running on FortiWeb, or send another signal from the FortiWeb OS
to the process.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
mntgrp area. For details, see "Permissions" on page 51.
Syntax
diagnose system kill <delay_int> <delay_int>
Related topics
l "system top " on page 621
l "hardware cpu" on page 592
l "hardware mem" on page 596
l "system performance" on page 659
system mount
Use this command to display a list of mounted file systems, including their available disk space, disk usage, and mount
locations.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
mntgrp area. For details, see "Permissions" on page 51.
Syntax
diagnose system mount list
Example
diagnose system mount list
Related topics
l "hardware logdisk info" on page 595
l "hardware raid list" on page 599
system top
Use this command to view a list of the most system-intensive processes and to change the refresh rate.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
mntgrp area. For details, see "Permissions" on page 51.
Syntax
diagnose system top [<delay_int> [<delay_int> ]]
<max-lines> Set the maximum number of top processes to display. All processes are shown.
Once you execute this command, it continues to run and display in the CLI window until you enter q (quit).
While the command is running, you can press Shift + P to sort the five columns of data by CPU usage (the default)
or Shift + M to sort by memory usage.
Example
This example displays a list of the top FortiWeb processes and sets the update interval at 10 seconds.
diagnose system top 10
The first line indicates the up time. The second line lists the processor and memory usage, where the parameters from
left to right mean:
l S—Sleeping (idle)
l R—Running
l Z—Zombie (crashed)
l <—High priority
l N—Low priority
Related topics
l "system kill" on page 619
l "hardware cpu" on page 592
l "hardware mem" on page 596
l "system performance" on page 659
Use this command to display recent error messages and the following information about FortiGuard signatures, IP lists,
and engine packages and the geography-to-IP mapping database:
l Current version
l Time of last update
l Next scheduled update time
l Previous version history
Syntax
diagnose system update info
Example
FortiWeb signature
----------
Version: 0.00146
Expiry Date: Thu Jan 01 1970
Last Update Date: Sat Dec 05 11:00:46 2015
Next Update Date: Wed Jan 13 11:00:00 2016
Historical versions
----------
0.00146
0.00144
0.00144
0.00144
0.00139
FortiWeb GEODB
----------
Version: GEO-533LITE 20141104
Expiry Date: N/A
Last Update Date: Tue Dec 01 10:53:35 2015
Next Update Date: N/A
Historical versions
----------
GEO-533LITE 20141007
N/A
Regular Antivirus
----------
Version: 30.00946
Expiry Date: Thu Mar 13 2014
Last Update Date: Sat Dec 05 11:03:30 2015
Next Update Date: Wed Jan 13 11:00:00 2016
Historical versions
----------
30.00859
30.00785
30.00698
29.00326
29.00302
29.00279
29.00256
14.00922
Extended Antivirus
----------
Version: 30.00871
Expiry Date: Thu Mar 13 2014
Last Update Date: Sat Dec 05 11:03:30 2015
Next Update Date: Wed Jan 13 11:00:00 2016
Historical versions
----------
30.00708
30.00540
29.00219
14.00922
IP Reputation
----------
Version: 2.00649
Expiry Date: Thu Jan 01 1970
Last Update Date: Sat Dec 05 11:00:46 2015
Next Update Date: Wed Jan 13 11:00:00 2016
Historical versions
----------
2.00642
2.00635
2.00628
2.00596
2.00594
2.00592
2.00590
1.00020
Latest errors
----------
Wed Jan 13 10:04:02 2016 Failed to establish connection with 192.168.100.205:443 when install anti-
virus packages.
Wed Jan 13 10:03:02 2016 Failed to establish connection with 192.168.100.205:443 when install
essential packages.
Wed Jan 13 10:02:00 2016 Failed to establish connection with 192.168.100.205:443 when install anti-
virus packages.
Wed Jan 13 10:01:00 2016 Failed to establish connection with 192.168.100.205:443 when install
essential packages.
Wed Jan 13 09:04:06 2016 Failed to establish connection with 192.168.100.205:443 when install anti-
virus packages.
Wed Jan 13 09:03:06 2016 Failed to establish connection with 192.168.100.205:443 when install
essential packages.
Wed Jan 13 09:02:04 2016 Failed to establish connection with 192.168.100.205:443 when install anti-
virus packages.
Wed Jan 13 09:01:04 2016 Failed to establish connection with 192.168.100.205:443 when install
essential packages.
Wed Jan 13 08:04:07 2016 Failed to establish connection with 192.168.100.205:443 when install anti-
virus packages.
Wed Jan 13 08:03:07 2016 Failed to establish connection with 192.168.100.205:443 when install
essential packages.
execute
The execute command has an immediate and decisive effect on your FortiWeb appliance and, for that reason, should
be used with care. Unlike config commands, most execute commands do not result in any configuration change.
db rebuild update-now
backup cert-config
To use this command, your administrator account’s access control profile must have either w or rw permission to the
mntgrp area. For details, see "Permissions" on page 51.
Syntax
execute backup cer-config <filename_str> <tftp_ipv4> [<password_str>]
Variable Description Default
<filename_str> Enter the name of the file to be used for the backup file, such as No
FortiWeb_backup.zip. default.
No
<tftp_ipv4> Enter the IP address of the TFTP server.
default.
Example
This example backs up certificates of the FortiWeb appliance on a TFTP server at IP address 192.0.2.23. The file is
encrypted with the password P@ssword1.
execute backup cert-config tftp FortiWeb_backup.zip 192.0.2.23 P@ssword1
Related topics
l "backup cli-config" on page 626
l "backup full-config" on page 627
l "system backup" on page 215
backup cli-config
Use this command to manually back up the configuration file to a TFTP server.
l Error pages
l WSDL files
l W3C Schema
l Vulnerability scan settings
If your configuration has these files, use either a full TFTP or FTP/SFTP backup
instead. For details, see "backup full-config" on page 627 or "system backup" on page
215.
This command also does not include settings that remain at their default values for
the currently installed version of the firmware. If you require a backup that includes
those settings, instead use execute backup full-config (page 627).
Alternatively, you can back up the configuration to an FTP or SFTP server. For details, see "system backup" on page
215.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
mntgrp area. For details, see "Permissions" on page 51.
Syntax
execute backup cli-config tftp <filename_str> <tftp_ipv4> [<password_str>]
<filename_str> Enter the name of the file to be used for the backup file, such as No
FortiWeb_backup.conf. default.
No
<tftp_ipv4> Enter the IP address of the TFTP server.
default.
Example
This example uploads the FortiWeb appliance’s system configuration to a file named fweb.zip on a TFTP server at IP
address 192.0.2.23. The file will not be password-encrypted.
execute backup cli-config tftp fweb.zip 192.0.2.23
Related topics
l "backup full-config" on page 627
l "restore config" on page 647
l "system backup" on page 215
backup full-config
Use this command to manually back up the entire configuration file, including those settings that remain at their
default values, to a TFTP server.
We strongly recommend that you password-encrypt this backup and store it in a secure
location. This backup method includes sensitive data such as your HTTPS certificates’
private keys. Unauthorized access to private keys compromises the security of all HTTPS
requests using those certificates.
Alternatively, you can back up the configuration to an FTP or SFTP server. For details, see "system backup" on page
215.
This backup includes settings that remain at their default values increases the file size of the backup, but may be useful
in some cases, such as when you want to compare the default settings with settings that you have configured.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
mntgrp area. For details, see "Permissions" on page 51.
Syntax
execute backup full-config tftp <filename_str> <tftp_ipv4> [<password_str>]
<filename_str> Enter the name of the file to be used for the backup file, such as No
FortiWeb_backup.conf. default.
No
<tftp_ipv4> Enter the IP address of the TFTP server.
default.
Example
This example uploads the FortiWeb appliance’s entire configuration, including uploaded error page and HTTPS
certificate files, to a file named fweb.zip on a TFTP server at IP address 192.0.2.23. The file is encrypted with the
password P@ssword1.
execute backup full-config tftp fweb.zip 192.0.2.23 P@ssword1
Related topics
l "backup cli-config" on page 626
l "system backup" on page 215
backup web-protection-profile
Use this command to back up web protection profiles of a FortiWeb appliance to a TFTP server.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
mntgrp area. For details, see "Permissions" on page 51.
Syntax
execute backup web-protection-profile <filename_str> <tftp_ipv4>[<password_str>]
Variable Description Default
No
<tftp_ipv4> Enter the IP address of the TFTP server.
default.
Example
This example backs up web protection profiles of the FortiWeb appliance on a TFTP server at IP address
192.0.2.23. The file is encrypted with the password P@ssword1.
execute backup web-protection-profile tftp config.zip 192.0.2.23 P@ssword1
Related topics
l "system backup" on page 215
batch
Use this command to execute commands in a group. If a command in the group fails or an operation cannot be
completed, every command in the group can be rolled back, whether they were successful or not.
To use this command, your administrator account’s access control profile must have at least r permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
execute batch start
execute batch status
execute batch lastlog
lastlog Enter to view the executed commands in the current batch mode. No
default.
create-raid level
Currently, only RAID level 1 is supported, and only on FortiWeb 1000B/C/D/E, 2000E, 3000C/CFsx, 3000E, and 4000E
shipped with FortiWeb 4.0 MR1 or later.
On older appliances that have been upgraded to FortiWeb 4.0 MR1, RAID cannot be activated.
Back up the data regularly. RAID is not a substitute for regular backups. RAID 1
(mirroring) is designed to improve hardware fault tolerance, but cannot negate all
risks.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
execute create-raid level {raid1}
level {raid1} Enter the RAID level. Currently, only RAID level 1 is supported. raid1
Related topics
l "system raid" on page 293
l "hardware raid list" on page 599
l "create-raid rebuild" on page 631
create-raid rebuild
Currently, only RAID level 1 is supported, and only on FortiWeb-1000B, 1000C, 3000C/CFsx, 3000E, and 4000E
shipped with FortiWeb 4.0 MR1 or later.
On older appliances that have been upgraded to FortiWeb 4.0 MR1, RAID cannot be activated.
Back up the data regularly. RAID is not a substitute for regular backups. RAID 1
(mirroring) is designed to improve hardware fault tolerance, but cannot negate all
risks.
Rebuilding the array due to disk failure may result in some loss of packet log data.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
execute create-raid rebuild
Example
This example rebuilds the RAID array.
execute create-raid rebuild
Related topics
l "system raid" on page 293
l "hardware raid list" on page 599
date
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
execute date <date_str>
date <date_str> Enter the current date for the FortiWeb appliance’s time zone, No
using the format yyyy-mm-dd, where: default.
Example
This example sets the date to September 23, 2017:
execute date 2017-09-23
Related topics
l "time" on page 654
db rebuild
Use this command to rebuild the FortiWeb appliance’s internal database that it uses to store log messages.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
mntgrp area. For details, see "Permissions" on page 51.
Syntax
execute db rebuild
Related topics
l "formatlogdisk" on page 634
l "debug application miglogd" on page 569
l "debug upload" on page 590
erase-disk
This command requires a console connection to the appliance and is available only when Federal Information
Processing Standards (FIPS) and Common Criteria (CC) compliant mode is enabled. For details, see "system fips-cc"
on page 248.
Syntax
execute erase-disk { flash | disk } [<erase-times> ]
{ flash | disk } Specify whether to erase the flash memory or the hard disk. No
default.
factoryreset
Use this command to reset the FortiWeb appliance to its default settings for the currently installed firmware version. If
you have not upgraded or downgraded the firmware, this restores factory default settings.
Back up your configuration first. This command resets all changes that you have made to
the FortiWeb appliance’s configuration file and reverts the system to the default values for
the firmware version. Depending on the firmware version, this could include factory default
settings for the IP addresses of network interfaces. For details about creating a backup,
see "backup cli-config" on page 626.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
mntgrp area. For details, see "Permissions" on page 51.
Syntax
execute factoryreset
Related topics
l "backup cli-config" on page 626
l "backup full-config" on page 627
l "restore config" on page 647
formatlogdisk
Use this command to clear the logs from the FortiWeb appliance’s hard disk and reformat the disk.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
When you execute this command, the FortiWeb appliance displays the following message:
This operation will clear all data on the log disk and take a few minutes according to the
disk size!!
Do you want to continue? (y/n)
Syntax
execute formatlogdisk
Related topics
l "db rebuild" on page 632
ha disconnect
Use this command to manually force a FortiWeb appliance to leave the HA group, without unplugging any cables. This
can be useful, for example, if you need to remove a standby appliance from the HA cluster in order to configure it for
standalone operation, and want to do so without disrupting traffic, and without unplugging cables.
l Active—Failover occurs. The standby remains as a member of the HA group, and will elect itself as the new active
appliance, assuming all of the HA cluster’s configured IP addresses and traffic processing duties.
l Standby—No failover occurs. The active appliance remains actively processing traffic.
To ensure that you can re-connect to the ejected appliance’s GUI or CLI via a remote network connection (not only via
its local console), this command requires that you specify an IP address and port name that will become its new
management interface. By default, it will be accessible via HTTP, HTTPS, SSH, and telnet.
All other network interfaces on the ejected appliance will be brought down and reset to 0.0.0.0/0.0.0.0. To configure
them, you must connect to the ejected appliance’s GUI or CLI.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
execute ha disconnect <serial-number_str> <interface_name> <interface_
ipv4mask/ipv6mask>
disconnect <serial- Enter the serial number of the FortiWeb appliance that you No
number_str> want to disconnect from the cluster. default.
Enter the name of the network interface, such as port1, that will No
<interface_name>
be configured as the ejected appliance’s management interface. default.
<interface_ Enter the IP address and netmask that will be configured as the No
ipv4mask/ipv6mask> ejected appliance’s management interface. default.
Example
This example ejects the standby appliance whose serial number is FV-1KC3R11111111, assigning its port1 to be the
web UI interface, reachable at 192.0.2.123.
execute ha disconnect FV-1KC3R11111111 port1 192.0.2.123/24 192::2:123/64
After the command completes, to reconfigure the ejected appliance, you could then use either a web browser or SSH
client to connect to 192.0.2.123 in order to reconfigure it for standalone operation.
Related topics
l "ha disconnect" on page 634
l "ha manage" on page 636
l "ha md5sum" on page 637
l "system ha status" on page 617
l "system ha mac" on page 617
l "system status" on page 660
ha manage
Use this command to log in to another appliance in the HA group via the HA link. In most cases, you log into a standby
appliance (also called the secondary, or slave) from the main (primary or master) appliance, but you can also use a
standby appliance to access the main appliance.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
execute ha manage <cluster-index>
Example
In this example, you are logged in to the main appliance.
execute ha manage ?
<id> please input peer box index.
<2> Subsidary unit FV-1KD3A12345678
<3> Subsidary unit FV-1KD3A11345678
The cluster index and serial number of the appliance you are currently logged in to is not displayed.
Enter 3 to connect to the standby appliance with serial number FV-1KD3A11345678. The CLI prompt changes to the
host name of this unit and the login prompt is displayed.
Related topics
l "ha disconnect" on page 634
l "ha md5sum" on page 637
l "ha synchronize" on page 637
l "system ha status" on page 617
l "system ha mac" on page 617
ha md5sum
Use this command to retrieve the CLI system configuration MD5 from the appliances in an HA cluster.
Syntax
execute ha md5sum
Example
Below is a sample output.
FortiWeb # execute ha md5sum
FV-1KD3A15800048<Master>
SYS: A4BA318B0762E202B4CAE44173F08CB5
CLI: 408268C68309651DC4C9D8C094B1EF0F
FV-1KD3A14800059<Slave>
SYS: A4BA318B0762E202B4CAE44173F08CB5
CLI: 408268C68309651DC4C9D8C094B1EF0F
Related topics
l "ha disconnect" on page 634
l "ha manage" on page 636
ha synchronize
Use this command to manually control the synchronization of configuration files and FortiGuard service-related
packages from the active HA appliance to the standby appliance.
Typically, most HA synchronization happens automatically, whenever changes are made. However, in some cases, you
may want to use this command to manually initiate full or partial HA synchronization, including to
l Delay synchronization to a more convenient time if you are planning to make large batch changes, and therefore delayed
synchronization is preferable for network performance reasons
l Manually force synchronization of files that are not automatically synchronized
l Trigger automatic synchronization if it has been interrupted due to HA link failure, daemon crashes, etc.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
execute ha synchronize {all | avupd | cli | geodb | sys}
https://support.fortinet.com
l sys—Only the IP Reputation Database (IRDB) and
system files such as X.509 certificates.
Example
This example shows how to manually synchronize the virus signature and engine package to the standby appliance.
FortiWeb # execute ha synchronize avupd
starting synchronize with HA master...
Related topics
l "ha disconnect" on page 634
l "ha manage" on page 636
l "ha md5sum" on page 637
ping
Use this command to perform an ICMP ECHO request (also called a ping) to a host by specifying its fully qualified
domain name (FQDN) or IPv4 address, using the options configured by ping-options.
To use this command, your administrator account’s access control profile must have at least r permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
execute ping {<host_fqdn> | <host_ipv4>}
ping {<host_fqdn> | Type either the IPv4 address or fully qualified domain name No
<host_ipv4>} (FQDN) of the host. default.
Example
This example pings a host with the IP address 192.0.2.10.
execute ping 192.0.2.10
The results indicate that a route exists between the FortiWeb appliance and 192.0.2.10. It also indicates that during
the sample period, there was no packet loss, and the average response time was 0.2 milliseconds.
Example
This example pings a host with the IP address 192.0.2.78.
execute ping 192.0.2.78
After several seconds, no output appears. The administrator halts the ping by pressing Ctrl+C. The CLI displays the
following:
--- 192.0.2.78 ping statistics ---
5 packets transmitted, 0 packets received, 100% packet loss
The results indicate the host may be down, or there is no route between the FortiWeb appliance and 192.0.2.78. To
determine the point of failure along the route, further diagnostic tests are required, such as execute traceroute
(page 655).
Related topics
l "system interface" on page 280
l "server-policy vserver" on page 196
l "ping-options" on page 641
l "ping6" on page 640
l "telnettest" on page 653
l "traceroute" on page 655
l "network ip" on page 603
l "hardware nic" on page 597
l "network sniffer" on page 607
ping6
Use this command to perform an ICMP ECHO request (also called a ping) to a host by specifying its IPv6 address, using
the options configured in execute ping-options (page 641).
To use this command, your administrator account’s access control profile must have at least r permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
execute ping6 {<host_fqdn> | <host_ipv6>}
ping6 {<host_fqdn> | Enter either the IP address or fully qualified domain name (FQDN) No
<host_ipv6>} of the host. default.
Example
This example pings a host with the IP address 2001:0db8:85a3:::8a2e:0370:7334.
execute ping6 2607:f0b0:f:420::
After several seconds, no output appears. The administrator halts the ping by pressing Ctrl+C. The CLI displays the
following:
--- 2607:f0b0:f:420:: ping statistics ---
5 packets transmitted, 0 packets received, 100% packet loss
The results indicate the host may be down, or there is no route between the FortiWeb appliance and
2607:f0b0:f:420::. To determine the point of failure along the route, further diagnostic tests are required, such as
execute traceroute (page 655).
Related topics
l "system interface" on page 280
l "server-policy vserver" on page 196
l "ping6-options" on page 643
l "telnettest" on page 653
l "traceroute" on page 655
l "network ip" on page 603
l "hardware nic" on page 597
l "network route" on page 604
l "network sniffer" on page 607
ping-options
Use these commands to configure the behavior of the execute ping (page 638) command.
To use this command, your administrator account’s access control profile must have at least r permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
execute ping-options data-size <bytes_int>
execute ping-options df-bit {yes | no}
execute ping-options pattern <bufferpattern_hex>
execute ping-options repeat-count <repeat_int>
execute ping-options source {auto | <interface_ipv4>}
execute ping-options timeout <seconds_int>
execute ping-options tos {<service_type>}
execute ping-options ttl <hops_int>
execute ping-options validate-reply {yes | no}
execute ping-options view-settings
data-size <bytes_int> Enter datagram size in bytes.This allows you to send out 56
packets of different sizes for testing the effect of packet size
on the connection. If you want to configure the pattern that
will be used to buffer small datagrams to reach this size, also
configure pattern <bufferpattern_hex> (page 642).
source {auto | Select the network interface from which the ping is sent. Enter auto
<interface_ipv4>} either auto or a FortiWeb network interface IP address.
No
view-settings Display the current ping option settings.
default.
Example
This example sets the number of pings to three and the source IP address to 192.0.2.1, then views the ping options
to verify their configuration.
execute ping-option repeat-count 3
execute ping-option source 192.0.2.1
execute ping-option view-settings
Related topics
l "ping" on page 638
l "traceroute" on page 655
ping6-options
Use these commands to configure the behavior of the execute ping6 (page 640) command.
To use this command, your administrator account’s access control profile must have at least r permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
execute ping6-options data-size <bytes_int>
execute ping6-options pattern <bufferpattern_hex>
execute ping6-options repeat-count <repeat_int>
execute ping6-options source {auto | <interface_ipv6>}
execute ping6-options timeout <seconds_int>
execute ping6-options tos {<service_type>}
execute ping6-options ttl <hops_int>
execute ping6-options validate-reply {yes | no}
execute ping6-options view-settings
data-size <bytes_int> Enter datagram size in bytes. This allows you to send out 56
packets of different sizes for testing the effect of packet size
on the connection. If you want to configure the pattern that
will be used to buffer small datagrams to reach this size, also
configure pattern <bufferpattern_hex> (page 642).
source {auto | Select the network interface from which the ping is sent. Enter
auto
<interface_ipv6>} either auto or a FortiWeb network interface IP address.
l lowdelay—Minimize delay.
l reliability—Maximize reliability.
l throughput—Maximize throughput.
Example
This example sets the number of pings to 3, then views the ping options to verify their configuration.
execute ping6-option repeat-count 3
execute ping6-option view-settings
Related topics
l "ping6" on page 640
l "traceroute" on page 655
reboot
To use this command, your administrator account’s access control profile must have either w or rw permission to the
mntgrp area. For details, see "Permissions" on page 51.
Syntax
execute reboot
Example
This example shows the reboot command in action.
execute reboot
If you are connected to the CLI through a local console, the CLI displays messages while the reboot is occurring.
If you are connected to the CLI through the network, the CLI will not display any notification while the reboot is
occurring, as this occurs after the network interfaces have been shut down. Instead, you may notice that the connection
is terminated. Time required by the reboot varies by many factors, such as whether or not hard disk verification is
required, but may be several minutes.
Related topics
l "shutdown" on page 651
l "system performance" on page 659
remove vmlicense
To use this command, your administrator account’s access control profile must have either w or rw permission to the
mntgrp area. For details, see "Permissions" on page 51.
https://docs.fortinet.com/fortiweb/hardware
Syntax
execute remove vmlicense
Example
This example shows the remove command in action.
execute remove vmlicense
Related Topics
l "restore vmlicense" on page 650
restore cert-config
Use this command to restore certificates of a FortiWeb appliance from a TFTP server.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
mntgrp area. For details, see "Permissions" on page 51.
Syntax
execute restore cer-config <filename_str> <tftp_ipv4>[<password_str>]
Variable Description Default
<filename_str> Enter the name of the file to be used for the backup file, such as No
FortiWeb_backup.zip. default.
No
<tftp_ipv4> Enter the IP address of the TFTP server.
default.
Example
This example restores certificates of the FortiWeb appliance on a TFTP server at IP address 192.0.2.23. The file is
encrypted with the password P@ssword1.
execute restore cert-config tftp FortiWeb_backup.zip 192.0.2.23 P@ssword1
Related topics
l "restore config" on page 647
restore config
Use this command to restore the configuration from a configuration backup file on an TFTP server, or to install primary
or backup firmware.
Back up the configuration before restoring the configuration. This command restores
configuration changes only, and does not affect settings that remain at their default values.
Default values may vary by firmware version. For backup commands, see "backup cli-
config" on page 626 and "backup full-config" on page 627.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
mntgrp area. For details, see "Permissions" on page 51.
Syntax
execute restore config tftp <filename_str> <tftp_ipv4> [<password_str>]
No
<tftp_ipv4> Enter the IP address of the TFTP server.
default.
[<password_str>] Enter the password that was used to encrypt the backup file, if No
any. default.
Example
This example downloads a configuration file named backup.zip from the TFTP server, 192.0.2.23, to the
FortiWeb appliance. The backup file was encrypted with the password P@ssword1.
execute restore config tftp backup.zip 192.0.2.23 P@ssword1
The FortiWeb appliance then applies the configuration backup and reboots.
Related topics
l "backup full-config" on page 627
l "restore config" on page 647
l "restore image" on page 648
l "restore secondary-image" on page 649
restore image
Use this command to install firmware on the primary partition and reboot.
Back up the configuration before installing new firmware. Installing new firmware can
change default settings and reset settings that are incompatible with the new version. For
backup commands, see "backup full-config" on page 627 and "backup cli-config" on page
626.
Unlike installing firmware via TFTP during a boot interrupt, installing firmware using this command will attempt to
preserve settings and files, and not necessarily restore the FortiWeb appliance to its firmware/factory default
configuration.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
mntgrp area. For details, see "Permissions" on page 51.
Syntax
execute restore image ftp <filename_str> <ftp_ipv4>
execute restore image tftp <filename_str> <tftp_ipv4>
No
<ftp_ipv4> Enter the IP address of the TFTP server.
default.
Example
This example installs a firmware file named firmware.out from the TFTP server, 192.0.2.23, to the FortiWeb
appliance.
execute restore image tftp firmware.out 192.0.2.23
The FortiWeb appliance downloads the firmware file, installs it, and reboots.
Related topics
l "backup cli-config" on page 626
l "backup full-config" on page 627
l "restore config" on page 647
l "restore secondary-image" on page 649
restore secondary-image
Use this command to install backup firmware on the secondary partition and reboot.
Back up the configuration before installing new firmware. Installing new firmware can
change default settings and reset settings that are incompatible with the new version. For
backup commands, see "backup full-config" on page 627 and "backup cli-config" on page
626.
Unlike installing firmware via TFTP during a boot interrupt, installing firmware using this command will attempt to
preserve settings and files, and not necessarily restore the FortiWeb appliance to its firmware/factory default
configuration.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
mntgrp area. For details, see "Permissions" on page 51.
Syntax
execute restore secondary-image ftp <filename_str> <ftp_ipv4>
execute restore secondary-image tftp <filename_str> <tftp_ipv4>
No
<ftp_ipv4> Enter the IP address of the FTP server.
default.
Example
This example installs a firmware file named firmware.out from the TFTP server, 192.0.2.23, to the FortiWeb
appliance.
execute restore secondary-image tftp firmware.out 192.0.2.23
The FortiWeb appliance downloads the firmware file, installs it, and reboots.
Related topics
l "backup cli-config" on page 626
l "backup full-config" on page 627
restore vmlicense
Use this command to upload a FortiWeb-VM license file from an FTP or TFTP server.
After you enter the command, FortiWeb prompts you to confirm the upload.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
mntgrp area. For details, see "Permissions" on page 51.
For more information on FortiWeb-VM licenses, see the FortiWeb-VM Install Guide:
https://docs.fortinet.com/fortiweb/hardware
Syntax
execute restore vmlicense {ftp | tftp} "<license-file_str>" {"<ftp_ipv4>" | "<user_
str>" :"<password_str>" @"<ftp_ipv4>" | "<tftp_ipv4>" }
{ftp | tftp} Specify whether to connect to the server using file transfer No
protocol (FTP) or trivial file transfer protocol (TFTP). default.
No
"<license-file_str>" Enter the name of the license file.
default.
No
"<tftp_ipv4>" Enter the IP address of the TFTP server.
default.
Example
This example uploads the license file FVVM040000010871.lic from the TFTP server 192.0.2.23 to the FortiWeb
appliance.
execute restore vmlicense tftp FVVM040000010871.lic 192.0.2.23
The FortiWeb appliance uploads the file, and then prompts you to log out and log in again.
session-cleanup
To use this command, your administrator account’s access control profile must have either w or rw permission to the
mntgrp area. For details, see "Permissions" on page 51.
Syntax
execute session-cleanup
shutdown
Use this command to prepare the FortiWeb appliance to be powered down by halting the software, clearing all buffers,
and writing all cached data to disk.
Power off the FortiWeb appliance only after issuing this command. Unplugging or
switching off the FortiWeb appliance without issuing this command could result in data
loss.
To use this command, your administrator account’s access control profile must have either w or rw permission to the
mntgrp area. For details, see "Permissions" on page 51.
Syntax
execute shutdown
Example
This example shows the reboot command in action.
execute shutdown
If you are connected to the CLI through a local console, the CLI displays a message when the shutdown is complete.
If you are connected to the CLI through the network, the CLI will not display any notification when the shutdown is
complete, as this occurs after the network interfaces have been shut down. Instead, you may notice that the connection
times out.
Related topics
l "reboot" on page 644
telnet
Use this command to open a Telnet connection to a server using IPv4 to port 23.
Telnet connections are not secure. Eavesdroppers could easily obtain your administrator
password. Only use telnet over a trusted, physically secured network, such as a direct
connection between your computer and the appliance.
To use this command, your administrator account’s access control profile must have at least r permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
execute telnet "<host_ipv4>"
Example
This example Telnets to a host with the IP address 192.0.2.10.
execute telnet 192.0.2.10
login: admin
Password: *******
Related topics
l "telnettest" on page 653
l "ping" on page 638
l "ping6" on page 640
telnettest
Use this command to open a Telnet connection to a server using an IPv4 or IPv6 address or fully qualified domain name
(FQDN). This command can be useful for troubleshooting. For example, when the server does not support the HTTP
versions, methods, headers, and so on, that the client uses.
Telnet connections are not secure. Eavesdroppers could easily obtain your administrator
password. Only use Telnet over a trusted, physically secured network, such as a direct
connection between your computer and the appliance, and from the appliance to the
server.
To use this command, your administrator account’s access control profile must have at least r permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
execute telnettest {"<host_ipv4>" | "<host_ipv6>" | "<host_fqdn>"}
telnettest {"<host_ Enter the IP address or fully qualified domain name (FQDN) of the No
ipv4>" | "<host_ipv6>" | host. default.
"<host_fqdn>"}
Example
This example Telnets to a host with the IPv4 address 192.0.2.10 on port 80, the IANA standard port for HTTP.
FortiWeb# exec telnettest 192.0.2.10:80
Connected
GET /
Related topics
l "telnet" on page 652
l "ping" on page 638
l "ping6" on page 640
time
To use this command, your administrator account’s access control profile must have either w or rw permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
execute time [<time_str>]
time [<time_str>] Enter the current date for the FortiWeb appliance’s time zone, No
using the format hh:mm:ss, where: default.
Example
This example sets the system time to 15:31:03:
execute time 15:31:03
Related topics
l "date" on page 632
traceroute
Use this command to use ICMP to test the connection between the FortiWeb appliance and another network device,
and display information about the time required for network hops between the device and the FortiWeb appliance.
To use this command, your administrator account’s access control profile must have at least r permission to the
sysgrp area. For details, see "Permissions" on page 51.
Syntax
execute traceroute {"<host_fqdn>" | "<host_ipv4>"}
traceroute {"<host_ Enter either the IP address or fully qualified domain name (FQDN) No
fqdn>" | "<host_ipv4>"} of the host. default.
Example
This example tests connectivity between the FortiWeb appliance and docs.fortinet.com. In this example, the trace
times out after the first hop, indicating a possible connectivity problem at that point in the network.
FortiWeb# execute traceroute docs.fortinet.com
traceroute to docs.fortinet.com (65.39.139.196), 30 hops max, 38 byte packets
1 192.0.2.200 (192.0.2.200) 0.324 ms 0.427 ms 0.360 ms
2 * * *
Example
This example tests the availability of a network route to the server example.com.
execute traceroute example.com
Example
This example attempts to test connectivity between the FortiWeb appliance and example.com. However, the FortiWeb
appliance could not trace the route, because the primary or secondary DNS server that the FortiWeb appliance is
configured to query could not resolve the FQDN example.com into an IP address, and it therefore did not know to
which IP address it should connect. As a result, an error message is displayed.
FortiWeb# execute traceroute example.com
traceroute: unknown host example.com
Command fail. Return code 1
To resolve the error message in order to perform connectivity testing, the administrator would first configure the
FortiWeb appliance with the IP addresses of DNS servers that can resolve the FQDN example.com. For details, see
"system dns" on page 242.
Related topics
l "ping" on page 638
l "ping-options" on page 641
l "network ip" on page 603
l "hardware nic" on page 597
l "network sniffer" on page 607
update-now
Use this command to initiate an update of the predefined robots, data types, suspicious URLS, and attack signatures
used by your FortiWeb appliance.
FortiWeb appliances receive updates from the FortiGuard Distribution Network (FDN). The FDN is a world-wide network
of FortiGuard Distribution Servers (FDS). FortiWeb appliances connect to the FDN by connecting to the FDS nearest to
the FortiWeb appliance by its configured time zone.
The time required for the update varies with the availability of the updates, the size of the updates, and the speed of the
FortiWeb appliance’s network connection. If event logging is enabled, and the FortiWeb appliance cannot connect
successfully, it will log the message update failed, failed to connect any fds servers! or
FortiWeb is unauthorized
To use this command, your administrator account’s access control profile must have either w or rw permission to the
mntgrp area. For details, see "Permissions" on page 51.
Syntax
execute update-now
get
The get command displays parts of your FortiWeb appliance’s configuration in the form of a list of settings and their
values.
Unlike show, get displays all settings, even if they are still in their default state.
Notice that the command displays the setting for the secondary DNS server, even though it has not been configured, or
has reverted to its default value.
Also unlike show, unless used from within an object or table, get requires that you specify the object or table whose
settings you want to display.
Like show, depending on whether or not you have specified an object, get may display one of two different outputs,
either the configuration that you have just entered but not yet saved, or as it currently exists on the flash disk.
For example, immediately after configuring the secondary DNS server setting but before saving it, get displays two
different outputs (differences highlighted in bold):
FortiWeb# config system dns
FortiWeb (dns)# set secondary 192.0.2.10
FortiWeb (dns)# get
primary : 192.0.2.19
secondary : 192.0.2.10
domain : example.com
FortiWeb (dns)# get system dns
primary : 192.0.2.19
secondary : 0.0.0.0
domain : example.com
The first output from get indicates the value that you have configured but not yet saved; the second output from get
indicates the value that was last saved to disk.
If you were to now enter end, saving your setting to disk, get output for both syntactical forms would again match.
However, if you were to enter abort at this point and discard your recently entered secondary DNS setting instead of
saving it to disk, the FortiWeb appliance’s configuration would therefore match the second output, not the first.
If you have entered settings but cannot remember how they differ from the existing
configuration, the two different forms of get, with and without the object name, can be a
useful way to remind yourself.
Most get commands, such as get system dns, are used to display configured settings. You can find relevant
information about such commands in the corresponding config commands in the config chapter.
Other get commands, such as get system performance (page 659), are used to display system information that
is not configurable. This chapter describes this type of get command.
The get commands require at least read (r) permission to applicable administrator profile groups.
Although not explicitly shown in this section, for all config commands, there are
related get and show commands which display that part of the configuration. get
and show commands use the same syntax as their related config command,
unless otherwise mentioned. For syntax examples and descriptions of each
configuration object, field, and option, see "config " on page 65.
When ADOMs are enabled, if you log in as admin, the top level of the shell changes: the two top level items are get
global and get vdom:
l get global displays settings that only admin or other accounts with the prof_admin access profile can change.
l get vdom displays each ADOM and its respective settings.
This menu and CLI structure change is not visible to non-global accounts; ADOM administrators’ navigation menus continue
to appear similar to when ADOMs are disabled, except that global settings such as network interfaces, HA, and other global
settings do not appear.
system fortisandbox-statistics
Use this command to display a count of uploaded files that FortiSandbox has evaluated in the past seven days, by
evaluation result.
Syntax
get system fortisandbox-statistics
Example
FortiWeb # get system fortisandbox-statistics
detected : 0
clean : 0
risk-low : 0
risk-medium : 0
risk-high : 0
Related topics
l "system fortisandbox" on page 257
l "waf file-upload-restriction-policy" on page 384
l "log reports" on page 83
system performance
Displays the FortiWeb appliance’s CPU usage, memory usage, average system load, and up time.
Normal idle load varies by hardware platform, firmware, and configured features. To determine your specific baseline
for idle, configure your system completely, reboot, then view the system load. After at least 1 week of uptime with
typical traffic volume, view the system load again to determine the normal non-idle baseline.
System load is the average of percentages relative to the maximum possible capability of this FortiWeb appliance’s
hardware. It includes:
Syntax
get system performance
Example
FortiWeb # get system performance
CPU states: 4% used, 96% idle
Memory states: 18% used
System Load: 1
Up: 28 days, 11 hours, 38 minutes
Related topics
l "system status" on page 660
l "hardware cpu" on page 592
l "hardware mem" on page 596
l "hardware raid list" on page 599
system status
Syntax
get system status
Example
get system status
International Version:FortiWeb-1000C 5.01,build0039,130726
Serial-Number:FV-1KC3R11700094
Bios version:04000002
Log hard disk:Available
Hostname:FortiWeb
Operation Mode:Reverse Proxy
Current HA mode=active-passive, Status=main
HA member :
Serial-Number Priority HA-Role
FV-1KC3R11700136 5 standby
FV-1KC3R11700094 1 main
Related topics
l "system performance" on page 659
l "system ha status" on page 617
waf predefined-global-white-list
Use this command to get the global object white list. This feature reduces false positives and improves performance.
Syntax
get waf predefined-global-white-list
waf signature-rules
Use this command to list the IDs, names, and descriptions of signature rules.
You specify signatures in the config waf signature command using the signature ID only. This command allows
you to view the names and descriptions of the IDs.
Syntax
get waf signature-rules
Example
get waf signature-rules
This example output is the first four entries that the CLI displays when FortiWeb is configured with the default
signatures only.
rule id : 110000009
main class id : 110000000
main class name : Bad Robot
sub class id : 000000000
sub class name : Bad Robot
rule description : This signature prevents Google Skipfish scanner from exploiting a
vulnerability to include an arbitrary remote file with malicious PHP code and executing it
in the context of the webserver process.
This attack can be achieved in HTTP request arguments.
rule id : 110000010
main class id : 110000000
main class name : Bad Robot
sub class id : 000000000
sub class name : Bad Robot
rule description : This signature checks whether the request came from Google Skipfish Web
scanner.
The signature check region: user-agent field in http request header.
rule id : 110000011
main class id : 110000000
main class name : Bad Robot
sub class id : 000000000
sub class name : Bad Robot
rule description : This signature checks whether the request contains a string of a content
scraper, which could be a part of virus.
The signature check region: user-agent field in http request header.
rule id : 110000012
Related topics
l "waf signature" on page 462
show
The show command displays parts of your FortiWeb appliance’s configuration in the form of commands that are
required to achieve that configuration from the firmware’s default state.
The show commands require at least read (r) permission to applicable administrator profile groups.
Although not explicitly shown in this section, for all config commands, there are
related get and show commands which display that part of the configuration. get
and show commands use the same syntax as their related config command,
unless otherwise mentioned. For syntax examples and descriptions of each
configuration object, field, and option, see "config " on page 65.
Unlike get, show does not display settings that are assumed to remain in their default state.
Like get, depending on whether or not you have specified an object, show may display one of two different outputs,
either the configuration:
If you have entered settings but cannot remember how they differ from the existing
configuration, the two different forms of show, with and without the object name, can be a
useful way to remind yourself.
If you were to now enter end, saving your setting to disk, show output for both syntactical forms would again match.
However, if you were to enter abort at this point and discard your recently entered secondary DNS setting instead of
saving it to disk, the FortiWeb appliance’s configuration would therefore match the second output, not the first.
When ADOMs are enabled, and if you log in as admin, the top level of the shell changes: the two top level items are show
global and show vdom.
l show global displays settings that only admin or other accounts with the prof_admin access profile can change.
l show vdom displays each ADOM and its respective settings.
This menu and CLI structure change is not visible to non-global accounts; ADOM administrators’ navigation menus continue
to appear similar to when ADOMs are disabled, except that global settings such as network interfaces, HA, and other global
settings do not appear.