marcieltorres / safe-chat-slack-bot Goto Github PK

Describe the solution you would like.

Nowadays this project is more like a POC, so we should to improve using the bolt-python-starter-template main structure.

Additional context

ref:
https://github.com/slack-samples/bolt-python-starter-template

Describe the solution you would like.

slack-bot-no-cpf is a temporary name for this project, so we are searching for a new name for The Bot and SafeChat can be a good name as well. However, we should use this issue to discuss about this (or another) name. 🚀

Describe the bug

When you send a message without sensitive data and right after edit this message putting some sensitive data, the bot do nothing about it.

To reproduce

You can send a message without sensitive data and right after edit this message putting some sensitive data

Expected behavior

The bot must be send the warning message about sensitive data.

Actual behavior

The bot do nothing about it.

Describe the solution you would like.

Making the Bot public for all slack workspaces 🚀

Additional context

ref:
https://api.slack.com/start/distributing
https://github.com/slack-samples/bolt-python-starter-template/blob/main/README.md#app-distribution--oauth

Describe the solution you would like.

The Bot must be multi language to automatically adapt to other realities. We need to structure automatic translations to evolve into other languages ​​in a simple and scalable way.

Describe alternatives you considered

We must not consider to use chatGPT or similar because we don't to expose the sensitive data to external service.

1. GNU gettext

Additional context

refs:
https://lokalise.com/blog/beginners-guide-to-python-i18n/
https://phrase.com/blog/posts/translate-python-gnu-gettext/
https://docs.python.org/pt-br/3/library/gettext.html

Describe the solution you would like.

The ideal of the bot is to educate people so that they do not share sensitive information through Slack. However, it may be that eventually, in a specific situation, sharing sensitive data becomes necessary. In this case, the bot could offer a safer way for sharing sensitive data in public channels.

Describe alternatives you considered

Something like @safebot /security-message sensitive data, perhaps with the possibility to share via DM as well. Anyway, there are possibilities to be explored for this feature. Perhaps exploring features similar to 1Password.

Describe the solution you would like.

Improving the docs using a external site, gh pages may be a good idea.

Describe alternatives you considered

• gh pages

Additional context

#22

ref about gh pages:
https://docs.github.com/pt/pages/getting-started-with-github-pages/creating-a-github-pages-site

ref about some slack bots:

• https://opensay.co
• https://tisane.ai/slack-moderation-plugin/

Describe the solution you would like.

Users often share images (such as screenshots) in public channels on Slack that may contain sensitive user data. Considering this scenario, the bot should be able to recognize sensitive data in images and also alert these users.

Describe alternatives you considered

We should use some python lib to do it, like https://github.com/tesseract-ocr/tesseract

Additional context

refs:

• https://pythonclub.com.br/extraindo-texto-de-imagens-com-python.html
• https://github.com/tesseract-ocr/tesseract
• https://awari.com.br/ocr-em-python-aprenda-a-extrair-texto-de-imagens-com-facilidade
• https://github.com/guilhermedonizetti/OCR_Python
• https://github.com/madmaze/pytesseract

Describe the solution you would like.

Create a manifest.json file facilitating the slack creation application flow.

Additional context

refs:
https://api.slack.com/reference/manifests
https://github.com/slack-samples/bolt-python-starter-template/blob/main/manifest.json
https://github.com/slack-samples/bolt-python-starter-template/tree/main?tab=readme-ov-file#create-a-slack-app

Describe the solution you would like.

PTBR Version:
Essa issue em especial terá uma descrição também em pt-br
Como esse bot foi concebido para atuar fortemente junto com a LGPD no Brasil, ;e uma boa estratégia criar um REAMDE resumido todo no idioma pt-br com as principais informações sobre o bot, talvez até o tópico https://github.com/marcieltorres/safe-chat-slack-bot?tab=readme-ov-file#installing-on-workspace, as demais informações são técnicas e podem continuar apenas no idioma en. Essa estratégia visa também facilitar a busca com palavras chave para o bot, ajudando quem está pesquisando em português a encontrar essa solução.

EN Version:
As this bot was designed to strongly align with LGPD in Brazil, it is a good strategy to create a summarized README entirely in Brazilian Portuguese with key information about the bot, perhaps even the topic https://github.com/marcieltorres/safe-chat-slack-bot?tab=readme-ov-file#installing-on-workspace, while keeping other information technical and in English only. This strategy also aims to facilitate keyword searches for the bot, helping those who are researching in Portuguese to find this solution.

Additional context

ref: #9