|
| 1 | +package cmd |
| 2 | + |
| 3 | +import ( |
| 4 | + "fmt" |
| 5 | + "os" |
| 6 | + "strings" |
| 7 | + |
| 8 | + "github.com/fatih/color" |
| 9 | + "github.com/j3ssie/osmedeus/core" |
| 10 | + "github.com/j3ssie/osmedeus/utils" |
| 11 | + "github.com/olekukonko/tablewriter" |
| 12 | + "github.com/spf13/cobra" |
| 13 | +) |
| 14 | + |
| 15 | +func init() { |
| 16 | + |
| 17 | + var workflowCmd = &cobra.Command{ |
| 18 | + Use: "workflow", |
| 19 | + Aliases: []string{"wf", "wl", "workflows", "wfs", "work", "works"}, |
| 20 | + Short: "Listing all available workflows", |
| 21 | + Long: core.Banner(), |
| 22 | + } |
| 23 | + |
| 24 | + var workflowListCmd = &cobra.Command{ |
| 25 | + Use: "list", |
| 26 | + Aliases: []string{"ls"}, |
| 27 | + Short: "Listing all available workflows", |
| 28 | + Long: core.Banner(), |
| 29 | + RunE: runWorkflow, |
| 30 | + } |
| 31 | + |
| 32 | + var workflowViewCmd = &cobra.Command{ |
| 33 | + Use: "view", |
| 34 | + Aliases: []string{"viwe", "ve", "vi", "v"}, |
| 35 | + Short: "View details of a workflow", |
| 36 | + Long: core.Banner(), |
| 37 | + RunE: runWorkflowView, |
| 38 | + } |
| 39 | + workflowViewCmd.Flags().Bool("all", false, "View all of the workflows") |
| 40 | + |
| 41 | + workflowCmd.AddCommand(workflowViewCmd) |
| 42 | + workflowCmd.AddCommand(workflowListCmd) |
| 43 | + workflowCmd.SetHelpFunc(UtilsHelp) |
| 44 | + RootCmd.AddCommand(workflowCmd) |
| 45 | + |
| 46 | + workflowCmd.PreRun = func(cmd *cobra.Command, args []string) { |
| 47 | + if options.FullHelp { |
| 48 | + cmd.Help() |
| 49 | + os.Exit(0) |
| 50 | + } |
| 51 | + } |
| 52 | +} |
| 53 | + |
| 54 | +func runWorkflow(cmd *cobra.Command, _ []string) error { |
| 55 | + listFlows() |
| 56 | + fmt.Printf("\n------------------------------------------------------------\n") |
| 57 | + listDefaultModules() |
| 58 | + fmt.Printf("💡 For full help message, please run: %s or %s\n", color.GreenString("osmedeus --hh"), color.GreenString("osmedeus scan --hh")) |
| 59 | + return nil |
| 60 | +} |
| 61 | + |
| 62 | +func runWorkflowView(cmd *cobra.Command, _ []string) error { |
| 63 | + allFlows := core.ListFlow(options) |
| 64 | + viewAll, _ := cmd.Flags().GetBool("all") |
| 65 | + |
| 66 | + if viewAll { |
| 67 | + for _, flow := range allFlows { |
| 68 | + err := viewWorkflow(flow) |
| 69 | + if err != nil { |
| 70 | + utils.ErrorF("Error viewing workflow: %v", err) |
| 71 | + } |
| 72 | + fmt.Printf("\n------------------------------------------------------------\n\n") |
| 73 | + } |
| 74 | + } else { |
| 75 | + err := viewWorkflow(options.Scan.Flow) |
| 76 | + if err != nil { |
| 77 | + utils.ErrorF("Error viewing workflow: %v", err) |
| 78 | + } |
| 79 | + } |
| 80 | + |
| 81 | + h := color.HiCyanString("\n📄 Sample Usage:\n") |
| 82 | + h += color.HiGreenString(" osmedeus scan -f %v", color.HiMagentaString(options.Scan.Flow)) + color.HiGreenString(" -t ") + color.HiMagentaString("[target]") + "\n" |
| 83 | + h += color.HiGreenString(" osmedeus scan -f %v", color.HiMagentaString(options.Scan.Flow)) + color.HiGreenString(" -t ") + color.HiMagentaString("[target]") + color.HiGreenString(" -p ") + color.HiMagentaString("'enableSomething=false'") + "\n\n" |
| 84 | + fmt.Printf(h) |
| 85 | + |
| 86 | + fmt.Printf("💡 To list all of the workflows available, please run: %s\n", color.GreenString("osmedeus workflow ls")) |
| 87 | + fmt.Printf("💡 For full help message, please run: %s or %s\n", color.GreenString("osmedeus --hh"), color.GreenString("osmedeus scan --hh")) |
| 88 | + return nil |
| 89 | +} |
| 90 | + |
| 91 | +func viewWorkflow(workflowName string) error { |
| 92 | + fmt.Printf("📖 Viewing workflow detail: %v\n\n", color.GreenString(workflowName)) |
| 93 | + allFlows := core.ListFlow(options) |
| 94 | + flows := core.SelectFlow(workflowName, options) |
| 95 | + if len(flows) == 0 { |
| 96 | + utils.ErrorF("Flow not found in any of existing workflow [%v]", color.HiYellowString(strings.Join(allFlows, ", "))) |
| 97 | + return fmt.Errorf("Flow %s not found", workflowName) |
| 98 | + } |
| 99 | + selectedWorkflow := flows[0] |
| 100 | + |
| 101 | + var content [][]string |
| 102 | + parsedFlow, err := core.ParseFlow(selectedWorkflow) |
| 103 | + if err != nil { |
| 104 | + utils.ErrorF("Error parsing flow: %v", selectedWorkflow) |
| 105 | + return err |
| 106 | + } |
| 107 | + |
| 108 | + var totalSteps, totalModules int |
| 109 | + parameters := make(map[string]string) |
| 110 | + for _, param := range parsedFlow.Params { |
| 111 | + for k, v := range param { |
| 112 | + parameters[k] = v |
| 113 | + } |
| 114 | + } |
| 115 | + |
| 116 | + for _, routine := range parsedFlow.Routines { |
| 117 | + // select module depend on the flow type |
| 118 | + if routine.FlowFolder != "" { |
| 119 | + parsedFlow.Type = routine.FlowFolder |
| 120 | + } else { |
| 121 | + parsedFlow.Type = parsedFlow.DefaultType |
| 122 | + } |
| 123 | + |
| 124 | + modules := core.SelectModules(routine.Modules, options) |
| 125 | + |
| 126 | + // loop through all modules to get the parameters |
| 127 | + for _, module := range modules { |
| 128 | + parsedModule, err := core.ParseModules(module) |
| 129 | + if err != nil || parsedModule.Name == "" { |
| 130 | + continue |
| 131 | + } |
| 132 | + for _, param := range parsedModule.Params { |
| 133 | + for k, v := range param { |
| 134 | + |
| 135 | + _, exist := parameters[k] |
| 136 | + if parsedFlow.ForceParams && exist { |
| 137 | + utils.DebugF("Skip override param: %v --> %v", k, v) |
| 138 | + continue |
| 139 | + } |
| 140 | + parameters[k] = v |
| 141 | + } |
| 142 | + |
| 143 | + } |
| 144 | + totalSteps += len(parsedModule.Steps) |
| 145 | + totalModules++ |
| 146 | + } |
| 147 | + } |
| 148 | + |
| 149 | + var toggleFlags, skippingFlags []string |
| 150 | + for key, value := range parameters { |
| 151 | + if value == "true" { |
| 152 | + value = color.GreenString(value) |
| 153 | + } else if value == "false" { |
| 154 | + value = color.RedString(value) |
| 155 | + } else { |
| 156 | + |
| 157 | + value = color.CyanString(value) |
| 158 | + } |
| 159 | + |
| 160 | + if strings.HasPrefix(key, "enable") { |
| 161 | + toggleFlags = append(toggleFlags, fmt.Sprintf("%v=%v", key, value)) |
| 162 | + } |
| 163 | + |
| 164 | + if strings.HasPrefix(key, "skip") { |
| 165 | + skippingFlags = append(skippingFlags, fmt.Sprintf("%v=%v", key, value)) |
| 166 | + } |
| 167 | + } |
| 168 | + |
| 169 | + workflowInfo := fmt.Sprintf("Name: %v", color.HiCyanString(parsedFlow.Name)) + ", " + fmt.Sprintf("Total Steps: %v", color.HiCyanString("%v", totalSteps)) + ", " + fmt.Sprintf("Total Modules: %v", color.HiCyanString("%v", totalModules)) |
| 170 | + content = append(content, []string{ |
| 171 | + "Workflow Information", workflowInfo, |
| 172 | + }) |
| 173 | + content = append(content, []string{ |
| 174 | + "Description", parsedFlow.Desc, |
| 175 | + }) |
| 176 | + |
| 177 | + content = append(content, []string{ |
| 178 | + "Toggleable parameter", strings.Join(toggleFlags, ", "), |
| 179 | + }) |
| 180 | + |
| 181 | + content = append(content, []string{ |
| 182 | + "Skippable parameter", strings.Join(skippingFlags, ", "), |
| 183 | + }) |
| 184 | + |
| 185 | + if parsedFlow.Usage != "" { |
| 186 | + content = append(content, []string{ |
| 187 | + "Examples Commands", strings.TrimSpace(parsedFlow.Usage), |
| 188 | + }) |
| 189 | + } |
| 190 | + |
| 191 | + table := tablewriter.NewWriter(os.Stdout) |
| 192 | + table.SetRowLine(true) |
| 193 | + table.SetBorders(tablewriter.Border{Left: true, Top: true, Right: true, Bottom: true}) |
| 194 | + table.SetColWidth(120) |
| 195 | + table.SetAutoWrapText(false) |
| 196 | + table.AppendBulk(content) |
| 197 | + table.Render() |
| 198 | + |
| 199 | + return nil |
| 200 | +} |
0 commit comments