Initial commit

.chainlit/config.toml

@@ -0,0 +1,84 @@
+[project]
+# Whether to enable telemetry (default: true). No personal data is collected.
+enable_telemetry = true
+
+# List of environment variables to be provided by each user to use the app.
+user_env = ["OPENAI_API_KEY"]
+
+# Duration (in seconds) during which the session is saved when the connection is lost
+session_timeout = 3600
+
+# Enable third parties caching (e.g LangChain cache)
+cache = false
+
+# Follow symlink for asset mount (see https://github.com/Chainlit/chainlit/issues/317)
+# follow_symlink = false
+
+[features]
+# Show the prompt playground
+prompt_playground = true
+
+# Process and display HTML in messages. This can be a security risk (see https://stackoverflow.com/questions/19603097/why-is-it-dangerous-to-render-user-generated-html-or-javascript)
+unsafe_allow_html = false
+
+# Process and display mathematical expressions. This can clash with "$" characters in messages.
+latex = false
+
+# Authorize users to upload files with messages
+multi_modal = false
+
+# Allows user to use speech to text
+[features.speech_to_text]
+    enabled = false
+    # See all languages here https://github.com/JamesBrill/react-speech-recognition/blob/HEAD/docs/API.md#language-string
+    # language = "en-US"
+
+[UI]
+# Name of the app and chatbot.
+name = "PoliGen"
+
+# Show the readme while the conversation is empty.
+show_readme_as_default = true
+
+# Description of the app and chatbot. This is used for HTML tags.
+# description = ""
+
+# Large size content are by default collapsed for a cleaner ui
+default_collapse_content = true
+
+# The default value for the expand messages settings.
+default_expand_messages = false
+
+# Hide the chain of thought details from the user in the UI.
+hide_cot = false
+
+# Link to your github repo. This will add a github button in the UI's header.
+github = "https://github.com/mrwadams/poligen"
+
+# Specify a CSS file that can be used to customize the user interface.
+# The CSS file can be served from the public directory or via an external link.
+# custom_css = "/public/test.css"
+
+# Override default MUI light theme. (Check theme.ts)
+[UI.theme.light]
+    #background = "#FAFAFA"
+    #paper = "#FFFFFF"
+
+    [UI.theme.light.primary]
+        #main = "#F80061"
+        #dark = "#980039"
+        #light = "#FFE7EB"
+
+# Override default MUI dark theme. (Check theme.ts)
+[UI.theme.dark]
+    #background = "#FAFAFA"
+    #paper = "#FFFFFF"
+
+    [UI.theme.dark.primary]
+        #main = "#F80061"
+        #dark = "#980039"
+        #light = "#FFE7EB"
+
+
+[meta]
+generated_by = "0.7.700"

.chainlit/translations/en-US.json

