flan - A pretty sweet vulnerability scanner

项目说明

<img src="

Flan Scan is a lightweight network scanner. With Flan Scan you can easily find open ports on your network, identify services and their , and get a list of relevant C your network.

Flan Scan is a wrapper over Nmap and the script which turns Nmap into a full-fledged network scanner. Flan Scan makes it easy to deploy Nmap locally within a container, push results to the cloud, and deploy the scanner on Kubernetes.

Getting Started
------
1. Clone this repository

2. Make sure you ha setup:

3. Add the list of IP addresses or CIDRS you wish to scan to shared/ips.txt.

4. Build the container:

5. Start scanning!

By default flan creates Latex reports, to get other formats run:

Additional supported formats are *md* (markdown), *html* and *json*.

When the scan finishes you will find the reports summarizing the scan in shared/reports. You can also see the raw XML output from Nmap in shared/xml_files.

<div>
<img style="display: inline-block" src=" width="49%"/>
<img style="display: inline-block" src=" width="49%"/>
</div>

Custom Nmap Configuration
-------------------------
By default Flan Scan runs the following Nmap command:

The -oX flag adds an XML of the scan results to the /shared/xml_files directory and the -oN - flag outputs "normal" Nmap results to the console. The -v1 flag increases the to 1 and the -sV flag runs a service detection scan (aside from Nmap's default port and SYN scans). The --script=/.nse is the script that matches the services detected with relevant CVEs.

Nmap also allows you to run UDP scans and to scan IPv6 addresses. To add these and other flags to Flan Scan's Nmap command after running make build run the container and pass in your Nmap flags like so:

Pushing Results to the Cloud
----------------------------

Flan Scan currently supports pushing Latex reports and raw XML Nmap output files to a GCS Bucket or to an AWS S3 Bucket. Flan Scan requires 2 en to push results to the cloud. The first is upload which takes one of two gcp or aws. The second is bucket and the value is the name of the S3 or GCS Bucket to upload the results to. To set the en , after running make build run the container setting the en like so:

Below are some examples for adding the necessary AWS or GCP authentication keys as en in container. However, this can also be accomplished with a secret in Kubernetes that exposes the necessary en or with other secrets management tools.

Example GCS Bucket Configuration

Copy your GCS private key for a service account to the /shared file

Run the container setting the GOOGLE_APPLICATION_CREDENTIALS en as the path to the GCS Key

Example AWS S3 Bucket Configuration

Set the AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY en to the corresponding for your S3 service account.

Deploying on Kubernetes
-----------------------

When deploying Flan Scan to a container orchestration system, such as Kubernetes, you must ensure that the container has access to a file called ips.txt at the directory /. In Kubernetes, this can be done with a ConfigMap which will mount a file on your local filesystem as a that the container can access once deployed. The kustomization.yaml file has an example of how to create a ConfigMap called shared-files. This ConfigMap is then mounted as a in the deployment.yaml file.

Here are some easy steps to deploy Flan Scan on Kubernetes:
1. To create the ConfigMap add a path to a local ips.txt file in kustomization.yaml and then run kubectl apply -k ..
2. Now run kubectl get configmap to make sure the ConfigMap was created properly.
3. Set the necessary en and secrets for your cloud provider within deployment.yaml.
4. Now run kubectl apply -f deployment.yaml to launch a deployment running Flan Scan.

Flan Scan should be running on Kubernetes successfully!

项目信息

开发语言：Python

Star 数：4162

技术要点

该项目属于安全软件方向的开源资源，代码结构清晰，适合安全研究人员学习参考。项目围绕A pretty sweet vulnerability scanner展开，提供了可运行的实现，对理解相关安全机制、工具原理与攻防技术具有较高的研究价值。

从技术实现角度看，此类项目的核心在于对底层原理的深入理解与工程化落地。开发者在研究过程中可以结合官方文档与社区讨论，梳理项目的初始化流程、核心模块职责与数据流转，逐步掌握其中的技术细节与设计思路。

使用与学习建议

1. 下载源码压缩包，解压到本地环境。

2. 根据项目类型准备对应的运行环境与依赖。

3. 按照 README 中的步骤完成配置与部署。

4. 在隔离的测试环境中运行验证，避免影响生产系统。

免责声明

本资源来源于开源社区，仅供安全研究、技术学习与合法授权范围内的攻防演练使用，请勿用于任何非法或侵害他人权益的用途。使用本项目产生的一切后果由使用者自行承担。