.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Mail::SpamAssassin::Plugin::OLEVBMacro 3pm"
.TH Mail::SpamAssassin::Plugin::OLEVBMacro 3pm "2020-01-31" "perl v5.28.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Mail::SpamAssassin::Plugin::OLEVBMacro \- search attached documents for evidence of containing an OLE Macro
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  loadplugin Mail::SpamAssassin::Plugin::OLEVBMacro
\&
\&  ifplugin Mail::SpamAssassin::Plugin::OLEVBMacro
\&    body     OLEMACRO eval:check_olemacro()
\&    describe OLEMACRO Attachment has an Office Macro
\&
\&    body     OLEMACRO_MALICE eval:check_olemacro_malice()
\&    describe OLEMACRO_MALICE Potentially malicious Office Macro
\&
\&    body     OLEMACRO_ENCRYPTED eval:check_olemacro_encrypted()
\&    describe OLEMACRO_ENCRYPTED Has an Office doc that is encrypted
\&
\&    body     OLEMACRO_RENAME eval:check_olemacro_renamed()
\&    describe OLEMACRO_RENAME Has an Office doc that has been renamed
\&
\&    body     OLEMACRO_ZIP_PW eval:check_olemacro_zip_password()
\&    describe OLEMACRO_ZIP_PW Has an Office doc that is password protected in a zip
\&
\&    body     OLEMACRO_CSV eval:check_olemacro_csv()
\&    describe OLEMACRO_CSV Malicious csv file that tries to exec cmd.exe detected
\&  endif
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This plugin detects \s-1OLE\s0 Macro inside documents attached to emails.
It can detect documents inside zip files as well as encrypted documents.
.SH "REQUIREMENT"
.IX Header "REQUIREMENT"
This plugin requires Archive::Zip and IO::String perl modules.
.SH "USER PREFERENCES"
.IX Header "USER PREFERENCES"
The following options can be used in both site-wide (\f(CW\*(C`local.cf\*(C'\fR) and
user-specific (\f(CW\*(C`user_prefs\*(C'\fR) configuration files to customize how
the module handles attached documents
.IP "olemacro_num_mime (default: 5)" 4
.IX Item "olemacro_num_mime (default: 5)"
Configure the maximum number of matching \s-1MIME\s0 parts the plugin will scan
.IP "olemacro_num_zip (default: 8)" 4
.IX Item "olemacro_num_zip (default: 8)"
Configure the maximum number of matching zip members the plugin will scan
.IP "olemacro_zip_depth (default: 2)" 4
.IX Item "olemacro_zip_depth (default: 2)"
Depth to recurse within Zip files
.IP "olemacro_extended_scan ( 0 | 1 ) (default: 0)" 4
.IX Item "olemacro_extended_scan ( 0 | 1 ) (default: 0)"
Scan more files for potential macros, the \f(CW\*(C`olemacro_skip_exts\*(C'\fR parameter will still be honored.
This parameter is off by default, this option is needed only to run
\&\f(CW\*(C`eval:check_olemacro_renamed\*(C'\fR rule.
If this is turned on consider adjusting values for \f(CW\*(C`olemacro_num_mime\*(C'\fR and \f(CW\*(C`olemacro_num_zip\*(C'\fR
and prepare for more \s-1CPU\s0 overhead
.IP "olemacro_prefer_contentdisposition ( 0 | 1 ) (default: 1)" 4
.IX Item "olemacro_prefer_contentdisposition ( 0 | 1 ) (default: 1)"
Choose if the content-disposition header filename be preferred if ambiguity is encountered whilst trying to get filename
.IP "olemacro_max_file (default: 1024000)" 4
.IX Item "olemacro_max_file (default: 1024000)"
Configure the largest file that the plugin will decode from the \s-1MIME\s0 objects
.IP "olemacro_exts (default: (?:doc|docx|dot|pot|ppa|pps|ppt|rtf|sldm|xl|xla|xls|xlsx|xlt|xltx|xslb)$)" 4
.IX Item "olemacro_exts (default: (?:doc|docx|dot|pot|ppa|pps|ppt|rtf|sldm|xl|xla|xls|xlsx|xlt|xltx|xslb)$)"
Set the case-insensitive regexp used to configure the extensions the plugin
targets for macro scanning
.IP "olemacro_macro_exts (default: (?:docm|dotm|ppam|potm|ppst|ppsm|pptm|sldm|xlm|xlam|xlsb|xlsm|xltm|xltx|xps)$)" 4
.IX Item "olemacro_macro_exts (default: (?:docm|dotm|ppam|potm|ppst|ppsm|pptm|sldm|xlm|xlam|xlsb|xlsm|xltm|xltx|xps)$)"
Set the case-insensitive regexp used to configure the extensions the plugin
treats as containing a macro
.IP "olemacro_skip_exts (default: (?:dotx|potx|ppsx|pptx|sldx|xltx)$)" 4
.IX Item "olemacro_skip_exts (default: (?:dotx|potx|ppsx|pptx|sldx|xltx)$)"
Set the case-insensitive regexp used to configure extensions for the plugin
to skip entirely, these should only be guaranteed macro free files
.IP "olemacro_skip_ctypes (default: ^(?:text\e/))" 4
.IX Item "olemacro_skip_ctypes (default: ^(?:text/))"
Set the case-insensitive regexp used to configure content types for the
plugin to skip entirely, these should only be guaranteed macro free
.IP "olemacro_zips (default: (?:zip)$)" 4
.IX Item "olemacro_zips (default: (?:zip)$)"
Set the case-insensitive regexp used to configure extensions for the plugin
to target as zip files, files listed in configs above are also tested for zip