From 44915b435f3c7051bd236d92517161aa9489fa17 Mon Sep 17 00:00:00 2001 From: Alex Goodman Date: Wed, 7 Apr 2021 16:28:45 -0400 Subject: [PATCH] add documentation for the file contents cataloger config options Signed-off-by: Alex Goodman --- README.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 642a1dc4d..5401f13f7 100644 --- a/README.md +++ b/README.md @@ -119,6 +119,25 @@ file-classification: # SYFT_FILE_CLASSIFICATION_CATALOGER_SCOPE env var scope: "squashed" +# cataloging file contents is exposed through the power-user subcommand +contents: + cataloger: + # enable/disable cataloging of secrets + # SYFT_CONTENTS_CATALOGER_ENABLED env var + enabled: true + + # the search space to look for secrets (options: all-layers, squashed) + # SYFT_CONTENTS_CATALOGER_SCOPE env var + scope: "squashed" + + # skip searching a file entirely if it is above the given size (default = 1MB; unit = bytes) + # SYFT_CONTENTS_SKIP_FILES_ABOVE_SIZE env var + skip-files-above-size: 1048576 + + # file globs for the cataloger to match on + # SYFT_CONTENTS_GLOBS env var + globs: [] + # cataloging file metadata is exposed through the power-user subcommand file-metadata: cataloger: @@ -149,9 +168,9 @@ secrets: # SYFT_SECRETS_REVEAL_VALUES env var reveal-values: false - # skip searching a file entirely if it is above the given size (default = 10MB; unit = bytes) + # skip searching a file entirely if it is above the given size (default = 1MB; unit = bytes) # SYFT_SECRETS_SKIP_FILES_ABOVE_SIZE env var - skip-files-above-size: 10485760 + skip-files-above-size: 1048576 # name-regex pairs to consider when searching files for secrets. Note: the regex must match single line patterns # but may also have OPTIONAL multiline capture groups. Regexes with a named capture group of "value" will