1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
# libhosty
[](http://golang.org)
[](https://goreportcard.com/report/github.com/areYouLazy/libhosty)
[](https://github.com/areYouLazy/libhosty/actions/workflows/build-and-test.yml)
[](https://godoc.org/github.com/areYouLazy/libhosty)
## Description
libhosty is a pure golang library to manipulate the hosts file. It is inspired by [txeh](https://github.com/txn2/txeh), with some enrichments.
## Table of Contents
* [Main Features](#Main-Features)
* [Installation](#Installation)
* [Usage](#Usage)
* [Contributing](#Contributing)
* [Templates](#Templates)
* [Credits](#Credits)
* [License](#License)
## Main Features
* Comment/Uncomment a line without removing it from the file
* Restore the default hosts file for your system
* Add/Remove Address lines
* Add/Remove Comment lines
* Add/Remove Empty lines
* Query by hostname
* Automatically handles duplicate entries
## Installation
Ensure you have go on your system
```bash
> go version
go version go1.15.6 linux/amd64
```
and pull the library
```bash
> go get github.com/areYouLazy/libhosty
```
## Usage
To use the library, just import it and call the `Init()` method.
Note: This code doesn't handle errors for readability purposes, but you SHOULD!
```go
package main
import "github.com/areYouLazy/libhosty"
func main() {
//you can define a custom config object
// and use it to initialize libhosty with a custom hosts file
//
//cnf, _ := libhosty.NewHostsFileConfig("/home/sonica/hosts-export.txt")
//hfl, _ := libhosty.InitWithConfig(cnf)
//or initialize libhosty that will automatically try to loads
// then default hosts file for your OS
hfl, _ := libhosty.Init()
//add an empty line
hfl.AddEmptyFileLine()
//add a host with a comment
hfl.AddHostFileLine("12.12.12.12", "my.host.name", "comment on my hostname!")
//add a comment
hfl.AddCommentFileLine("just a comment")
//add an empty line
hfl.AddEmptyFileLine()
//add another host without comment
hfl.AddHostsFileLine("13.13.13.13", "another.host.name", "")
//add another fqdn to the previous ip
hfl.AddHostsFileLine("12.12.12.12", "second.host.name", "")
// comment for host lines can be done by hostname, row line
// or IP (as net.IP or string)
//
// Comment the line with address 12.12.12.12
//
// By-Row-Number
idx, _ := hfl.GetHostsFileLineByHostname("second.host.name")
hfl.CommentHostsFileLineByRow(idx)
//
// By-Hostname
hfl.CommentHostsFileLineByHostname("second.host.name")
//
// By-Address-As-IP
ip := net.ParseIP("12.12.12.12")
hfl.CommentHostsFileLineByIP(ip)
//
// By-Address-As-String
hfl.CommentHostsFileLineByAddress("12.12.12.12")
// render the hosts file
fmt.Println(hfl.RenderHostsFile())
// write file to disk
hfl.SaveHostsFile()
// or to a custom location
hfl.SaveHostsFileAs("/home/sonica/hosts-export.txt")
// restore the original hosts file for linux
hfl.RestoreDefaultLinuxHostsFile()
// render the hosts file
fmt.Println(hfl.RenderHostsFile())
// write to disk
hfl.SaveHostsFile()
}
```
The 1st `fmt.Println()` should output something like this (in a linux host)
```console
# Do not remove the following line, or various programs
# that require network functionality will fail.
127.0.0.1 localhost.localdomain localhost
::1 localhost6.localdomain6 localhost6
# 12.12.12.12 my.host.name second.host.name #comment on my hostname!
# just a comment line
13.13.13.13 another.host.name
```
While the 2nd `fmt.Println()` should output the default template for linux systems
```console
# Do not remove the following line, or various programs
# that require network functionality will fail.
127.0.0.1 localhost.localdomain localhost
::1 localhost6.localdomain6 localhost6
```
If you handle errors properly, you'll notice that this example program will fail on the `SaveHostsFile()` call if started as a normal user, as editing the hosts file requires root privileges. This does not prevent libhosty from loading, managing, rendering and exporting the hosts file
## Contributing
Issues and PRs are more than welcome!
### Templates
If you find a hosts template (like the Docker one) that you think can be useful to have in this library feel free to open a Pull Request
## Credits
Project Contributors will be listed here
## License
Licenses under Apache License 2.0
|
