Skip to content

Latest commit

 

History

History
41 lines (35 loc) · 2.64 KB

Readme.md

File metadata and controls

41 lines (35 loc) · 2.64 KB

Acquiring

dotnet tool install DotUtils.MsBuild.BinlogRedactor.CLI

https://www.nuget.org/packages/DotUtils.MsBuild.BinlogRedactor.CLI/

dotnet redact-binlog command

Description:
  Provides ability to redact and detect sensitive data from MSBuild binlogs (https://aka.ms/binlog-redactor).

Usage:
  redact-binlog [options]

Options:
  -p, --password <password> (REQUIRED)  Password or other sensitive data to be redacted from binlog. Multiple options are
                                        supported. Has to be specified if common patterns opted out with
                                        --no-common-patterns.
  -i, --input <input>                   Input binary log file name. Or a directory to inspect for all existing binlogs. If
                                        not specified current directory is assumed.
  -o, --output <output>                 Output binary log file name. If not specified, replaces the input file in place -
                                        overwrite option needs to be specified in such case.
  -f, --overwrite                       Replace the output file if it already exists. Replace the input file if the output
                                        file is not specified.
  --dryrun                              Performs the operation in-memory and outputs what would be performed.
  -r, --recurse                         Recurse given path (or current dir if none) for all binlogs. Applies only when
                                        single input file is not specified.
  --logsecrets                          Logs what secrets have been detected and replaced. This should be used only for
                                        test/troubleshooting purposes!
  --skip-embedded-files                 Binlog embedded files will not be processed by the redactor.
  --identify-replacements               If set - the redacted values will be distinguishable (e.g. 'REDACTED__Gcp-Token',
                                        'REDACTED__USERNAME') instead all same ('*******')
  --no-common-patterns                  If set - redactor will not attempt to autodetect possible sensitive data based
                                        (username, tokens/secrets with known formats, etc.). Specific passwords to redact
                                        must be specified in such case (with -p)
  -v, --verbosity <LEVEL>               Sets the verbosity level. Allowed values are q[uiet], m[inimal], n[ormal], and
                                        diag[nostic]. [default: normal]
  -?, -h, --help                        Show help and usage information
  --version                             Show version information