Salesforce (im_salesforce)

This module can be used to collect event monitoring data from Salesforce applications. It uses Salesforce Lightning Platform SOAP API and REST API v54 with username-password authorization to retrieve log data.

To examine the supported platforms, see the list of installation packages.

Prerequisites

To connect to the API and access Salesforce logs, you must first create and configure a Connected App to retrieve its Consumer Key and Consumer Secret.

Permissions

The Salesforce Connected App must be configured with the required Oauth tokens and scopes to collect the information you request. The following examples offer an initial guidance, but your set of tokens and scopes is ultimately defined by your use case.

While doing initial tests or debugging in a controlled environment, you may benefit from having access to nearly all data Salesforce can provide. The following example provides a wide access to data, however, it should be avoided as a permanent solution because of security concerns.

Access the identity URL service (id, profile, email, address, phone)
Manage user data via APIs (api)
Manage user data via Web browsers (web)
Full access (full)
Access Connect REST API resources (chatter_api)
Access Visualforce applications (visualforce)
Perform requests at any time (refresh_token, offline_access)
Access unique user identifiers (openid)
Access custom permissions (custom_permissions)
Access Analytics REST API resources (wave_api)
Access Analytics REST API Charts Geodata resources (eclair_api)
Manage Pardot services (pardot_api)
Access Lightning applications (lightning)
Access content resources (content)
Manage Data Cloud Ingestion API data (cdp_ingest_api)
Manage Data Cloud profile data (cdp_profile_api)
Perform ANSI SQL queries on Data Cloud data (cdp_query_api)
Access chatbot services (chatbot_api)
Perform segmentation on Data Cloud data (cdp_segment_api)
Manage Data Cloud Identity Resolution (cdp_identityresolution_api)
Access Headless Forgot Password API (forgot_password)
Manage Data Cloud Calculated Insight data (cdp_calculated_insight_api)

For a more restricted example, the following list supports typical information requests for security analysis, using Salesforce data for reporting, monitoring, or investigation. This could be used by a SIEM ingesting sign-in history and API activity, a compliance team running scheduled reports on user permissions and data access, or a security analytics platform correlating Salesforce user identities with activity logs from other systems.
```
Manage user data via APIs (api)
Perform requests at any time (refresh_token, offline_access)
Access the identity URL service (id, profile, email, address, phone)
Access unique user identifiers (openid)
Access Connect REST API resources (chatter_api)
```

Configuration

The im_salesforce module accepts the following directives in addition to the common module directives.

Required directives

The following directives are required to authenticate with the REST API.

ConsumerKey

This mandatory directive specifies the consumer key of your Salesforce Connected App.

ConsumerSecret

This mandatory directive specifies the consumer secret of your Salesforce Connected App.

LoginDomain

An optional directive to specify a different domain for OAuth application authorization. By default, login.salesforce.com is used. For a sandbox environment, specify test.salesforce.com.

Login

This mandatory directive specifies the username of your Salesforce org account, e.g., mylogin@domain.com. For a sandbox environment, should be appended with .sandbox_name. For example, if the sandbox name is test, the login user1@acme.com becomes user1@acme.com.test.

Password

This mandatory directive specifies the password of your Salesforce org account.

HTTPS directives

The following directives configure secure data transfer via HTTPS.

HTTPSAllowExpired

Specifies if the connection should be allowed with an expired certificate. If set to TRUE, the remote host will be able to connect with an expired certificate. The default is FALSE: the certificate must not be expired.

HTTPSAllowUntrusted

Specifies if the connection should be allowed without certificate verification. If set to TRUE, the connection will be allowed even if the remote host presents an unknown or self-signed certificate. The default value is FALSE: the remote host must present a trusted certificate.

HTTPSCADir

The path to a directory containing certificate authority (CA) certificates. These certificates will be used to verify the certificate presented by the remote host. The certificate files must be named using the OpenSSL hashed format, i.e. the hash of the certificate followed by .0, .1 etc. To find the hash of a certificate using OpenSSL:

$ openssl x509 -hash -noout -in ca.crt

For example, if the certificate hash is e2f14e4a, then the certificate filename should be e2f14e4a.0. If there is another certificate with the same hash then it should be named e2f14e4a.1 and so on.

A remote host’s self-signed certificate (which is not signed by a CA) can also be trusted by including a copy of the certificate in this directory.

The default operating system root certificate store will be used if this directive is not specified. Unix-like operating systems commonly store root certificates in /etc/ssl/certs. Windows operating systems use the Windows Certificate Store, while macOS uses the Keychain Access Application as the default certificate store. See Certification Authority (CA) certificates in the NXLog Platform User Guide for more information on using this directive.

In addition, Microsoft’s PKI repository contains root certificates for Microsoft services.

HTTPSCAFile

The path of the certificate authority (CA) certificate that will be used to verify the certificate presented by the remote host. A remote host’s self-signed certificate (which is not signed by a CA) can be trusted by specifying the remote host certificate itself. In case of certificates signed by an intermediate CA, the certificate specified must contain the complete certificate chain (certificate bundle).

HTTPSCertFile

The path of the certificate file that will be presented to the remote host during the HTTPS handshake.

HTTPSCertKeyFile

The path of the private key file that was used to generate the certificate specified by the HTTPSCertFile directive. This is used for the HTTPS handshake.

Optional directives

AddHeader

This optional directive can be specified multiple times to add custom headers to each HTTP request.

Compression

This optional directive can be used to enable HTTP compression for outgoing HTTP messages. The possible values are none, gzip, and deflate. By default, compression is disabled. Please note that some HTTP servers may not accept compressed HTTP requests. If a server doesn’t support a specific compression method, it may return 415 Unsupported Media Type errors in response to compressed requests.

