diff --git a/README.md b/README.md index dc60a9e..7fc48a3 100644 --- a/README.md +++ b/README.md @@ -13,22 +13,20 @@ HTML: Graphviz: ![nmap-example-graphviz](docs/images/example-dot.png) -A tool that allows you to convert NMAP XML output to html/csv/json/markdown/dot/sqlite. +A tool that allows you to convert NMAP XML output to excel/html/csv/json/markdown/dot/sqlite. ## Installation -It's possible to install it using `go install` command - ``` -go install github.com/vdjagilev/nmap-formatter/v2@latest +git clone https://github.com/gorkavp/nmap-formatter.git +cd nmap-formatter +go build ``` -All other options can be found on [Installation Wiki page](https://github.com/vdjagilev/nmap-formatter/wiki/Installation). - ## Usage ```bash -nmap-formatter [html|csv|md|json|dot|sqlite] [path-to-nmap.xml] [flags] +nmap-formatter [html|csv|md|json|dot|sqlite|excel] [path-to-nmap.xml] [flags] ``` Or alternatively you can read file from `stdin` and parse it @@ -49,6 +47,12 @@ or Markdown nmap-formatter md [path-to-nmap.xml] > some-markdown.md ``` +or Excel + +```bash +nmap-formatter excel [path-to-nmap.xml] +``` + or JSON ```bash diff --git a/cmd/root.go b/cmd/root.go index b43475d..fa24595 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -39,6 +39,7 @@ var config = formatter.Config{ JSONOptions: formatter.JSONOutputOptions{}, CSVOptions: formatter.CSVOutputOptions{}, SqliteOutputOptions: formatter.SqliteOutputOptions{}, + ExcelOptions: formatter.ExcelOutputOptions{}, }, ShowVersion: false, CurrentVersion: VERSION, @@ -51,9 +52,9 @@ var workflow formatter.Workflow // rootCmd represents the base command when called without any subcommands var rootCmd = &cobra.Command{ - Use: "nmap-formatter [html|csv|md|json|dot|sqlite] [path-to-nmap.xml]", + Use: "nmap-formatter [html|csv|md|json|dot|sqlite|excel] [path-to-nmap.xml]", Short: "Utility that can help you to convert NMAP XML application output to various other formats", - Long: `This utility allows you to convert NMAP XML output to various other formats like (html, csv, markdown (md), json, dot)`, + Long: `This utility allows you to convert NMAP XML output to various other formats like (html, csv, markdown (md), json, dot, excel, sqlite)`, Args: arguments, RunE: run, } diff --git a/cmd/validation.go b/cmd/validation.go index 82b3b7d..8298a8f 100644 --- a/cmd/validation.go +++ b/cmd/validation.go @@ -10,7 +10,7 @@ import ( // validate is checking input from the command line func validate(config formatter.Config) error { if !config.OutputFormat.IsValid() { - return fmt.Errorf("not valid format: %s, please choose html/json/md/csv/sqlite", config.OutputFormat) + return fmt.Errorf("not valid format: %s, please choose html/json/md/csv/excel/sqlite", config.OutputFormat) } err := validateIOFiles(config) diff --git a/formatter/format.go b/formatter/format.go index db33513..acd48d2 100644 --- a/formatter/format.go +++ b/formatter/format.go @@ -16,13 +16,15 @@ const ( DotOutput OutputFormat = "dot" // SqliteOutput constant defines OutputFormat for sqlite file, which can be used to generate sqlite embedded databases SqliteOutput OutputFormat = "sqlite" + // ExcelOutput constant defines OutputFormat for Excel file, which can be used to generate Excel files + ExcelOutput OutputFormat = "excel" ) // IsValid checks whether requested output format is valid func (of OutputFormat) IsValid() bool { // markdown & md is essentially the same thing switch of { - case "markdown", "md", "html", "csv", "json", "dot", "sqlite": + case "markdown", "md", "html", "csv", "json", "dot", "sqlite", "excel": return true } return false diff --git a/formatter/formatter.go b/formatter/formatter.go index b17d606..f0dcaaf 100644 --- a/formatter/formatter.go +++ b/formatter/formatter.go @@ -25,6 +25,10 @@ func New(config *Config) Formatter { return &CSVFormatter{ config, } + case ExcelOutput: + return &ExcelFormatter{ + config, + } case DotOutput: return &DotFormatter{ config, diff --git a/formatter/formatter_excel.go b/formatter/formatter_excel.go new file mode 100644 index 0000000..0d8ac2d --- /dev/null +++ b/formatter/formatter_excel.go @@ -0,0 +1,71 @@ +package formatter + +import ( + "fmt" + + "github.com/xuri/excelize/v2" +) + +// ExcelFormatter is struct defined for Excel Output use-case +type ExcelFormatter struct { + config *Config +} + +// Format the data to Excel and output it to an Excel file +func (f *ExcelFormatter) Format(td *TemplateData, templateContent string) (err error) { + file := excelize.NewFile() + sheetName := "Sheet1" + + // Create a style for center alignment + style, err := file.NewStyle(&excelize.Style{ + Alignment: &excelize.Alignment{Horizontal: "center", Vertical: "center"}, + }) + + // Set the column headers + file.SetCellValue(sheetName, "A1", "IP/Host") + file.SetCellValue(sheetName, "B1", "Servicios") + file.SetCellStyle(sheetName, "A1", "A1", style) + file.SetCellStyle(sheetName, "B1", "B1", style) + + row := 2 // Start from row 2 for data + + for i := range td.NMAPRun.Host { + var host *Host = &td.NMAPRun.Host[i] + // Skipping hosts that are down + if td.OutputOptions.ExcelOptions.SkipDownHosts && host.Status.State != "up" { + continue + } + address := fmt.Sprintf("%s (%s)", host.JoinedAddresses("/"), host.JoinedHostNames("/")) + + // Set the IP/Host value + cell := fmt.Sprintf("A%d", row) + file.SetCellValue(sheetName, cell, address) + file.SetCellStyle(sheetName, cell, cell, style) + + startRow := row // Remember the start row for this host + + for j := range host.Port { + var port *Port = &host.Port[j] + col := 'B' // Start from column B for Services + + // Set the Service value + cell = fmt.Sprintf("%c%d", col, row) + file.SetCellValue(sheetName, cell, fmt.Sprintf("%d/%s %s", port.PortID, port.Protocol, port.Service.Name)) + file.SetCellStyle(sheetName, cell, cell, style) + row++ // Increment row for next service + } + + // Merge cells in the IP/Host column for this host + if row > startRow+1 { // Only merge if there's more than one service + file.MergeCell(sheetName, fmt.Sprintf("A%d", startRow), fmt.Sprintf("A%d", row-1)) + } + } + + // Save the Excel file + err = file.SaveAs("nmap-output.xlsx") + return err +} + +func (f *ExcelFormatter) defaultTemplateContent() string { + return HTMLSimpleTemplate +} diff --git a/formatter/output_options.go b/formatter/output_options.go index 15442b3..8bfdfa4 100644 --- a/formatter/output_options.go +++ b/formatter/output_options.go @@ -7,6 +7,7 @@ type OutputOptions struct { JSONOptions JSONOutputOptions CSVOptions CSVOutputOptions SqliteOutputOptions SqliteOutputOptions + ExcelOptions ExcelOutputOptions } // HTMLOutputOptions stores options related only to HTML conversion/formatting @@ -61,3 +62,9 @@ type SqliteOutputOptions struct { // ScanIdentifier is a unique string passed by the user to identify unique scans. If it's empty, it's generated automatically ScanIdentifier string } + +// ExcelOutputOptions store options related to Excel file formatting +type ExcelOutputOptions struct { + // The hosts that are down won't be displayed + SkipDownHosts bool +} diff --git a/go.mod b/go.mod index f9cdb9f..beb65e2 100644 --- a/go.mod +++ b/go.mod @@ -9,7 +9,18 @@ require ( golang.org/x/net v0.19.0 ) +require ( + github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826 // indirect + github.com/richardlehane/mscfb v1.0.4 // indirect + github.com/richardlehane/msoleps v1.0.3 // indirect + github.com/xuri/efp v0.0.0-20230802181842-ad255f2331ca // indirect + github.com/xuri/nfp v0.0.0-20230819163627-dc951e3ffe1a // indirect + golang.org/x/crypto v0.16.0 // indirect + golang.org/x/text v0.14.0 // indirect +) + require ( github.com/inconshreveable/mousetrap v1.1.0 // indirect github.com/spf13/pflag v1.0.5 // indirect + github.com/xuri/excelize/v2 v2.8.0 ) diff --git a/go.sum b/go.sum index b945f40..3294024 100644 --- a/go.sum +++ b/go.sum @@ -1,16 +1,81 @@ github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/google/uuid v1.4.0 h1:MtMxsa51/r9yyhkyLsVeVt0B+BGQZzpQiTQ4eHZ8bc4= github.com/google/uuid v1.4.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo= github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8= github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw= github.com/mattn/go-sqlite3 v1.14.18 h1:JL0eqdCOq6DJVNPSvArO/bIV9/P7fbGrV00LZHc+5aI= github.com/mattn/go-sqlite3 v1.14.18/go.mod h1:2eHXhiwb8IkHr+BDWZGa96P6+rkvnG63S2DGjv9HUNg= +github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826 h1:RWengNIwukTxcDr9M+97sNutRR1RKhG96O6jWumTTnw= +github.com/mohae/deepcopy v0.0.0-20170929034955-c48cc78d4826/go.mod h1:TaXosZuwdSHYgviHp1DAtfrULt5eUgsSMsZf+YrPgl8= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/richardlehane/mscfb v1.0.4 h1:WULscsljNPConisD5hR0+OyZjwK46Pfyr6mPu5ZawpM= +github.com/richardlehane/mscfb v1.0.4/go.mod h1:YzVpcZg9czvAuhk9T+a3avCpcFPMUWm7gK3DypaEsUk= +github.com/richardlehane/msoleps v1.0.1/go.mod h1:BWev5JBpU9Ko2WAgmZEuiz4/u3ZYTKbjLycmwiWUfWg= +github.com/richardlehane/msoleps v1.0.3 h1:aznSZzrwYRl3rLKRT3gUk9am7T/mLNSnJINvN0AQoVM= +github.com/richardlehane/msoleps v1.0.3/go.mod h1:BWev5JBpU9Ko2WAgmZEuiz4/u3ZYTKbjLycmwiWUfWg= github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= github.com/spf13/cobra v1.8.0 h1:7aJaZx1B85qltLMc546zn58BxxfZdR/W22ej9CFoEf0= github.com/spf13/cobra v1.8.0/go.mod h1:WXLWApfZ71AjXPya3WOlMsY9yMs7YeiHhFVlvLyhcho= github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA= github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= +github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= +github.com/xuri/efp v0.0.0-20230802181842-ad255f2331ca h1:uvPMDVyP7PXMMioYdyPH+0O+Ta/UO1WFfNYMO3Wz0eg= +github.com/xuri/efp v0.0.0-20230802181842-ad255f2331ca/go.mod h1:ybY/Jr0T0GTCnYjKqmdwxyxn2BQf2RcQIIvex5QldPI= +github.com/xuri/excelize/v2 v2.8.0 h1:Vd4Qy809fupgp1v7X+nCS/MioeQmYVVzi495UCTqB7U= +github.com/xuri/excelize/v2 v2.8.0/go.mod h1:6iA2edBTKxKbZAa7X5bDhcCg51xdOn1Ar5sfoXRGrQg= +github.com/xuri/nfp v0.0.0-20230819163627-dc951e3ffe1a h1:Mw2VNrNNNjDtw68VsEj2+st+oCSn4Uz7vZw6TbhcV1o= +github.com/xuri/nfp v0.0.0-20230819163627-dc951e3ffe1a/go.mod h1:WwHg+CVyzlv/TX9xqBFXEZAuxOPxn2k1GNHwG41IIUQ= +github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= +golang.org/x/crypto v0.12.0/go.mod h1:NF0Gs7EO5K4qLn+Ylc+fih8BSTeIjAP05siRnAh98yw= +golang.org/x/crypto v0.16.0 h1:mMMrFzRSCF0GvB7Ne27XVtVAaXLrPmgPC7/v0tkwHaY= +golang.org/x/crypto v0.16.0/go.mod h1:gCAAfMLgwOJRpTjQ2zCCt2OcSfYMTeZVSRtQlPC7Nq4= +golang.org/x/image v0.11.0/go.mod h1:bglhjqbqVuEb9e9+eNR45Jfu7D+T4Qan+NhQk8Ck2P8= +golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= +golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= +golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= +golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= +golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs= +golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg= +golang.org/x/net v0.14.0/go.mod h1:PpSgVXXLK0OxS0F31C1/tv6XNguvCrnXIDrFMspZIUI= golang.org/x/net v0.19.0 h1:zTwKpTd2XuCqf8huc7Fo2iSy+4RHPd10s4KzeTnVr1c= golang.org/x/net v0.19.0/go.mod h1:CfAk/cbD4CthTvqiEl8NpboMuiuOYsAr/7NOjZJtv1U= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.11.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= +golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k= +golang.org/x/term v0.8.0/go.mod h1:xPskH00ivmX89bAKVGSKKtLOWNx2+17Eiy94tnKShWo= +golang.org/x/term v0.11.0/go.mod h1:zC9APTIj3jG3FdV/Ons+XE1riIZXG4aZ4GTHiPZJPIU= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= +golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= +golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= +golang.org/x/text v0.12.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE= +golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ= +golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= +golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU= +golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=