feat: Add envoy wasm plugin for istio-sidecar

Signed-off-by: Anurag Rajawat <[email protected]>
5GSEC · Sep 23, 2024 · 12fdc56 · 12fdc56
1 parent adf969a
commit 12fdc56
Show file tree

Hide file tree

Showing 12 changed files with 864 additions and 0 deletions.
diff --git a/filters/envoy-wasm-filters/.gitignore b/filters/envoy-wasm-filters/.gitignore
@@ -0,0 +1,6 @@
+/target
+**/*.rs.bk
+Cargo.lock
+bin/
+pkg/
+wasm-pack.log
diff --git a/filters/envoy-wasm-filters/Cargo.toml b/filters/envoy-wasm-filters/Cargo.toml
@@ -0,0 +1,20 @@
+[package]
+name = "envoy-wasm-filters"
+version = "0.1.0"
+authors = ["Anurag Rajawat", "[email protected]"]
+edition = "2021"
+
+[lib]
+name = "httpfilters"
+path = "src/lib.rs"
+crate-type = ["cdylib"]
+
+[dependencies]
+proxy-wasm = "0.2.2"
+log = "0.4.22"
+serde_json = "1.0.127"
+serde = { version = "1.0.209", features = ["derive"] }
+
+[profile.release]
+# Tell `rustc` to optimize for small code size.
+opt-level = "s"
diff --git a/filters/envoy-wasm-filters/LICENSE_APACHE b/filters/envoy-wasm-filters/LICENSE_APACHE
@@ -0,0 +1,176 @@
+                              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
diff --git a/filters/envoy-wasm-filters/LICENSE_MIT b/filters/envoy-wasm-filters/LICENSE_MIT
@@ -0,0 +1,25 @@
+Copyright (c) 2018 anurag
+
+Permission is hereby granted, free of charge, to any
+person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the
+Software without restriction, including without
+limitation the rights to use, copy, modify, merge,
+publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice
+shall be included in all copies or substantial portions
+of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
+ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
+TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
+SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
+IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
diff --git a/filters/envoy-wasm-filters/Makefile b/filters/envoy-wasm-filters/Makefile
@@ -0,0 +1,7 @@
+.PHONY: build
+build:
+	@cargo build --target wasm32-unknown-unknown --release
+
+.PHONY: clean
+clean:
+	@cargo clean
diff --git a/filters/envoy-wasm-filters/Readme.md b/filters/envoy-wasm-filters/Readme.md
@@ -0,0 +1,108 @@
+# Envoy Wasm HTTP Filter
+
+An HTTP filter to observe RESTful and gRPC API calls made to/from a k8s workload.
+
+## Sample API Event:
+
+```json
+{
+  "metadata": {
+    "context_id": 3,
+    "timestamp": 1726211548,
+    "istio_version": "1.23.0",
+    "mesh_id": "cluster.local",
+    "node_name": "kind-control-plane"
+  },
+  "request": {
+    "headers": {
+      ":scheme": "http",
+      ":method": "GET",
+      "x-envoy-decorator-operation": "filterserver.sentryflow.svc.cluster.local:80/*",
+      ":authority": "filterserver.sentryflow",
+      "x-envoy-peer-metadata": "ChoKCkNMVVNURVJfSUQSDBoKS3ViZXJuZXRlcwp5CgZMQUJFTFMSbyptCg4KA2FwcBIHGgVodHRwZAoqCh9zZXJ2aWNlLmlzdGlvLmlvL2Nhbm9uaWNhbC1uYW1lEgcaBWh0dHBkCi8KI3NlcnZpY2UuaXN0aW8uaW8vY2Fub25pY2FsLXJldmlzaW9uEggaBmxhdGVzdAofCgROQU1FEhcaFWh0dHBkLWM2ZDZjYjk0Yi12MjU5ZwoWCglOQU1FU1BBQ0USCRoHZGVmYXVsdApJCgVPV05FUhJAGj5rdWJlcm5ldGVzOi8vYXBpcy9hcHBzL3YxL25hbWVzcGFjZXMvZGVmYXVsdC9kZXBsb3ltZW50cy9odHRwZAoYCg1XT1JLTE9BRF9OQU1FEgcaBWh0dHBk",
+      ":path": "/",
+      "x-envoy-peer-metadata-id": "sidecar~10.244.0.27~httpd-c6d6cb94b-v259g.default~default.svc.cluster.local",
+      "user-agent": "Wget",
+      "x-forwarded-proto": "http",
+      "x-request-id": "6b2e87df-257c-931e-a996-5517b8155b4a"
+    },
+    "body": ""
+  },
+  "response": {
+    "headers": {
+      "date": "Fri, 13 Sep 2024 07:12:28 GMT",
+      "x-envoy-upstream-service-time": "1",
+      "content-type": "application/json; charset=utf-8",
+      "content-length": "63",
+      ":status": "404"
+    },
+    "body": "{\"message\":\"The specified route / not found\",\"status\":\"failed\"}"
+  },
+  "source": {
+    "name": "httpd-c6d6cb94b-v259g",
+    "namespace": "default",
+    "ip": "10.244.0.27",
+    "port": 54636
+  },
+  "destination": {
+    "name": "",
+    "namespace": "sentryflow",
+    "ip": "10.96.158.214",
+    "port": 80
+  },
+  "protocol": "HTTP/1.1"
+}
+```
+
+# Getting Started
+
+## Install development tools
+
+You'll need these tools for a smooth development experience:
+
+- [Make](https://www.gnu.org/software/make/#download),
+- [Rust](https://www.rust-lang.org/tools/install) toolchain,
+- An IDE ([RustRover](https://www.jetbrains.com/rust/) / [VS Code](https://code.visualstudio.com/download)),
+- Container tools ([Docker](https://www.docker.com/) / [Podman](https://podman.io/)),
+- [Kubernetes cluster](https://kubernetes.io/docs/setup/) running version 1.26 or later,
+- [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) version 1.26 or later.
+
+## In Envoy alone
+
+This example can be run with docker compose and has a matching [envoy configuration](envoy.yaml) file.
+
+- Install the rust wasm toolchain:
+  ```shell
+  rustup target add wasm32-unknown-unknown
+  ```
+
+- Build the plugin
+  ```shell
+  make
+  ```
+
+- Start the envoy container
+  ```shell
+  docker compose up
+  ```
+
+- See the Raw API Events in `server` cluster configured in [envoy configuration](envoy.yaml).
+
+# In Kubernetes
+
+- [Install Istio](https://istio.io/latest/docs/setup/install/)
+- Update the `.spec.configPatches[0].patch.value.typedConfig.value.config.configuration.value` value according
+  to `api_path`
+  exposed by configured upstream cluster.
+- Create the [envoy filter](auto-observe-filter.yaml) to observe the API calls:
+
+  ```shell
+  kubectl apply -f auto-observe-filter.yaml
+  ```
+
+- Enable the envoy proxy injection by labeling the namespace in which you'll deploy workload:
+  ```shell
+  kubectl label ns <namespace_name> istio-injection=enabled
+  ```
+- Deploy some workload and generate traffic by calling some APIs.
+- See the observed Raw API Events in `filterserver` cluster configured in [envoy filter](auto-observe-filter.yaml).