Cisco Intrusion Prevention System Sensor CLI Configuration Guide for IPS 6.0
Obtaining Software
Downloads: This chapterpdf (PDF - 331.0KB) The complete bookPDF (PDF - 8.39MB) | Feedback

Obtaining Software

Table Of Contents

Obtaining Software

Obtaining Cisco IPS Software

IPS Software Versioning

Software Release Examples

Upgrading Cisco IPS Software to 6.0

Obtaining a License Key From Cisco.com

Understanding Licensing

Service Programs for IPS Products

Obtaining and Installing the License Key

Using IDM

Using the CLI

Cisco Security Intelligence Operations

Accessing IPS Documentation


Obtaining Software


This chapter provides information on obtaining Cisco IPS software for the sensor. It contains the following sections:

Obtaining Cisco IPS Software

IPS Software Versioning

Software Release Examples

Upgrading Cisco IPS Software to 6.0

Obtaining a License Key From Cisco.com

Cisco Security Intelligence Operations

Accessing IPS Documentation


Caution The BIOS on Cisco IDS/IPS sensors is specific to Cisco IDS/IPS sensors and must only be upgraded under instructions from Cisco with BIOS files obtained from the Cisco website. Installing a non-Cisco or third-party BIOS on Cisco IDS/IPS sensors voids the warranty. For more information on how to obtain instructions and BIOS files from the Cisco website, see Obtaining Cisco IPS Software.

Obtaining Cisco IPS Software

You can find major and minor updates, service packs, signature and signature engine updates, system and recovery files, firmware upgrades, and readmes on the Download Software site on Cisco.com.

Signature updates are posted to Cisco.com approximately every week, more often if needed. Service packs are posted to Cisco.com as needed. Major and minor updates are also posted periodically. Check Cisco.com regularly for the latest IPS software.


Note You must be logged in to Cisco.com to download software.You must have an active IPS maintenance contract and a Cisco.com password to download software. You must have a license to apply signature updates.


Downloading IPS Software

To download software on Cisco.com, follow these steps:


Step 1 Log in to Cisco.com.

Step 2 From the Support drop-down menu, choose Download Software.

Step 3 Under Select a Software Product Category, choose Security Software.

Step 4 Choose Intrusion Prevention System (IPS).

Step 5 Enter your username and password.

Step 6 In the Download Software window, choose IPS Appliances > Cisco Intrusion Prevention System and then click the version you want to download.


Note You must have an IPS subscription service license to download software.


Step 7 Click the type of software file you need.

The available files appear in a list in the right side of the window. You can sort by file name, file size, memory, and release date. And you can access the Release Notes and other product documentation.

Step 8 Click the file you want to download.

The file details appear.

Step 9 Verify that it is the correct file, and click Download.

Step 10 Click Agree to accept the software download rules.

The first time you download a file from Cisco.com, you must fill in the Encryption Software Export Distribution Authorization form before you can download the software.

Fill out the form and click Submit.

The Cisco Systems Inc. Encryption Software Usage Handling and Distribution Policy appears.

Read the policy and click I Accept.

The Encryption Software Export/Distribution Form appears.

If you previously filled out the Encryption Software Export Distribution Authorization form, and read and accepted the Cisco Systems Inc. Encryption Software Usage Handling and Distribution Policy, these forms are not displayed again.

The File Download dialog box appears.

Step 11 Open the file or save it to your computer.

Step 12 Follow the instructions in the Readme to install the update.


Note Major and minor updates, service packs, recovery files, signature and signature engine updates are the same for all sensors. System image files are unique per platform.



For More Information

For information on obtaining the license key, see Obtaining a License Key From Cisco.com.

For an explanation of the IPS file versioning scheme, see IPS Software Versioning.

IPS Software Versioning

When you download IPS software images from Cisco.com, you should understand the versioning scheme so that you know which files are base files, which are cumulative, and which are incremental.

Major Update

A major update contains new functionality or an architectural change in the product. For example, the IPS 6.0 base version includes everything (except deprecated features) since the previous major release (the minor update features, service pack fixes, and signature updates) plus any new changes. Major update 6.0(1) requires 5.x. With each major update there are corresponding system and recovery packages.


