/go-cidr

Network CIDR checker, it will check from a network CIDR if contains an IP which you send.

Primary LanguageGoOtherNOASSERTION

Go-CIDR

Go Reference Go Report Card


Description

The purpose of that library is checked an IP inside from a CIDR.


Project structure

The project structure explained what contains what.

├── cmd
│   ├── bootstrap
│   │   └── bootstrap.go // point where init the service
│   └── main.go // entrypoint of the service
├── pkg
│   ├── config
│   │   └── config.go // config structs, methods and functions
│   ├── ip
│   │   ├── ip.go // logic to create the hosts from cirds
│   │   └── ip_test.go // test file for ip pkg
│   └── store
│       └── memory
│           └── memory.go // storage in memory
└── README.md // Readme

Example

Using storage in memory:

package main

import (
	"time"
	"log"

	b "github.com/jrmanes/go-cidr/cmd/bootstrap"
	m "github.com/jrmanes/go-cidr/pkg/store/memory"
)

func main() {
	// load configuration
	cidr := []string{"10.251.0.0/16", "172.18.0.0/16", "192.168.0.0/16"}

	// Run the process in order to load the hosts inside the cidr
	b.Run(cidr)

	now := time.Now()
	log.Println("---------FROM MEMORY------------")
	ip2CheckInMemory := "12.251.0.162"
	existsInMemory := m.CheckIfIpExistsInMemory(ip2CheckInMemory)
	if existsInMemory {
		log.Println("IP found ip2CheckInMemory (", ip2CheckInMemory, ")", existsInMemory)
	} else {
		log.Println("IP NOT found ip2CheckInMemory (", ip2CheckInMemory, ")", existsInMemory)
	}
	log.Println("elapse using storage memory:", time.Since(now))
	log.Println("-----------------------------")
}

TODO

  • Change project structure
    • Release 2.0.0
  • Add more test

Jose Ramón Mañes