Internal change

PiperOrigin-RevId: 618192497
Change-Id: Ib325be2d54a0c9a0fd847fcec5c5d32d92e2ccb7

Author: dchakarwarti

LICENSE

@@ -0,0 +1,203 @@
+Copyright 2023 Google Inc. All rights reserved.
+
+                                Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2016 Google Inc
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -0,0 +1,5 @@
+# proto-processing-lib
+
+proto-processing-lib is a library that provides utility functionality for proto field scrubbing.
+
+This folder is the source-of-truth.

proto_processing_lib/factory_helper.h

@@ -0,0 +1,51 @@
+// Copyright 2023 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef THIRD_PARTY_PROTO_PROCESSING_LIB_SRC_FACTORY_HELPER_H_
+#define THIRD_PARTY_PROTO_PROCESSING_LIB_SRC_FACTORY_HELPER_H_
+
+#include <functional>
+#include <memory>
+#include <string>
+
+#include "proto_processing_lib/interface_util.h"
+#include "proto_processing_lib/proto_scrubber/field_checker_interface.h"
+#include "proto_processing_lib/proto_scrubber/field_mask_tree.h"
+#include "proto_processing_lib/proto_scrubber/unknown_field_checker.h"
+
+namespace proto_processing_lib {
+
+// Factory Method to create UnknownFieldChecker.
+static const proto_processing_lib::proto_scrubber::FieldCheckerInterface*
+FactoryCreateUnknownFieldChecker() {
+  return proto_processing_lib::proto_scrubber::UnknownFieldChecker::
+      GetDefault();
+}
+
+// Factory Method to create UnknownFieldChecker.
+static std::unique_ptr<proto_processing_lib::FieldMaskTreeInterface>
+FactoryCreateFieldMaskTree(
+    const google::protobuf::Type* type,
+    std::function<const google::protobuf::Type*(const std::string&)>
+        type_finder) {
+  proto_processing_lib::proto_scrubber::FieldMaskTree* fmt =
+      new proto_processing_lib::proto_scrubber::FieldMaskTree(type,
+                                                              type_finder);
+  return std::unique_ptr<proto_processing_lib::proto_scrubber::FieldMaskTree>(
+      fmt);
+}
+
+}  // namespace proto_processing_lib
+
+#endif  // THIRD_PARTY_PROTO_PROCESSING_LIB_SRC_FACTORY_HELPER_H_

proto_processing_lib/interface_util.h

@@ -0,0 +1,121 @@
+// Copyright 2023 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef THIRD_PARTY_PROTO_PROCESSING_LIB_SRC_INTERFACE_UTIL_H_
+#define THIRD_PARTY_PROTO_PROCESSING_LIB_SRC_INTERFACE_UTIL_H_
+
+#include <cstdint>
+#include <string>
+#include <vector>
+
+#include "absl/status/status.h"
+#include "absl/status/statusor.h"
+#include "absl/strings/string_view.h"
+#include "proto_field_extraction/message_data/message_data.h"
+#include "proto_processing_lib/proto_scrubber/field_checker_interface.h"
+#include "proto_processing_lib/proto_scrubber/field_mask_node.h"
+#include "proto_processing_lib/proto_scrubber/proto_scrubber_enums.h"
+
+namespace proto_processing_lib {
+
+// FieldMaskTreeInterface is an abstract class. Proto Processing Library
+// provides its own implementation.
+class FieldMaskTreeInterface : public proto_scrubber::FieldCheckerInterface {
+ public:
+  // Adds a list of FieldMask paths to the tree if no paths have been added. The
+  // resulting tree will be the union of "paths" (i.e. a paths to a parent field
+  // override paths to its child fields). For subsequent calls, the resulting
+  // tree represents an intersection between 'paths' and the previously added
+  // paths.
+  // Returns OK if all "paths" are legal, otherwise returns INVALID_ARGUMENT and
+  // the tree will be left in a broken state. Calling this method again on a
+  // broken FieldMaskTree will yield an error of FAILED_PRECONDITION.
+  virtual absl::Status AddOrIntersectFieldPaths(
+      const std::vector<std::string>& paths) = 0;
+
+  // Returns the status of the tree.
+  virtual absl::Status status() = 0;
+
+  // Returns root node of the tree.
+  virtual const proto_scrubber::FieldMaskNode* root() const = 0;
+};
+
+// CloudAuditLogFieldCheckerInterface is an abstract class. Proto Processing
+// Library provides its own implementation.
+class CloudAuditLogFieldCheckerInterface
+    : public proto_scrubber::FieldCheckerInterface {
+ public:
+  // Adds a list of auditing field paths to this field checker. For example,
+  // {"a.b", "c"} indicates that the root message can include only fields "a"
+  // and "c", and the message "a" can include only field "b".
+  virtual absl::Status AddOrIntersectFieldPaths(
+      const std::vector<std::string>& paths) = 0;
+};
+
+// ProtoScrubberInterface is an abstract class. Proto Processing Library
+// provides its own implementation.
+class ProtoScrubberInterface {
+ public:
+  virtual ~ProtoScrubberInterface() {}
+
+  // Scrubs a serialized (as Cord) proto message. The result only contains
+  // (sub-)fields that match one of the FieldMask paths. 'message' is changed
+  // only when the result is OK. Otherwise, it will be kept intact. Caller
+  // retains ownership to 'message'.
+  virtual absl::Status Scrub(
+      google::protobuf::field_extraction::MessageData* message) const = 0;
+
+  // Scrubs the proto message same as Scrub, but also returns the checksum
+  // for all scrubbed fields.
+  virtual absl::StatusOr<uint32_t> ScrubWithChecksum(
+      google::protobuf::field_extraction::MessageData* message) const = 0;
+
+  // Checks if a field should be kept by calling field_checkers_ and returns the
+  // aggregated result. If one of them returns EXCLUDE, the aggregated result is
+  // EXCLUDE. If all of them return INCLUDE, the aggregated result is INCLUDE.
+  // Otherwise, the aggregated result is PARTIAL. Caller retains the ownership
+  // of 'field'. If the field is excluded, also update the excluded_by_filter.
+  virtual proto_scrubber::FieldCheckResults CheckField(
+      const std::vector<std::string>& path,
+      const google::protobuf::Field* field,
+      proto_scrubber::FieldFilters* excluded_by_filter) const = 0;
+
+  // An overload that allows passing the parent type.
+  virtual proto_scrubber::FieldCheckResults CheckField(
+      const std::vector<std::string>& path,
+      const google::protobuf::Field* field,
+      const google::protobuf::Type* parent_type,
+      proto_scrubber::FieldFilters* excluded_by_filter) const = 0;
+
+  // Add a FieldChecker instance that will be used to check if a fields should
+  // be included in the scrubbing result.
+  virtual void AddFieldFilter(
+      const proto_scrubber::FieldCheckerInterface* checker) = 0;
+
+  virtual const std::vector<const proto_scrubber::FieldCheckerInterface*>&
+  field_filters() = 0;
+
+  virtual void IncreaseFieldDroppedCount(
+      const std::string& type_name, int32_t field_number,
+      const proto_scrubber::ScrubberContext& scrubber_context,
+      const proto_scrubber::FieldFilters& excluded_by_filter) const = 0;
+
+  virtual void IncreaseUnknownFieldDroppedCount(
+      absl::string_view type_name, int32_t field_number,
+      proto_scrubber::ScrubberContext scrubber_context) const = 0;
+};
+
+}  // namespace proto_processing_lib
+
+#endif  // THIRD_PARTY_PROTO_PROCESSING_LIB_SRC_INTERFACE_UTIL_H_