Note The 6.0(1) major update is only used to upgrade 5.x sensors to 6.0(1). If you are reinstalling 6.0(1) on a sensor that already has 6.0(1) installed, use the system image or recovery procedures rather than the major update.


Minor Update

A minor update is incremental to the major version. Minor updates are also base versions for service packs. The first minor update for 6.0 is 6.1(1). Minor updates are released for minor enhancements to the product. Minor updates contain all previous minor features (except deprecated features), service pack fixes, signature updates since the last major version, and the new minor features being released. You can install the minor updates on the previous major or minor version (and often even on earlier versions). The minimum supported version needed to upgrade to the newest minor version is listed in the Readme that accompanies the minor update. With each minor update there are corresponding system and recovery packages.

Service Pack

A service pack is cumulative following a base version release (minor or major). Service packs are used for the release of defect fixes with no new enhancements. Service packs contain all service pack fixes since the last base version (minor or major) and the new defect fixes being released. Service packs require the minor version. The minimum supported version needed to upgrade to the newest service pack is listed in the Readme that accompanies the service pack. Service packs also include the latest engine update. For example, if service pack 6.0(3) is released, and E3 is the latest engine level, the service pack is released as 6.0(3)E3.

Patch Release

A patch release is used to address defects that are identified in the upgrade binaries after a software release. Rather than waiting until the next major or minor update, or service pack to address these defects, a patch can be posted. Patches include all prior patch releases within the associated service pack level. The patches roll in to the next official major or minor update, or service pack.

Before you can install a patch release, the most recent major or minor update, or service pack must be installed. For example, patch release 5.0(1p1) requires 5.0(1).


Note Upgrading to a newer patch does not require you to uninstall the old patch. For example, you can upgrade from patch 5.0(1p1) to 5.0(1p2) without first uninstalling 5.0(1p1).


Figure 22-1 illustrates what each part of the IPS software file represents for major and minor updates, service packs, and patch releases.

Figure 22-1 IPS Software File Name for Major and Minor Updates, Service Packs, and Patch Releases

Signature Update

A signature update is a package file containing a set of rules designed to recognize malicious network activities. Signature updates are released independently from other software updates. Each time a major or minor update is released, you can install signature updates on the new version and the next oldest version for a period of at least six months. Signature updates are dependent on a required signature engine version. Because of this, a req designator lists the signature engine required to support a particular signature update.

Figure 22-2 illustrates what each part of the IPS software file represents for signature updates.

Figure 22-2 IPS Software File Name for Signature Updates

.

Signature Engine Update

A signature engine update is an executable file containing binary code to support new signature updates. Signature engine files require a specific service pack, which is also identified by the req designator.

Figure 22-3 illustrates what each part of the IPS software file represents for signature engine updates.

Figure 22-3 IPS Software File Name for Signature Engine Updates

Recovery and System Image Files

Recovery and system image files contain separate versions for the installer and the underlying application. The installer version contains a major and minor version field. The major version is incremented by one of any major changes to the image installer, for example, switching from .tar to rpm or changing kernels. The minor version can be incremented by any one of the following:

Minor change to the installer, for example, a user prompt added.

Repackages require the installer minor version to be incremented by one if the image file must be repackaged to address a defect or problem with the installer.

Figure 22-4 illustrates what each part of the IPS software file represents for recovery and system image filenames.

Figure 22-4 IPS Software File Name for Recovery and System Image Files

Software Release Examples

Table 22-1 lists platform-independent IDS 6.x software release examples. Refer to the Readmes that accompany the software files for detailed instructions on how to install the files.

Table 22-1 Platform-Independent Release Examples 

Release
Target Frequency
Identifier
Example Version
Example Filename

Signature update1

Weekly

sig

S700

IPS-sig-S700-req-E1.pkg

Signature engine update2

As needed

engine

E1

IPS-engine-E1-req-6.1-3.pkg

Service packs3

Semi-annually
or as needed

6.1(3)

IPS-K9-6.1-3-E1.pkg

Minor version update4

Annually

6.1(1)

IPS-K9-6.1-1-E1.pkg

Major version update5

Annually

6.0(1)

IPS-K9-6.0-1-E1.pkg

Patch release6

