Code Monkey home page Code Monkey logo

admyral-security / admyral Goto Github PK

View Code? Open in Web Editor NEW
218.0 4.0 3.0 9 MB

πŸ€– Cybersecurity Automation & Investigation Assistant

Home Page: https://admyral.dev

License: Apache License 2.0

Rust 47.14% JavaScript 0.06% CSS 0.23% TypeScript 39.03% Shell 0.17% Dockerfile 0.50% Python 11.97% Mako 0.05% HTML 0.04% PLpgSQL 0.81%
cybersecurity hyperautomation open-source python rust security-automation typescript case-management gpt workflow

admyral's Introduction

admyral

Login Β· Docs Β· Discord

Commit Activity License Status


Admyral is an open-source Cybersecurity Automation & Investigation Assistant. Admyral's Assistant enjoys a deep integration into Admyral's case management and workflow automation. Through this triangulation, SOC teams can benefit from:

  1. A unified console to perform investigations and handle incidents πŸ“Ί
  2. A seamless workflow automation creation -- even during incident triage, investigation, or response πŸ‘·
  3. Automatic alert investigation as well as next step suggestions for analysts πŸ§‘β€βœˆοΈ
  4. Recommendations for automating workflows πŸ€–

Through Admyral's Assistant functionality, Admyral seeks to provide a new, more effective, and scalable approach for tackling alert fatigue and automating security workflows.

β†’ β†’ β†’ Try out the free cloud version ← ← ←

Here is a sneek-peak into the workflow automation builder: admyral

πŸ—ΊοΈ Key Features & Roadmap

Hyperautomation Platform Foundation

  • Workflow Actions
    • HTTP request
    • Manual and event-based workflow start
    • Credential Management for HTTP Requests
    • If-Condition
    • AI Actions
    • Send Emails
    • Scheduling
    • Case Actions (Create Case, Update Case, etc.)
    • Receive Emails
    • Data Transformations
    • Formulas
    • Custom Python code
  • Run history
  • Case Management
  • Alert Handling
  • Dashboard

Next-Gen Hyperautomation Features

  • Natural Language to Workflow Automation
  • Incident Investigation Assistant
  • AI-proposed next steps on handling an incident/a case
  • Customized workflow automation recommendations

Integrations

Available Integrations: VirusTotal, Jira, Slack, AlienVault, Phish Report, Jira, GreyNoise, MS Defender, Abnormal, and many more.

What integrations are missing for you? Let us know on Discord or [email protected] about your use-case and we will build it within less than one week!

Hosting

  • Cloud version
  • Self-hosting

Misc

  • Β Multi-tenancy for MSSPs

πŸš€ Get Started

Admyral Cloud

Managed deployment by the Admyral team, free, no credit card required.

Β» Admyral Cloud

Self-hosting with Docker

# Clone the repository
git clone https://github.com/Admyral-Security/admyral.git
 
# Change directory to docker self-hosting
cd admyral/deploy/selfhosting
 
# Copy the env vars
cp .env.example .env
 
# Start the services in detached mode
docker compose up -d

Β» Learn more about deploying locally

πŸ’¬ Feedback & Contributing to Admyral

