Skip to content

Latest commit

 

History

History
42 lines (33 loc) · 1.59 KB

README.md

File metadata and controls

42 lines (33 loc) · 1.59 KB
Raw

shaggy-rogers

image

Clojure lambda which knows how to scan blob files and find sensitive information.

Installation

Deploy shaggy-rogers

  • Create a role for this lambda allowing it to read all files in all buckets.
  • Create a cloudtrail log on your account so every file uploaded to s3 will be logged.
  • Create a bucket which will be used to store the lambda artifact. Then configure this bucket on scripts/manager
  • Edit the scripts/manage script and add you account information and the correct iam-role
  • Deploy the lambda with this command: bash scripts/manage deploy
  • Create a cloudtrail trigger to your lambda.

Update shaggy-rogers

bash scripts/manage deploy

Detectors

  • Credit card numbers
  • JWT Tokens
  • PII (CPF and emails)
  • Shannon's entropy

How to create an detector?

  • Create your detector in the following path src/shaggy_rogers/detectors/.
  • Add your detector handler on the def invoke-all-detectors inside the src/shaggy_rogers/engine.clj file.

Detector template

Simple example of a detector which finds the word banana in the files.

(ns shaggy.rogers.detector.bananas)

(defn handler [{:keys [text-document] :as finding}]
  (println {:fn ::handler :finding finding :text-document text-document})
  (let [bananas (->> text-document
                    (re-seq #"banana"))]
    (if (empty? bananas)
      finding
      (assoc finding :banana-detector {:bananas bananas}))))