As needed

patch

6.0(1p1)

IPS-K9-patch-6.0-1pl-E1.pkg

Recovery package7

Annually or as needed

r

1.1-6.0(1)

IPS-K9-r-1.1-a-6.0-1-E1.pkg

1 Signature updates include the latest cumulative IPS signatures.

2 Signature engine updates add new engines or engine parameters that are used by new signatures in later signature updates.

3 Service packs include defect fixes.

4 Minor versions include new minor version features and/or minor version functionality.

5 Major versions include new major version functionality or new architecture.

6 Patch releases are for interim fixes.

7 The r 1.1 can be revised to r 1.2 if it is necessary to release a new recovery package that contains the same underlying application image. If there are defect fixes for the installer, for example, the underlying application version may still be 6.0(1), but the recovery partition image will be r 1.2.


Table 22-2 describes platform-dependent software release examples.

Table 22-2 Platform-Dependent Release Examples 

Release
Target Frequency
Identifier
Supported Platform
Example Filename

System image1

Annually

sys

Separate file for each sensor platform

IPS-4240-K9-sys-1.1-a-6.0-1-E1.img

Maintenance partition image2

Annually

mp

IDSM2

c6svc-mp.2-1-2.bin.gz

Bootloader

As needed

bl

NM CIDS
AIM IPS

servicesengine-boot-1.0-4.bin
pse_aim_x.y.z.bin (where x, y, z is the release number)

Mini-kernel

As needed

mini-kernel

AIM IPS

pse_mini_kernel_1.1.10.64.bz2

1 The system image includes the combined recovery and application image used to reimage an entire sensor.

2 The maintenance partition image includes the full image for the IDSM2 maintenance partition. The file is installed from but does not affect the IDSM2 application partition.


Table 22-3 describes the platform identifiers used in platform-specific names.


Note IDS-4235 and IDS-4250 do not use platform-specific image files.


Table 22-3 Platform Identifiers 

Sensor Family
Identifier

IDS 4215 series

4215

IPS 4240 series

4240

IPS 4255 series

4255

IPS 4260 series

4260

IPS 4270-20 series

4270_20

IDS module for Catalyst 6K

IDSM2

IDS network module

NM_CIDS

IPS network module

AIM

AIP SSM

SSM_10
SSM_20
SSM_40


For More Information

For instructions on how to access IPS software files on Cisco.com, see Obtaining Cisco IPS Software.

Upgrading Cisco IPS Software to 6.0


Note You cannot upgrade the IDSM (WS-X6381) to IPS 6.x. You must replace your IDSM (WS-X6381) with the IDSM2 (WS-SVC-IDSM2-K9), which supports version 6.x.


Pay attention to the following when upgrading to IPS 6.0:

The minimum required version for upgrading to 6.0 is 5.1. The minimum required version for upgrading to 5.1 is 5.0 The upgrades from Cisco 5.1 to 6.0 and Cisco 5.0 to 5.1 are available as a download from Cisco.com.

After downloading the 6.0 update, refer to the accompanying Readme for the procedure for installing the 6.0 update using the upgrade command.

If you configured Auto Update for your sensor, copy the 6.0 update to the directory on the server that your sensor polls for updates.

After you upgrade any IPS software on your sensor, you must restart the IDM to see the latest software features.

If you install an update on your sensor and the sensor is unusable after it reboots, you must reimage your sensor. Updating a sensor from any Cisco IDS version before 4.1 also requires you to use the recover command or the recovery/upgrade CD.

You can reimage your sensor in the following ways:

For IDS appliances with a CD-ROM drive, use the recovery/upgrade CD.

For all sensors, use the recover command.

For IDS 4215, IPS 4240, IPS 4255, IPS 4260, and IPS 4270-20 use the ROMMON to restore the system image.

For the NM CIDS, use the bootloader.

For the AIM IPS, use the bootloader.

For the IDSM2, reimage the application partition from the maintenance partition.

For the AIP SSM, reimage from the adaptive security appliance using the hw-module module 1 recover configure/boot command.


Caution When you install the system image for your sensor, all accounts are removed and the default account and password are reset to cisco.

For More Information

For the procedure for accessing downloads on Cisco.com, see Obtaining Cisco IPS Software.

