src/developer/forensics/utils/redact/redactor.h

// Copyright 2022 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef SRC_DEVELOPER_FORENSICS_UTILS_REDACT_REDACTOR_H_
#define SRC_DEVELOPER_FORENSICS_UTILS_REDACT_REDACTOR_H_

#include <lib/inspect/cpp/vmo/types.h>

#include <string>
#include <string_view>
#include <vector>

#include "src/developer/forensics/utils/redact/cache.h"
#include "src/developer/forensics/utils/redact/replacer.h"

namespace forensics {

class RedactorBase {
 public:
  explicit RedactorBase(inspect::BoolProperty redaction_enabled);
  virtual ~RedactorBase() = default;
  //
  // Redacts |text| in-place and returns a reference to |text|.
  virtual std::string& Redact(std::string& text) = 0;

  // Unredacted / redacted version of canary message for confirming log redaction.
  virtual std::string UnredactedCanary() const = 0;
  virtual std::string RedactedCanary() const = 0;

 private:
  inspect::BoolProperty redaction_enabled_;
};

// Redacts PII from text.
class Redactor : public RedactorBase {
 public:
  Redactor(int starting_id, inspect::UintProperty cache_size,
           inspect::BoolProperty redaction_enabled);
  ~Redactor() override = default;

  std::string& Redact(std::string& text) override;

  std::string UnredactedCanary() const override;
  std::string RedactedCanary() const override;

 private:
  Redactor& Add(Replacer replacer);
  Redactor& AddTextReplacer(std::string_view pattern, std::string_view replacement);
  Redactor& AddIdReplacer(std::string_view pattern, std::string_view format);

  RedactionIdCache cache_;
  std::vector<Replacer> replacers_;
};

// Do-nothing redactor
class IdentityRedactor : public RedactorBase {
 public:
  explicit IdentityRedactor(inspect::BoolProperty redaction_enabled);
  ~IdentityRedactor() override = default;

  std::string& Redact(std::string& text) override;

  std::string UnredactedCanary() const override;
  std::string RedactedCanary() const override;
};

}  // namespace forensics

#endif  // SRC_DEVELOPER_FORENSICS_UTILS_REDACT_REDACTOR_H_