Skip to content

Latest commit

 

History

History
187 lines (126 loc) · 5.32 KB

README.md

File metadata and controls

187 lines (126 loc) · 5.32 KB
Raw

flottbot

A Haskell based bot for Cisco Webex Teams.

Screen shot:

screenshot

Currently doesn't support any security for external commands but will run things found in commands that have a valid index.yaml. This model allows you to write the bot commands in any language.

Features

Work in progress -- I wouldn't use it just yet...

  • Webhook server runs in TLS
  • Commands can be written in any language, they are invoked as regular system processes
  • Commands are forced to timeout after a configurable amount of time
  • No dependencies once compiled
  • Portable across Linux, OSX, and Windows

TODO (in order of importance)

  1. Upstream webex-teams-api changes
  2. HMAC secret decoding
  3. Isolate/sandbox external commands somehow, leaning towards docker containers
  4. Get working with chat rooms
  5. Better replying to user things failed (currently logged)
  6. Turn log output into something more useful (currently show a on all LogEvents)
  7. Some form of testing
  8. A way to specify how the command wants it's input, either simple (just send what text the user sent) or a JSON blob with more details
  9. Prevent malicious behavior with truncating input, etc
  10. Dynamic reloading of config (via inotify)
  11. Dynamic reloading of command indexes (likely !reload-commands, maybe via inotify)
  12. Add Unix signal handling
  13. Compute metrics from LogEvents and record somewhere
  14. Easier webhook creation/deleting
  15. Less nesting in handleMsg
  16. Commands enabled per team/room (likely annoying as rooms have a long ugly opaque string as an id)
  17. Remove remaining warnings (not many)
  18. User documentation

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

  1. Cisco Webex Teams account
  2. open TCP port on the internet so the Webex API can contact it (specify the URL when you create the webhook)
  3. stack from https://tech.fpcomplete.com/haskell/get-started and https://www.stackage.org/

Installing

A step by step series of examples that tell you how to get a development env running

  1. Create a webhook

https://developer.webex.com/docs/api/v1/webhooks/create-a-webhook

Create create-webhook.json

{
    "name": "flottbot-webhook-test",
    "targetUrl": "https://your-domain",
    "resource": "messages",
    "event": "created"
}
$ export TOKEN=...
$ curl -v -H "Authorization: Bearer ${TOKEN}" -H 'Accept: application/json' -H 'Content-Type: application/json' -d @create-webhook.json https://api.ciscospark.com/v1/webhooks

You'll get back something like

{"id":"...","name":"flottbot-webhook-test","targetUrl":"https://your-domain","resource":"messages","event":"created","orgId":"...","createdBy":"...","appId":"...","ownedBy":"creator","status":"active","created":"2020-02-08T22:49:20.765Z"}
  1. Create a config file, flottbot.yaml (can override with -c to flottbot)
---
tlsCertFilePath: mydomain.com.fullchain.pem
tlsKeyFilePath: mydomain.com.key

loggingEnabled: true
loggingQueueSize: 10000

commandTimeoutInSeconds: 30

webexWebhookListen: 0.0.0.0
webexWebhookPort: 3000
webexWebhookEventWorkerCount: 4
webexWebhookEventWorkerQueueSize: 10000

webexAccessToken: <available once you have an account and create a bot, don't share this>
webexWebhookId: <in response from create webhook api call>
webexBotId: <available once you have an account and create a bot>
webexBotName: flottbot
webexBotUserName: flottbot
  1. Build
$ stack install
  1. Run
$ flottbot -h
flottbot - a bot for Cisco Webex Teams

Usage: flottbot [-c|--config-file FILE] [-v|--version]
  Cisco Webex Teams bot

Available options:
  -h,--help                Show this help text
  -c,--config-file FILE    YAML config file path (default: "flottbot.yaml")
  -v,--version             Print version

$ flottbot -v
0.0.1

$ flottbot -c flottbot.yaml

  1. Open a direct chat with the bot in the Teams app

  2. To delete the webhook

$ export webhook_id=""
$ curl -v -H "Authorization: Bearer ${TOKEN}" -H 'Accept: application/json' -H 'Content-Type: application/json' -X DELETE https://api.ciscospark.com/v1/webhooks/$webhook_id

Running the tests

TODO

Break down into end to end tests

TODO

And coding style tests

TODO

Deployment

TODO

Built With

  • Servant - The web framework used
  • And a host of other great Haskell libraries (see package.yaml)

Contributing

Open a PR.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments