Giter Site home page Giter Site logo

abuse-scanner's Introduction

Abuse Scanner

The abuse scanner is a project which will monitor a mailbox and periodically scan it for reported (abusive) skylinks.

Architecture

The scanner used a MongoDB database in which it persists 3 types of entities:

  • emails: used to persist the email and some state variables
  • locks: used for distributed locking
  • reports: NCMEC reports

The database name is abuse-scanner

The scanner is comprised of 4 main modules:

  • the fetcher: downloads the emails from the mailbox
  • the parser: parses abusive skylinks and tags from the email body
  • the blocker: blocks the skylinks using the blocker API
  • the finalizer: finalizes the emails
  • the reporter: reports csam abuse to NCMEC

The modules communicate through a shared database and a series of booleans that define whether a certain module has handled the email in question, e.g. parsed, blocked and finalized.

The finalizer replies to the abuse email with a scanner report, sent to the abuse mailbox itself. If the email was successfully handled, we also send an automated reply to the original sender of the abuse email.

NCMEC

All emails that are tagged with the csam are emails from which we want to report the skylinks to NCMEC

In order for this to happen, the ABUSE_NCMEC_REPORTING_ENABLED has to be set to true and all NCMEC related environment variables have to be filled in accordingly.

Environment

  • ABUSE_LOG_LEVEL
  • ABUSE_MAILADDRESS
  • ABUSE_MAILBOX
  • ABUSE_NCMEC_REPORTING_ENABLED
  • ABUSE_PORTAL_URL, e.g. https://siasky.net
  • ABUSE_SPONSOR
  • SKYNET_ACCOUNTS_HOST, e.g accounts
  • SKYNET_ACCOUNTS_PORT, e.g 3000
  • BLOCKER_HOST
  • BLOCKER_PORT
  • EMAIL_SERVER
  • EMAIL_USERNAME
  • EMAIL_PASSWORD
  • NCMEC_USERNAME
  • NCMEC_PASSWORD
  • NCMEC_REPORTER_FIRSTNAME
  • NCMEC_REPORTER_LASTNAME
  • NCMEC_REPORTER_EMAIL
  • NCMEC_DEBUG
  • SERVER_DOMAIN
  • SKYNET_DB_HOST
  • SKYNET_DB_PORT
  • SKYNET_DB_USER
  • SKYNET_DB_PASS

abuse-scanner's People

Contributors

dependabot[bot] avatar kwypchlo avatar msevey avatar peterjan avatar ro-tex 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.