@@ -0,0 +1,155 @@
+{
+    "components": {
+        "atoms": {
+            "buttons": {
+                "userButton": {
+                    "menu": {
+                        "settings": "Settings",
+                        "settingsKey": "S",
+                        "APIKeys": "API Keys",
+                        "logout": "Logout"
+                    }
+                }
+            }
+        },
+        "molecules": {
+            "newChatButton": {
+                "newChat": "New Chat"
+            },
+            "tasklist": {
+                "TaskList": {
+                    "title": "\ud83d\uddd2\ufe0f Task List",
+                    "loading": "Loading...",
+                    "error": "An error occured"
+                }
+            },
+            "attachments": {
+                "cancelUpload": "Cancel upload",
+                "removeAttachment": "Remove attachment"
+            },
+            "newChatDialog": {
+                "createNewChat": "Create new chat?",
+                "clearChat": "This will clear the current messages and start a new chat.",
+                "cancel": "Cancel",
+                "confirm": "Confirm"
+            },
+            "settingsModal": {
+                "expandMessages": "Expand Messages",
+                "hideChainOfThought": "Hide Chain of Thought",
+                "darkMode": "Dark Mode"
+            }
+        },
+        "organisms": {
+            "chat": {
+                "history": {
+                    "index": {
+                        "lastInputs": "Last Inputs",
+                        "noInputs": "Such empty...",
+                        "loading": "Loading..."
+                    }
+                },
+                "inputBox": {
+                    "input": {
+                        "placeholder": "Type your message here..."
+                    },
+                    "speechButton": {
+                        "start": "Start recording",
+                        "stop": "Stop recording"
+                    },
+                    "SubmitButton": {
+                        "sendMessage": "Send message",
+                        "stopTask": "Stop Task"
+                    },
+                    "UploadButton": {
+                        "attachFiles": "Attach files"
+                    },
+                    "waterMark": {
+                        "text": "Built with"
+                    }
+                },
+                "Messages": {
+                    "index": {
+                        "running": "Running",
+                        "executedSuccessfully": "executed successfully",
+                        "failed": "failed",
+                        "feedbackUpdated": "Feedback updated",
+                        "updating": "Updating"
+                    }
+                },
+                "dropScreen": {
+                    "dropYourFilesHere": "Drop your files here"
+                },
+                "index": {
+                    "failedToUpload": "Failed to upload",
+                    "cancelledUploadOf": "Cancelled upload of",
+                    "couldNotReachServer": "Could not reach the server",
+                    "continuingChat": "Continuing previous chat"
+                },
+                "settings": {
+                    "settingsPanel": "Settings panel",
+                    "reset": "Reset",
+                    "cancel": "Cancel",
+                    "confirm": "Confirm"
+                }
+            },
+            "threadHistory": {
+                "sidebar": {
+                    "filters": {
+                        "FeedbackSelect": {
+                            "feedbackAll": "Feedback: All",
+                            "feedbackPositive": "Feedback: Positive",
+                            "feedbackNegative": "Feedback: Negative"
+                        },
+                        "SearchBar": {
+                            "search": "Search"
+                        }
+                    },
+                    "DeleteThreadButton": {
+                        "confirmMessage": "This will delete the thread as well as it's messages and elements.",
+                        "cancel": "Cancel",
+                        "confirm": "Confirm",
+                        "deletingChat": "Deleting chat",
+                        "chatDeleted": "Chat deleted"
+                    },
+                    "index": {
+                        "pastChats": "Past Chats"
+                    },
+                    "ThreadList": {
+                        "empty": "Empty..."
+                    },
+                    "TriggerButton": {
+                        "closeSidebar": "Close sidebar",
+                        "openSidebar": "Open sidebar"
+                    }
+                },
+                "Thread": {
+                    "backToChat": "Go back to chat",
+                    "chatCreatedOn": "This chat was created on"
+                }
+            },
+            "header": {
+                "chat": "Chat",
+                "readme": "Readme"
+            }
+        }
+    },
+    "hooks": {
+        "useLLMProviders": {
+            "failedToFetchProviders": "Failed to fetch providers:"
+        }
+    },
+    "pages": {
+        "Design": {},
+        "Env": {
+            "savedSuccessfully": "Saved successfully",
+            "requiredApiKeys": "Required API Keys",
+            "requiredApiKeysInfo": "To use this app, the following API keys are required. The keys are stored on your device's local storage."
+        },
+        "Page": {
+            "notPartOfProject": "You are not part of this project."
+        },
+        "ResumeButton": {
+            "resumeChat": "Resume Chat"
+        }
+    }
+}

.chainlit/translations/pt-BR.json

