Prevent Bots from running BotCommands #36

modulatingforce · 2024-03-20T17:37:51-04:00

modulatingforce commented

2024-03-20 17:37:51 -04:00

Relatively easy validation check . Should involve following

Cmd Sender should be validated first if Bot or not
Ideally a Configurable Shared Config file that could be adjusted if required in future , noting a list of known Bots

Potentially Related Areas

https://git.flake.sh/modulatingforce/forcebot_rs/src/branch/main/src/core/botinstance.rs#L277
https://git.flake.sh/modulatingforce/forcebot_rs/src/branch/main/src/core/botinstance.rs#L274
https://git.flake.sh/modulatingforce/forcebot_rs/src/branch/main/src/core/identity.rs#L639
https://git.flake.sh/modulatingforce/forcebot_rs/src/branch/main/src/core/identity.rs#L725

Possible Solution :

Address in Identity Module by adding into can_user_run() , even close to the beginning, validation involving the following pseudocode

let botVector = // result of pulling from a bot.config file
if botVector.contains(&usr) {
             return (
                Permissible::Block,
                ChangeResult::NoChange("Other Bots Cannot Run Commands".to_string()),
            );
}

Likely around this area

https://git.flake.sh/modulatingforce/forcebot_rs/src/branch/main/src/core/identity.rs#L782

Need to also add unit test that asserts for

Permissible::Block,
ChangeResult::NoChange("Other Bots Cannot Run Commands".to_string()),

Relatively easy validation check . Should involve following - [x] Cmd Sender should be validated first if Bot or not - [x] Ideally a Configurable Shared Config file that could be adjusted if required in future , noting a list of known Bots --- Potentially Related Areas https://git.flake.sh/modulatingforce/forcebot_rs/src/branch/main/src/core/botinstance.rs#L277 https://git.flake.sh/modulatingforce/forcebot_rs/src/branch/main/src/core/botinstance.rs#L274 https://git.flake.sh/modulatingforce/forcebot_rs/src/branch/main/src/core/identity.rs#L639 https://git.flake.sh/modulatingforce/forcebot_rs/src/branch/main/src/core/identity.rs#L725 --- **Possible Solution :** - [x] Address in Identity Module by adding into `can_user_run()` , even close to the beginning, validation involving the following pseudocode ```rust let botVector = // result of pulling from a bot.config file if botVector.contains(&usr) { return ( Permissible::Block, ChangeResult::NoChange("Other Bots Cannot Run Commands".to_string()), ); } ``` - Likely around this area https://git.flake.sh/modulatingforce/forcebot_rs/src/branch/main/src/core/identity.rs#L782 --- - [x] Need to also add unit test that asserts for ``` Permissible::Block, ChangeResult::NoChange("Other Bots Cannot Run Commands".to_string()), ```

modulatingforce added the

Kind/Enhancement

Priority

Low

labels 2024-03-20 17:39:00 -04:00

modulatingforce commented

2024-03-20 18:01:52 -04:00

For ease, and so we don't have to re-invent the wheel, we can use Environment Variables, but instead of defining the OtherBots variable in a .gitignore .env file , we can set the Environment variable via Cargo.toml system :

https://doc.rust-lang.org/cargo/reference/config.html

** This would make it so moving forward, if we need to add other bot names, we can go easily to the known Cargo.toml

Internal code on the BotVector should be similar to handling environment variables as normal

For ease, and so we don't have to re-invent the wheel, we can use Environment Variables, but instead of defining the `OtherBots` variable in a `.gitignore` `.env` file , we can set the Environment variable via `Cargo.toml` system : https://doc.rust-lang.org/cargo/reference/config.html ** This would make it so moving forward, if we need to add other bot names, we can go easily to the known `Cargo.toml` Internal code on the `BotVector` should be similar to handling environment variables as normal

modulatingforce self-assigned this 2024-03-20 18:21:20 -04:00

modulatingforce added 1 commit 2024-03-20 19:08:09 -04:00

other bots cant run botcommands

ci/woodpecker/pr/cargo-checks Pipeline was successful

Details

e22e755bf5

modulatingforce added 1 commit 2024-03-20 19:26:11 -04:00

otherbots unit test

ci/woodpecker/pr/cargo-checks Pipeline was successful

Details

e86fa4884b

modulatingforce changed title from ~~WIP: Prevent Bots from running BotCommands~~ to Prevent Bots from running BotCommands

2024-03-20 19:28:13 -04:00

modulatingforce reviewed 2024-03-20 19:55:44 -04:00

modulatingforce left a comment

Someone check this please

.cargo/config.toml

					
				@ -0,0 +1,4 @@

				[env]

				# Based on https://doc.rust-lang.org/cargo/reference/config.html

				OtherBots = "Supibot,buttsbot,PotatBotat,StreamElements"