oracle.oci.oci_threat_intelligence_indicator_facts – Fetches details about one or multiple Indicator resources in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_threat_intelligence_indicator_facts.

New in version 2.9.0: of oracle.oci

Synopsis

  • Fetches details about one or multiple Indicator resources in Oracle Cloud Infrastructure

  • Get a list of threat indicator summaries based on the search criteria.

  • If indicator_id is specified, the details of a single Indicator will be returned.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compartment_id
string / required
The OCID of the tenancy (root compartment) that is used to filter results.
confidence_greater_than_or_equal_to
integer
The minimum confidence score of entities to be returned.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
indicator_id
string
The unique identifier (OCID) of the threat indicator.
Required to get a specific indicator.

aliases: id
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
sort_by
string
    Choices:
  • confidence
  • timeCreated
  • timeUpdated
  • timeLastSeen
The field to sort by. Only one field to sort by may be provided.
sort_order
string
    Choices:
  • ASC
  • DESC
The sort order to use, either 'ASC' or 'DESC'.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
threat_type_name
list / elements=string
The threat type of entites to be returned. To filter for multiple threat types, repeat this parameter.
time_created_greater_than_or_equal_to
string
The oldest created/first seen time of entities to be returned.
time_created_less_than
string
Return indicators created/first seen before the provided time.
time_last_seen_greater_than_or_equal_to
string
The oldest last seen time of entities to be returned.
time_last_seen_less_than
string
Return indicators last seen before the provided time.
time_updated_greater_than_or_equal_to
string
The oldest update time of entities to be returned.
time_updated_less_than
string
Return indicators updated before the provided time.
type
string
    Choices:
  • DOMAIN_NAME
  • FILE_NAME
  • MD5_HASH
  • SHA1_HASH
  • SHA256_HASH
  • IP_ADDRESS
  • URL
The indicator type of entities to be returned.
value
string
The indicator value of entities to be returned.

Examples

- name: Get a specific indicator
  oci_threat_intelligence_indicator_facts:
    # required
    indicator_id: "ocid1.indicator.oc1..xxxxxxEXAMPLExxxxxx"
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

- name: List indicators
  oci_threat_intelligence_indicator_facts:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    threat_type_name: [ "threat_type_name_example" ]
    type: DOMAIN_NAME
    value: value_example
    confidence_greater_than_or_equal_to: 0
    time_updated_greater_than_or_equal_to: 2013-10-20T19:20:30+01:00
    time_updated_less_than: 2013-10-20T19:20:30+01:00
    time_last_seen_greater_than_or_equal_to: 2013-10-20T19:20:30+01:00
    time_last_seen_less_than: 2013-10-20T19:20:30+01:00
    time_created_greater_than_or_equal_to: 2013-10-20T19:20:30+01:00
    time_created_less_than: 2013-10-20T19:20:30+01:00
    sort_order: ASC
    sort_by: confidence

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
indicators
complex
on success
List of Indicator resources

