Split config and hosts into separate modules

This cleans up the main file to make things easier to work with
testing
Justin Reichardt 2022-08-19 13:36:07 -05:00
parent 75207c51df
commit ba490c27d7
3 changed files with 497 additions and 442 deletions

145
src/cfg/cfg.go Normal file
View File

@ -0,0 +1,145 @@
package cfg
import (
"log"
"os"
"bufio"
)
const CFG = `
# There are 3 types of entries: download, site, and whitelist. Downloads are
# downloaded and stripped of comments and bad entries if possible before being
# added to a list of sites. Whitelisted urls are removed from the list of sites.
# From there all the urls are added to the hosts file for both IPv4 and IPv6.
# You can also add comments by prepending with a '#'.
# This is a static entry
#site=www.site.xyz
# This is a download entry
#download=w3.site.xyz/location/to/config.txt
# This is a whitelist entry
#whitelist=www.site.xyz
# A suggested download is: https://github.com/StevenBlack/hosts
#download=https://raw.githubusercontent.com/StevenBlack/hosts/master/hosts`
type Config struct {
CfgLoc string
Sites []string
Downloads []string
Whitelist []string
}
// Create initialized a config to be used the entire session
func Create(cfgLoc string)(cfg Config){
cfg.CfgLoc = cfgLoc
return
}
// cfgparse recieves the location of the config file and returns a list of sites to add and content to download
func (cfg Config) Update() (error, Config){
l := (cfg.CfgLoc + "rhosts.cfg")
var err error=nil
log.Print("Opening: ", l)
if _,err = os.Stat(cfg.CfgLoc); os.IsNotExist(err) {
log.Print(cfg.CfgLoc + " Does not exist, attempting to create it")
err = os.MkdirAll(cfg.CfgLoc,0755)
if err != nil {
log.Fatal("Could not create " + cfg.CfgLoc)
}
}
if _,err = os.Stat(l); os.IsNotExist(err) {
log.Print(l + " does not exist, attempting to create a placeholder")
err = os.WriteFile(l,[]byte(CFG),0644)
if err != nil {
log.Fatal("Unable to create file: " + l)
}
}
file, err := os.Open(l)
defer file.Close()
if err != nil {
log.Print(err)
return err, cfg
}
filebuf := bufio.NewScanner(file)
filebuf.Split(bufio.ScanLines)
for res := filebuf.Scan();res;res = filebuf.Scan() {
state, body := cfgparseline(filebuf.Text())
switch state {
case 3:
cfg.Sites =append(cfg.Sites,body)
case 4:
cfg.Downloads = append(cfg.Downloads,body)
case 5:
cfg.Whitelist = append(cfg.Whitelist,body)
}
}
err = filebuf.Err()
if err != nil {
log.Print(err)
return err, cfg
}
return err, cfg
}
// cfgparseline reads a single line of the config and returns the type and content of the line
func cfgparseline(buf string) (uint8, string){
// State options
// 0 - Init
// 1 - Error
// 2 - Comment
// 3 - Site
// 4 - Download
// 5 - Whitelist
var state uint8= 0
body :=buf[:]
for i:=0; i<len(buf);i++ {
//fmt.Printf("%c",buf[i])
switch buf[i] {
case ' ':
case '#':
state = 2
case 'd':
if (len(buf) < i+10) {
state = 1
break
}
if (buf[i:(i+9)] == "download=") {
i +=9
state = 4
body = buf[i:]
} else{
state = 1
}
case 's':
if (len(buf) < i+6) {
state = 1
break
}
if (buf[i:(i+5)] == "site=") {
i +=5
state = 3
body = buf[i:]
} else{
state = 0
}
//compare buf[i:(i+3)] to "site"
case 'w':
if (len(buf) < i+10) {
state = 1
break
}
if (buf[i:(i+10)] == "whitelist=") {
i +=10
state = 5
body = buf[i:]
} else{
state = 1
}
}
if (state !=0){
return state,body
}
}
return state, body
}

340
src/hosts/hosts.go Normal file
View File

