21
6 May 2015 Administration Guide SmartLog R77 Classification: [Protected]

SmartLog Administration Guide R77docshare01.docshare.tips/files/28328/283288560.pdf · R77 and R77.10: In the Log Servers Connection window, select Single Log Server, and click OK

  • Upload
    others

  • View
    9

  • Download
    0

Embed Size (px)

Citation preview

Page 1: SmartLog Administration Guide R77docshare01.docshare.tips/files/28328/283288560.pdf · R77 and R77.10: In the Log Servers Connection window, select Single Log Server, and click OK

6 May 2015

Administration Guide

SmartLog

R77

Classification: [Protected]

Page 2: SmartLog Administration Guide R77docshare01.docshare.tips/files/28328/283288560.pdf · R77 and R77.10: In the Log Servers Connection window, select Single Log Server, and click OK

© 2015 Check Point Software Technologies Ltd.

All rights reserved. This product and related documentation are protected by copyright and distributed under licensing restricting their use, copying, distribution, and decompilation. No part of this product or related documentation may be reproduced in any form or by any means without prior written authorization of Check Point. While every precaution has been taken in the preparation of this book, Check Point assumes no responsibility for errors or omissions. This publication and features described herein are subject to change without notice.

RESTRICTED RIGHTS LEGEND:

Use, duplication, or disclosure by the government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.227-7013 and FAR 52.227-19.

TRADEMARKS:

