- CAM Concept of Operations
- CAM Reporting
- Asset Class Mapping
- [Supported Asset Services]
The CONOPS for the CAM capabilities of ElectricEye largely lay within the evaluation logic provided by ElectricEye. All ElectricEye findings created by its checks are mapped to the AWS Security Finding Format (ASFF) which supports up to 50 key-value pairs within its ProductFields object in the schema.
ElectricEye utilizes the ProductFields object to record information about the Assessment Target - the Cloud Service Provider (CSP) or Software-as-a-Service (SaaS) vendor - that is being evaluated in two distinct ways. Any key with Provider in its name corresponds to information about the Assessment Target itself and any key with Asset in its name corresponds to whatever discrete component or sub-service is being evaluated by an ElectricEye Check such as an AWS EC2 Instance or a ServiceNow Plugin.
The following CAM-related ProductFields keys are provided per Check within ElectricEye:
This key contains the name of the Assessment Target that that Auditor corresponds to such as AWS, GCP, OCI, ServiceNow, M365, or otherwise.
This key corresponds to the cloud offering of the Assessment Target, either CSP for public cloud service providers or SaaS for Software-as-a-Service vendors and providers. In the future, this may be further expanded as ElectricEye expands in its service coverage.
This key contains the unique identifier of the specific Assessment Target being evaluated such as a ServiceNow Instance Name, a M365 Tenant Identifier, an Oracle Cloud Infrastrucute Tenancy ID, an AWS Account ID, and so on. Only the value will be provided and it will always correspond to Provider.
This key contains information about the specific asset's (what the Check is evalauting against) geographic region, if known. In some cases this may correspond to a smaller geographical infrastructure repesentation such as a Google Cloud Platform zone and may be omitted completely if deducing the location is not known (such as from a Workday ERP or ServiceNow instance). Best effort is made to parse this information from information returned by a CSP or SaaS Provider API such as an AWS region or a GCP zone.
Within AWS, there is the concept of a "global endpoint" which typically defaults to us-east-1 but in some rare cases can be other Regions, in non-Commercial Partitions this concept also persists. Services that are "global" are Amazon S3, Amazon CloudFront, AWS Health, AWS Trusted Advisor, AWS Support, Amazon IAM, and AWS Global Accelerator. These services will follow the service endpoint identifier of aws-global, aws-gov-global, aws-cn-global and so on. This is done instead of using an overwrite into us-east-1 as it should cause less confusion for users who do not have their primary regions in CONUS.
This key contains the JSON payload returned by the CSP or SaaS provider's API relative to the specific Asset being evaluated by an ElectricEye Check. The entire schema is captured in AssetDetails and will only appear in json, stdout, and cam_json ElectricEye Outputs.
This key contains information about the high level category a specific Asset maps into, this is derived from the Product offerings from AWS and how they are categorized, the intent is to use this to monitor or review all offerings within a specific IT vertical such as databases or analytics services. See the Asset Class Mapping section for more information on how these AssetClass types are used.
This key contains the information about the specific CSP or SaaS service offering that an Asset belongs to, for instance, Amazon API Gateway or Google CloudSQL. For SaaS Providers which lack the specificity of an asset management hierarchy, best effort is taken to give a descriptive name or title for AssetService such as "Plugin" for entries in the v_plugin or sys_plugins tables within ServiceNow or "Data Loss Prevention" for settings pertaining to M365 Defender for Cloud Apps or Google WorkSpaces DLP configurations.
Additionally, AssetService can be mapped to literal product offerings instead of how the Asset is attributed in the Provider's APIs in certain cases. For instance, Amazon EC2 contains APIs for AWS Site2Site VPN, AWS ClientVPN, AWS EBS Volumes, AWS EBS Snapshots, and so on - some of these are specifically broken out such as VPCs and Subnets with "Amazon Virtual Private Cloud" and EBS Volumes and Snapshots with "AWS Elastic Block Storage".
This key contains the information about what the actual Asset is, this can also be known as a "type" or "sub-service" in other asset management hierarchies. This is the logical entity in which an ElectricEye Check is directly evaluating such as an Amazon EC2 Instance or a Google CloudSQL Database Instance or a ServiceNow System Property. AssetComponent will be as simplistic as possible to describe the asset itself and will attempt to use the CSP or SaaS provider's own terminology when it makes sense to.
In some cases the AssetComponent doesn't refer to a "thing" but it may refer to a shared fact or attribute about a Provider itself such as different "Account-level" or "Project-level" settings within the Public CSPs. An example of this includes AWS EC2 Serial Port Console Access, Google Cloud Project Instance Connection Settings, or AWS X-Ray Encryption Configurations. It can also show up for ElectricEye Checks that are assessing the overall posture of multiple services such as checking if Subnets within AWS have remaining capacity or if Instances have Systems Manager State Manager Associations associated with them to apply patches or collect software assets.
ElectricEye has several Cloud Asset Management (CAM) reporting mechanisms within the Outputs, for the most accurate output information uses the following command from wherever you have the root directory of ElectricEye installed: python3 eeauditor/controller.py --list-options.
For information on how to use these Outputs and view sample outputs refer to
- HTML Output
- Cloud Asset Management JSON Output
- Cloud Asset Management MongoDB & AWS DocumentDB Output
- Cloud Asset Management PostgreSQL Output
The cam_ Outputs will generate new Outputs listed below.
This key is derived from Resources.[*].Id in the ASFF and is typically an ARN for AWS and is an ElectricEye-specific GUID for GCP and ServiceNow. (This section will be updated upon subsequent provider releases).
This key contains the sum of all INFORMATIONAL Check results specified in Severity.Label regardless of Compliance.Status, RecordState, or Workflow.Status values.
This key contains the sum of all LOW Check results specified in Severity.Label regardless of Compliance.Status, RecordState, or Workflow.Status values.
This key contains the sum of all MEDIUM Check results specified in Severity.Label regardless of Compliance.Status, RecordState, or Workflow.Status values.
This key contains the sum of all HIGH Check results specified in Severity.Label regardless of Compliance.Status, RecordState, or Workflow.Status values.
This key contains the sum of all CRITICAL Check results specified in Severity.Label regardless of Compliance.Status, RecordState, or Workflow.Status values.
For the purpose of ElectricEye CAM, the AWS Product Categories which are shown below are the guidepost for the AssetClass entry.
The following mapping is used, where the entry for "ElectricEye CAM AssetClass" is NOT_MAPPED that means that category is not used.
| AWS Product Category Name | ElectricEye CAM AssetClass |
Extra Notes |
|---|---|---|
| Analytics | Analytics | Mapped 1:1 |
| Application Integration | Application Integration | Mapped 1:1 for all messaging, queuing, and brokerage services |
| Blockchain | Blockchain | Mapped 1:1 |
| Business Applications | NOT_MAPPED | Not currently used |
| Cloud Financial Management | NOT_MAPPED | Not currently used |
| Compute | Compute | Mapped 1:1 |
| Contact Center | NOT_MAPPED | Not currently used |
| Containers | Containers | Will be prioritized over Compute, Networking, and Developer Tools for container/Docker/Kubernetes-related offerings such as Amazon ECR, Google Container Registry, and AWS AppMesh |
| Database | Database | Mapped 1:1 |
| Developer Tools | Developer Tools | Some services are recategorized to Developer Tools such as Amazon EC2 Image Builder and AWS Amplify |
| End User Computing | End User Computing | Mapped 1:1 |
| Front-End Web & Mobile | NOT_MAPPED | Front-End Web & Mobile is not used to differentiate across the offerings, only the "base" service is used, for instance Amazon API Gateway is mapped to Networking and AWS Amplify is mapped to Developer Tools |
| Games | NOT_MAPPED | Not currently used |
| Internet of Things | NOT_MAPPED | Not currently used |
| Machine Learning | Machine Learning | Mapped 1:1 |
| Artificial Intelligence | Artificial Intelligence | Mapped 1:1 |
| Management & Governance | Management & Governance | Management, IT Operations, and GRC tools (such as AWS Audit Manager) which map here - this also includes security configurations and other "account-wide" or "project-wide" settings, plugins, and properties |
| Media Services | Media Services | Mapped 1:1 |
| Migration & Transfer | Migration & Transfer | Mapped 1:1 |
| Networking & Content Delivery | Networking | "Content Delivery" is removed from this AssetClass but CDNs such as Amazon CloudFront and Google Cloud Armor will map to Networking as will API-related services such as AWS AppSync or Google Apigee |
| Quantum Technologies | NOT_MAPPED | Not currently used |
| Robotics | NOT_MAPPED | Not currently used |
| Satellite | NOT_MAPPED | Not currently used |
| Security, Identity, & Compliance | Security Services | The Security Services is used as AssetClass for generic security offerings and not for configurations - for instance, Azure WAF, AWS WAFv2, Amazon GuardDuty, AWS Trusted Advisor, etc. |
| Security, Identity, & Compliance | Identity & Access Management | Any cloud identity or identity service such as AWS Directory Services or Amazon Cognito maps into Identity & Access Management |
| Serverless | NOT_MAPPED | Serverless is not used to differentiate across the offerings, for instance GCP Cloud Functions and AWS Lambda map to Compute and Amazon DynamoDB and GCP AlloyDB map to Database. |
| Storage | Storage | In some cases, Storage is used in lieu of Compute such as with Disks and AMIs |
As more Providers and Services are added into ElectricEye this section will be further broken out.
NOTE To get an up to date list of these values, navigate to the directory of Auditors you want to check and use the following command: grep -ho 'AssetService": "[^"]*' *.py | sed 's/.*: "//;s/"$//' | sort -u
AWS Account
AWS Amplify
AWS App Mesh
AWS AppStream 2.0
AWS Auto Scaling
AWS CloudFormation
AWS CloudHSM
AWS CloudTrail
AWS CodeArtifact
AWS CodeBuild
AWS CodeDeploy
AWS DataSync
AWS Database Migration Service
AWS Directory Service
AWS EC2 Image Builder
AWS Elastic Load Balancer
AWS Elastic Load Balancer V2
AWS Fault Injection Simulator
AWS Glue
AWS Health
AWS IAM
AWS IAM Access Analyzer
AWS IAM Roles Anywhere
AWS Lambda
AWS License Manager
AWS MemoryDB for Redis
AWS Resource Access Manager
AWS Secrets Manager
AWS Security Hub
AWS Site-to-Site VPN
AWS Systems Manager
AWS Trusted Advisor
AWS VPC Lattice
AWS WAFv2 Global
AWS WAFv2 Regional
AWS WorkSpaces
AWS XRay
Amazon API Gateway
Amazon Athena
Amazon Certificate Manager
Amazon Cloud9
Amazon CloudFront
Amazon CloudSearch
Amazon Cognito
Amazon Detective
Amazon DocumentDB
Amazon DynamoDB
Amazon DynamoDB Accelerator (DAX)
Amazon EC2
Amazon ElastiCache for Redis
Amazon Elastic Beanstalk
Amazon Elastic Block Storage
Amazon Elastic Container Registry
Amazon Elastic Container Service
Amazon Elastic File System
Amazon Elastic Kubernetes Service
Amazon Elastic MapReduce
Amazon Elastic MapReduce Serverless
Amazon Elastic Transcoder
Amazon Global Accelerator
Amazon GuardDuty
Amazon Inspector V2
Amazon Key Management Service
Amazon Keyspaces
Amazon Kinesis Data Analytics
Amazon Kinesis Data Firehose
Amazon Kinesis Data Streams
Amazon MQ
Amazon Macie
Amazon Managed Blockchain
Amazon Managed Streaming for Apache Kafka
Amazon Managed Workflows for Apache Airflow
Amazon Neptune
Amazon OpenSearch Service
Amazon Quantum Ledger Database
Amazon Redshift
Amazon Redshift Serverless
Amazon Relational Database Service
Amazon Route53
Amazon S3
Amazon SageMaker
Amazon Shield Advanced
Amazon Simple Notification Service
Amazon Simple Queue Service
Amazon VPC
Amazon Virtual Private Cloud
Google CloudSQL
Google Compute Engine
Oracle Artifact Registry
Oracle Autonomous Database
Oracle Block Storage
Oracle Cloud Compute
Oracle Cloud Compute Management
Oracle Cloud Functions
Oracle Cloud Load Balancer
Oracle Cloud Virtual Cloud Network
Oracle Container Engine for Kubernetes
Oracle Container Instance Serivce
Oracle Container Registry
Oracle File Storage
Oracle GoldenGate
Oracle MySQL Database Service
Oracle NoSQL Database Cloud Service
Oracle Object Storage
Oracle Search with OpenSearch
System Plugins
System Properties
Users & Groups
Azure Active Directory
Microsoft 365 Conditional Access
Microsoft 365 Defender
This list will be kept up to date, probably.
NOTE To get an up to date list of these values, navigate to the directory of Auditors you want to check and use the following command: grep -ho 'AssetComponent": "[^"]*' *.py | sed 's/.*: "//;s/"$//' | sort -u
Accelerator
Access Key
Account Activation
Account Configuration
Activation
Agent
Alternate Contact
Application
Application Load Balancer
Association
Attack
Autoscaling Group
Broker
Bucket
Cache Cluster
Certificate
Check
Classic Load Balancer
Cluster
Crawler
Data Catalog
Database Cluster
Database Cluster Snapshot
Database Instance
Delivery Stream
Deployment Group
Directory
Distribution
Document
Domain
EC2 Deep Inspection Configuration
EC2 Scanner
ECR Scanner
Elastic IP
Encryption Configuration
Endpoint
Environment
Event
Event Subscription
File System
Findings
Fleet
Function
Group
Hardware Security Module
Hosted Zone
Hosted Zone Resource Record
Image
Instance
Journal Export
Key
Key Alias
Lambda Scanner
Layer
Ledger
License Configuration
Member
Mesh
Model
Namespace
Network Load Balancer
Notebook Instance
Parameter Group
Password Policy
Peer Node
Pipeline
Policy
Profile
Project
Queue
REST API
Recipe
Registry
Replication Instance
Repository
Resource Share
Role
Search Domain
Secret
Security Group
Serial Console Access
Server Certificate Storage
Shield Response Team Access
Snapshot
Source Credential
Stack
Stage
Stream
Subnet
Subscription
Table
Task
Task Definition
Topic
Trail
Trust Anchor
User
User Pool
Virtual Node
Virtual Private Cloud
Volume
Web Access Control List
Workgroup
Workspace
Database Instance
Service
Service Network
Target Group
Listener
Experiment Template
Instance
Application
Artifact
Bucket
Cluster
Connection
Database
Database System
Deployment
File System
Function
Image
Instance
Instance Configuration
Load Balancer
Mount Target
Network Security Group
Node Pool
Repository
Security List
Table
Virtual Node Pool
Volume
Plugin
System Property
User
Machine
Policy
Recommendation
User
This list will be kept up to date, probably.