@@ -0,0 +1,155 @@
+{
+    "components": {
+        "atoms": {
+            "buttons": {
+                "userButton": {
+                    "menu": {
+                        "settings": "Configura\u00e7\u00f5es",
+                        "settingsKey": "S",
+                        "APIKeys": "Chaves de API",
+                        "logout": "Sair"
+                    }
+                }
+            }
+        },
+        "molecules": {
+            "newChatButton": {
+                "newChat": "Nova Conversa"
+            },
+            "tasklist": {
+                "TaskList": {
+                    "title": "\ud83d\uddd2\ufe0f Lista de Tarefas",
+                    "loading": "Carregando...",
+                    "error": "Ocorreu um erro"
+                }
+            },
+            "attachments": {
+                "cancelUpload": "Cancelar envio",
+                "removeAttachment": "Remover anexo"
+            },
+            "newChatDialog": {
+                "createNewChat": "Criar novo chat?",
+                "clearChat": "Isso limpar\u00e1 as mensagens atuais e iniciar\u00e1 uma nova conversa.",
+                "cancel": "Cancelar",
+                "confirm": "Confirmar"
+            },
+            "settingsModal": {
+                "expandMessages": "Expandir Mensagens",
+                "hideChainOfThought": "Esconder Sequ\u00eancia de Pensamento",
+                "darkMode": "Modo Escuro"
+            }
+        },
+        "organisms": {
+            "chat": {
+                "history": {
+                    "index": {
+                        "lastInputs": "\u00daltimas Entradas",
+                        "noInputs": "Vazio...",
+                        "loading": "Carregando..."
+                    }
+                },
+                "inputBox": {
+                    "input": {
+                        "placeholder": "Digite sua mensagem aqui..."
+                    },
+                    "speechButton": {
+                        "start": "Iniciar grava\u00e7\u00e3o",
+                        "stop": "Parar grava\u00e7\u00e3o"
+                    },
+                    "SubmitButton": {
+                        "sendMessage": "Enviar mensagem",
+                        "stopTask": "Parar Tarefa"
+                    },
+                    "UploadButton": {
+                        "attachFiles": "Anexar arquivos"
+                    },
+                    "waterMark": {
+                        "text": "Constru\u00eddo com"
+                    }
+                },
+                "Messages": {
+                    "index": {
+                        "running": "Executando",
+                        "executedSuccessfully": "executado com sucesso",
+                        "failed": "falhou",
+                        "feedbackUpdated": "Feedback atualizado",
+                        "updating": "Atualizando"
+                    }
+                },
+                "dropScreen": {
+                    "dropYourFilesHere": "Solte seus arquivos aqui"
+                },
+                "index": {
+                    "failedToUpload": "Falha ao enviar",
+                    "cancelledUploadOf": "Envio cancelado de",
+                    "couldNotReachServer": "N\u00e3o foi poss\u00edvel conectar ao servidor",
+                    "continuingChat": "Continuando o chat anterior"
+                },
+                "settings": {
+                    "settingsPanel": "Painel de Configura\u00e7\u00f5es",
+                    "reset": "Redefinir",
+                    "cancel": "Cancelar",
+                    "confirm": "Confirmar"
+                }
+            },
+            "threadHistory": {
+                "sidebar": {
+                    "filters": {
+                        "FeedbackSelect": {
+                            "feedbackAll": "Feedback: Todos",
+                            "feedbackPositive": "Feedback: Positivo",
+                            "feedbackNegative": "Feedback: Negativo"
+                        },
+                        "SearchBar": {
+                            "search": "Buscar"
+                        }
+                    },
+                    "DeleteThreadButton": {
+                        "confirmMessage": "Isso deletar\u00e1 a conversa, assim como suas mensagens e elementos.",
+                        "cancel": "Cancelar",
+                        "confirm": "Confirmar",
+                        "deletingChat": "Deletando conversa",
+                        "chatDeleted": "Conversa deletada"
+                    },
+                    "index": {
+                        "pastChats": "Conversas Anteriores"
+                    },
+                    "ThreadList": {
+                        "empty": "Vazio..."
+                    },
+                    "TriggerButton": {
+                        "closeSidebar": "Fechar barra lateral",
+                        "openSidebar": "Abrir barra lateral"
+                    }
+                },
+                "Thread": {
+                    "backToChat": "Voltar para a conversa",
+                    "chatCreatedOn": "Esta conversa foi criada em"
+                }
+            },
+            "header": {
+                "chat": "Conversa",
+                "readme": "Leia-me"
+            }
+        },
+        "hooks": {
+            "useLLMProviders": {
+                "failedToFetchProviders": "Falha ao buscar provedores:"
+            }
+        },
+        "pages": {
+            "Design": {},
+            "Env": {
+                "savedSuccessfully": "Salvo com sucesso",
+                "requiredApiKeys": "Chaves de API necess\u00e1rias",
+                "requiredApiKeysInfo": "Para usar este aplicativo, as seguintes chaves de API s\u00e3o necess\u00e1rias. As chaves s\u00e3o armazenadas localmente em seu dispositivo."
+            },
+            "Page": {
+                "notPartOfProject": "Voc\u00ea n\u00e3o faz parte deste projeto."
+            },
+            "ResumeButton": {
+                "resumeChat": "Continuar Conversa"
+            }
+        }
+    }
+}

