Skip to content

Commit 77d8074

Browse files
gorkavpgorkavp
authored
Add Excel format support (#156)
* Excel format support added * fix issuses * Update README.md * Update README.md * Update README.md * Update README.md
1 parent 1c26b70 commit 77d8074

9 files changed

+176
-11
lines changed

‎README.md

+11-7
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,20 @@ HTML:
1313
Graphviz:
1414
![nmap-example-graphviz](docs/images/example-dot.png)
1515

16-
A tool that allows you to convert NMAP XML output to html/csv/json/markdown/dot/sqlite.
16+
A tool that allows you to convert NMAP XML output to excel/html/csv/json/markdown/dot/sqlite.
1717

1818
## Installation
1919

20-
It's possible to install it using `go install` command
21-
2220
```
23-
go install github.com/vdjagilev/nmap-formatter/v2@latest
21+
git clone https://github.com/gorkavp/nmap-formatter.git
22+
cd nmap-formatter
23+
go build
2424
```
2525

26-
All other options can be found on [Installation Wiki page](https://github.com/vdjagilev/nmap-formatter/wiki/Installation).
27-
2826
## Usage
2927

3028
```bash
31-
nmap-formatter [html|csv|md|json|dot|sqlite] [path-to-nmap.xml] [flags]
29+
nmap-formatter [html|csv|md|json|dot|sqlite|excel] [path-to-nmap.xml] [flags]
3230
```
3331

3432
Or alternatively you can read file from `stdin` and parse it
@@ -49,6 +47,12 @@ or Markdown
4947
nmap-formatter md [path-to-nmap.xml] > some-markdown.md
5048
```
5149

50+
or Excel
51+
52+
```bash
53+
nmap-formatter excel [path-to-nmap.xml]
54+
```
55+
5256
or JSON
5357

5458
```bash

‎cmd/root.go

+3-2
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ var config = formatter.Config{
3939
JSONOptions: formatter.JSONOutputOptions{},
4040
CSVOptions: formatter.CSVOutputOptions{},
4141
SqliteOutputOptions: formatter.SqliteOutputOptions{},
42+
ExcelOptions: formatter.ExcelOutputOptions{},
4243
},
4344
ShowVersion: false,
4445
CurrentVersion: VERSION,
@@ -51,9 +52,9 @@ var workflow formatter.Workflow
5152

5253
// rootCmd represents the base command when called without any subcommands
5354
var rootCmd = &cobra.Command{
54-
Use: "nmap-formatter [html|csv|md|json|dot|sqlite] [path-to-nmap.xml]",
55+
Use: "nmap-formatter [html|csv|md|json|dot|sqlite|excel] [path-to-nmap.xml]",
5556
Short: "Utility that can help you to convert NMAP XML application output to various other formats",
56-
Long: `This utility allows you to convert NMAP XML output to various other formats like (html, csv, markdown (md), json, dot)`,
57+
Long: `This utility allows you to convert NMAP XML output to various other formats like (html, csv, markdown (md), json, dot, excel, sqlite)`,
5758
Args: arguments,
5859
RunE: run,
5960
}

‎cmd/validation.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import (
1010
// validate is checking input from the command line
1111
func validate(config formatter.Config) error {
1212
if !config.OutputFormat.IsValid() {
13-
return fmt.Errorf("not valid format: %s, please choose html/json/md/csv/sqlite", config.OutputFormat)
13+
return fmt.Errorf("not valid format: %s, please choose html/json/md/csv/excel/sqlite", config.OutputFormat)
1414
}
1515

1616
err := validateIOFiles(config)

‎formatter/format.go

+3-1
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,15 @@ const (
1616
DotOutput OutputFormat = "dot"
1717
// SqliteOutput constant defines OutputFormat for sqlite file, which can be used to generate sqlite embedded databases
1818
SqliteOutput OutputFormat = "sqlite"
19+
// ExcelOutput constant defines OutputFormat for Excel file, which can be used to generate Excel files
20+
ExcelOutput OutputFormat = "excel"
1921
)
2022

2123
// IsValid checks whether requested output format is valid
2224
func (of OutputFormat) IsValid() bool {
2325
// markdown & md is essentially the same thing
2426
switch of {
25-
case "markdown", "md", "html", "csv", "json", "dot", "sqlite":
27+
case "markdown", "md", "html", "csv", "json", "dot", "sqlite", "excel":
2628
return true
2729
}
2830
return false

‎formatter/formatter.go

+4
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@ func New(config *Config) Formatter {
2525
return &CSVFormatter{
2626
config,
2727
}
28+
case ExcelOutput:
29+
return &ExcelFormatter{
30+
config,
31+
}
2832
case DotOutput:
2933
return &DotFormatter{
3034
config,

‎formatter/formatter_excel.go

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
package formatter
2+
3+
import (
4+
"fmt"
5+
6+
"github.com/xuri/excelize/v2"
7+
)
8+
9+
// ExcelFormatter is struct defined for Excel Output use-case
10+
type ExcelFormatter struct {
11+
config *Config
12+
}
13+
14+
// Format the data to Excel and output it to an Excel file
15+
func (f *ExcelFormatter) Format(td *TemplateData, templateContent string) (err error) {
16+
file := excelize.NewFile()
17+
sheetName := "Sheet1"
18+
19+
// Create a style for center alignment
20+
style, err := file.NewStyle(&excelize.Style{
21+
Alignment: &excelize.Alignment{Horizontal: "center", Vertical: "center"},
22+
})
23+
24+
// Set the column headers
25+
file.SetCellValue(sheetName, "A1", "IP/Host")
26+
file.SetCellValue(sheetName, "B1", "Servicios")
27+
file.SetCellStyle(sheetName, "A1", "A1", style)
28+
file.SetCellStyle(sheetName, "B1", "B1", style)
29+
30+
row := 2 // Start from row 2 for data
31+
32+
for i := range td.NMAPRun.Host {
33+
var host *Host = &td.NMAPRun.Host[i]
34+
// Skipping hosts that are down
35+
if td.OutputOptions.ExcelOptions.SkipDownHosts && host.Status.State != "up" {
36+
continue
37+
}
38+
address := fmt.Sprintf("%s (%s)", host.JoinedAddresses("/"), host.JoinedHostNames("/"))
39+
40+
// Set the IP/Host value
41+
cell := fmt.Sprintf("A%d", row)
42+
file.SetCellValue(sheetName, cell, address)
43+
file.SetCellStyle(sheetName, cell, cell, style)
44+
45+
startRow := row // Remember the start row for this host
46+
47+
for j := range host.Port {
48+
var port *Port = &host.Port[j]
49+
col := 'B' // Start from column B for Services
50+
51+
// Set the Service value
52+
cell = fmt.Sprintf("%c%d", col, row)
53+
file.SetCellValue(sheetName, cell, fmt.Sprintf("%d/%s %s", port.PortID, port.Protocol, port.Service.Name))
54+
file.SetCellStyle(sheetName, cell, cell, style)
55+
row++ // Increment row for next service
56+
}
57+
58+
// Merge cells in the IP/Host column for this host
59+
if row > startRow+1 { // Only merge if there's more than one service
60+
file.MergeCell(sheetName, fmt.Sprintf("A%d", startRow), fmt.Sprintf("A%d", row-1))
61+
}
62+
}
63+
64+
// Save the Excel file
65+
err = file.SaveAs("nmap-output.xlsx")
66+
return err
67+
}
68+
69+
func (f *ExcelFormatter) defaultTemplateContent() string {
70+
return HTMLSimpleTemplate
71+
}

‎formatter/output_options.go

+7
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ type OutputOptions struct {
77
JSONOptions JSONOutputOptions
88
CSVOptions CSVOutputOptions
99
SqliteOutputOptions SqliteOutputOptions
10+
ExcelOptions ExcelOutputOptions
1011
}
1112

1213
// HTMLOutputOptions stores options related only to HTML conversion/formatting
@@ -61,3 +62,9 @@ type SqliteOutputOptions struct {
6162
// ScanIdentifier is a unique string passed by the user to identify unique scans. If it's empty, it's generated automatically
6263
ScanIdentifier string
6364
}
65+
66+
// ExcelOutputOptions store options related to Excel file formatting
67+
type ExcelOutputOptions struct {
68+
// The hosts that are down won't be displayed
69+
SkipDownHosts bool
70+
}

‎go.mod

+11
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,18 @@ require (
99
golang.org/x/net v0.19.0
1010
)
1111

12+
require (
13+
github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826 // indirect
14+
github.com/richardlehane/mscfb v1.0.4 // indirect
15+
github.com/richardlehane/msoleps v1.0.3 // indirect
16+
github.com/xuri/efp v0.0.0-20230802181842-ad255f2331ca // indirect
17+
github.com/xuri/nfp v0.0.0-20230819163627-dc951e3ffe1a // indirect
18+
golang.org/x/crypto v0.16.0 // indirect
19+
golang.org/x/text v0.14.0 // indirect
20+
)
21+
1222
require (
1323
github.com/inconshreveable/mousetrap v1.1.0 // indirect
1424
github.com/spf13/pflag v1.0.5 // indirect
25+
github.com/xuri/excelize/v2 v2.8.0
1526
)

‎go.sum

+65
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,81 @@
11
github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
2+
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
3+
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
24
github.com/google/uuid v1.4.0 h1:MtMxsa51/r9yyhkyLsVeVt0B+BGQZzpQiTQ4eHZ8bc4=
35
github.com/google/uuid v1.4.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
46
github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
57
github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
68
github.com/mattn/go-sqlite3 v1.14.18 h1:JL0eqdCOq6DJVNPSvArO/bIV9/P7fbGrV00LZHc+5aI=
79
github.com/mattn/go-sqlite3 v1.14.18/go.mod h1:2eHXhiwb8IkHr+BDWZGa96P6+rkvnG63S2DGjv9HUNg=
10+
github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826 h1:RWengNIwukTxcDr9M+97sNutRR1RKhG96O6jWumTTnw=
11+
github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826/go.mod h1:TaXosZuwdSHYgviHp1DAtfrULt5eUgsSMsZf+YrPgl8=
12+
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
13+
github.com/richardlehane/mscfb v1.0.4 h1:WULscsljNPConisD5hR0+OyZjwK46Pfyr6mPu5ZawpM=
14+
github.com/richardlehane/mscfb v1.0.4/go.mod h1:YzVpcZg9czvAuhk9T+a3avCpcFPMUWm7gK3DypaEsUk=
15+
github.com/richardlehane/msoleps v1.0.1/go.mod h1:BWev5JBpU9Ko2WAgmZEuiz4/u3ZYTKbjLycmwiWUfWg=
16+
github.com/richardlehane/msoleps v1.0.3 h1:aznSZzrwYRl3rLKRT3gUk9am7T/mLNSnJINvN0AQoVM=
17+
github.com/richardlehane/msoleps v1.0.3/go.mod h1:BWev5JBpU9Ko2WAgmZEuiz4/u3ZYTKbjLycmwiWUfWg=
818
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
919
github.com/spf13/cobra v1.8.0 h1:7aJaZx1B85qltLMc546zn58BxxfZdR/W22ej9CFoEf0=
1020
github.com/spf13/cobra v1.8.0/go.mod h1:WXLWApfZ71AjXPya3WOlMsY9yMs7YeiHhFVlvLyhcho=
1121
github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
1222
github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
23+
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
24+
github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
25+
github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
26+
github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
27+
github.com/xuri/efp v0.0.0-20230802181842-ad255f2331ca h1:uvPMDVyP7PXMMioYdyPH+0O+Ta/UO1WFfNYMO3Wz0eg=
28+
github.com/xuri/efp v0.0.0-20230802181842-ad255f2331ca/go.mod h1:ybY/Jr0T0GTCnYjKqmdwxyxn2BQf2RcQIIvex5QldPI=
29+
github.com/xuri/excelize/v2 v2.8.0 h1:Vd4Qy809fupgp1v7X+nCS/MioeQmYVVzi495UCTqB7U=
30+
github.com/xuri/excelize/v2 v2.8.0/go.mod h1:6iA2edBTKxKbZAa7X5bDhcCg51xdOn1Ar5sfoXRGrQg=
31+
github.com/xuri/nfp v0.0.0-20230819163627-dc951e3ffe1a h1:Mw2VNrNNNjDtw68VsEj2+st+oCSn4Uz7vZw6TbhcV1o=
32+
github.com/xuri/nfp v0.0.0-20230819163627-dc951e3ffe1a/go.mod h1:WwHg+CVyzlv/TX9xqBFXEZAuxOPxn2k1GNHwG41IIUQ=
33+
github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
34+
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
35+
golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
36+
golang.org/x/crypto v0.12.0/go.mod h1:NF0Gs7EO5K4qLn+Ylc+fih8BSTeIjAP05siRnAh98yw=
37+
golang.org/x/crypto v0.16.0 h1:mMMrFzRSCF0GvB7Ne27XVtVAaXLrPmgPC7/v0tkwHaY=
38+
golang.org/x/crypto v0.16.0/go.mod h1:gCAAfMLgwOJRpTjQ2zCCt2OcSfYMTeZVSRtQlPC7Nq4=
39+
golang.org/x/image v0.11.0/go.mod h1:bglhjqbqVuEb9e9+eNR45Jfu7D+T4Qan+NhQk8Ck2P8=
40+
golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
41+
golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
42+
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
43+
golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
44+
golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
45+
golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=
46+
golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg=
47+
golang.org/x/net v0.14.0/go.mod h1:PpSgVXXLK0OxS0F31C1/tv6XNguvCrnXIDrFMspZIUI=
1348
golang.org/x/net v0.19.0 h1:zTwKpTd2XuCqf8huc7Fo2iSy+4RHPd10s4KzeTnVr1c=
1449
golang.org/x/net v0.19.0/go.mod h1:CfAk/cbD4CthTvqiEl8NpboMuiuOYsAr/7NOjZJtv1U=
50+
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
51+
golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
52+
golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
53+
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
54+
golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
55+
golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
56+
golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
57+
golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
58+
golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
59+
golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
60+
golang.org/x/sys v0.11.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
61+
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
62+
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
63+
golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k=
64+
golang.org/x/term v0.8.0/go.mod h1:xPskH00ivmX89bAKVGSKKtLOWNx2+17Eiy94tnKShWo=
65+
golang.org/x/term v0.11.0/go.mod h1:zC9APTIj3jG3FdV/Ons+XE1riIZXG4aZ4GTHiPZJPIU=
66+
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
67+
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
68+
golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
69+
golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
70+
golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8=
71+
golang.org/x/text v0.12.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE=
72+
golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
73+
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
74+
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
75+
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
76+
golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
77+
golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU=
78+
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
1579
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
80+
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
1681
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

0 commit comments

Comments
 (0)