diff --git a/plugins/hashicorp-vault/.gitignore b/plugins/hashicorp-vault/.gitignore new file mode 100644 index 00000000..2a9f2a75 --- /dev/null +++ b/plugins/hashicorp-vault/.gitignore @@ -0,0 +1 @@ +falco.yaml \ No newline at end of file diff --git a/plugins/hashicorp-vault/CHANGELOG.md b/plugins/hashicorp-vault/CHANGELOG.md new file mode 100644 index 00000000..5b640ddb --- /dev/null +++ b/plugins/hashicorp-vault/CHANGELOG.md @@ -0,0 +1,5 @@ +# Changelog + +## v0.1.0 + +* First version \ No newline at end of file diff --git a/plugins/hashicorp-vault/LICENSE b/plugins/hashicorp-vault/LICENSE new file mode 100644 index 00000000..f49a4e16 --- /dev/null +++ b/plugins/hashicorp-vault/LICENSE @@ -0,0 +1,201 @@ + 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 [yyyy] [name of copyright owner] + + 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. \ No newline at end of file diff --git a/plugins/hashicorp-vault/Makefile b/plugins/hashicorp-vault/Makefile new file mode 100644 index 00000000..00804899 --- /dev/null +++ b/plugins/hashicorp-vault/Makefile @@ -0,0 +1,36 @@ +# SPDX-License-Identifier: Apache-2.0 +# +# Copyright (C) 2024 The Falco Authors. +# +# 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. +# + +SHELL=/bin/bash -o pipefail +GO ?= go + +NAME := hashicorp-vault +OUTPUT := lib$(NAME).so + +ifeq ($(DEBUG), 1) + GODEBUGFLAGS= GODEBUG=cgocheck=1 +else + GODEBUGFLAGS= GODEBUG=cgocheck=0 +endif + +all: $(OUTPUT) + +clean: + @rm -f $(OUTPUT) + +$(OUTPUT): clean + @$(GODEBUGFLAGS) $(GO) build -buildmode=c-shared -o $(OUTPUT) ./plugin + +readme: + @$(READMETOOL) -p ./$(OUTPUT) -f README.md \ No newline at end of file diff --git a/plugins/hashicorp-vault/OWNERS b/plugins/hashicorp-vault/OWNERS new file mode 100644 index 00000000..7c40ecd5 --- /dev/null +++ b/plugins/hashicorp-vault/OWNERS @@ -0,0 +1,2 @@ +approvers: + - Issif \ No newline at end of file diff --git a/plugins/hashicorp-vault/README.md b/plugins/hashicorp-vault/README.md new file mode 100644 index 00000000..df07dae7 --- /dev/null +++ b/plugins/hashicorp-vault/README.md @@ -0,0 +1,111 @@ +# Hashicorp Vault Events Plugin + +This repository contains the `hashicorp-vault` plugin for `Falco`, which fetch log [events](https://developer.hashicorp.com/vault/docs/concepts/events) from an [Hashicorp Vault](https://www.vaultproject.io/) instance and emit sinsp/scap events (e.g. the events used by `Falco`) for each entry. + +The plugin also exports fields that extract information from a `hashicorp-vault` log event, such as the event time, the event type, the mount class, the mount path, ... + +- [Hashicorp Vault Events Plugin](#hashicorp-vault-events-plugin) +- [Event Source](#event-source) +- [Supported Fields](#supported-fields) +- [Development](#development) + - [Requirements](#requirements) + - [Build](#build) +- [Settings](#settings) +- [Configurations](#configurations) +- [Usage](#usage) + - [Requirements](#requirements-1) + - [Results](#results) + +# Event Source + +The event source for `hashicorp-vault` events is `hashicorpvault`. + +# Supported Fields + + +| NAME | TYPE | ARG | DESCRIPTION | +|------------------------------------------|----------|------|---------------------------------------------| +| `hashicorpvault.event.id` | `string` | None | CloudEvents unique identifier for the event | +| `hashicorpvault.event.type` | `string` | None | The event type that was published | +| `hashicorpvault.metadata.currentversion` | `string` | None | Current version of the object | +| `hashicorpvault.metadata.oldestversion` | `string` | None | Oldest version of the object | +| `hashicorpvault.metadata.path` | `string` | None | Path of the object | +| `hashicorpvault.plugin.mountclass` | `string` | None | The class of the plugin | +| `hashicorpvault.plugin.mountaccessor` | `string` | None | The unique ID of the mounted plugin | +| `hashicorpvault.plugin.mountpath` | `string` | None | The path that the plugin is mounted at | +| `hashicorpvault.plugin.name` | `string` | None | The name of the plugin | + + +# Development +## Requirements + +You need: +* `Go` >= 1.17 + +## Build + +```shell +make +``` + +# Settings + +Only `init` accepts settings: +* `token`: your Token to access Hashicorp Vault API +* `host_port`: Host:Port of your Hashicrop Vault instance (ex: *localhost:8200*) + +# Configurations + +* `falco.yaml` + + ```yaml + plugins: + - name: hashicorp-vault + library_path: /usr/share/falco/plugins/libhashicorp-vault.so + init_config: + token: xxxxxxxxxxx + host_port: localhost:8200 + open_params: '' + + load_plugins: [hashicorp-vault] + ``` + +* `rules.yaml` + +The `source` for rules must be `hashicorp-vault`. + +See example: +```yaml +- rule: Secret update + desc: Secret update + condition: hashicorpvault.event.type="kv-v2/data-write" + output: The secret %hashicorpvault.metadata.path in the engine %hashicorpvault.plugin.mountpath has been updated to version %hashicorpvault.metadata.currentversion + priority: NOTICE + source: hashicorpvault + tags: [hashicorp-vault] +- rule: Secret delete + desc: Secret delete + condition: hashicorpvault.event.type="kv-v2/metadata-delete" + output: The secret %hashicorpvault.metadata.path in the engine %hashicorpvault.plugin.mountpath has been deleted + priority: WARNING + source: hashicorpvault + tags: [hashicorp-vault] +``` + +# Usage + +```shell +falco -c falco.yaml -r hashicorp-vault_rules.yaml +``` + +## Requirements + +* `Falco` >= 0.31 + +## Results + +```shell +2023-05-16T16:26:27.687301000+0000: Notice The secret data/secret00 in the engine mysecrets/ has been updated to version 4 +2023-05-16T16:26:34.384587000+0000: Notice The secret data/secret00 in the engine mysecrets/ has been updated to version 5 +2023-05-16T16:26:39.393935000+0000: Warning The secret metadata/secret00 in the engine mysecrets/ has been deleted +``` diff --git a/plugins/hashicorp-vault/go.mod b/plugins/hashicorp-vault/go.mod new file mode 100644 index 00000000..8da2e53c --- /dev/null +++ b/plugins/hashicorp-vault/go.mod @@ -0,0 +1,14 @@ +module github.com/falcosecurity/plugins/plugins/hashicorp-vault + +go 1.19 + +require ( + github.com/alecthomas/jsonschema v0.0.0-20220216202328-9eeeec9d044b + github.com/falcosecurity/plugin-sdk-go v0.7.3 + github.com/gorilla/websocket v1.5.1 +) + +require ( + github.com/iancoleman/orderedmap v0.3.0 // indirect + golang.org/x/net v0.22.0 // indirect +) diff --git a/plugins/hashicorp-vault/go.sum b/plugins/hashicorp-vault/go.sum new file mode 100644 index 00000000..d09ad860 --- /dev/null +++ b/plugins/hashicorp-vault/go.sum @@ -0,0 +1,33 @@ +github.com/alecthomas/jsonschema v0.0.0-20220216202328-9eeeec9d044b h1:doCpXjVwui6HUN+xgNsNS3SZ0/jUZ68Eb+mJRNOZfog= +github.com/alecthomas/jsonschema v0.0.0-20220216202328-9eeeec9d044b/go.mod h1:/n6+1/DWPltRLWL/VKyUxg6tzsl5kHUCcraimt4vr60= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/falcosecurity/plugin-sdk-go v0.7.3 h1:nmlBUmeAgEhcEHhSDWeEYgD9WdiHR9uMWyog5Iv7GIA= +github.com/falcosecurity/plugin-sdk-go v0.7.3/go.mod h1:NP+y22DYOS+G3GDXIXNmzf0CBL3nfPPMoQuHvAzfitQ= +github.com/gorilla/websocket v1.5.1 h1:gmztn0JnHVt9JZquRuzLw3g4wouNVzKL15iLr/zn/QY= +github.com/gorilla/websocket v1.5.1/go.mod h1:x3kM2JMyaluk02fnUJpQuwD2dCS5NDG2ZHL0uE0tcaY= +github.com/iancoleman/orderedmap v0.0.0-20190318233801-ac98e3ecb4b0/go.mod h1:N0Wam8K1arqPXNWjMo21EXnBPOPp36vB07FNRdD2geA= +github.com/iancoleman/orderedmap v0.3.0 h1:5cbR2grmZR/DiVt+VJopEhtVs9YGInGIxAoMJn+Ichc= +github.com/iancoleman/orderedmap v0.3.0/go.mod h1:XuLcCUkdL5owUCQeF2Ue9uuw1EptkJDkXXS7VoV7XGE= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= +github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= +github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= +github.com/stretchr/testify v1.3.1-0.20190311161405-34c6fa2dc709/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= +github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= +github.com/stretchr/testify v1.8.2 h1:+h33VjcLVPDHtOdpUCuF+7gSuG3yGIftsP1YvFihtJ8= +github.com/stretchr/testify v1.8.2/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= +github.com/xeipuuv/gojsonpointer v0.0.0-20180127040702-4e3ac2762d5f/go.mod h1:N2zxlSyiKSe5eX1tZViRH5QA0qijqEDrYZiPEAiq3wU= +github.com/xeipuuv/gojsonpointer v0.0.0-20190905194746-02993c407bfb/go.mod h1:N2zxlSyiKSe5eX1tZViRH5QA0qijqEDrYZiPEAiq3wU= +github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415/go.mod h1:GwrjFmJcFw6At/Gs6z4yjiIwzuJ1/+UwLxMQDVQXShQ= +github.com/xeipuuv/gojsonschema v1.2.0/go.mod h1:anYRn/JVcOK2ZgGU+IjEV4nwlhoK5sQluxsYJ78Id3Y= +golang.org/x/net v0.22.0 h1:9sGLhx7iRIHEiX0oAJ3MRZMUCElJgy7Br1nO+AMN3Tc= +golang.org/x/net v0.22.0/go.mod h1:JKghWKKOSdJwpW2GEx0Ja7fmaKnMsbu+MWVZTokSYmg= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= +gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/plugins/hashicorp-vault/pkg/hashicorpvault/hashicorpvault.go b/plugins/hashicorp-vault/pkg/hashicorpvault/hashicorpvault.go new file mode 100644 index 00000000..0295dd13 --- /dev/null +++ b/plugins/hashicorp-vault/pkg/hashicorpvault/hashicorpvault.go @@ -0,0 +1,238 @@ +/* +Copyright (C) 2023 The Falco Authors. + +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. +*/ + +package hashicorpvault + +import ( + "context" + "encoding/base64" + "encoding/json" + "fmt" + "io/ioutil" + "net/http" + "net/url" + "strings" + + "github.com/alecthomas/jsonschema" + "github.com/falcosecurity/plugin-sdk-go/pkg/sdk" + "github.com/falcosecurity/plugin-sdk-go/pkg/sdk/plugins" + "github.com/falcosecurity/plugin-sdk-go/pkg/sdk/plugins/source" + "github.com/gorilla/websocket" +) + +// Events are arbitrary, non-secret data that can be exchanged between producers (Vault and plugins) +// and subscribers (Vault components and external users via the API) +type Event struct { + ID string `json:"id"` + Time string `json:"time"` + DataContentType string `json:"datacontentype"` + Type string `json:"type"` + Data struct { + Event struct { + ID string `json:"id"` + Metadata struct { + CurrentVersion string `json:"current_version"` + OldestVersion string `json:"oldest_version"` + Path string `json:"path"` + } `json:"metadata"` + } `json:"event"` + EventType string `json:"event_type"` + PluginInfo struct { + MountClass string `json:"mount_class"` + MountAccessor string `json:"mount_accessor"` + MountPath string `json:"mount_path"` + Plugin string `json:"plugin"` + } `json:"plugin_info"` + } `json:"data"` +} + +// Plugin represents our plugin +type Plugin struct { + plugins.BasePlugin + Token string `json:"token" jsonschema:"title=Token,description=Token"` + HostPort string `json:"host_port" jsonschema:"title=HostPort,description=Host:Port"` + lastEvent Event + lastEventNum uint64 +} + +// PluginInstance represents a opened stream based on our Plugin +type PluginInstance struct { + source.BaseInstance + cancel context.CancelFunc +} + +const vaultBasePath string = "/v1/sys/events/subscribe/*?json=true" + +// Info displays information of the plugin to Falco plugin framework +func (hashicorpvaultPlugin *Plugin) Info() *plugins.Info { + return &plugins.Info{ + ID: 11, + Name: "hashicorp-vault", + Description: "Hashicorp Vault Events", + Contact: "github.com/falcosecurity/plugins/", + Version: "0.1.0", + EventSource: "hashicorpvault", + } +} + +// InitSchema exports the json schema for parameters +func (hashicorpvaultPlugin *Plugin) InitSchema() *sdk.SchemaInfo { + reflector := jsonschema.Reflector{ + RequiredFromJSONSchemaTags: true, // all properties are optional by default + AllowAdditionalProperties: true, // unrecognized properties don't cause a parsing failures + } + if schema, err := reflector.Reflect(&Plugin{}).MarshalJSON(); err == nil { + return &sdk.SchemaInfo{ + Schema: string(schema), + } + } + return nil +} + +// Init is called by the Falco plugin framework as first entry, +// we use it for setting default configuration values and mapping +// values from `init_config` (json format for this plugin) +func (hashicorpvaultPlugin *Plugin) Init(config string) error { + err := json.Unmarshal([]byte(config), &hashicorpvaultPlugin) + if err != nil { + return err + } + return nil +} + +// Fields exposes to Falco plugin framework all availables fields for this plugin +func (hashicorpvaultPlugin *Plugin) Fields() []sdk.FieldEntry { + return []sdk.FieldEntry{ + {Type: "string", Name: "hashicorpvault.event.id", Desc: "CloudEvents unique identifier for the event"}, + {Type: "string", Name: "hashicorpvault.event.type", Desc: "The event type that was published"}, + {Type: "string", Name: "hashicorpvault.metadata.currentversion", Desc: "Current version of the object"}, + {Type: "string", Name: "hashicorpvault.metadata.oldestversion", Desc: "Oldest version of the object"}, + {Type: "string", Name: "hashicorpvault.metadata.path", Desc: "Path of the object"}, + {Type: "string", Name: "hashicorpvault.plugin.mountclass", Desc: "The class of the plugin"}, + {Type: "string", Name: "hashicorpvault.plugin.mountaccessor", Desc: "The unique ID of the mounted plugin"}, + {Type: "string", Name: "hashicorpvault.plugin.mountpath", Desc: "The path that the plugin is mounted at"}, + {Type: "string", Name: "hashicorpvault.plugin.name", Desc: "The name of the plugin"}, + } +} + +// Extract allows Falco plugin framework to get values for all available fields +func (hashicorpvaultPlugin *Plugin) Extract(req sdk.ExtractRequest, evt sdk.EventReader) error { + event := hashicorpvaultPlugin.lastEvent + + if evt.EventNum() != hashicorpvaultPlugin.lastEventNum { + rawData, err := ioutil.ReadAll(evt.Reader()) + if err != nil { + return err + } + + err = json.Unmarshal(rawData, &event) + if err != nil { + return err + } + + hashicorpvaultPlugin.lastEvent = event + hashicorpvaultPlugin.lastEventNum = evt.EventNum() + } + + switch req.Field() { + case "hashicorpvault.event.id": + req.SetValue(event.Data.Event.ID) + case "hashicorpvault.event.type": + req.SetValue(event.Data.EventType) + case "hashicorpvault.metadata.currentversion": + req.SetValue(event.Data.Event.Metadata.CurrentVersion) + case "hashicorpvault.metadata.oldestversion": + req.SetValue(event.Data.Event.Metadata.OldestVersion) + case "hashicorpvault.metadata.path": + req.SetValue(event.Data.Event.Metadata.Path) + case "hashicorpvault.plugin.mountclass": + req.SetValue(event.Data.PluginInfo.MountClass) + case "hashicorpvault.plugin.mountaccessor": + req.SetValue(event.Data.PluginInfo.MountAccessor) + case "hashicorpvault.plugin.mountpath": + req.SetValue(event.Data.PluginInfo.MountPath) + case "hashicorpvault.plugin.name": + req.SetValue(event.Data.PluginInfo.Plugin) + default: + return nil + } + + return nil +} + +// Open is called by Falco plugin framework for opening a stream of events, we call that an instance +func (hashicorpvaultPlugin *Plugin) Open(params string) (source.Instance, error) { + eventC := make(chan source.PushEvent) + ctx, cancel := context.WithCancel(context.Background()) + + // launch an async worker that listens for Docker events and pushes them + // to the event channel + go func() { + defer close(eventC) + + headers := make(http.Header) + headers.Add("X-Vault-Token", hashicorpvaultPlugin.Token) + + u := url.URL{Scheme: "ws", Host: hashicorpvaultPlugin.HostPort, Path: vaultBasePath} + v, _ := url.QueryUnescape(u.String()) + + wsclient, _, err := websocket.DefaultDialer.DialContext(ctx, v, headers) + if err != nil { + eventC <- source.PushEvent{Err: err} + // errors are blocking, so we can stop here + return + } + defer wsclient.Close() + + for { + _, message, err := wsclient.ReadMessage() + if err != nil { + eventC <- source.PushEvent{Err: err} + return + } + eventBytes, err := json.Marshal(message) + if err != nil { + eventC <- source.PushEvent{Err: err} + return + } + eventBase64 := strings.ReplaceAll(string(eventBytes), `"`, "") + event, err := base64.StdEncoding.DecodeString(eventBase64) + if err != nil { + eventC <- source.PushEvent{Err: err} + return + } + eventC <- source.PushEvent{Data: []byte(event)} + } + }() + + return source.NewPushInstance(eventC, source.WithInstanceClose(cancel)) +} + +// String represents the raw value of on event +// todo: optimize this to cache by event number +func (hashicorpvaultPlugin *Plugin) String(evt sdk.EventReader) (string, error) { + evtBytes, err := ioutil.ReadAll(evt.Reader()) + if err != nil { + return "", err + } + evtStr := string(evtBytes) + + return fmt.Sprintf("%v", evtStr), nil +} + +func (haschicorpvaultInstance *PluginInstance) Close() { + haschicorpvaultInstance.cancel() +} diff --git a/plugins/hashicorp-vault/plugin/hashicorpvault.go b/plugins/hashicorp-vault/plugin/hashicorpvault.go new file mode 100644 index 00000000..e86c1aeb --- /dev/null +++ b/plugins/hashicorp-vault/plugin/hashicorpvault.go @@ -0,0 +1,35 @@ +/* +Copyright (C) 2023 The Falco Authors. + +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. +*/ + +package main + +import ( + "github.com/falcosecurity/plugin-sdk-go/pkg/sdk/plugins" + "github.com/falcosecurity/plugin-sdk-go/pkg/sdk/plugins/extractor" + "github.com/falcosecurity/plugin-sdk-go/pkg/sdk/plugins/source" + "github.com/falcosecurity/plugins/plugins/hashicorp-vault/pkg/hashicorpvault" +) + +func init() { + plugins.SetFactory(func() plugins.Plugin { + p := &hashicorpvault.Plugin{} + extractor.Register(p) + source.Register(p) + return p + }) +} + +func main() {} diff --git a/plugins/hashicorp-vault/rules/hashicorp-vault_rules.yaml b/plugins/hashicorp-vault/rules/hashicorp-vault_rules.yaml new file mode 100644 index 00000000..95edb095 --- /dev/null +++ b/plugins/hashicorp-vault/rules/hashicorp-vault_rules.yaml @@ -0,0 +1,37 @@ +# +# Copyright (C) 2023 The Falco Authors. +# +# +# 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. +# + +- required_engine_version: 11 + +- required_plugin_versions: + - name: hashicorp-vault + version: 0.1.0 + +- rule: Secret update + desc: Secret update + condition: hashicorpvault.event.type="kv-v2/data-write" + output: The secret %hashicorpvault.metadata.path in the engine %hashicorpvault.plugin.mountpath has been updated to version %hashicorpvault.metadata.currentversion + priority: NOTICE + source: hashicorpvault + tags: [hashicorp-vault] +- rule: Secret delete + desc: Secret delete + condition: hashicorpvault.event.type="kv-v2/metadata-delete" + output: The secret %hashicorpvault.metadata.path in the engine %hashicorpvault.plugin.mountpath has been deleted + priority: WARNING + source: hashicorpvault + tags: [hashicorp-vault] diff --git a/registry.yaml b/registry.yaml index 9197817b..10ff81e8 100644 --- a/registry.yaml +++ b/registry.yaml @@ -257,6 +257,7 @@ plugins: keywords: - audit - audit-events + - hashicorp - nomad url: https://github.com/albertollamaso/nomad-plugin/tree/main rules_url: https://github.com/albertollamaso/nomad-plugin/tree/main/rules @@ -373,6 +374,25 @@ plugins: source: box extraction: supported: true + - name: hashicorp-vault + description: Read Hashicorp Vault Events Stream + authors: The Falco Authors + contact: https://github.com/falcosecurity/plugins/tree/master/plugins/k8saudit-eks + keywords: + - audit + - audit-events + - hashicorp + - vault + url: https://github.com/falcosecurity/plugins/tree/master/plugins/hashicorp-vault + rules_url: https://github.com/falcosecurity/plugins/tree/master/plugins/hashicorp-vault/rules + license: Apache-2.0 + capabilities: + sourcing: + supported: true + id: 16 + source: hashicorpvault + extraction: + supported: true - name: test description: This ID is reserved for source plugin development. Any plugin author can use this ID, but authors can expect events from other developers with this ID. After development is complete, the author should request an actual ID reserved: true