'\" t
.\"     Title: falcodump
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.20
.\"      Date: 2024-06-09
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "FALCODUMP" "1" "2024-06-09" "\ \&" "\ \&"
.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
\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>\~]
.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
.SH "PLUGINS"
.SS "cloudtrail (AWS CloudTrail)"
.sp
CloudTrail sources can be S3 buckets or SQS queue URLs. S3 bucket URLs have the form
.sp
s3://\fIbucket_name\fP/AWSLogs/\fIid\fP/CloudTrail/\fIregion\fP/\fIyear\fP/\fImonth\fP/\fIday\fP
.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 s3://mybucket/AWSLogs/012345678/CloudTrail/us\-west\-2/2023 will fetch all CloudWatch logs for the year 2023.
.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.
.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
.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>