Coder Social home page Coder Social logo

ai-report-assistant's Introduction

AI-Report-Assistant

๐Ÿ›ธ Harness the Power of AI for all your reporting needs ๐Ÿš€

Kind of, it works but whether it is of use to you is a different matter.

Not a real API Key ๐Ÿ˜Ž image

Mainly came about as I wanted to generate a decent Knowledge Base for reporting and trying to save time when Googling for issues as not to use Nessus Writeups.

Like everything I ever do, it goes from an idea to spending more time than I should trying to get it to work.

Is it glorified google?

Basically yes, you could easily get all the information it returns by either a) googling for the information or b) going to chatgpt and asking it questions.

But......command line tools are much cooler imo.

So what is it?

Its just a Python scipt for interacting with the chatgpt api.

pip install openai

You need an openAI API Key

Sign into chatgpt and get an API Key - You get $5 free. It costs about $0.002 per API request so free credit will probably expire before you use up that amount.

Is it well built?

Doubtful, I have minimal developer experience. This was done to serve a purpose and to improve my python understanding. If you have any issues with the code feel free to re-write it.

Is it well tested?

Works on my kali VM ๐Ÿคท๐Ÿผโ€โ™‚๏ธ

TODO

Needs more error handling and colours, everyone likes a coloured output. Possibly add some extra parameters to use for the writeups as currently it just uses the pluginName from the .nessus xml file.

How to use

You can use it interactively to get writeups for a single issue or pass it a .nessus file and it will parse it, pulling all Critical, High, Medium and Low Issues then using the pluginName as input to get writeups.

All issues are then saved in an .txt file.

Run with python3 Report-Assist.py

Can it be tweaked?

100% - See below. This is sent with every request, it tells chatgpt what is expected.

# Initialize message history
message_history = [
    {"role": "user", "content": "You are a penetration test report writing technical assistant. "
                                 "Give me Penetration Test Report writeups for each vulnerability I give you. "
                                 "Provide a Description, Background, Risk, Impact and remediaton section. "
                                 "All respsonses must be highly technical in nature. show the commands "
                                 "used to check for this issue."}]

Nessus File

If passing a nessus file choose option 2 and give it the filename.

image

Will output .txt file with Issues in Current Directory

image

Interactive Mode

Try to be specific for best results. If choosing option 1 just give it the issue ie >: SMB Signing enabled but not required on Windows 10 host

image

Return to Menu added

image

NOTE

Do not copy Verbatim - for obvious reasons, it can give sometimes you random information that isnt entirely correct

ai-report-assistant's People

Contributors

deeexcee-io avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.