For the procedure for using the upgrade command to upgrade the sensor, see Upgrading the Sensor.

For the procedure for configuring automatic update, see Configuring Automatic Upgrades.

For the procedure for using the recovery/upgrade CD, see Using the Recovery/Upgrade CD.

For the procedure for using the recover command, see Recovering the Application Partition.

For the procedures for using ROMMON to restore the system image, see Installing the IDS 4215 System Image, Installing the IPS 4240 and IPS 4255 System Image, and Installing the IPS 4260 System Image, and Installing the IPS 4270-20 System Image.

For the procedure for using the bootloader to install the NM CIDS system image, see Installing the NM CIDS System Image.

For the procedure for using the bootloader to install the AIM IPS system image, see Installing the AIM IPS System Image.

For the procedure for installing the IDSM2 system image, see Installing the IDSM2 System Image.

For the procedure for installing the AIP SSM system image, see Installing the AIP SSM System Image.

Obtaining a License Key From Cisco.com

This section describes how to obtain a license key from Cisco.com and how to install it using the CLI or IDM. This section contains the following topics:

Understanding Licensing

Service Programs for IPS Products

Obtaining and Installing the License Key

Understanding Licensing

Although the sensor functions without the license key, you must have a license key to obtain signature updates. To obtain a license key, you must have the following:

Cisco Service for IPS service contract

Contact your reseller, Cisco service or product sales to purchase a contract.

Your IPS device serial number

To find the IPS device serial number in IDM, choose Configuration > Licensing, or in the CLI use the show version command.

Valid Cisco.com username and password

Trial license keys are also available. If you cannot get your sensor licensed because of problems with your contract, you can obtain a 60-day trial license that supports signature updates that require licensing.

You can obtain a license key from the Cisco.com licensing server, which is then delivered to the sensor. Or, you can update the license key from a license key provided in a local file. Go to http://www.cisco.com/go/license and click IPS Signature Subscription Service to apply for a license key.

You can view the status of the license key on the Licensing pane in IDM. Whenever you start IDM, you are informed of your license status—whether you have a trial, invalid, or expired license key. With no license key, an invalid license key, or an expired license key, you can continue to use IDM but you cannot download signature updates.

When you enter the CLI, you are informed of your license status. For example, you receive the following message if there is no license installed:

***LICENSE NOTICE***
There is no license key installed on the system.
The system will continue to operate with the currently installed
signature set. A valid license must be obtained in order to apply
signature updates. Please go to http://www.cisco.com/go/license
to obtain a new license or install a license.
 
   

You will continue to see this message until you install a license key.

For More Information

For more information on obtaining a service contract, see Service Programs for IPS Products.

For the procedure for applying for a license key, see Obtaining and Installing the License Key.

Service Programs for IPS Products

You must have a Cisco Services for IPS service contract for any IPS product so that you can download a license key and obtain the latest IPS signature updates. If you have a direct relationship with Cisco Systems, contact your account manager or service account manager to purchase the Cisco Services for IPS service contract. If you do not have a direct relationship with Cisco Systems, you can purchase the service account from a one-tier or two-tier partner.

When you purchase the following IPS products you must also purchase a Cisco Services for IPS service contract:

IDS 4215

IDS 4235

IDS 4250

IPS 4240

IPS 4255

IPS 4260

IPS 4270-20

IDSM2

NM CIDS

AIM IPS

When you purchase an ASA 5500 series adaptive security appliance product that does not contain IPS, you must purchase a SMARTnet contract.


Note SMARTnet provides operating system updates, access to Cisco.com, access to TAC, and hardware replacement NBD on site.


When you purchase an ASA 5500 series adaptive security appliance product that ships with the AIP SSM installed or if you purchase the AIP SSM to add to your ASA 5500 series adaptive security appliance product, you must purchase the Cisco Services for IPS service contract.


Note Cisco Services for IPS provides IPS signature updates, operating system updates, access to Cisco.com, access to TAC, and hardware replacement NBD on site.


For example, if you purchased an ASA 5510 and then later wanted to add IPS and purchased an ASA-SSM-AIP-10-K9, you must now purchase the Cisco Services for IPS service contract. After you have the Cisco Services for IPS service contract, you must also have your product serial number to apply for the license key.


