feat(contrib/fvuls) Add commands to obtained CPE information of network devices by executing snmp2cpe and upload to Fvuls server (#1721)
* add: README.md * add: commands(discover,add-server,add-cpe) * add: implements(discover,add-server,add-cpe) * fix: changed os.Exit(1) in main.go to return an error * fix: lint error * delete: trivy-to-vuls stdIn * fix: Incomprehesible error logs * fix: according to review * add: function converts old config to latest one * delete: add-server * fix: lint error * fix * fix: remote scan error in Windows * fix: lint error * fix * fix: lint error * fix: lint error * fix: lint error * add: scanner/scanner.go test normalizeHomeDirForWindows() * fix * fix * fix * fix * fix * fix * fix: lint error * fix: error log * fix * refactor(fvuls) * Refactor (#2) refactor --------- Co-authored-by: 和田皓翔 <wadahiroka@192.168.0.6> * Refactor (#3) fix --------- Co-authored-by: Sadayuki Matsuno <sadayuki.matsuno@gmail.com> Co-authored-by: 和田皓翔 <wadahiroka@192.168.0.6> * fix * fix: lint error * fix --------- Co-authored-by: 和田皓翔 <wadahiroka@192.168.0.4> Co-authored-by: 和田皓翔 <wadahiroka@192.168.0.10> Co-authored-by: 和田皓翔 <wadahiroka@192.168.0.6> Co-authored-by: Sadayuki Matsuno <sadayuki.matsuno@gmail.com>
This commit is contained in:
hiroka-wada
@@ -2,18 +2,77 @@
|
||||
|
||||
## Main Features
|
||||
|
||||
- upload vuls results json to future-vuls
|
||||
- `future-vuls upload`
|
||||
- upload vuls results json to future-vuls
|
||||
|
||||
- `future-vuls discover`
|
||||
- Explore hosts within the CIDR range using the ping command
|
||||
- Describe the information including CPE on the found hosts in a toml-formatted file.
|
||||
- Exec snmp2cpe(https://github.com/future-architect/vuls/pull/1625) to active hosts to obtain CPE<br>
|
||||
Commands running internally `snmp2cpe v2c {IPAddr} public | snmp2cpe convert`<br>
|
||||
|
||||
Structure of toml-formatted file
|
||||
```
|
||||
[server.{ip}]
|
||||
ip = {IpAddr}
|
||||
server_name = ""
|
||||
uuid = {UUID}
|
||||
cpe_uris = []
|
||||
fvuls_sync = false
|
||||
```
|
||||
|
||||
- `future-vuls add-cpe`
|
||||
- Create pseudo server to Fvuls to obtain uuid and Upload CPE information on the specified(FvulsSync is true and UUID is obtained) hosts to Fvuls
|
||||
- Fvuls_Sync must be rewritten to true to designate it as the target of the command<br><br>
|
||||
|
||||
|
||||
1. `future-vuls discover`
|
||||
|
||||
2. `future-vuls add-cpe`
|
||||
|
||||
These two commands are used to manage the CPE of network devices, and by executing the commands in the order from the top, you can manage the CPE of each device in Fvuls
|
||||
|
||||
toml file after command execution
|
||||
```
|
||||
["192.168.0.10"]
|
||||
ip = "192.168.0.10"
|
||||
server_name = "192.168.0.10"
|
||||
uuid = "e811e2b1-9463-d682-7c79-a4ab37de28cf"
|
||||
cpe_uris = ["cpe:2.3:h:fortinet:fortigate-50e:-:*:*:*:*:*:*:*", "cpe:2.3:o:fortinet:fortios:5.4.6:*:*:*:*:*:*:*"]
|
||||
fvuls_sync = true
|
||||
```
|
||||
## Installation
|
||||
|
||||
```
|
||||
git clone https://github.com/future-architect/vuls.git
|
||||
cd vuls
|
||||
make build-future-vuls
|
||||
```
|
||||
|
||||
## Command Reference
|
||||
|
||||
```
|
||||
./future-vuls -h
|
||||
Usage:
|
||||
future-vuls [command]
|
||||
|
||||
Available Commands:
|
||||
add-cpe Create a pseudo server in Fvuls and register CPE. Default outputFile is ./discover_list.toml
|
||||
completion Generate the autocompletion script for the specified shell
|
||||
discover discover hosts with CIDR range. Run snmp2cpe on active host to get CPE. Default outputFile is ./discover_list.toml
|
||||
help Help about any command
|
||||
upload Upload to FutureVuls
|
||||
version Show version
|
||||
|
||||
Flags:
|
||||
-h, --help help for future-vuls
|
||||
|
||||
Use "future-vuls [command] --help" for more information about a command.
|
||||
```
|
||||
### Subcommands
|
||||
|
||||
```
|
||||
./future-vuls upload -h
|
||||
Upload to FutureVuls
|
||||
|
||||
Usage:
|
||||
@@ -29,10 +88,71 @@ Flags:
|
||||
--uuid string server uuid. ENV: VULS_SERVER_UUID
|
||||
```
|
||||
|
||||
```
|
||||
./future-vuls discover -h
|
||||
discover hosts with CIDR range. Run snmp2cpe on active host to get CPE. Default outputFile is ./discover_list.toml
|
||||
|
||||
Usage:
|
||||
future-vuls discover --cidr <CIDR_RANGE> --output <OUTPUT_FILE> [flags]
|
||||
|
||||
Examples:
|
||||
future-vuls discover --cidr 192.168.0.0/24 --output discover_list.toml
|
||||
|
||||
Flags:
|
||||
--cidr string cidr range
|
||||
-h, --help help for discover
|
||||
--output string output file
|
||||
--snmp-version string snmp version v1,v2c and v3. default: v2c
|
||||
```
|
||||
|
||||
```
|
||||
./future-vuls add-cpe -h
|
||||
Create a pseudo server in Fvuls and register CPE. Default outputFile is ./discover_list.toml
|
||||
|
||||
Usage:
|
||||
future-vuls add-cpe --token <VULS_TOKEN> --output <OUTPUT_FILE> [flags]
|
||||
|
||||
Examples:
|
||||
future-vuls add-cpe --token <VULS_TOKEN>
|
||||
|
||||
Flags:
|
||||
-h, --help help for add-cpe
|
||||
--http-proxy string proxy url
|
||||
--output string output file
|
||||
-t, --token string future vuls token ENV: VULS_TOKEN
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
- update results json
|
||||
- `future-vuls upload`
|
||||
|
||||
```
|
||||
cat results.json | future-vuls upload --stdin --token xxxx --url https://xxxx --group-id 1 --uuid xxxx
|
||||
```
|
||||
```
|
||||
- `future-vuls discover`
|
||||
```
|
||||
./future-vuls discover --cidr 192.168.0.1/24
|
||||
Discovering 192.168.0.1/24...
|
||||
192.168.0.1: Execute snmp2cpe...
|
||||
failed to execute snmp2cpe. err: failed to execute snmp2cpe. err: exit status 1
|
||||
192.168.0.2: Execute snmp2cpe...
|
||||
failed to execute snmp2cpe. err: failed to execute snmp2cpe. err: exit status 1
|
||||
192.168.0.4: Execute snmp2cpe...
|
||||
failed to execute snmp2cpe. err: failed to execute snmp2cpe. err: exit status 1
|
||||
192.168.0.5: Execute snmp2cpe...
|
||||
failed to execute snmp2cpe. err: failed to execute snmp2cpe. err: exit status 1
|
||||
192.168.0.6: Execute snmp2cpe...
|
||||
New network device found 192.168.0.6
|
||||
wrote to discover_list.toml
|
||||
```
|
||||
- `future-vuls add-cpe`
|
||||
```
|
||||
./future-vuls add-cpe --token fvgr-686b92af-5216-11ee-a241-0a58a9feac02
|
||||
Creating 1 pseudo server...
|
||||
192.168.0.6: Created FutureVuls pseudo server ce024b45-1c59-5b86-1a67-e78a40dfec01
|
||||
wrote to discover_list.toml
|
||||
|
||||
Uploading 1 server's CPE...
|
||||
192.168.0.6: Uploaded CPE cpe:2.3:h:fortinet:fortigate-50e:-:*:*:*:*:*:*:*
|
||||
192.168.0.6: Uploaded CPE cpe:2.3:o:fortinet:fortios:5.4.6:*:*:*:*:*:*:*
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user