Add Slack as an extension API

tlawrie commented 2 years ago

Closes #https://github.com/boomerang-io/roadmap/issues/352

Implement new /apis/v1/extensions/slack endpoints to allow the integration with Flow via a Slack App. This PR addresses this and creates the first alpha PoC.

Changelog

New

/apis/v1/extensions/slack/commands endpoint for responding to Slash Commands
/apis/v1/extensions/slack/interactivity endpoint for responding to Modal submission
New SlackExtensionImpl

Changed

Updated Auth Filter to handle retrieving API token from access_token request parameter in addition to the existing x-access-token request header.

Testing / Reviewing

{{ Add descriptions, steps or a checklist for how reviewers can verify this PR works or not }}

gitguardian[bot] commented 2 years ago

⚠️ GitGuardian has uncovered 4 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request

| GitGuardian id | Secret | Commit | Filename | | | -------------- | ------------------------- | ---------------- | --------------- | -------------------- | | [3708040](https://dashboard.gitguardian.com/incidents/3708040?occurrence=42424382) | Slack Bot Token | 629158f842e75d82883a04da3c3d15d0e49e8ec6 | src/main/java/io/boomerang/extensions/SlackExtensionImpl.java | [View secret](https://github.com/boomerang-io/flow.service.workflow/commit/629158f842e75d82883a04da3c3d15d0e49e8ec6#diff-c90290e49bb99c07546a2b47c6541674b7a3b728cb1b75ab143a4b3541792a39R86) | | [3708040](https://dashboard.gitguardian.com/incidents/3708040?occurrence=42424951) | Slack Bot Token | be19b3058123e754742584a1cf652b656693a739 | src/main/java/io/boomerang/extensions/SlackExtensionImpl.java | [View secret](https://github.com/boomerang-io/flow.service.workflow/commit/be19b3058123e754742584a1cf652b656693a739#diff-c90290e49bb99c07546a2b47c6541674b7a3b728cb1b75ab143a4b3541792a39L86) | | [3708040](https://dashboard.gitguardian.com/incidents/3708040?occurrence=42960613) | Slack Bot Token | 362e63d9143326c1dbf16afa41325b16e8877fc8 | src/main/java/io/boomerang/extensions/SlackExtensionImpl.java | [View secret](https://github.com/boomerang-io/flow.service.workflow/commit/362e63d9143326c1dbf16afa41325b16e8877fc8#diff-c90290e49bb99c07546a2b47c6541674b7a3b728cb1b75ab143a4b3541792a39R86) | | [3708040](https://dashboard.gitguardian.com/incidents/3708040?occurrence=42960614) | Slack Bot Token | 2ed7006ad689dd0b437046cead4e6a1acd264420 | src/main/java/io/boomerang/extensions/SlackExtensionImpl.java | [View secret](https://github.com/boomerang-io/flow.service.workflow/commit/2ed7006ad689dd0b437046cead4e6a1acd264420#diff-c90290e49bb99c07546a2b47c6541674b7a3b728cb1b75ab143a4b3541792a39L86) |

🛠 Guidelines to remediate hardcoded secrets

1. Understand the implications of revoking this secret by investigating where it is used in your code. 2. Replace and store your secrets safely. [Learn here](https://blog.gitguardian.com/secrets-api-management?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) the best practices. 3. Revoke and [rotate these secrets](https://docs.gitguardian.com/secrets-detection/detectors/specifics/slackbototken#revoke-the-secret?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment). 4. If possible, [rewrite git history](https://blog.gitguardian.com/rewriting-git-history-cheatsheet?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment). Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data. To avoid such incidents in the future consider - following these [best practices](https://blog.gitguardian.com/secrets-api-management/?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) for managing and storing secrets including API keys and other credentials - install [secret detection on pre-commit](https://docs.gitguardian.com/internal-repositories-monitoring/integrations/git_hooks/pre_commit?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) to catch secret before it leaves your machine and ease remediation.

^{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!}

tlawrie commented 2 years ago

Hey @amhudson @marcusdroy this is ready for review.

It is already tested in Flowabl's dev environment and part of it is already in our production environment.

boomerang-io / flow.service.workflow