Caution If you ever send your product for RMA, the serial number will change. You must then get a new license key for the new serial number.

For More Information

For the procedure for applying for a license key, see Obtaining and Installing the License Key.

Obtaining and Installing the License Key

This section describes how to obtain and install the license key using IDM or the CLI. It contains the following topics:

Using IDM

Using the CLI

Using IDM


Note In addition to a valid Cisco.com username and password, you must also have a Cisco Services for IPS service contract before you can apply for a license key.


To obtain and install the license key, follow these steps:


Step 1 Log in to IDM using an account with administrator privileges.

Step 2 Choose Configuration > Licensing.

The Licensing pane displays the status of the current license. If you have already installed your license, you can click Download to save it if needed.

Step 3 Obtain a license key by doing one of the following:

Check the Cisco Connection Online check box to obtain the license from Cisco.com.

IDM contacts the license server on Cisco.com and sends the server the serial number to obtain the license key. This is the default method. Go to Step 4.

Check the License File check box to use a license file.

To use this option, you must apply for a license key at www.cisco.com/go/license.

The license key is sent to you in e-mail and you save it to a drive that IDM can access. This option is useful if your computer cannot access Cisco.com. Go to Step 7.

Step 4 Click Update License.

The Licensing dialog box appears.

Step 5 Click Yes to continue.

The Status dialog box informs you that the sensor is trying to connect to Cisco.com. An Information dialog box confirms that the license key has been updated.

Step 6 Click OK.

Step 7 Go to www.cisco.com/go/license.

Step 8 Fill in the required fields.


Caution You must have the correct IPS device serial number because the license key only functions on the device with that number.

Your license key will be sent to the e-mail address you specified.

Step 9 Save the license key to a hard-disk drive or a network drive that the client running IDM can access.

Step 10 Log in to IDM.

Step 11 Choose Configuration > Licensing.

Step 12 Under Update License, check the Update From: License File check box.

Step 13 In the Local File Path field, specify the path to the license file or click Browse Local to browse to the file.

The Select License File Path dialog box appears.

Step 14 Browse to the license file and click Open.

Step 15 Click Update License.


For More Information

For more information on service contracts, see Service Programs for IPS Products.

Using the CLI

Use the copy source-url license_file_name license-key command to copy the license key to your sensor.

The following options apply:

source-url—The location of the source file to be copied. It can be a URL or keyword.

destination-url—The location of the destination file to be copied. It can be a URL or a keyword.

license-key—The subscription license file.

license_file_name—The name of the license file you receive.


Note You cannot install an older license key over a newer license key.


The exact format of the source and destination URLs varies according to the file. Here are the valid types:

ftp:—Source URL for an FTP network server. The syntax for this prefix is:

ftp://[[username@]location][/relativeDirectory]/filename

ftp://[[username@]location][//absoluteDirectory]/filename


Note You are prompted for a password.


scp:—Source URL for the SCP network server. The syntax for this prefix is:

scp://[[username@]location][/relativeDirectory]/filename

scp://[[username@]location][//absoluteDirectory]/filename


Note You are prompted for a password. You must add the remote host to the SSH known hosts list.


http:—Source URL for the web server. The syntax for this prefix is:

http://[[username@]location][/directory]/filename


Note The directory specification should be an absolute path to the desired file.


https:—Source URL for the web server. The syntax for this prefix is:

https://[[username@]location][/directory]/filename


Note The directory specification should be an absolute path to the desired file. The remote host must be a TLS trusted host.


Installing the License Key

To install the license key, follow these steps:


Step 1 Apply for the license key at www.cisco.com/go/license.


Note In addition to a valid Cisco.com username and password, you must also have a Cisco Services for IPS service contract before you can apply for a license key.


Step 2 Fill in the required fields.


Note You must have the correct IPS device serial number because the license key only functions on the device with that number.


Your Cisco IPS Signature Subscription Service license key will be sent by e-mail to the e-mail address you specified.

Step 3 Save the license key to a system that has a web server, FTP server, or SCP server.

Step 4 Log in to the CLI using an account with administrator privileges.

