-
Notifications
You must be signed in to change notification settings - Fork 93
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 2f5ef90
Showing
13 changed files
with
800 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
name: Build | ||
on: | ||
push: | ||
branches: | ||
- master | ||
pull_request: | ||
|
||
jobs: | ||
build: | ||
name: Build | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Set up Go | ||
uses: actions/setup-go@v2 | ||
with: | ||
go-version: 1.14 | ||
|
||
- name: Check out code | ||
uses: actions/checkout@v2 | ||
|
||
- name: Test | ||
run: go test . | ||
working-directory: cmd/mapcidr/ | ||
|
||
- name: Build | ||
run: go build . | ||
working-directory: cmd/mapcidr/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# dockerhub-push pushes docker build to dockerhub automatically | ||
# on the creation of a new release | ||
name: Publish to Dockerhub on creation of a new release | ||
on: | ||
release: | ||
types: [published] | ||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@master | ||
- name: Publish to Dockerhub Registry | ||
uses: elgohr/Publish-Docker-Github-Action@master | ||
with: | ||
name: projectdiscovery/mapcidr | ||
username: ${{ secrets.DOCKER_USERNAME }} | ||
password: ${{ secrets.DOCKER_PASSWORD }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
name: Release | ||
on: | ||
create: | ||
tags: | ||
- v* | ||
|
||
jobs: | ||
release: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- | ||
name: "Check out code" | ||
uses: actions/checkout@v2 | ||
with: | ||
fetch-depth: 0 | ||
- | ||
name: "Set up Go" | ||
uses: actions/setup-go@v2 | ||
with: | ||
go-version: 1.14 | ||
- | ||
env: | ||
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}" | ||
name: "Create release on GitHub" | ||
uses: goreleaser/goreleaser-action@v2 | ||
with: | ||
args: "release --rm-dist" | ||
version: latest |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
builds: | ||
- binary: mapcidr | ||
main: cmd/mapcidr/main.go | ||
goos: | ||
- linux | ||
- windows | ||
- darwin | ||
goarch: | ||
- amd64 | ||
- 386 | ||
- arm | ||
- arm64 | ||
|
||
archives: | ||
- id: tgz | ||
format: tar.gz | ||
replacements: | ||
darwin: macOS | ||
format_overrides: | ||
- goos: windows | ||
format: zip |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
FROM golang:1.14-alpine AS build-env | ||
|
||
RUN apk add --no-cache --upgrade git openssh-client ca-certificates | ||
RUN go get -u github.com/golang/dep/cmd/dep | ||
WORKDIR /go/src/app | ||
|
||
# Install | ||
RUN go get -u github.com/projectdiscovery/mapcidr/cmd/mapcidr | ||
|
||
ENTRYPOINT ["mapcidr"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
MIT License | ||
|
||
Copyright (c) Exposed Atoms Pvt Ltd | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,171 @@ | ||
<h1 align="left"> | ||
<img src="static/mapCIDR-logo.png" alt="mapCIDR" width="180px"></a> | ||
<br> | ||
</h1> | ||
|
||
[![License](https://img.shields.io/badge/license-MIT-_red.svg)](https://opensource.org/licenses/MIT) | ||
[![Go Report Card](https://goreportcard.com/badge/github.com/projectdiscovery/mapcidr)](https://goreportcard.com/report/github.com/projectdiscovery/mapcidr) | ||
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/projectdiscovery/mapcidr/issues) | ||
[![Follow on Twitter](https://img.shields.io/twitter/follow/pdiscoveryio.svg?logo=twitter)](https://twitter.com/pdiscoveryio) | ||
[![Chat on Discord](https://img.shields.io/discord/695645237418131507.svg?logo=discord)](https://discord.gg/KECAGdH) | ||
|
||
Small utility program to perform multiple operations for a given subnet/CIDR ranges. | ||
|
||
The tool was developed to ease load distribution for mass scanning operations, it can be used both as a library and as independent CLI tool. | ||
|
||
|
||
|
||
# Features | ||
|
||
<h1 align="left"> | ||
<img src="static/mapCIDR-run.png" alt="mapCIDR" width="700px"></a> | ||
<br> | ||
</h1> | ||
|
||
|
||
- Simple and modular code base making it easy to contribute. | ||
- **CIDR distribution** for distributed scanning. | ||
- **Stdin** and **stdout** support for integrating in workflows | ||
|
||
# Installation:- | ||
|
||
### From Source | ||
|
||
```sh | ||
▶ GO111MODULE=auto go get -u github.com/projectdiscovery/mapcidr/cmd/mapcidr | ||
``` | ||
|
||
### From Github | ||
|
||
```sh | ||
▶ git clone https://github.com/projectdiscovery/mapcidr.git; cd mapcidr/cmd/mapcidr; go build .; cp mapcidr /usr/local/bin | ||
``` | ||
|
||
# Usage:- | ||
|
||
```sh | ||
▶ mapcidr -h | ||
``` | ||
|
||
This will display help for the tool. Here are all the switches it supports. | ||
|
||
| Flag | Description | Example | | ||
|-----------|------------------------------------------ |--------------------------- | | ||
| -cidr | Single CIDR to process | mapcidr -cidr 173.0.84.0/24 | | ||
| -sbc | Slice by CIDR count | mapcidr -sbc 10 | | ||
| -sbh | Slice by HOST count | mapcidr -sbh 10000 | | ||
| -l | File containing list of CIDRs | mapcidr -l cidr.txt | | ||
| -o | File to write output to (optional) | mapcidr -o output.txt | | ||
| -silent | Make the output silent | mapcidr -silent | | ||
| -version | Print current version of chaos client | mapcidr -version | | ||
|
||
# Running mapCIDR | ||
|
||
In order to get list of IPs for a give CIDR, use the following command. | ||
|
||
```sh | ||
▶ mapcidr -cidr 173.0.84.0/24 | ||
▶ echo 173.0.84.0/24 | mapcidr | ||
|
||
``` | ||
|
||
```sh | ||
____________ ___ | ||
__ _ ___ ____ / ___/ _/ _ \/ _ \ | ||
/ ' \/ _ '/ _ \/ /___/ // // / , _/ | ||
/_/_/_/\_,_/ .__/\___/___/____/_/|_| v0.1 | ||
/_/ | ||
|
||
projectdiscovery.io | ||
|
||
[WRN] Use with caution. You are responsible for your actions | ||
[WRN] Developers assume no liability and are not responsible for any misuse or damage. | ||
|
||
173.0.84.0 | ||
173.0.84.1 | ||
173.0.84.2 | ||
173.0.84.3 | ||
173.0.84.4 | ||
173.0.84.5 | ||
173.0.84.13 | ||
173.0.84.14 | ||
173.0.84.15 | ||
173.0.84.16 | ||
``` | ||
|
||
## Slice by CIDR | ||
|
||
In order to slice given CIDR or list of CIDR by CIDR count or slice into multiple and equal smaller subnets, use the following command. | ||
|
||
|
||
```sh | ||
▶ mapcidr -cidr 173.0.84.0/24 -sbc 10 -silent | ||
▶ echo 173.0.84.0/24 | mapcidr -sbc 10 -silent | ||
``` | ||
|
||
``` | ||
173.0.84.0/27 | ||
173.0.84.32/27 | ||
173.0.84.64/27 | ||
173.0.84.96/27 | ||
173.0.84.128/27 | ||
173.0.84.160/27 | ||
173.0.84.208/28 | ||
173.0.84.192/28 | ||
173.0.84.240/28 | ||
173.0.84.224/28 | ||
``` | ||
|
||
## Slice by HOST | ||
|
||
In order to slice given CIDR for equal number of host count in each CIDR, use the following command. | ||
|
||
```sh | ||
▶ mapcidr -cidr 173.0.84.0/16 -sbh 20000 -silent | ||
▶ echo 173.0.84.0/16 | mapcidr -sbh 20000 -silent | ||
``` | ||
|
||
``` | ||
173.0.0.0/18 | ||
173.0.64.0/18 | ||
173.0.128.0/18 | ||
173.0.192.0/18 | ||
``` | ||
|
||
Note: it's possible to obtain a perfect split only when the desired amount of slices or hosts per subnet is a powers of two. Otherwise the tool will attempt to automatically find the best split strategy to obtain the desired outcome. | ||
|
||
# Use mapCIDR as a library | ||
|
||
It's possible to use the library directly in your go programs. The following code snippets outline how to divide a cidr into subnets, and how to divide the same into subnets containing a certain number of hosts | ||
|
||
```go | ||
package main | ||
|
||
import ( | ||
"fmt" | ||
"github.com/projectdiscovery/mapcidr" | ||
) | ||
|
||
funf main() { | ||
// Divide the CIDR into two subnets | ||
subnets1 := mapcidr.SplitN("192.168.1.0/24", 2) | ||
for _, subnet := range subnets1 { | ||
fmt.Println(subnet) | ||
} | ||
// Divide the CIDR into two subnets containing 128 hosts each | ||
subnets2 := mapcidr.SplitByNumber("192.168.1.0/24", 128) | ||
for _, subnet := range subnets2 { | ||
fmt.Println(subnet) | ||
} | ||
|
||
|
||
// List all ips in the CIDR | ||
ips, _ := mapcidr.Ips("192.168.1.0/24") | ||
for _, ip := range ips { | ||
fmt.Println(ip) | ||
} | ||
} | ||
``` | ||
|
||
|
||
mapCDIR is made with 🖤 by the [projectdiscovery](https://projectdiscovery.io) team. |
Oops, something went wrong.