Refer to the Copyright page (http://www.checkpoint.com/copyright.html) for a list of our trademarks.

Refer to the Third Party copyright notices (http://www.checkpoint.com/3rd_party_copyright.html) for a list of relevant copyrights and third-party licenses.

Page 3: SmartLog Administration Guide R77docshare01.docshare.tips/files/28328/283288560.pdf · R77 and R77.10: In the Log Servers Connection window, select Single Log Server, and click OK

Important Information Latest Software

We recommend that you install the most recent software release to stay up-to-date with the latest functional improvements, stability fixes, security enhancements and protection against new and evolving attacks.

Latest Documentation

The latest version of this document is at: (http://supportcontent.checkpoint.com/documentation_download?ID=24814)

For additional technical information, visit the Check Point Support Center (http://supportcenter.checkpoint.com).

For more about this release, see the R77 home page (http://supportcontent.checkpoint.com/solutions?id=sk104859).

Revision History

Date Description

6 May 2015 Fixed Working with More than One Log Server (on page 8)

Added Aggregated Logs to Running Queries (on page 10)

17 July 2014 Cover changed to be relevant for all R77 versions

Added Show/Hide User identity ("Working with the Results Pane" on page 12) icon to Results Pane toolbar

Added note to Query Language Overview (on page 15) topic

1 January 2014 Added Configuring Query Defaults

26 August 2013 First release of this document

Feedback

Check Point is engaged in a continuous effort to improve its documentation.

Please help us by sending your comments (mailto:[email protected]?subject=Feedback on SmartLog R77 Administration Guide).

Page 4: SmartLog Administration Guide R77docshare01.docshare.tips/files/28328/283288560.pdf · R77 and R77.10: In the Log Servers Connection window, select Single Log Server, and click OK

Contents

Important Information ............................................................................................................ 3 Introduction ............................................................................................................................ 5

Enabling Logging on a Security Management Server or Domain Log Server ....................... 5 Starting and Stopping the SmartLog Index Server ............................................................... 6 Activating SmartLog on Multi-Domain Security Management .............................................. 6 SmartLog User Interface ..................................................................................................... 7

Using the Query Results Timeline ................................................................................... 8 Working with More than One Log Server ............................................................................. 8 Minimum Disk Space ........................................................................................................... 9

Managing the Event Database ........................................................................................ 9 Working with Queries .......................................................................................................... 10

Running Queries ............................................................................................................... 10 Working with Query Settings ............................................................................................. 11 Working with the Favorites List .......................................................................................... 11

Adding a Query to the Favorites List ............................................................................. 11 Creating a New Folder .................................................................................................. 12 Deleting a Folder .......................................................................................................... 12

Working with the Results Pane .......................................................................................... 12 Showing Query Results ................................................................................................ 13 Customizing the Results Pane ...................................................................................... 13 Exporting Query Results ............................................................................................... 13

Creating Custom Queries .................................................................................................. 14 Selecting Query Fields .................................................................................................. 14 Selecting Criteria from Grid Columns ............................................................................ 14 Manually Entering Query Criteria .................................................................................. 14

Query Syntax ........................................................................................................................ 15 Query Language Overview ................................................................................................ 15 Criteria Values ................................................................................................................... 15

IP Addresses ................................................................................................................ 16 IP Address Ranges ....................................................................................................... 16 Numeric Ranges ........................................................................................................... 16 Null Values ................................................................................................................... 16

Wildcards .......................................................................................................................... 16 Using Wildcards with IP Addresses ............................................................................... 17

Field Keywords .................................................................................................................. 17 Boolean Operators ............................................................................................................ 18 Date and Time Queries ..................................................................................................... 19

Preceding Time Period Queries .................................................................................... 19 From-To Queries .......................................................................................................... 20

Index ..................................................................................................................................... 21

Page 5: SmartLog Administration Guide R77docshare01.docshare.tips/files/28328/283288560.pdf · R77 and R77.10: In the Log Servers Connection window, select Single Log Server, and click OK

SmartLog Administration Guide R77 | 5

Chapter 1

Introduction

In This Section:

Enabling Logging on a Security Management Server or Domain Log Server .......... 5

Starting and Stopping the SmartLog Index Server ................................................... 6

Activating SmartLog on Multi-Domain Security Management .................................. 6

SmartLog User Interface ........................................................................................... 7

Working with More than One Log Server .................................................................. 8

Minimum Disk Space ................................................................................................ 9

SmartLog reads and indexes logs generated by Check Point and OPSEC products. You can use this data to:

Detect and monitor security-related events. For example, alerts, rejected connections, and failed authentication attempts can indicate intrusion attempts.

Collect data on problematic issues. For example, a client is authorized to create a connection, but cannot connect. SmartLog shows that the Rule Base incorrectly blocks the client connection attempts.

Analyze network traffic patterns. For example, find out how many HTTP services were used during peak activity.

What sets SmartLog apart from other log utilities is its power, ease of use, and speed. The SmartLog Index Server gets log files from many log servers and indexes them for rapid data extraction. SmartLog includes a powerful query language that lets you create your own queries in minutes.

SmartLog is part of the R77 SmartConsole installation.

Enabling Logging on a Security Management Server or Domain Log Server

You must enable Logging & Status Software Blade on the Security Management Server and on all Log Server.

To enable logging on a Security Management Server or Log Server:

1. Open SmartConsole.

2. In the Gateways view, double-click the Security Management Server or Log Server.

The General Properties window opens.

3. In the Management tab, select Logging & Status.

4. From the navigation tree, click Logs.

This shows the Security Gateways that forward logs to this machine.

5. Make sure that Enable SmartLog is selected.

It is enabled by default. If you clear this option, it will take much more time to search the logs.

6. Click OK.

7. Click Publish.

Page 6: SmartLog Administration Guide R77docshare01.docshare.tips/files/28328/283288560.pdf · R77 and R77.10: In the Log Servers Connection window, select Single Log Server, and click OK

Introduction

SmartLog Administration Guide R77 | 6

Starting and Stopping the SmartLog Index Server When you activate the SmartLog Index Server, it continuously indexes logs on management and log

servers. To stop the SmartLog Index Server, run smartlogstop from the command line. To restart the

SmartLog Index Server, run smartlogstart from the command line.

Activating SmartLog on Multi-Domain Security Management

SmartLog in a Multi-Domain Security Management environment works on the Multi-Domain Server. This server is used to query results from the Domain Management Servers and Multi-Domain Log Servers.

SmartLog on the Multi-Domain Server is active by default. Each Domain Management Server and Multi-Domain Log Server can be activated separately.

To activate SmartLog on the Multi-Domain Security Management:

1. Open the SmartDomain Manager > General Multi-Domain Server Contents.

2. Right-click the Domain Management Server and select Launch Application > SmartDashboard.

3. In the properties of the Domain Management Server object > Logs, select Enable SmartLog.

Do this also for the Multi-Domain Log Servers objects.

4. Click OK and then Save.

5. In the SmartDomain Manager > General Multi-Domain Server Contents, double-click the Multi-Domain Server object.

6. Select Enable SmartLog.

7. Click OK.

8. Start the SmartLog console.

SmartLog can be used to access the Domain Management Servers or Multi-Domain Log Servers directly, or through the Multi-Domain Server.

When you connect through the Multi-Domain Server, on the left pane, SmartLog shows the Domain Management Servers and Multi-Domain Log Servers that you can select as query targets. The results are a collection of logs from the selected Domain Management Servers and Multi-Domain Log Servers (that match the query).

Page 7: SmartLog Administration Guide R77docshare01.docshare.tips/files/28328/283288560.pdf · R77 and R77.10: In the Log Servers Connection window, select Single Log Server, and click OK

Introduction

SmartLog Administration Guide R77 | 7

SmartLog User Interface

Item Description

1 Favorites - Shows list of predefined queries. Select a query in this list to run it.

2 Back/Forward - Scroll backward and forward between recent queries.

3 Log pane toolbar - Lets you select the grid or table view for the Log pane. You can also show IP addresses and ports as numbers or their resolved names.

4 Query Definition field - Shows the query definition for the most recent query. You also define custom queries in this field using the GUI tools or manually entering query criteria.

5 Top Results pane - Shows the top results of the most recent query.

6 Results pane - Shows the log entries for the most recent query.

7 Log Details pane - Shows the detailed contents of the most recently selected log record.

8 Query Results Timeline - Shows a chart of the current query results over time.

9 Disk Space Indicator - Bar graph that shows used and available disk space in the /var/log

partition. Put the cursor over the indicator to see how much space is used by log files and other data.

Page 8: SmartLog Administration Guide R77docshare01.docshare.tips/files/28328/283288560.pdf · R77 and R77.10: In the Log Servers Connection window, select Single Log Server, and click OK

Introduction

SmartLog Administration Guide R77 | 8

Toolbar Icons

Launch Menu - Opens the menu.

Grid view - Detailed tabular view. You can select the fields to show and change the order and width of the columns.

Table view - Summary view that shows basic information. This view is suitable for small windows, but cannot be customized.

Hide user identity - Hides the source user name in the Results pane,

Resolve - Resolves IP addresses and services to their names, if possible.

SmartConsoles - Open SmartConsole clients.

Using the Query Results Timeline

The Query Results Timeline shows the results of the current query as a horizontal bar graph. By default, the graphs shows the number of incidents during the last seven days.

By default the Query Results Timeline is enabled and shows under the Results Pane. To disable it, Click the X icon in the upper right-hand corner of the timeline. To enable the timeline, select View > Timeline from the menu bar.

The ability to change the time frame on the timeline is intentionally not documented because this feature does not work properly.

Working with More than One Log Server You can include log records from more than one Log Server in your SmartLog queries. The Log Servers must all be managed by the same Security Management Server. SmartLog automatically indexes logs on all Log Servers. The Timeline and Top Results pane are not available when working with more than one Log Server.

To see logs from more than one Log Server:

1. Select Tools > Log servers connection.

2. R77 and R77.10: In the Log Servers Connection window, select Multiple log servers, and click OK.

R77.20 and higher: Select Reads logs from multiple log servers.

3. On the Log Servers pane (on the left), select the log servers to include in your queries. By default, all servers are selected.

If you have many log servers with large log files, it may take a long time to index the servers. Please be patient. The Top Results pane does not show.

To see logs from only the connected Log Server:

1. Select Tools > Log servers connection.

2. R77 and R77.10: In the Log Servers Connection window, select Single Log Server, and click OK.

R77.20 and higher: Select Reads logs only from connected server.

The Top Results pane shows in the user interface.

To see logs from more than one Domain Log Server:

In a Multi-Domain Security Management environment, the SmartLog queries include log records from all the Domain Log Servers that are managed by the same Multi-Domain Server.

Page 9: SmartLog Administration Guide R77docshare01.docshare.tips/files/28328/283288560.pdf · R77 and R77.10: In the Log Servers Connection window, select Single Log Server, and click OK

Introduction

SmartLog Administration Guide R77 | 9

Minimum Disk Space SmartLog creates and uses index files for fast access to log file contents. The index files are located by

default at $SMARTLOGDIR/data.

To make sure that there is always sufficient disk space on the server, SmartLog deletes the oldest index entries when the available disk space is less than a specified minimum. The default minimum value is 10,240 MB.

To change the minimum available disk space value:

1. On the SmartLog index server command line, go to $SMARTLOGDIR.

2. Open smartlog_settings.txt in a text editor.

3. Add this line to the section:

:min_disk_space (space), where space = the minimum available disk space in MB.

The default value is 10240 MB, which is in effect when there is no :min_disk_space line in the

smartlog_settings.txt file. A smaller number will let the index file contain more entries before it

automatically deletes the oldest records.

Managing the Event Database

SmartLog uses an optimization algorithm to manage disk space and other system resources. When the SmartLog database becomes too large, the oldest events are automatically deleted to save space. Also, events that are more than one year old are automatically deleted.

For instructions to change maximum period and maximum database size to save past events in SmartEvent database, see sk73640 (http://supportcontent.checkpoint.com/solutions?id=sk73640).

Page 10: SmartLog Administration Guide R77docshare01.docshare.tips/files/28328/283288560.pdf · R77 and R77.10: In the Log Servers Connection window, select Single Log Server, and click OK

SmartLog Administration Guide R77 | 10

Chapter 2

Working with Queries

In This Section:

Running Queries ..................................................................................................... 10

Working with Query Settings ................................................................................... 11

Working with the Favorites List ............................................................................... 11

Working with the Results Pane ............................................................................... 12

Creating Custom Queries ....................................................................................... 14

SmartLog lets you quickly and easily create log queries. The query results show in the Results pane. SmartLog comes with many predefined queries that are ready to run right out of the box. You can create your own custom queries and save them for future use.

Running Queries You can run a SmartLog an existing query or create a custom query ("Creating Custom Queries" on page 14).

To run a query:

Click Favorites and select a predefined or custom query.

Or

Click in the Query Definition field and select a recent query.

To create and run a query:

1. Click in the Query Definition field.

2. Enter or select query criteria.

The query runs automatically. As you add more criteria, results are updated dynamically.

To manually refresh your query:

Click the Refresh icon.

To continuously refresh your query (Auto-Refresh):

Click the Auto-Refresh icon. The icon is highlighted when you enable Auto-Refresh.

The query updates every two seconds while Auto-Refresh is enabled. If the number of logs is greater than 20 in any two-second period, logs are aggregated, and a summary view shows. To see all logs that have been aggregated in a specific time interval, click View.

To stop refreshing your query:

Click Auto-Refresh icon. The icon is not highlighted when you deactivate Auto-Refresh.

Page 11: SmartLog Administration Guide R77docshare01.docshare.tips/files/28328/283288560.pdf · R77 and R77.10: In the Log Servers Connection window, select Single Log Server, and click OK

Working with Queries

SmartLog Administration Guide R77 | 11

Working with Query Settings You can use the Query Settings to:

Define the default query that runs when you open SmartLog

Set the number of items that show in the Top Results pane.

Sets the time, in seconds, that the Top Results show after running a query.

To define the default query:

1. Go to Menu > Tools > Query Settings.

The Query Settings window opens.

2. Enter a query (using the query syntax) in the Default Query field.

Tip: Select a query or Define a query in the Query Definition field. Then copy and paste it into the Default Query field.

If no default query is specified, SmartLog runs the All Records query.

3. Click OK.

To configure the Top Results:

1. Go to Menu > Tools > Query Settings.

The Query Settings window opens.

2. In the Maximum top results field, enter the number of results to show (default =10).

3. In the Show top results after field, enter the time interval allocated for calculation of top results (default=10 seconds).

Note - SmartLog stops collecting top results after 150000 log entries or after 10 seconds, whichever happens first. To change these limits, refer to sk74800 http://supportcontent.checkpoint.com/solutions?id=sk74800.

4. To get top results from Multi-Domain Log Server and multiple Log Servers:

a) Select Show top results from Multi-Domain Log Server and multiple Log Servers.

b) Enter the maximum number of Simultaneous connections to Log Servers (default=3).

Note - top results are collected from all Log Servers in groups of size configured in Simultaneous connections.

5. Click OK.

Working with the Favorites List The Favorites list lets you work with predefined and saved custom queries. The predefined queries are organized into folders by Software Blade. You can add new queries to existing folder or create new folders hold them.

You can do these actions with the Favorites list:

Add new custom queries

Add new query folders

Delete queries

In this version, you cannot move a query from one folder to a different folder.

Adding a Query to the Favorites List

To add a folder to the Favorites list:

1. From the Favorites menu, select Add to Favorites.

2. In the Add to Favorites window, enter a name for the new query.

The query criteria show in the Query field.

Page 12: SmartLog Administration Guide R77docshare01.docshare.tips/files/28328/283288560.pdf · R77 and R77.10: In the Log Servers Connection window, select Single Log Server, and click OK

Working with Queries

SmartLog Administration Guide R77 | 12

3. Select a folder from the list or click Create a New Folder.

4. Click Add.

Creating a New Folder

You can use folders to help you organize custom queries into logical groups. Folders can be created inside of other folders.

You can also do this procedure while adding a new query to the favorites list.

To create a new folder:

1. From the Favorites menu, select Add to Favorites.

2. In the Add to Favorites window, click the Folder list.

3. Select Create a New Folder from the list.

4. In the Create a Folder window, enter a name for the new folder.

5. Select a folder to contain the new folder.

6. Click Add.

Deleting a Folder

You can delete folders that are no longer necessary.

Important - When you delete a folder, you also delete any queries included in that folder. We recommend that you carefully look at folder contents before deleting it. In this release, you cannot move a query from one folder to a different one.

To delete a folder:

1. From the Favorites menu, select Organize Favorites.

2. In the Organize Favorites folder, select the folder to be deleted.

3. Click Delete.

4. Click Close.

Working with the Results Pane You can control how the data shows on in the results.

Select Grid View. This shows log records in a detailed tabular view. You can select the fields that show and can change the column order and width.

Select Table View. This shows a short summary of basic log data. You cannot customize this view.

Show or Hide User Identity.

Show resolved IP addresses and service names.

Scroll down to increase the quantity of query results that show.

Export query results to a CSV file.

Page 13: SmartLog Administration Guide R77docshare01.docshare.tips/files/28328/283288560.pdf · R77 and R77.10: In the Log Servers Connection window, select Single Log Server, and click OK

Working with Queries

SmartLog Administration Guide R77 | 13

Showing Query Results

Query results can include tens of thousands of log records. To prevent performance degradation, SmartLog only shows the first set of results in the Results pane. Typically, this is 50 results.

Scroll down to show more results. As you scroll down, SmartLog extracts more records from the SmartLog Index Server and adds them to the results set. The number of results shows above the Results pane.

For example, on the first run of a query, you can see the first 50 results (128 ms), out of over 150,000 results. When you scroll down, you can see the first 100 results (128 ms), out of over 150,000 results.

Customizing the Results Pane

By default, SmartLog shows a predefined set of columns and information based on the selected blade in your query. This is known as the Column Profile. If no blade is specified, a column profile is assigned based on the blade that occurs most frequently in the query results.

The Column Profile defines which columns appear in the Results Pane and in which order. You can change the Column Profile as necessary for your environment. You can sort the results by the actual event date and time or by the time that the event index arrived to the SmartLog Server.

To use the default Column Profile assignments, right-click a column heading and select Columns Profile > Automatic Profile Selection. This option is enabled by default.

To manually assign Column Profile assignments by default, right-click a column heading and select Columns Profile > Manual Profile Selection.

To manually assign a different Column Profile:

1. Right-click a column heading and select Columns Profile.

2. Select a Column Profile from the options menu.

To change a Column Profile:

1. Right-click a column heading and select Columns Profile > Edit Columns Profile.

2. In the Show Fields window, select a Column Profile to change.

3. Select fields to add from the Available Fields column and click Add.

4. Select fields to remove from the Selected Fields column and click Remove.

5. Select a field in the Selected Fields and then click Move Up or Move Down to change its position in the Results Pane.

6. Double click the Width column to change the default column width for the selected field.

You can drag the right-hand column border in the Results Pane to change the column width. This action is only applicable to the current session. The width defined in the Column Profile will show when you start a new SmartLog session.

To change the sort query order:

1. Right-click the Time column.

2. Select Sort by time or Sort by arrival order as applicable.

Exporting Query Results

SmartLog lets you export queries to a comma separated value (CSV) file. You can then use Microsoft Excel or other database programs to further analyze the data information print reports.

SmartLog only exports the query result included in the result set. You must scroll down to add more records to the result set. The actual number of results in the result set, shows below the Query Definition pane.

To export query results:

1. Create or run a query in SmartLog.

2. Scroll down in the Results pane until a sufficient quantity of records show.

3. From the File menu, select Export > Excel CSV.

4. Enter the file name and path and then click Save.

Page 14: SmartLog Administration Guide R77docshare01.docshare.tips/files/28328/283288560.pdf · R77 and R77.10: In the Log Servers Connection window, select Single Log Server, and click OK

Working with Queries

SmartLog Administration Guide R77 | 14

Creating Custom Queries Queries can include one or more criteria. You can create custom queries using one or a combination of these basic procedures:

Right-click columns in the grid view and select Add Filter.

Click in the Query Definition field and then select the fields and filter criteria for those fields.

Manually enter filter criteria in the Query Definition field.

A good way to create a new custom query is to run an existing query and then use one of these procedures to change it. You can save the new query in the Favorites list.

When you create complex queries, SmartLog suggests, or automatically enters, an appropriate Boolean operator. This can be an implied AND operator, which does not explicitly show.

Selecting Query Fields

You can enter query criteria directly from the Query Definition field.

To select field criteria from the Query Definition field:

1. If you are starting a new query, remove query definitions: click Clear

2. Put the cursor in the Query Definition Field.

3. Select a criterion from the drop-down list or enter the criteria in the Query Definition field.

The query runs automatically.

Selecting Criteria from Grid Columns

You can use the column headings in the Grid view to select query criteria. This option is not available in the Table view.

To select query criteria from grid columns:

1. In the Results pane, right-click on a column heading.

2. Select Add Filter.

3. Select or enter the filter criteria. The criteria show in the Query Definition field and the query runs automatically.

You can continue to enter more criteria using this or other procedures.

Manually Entering Query Criteria

You can always type query criteria directly in the Query Definition field. You can manually create a new query or make changes to an existing query that shows in the Query Definition field.

As you type, SmartLog helps you by showing recently used query criteria or even complete queries. To use these suggestions, simply select them from the drop down list. If you make a syntax error in a query, SmartLog shows a helpful error message that identifies the error and suggests a solution.

Page 15: SmartLog Administration Guide R77docshare01.docshare.tips/files/28328/283288560.pdf · R77 and R77.10: In the Log Servers Connection window, select Single Log Server, and click OK

SmartLog Administration Guide R77 | 15

Chapter 3

Query Syntax

In This Section:

Query Language Overview ..................................................................................... 15

Criteria Values......................................................................................................... 15

Wildcards ................................................................................................................ 16

Field Keywords........................................................................................................ 17

Boolean Operators .................................................................................................. 18

Date and Time Queries ........................................................................................... 19

Query Language Overview A powerful query language lets you show only selected records from the log files, according to your criteria. You can create complex queries by using Boolean operators, wildcards, fields, and ranges. This section is a detailed reference to the query language.

When you use the GUI to create a query, the applicable criteria show in the Query Definition field.

The basic query syntax is [<Field>:] <Filter Criterion>.

You can put together many criteria in one query by using Boolean operators:

[<Field>:] <Filter Criterion> AND|OR|NOT [<Field>:] <Filter Criterion> ...

Most query keywords and filter criteria are not case sensitive, but there are some exceptions. For example, Risk:High is case sensitive (Risk:high will not match). If your query results do not show the expected results, change the case of your query criteria or try both upper and lower case.

Note: When you use queries with more than one criteria value, you must explicitly enter a Boolean operator.

Criteria Values Criteria values are written as one or more text strings. You can enter one text string, such as a word, IP address or URL, without delimiters. Phrases or text strings that contain more than one word must be surrounded by apostrophes or quotation marks.

One character string examples:

richard

inbound

192.0.2.1

mahler.ts.example.com

dns_udp

Phrase examples

'John Doe'

'log out'

'VPN-1 Embedded Connector

Note - You cannot put numbers or IP addresses in quotation marks. For example, 'John 1234' is invalid.

Page 16: SmartLog Administration Guide R77docshare01.docshare.tips/files/28328/283288560.pdf · R77 and R77.10: In the Log Servers Connection window, select Single Log Server, and click OK

Query Syntax

SmartLog Administration Guide R77 | 16

IP Addresses

IPv4 and IPv6 addresses used in SmartLog queries are counted as one word. You can enter IPv4 address using dotted decimal or CIDR notation. IPv6 addresses are typically entered using CIDR notation.

You can also use the '*' wildcard character with IPv6 addresses.

Examples:

20.20.20.1

10.0.0.0/24

2001:0db8::61:1/32

2001:0db8::*

IP Address Ranges

You can use IPv4 and IPv6 address ranges in free text queries or with the source and destination fields.

Enter the range criteria using this notation: <starting IP address>-<ending IP address>

The query shows all IP addresses in the range, and includes the starting and ending addresses.

Examples:

192.0.2.0-192.0.2.255

2001:0db8::64:1-2001:0db8::64:199

Numeric Ranges

You can use ranges for numeric values in free text and numeric field queries, such as the port fields.

Syntax

<Number>-<Number>

Examples

65000-66000

port:80-660

Null Values

You can use null (empty) values with field keywords (on page 17) in SmartLog queries with one of these syntax options:

<field> ""

<field> []

You can also use the Boolean NOT operator to return fields that are not null:

NOT <field> ""

NOT <field> []

Null value queries only work with fields contained in the field keywords (on page 17) table.

Wildcards You can use the standard wildcard characters (* and ?) in queries to match variable characters or strings in log records. The wildcard character cannot be the first character in a query criterion. You can use more than wildcard character in query criteria.

Page 17: SmartLog Administration Guide R77docshare01.docshare.tips/files/28328/283288560.pdf · R77 and R77.10: In the Log Servers Connection window, select Single Log Server, and click OK

Query Syntax

SmartLog Administration Guide R77 | 17

Wildcard syntax

The ? (question mark) matches one character.

The * (asterisk) matches a character string.

Examples:

Jo* shows John, Jon, Joseph, Joshua, John Paul, and so on.

Jo? shows Joe and Jon, but not Joseph.

If your criteria value contains more than one word, you can use the wildcard in each word. For example, 'Jo* N*' shows Joe North, John Natt, Joshua Named, and so on.

Using Wildcards with IP Addresses

The wildcard character is useful when used with IPv4 addresses. It is a best practice to put the wildcard character after an IP address delimiter.

Examples:

192.168.2.* shows all records for 192.168.2.0 to 192.168.2.255 inclusive

192.168.* shows all records for 192.168.0.0 to 192.168.255.255 inclusive

Field Keywords You can use predefined field names, followed by a colon, as keywords in filter criteria. SmartLog only shows log records that match the criteria in the specified field. If you do not use field names, SmartLog shows records that contain the criteria in all fields.

This table shows the predefined field keywords. Some fields also support keyword aliases that you can type as alternatives to the primary keyword.

Keyword Keyword Aliases Description

action Action taken by a security rule

blade product Software Blade

destination dst, dest, to Traffic destination IP address, DNS name or Check Point network object name

ipproto protocol IP Protocol number

origin Name of originating Security Gateway

port dport, d_port, dst_port, destination_port

Destination TCP/UDP port

rule Security rule that generated the log entry

service Service that generated the log entry

source src, from Traffic source IP address, DNS name or Check Point network object name

source_port sport, s_port, src_port Source TCP/UDP port

user User name

The syntax for a field name query is: <field name>:<values>

Page 18: SmartLog Administration Guide R77docshare01.docshare.tips/files/28328/283288560.pdf · R77 and R77.10: In the Log Servers Connection window, select Single Log Server, and click OK

Query Syntax

SmartLog Administration Guide R77 | 18

<field name> - One of the predefined field names

<values> - One or more filter criteria

When using the Rule field as a criterion, you must specify rule number or rule UID together as one string. This is the syntax for this special case:

rule:<rule number or rule UID>/<policy name>

Examples:

source:192.0.2.1

rule:2/my_policy

action:(drop or reject or block)

You can use the OR Boolean operator in parentheses to include multiple criteria values.

Notes:

When using fields with multiple criteria values, you must explicitly write the Boolean operator. SmartLog does not automatically presume the AND operator if it is not specified.

You must use parentheses when using multiple criteria with fields.

Boolean Operators You can use the Boolean operators AND, OR, and NOT to create filters with many different criteria. You can put multiple Boolean expressions in parentheses.

If you enter more than one criteria without a Boolean operator, the AND operator is implied. When using multiple criteria without parentheses, the OR operator is applied before the AND operator.

Examples:

blade:"application control" AND action:block - Shows log records from the Application

Control and URL Filtering Software Blade where traffic was blocked.

192.0.2.133 10.19.136.101 - Includes log entries that match the two IP addresses. The AND

operator is presumed.

192.0.2.133 OR 10.19.136.101 - Includes log entries the match one of the IP addresses.

(blade:Firewall or blade:IPS or blade:VPN) AND NOT action:drop - Includes all log entries

from the Firewall, IPS or VPN blades that are not dropped. The criteria in the parentheses are applied

before the AND NOT criterion.

Source:(192.0.2.1 OR 192.0.2.2) AND destination:17.168.8.2 - Includes log entries from

the two source IP addresses if the destination IP address is 17.168.8.2. This example also shows

how you can use Boolean operators with field criteria.

Notes:

Boolean operators are not case sensitive.

Page 19: SmartLog Administration Guide R77docshare01.docshare.tips/files/28328/283288560.pdf · R77 and R77.10: In the Log Servers Connection window, select Single Log Server, and click OK

Query Syntax

SmartLog Administration Guide R77 | 19

Date and Time Queries You can define a query that shows logs generated during the preceding period of time using the last or past keywords. The applicable periods of time are:

minute

hour

day

week

month

year

The syntax for this criterion is:

last|past [<number>] <period of time>

You can specify the period of time in the singular or the plural. If you do not enter a number, the value is presumed to be the most recent period.

Examples

last 12 hours - Shows logs generated during the last 12 hours.

past 10 week - Shows logs generated during the last 10 weeks. Using the singular is permitted.

last year - Shows logs generated

Preceding Time Period Queries

You can define a query that shows logs generated during the preceding period of time using the last or past keyword.

Preceding period of time queries show log records based on the time that you run the query. For example, if

your criterion is 'last 2 weeks' at 3:15 PM, SmartLog shows all logs starting from 3:15 on the 14th day

before today. A log generated at 1:15 PM on the 14th day does not show, but one generated at 6:50 does show.

The valid periods of time are:

minute

hour

day

week

month

year

The syntax is:

last|past [<number>] <period of time>

Examples

last 12 hours - Shows logs generated during the last 12 hours before the most recent time.

past 10 week - Shows logs generated during the last 10 weeks before the most recent date and

time. This example shows that you can use the singular or plural interchangeably.

last year - Shows logs generated during the last 365 days starting from the most recent date and

time. This example shows that the default value (1) applies if no number value is entered.

Notes:

You can specify the period of time in the singular or the plural.

If you do not enter a <number> value, the number one is assumed.

Page 20: SmartLog Administration Guide R77docshare01.docshare.tips/files/28328/283288560.pdf · R77 and R77.10: In the Log Servers Connection window, select Single Log Server, and click OK

Query Syntax

SmartLog Administration Guide R77 | 20

From-To Queries

You can define queries that show log records between a starting date and time and an ending date and time. SmartLog shows records between and including the specified dates.

Syntax

dd/mmm/yyyy hh:mm:ss[-dd/mmm/yyyy hh:mm:ss]

dd - Day of the month. The leading 0 is optional.

mmm - Three character mnemonic for the month. This value is case insensitive.

yyyy - Year (four digits are required).

hh - Hour in 24 hour time notation. The leading 0 is optional.

mm - Minutes. The leading 0 is optional.

ss - Seconds. The leading 0 is optional.

Syntax Notes

You can use the yesterday and today keywords as alternatives to the date parameter. You can use

these with or without time values.

The 'to' value is optional. If not specified, SmartLog shows all values on the specified 'from' value.

The time value is optional. If no time is specified, SmartLog shows all records from 00:00 to 23:59 on the specified date.

If you specify a time value, you must specify the hours and minutes. You can ignore the second values.

The day and year values are optional. If you do not specify these values the most recent day and/or year is assumed.

You can ignore the date value. Today is assumed.

You must always specify the month value.

You cannot use wildcards with dates and times.

Examples

1/mar/2012-5/mar/2012 - Shows all logs on and between these dates.

5/mar/2012 - Shows all logs for 5 March only.

yesterday-today - Shows all logs from 00:00 yesterday to 23:59 today.

5/mar/2012 07:00-08:59 - Shows all logs from 7:00 on 5 March to 8:59 today. This example

illustrates the fact that you can ignore the date value. Today is assumed.

Page 21: SmartLog Administration Guide R77docshare01.docshare.tips/files/28328/283288560.pdf · R77 and R77.10: In the Log Servers Connection window, select Single Log Server, and click OK

Index A

Activating SmartLog on Multi-Domain Security Management • 6

Adding a Query to the Favorites List • 11

B

Boolean Operators • 18

C

Creating a New Folder • 12 Creating Custom Queries • 14 Criteria Values • 15 Customizing the Results Pane • 13

D

Date and Time Queries • 19 Deleting a Folder • 12

E

Enabling Logging on a Security Management Server or Domain Log Server • 5

Exporting Query Results • 13

F

Field Keywords • 17 From-To Queries • 20

I

Important Information • 3 Introduction • 5 IP Address Ranges • 16 IP Addresses • 16

M

Managing the Event Database • 9 Manually Entering Query Criteria • 14 Minimum Disk Space • 9

N

Null Values • 16 Numeric Ranges • 16

P

Preceding Time Period Queries • 19

Q

Query Language Overview • 15 Query Syntax • 15

R

Running Queries • 10

S

Selecting Criteria from Grid Columns • 14 Selecting Query Fields • 14 Showing Query Results • 13

SmartLog User Interface • 7 Starting and Stopping the SmartLog Index

Server • 6

U

Using the Query Results Timeline • 8 Using Wildcards with IP Addresses • 17

W

Wildcards • 16 Working with More than One Log Server • 8 Working with Queries • 10 Working with Query Settings • 11 Working with the Favorites List • 11 Working with the Results Pane • 12