Step 5 Copy the license key to the sensor.

sensor# copy scp://user@10.89.147.3://tftpboot/dev.lic license-key
Password: *******
 
   

Step 6 Verify the sensor is licensed.

sensor# show version
Application Partition:
 
   
Cisco Intrusion Prevention System, Version 6.0(3)E1
 
   
Host:
    Realm Keys          key1.0
Signature Definition:
    Signature Update    S291.0                   2007-06-18
    Virus Update        V1.2                     2005-11-24
OS Version:             2.4.30-IDS-smp-bigphys
Platform:               ASA-SSM-20
Serial Number:          P300000220
No license present
Sensor up-time is 3 days.
Using 1031888896 out of 2093682688 bytes of available memory (49% usage)
system is using 17.8M out of 29.0M bytes of available disk space (61% usage)
application-data is using 52.4M out of 166.6M bytes of available disk space (33% usage)
boot is using 37.8M out of 68.5M bytes of available disk space (58% usage)
 
   
 
   
MainApp          N-2007_JUN_19_16_45   (Release)   2007-06-19T17:10:20-0500   Running
AnalysisEngine   N-2007_JUN_19_16_45   (Release)   2007-06-19T17:10:20-0500   Running
CLI              N-2007_JUN_19_16_45   (Release)   2007-06-19T17:10:20-0500
 
   
 
   
Upgrade History:
 
   
  IPS-K9-6.0-3-E1   15:36:05 UTC Wed Aug 22 2007
 
   
Recovery Partition Version 1.1 - 6.0(3)E1
 
   
sensor#
 
   

Step 7 Copy your license key from a sensor to a server to keep a backup copy of the license:

sensor# copy license-key scp://user@10.89.147.3://tftpboot/dev.lic 
Password: *******
sensor#
 
   

For More Information

For the procedure for adding a remote host to the SSH known hosts list, see Adding Hosts to the SSH Known Hosts List.

For more information on service contracts, see Service Programs for IPS Products.

For the procedure for making a remote host a TLS trusted host, see Adding TLS Trusted Hosts.

Cisco Security Intelligence Operations

The Cisco Security Intelligence Operations site on Cisco.com provides intelligence reports about current vulnerabilities and security threats. It also has reports on other security topics that help you protect your network and deploy your security systems to reduce organizational risk.

You should be aware of the most recent security threats so that you can most effectively secure and manage your network. Cisco Security Intelligence Operations contains the top ten intelligence reports listed by date, severity, urgency, and whether there is a new signature available to deal with the threat.

Cisco Security Intelligence Operations contains a Security News section that lists security articles of interest. There are related security tools and links.

You can access Cisco Security Intelligence Operations at this URL:

http://tools.cisco.com/security/center/home.x

Cisco Security Intelligence Operations is also a repository of information for individual signatures, including signature ID, type, structure, and description.

You can search for security alerts and signatures at this URL:

http://tools.cisco.com/security/center/search.x

Accessing IPS Documentation

You can find IPS documentation at this URL:

http://www.cisco.com/en/US/products/hw/vpndevc/ps4077/tsd_products_support_series_home.html

Or to access IPS documentation from Cisco.com, follow these steps:


Step 1 Log in to Cisco.com.

Step 2 Click Support.

Step 3 Under Support at the bottom of the page, click Documentation.

Step 4 Choose Products > Security > Intrusion Prevention System (IPS) > IPS Appliances > Cisco IPS 4200 Series Sensors. The Cisco IPS 4200 Series Sensors page appears. All of the most up-to-date IPS documentation is on this page.


Note Although you will see references to other IPS documentation sites on Cisco.com, this is the site with the most complete and up-to-date IPS documentation.


Step 5 Click one of the following categories to access Cisco IPS documentation:

Download Software—Takes you to the Download Software site.


Note You must be logged into Cisco.com to access the software download site.


Release and General Information—Contains documentation roadmaps and release notes.

Reference Guides—Contains command references and technical references.

Design—Contains design guide and design tech notes.

Install and Upgrade—Contains hardware installation and regulatory guides.

Configure—Contains configuration guides for IPS CLI, IDM, and IME.

Troubleshoot and Alerts—Contains TAC tech notes and field notices.