We value your feedback and contributions! For details on how to contribute, check out the (Contribution Guideline)[https://github.com/Admyral-Security/admyral/blob/main/CONTRIBUTING.md].

If you have suggestions, questions, or would like to discuss anything related to Admyral, just text us on Discord.

❓ FAQ

What is the issue with the current Security Automation tools?

  1. Challenges of Staffing in Security Automation Implementation: Security automation platforms promised to reduce the burden on security teams. However, they still require a dedicated team for building and managing automations, not addressing the ongoing issue of a skilled worker shortage.

  2. Automation Builders & Requesters vs. Automation Users: Security Engineers are tasked with building automations while Managers drive their development based on input from the end users, aka Security Analysts. To complicate this, there's a lack of a feedback loop among these groups.

  3. Inflexibility of Static Workflows in a Dynamic Threat Environment: Existing security automation platforms originated from generic workflow builders and are designed for static environments and pre-GenAI era. In cybersecurity, where threats evolve rapidly, static workflows are inadequate. It is impossible to constantly maintain and update static and predefined workflows.

Overall, creating workflows should be made easier, more accessible, and faster. This enables automation users, e.g. Security Analysts, to effortlessly create workflows during their regular processes without creating additional overhead. To achieve this, we have to rethink the creation and overall concept of security automation. We believe that workflows is a dynamic concept that should welcome easy case-by-case adjustments during the incident investigation stage and beyond.

Why should security automation and case management be combined?

Security automation and case management are two sides of the same coin. Security automation is the process of automating security tasks, while case management is the process of managing security incidents. Combining the two allows for a more streamlined and efficient incident response process. By automating repetitive tasks and integrating automations into the case management process, security teams can respond to incidents more quickly and effectively. This integration also allows for better tracking and reporting of incidents, which can help organizations identify trends and improve their overall security posture.

How do you stay secure?

Visit SECURITY.md for more details.

What does your pricing look like?

As Admyral is still in its public alpha phase, we have not finalized a specific pricing structure yet. We invite interested organizations to reach out directly via email at [email protected] or Discord to discuss potential use cases and explore custom pricing options based on their needs and the scale of implementation.

Why is Admyral open-source?

We are open-source for the following reasons:

  • To establish transparency and trust with our users
  • To enable the community to self-host and contribute to Admyral
  • To collaborate on integrations and features with the community because users know best what a Cybersecurity Automation & Investigation Assistant should look like
  • To secure small- and medium-sized businesses, that have no budget for security

Does Admyral stay open-source?

We love open-source. Therefore, Admyral stays committed to keep all open-sourced features freely available under the same open-source terms and maintain them. However, future premium features may only be part of our enterprise version. For specific requirements, please reach out to us via [email protected].

πŸ™οΈ Enterprise Version

Disclaimer: Admyral is still in public alpha. If you'd like to use it within your company or try it out, reach out to us via [email protected] or directly on Discord.

As of now, our project does not have a dedicated Enterprise version. If you represent an MSSP or an Enterprise and would like to discuss potential collaborations with Admyral, please do not hesitate to reach out directly at [email protected] to start a conversation. We are excited about the possibility of working together to meet your specific business needs and to expand the capabilities of our project in a way that benefits your organization.

πŸ“ƒ License

This repository is licensed under Apache License 2.0. See LICENSE for more details.

Misc

Telemetry

Admyral automatically collects telemetry data using PostHog with hosting in the EU. We want to emphasize that no personal data is sent to PostHog. The data helps us to understand how Admyral is used and improve our most relevant features as well as track the overall usage for internal and external reporting.

None of data is shared with third parties and does not include any sensitive information. If you would like to opt-out of telemetry or have questions, please reach out to us via [email protected] or contact us on Discord, as we want to be transparent and respect your privacy.

For self-hosting, you can opt-out by simply removing NEXT_PUBLIC_POSTHOG_KEY and NEXT_PUBLIC_POSTHOG_HOST from the environment variables.

admyral's People

Contributors

christophergrittner avatar danielgrittner avatar dependabot[bot] avatar eltociear 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  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  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  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

admyral's Issues

VirusTotal Integration: Implement pagination

Feature request

The APIs in workflow-runner/workflow/integration_action/virustotal.rs requiring pagination are marked with TODO.

There are two acceptable solutions for now:

  • extend HttpClient to automatically handle pagination (preferred)
  • directly implement it in the corresponding functions

Hint user if an integration action without credentials is selected

Feature request

If a user has selected an integration action (e.g. integration Slack, API Send a message) and didn't configure the corresponding credentials, then the Select field for credentials is empty. From a user perspective, it would be helpful to render a warning below the Select field to tell the user that credentials for this integration have not yet been configured.

Add search bar to integrations/API side panel

Feature request

When dropping an Integration node and clicking on it in the workflow builder UI, you can see in the right side panel a list of integrations and if you click on that integration you can see a list of APIs. For both, integrations and APIs a search bar on top is needed.

Admyral is based on Radix UI.

Migrate from workflow timeout to maximum workflow steps

Feature request

The workflow runner can be configured to stop jobs exceeding a certain time limit. However, due to potentially, high latency times of some integrations, we should rather stop workflows after a certain amount of actions have been executed. Similarly to the timeout, the max. number of steps should be optional and configurable via environment variables.

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.