'\" t
.\"     Title: falcodump
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.23
.\"      Date: 2024-08-29
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "FALCODUMP" "1" "2024-08-29" "\ \&" "\ \&"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
falcodump \- Dump log data to a file using a Falco source plugin.
.SH "SYNOPSIS"
.sp
.B Common options
.br
\fBfalcodump\fP
[\~\fB\-\-help\fP\~]
[\~\fB\-\-version\fP\~]
[\~\fB\-\-plugin\-api\-version\fP\~]
[\~\fB\-\-extcap\-interfaces\fP\~]
[\~\fB\-\-extcap\-dlts\fP\~]
[\~\fB\-\-extcap\-interface\fP=<interface>\~]
[\~\fB\-\-extcap\-config\fP\~]
[\~\fB\-\-extcap\-capture\-filter\fP=<capture\~filter>\~]
[\~\fB\-\-capture\fP\~]
[\~\fB\-\-fifo\fP=<path\~to\~file\~or\~pipe>\~]
[\~\fB\-\-plugin\-source\fP=<source\~path\~or\~URL>\~]
[\~\fB\-\-log\-level\fP=<log\~level>\~]
[\~\fB\-\-log\-file\fP=<path\~to\~file>\~]
.sp
.B System call options
.br
[\~\fB\-\-include\-capture\-processes=<TRUE\~or\~FALSE>\~]
[\~\fP\-\-include\-switch\-calls=<TRUE\~or\~FALSE>\~]
.sp
.B CloudTrail plugin options
.br
[\~\fB\-\-cloudtrail\-s3downloadconcurrency\fP=<number\~of\~concurrent\~downloads>\~]
[\~\fB\-\-cloudtrail\-s3interval\fP=<timeframe>\~]
[\~\fB\-\-cloudtrail\-s3accountlist\fP=<comma\~separated\~account\~IDs>\~]
[\~\fB\-\-cloudtrail\-sqsdelete\fP=<true\~or\~false>\~]
[\~\fB\-\-cloudtrail\-useasync\fP=<true\~or\~false>\~]
[\~\fB\-\-cloudtrail\-uses3sns\fP=<true\~or\~false>\~]
[\~\fB\-\-cloudtrail\-aws\-region\fP=<AWS\~region>\~]
[\~\fB\-\-cloudtrail\-aws\-profile\fP=<AWS\~profile>\~]
[\~\fB\-\-cloudtrail\-aws\-config\fP=<path>\~]
[\~\fB\-\-cloudtrail\-aws\-credentials\fP=<path\~to\~file>\~]
.SH "DESCRIPTION"
.sp
\fBfalcodump\fP is an extcap tool that allows one to capture log messages from cloud providers.
.sp
Each plugin is listed as a separate interface.
For example, the AWS CloudTrail plugin is listed as “cloudtrail”.
.SH "OPTIONS"
.sp
\-\-help
.RS 4
Print program arguments.
This will also list the configuration arguments for each plugin.
.RE
.sp
\-\-version
.RS 4
Print the program version.
.RE
.sp
\-\-plugin\-api\-version
.RS 4
Print the Falco plugin API version.
.RE
.sp
\-\-extcap\-interfaces
.RS 4
List the available interfaces.
.RE
.sp
\-\-extcap\-interface=<interface>
.RS 4
Use the specified interface.
.RE
.sp
\-\-extcap\-dlts
.RS 4
List the DLTs of the specified interface.
.RE
.sp
\-\-extcap\-config
.RS 4
List the configuration options of specified interface.
.RE
.sp
\-\-extcap\-capture\-filter=<capture filter>
.RS 4
The capture filter.
Must be a valid Sysdig / Falco filter.
.RE
.sp
\-\-capture
.RS 4
Start capturing from the source specified by \-\-plugin\-source via the specified interface and write raw packet data to the location specified by \-\-fifo.
.RE
.sp
\-\-fifo=<path to file or pipe>
.RS 4
Save captured packet to file or send it through pipe.
.RE
.sp
\-\-plugin\-source=<source path or URL>
.RS 4
Capture from the specified location.
.RE
.sp
\-\-log\-level
.RS 4
Set the log level
.RE
.sp
\-\-log\-file
.RS 4
Set a log file to log messages in addition to the console
.RE
.SH "SYSTEM CALL OPTIONS"
.sp
\-\-include\-capture\-processes
.RS 4
Include system calls for capture processes (falcodump, dumpcap, and Logray) if TRUE.
Defaults to FALSE.
.RE
.sp
\-\-include\-switch\-calls
.RS 4
Include "switch" calls if TRUE.
Defaults to FALSE.
.RE
.SH "PLUGINS"
.SS "cloudtrail (AWS CloudTrail)"
.sp
\-\-cloudtrail\-s3downloadconcurrency
.RS 4
Controls the number of background goroutines used to download S3 files (Default: 32)
.RE
.sp
\-\-cloudtrail\-s3interval
.RS 4
Download log files over the specified interval (Default: no interval)
.RE
.sp
\-\-cloudtrail\-s3accountlist
.RS 4
If source is an organization CloudTrail S3 bucket download log files for all specified account IDs (Default: no account IDs)
.RE
.sp
\-\-cloudtrail\-sqsdelete
.RS 4
If true then the plugin will delete SQS messages from the queue immediately after receiving them (Default: true)
.RE
.sp
\-\-cloudtrail\-useasync
.RS 4
If true then async extraction optimization is enabled (Default: true)
.RE
.sp
\-\-cloudtrail\-uses3sns
.RS 4
If true then the plugin will expect SNS messages to originate from S3 instead of directly from Cloudtrail (Default: false)
.RE
.sp
\-\-cloudtrail\-aws\-profile
.RS 4
If non\-empty overrides the AWS shared configuration profile (e.g. \*(Aqdefault\*(Aq) and environment variables such as AWS_PROFILE (Default: empty)
.RE
.sp
\-\-cloudtrail\-aws\-region
.RS 4
If non\-empty overrides the AWS region specified in the profile (e.g. \*(Aqus\-east\-1\*(Aq) and environment variables such as AWS_REGION (Default: empty)
.RE
.sp
\-\-cloudtrail\-aws\-config
.RS 4
If non\-empty overrides the AWS shared configuration filepath (e.g. ~/.aws/config) and env variables such as AWS_CONFIG_FILE (Default: empty)
.RE
.sp
\-\-cloudtrail\-aws\-credentials
.RS 4
If non\-empty overrides the AWS shared credentials filepath (e.g. ~/.aws/credentials) and env variables such as AWS_SHARED_CREDENTIALS_FILE (Default: empty)
.RE
.sp
CloudTrail sources can be S3 buckets or SQS queue URLs. S3 bucket URLs have the form
.sp
\*(Aqs3://\fIbucket_name\fP/\fIprefix\fP/AWSLogs/\fIaccount\-id\fP/CloudTrail/\fIregion\fP/\fIyear\fP/\fImonth\fP/\fIday\fP\*(Aq
.sp
For organization CloudTrail the S3 bucket URL can be
.sp
\*(Aqs3://\fIbucket_name\fP/\fIprefix\fP/AWSLogs/\fIorg\-id\fP/\fIaccount\-id\fP/CloudTrail/\fIregion\fP/\fIyear\fP/\fImonth\fP/\fIday\fP\*(Aq
.sp
The \fIregion\fP, \fIyear\fP, \fImonth\fP, and \fIday\fP components can be omitted in order to fetch more or less data.
For example, the source \*(Aqs3://mybucket/AWSLogs/012345678/CloudTrail/us\-west\-2/2023\*(Aq will fetch all CloudWatch logs for the year 2023.
.sp
If the URL ends with \*(Aq\fIaccount\-id\fP/\*(Aq or \*(Aq\fIaccount\-id\fP/CloudTrail/\*(Aq (for example \*(Aqs3://mybucket/AWSLOGS/012345678912/\*(Aq) the option \*(Aq\-\-cloudtrail\-s3interval\*(Aq can be used to define the time frame. A s3interval of \*(Aq1d\*(Aq for example would get all events of the last 24 hours from all available regions. A s3interval of \*(Aq2w\-1w\*(Aq would get all events from all regions from two weeks ago up to one week ago. The s3invterval can also be defined as a RFC 3339\-style timestamp like \*(Aq2024\-02\-29T18:07:17Z\*(Aq or \*(Aq2024\-02\-29T00:00:00Z\-2024\-03\-01T23:59:59Z\*(Aq.
.sp
If the URL ends with \*(AqAWSLogs/\fIorg\-id\fP\*(Aq option \*(Aq\-\-cloudtrail\-s3accountlist\*(Aq can be used to specify account IDs. This can be combined with \*(Aq\-\-cloudtrail\-s3interval\*(Aq. A source like \*(Aqs3://my\-org\-bucket/AWSLogs/o\-123abc/\*(Aq with \*(Aq\-\-cloudstrail\-s3accountlist\*(Aq set to \*(Aq123456789012,987654321098\*(Aq and \*(Aq\-\-cloudtrail\-s3interval\*(Aq set to \*(Aq30m\*(Aq would get all events of the last 30min from all regions for accounts 123456789012 and 987654321098.
.sp
If source URL is the organization CloudTrail bucket (like \*(Aqs3://my\-org\-bucket/AWSLogs/o\-123abc\*(Aq) and \*(Aq\-\-s3accountlist\*(Aq is not set the plugin iterates over all accounts (limited by \*(Aq\-\-s3interval\*(Aq if set). Attention: Depending on the size of the organization and the time interval, this can take a long time.
.sp
The cloudtrail plugin uses the AWS SDK for Go, which can obtain profile, region, and credential settings from a set of standard \c
.URL "https://aws.github.io/aws\-sdk\-go\-v2/docs/configuring\-sdk/" "environment variables and configuration files" "."
Falcodump will show a list of locally configured profiles and the current regions, and will let you supply a custom value as well.
.sp
More information is available in the \c
.URL "https://github.com/falcosecurity/plugins/blob/master/plugins/cloudtrail/README.md" "README" ""
of the CloudTrail plugin.
.SH "EXAMPLES"
.sp
To see program arguments:
.sp
.if n .RS 4
.nf
.fam C
falcodump \-\-help
.fam
.fi
.if n .RE
.sp
To see program version:
.sp
.if n .RS 4
.nf
.fam C
falcodump \-\-version
.fam
.fi
.if n .RE
.sp
To see interfaces:
.sp
.if n .RS 4
.nf
.fam C
falcodump \-\-extcap\-interfaces
.fam
.fi
.if n .RE
.sp
Only one interface (falcodump) is supported.
.sp
.B Example output
.br
.sp
.if n .RS 4
.nf
.fam C
interface {value=cloudtrail}{display=Falco plugin}
.fam
.fi
.if n .RE
.sp
To see interface DLTs:
.sp
.if n .RS 4
.nf
.fam C
falcodump \-\-extcap\-interface=cloudtrail \-\-extcap\-dlts
.fam
.fi
.if n .RE
.sp
.B Example output
.br
.sp
.if n .RS 4
.nf
.fam C
dlt {number=147}{name=cloudtrail}{display=USER0}
.fam
.fi
.if n .RE
.sp
To see interface configuration options:
.sp
.if n .RS 4
.nf
.fam C
falcodump \-\-extcap\-interface=cloudtrail \-\-extcap\-config
.fam
.fi
.if n .RE
.sp
.B Example output
.br
.sp
.if n .RS 4
.nf
.fam C
arg {number=0}{call=\-\-plugin\-source}{display=Plugin source}{type=string}{tooltip=The plugin data source. This us usually a URL.}{placeholder=Enter a source URL…}{required=true}{group=Capture}
arg {number=1}{call=cloudtrail\-s3downloadconcurrency}{display=s3DownloadConcurrency}{type=integer}{default=1}{tooltip=Controls the number of background goroutines used to download S3 files (Default: 1)}{group=Capture}
arg {number=2}{call=cloudtrail\-sqsdelete}{display=sqsDelete}{type=boolean}{default=true}{tooltip=If true then the plugin will delete sqs messages from the queue immediately after receiving them (Default: true)}{group=Capture}
arg {number=3}{call=cloudtrail\-useasync}{display=useAsync}{type=boolean}{default=true}{tooltip=If true then async extraction optimization is enabled (Default: true)}{group=Capture}
.fam
.fi
.if n .RE
.sp
To capture AWS CloudTrail events from an S3 bucket:
.sp
.if n .RS 4
.nf
.fam C
falcodump \-\-extcap\-interface=cloudtrail \-\-fifo=/tmp/cloudtrail.pcap \-\-plugin\-source=s3://aws\-cloudtrail\-logs.../CloudTrail/us\-east\-2/... \-\-capture
.fam
.fi
.if n .RE
.sp
or:
.sp
.if n .RS 4
.nf
.fam C
falcodump \-\-capture \-\-extcap\-interface cloudtrail \-\-fifo ~/cloudtrail.pcap \-\-plugin\-source s3://my\-cloudtrail\-bucket/AWSLogs/o\-abc12345/123456789012/ \-\-cloudtrail\-s3downloadconcurrency 32 \-\-cloudtrail\-s3interval 5d\-2d \-\-cloudtrail\-aws\-region eu\-west\-1
.fam
.fi
.if n .RE
.if n .sp
.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
.ps +1
.B Note
.ps -1
.br
.sp
\f(CRCTRL\0+\0C\fP should be used to stop the capture in order to ensure clean termination.
.sp .5v
.RE
.SH "SEE ALSO"
.sp
wireshark(1), tshark(1), dumpcap(1), extcap(4)
.SH "NOTES"
.sp
\fBfalcodump\fP is part of the \fBLogray\fP distribution.
The latest version of \fBLogray\fP can be found at \c
.URL "https://www.wireshark.org" "" "."
.sp
HTML versions of the Wireshark project man pages are available at
.URL "https://www.wireshark.org/docs/man\-pages" "" "."
.SH "AUTHORS"
.sp
.B Original Author
.br
Gerald Combs <gerald[AT]wireshark.org>