webhookey/Cargo.toml

[package]
name = "webhookey"
version = "0.1.0"
authors = ["finga <webhookey@onders.org>"]
edition = "2018"
license = "GPL-3.0-or-later"
readme = "README.md"
description = "Trigger scripts via http(s) requests"

[features]
tls = ["rocket/tls"]

[dependencies]
rocket = "0.4"
serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"
serde_yaml = "0.8"
regex = "1.4"
dirs = "3.0"
anyhow = "1.0"
log = "0.4"
env_logger = "0.8"
nom = "6"
hmac = "0.10"
sha2 = "0.9"
hex = "0.4"
ipnet = { version = "2.3", features = ["serde"] }
thiserror = "1.0"
run_script = "0.7"
clap = "3.0.0-beta.2"

[package.metadata.deb]
extended-description = "Webhookey receives requests in form of a so called Webhook as for example sent by Gitea. Those requests are matched against configured filters, if a filter matches, values from the header and the body can be passed to scripts as parameters which are then executed subsequently."
maintainer-scripts = "debian/"
systemd-units = { enable = false }
assets = [
       ["config.yml", "etc/webhookey/", "644"],
       ["target/release/webhookey", "usr/bin/", "755"],
       ["README.md", "usr/share/doc/cargo-deb/README", "644"],
       ["debian/service", "lib/systemd/system/webhookey.service", "644"],
]
conf-files = ["/etc/webhookey/config.yml"]
Parse JSON from post request Accept a post request and try to parse it expecting the data is formated in JSON. 2021-02-02 11:05:50 +01:00			`[package]`
			`name = "webhookey"`
Restructure and minor improvements In order to keep things together the code was restructured. Some small improvements such as clippy warnings and the validation of a hook in regards of the ip filter. 2021-06-02 03:35:43 +02:00			`version = "0.1.0"`
Build a Debian package The first version `0.1.0-rc.0` and metadata for `cargo-deb` is now in `Cargo.toml`. For that, the service file as well as the config file were moved. For a improved systemd service file the `User` and `Group` is now set via variables and the log level is now set to `info`. In the previous version of the service file the parameter for `ExecStart` was missing which prevented this file from working. The dependencies in `Cargo.lock` were updated. 2021-04-17 00:08:11 +02:00			`authors = ["finga <webhookey@onders.org>"]`
Parse JSON from post request Accept a post request and try to parse it expecting the data is formated in JSON. 2021-02-02 11:05:50 +01:00			`edition = "2018"`
Add license 2021-03-12 17:23:35 +01:00			`license = "GPL-3.0-or-later"`
Add meta data to `Cargo.toml` 2021-03-17 11:01:30 +01:00			`readme = "README.md"`
			`description = "Trigger scripts via http(s) requests"`
Parse JSON from post request Accept a post request and try to parse it expecting the data is formated in JSON. 2021-02-02 11:05:50 +01:00
Make `tls` an optional feature 2021-03-21 23:37:30 +01:00			`[features]`
			`tls = ["rocket/tls"]`

Parse JSON from post request Accept a post request and try to parse it expecting the data is formated in JSON. 2021-02-02 11:05:50 +01:00			`[dependencies]`
Make `tls` an optional feature 2021-03-21 23:37:30 +01:00			`rocket = "0.4"`
Parse JSON from post request Accept a post request and try to parse it expecting the data is formated in JSON. 2021-02-02 11:05:50 +01:00			`serde = { version = "1.0", features = ["derive"] }`
			`serde_json = "1.0"`
Parse config file and act upon All dependencies were updated. An example configuration file `config.yml` is added to show the configuration options. Following locations are checked: - `/etc/webhookey/config.yml` - `<config_dir>/webhookey/config.yml` - `./config.yml` Whereas `<config_dir>` is depending on the platform: - Linux: `$XDG_CONFIG_HOME` or `$HOME/.config` - macOS: `$HOME/Library/Application Support` - Windows: `{FOLDERID_RoamingAppData}` Each hook's action is executed if all of the specified filters match. 2021-03-03 15:24:46 +01:00			`serde_yaml = "0.8"`
			`regex = "1.4"`
			`dirs = "3.0"`
			`anyhow = "1.0"`
Implement proper logging The `log` and `env_logger` crates are used for logging. 2021-03-03 16:14:54 +01:00			`log = "0.4"`
			`env_logger = "0.8"`
Replace command parameters with values To create a minimalistic parser, nom is used to identify and replace parameters given in the command field. For clarity the `action` field for hooks was renamed to `command`. 2021-03-21 15:51:58 +01:00			`nom = "6"`
Use signature field for verification Instead of looking for a "secret" field hmac is used. Therefore the raw payload is hashed with all secrets consecutively in order to validate its content. If the content is certified the established behaviour is pursued.. 2021-03-28 03:50:52 +02:00			`hmac = "0.10"`
			`sha2 = "0.9"`
			`hex = "0.4"`
Add optional `ip_filter` to hook config In order to allow or deny sources of requests the possibility to configure a list of allowed or denied IP addresses was added as described by the readme. Closes #3 2021-04-02 00:25:39 +02:00			`ipnet = { version = "2.3", features = ["serde"] }`
Split `from_data()` up in smaller pieces To still be able to handle errors correctly, also regarding the http status code, `thiserror::Error` is used. 2021-04-03 01:10:50 +02:00			`thiserror = "1.0"`
Fix execution of scripts For better script and argument support `run_script` is used instead of `process::Command`. 2021-04-16 17:42:40 +02:00			`run_script = "0.7"`
Use clap for command line arguments To support command line arguments `clap` is used. This adds following argument `--config`/`-c` to provide a different path for the configurationf file and the subcommand `configtest` which parses and loads the configuration and exits. 2021-05-31 16:14:19 +02:00			`clap = "3.0.0-beta.2"`
Build a Debian package The first version `0.1.0-rc.0` and metadata for `cargo-deb` is now in `Cargo.toml`. For that, the service file as well as the config file were moved. For a improved systemd service file the `User` and `Group` is now set via variables and the log level is now set to `info`. In the previous version of the service file the parameter for `ExecStart` was missing which prevented this file from working. The dependencies in `Cargo.lock` were updated. 2021-04-17 00:08:11 +02:00
			`[package.metadata.deb]`
Update build deps and improve readability The ip filtering is improved as well as the replacing of parameters. The index page is removed. 2021-05-29 00:50:48 +02:00			`extended-description = "Webhookey receives requests in form of a so called Webhook as for example sent by Gitea. Those requests are matched against configured filters, if a filter matches, values from the header and the body can be passed to scripts as parameters which are then executed subsequently."`
Build a Debian package The first version `0.1.0-rc.0` and metadata for `cargo-deb` is now in `Cargo.toml`. For that, the service file as well as the config file were moved. For a improved systemd service file the `User` and `Group` is now set via variables and the log level is now set to `info`. In the previous version of the service file the parameter for `ExecStart` was missing which prevented this file from working. The dependencies in `Cargo.lock` were updated. 2021-04-17 00:08:11 +02:00			`maintainer-scripts = "debian/"`
			`systemd-units = { enable = false }`
			`assets = [`
			`["config.yml", "etc/webhookey/", "644"],`
			`["target/release/webhookey", "usr/bin/", "755"],`
			`["README.md", "usr/share/doc/cargo-deb/README", "644"],`
			`["debian/service", "lib/systemd/system/webhookey.service", "644"],`
			`]`
Fix debian build overwriting config file Add missing `confi-files` parameter to `Cargo.toml`. 2021-04-22 13:19:28 +02:00			`conf-files = ["/etc/webhookey/config.yml"]`