Giter Club home page Giter Club logo

muon's Introduction

Muon

Muon contains a database of URLS that are known to contain malware. The database can be queried using a REST API

Installation

Here are some examples to help you get started creating a container.

docker-compose (recommended)

---
version: "2.1"
services:
  muon:
    image: rogueranga/muon:latest
    container_name: muon
    ports:
      - 5000:5000
    restart: unless-stopped

docker cli

docker run -d \
  --name=muon \
  -p 5000:5000 \
  --restart unless-stopped \
  rogueranga/muon:latest

Usage

All responses will be in JSON. Note: The url must be base64 encoded

GET Request Parameters

Name Value Required
version 1 Yes
url base64 encoded url Yes

Example request

$ curl -X GET http://localhost:5000/urlinfo/1/d3d3LmJhc2U2NGVuY29kZS5vcmc6NDQzLw==

Response

{
    "base64_url":"d3d3LmJhc2U2NGVuY29kZS5vcmc6NDQzLw==",
    "id":1,
    "verified":"True",
    "verified_at":"Tue, 14 Dec 2021 20:11:51 GMT"
}

POST Request Parameters

Name Value Required
url base64 encoded url Yes
verified true/false Yes

Example request

$ curl -X POST http://localhost:5000/urlinfo/1/d3d3LmJhc2U2NGVuY29kZS5vcmc6NDQzLw==?verified=True

response

{
    "base64_url":"d3d3LmJhc2U2NGVuY29kZS5vcmc6NDQzLw==",
    "id":1,
    "verified":"True",
    "verified_at":"Tue, 14 Dec 2021 20:11:51 GMT"
}

Testing

Testing assumes you have the API avaiable on localhost:5000. To run the tests install pytests

pip3 install pytest

Then run pytest from the tests dir

/tests$ pytest

Contributing

Pull requests are welcome.

muon's People

Contributors

roguenorman avatar

Watchers

 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.