Osquery

Scanner supports Osquery logs, which contain information about events related to the operating system and hardware of the servers or laptops where Osquery is running. In order for Scanner to see them, you can configure Osquery to forward to logs to an AWS Kinesis Data Firehose, and then write them into an S3 bucket that Scanner is linked to.

Step 1: Configure Osquery to push logs to Kinesis Data Firehose

You can follow the Osquery documentation to configure your logger to push log events to a Kinesis Data Firehose in your AWS account. See: Logging osquery to AWS.

Step 2: Configure the Kinesis Data Firehose to write logs to S3

A Kinesis Data Firehose can push logs to various destinations. We want to push to an S3 bucket that Scanner is linked to. You can follow the AWS documentation to configure the Firehose to write to an S3 bucket. See: Understand data delivery in Amazon Data Firehose.

Step 3: Link the S3 bucket to Scanner

If you haven't done so already, link the S3 bucket containing your Osquery logs to Scanner using the Linking AWS Accounts guide.

Step 4: Set up an S3 Import Rule in Scanner

  1. Within Scanner, navigate to Settings > S3 Import Rules.

  2. Click Create Rule.

  3. For Rule name, type a name like my_team_name_osquery_logs.

  4. For Destination Index, choose the index where you want these logs to be searchable in Scanner.

  5. For Status, set to Active if you want to start indexing the data immediately.

  6. For Source Type, we recommend osquery, but you are free to choose any name. However, out-of-the-box detection rules will expect osquery.

  7. For AWS Account, choose the account that contains the S3 bucket containing Osquery logs.

  8. For S3 Bucket, choose the S3 bucket containing Osquery logs.

  9. For S3 Key Prefix, type the prefix (i.e. directory path) of the S3 objects that your Firehose is writing.

  10. For File type, choose JsonLines with Gzip compression.

  11. For Timestamp extractors, under Column name, type calendarTime. This is the field in each log event that contains the timestamp information.

  12. Click Preview rule to try it out. Check that the S3 keys you expect are appearing, and check that the log events inside are being parsed properly with the timestamp detected properly.

  13. When you're ready, click Create.

PreviousLaceworkNextOSSEC

Last updated