@ -0,0 +1,340 @@
package hosts
import (
"os"
"io"
"net/http"
"log"
"bufio"
"jbreich/rhosts/cfg"
)
// siteList holds the location of all the sites along with a list of their location
type siteList struct {
location string
siteEntry []siteEntry
}
// siteEntry holds a single entry and if it is a repeat
type siteEntry struct {
repeat bool
site string
}
func Update(config cfg.Config, tmpdir, hostsloc string, daemon bool, interval int)(err error){
var siteBuff []siteList
err = error(nil)
err = copystatichosts(tmpdir, hostsloc)
if (err != nil){
log.Print("Failed to copy static entries")
return nil
}
defer os.Remove(tmpdir + "rhosts")
err, siteBuff = downloadcontent(config.Downloads, tmpdir, hostsloc)
if (err != nil){
log.Print("Failed to download entries")
return nil
}
err = writesites(config.Sites, tmpdir, &siteBuff)
if (err != nil){
log.Print("Failed to failed to copy rhosts static entries")
return nil
}
removeduplicates(&siteBuff, &config.Whitelist)
err = write2tmp(tmpdir, &siteBuff)
if (err != nil){
log.Print("Failed to write sites to tmpfile")
return nil
}
err = writetmp2hosts(hostsloc, tmpdir)
if (err != nil){
log.Print("Failed to copy to hosts file")
return nil
}
return
}
// copystatichosts copies the hosts not managed by rhosts from the hosts file to the start of the temporary file
func copystatichosts(tmpdir, hostsloc string) error {
fileloc := tmpdir + "rhosts"
file, err := os.Create(fileloc)
defer file.Close()
if err != nil {
log.Print(err)
return err
}
filer, err := os.Open(hostsloc)
defer filer.Close()
if err != nil {
log.Print(err)
return err
}
filebuf := bufio.NewScanner(filer)
filebuf.Split(bufio.ScanLines)
for res := filebuf.Scan();res;res = filebuf.Scan() {
buff := filebuf.Text()
if (buff == "# rhosts begin"){
break
}
_,err := file.WriteString(buff + "\n")
if (err != nil) {
log.Print(err)
return err
}
}
_,err = file.WriteString("# rhosts begin\n")
err = filebuf.Err()
return err
}
// downloadcontent attempts to download the provided url and create a siteList. If the file fails to download it attempts to find an old copy from the hosts file.
func downloadcontent(downloads []string, tmpdir string, hostsloc string) (err error, list []siteList){
for _, d := range downloads {
var site siteList
site.location = d
log.Print("Downloading: ",d)
response, err := http.Get(d)
if (err !=nil) {
log.Print(err)
log.Print("Looking for old record in hosts file")
downloadoldlookup(hostsloc, d, &site)
}else{
defer response.Body.Close()
scanner := bufio.NewScanner(response.Body)
for scanner.Scan() {
resp := checkDownloadLine(scanner.Text())
if resp.site != "" {
site.siteEntry = append(site.siteEntry, resp)
}
}
}
list = append(list, site)
}
return err, list
}
// checkDownloadLine parses the download line into just the address that needs to be blocked
func checkDownloadLine (line string) (address siteEntry){
var token []string
address.repeat = false
address.site = ""
buff := ""
lineLength := len(line) -1
for i, c := range(line){
if c != ' ' && i < lineLength {
buff += string(c)
}else if len(buff) > 0 {
if i == lineLength{
buff += string(c)
}
token = append(token,buff)
buff = ""
}
}
if len(token) == 0 {
return
}
if token[0][0] == '#' {
return
}
for _, t := range(token) {
var period uint
var failed bool
period = 0
failed = false
for _, c := range(t) {
switch c{
case '.':
period ++
case '#':
return
case ':':
failed = true
break
}
}
if period <=2 && failed == false {
address.site = t
return
}
}
return
}
// downloadoldlookup attemps to find an entry in the hosts file and add it to the siteList
func downloadoldlookup(hostsloc, d string, site *siteList) error {
var err error = nil
var state uint8 = 0
hostsf, err := os.Open(hostsloc)
if (err != nil){
log.Print(err)
return err
}
defer hostsf.Close()
fbuff := bufio.NewScanner(hostsf)
fbuff.Split(bufio.ScanLines)
for res := fbuff.Scan();res;res = fbuff.Scan() {
buff := fbuff.Text()
switch state {
case 0:
if (buff == "# rhosts download - " + d){
log.Print("Found old record in hosts file:" + buff)
state =1
}
case 1:
if (len(buff) >=9 && buff[0:8] == "# rhosts"){
state = 2
}else{
siteBuff := checkDownloadLine(buff)
if siteBuff.site != "" {
site.siteEntry = append(site.siteEntry, siteBuff)
}
}
case 3:
return nil
}
}
return err
}
// writesites writes the list of sites from the config file to the local siteList
func writesites(sites []string, tmpdir string, siteBuff *[]siteList) (err error) {
var localList siteList
localList.location = "local"
err = nil
fileloc := tmpdir + "rhosts"
log.Print("Opening: " + fileloc)
if len(sites) == 0 {
return
}
for _,s := range sites {
var site siteEntry
site.repeat = false
site.site = s
localList.siteEntry = append(localList.siteEntry,site)
}
*siteBuff = append(*siteBuff,localList)
return
}
// removeduplicates removes any duplicate or uneeded/unwanted addresses
func removeduplicates(siteBuff *[]siteList, whitelist *[]string){
var safewords = []string{"localhost", "localhost.localdomain", "broadcasthost", "ip6-loopback", "ip6-localhost", "ip6-localnet", "ip6-mcastprefix", "ip6-allnodes", "ip6-allrouters", "ip6-allhosts", "local"}
var c struct {
d uint
s uint
w uint
}
c.d = 0
c.s = 0
c.w = 0
log.Print("Checking for duplicates")
var entry []struct{
r *bool
s *string
}
var entryBuff struct{
r *bool
s *string
}
for i := len((*siteBuff))-1; i > -1; i --{
for j := len((*siteBuff)[i].siteEntry)-1; j > -1; j -- {
entryBuff.r = &((*siteBuff)[i].siteEntry[j].repeat)
entryBuff.s = &((*siteBuff)[i].siteEntry[j].site)
entry = append(entry,entryBuff)
}
}
lenEntry := len(entry)
for i,e := range(entry) {
for _,w := range(safewords){
if *e.s == w {
*(entry[i].r) = true
c.s ++
break
}
}
if *(entry[i].r) == true {
continue
}
for _,w := range(*whitelist){
if *e.s == w {
*(entry[i].r) = true
c.w ++
break
}
}
if *(entry[i].r) == true {
continue
}
if i == lenEntry {
break
}
for j,n := range(entry[i+1:]){
if *e.s == *n.s {
*(entry[i+j].r) = true
c.d ++
}
}
}
log.Printf("Total: %d\tDuplicates: %d\tSafeWords: %d\tWhitelisted: %d\n", lenEntry, c.d, c.s, c.w)
}
// write2tmp write the siteBuff to the tempfile
func write2tmp(tmpdir string, siteBuff *[]siteList) (err error) {
err = nil
tmploc := tmpdir+ "rhosts"
tmpf, err := os.OpenFile(tmploc, os.O_APPEND|os.O_WRONLY|os.O_CREATE, 0600)
defer tmpf.Close()
if err != nil {
log.Print(err)
return err
}
for _,location := range(*siteBuff){
if len(location.siteEntry) == 0 {
continue
}
_,err := tmpf.WriteString("# rhosts download - " + location.location + "\n")
if err != nil {
return err
}
for _,site := range(location.siteEntry){
if site.repeat == false {
_, err = tmpf.WriteString("0.0.0.0 " + site.site + "\n")
if err != nil {
return err
}
_, err = tmpf.WriteString(":: " + site.site + "\n")
if err != nil {
return err
}
}
}
}
return
}
// writetmp2hosts overwrites the hostsfile with the tmp file
func writetmp2hosts(hostsloc, tmpdir string) error {
var err error = nil
tmploc := tmpdir + "rhosts"
hosts, err := os.Create(hostsloc)
if (err != nil){
log.Print(err)
return err
}
tmp, err := os.Open(tmploc)
if (err != nil){
log.Print(err)
return err
}
_,err = io.Copy(hosts,tmp)
if (err != nil){
log.Print(err)
}
return err
}