Sample:
[{'attributes': [{'attribution': [{'confidence': 56, 'source': {'name': 'name_example'}, 'time_first_seen': '2013-10-20T19:20:30+01:00', 'time_last_seen': '2013-10-20T19:20:30+01:00', 'visibility': {'name': 'name_example', 'tlp_name': 'TLP_INTERNAL_AUDIT'}}], 'name': 'name_example', 'value': 'value_example'}], 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'confidence': 56, 'geodata': {'admin_div': 'admin_div_example', 'city': 'city_example', 'country_code': 'country_code_example', 'geo_id': 'ocid1.geo.oc1..xxxxxxEXAMPLExxxxxx', 'label': 'label_example', 'latitude': 'latitude_example', 'longitude': 'longitude_example', 'origin': 'origin_example', 'routed_prefix': 'routed_prefix_example'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'ACTIVE', 'relationships': [{'attribution': [{'confidence': 56, 'source': {'name': 'name_example'}, 'time_first_seen': '2013-10-20T19:20:30+01:00', 'time_last_seen': '2013-10-20T19:20:30+01:00', 'visibility': {'name': 'name_example', 'tlp_name': 'TLP_INTERNAL_AUDIT'}}], 'name': 'name_example', 'related_entity': {'indicator_id': 'ocid1.indicator.oc1..xxxxxxEXAMPLExxxxxx', 'type': 'INDICATOR'}}], 'threat_types': [{'attribution': [{'confidence': 56, 'source': {'name': 'name_example'}, 'time_first_seen': '2013-10-20T19:20:30+01:00', 'time_last_seen': '2013-10-20T19:20:30+01:00', 'visibility': {'name': 'name_example', 'tlp_name': 'TLP_INTERNAL_AUDIT'}}], 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'name': 'name_example'}], 'time_created': '2013-10-20T19:20:30+01:00', 'time_last_seen': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'type': 'DOMAIN_NAME', 'value': 'value_example'}]
 
attributes
complex
on success
A map of attributes with additional information about the indicator. Each attribute has a name (string), value (string), and attribution (supporting data).

   
attribution
complex
on success
The array of attribution data that support this attribute.

     
confidence
integer
on success
An integer from 0 to 100 that provides a measure of our certainty in the maliciousness of data attributed to an indicator. For example, if the source of the data being attributed is the Tor Project, our confidence that the associated indicator is a tor exit node would be 100.

Sample:
56
     
source
complex
on success

       
name
string
on success
The name of the source.

Sample:
name_example
     
time_first_seen
string
on success
The date and time the attribution data was first seen for this entity. If the data source does not provide this information, it is set to the last time it was seen. An RFC3339 formatted string.

Sample:
2013-10-20T19:20:30+01:00
     
time_last_seen
string
on success
The last date and time the attribution data was seen for this entity. An RFC3339 formatted string.

Sample:
2013-10-20T19:20:30+01:00
     
visibility
complex
on success

       
name
string
on success
The name of the visibility level.

Sample:
name_example
       
tlp_name
string
on success
The Traffic Light Protocol (TLP) color of the visibility level.

Sample:
TLP_INTERNAL_AUDIT
   
name
string
on success
The name of the attribute.

Sample:
name_example
   
value
string
on success
The value of the attribute.

Sample:
value_example
 
compartment_id
string
on success
The OCID of the compartment that contains this indicator.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
confidence
integer
on success
An integer from 0 to 100 that represents how certain we are that the indicator is malicious and a potential threat if it is detected communicating with your cloud resources. This confidence value is aggregated from the confidence in the threat types, attributes, and relationships to create an overall value for the indicator.

Sample:
56
 
geodata
complex
on success

   
admin_div
string
on success
State/Province/subdivision within the country

Sample:
admin_div_example
   
city
string
on success
City of origin

Sample:
city_example
   
country_code
string
on success
Two-letter abbreviation for country of origin

Sample:
country_code_example
   
geo_id
string
on success
Unique Identifier (optional)

Sample:
ocid1.geo.oc1..xxxxxxEXAMPLExxxxxx
   
label
string
on success
Information on source providing the information

Sample:
label_example
   
latitude
string
on success
Latitude

Sample:
latitude_example
   
longitude
string
on success
Longitude

Sample:
longitude_example
   
origin
string
on success
ASN entry

Sample:
origin_example
   
routed_prefix
string
on success
Encompassing assigned prefix for the IP

Sample:
routed_prefix_example
 
id
string
on success
The OCID of the indicator.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The state of the indicator. It will always be `ACTIVE`.

Sample:
ACTIVE
 
relationships
complex
on success
A map of relationships between the indicator and other entities. Each relationship has a name (string), related entity, and attribution (supporting data).
Returned for get operation

   
attribution
complex
on success
The array of attribution data that support this relationship.

     
confidence
integer
on success
An integer from 0 to 100 that provides a measure of our certainty in the maliciousness of data attributed to an indicator. For example, if the source of the data being attributed is the Tor Project, our confidence that the associated indicator is a tor exit node would be 100.

Sample:
56
     
source
complex
on success

       
name
string
on success
The name of the source.

Sample:
name_example
     
time_first_seen
string
on success
The date and time the attribution data was first seen for this entity. If the data source does not provide this information, it is set to the last time it was seen. An RFC3339 formatted string.

Sample:
2013-10-20T19:20:30+01:00
     
time_last_seen
string
on success
The last date and time the attribution data was seen for this entity. An RFC3339 formatted string.

Sample:
2013-10-20T19:20:30+01:00
     
visibility
complex
on success

       
name
string
on success
The name of the visibility level.

Sample:
name_example
       
tlp_name
string
on success
The Traffic Light Protocol (TLP) color of the visibility level.

Sample:
TLP_INTERNAL_AUDIT
   
name
string
on success
The name of the attribute.

Sample:
name_example
   
related_entity
complex
on success

     
indicator_id
string
on success
The unique OCID of the referenced threat indicator.

Sample:
ocid1.indicator.oc1..xxxxxxEXAMPLExxxxxx
     
type
string
on success
The type of the referenced entity.

Sample:
INDICATOR
 
threat_types
complex
on success
Characteristics of the threat indicator based on previous observations or behavior. May include related tactics, techniques, and procedures.

   
attribution
complex
on success
The list of supporting attribution information.

     
confidence
integer
on success
An integer from 0 to 100 that provides a measure of our certainty in the maliciousness of data attributed to an indicator. For example, if the source of the data being attributed is the Tor Project, our confidence that the associated indicator is a tor exit node would be 100.

Sample:
56
     
source
complex
on success

       
name
string
on success
The name of the source.

Sample:
name_example
     
time_first_seen
string
on success
The date and time the attribution data was first seen for this entity. If the data source does not provide this information, it is set to the last time it was seen. An RFC3339 formatted string.

Sample:
2013-10-20T19:20:30+01:00
     
time_last_seen
string
on success
The last date and time the attribution data was seen for this entity. An RFC3339 formatted string.

Sample:
2013-10-20T19:20:30+01:00
     
visibility
complex
on success

       
name
string
on success
The name of the visibility level.

Sample:
name_example
       
tlp_name
string
on success
The Traffic Light Protocol (TLP) color of the visibility level.

Sample:
TLP_INTERNAL_AUDIT
   
id
string
on success
The OCID of the threat type.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
   
name
string
on success
The name of the threat type.

Sample:
name_example
 
time_created
string
on success
The date and time that the indicator was first detected. An RFC3339 formatted string.

Sample:
2013-10-20T19:20:30+01:00
 
time_last_seen
string
on success
The date and time that this indicator was last seen. The value is the same as `timeCreated` for a new indicator. An RFC3339 formatted string.

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The date and time that this indicator was last updated. The value is the same as `timeCreated` for a new indicator. An RFC3339 formatted string.

Sample:
2013-10-20T19:20:30+01:00
 
type
string
on success
The type of indicator.

Sample:
DOMAIN_NAME
 
value
string
on success
The value for this indicator. The value's format is dependent upon its `type`. Examples:
DOMAIN_NAME "evil.example.com"
MD5_HASH "44d88612fea8a8f36de82e1278abb02f"
IP_ADDRESS "2001:db8::1"

Sample:
value_example


Authors

  • Oracle (@oracle)