Skip to content

sergenikov/crows-nest-api

Repository files navigation

Overview

API that encapsulates running of Nmap scanner (for now).

Client

There is an Angular web client for this API available here

Some product goals for this

  • Be able to scan hosts from a mobile phone using main network enumeration tools like nmap, dig, etc. This API has an Angular client that will allow me to scan hosts with Nmap, dig and other tools from any device once this is deployed. Of course, there are services that do that, but this is not important for a personal development project.
  • Have a functionality to show close to real time changes in opened ports of a given host. I don't know if it's really practical, but it seems cool.
  • Have simple insights into what services are running on a given host in-browser. For example, if there is a Samsung TV opening ports some host, have Crows Nest tell the user about that.

Why do this?

To accomplish a few personal goals:

  • Mainly, to have a small project that's easy to modify and to add new features to. For example, current simple queue functionality can be replaced with a third-party service that can do queuing like SQS or Kafka or anything else. Or I can rewrite the API in NestJS or Closure or Rust, just 'cause to learn something new. Having this project hopefully won't require looking for a new topic each time.
  • Learn about full stack development (the client app of this), async webservices, queueing, Spring Boot details, Docker, etc. All the regular parts of a contemporary stack.

Requirements to run

  • Java 8+
  • Gradle 6+
  • Nmap

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published