View File

@ -22,30 +22,18 @@
package main
import (
"os"
"io"
"bufio"
"log"
"net/http"
"flag"
"time"
"fmt"
"time"
sysos "jbreich/rhosts/sys"
"jbreich/rhosts/serve"
"jbreich/rhosts/cfg"
"jbreich/rhosts/hosts"
)
var Exit chan bool
// siteList holds the location of all the sites along with a list of their location
type siteList struct {
location string
siteEntry []siteEntry
}
// siteEntry holds a single entry and if it is a repeat
type siteEntry struct {
repeat bool
site string
}
const GPL =`
rhosts maintains a blocklist and appends it to the system hosts file
@ -75,7 +63,6 @@ func main() {
var interval int=1440
var versionflag bool=false
var removetimestamp bool=false
var siteBuff []siteList
// Parsing Flags
flag.BoolVar(&daemon, "d", false, "Should this be run in daemon mode")
@ -105,42 +92,16 @@ func main() {
sysos.Detect (&tmpdir, &hostsloc, &cfgloc)
for true {
var sites, downloads, whitelist []string
err := error(nil)
err = cfgparse(&sites, &downloads, &whitelist, cfgloc)
if (err != nil){
log.Print("Failed to parse config file")
continue
}
err = copystatichosts(tmpdir, hostsloc)
if (err != nil){
log.Print("Failed to copy static entries")
continue
}
defer os.Remove(tmpdir + "rhosts")
err, siteBuff = downloadcontent(downloads, tmpdir, hostsloc)
if (err != nil){
log.Print("Failed to download entries")
continue
}
err = writesites(sites, tmpdir, &siteBuff)
if (err != nil){
log.Print("Failed to failed to copy rhosts static entries")
continue
}
removeduplicates(&siteBuff, &whitelist)
err = write2tmp(tmpdir, &siteBuff)
if (err != nil){
log.Print("Failed to write sites to tmpfile")
continue
}
err = writetmp2hosts(hostsloc, tmpdir)
if (err != nil){
log.Print("Failed to copy to hosts file")
continue
}
config := cfg.Create(cfgloc)
err,config := config.Update()
log.Print(config)
if (err != nil){log.Panic("Failed to parse config: " + cfgloc)}
for true {
err := hosts.Update(config, tmpdir, hostsloc,daemon, interval)
if (err != nil){
log.Print(err)
}
log.Print("Finished updating host")
if (daemon == true){
i := time.Now().Add(time.Duration(interval) * time.Minute).Format(time.Layout)
@ -156,394 +117,3 @@ func main() {
}
// cfgparse recieves the location of the config file and returns a list of sites to add and content to download
func cfgparse (sites, downloads, whitelist *[]string, cfgloc string) (error){
l := (cfgloc + "rhosts.cfg")
var err error=nil
log.Print("Opening: ", l)
if _,err = os.Stat(cfgloc); os.IsNotExist(err) {
log.Print(cfgloc + " Does not exist, attempting to create it")
err = os.MkdirAll(cfgloc,0755)
if err != nil {
log.Fatal("Could not create " + cfgloc)
}
}
if _,err = os.Stat(l); os.IsNotExist(err) {
log.Print(l + " does not exist, attempting to create a placeholder")
err = os.WriteFile(l,[]byte(CFG),0644)
if err != nil {
log.Fatal("Unable to create file: " + l)
}
}
file, err := os.Open(l)
defer file.Close()
if err != nil {
log.Print(err)
return err
}
filebuf := bufio.NewScanner(file)
filebuf.Split(bufio.ScanLines)
for res := filebuf.Scan();res;res = filebuf.Scan() {
state, body := cfgparseline(filebuf.Text())
switch state {
case 3:
*sites =append(*sites,body)
case 4:
*downloads = append(*downloads,body)
case 5:
*whitelist = append(*whitelist,body)
}
}
err = filebuf.Err()
if err != nil {
log.Print(err)
return err
}
return err
}
// cfgparseline reads a single line of the config and returns the type and content of the line
func cfgparseline(buf string) (uint8, string){
// State options
// 0 - Init
// 1 - Error
// 2 - Comment
// 3 - Site
// 4 - Download
// 5 - Whitelist
var state uint8= 0
body :=buf[:]
for i:=0; i<len(buf);i++ {
//fmt.Printf("%c",buf[i])
switch buf[i] {
case ' ':
case '#':
state = 2
case 'd':
if (len(buf) < i+10) {
state = 1
break
}
if (buf[i:(i+9)] == "download=") {
i +=9
state = 4
body = buf[i:]
} else{
state = 1
}
case 's':
if (len(buf) < i+6) {
state = 1
break
}
if (buf[i:(i+5)] == "site=") {
i +=5
state = 3
body = buf[i:]
} else{
state = 0
}
//compare buf[i:(i+3)] to "site"
case 'w':
if (len(buf) < i+10) {
state = 1
break
}
if (buf[i:(i+10)] == "whitelist=") {
i +=10
state = 5
body = buf[i:]
} else{
state = 1
}
}
if (state !=0){
return state,body
}
}
return state, body
}
// copystatichosts copies the hosts not managed by rhosts from the hosts file to the start of the temporary file
func copystatichosts(tmpdir, hostsloc string) error {
fileloc := tmpdir + "rhosts"
file, err := os.Create(fileloc)
defer file.Close()
if err != nil {
log.Print(err)
return err
}
filer, err := os.Open(hostsloc)
defer filer.Close()
if err != nil {
log.Print(err)
return err
}
filebuf := bufio.NewScanner(filer)
filebuf.Split(bufio.ScanLines)
for res := filebuf.Scan();res;res = filebuf.Scan() {
buff := filebuf.Text()
if (buff == "# rhosts begin"){
break
}
_,err := file.WriteString(buff + "\n")
if (err != nil) {
log.Print(err)
return err
}
}
_,err = file.WriteString("# rhosts begin\n")
err = filebuf.Err()
return err
}
// downloadcontent attempts to download the provided url and create a siteList. If the file fails to download it attempts to find an old copy from the hosts file.
func downloadcontent(downloads []string, tmpdir string, hostsloc string) (err error, list []siteList){
for _, d := range downloads {
var site siteList
site.location = d
log.Print("Downloading: ",d)
response, err := http.Get(d)
if (err !=nil) {
log.Print(err)
log.Print("Looking for old record in hosts file")
downloadoldlookup(hostsloc, d, &site)
}else{
defer response.Body.Close()
scanner := bufio.NewScanner(response.Body)
for scanner.Scan() {
resp := checkDownloadLine(scanner.Text())
if resp.site != "" {
site.siteEntry = append(site.siteEntry, resp)
}
}
}
list = append(list, site)
}
return err, list
}
// checkDownloadLine parses the download line into just the address that needs to be blocked
func checkDownloadLine (line string) (address siteEntry){
var token []string
address.repeat = false
address.site = ""
buff := ""
lineLength := len(line) -1
for i, c := range(line){
if c != ' ' && i < lineLength {
buff += string(c)
}else if len(buff) > 0 {
if i == lineLength{
buff += string(c)
}
token = append(token,buff)
buff = ""
}
}
if len(token) == 0 {
return
}
if token[0][0] == '#' {
return
}
for _, t := range(token) {
var period uint
var failed bool
period = 0
failed = false
for _, c := range(t) {
switch c{
case '.':
period ++
case '#':
return
case ':':
failed = true
break
}
}
if period <=2 && failed == false {
address.site = t
return
}
}
return
}
// downloadoldlookup attemps to find an entry in the hosts file and add it to the siteList
func downloadoldlookup(hostsloc, d string, site *siteList) error {
var err error = nil
var state uint8 = 0
hostsf, err := os.Open(hostsloc)
if (err != nil){
log.Print(err)
return err
}
defer hostsf.Close()
fbuff := bufio.NewScanner(hostsf)
fbuff.Split(bufio.ScanLines)
for res := fbuff.Scan();res;res = fbuff.Scan() {
buff := fbuff.Text()
switch state {
case 0:
if (buff == "# rhosts download - " + d){
log.Print("Found old record in hosts file:" + buff)
state =1
}
case 1:
if (len(buff) >=9 && buff[0:8] == "# rhosts"){
state = 2
}else{
siteBuff := checkDownloadLine(buff)
if siteBuff.site != "" {
site.siteEntry = append(site.siteEntry, siteBuff)
}
}
case 3:
return nil
}
}
return err
}
// writesites writes the list of sites from the config file to the local siteList
func writesites(sites []string, tmpdir string, siteBuff *[]siteList) (err error) {
var localList siteList
localList.location = "local"
err = nil
fileloc := tmpdir + "rhosts"
log.Print("Opening: " + fileloc)
if len(sites) == 0 {
return
}
for _,s := range sites {
var site siteEntry
site.repeat = false
site.site = s
localList.siteEntry = append(localList.siteEntry,site)
}
*siteBuff = append(*siteBuff,localList)
return
}
// removeduplicates removes any duplicate or uneeded/unwanted addresses
func removeduplicates(siteBuff *[]siteList, whitelist *[]string){
var safewords = []string{"localhost", "localhost.localdomain", "broadcasthost", "ip6-loopback", "ip6-localhost", "ip6-localnet", "ip6-mcastprefix", "ip6-allnodes", "ip6-allrouters", "ip6-allhosts", "local"}
var c struct {
d uint
s uint
w uint
}
c.d = 0
c.s = 0
c.w = 0
log.Print("Checking for duplicates")
var entry []struct{
r *bool
s *string
}
var entryBuff struct{
r *bool
s *string
}
for i := len((*siteBuff))-1; i > -1; i --{
for j := len((*siteBuff)[i].siteEntry)-1; j > -1; j -- {
entryBuff.r = &((*siteBuff)[i].siteEntry[j].repeat)
entryBuff.s = &((*siteBuff)[i].siteEntry[j].site)
entry = append(entry,entryBuff)
}
}
lenEntry := len(entry)
for i,e := range(entry) {
for _,w := range(safewords){
if *e.s == w {
*(entry[i].r) = true
c.s ++
break
}
}
if *(entry[i].r) == true {
continue
}
for _,w := range(*whitelist){
if *e.s == w {
*(entry[i].r) = true
c.w ++
break
}
}
if *(entry[i].r) == true {
continue
}
if i == lenEntry {
break
}
for j,n := range(entry[i+1:]){
if *e.s == *n.s {
*(entry[i+j].r) = true
c.d ++
}
}
}
log.Printf("Total: %d\tDuplicates: %d\tSafeWords: %d\tWhitelisted: %d\n", lenEntry, c.d, c.s, c.w)
}
// write2tmp write the siteBuff to the tempfile
func write2tmp(tmpdir string, siteBuff *[]siteList) (err error) {
err = nil
tmploc := tmpdir+ "rhosts"
tmpf, err := os.OpenFile(tmploc, os.O_APPEND|os.O_WRONLY|os.O_CREATE, 0600)
defer tmpf.Close()
if err != nil {
log.Print(err)
return err
}
for _,location := range(*siteBuff){
if len(location.siteEntry) == 0 {
continue
}
_,err := tmpf.WriteString("# rhosts download - " + location.location + "\n")
if err != nil {
return err
}
for _,site := range(location.siteEntry){
if site.repeat == false {
_, err = tmpf.WriteString("0.0.0.0 " + site.site + "\n")
if err != nil {
return err
}
_, err = tmpf.WriteString(":: " + site.site + "\n")
if err != nil {
return err
}
}
}
}
return
}
// writetmp2hosts overwrites the hostsfile with the tmp file
func writetmp2hosts(hostsloc, tmpdir string) error {
var err error = nil
tmploc := tmpdir + "rhosts"
hosts, err := os.Create(hostsloc)
if (err != nil){
log.Print(err)
return err
}
tmp, err := os.Open(tmploc)
if (err != nil){
log.Print(err)
return err
}
_,err = io.Copy(hosts,tmp)
if (err != nil){
log.Print(err)
}
return err
}