.gitignore

@@ -0,0 +1,4 @@
+venv/
+.env
+.cache
+.__pycache__

README.md

@@ -0,0 +1,60 @@
+![PoliGen Logo](poligen_logo.png)
+
+# PoliGen 📄🤖
+## A Multi-Agent Chat Interface for Generating Cybersecurity Policies
+
+PoliGen harnesses the power of multi-agent chat interfaces to streamline the generation of cybersecurity policies. Tailored for organisations seeking to update their policy documentation to align with recognised information security best practices, PoliGen simplifies the process, enabling both cybersecurity experts and non-experts to craft policies that meet their specific needs.
+
+## Overview
+
+Utilising an innovative combination of OpenAI's [GPT](https://openai.com/product#gpt) models and [AutoGen](https://microsoft.github.io/autogen/), a cutting-edge multi-agent conversation framework, PoliGen facilitates a dynamic, interactive environment where users can directly specify their cybersecurity policy requirements. This collaboration between human input and artificial intelligence enables policy documents to be produced within minutes instead of days.
+
+## Features
+
+* **Interactive Multi-Agent System:** Engage with a team of AI agents, including a User Proxy, Technical Writer, and Reviewer, each with specific roles to ensure the creation of comprehensive and professionally structured policy documents.
+* **User-Guided Policy Generation:** Influence the policy generation process in real-time, providing feedback and direction to refine and tailor the output according to your organisational needs.
+* **Best Practices Alignment:** Generated policies reflect the latest in cybersecurity best practices, ensuring your documentation is both current and effective.
+* **Flexible and Accessible:** Designed for a wide range of users, from cybersecurity professionals to those with limited technical expertise, making policy generation accessible to all.
+
+## Installation
+
+1. Clone the PoliGen repository to your local machine.
+
+    ```bash
+    git clone https://github.com/mrwadams/poligen.git
+    ```
+    
+2. Change into the PoliGen directory.
+
+    ```bash
+    cd poligen
+    ```
+
+3. Install the required dependencies.
+    
+    ```bash
+    pip install -r requirements.txt
+    ```
+
+4. Start the application.
+
+    ```bash
+    chainlit run app.py
+    ``````
+
+5. If you don't already have one stored, you will be prompted to enter your OpenAI API key.
+
+## Live Demo
+You can also try out PoliGen in your browser using the HuggingFace Spaces platform. Click the button below to launch the live demo.
+
+[![Run on Hugging Face Spaces](https://img.shields.io/badge/%F0%9F%A4%97-Run_on_HuggingFace_Spaces-yellow)](https://huggingface.co/spaces/mrwadams/poligen)
+
+## Contributions
+
+PoliGen is an open-source project and contributions are welcome. If you're interested in improving the tool or adding new features, please fork the repository and submit a pull request with your changes.
+
+## Acknowledgements
+This project was inspired by Antoine Ross' AutoGen Article Generator, which can be found [here](https://github.com/antoineross/autogen-article-generator/tree/main).
+
+## License
+PoliGen is released under MIT License, allowing for wide-ranging flexibility in both personal and commercial use.

app.py

@@ -0,0 +1,222 @@
+from typing import Dict, Optional, Union
+
+import chainlit as cl
+
+import autogen
+from autogen import Agent, AssistantAgent, UserProxyAgent
+
+CONTEXT = """- Task: PoliGen specialises in creating high-quality and detailed cybersecurity policies. The target audience is organisations that want to update their policy documentation to reflect recognised information security best practices.
+    
+    Output Specifications: 
+    
+    • Output Style and Format: Write policy documents that are thorough and detailed. Ensure grammatical accuracy, coherence, and stylistic refinement. Structure the policy document logically and clearly. 
+    
+    • Tone: The tone is formal and professional.
+    
+    • Section Headings and Subheadings: Create titles and subheadings that are clear, concise, and descriptive. 
+    
+    • Section Headings: Use a consistent format for section headings. 
+    
+    • Subheadings: Use a consistent format for subheadings. 
+        
+    • Content Structure: Use bullet points or numbered lists to present information in a clear and concise manner.
+    
+    Sample output:
+    
+    - Introduction
+    - Purpose
+    - Scope
+    - Policy Details (this section and subheadings will vary depending on the policy type)
+    - Responsibilities
+    - Enforcement
+    - Definitions
+    - References
+    - Revision History
+    - Appendix A: Glossary
+    - Appendix B: Acronyms
+    - Appendix C: Document Control
+
+    """
+
+# Agents
+USER_PROXY_NAME = "User Proxy"
+REVIEWER = "Reviewer"
+WRITER = "Technical Writer"
+    
+async def ask_helper(func, **kwargs):
+    res = await func(**kwargs).send()
+    while not res:
+        res = await func(**kwargs).send()
+    return res
+
+class ChainlitAssistantAgent(AssistantAgent):
+    """
+    Wrapper for AutoGens Assistant Agent
+    """
+    def send(
+        self,
+        message: Union[Dict, str],
+        recipient: Agent,
+        request_reply: Optional[bool] = None,
+        silent: Optional[bool] = False,
+    ) -> bool:
+        cl.run_sync(
+            cl.Message(
+                content=f'*Sending message to "{recipient.name}":*\n\n{message}',
+                author=self.name,
+            ).send()
+        )
+        super(ChainlitAssistantAgent, self).send(
+            message=message,
+            recipient=recipient,
+            request_reply=request_reply,
+            silent=silent,
+        )
+class ChainlitUserProxyAgent(UserProxyAgent):
+    """
+    Wrapper for AutoGens UserProxy Agent. Simplifies the UI by adding CL Actions. 
+    """
+    def get_human_input(self, prompt: str) -> str:
+        if prompt.startswith(
+            "Provide feedback to chat_manager. Press enter to skip and use auto-reply"
+        ):
+            res = cl.run_sync(
+                ask_helper(
+                    cl.AskActionMessage,
+                    content="Continue or provide feedback?",
+                    actions=[
+                        cl.Action( name="continue", value="continue", label="✅ Continue" ),
+                        cl.Action( name="feedback",value="feedback", label="💬 Provide feedback"),
+                        cl.Action( name="exit",value="exit", label="🔚 Exit Conversation" )
+                    ],
+                )
+            )
+            if res.get("value") == "continue":
+                return ""
+            if res.get("value") == "exit":
+                return "exit"
+
+        reply = cl.run_sync(ask_helper(cl.AskUserMessage, content=prompt, timeout=60))
+
+        return reply["content"].strip()
+
+    def send(
+        self,
+        message: Union[Dict, str],
+        recipient: Agent,
+        request_reply: Optional[bool] = None,
+        silent: Optional[bool] = False,
+    ):
+        cl.run_sync(
+            cl.Message(
+                content=f'*Sending message to "{recipient.name}"*:\n\n{message}',
+                author=self.name,
+            ).send()
+        )
+        super(ChainlitUserProxyAgent, self).send(
+            message=message,
+            recipient=recipient,
+            request_reply=request_reply,
+            silent=silent,
+        )
+
+
+
+config_list = [
+    {
+        "model": "gpt-4-turbo-preview",
+    },
+]
+
+
+
+@cl.action_callback("confirm_action")
+async def on_action(action: cl.Action):
+    if action.value == "everything":
+        content = "everything"
+    elif action.value == "top-headlines":
+        content = "top_headlines"
+    else:
+        await cl.ErrorMessage(content="Invalid action").send()
+        return
+
+    prev_msg = cl.user_session.get("url_actions")  # type: cl.Message
+    if prev_msg:
+        await prev_msg.remove_actions()
+        cl.user_session.set("url_actions", None)
+
+    await cl.Message(content=content).send()
+
+    
+@cl.on_chat_start
+async def start():
+#  OPENAI_API_KEY = os.getenv('OPENAI_API_KEY')
+  OPENAI_API_KEY = cl.user_session.get("OPENAI_API_KEY")
+
+
+  try:
+    # app_user = cl.user_session.get("user")
+    # await cl.Message(f"Hello {app_user.username}").send()
+    # config_list = config_list_from_json(env_or_file="OAI_CONFIG_LIST")
+    llm_config = {"config_list": config_list, "api_key": OPENAI_API_KEY, "seed": 42, "request_timeout": 120, "retry_wait_time": 10}
+    reviewer = ChainlitAssistantAgent(
+        name="Reviewer", llm_config=llm_config,
+        system_message="""Reviewer. Reviews the policy document, focuses on the structure and clarity of the content.
+Ensures policies are detailed and thorough.
+Highly focussed on helping the Technical Writer to create a high-quality policy document.
+Only provides suggestions for improvement."""
+    )
+    writer = ChainlitAssistantAgent(
+        name="Technical_Writer", llm_config=llm_config,
+        system_message="""Technical Writer. Creates high-quality and detailed information security policies, focusing on recognised information security best practices.
+Writes policy documents that are thorough and detailed.
+Crafts documents using a formal and professional tone.
+Structures content with effective subheadings and bullet points to facilitate reader comprehension."""
+    )
+    user_proxy = ChainlitUserProxyAgent(
+        name="User_Proxy",
+        human_input_mode="ALWAYS",
+        llm_config=llm_config,
+        # max_consecutive_auto_reply=3,
+        # is_termination_msg=lambda x: x.get("content", "").rstrip().endswith("TERMINATE"),
+        code_execution_config=False,
+        system_message="""User Proxy. Provides feedback on the policy document and guides the team through the process."""
+    )
+    
+    cl.user_session.set(USER_PROXY_NAME, user_proxy)
+    cl.user_session.set(REVIEWER, reviewer)
+    cl.user_session.set(WRITER, writer)
+    
+    msg = cl.Message(content=f"""Hi, this is the PoliGen agent team 🤖. Please specify a cybersecurity domain for us to write a policy about (e.g. Data Classification, Remote Access).""", 
+                     disable_human_feedback=True, 
+                     author="User_Proxy")
+    await msg.send()
+    
+  except Exception as e:
+    print("Error: ", e)
+    pass
+
+@cl.on_message
+async def run_conversation(message: cl.Message):
+  #try:
+    MESSAGE = message.content
+    print("Task: ", MESSAGE)
+    reviewer = cl.user_session.get(REVIEWER)
+    user_proxy = cl.user_session.get(USER_PROXY_NAME)
+    writer = cl.user_session.get(WRITER)
+
+    groupchat = autogen.GroupChat(agents=[user_proxy, reviewer, writer], messages=[], max_round=10)
+    manager = autogen.GroupChatManager(groupchat=groupchat)
+    
+    print("Initiated GC messages... \nGC messages length: ", len(groupchat.messages))
+
+    if len(groupchat.messages) == 0:
+      message = f"""Write a policy document for the following cybersecurity domain: """ + MESSAGE + """. The final output should adhere to these requirements: \n""" + CONTEXT
+      await cl.Message(content=f"""Starting agents on task of creating a policy document...""").send()
+      await cl.make_async(user_proxy.initiate_chat)( manager, message=message, )
+    else:
+      await cl.make_async(user_proxy.send)( manager, message=MESSAGE, )
+      
+#   except Exception as e:
+#     print("Error: ", e)
+#     pass

chainlit.md

@@ -0,0 +1,6 @@
+# PoliGen 📄🤖
+## A multi-agent chat inferface for generating cybersecurity policies
+
+PoliGen is a multi-agent chat interface for generating cybersecurity policies. It is designed to be used by non-experts in cybersecurity, to help them generate policies that are tailored to their specific needs.
+
+The tool uses an OpenAI [GPT model](https://openai.com/product#gpt) in combination with [AutoGen](https://microsoft.github.io/autogen/) - a multi-agent conversation framework for building Large Language Model (LLM) workflows. Together, they allow users to simply specify the type of policy they need, and then have it generated by a team of AI agents. The user can also participate in the conversation, providing feedback and guidance to the agents to improve the quality of the generated policy.

requirements.txt

@@ -0,0 +1,2 @@
+pyautogen
+chainlit