topic Re: Splunk Phantom: How to append each username from LDAP query result into an email body and send? in Splunk SOAR

Splunk Phantom: How to append each username from LDAP query result into an email body and send?

robertbuscato — Sun, 07 Jun 2020 17:36:16 GMT

Results from LDAP query:
user1
user2

I want to send an email for each of this users with the below email body separately:

Hi user1 (for user 1 email)

Hi user1 (for user 2 email)

And then send the email to each of these users.

====================================================================

The issue that I am facing is that currently, the email body looks like this:

Hi user1, user2

Though the email was successfully to each of these users.

Re: Splunk Phantom: How to append each username from LDAP query result into an email body and send?

sam_splunk — Wed, 30 Sep 2020 02:18:58 GMT

Hello!

The easiest way to do this may be a custom code block.

In my environment, I have an LDAP query from an action block that feeds into a custom function. That function has the inputs:

get_users_1:action_result.data..emails.0
get_users_1:action_result.data..displayname

And the code looks like this:

def custom_function_2(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None):
    phantom.debug('custom_function_2() called')
    results_data_1 = phantom.collect2(container=container, datapath=['get_users_1:action_result.data.*.emails.0', 'get_users_1:action_result.data.*.displayname'], action_results=results)
    results_item_1_0 = [item[0] for item in results_data_1]
    results_item_1_1 = [item[1] for item in results_data_1]

    ################################################################################
    ## Custom Code Start
    ################################################################################

    for i in range(len(results_item_1_0)):
        parameters = []
        email_body = """
Hello{},

This is a test!
        """
        if results_item_1_0[i] == None:
            continue                    # don't send on empyt emails

        if results_item_1_1[i] == None:
            email_body = email_body.format("")
        else:
            email_body = email_body.format(" " + results_item_1_1[i])

        parameters.append({
            'body': email_body,
            'from': "<REDACTED>@gmail.com",
            'attachments': "",
            'to': results_item_1_0[i],
            'cc': "",
            'bcc': "",
            'headers': "",
            'subject': "Testing"
        })
        phantom.act("send email", parameters=parameters, assets=['gmail'], name="send_email_1")

    ################################################################################
    ## Custom Code End
    ################################################################################

In this way I am looping through the values and grabbing display name and email and smashing them together to send an email. I do a couple of lightweight error handling too:

If the email field is None, we break out of that iteration of the loop to prevent failing to send.
If the Displayname is empty then we just start the email with "Hello," instead of "Hello None,"

It would be possible to do this with artifacts and the like, but I think a short code block is more straightforward. Feel free to reach out to me on the Phantom-Community Slack (sam_phantom) to discuss.

Re: Splunk Phantom: How to append each username from LDAP query result into an email body and send?

robertbuscato — Mon, 23 Sep 2019 06:00:07 GMT

Hi Ghays,

It was able to send email to only one of the emails returned from LDAP (2 users returned which is the expected result). Also, I noticed that it sends to the second email returned by LDAP.
Any update you can recommend? I'm not really good at Python so I'm having a hard time on fixing the issue.

Thank you.
Robert

Re: Splunk Phantom: How to append each username from LDAP query result into an email body and send?

sam_splunk — Mon, 23 Sep 2019 15:46:50 GMT

Would you be able to post your configuration w/ screenshots or names + params?

Re: Splunk Phantom: How to append each username from LDAP query result into an email body and send?

robertbuscato — Wed, 30 Sep 2020 02:15:22 GMT

Below is the custom code I created.
Input Paramaters from LDAP:

Get_User_Attribute:action_result.data.*.mail
Get_User_Attribute:action_result.data.*.givenname

def Format_Email(action=None, success=None, container=None, results=None, handle=None, filtered_artifacts=None, filtered_results=None):
    phantom.debug('Format_Email() called')
    results_data_1 = phantom.collect2(container=container, datapath=['Get_User_Attribute:action_result.data.*.mail', 'Get_User_Attribute:action_result.data.*.givenname'], action_results=results)
    results_item_1_0 = [item[0] for item in results_data_1]
    results_item_1_1 = [item[1] for item in results_data_1]

    ################################################################################
    ## Custom Code Start
    ################################################################################

    # build parameters list for 'Send_Email' call
    for i in range(len(results_item_1_0)):

        parameters = []
        email_body = """
          Hello{},

          This is a test!
            """
        if results_item_1_0[i] == None:
            continue                    # don't send on empyt emails

        if results_item_1_1[i] == None:
            email_body = email_body.format("")
        else:
            email_body = email_body.format(" " + results_item_1_1[i])

            parameters.append({
             'body': email_body,
             'from': "test@mail.com",
             'attachments': "",
             'to': results_item_1_0[i],
             'cc': "",
             'bcc': "",
             'headers': "",
             'subject': "Testing"
      })
    phantom.act("send email", parameters=parameters, assets=['smtp'], name="Send_Email")

    ################################################################################
    ## Custom Code End
    ################################################################################

    return

Re: Splunk Phantom: How to append each username from LDAP query result into an email body and send?

sam_splunk — Tue, 24 Sep 2019 21:28:44 GMT

Confirm the inputs to your custom function are right?

Should be:

Input 1: Get_User_Attribute:action_result.data.*.emails.0
Input 2: Get_User_Attribute:action_result.data.*.displayname

Re: Splunk Phantom: How to append each username from LDAP query result into an email body and send?

robertbuscato — Wed, 25 Sep 2019 23:20:03 GMT

@ghays_splunk - It actually works now. I didn't put the proper indention (newbie mistake) in for loop that's why it didn't work before. Thank you so much for helping me.

Re: Splunk Phantom: How to append each username from LDAP query result into an email body and send?

sam_splunk — Thu, 26 Sep 2019 14:25:01 GMT

Awesome! Python is super sensitive to indentation - it's literally a language where the amount of whitespace controls how statements a grouped.. crazy stuff.

Anywho, glad it working for you!