Understanding Masking Gateway Log File Elements

You can mask, or hide, elements that appear in the integration gateway log files, thereby prohibiting sensitive information from displaying in the generated logs.

Note:

The system applies gateway log masks and messages to both the integration gateway message log file (MsgLog.html) and the integration gateway error log file (ErrorLog.html).

Global and Custom Mask Messages

By default, all masked elements have a global mask message applied to them, whereby every element you mask is replaced with a standardized message. You can also create custom mask messages for specific elements. You can use a combination of global and custom mask messages.

The default global mask message is *** deleted for security purposes ***. You can change the global mask as you wish to a message that best suits your business needs.

Default Masks

Several gateway log masks are implemented by default. They include, but are not limited to, the following elements:

  • WSSE password.

  • NodePassword.

  • ExternalUserPassword.

  • XML format request with password.

  • PSFT AuthToken.

  • SAML-TokenData.

You can disable any of these masks in the logfilter.properties file.

logfilter.properties File

To mask and unmask gateway log file elements use the logfilter.properties file.

To use the file to specify the element names, attribute names, and element namespaces to mask. You can also use the file to change the global mask message and set up custom mask messages.

Note:

After you make any changes to the logfilter.properties file, you must reboot the web server for the changes to take effect.

Property Types

The following table lists the property types with which you can work in the logfilter.properties file:

Note:

The examples provided in this section show property names appended with a number. These numbers are property indexes and are discussed elsewhere in this section.

Property Description

AttributeName

Set this property equal to an attribute of an element to mask.

ElementName

Set this property equal to an element name to mask.

IsLeaf

Use this property to mask an element and all child tags of the element.

Namesapace

Use the Namespace property in conjunction with the ElementName property to specify the namespace of the element to mask.

Property Indexes

All properties in the logfilter.properties file are appended with an index number. Indexes group related properties and their values. The following example shows an excerpt from the logfilter.properties file and the ElementName.<index_number> naming scheme. 

#IBInfo NodePassword
ElementName.2=NodePassword

#IBInfo ExternalUserPassword
ElementName.3=ExternalUserPassword

#XML format request with Password
ElementName.4=Password

You can use any number as an index number. Index numbers do not have to be used in sequence. Using the previous example, if you were to add a new element name to the file, you would not have to name it ElementName.5. You could use any number not already in use, such as ElementName.72.

Properties can appear in any order in the logfilter.properties file and do not have to appear in sequential index order. As an example, ElementName.72 could appear first in the file, followed by ElementName.3, followed by ElementName.1, followed by ElementName.12, and so on.

Mask Variables

PeopleSoft Integration Broker provides the following mask variables:

Mask Variable Description

GlobalReplaceWith

By default the system assigns the value of this variable to all asked elements.

The default global mask message is:

***deleted for security purposes***

ReplaceWith

Use this variable to override the global mask value for a specific element and set a custom mask message.