HTTPBasicAuthPassword

HTTP basic authentication password. You must also set the HTTPBasicAuthUser directive to use HTTP authentication.

HTTPBasicAuthUser

HTTP basic authentication username. You must also set the HTTPBasicAuthPassword directive to use HTTP authentication.

Proxy

This optional directive is used to specify the protocol, IP address (or hostname) and port number of the HTTP or SOCKS proxy host to be used. The format is protocol://hostname:port.

Reconnect

This optional directive sets the reconnect interval in seconds. If it is set, the module attempts to reconnect in every defined second. If it is not set, the reconnect interval will start at 1 second and double with every attempt. In the latter case, when the system decides that the reconnection is successful, the reconnect interval is immediately reset to 1 sec.

The Reconnect directive must be used with caution. If it is used on multiple systems, it can send reconnect requests simultaneously to the same destination, potentially overloading the destination system. It may also cause NXLog Agent to use unusually high system resources or cause NXLog Agent to become unresponsive.

ReconnectOnData

This optional directive defines the behavior when the connection with the remote host is lost. When set to TRUE, the module only attempts to reconnect when it has data to send. The default value is FALSE; it will always keep a connection open with the remote host.

ApiVersion

This optional directive specifies the used Salesforce REST API version. It can be in v57.0 or 57 form.

EventFilter

This is an optional group directive to include or exclude event types from being collected. If this directive is not specified, the module will collect all events. It has the following sub-directives that can be defined multiple times:

Accept: Specifies a list of comma-separated event types to collect.

Exclude: Specifies a list of comma-separated event types to exclude from being collected.

The Accept and Exclude directives are mutually exclusive. If Accept is specified, the module downloads only events matching the listed event types. If Exclude is specified, the module downloads all events except the listed event types.

PollInterval

This optional directive specifies how frequently the module will check for new events in seconds. If this directive is not specified, it defaults to 60 seconds.

ReadFromLast

This boolean directive instructs the module on where to start reading events from the log source when NXLog Agent starts.

When TRUE, NXLog Agent will only read events logged after NXLog Agent started, unless SavePos is TRUE and a saved position for this log source exists in the cache file.

When FALSE, NXLog Agent will read all events from the log source, unless SavePos is TRUE and a saved position for this log source exists in the cache file.

The default is TRUE.

The following matrix shows the outcome of this directive in conjunction with the SavePos directive:

ReadFromLast SavePos Saved position Outcome

TRUE

Yes

Reads events from the saved position.

TRUE

Reads events that are logged after NXLog Agent is started.

TRUE

FALSE

Yes

Reads events that are logged after NXLog Agent is started.

TRUE

FALSE

Reads events that are logged after NXLog Agent is started.

FALSE

TRUE

Yes

Reads events from the saved position.

FALSE

TRUE

Reads all events.

FALSE

Yes

Reads all events.

FALSE

Reads all events.

If the NoCache directive is TRUE, it overrides the SavePos directive. In this case, the module behaves as if SavePos is FALSE.

SavePos

Set this directive to TRUE to save the position of the last processed event before NXLog Agent exits. On the next startup, the agent reads the saved position from the cache file and resumes from that point. Together with the ReadFromLast directive, this directive allows the agent to continue reading events from the saved position.

The default is TRUE; the position of the last read event is saved and will be read from the cache file on the next startup.

If the NoCache directive is TRUE, it overrides the SavePos directive. In this case, the module behaves as if SavePos is FALSE.

StartFrom

This optional directive specifies the time in RFC 3339 format of the first event to pull. If this directive is not set, the module reads events according to the ReadFromLast directive.

Examples

Example 1. Collecting Salesforce logs

This configuration collects event monitoring logs from a Salesforce organization. im_salesforce receives records from the Salesforce API in CSV format, which it then parses into structured data and writes each record as a list of key-value pairs.

nxlog.conf

<Input salesforce>
    Module            im_salesforce
    LoginDomain       login.salesforce.com
    Login             USER@email.com
    Password          USERPASSWORD
    ConsumerKey       APP_KEY
    ConsumerSecret    APP_SECRET

    <EventFilter>
        Accept      Login,Logout (1)
        Accept      OneCommerceUsage

        # Exclude   Search,SearchClick (2)
        # Exclude   Sandbox
    </EventFilter>

    StartFrom         2022-07-19T16:39:57-08:00 (3)
    PollInterval      120 (4)
</Input>

1	The event filter specifies the list of event types to collect in the Accept sub-directives.
2	The filter can also be configured to collect all log types except those specified by the Exclude sub-directives.
3	The StartFrom directive specifies to start collecting events from the specified date onward.
4	The PollInterval directive specifies to check for new events every 120 seconds. The default is 60 seconds.

Output sample

The following is a Salesforce event monitoring record after it was processed by NXLog Agent.

2022-07-15 12:03:11 nxlog-server INFO EVENT_TYPE="OneCommerceUsage" TIMESTAMP="20220602110049.842" REQUEST_ID="4jHvZvFIY-2Rl-l1cKNLKV" ORGANIZATION_ID="00D5f000003Hhp1" USER_ID="0055f0000030qMF" RUN_TIME="14443623" CPU_TIME="6876485" SERVICE_NAME="CommerceLicenseUsageMetrics" OPERATION="B2BMetricsCombinationJob" OPERATION_STAGE="combineNumberOfStores" COUNT="0" OPERATION_STATUS="Success" CONTEXT_MAP="{\"cc\":0,\"lb2b\":0}" B2B_EDITION="LB2B" TIMESTAMP_DERIVED="2022-06-02T11:00:49.842Z" USER_ID_DERIVED="0055f0000030qMFAAY"