Add proboctl statement of applicability commands

Add CRUD commands for statements of applicability and their
applicability statements (add, list, remove, update).

Signed-off-by: Bryan Frimin <bryan@getprobo.com>
This commit is contained in:
Bryan Frimin
2026-03-14 23:35:08 +01:00
parent 04cb9e08fb
commit f1a028c4f1
11 changed files with 1380 additions and 0 deletions

View File

@@ -0,0 +1,183 @@
// Copyright (c) 2026 Probo Inc <hello@getprobo.com>.
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
package add
import (
"encoding/json"
"fmt"
"github.com/charmbracelet/huh"
"github.com/spf13/cobra"
"go.probo.inc/probo/pkg/cli/api"
"go.probo.inc/probo/pkg/cmd/cmdutil"
)
const createMutation = `
mutation($input: CreateApplicabilityStatementInput!) {
createApplicabilityStatement(input: $input) {
applicabilityStatementEdge {
node {
id
applicability
justification
control {
id
sectionTitle
name
}
}
}
}
}
`
type createResponse struct {
CreateApplicabilityStatement struct {
ApplicabilityStatementEdge struct {
Node struct {
ID string `json:"id"`
Applicability bool `json:"applicability"`
Justification string `json:"justification"`
Control struct {
ID string `json:"id"`
SectionTitle string `json:"sectionTitle"`
Name string `json:"name"`
} `json:"control"`
} `json:"node"`
} `json:"applicabilityStatementEdge"`
} `json:"createApplicabilityStatement"`
}
func NewCmdAdd(f *cmdutil.Factory) *cobra.Command {
var (
flagSoA string
flagControl string
flagApplicable bool
flagNotApplicable bool
flagJustification string
)
cmd := &cobra.Command{
Use: "add",
Short: "Add an applicability statement to a SoA",
Example: ` # Add a control as applicable
proboctl soa statement add --soa SOA_ID --control CTRL_ID --applicable
# Add a control as not applicable with justification
proboctl soa statement add --soa SOA_ID --control CTRL_ID --not-applicable --justification "Not in scope"`,
Args: cobra.NoArgs,
RunE: func(cmd *cobra.Command, args []string) error {
if flagApplicable && flagNotApplicable {
return fmt.Errorf("cannot set both --applicable and --not-applicable")
}
if !flagApplicable && !flagNotApplicable {
if !f.IOStreams.IsInteractive() {
return fmt.Errorf("either --applicable or --not-applicable is required")
}
var choice string
err := huh.NewSelect[string]().
Title("Is this control applicable?").
Options(
huh.NewOption("Applicable", "applicable"),
huh.NewOption("Not applicable", "not-applicable"),
).
Value(&choice).
Run()
if err != nil {
return err
}
flagApplicable = choice == "applicable"
}
if !flagApplicable && flagJustification == "" && f.IOStreams.IsInteractive() {
err := huh.NewText().
Title("Justification for not applicable").
Value(&flagJustification).
Run()
if err != nil {
return err
}
}
cfg, err := f.Config()
if err != nil {
return err
}
host, hc, err := cfg.DefaultHost()
if err != nil {
return err
}
client := api.NewClient(
host,
hc.Token,
"/api/console/v1/graphql",
cfg.HTTPTimeoutDuration(),
)
input := map[string]any{
"stateOfApplicabilityId": flagSoA,
"controlId": flagControl,
"applicability": flagApplicable,
}
if flagJustification != "" {
input["justification"] = flagJustification
}
data, err := client.Do(
createMutation,
map[string]any{"input": input},
)
if err != nil {
return err
}
var resp createResponse
if err := json.Unmarshal(data, &resp); err != nil {
return fmt.Errorf("cannot parse response: %w", err)
}
s := resp.CreateApplicabilityStatement.ApplicabilityStatementEdge.Node
applicable := "not applicable"
if s.Applicability {
applicable = "applicable"
}
_, _ = fmt.Fprintf(
f.IOStreams.Out,
"Added statement %s: control %s (%s) marked as %s\n",
s.ID,
s.Control.SectionTitle,
s.Control.Name,
applicable,
)
return nil
},
}
cmd.Flags().StringVar(&flagSoA, "soa", "", "Statement of applicability ID (required)")
cmd.Flags().StringVar(&flagControl, "control", "", "Control ID (required)")
cmd.Flags().BoolVar(&flagApplicable, "applicable", false, "Mark control as applicable")
cmd.Flags().BoolVar(&flagNotApplicable, "not-applicable", false, "Mark control as not applicable")
cmd.Flags().StringVar(&flagJustification, "justification", "", "Justification for the applicability decision")
_ = cmd.MarkFlagRequired("soa")
_ = cmd.MarkFlagRequired("control")
return cmd
}

View File

@@ -0,0 +1,190 @@
// Copyright (c) 2026 Probo Inc <hello@getprobo.com>.
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
package list
import (
"encoding/json"
"fmt"
"github.com/spf13/cobra"
"go.probo.inc/probo/pkg/cli/api"
"go.probo.inc/probo/pkg/cmd/cmdutil"
)
const listQuery = `
query($id: ID!, $first: Int, $after: CursorKey, $orderBy: ApplicabilityStatementOrder) {
node(id: $id) {
__typename
... on StateOfApplicability {
applicabilityStatements(first: $first, after: $after, orderBy: $orderBy) {
totalCount
edges {
node {
id
applicability
justification
control {
id
sectionTitle
name
}
}
}
pageInfo {
hasNextPage
endCursor
}
}
}
}
}
`
type applicabilityStatement struct {
ID string `json:"id"`
Applicability bool `json:"applicability"`
Justification string `json:"justification"`
Control struct {
ID string `json:"id"`
SectionTitle string `json:"sectionTitle"`
Name string `json:"name"`
} `json:"control"`
}
func NewCmdList(f *cmdutil.Factory) *cobra.Command {
var (
flagLimit int
flagOrderBy string
flagOrderDir string
flagOutput *string
)
cmd := &cobra.Command{
Use: "list <soa-id>",
Short: "List applicability statements in a SoA",
Aliases: []string{"ls"},
Args: cobra.ExactArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
if err := cmdutil.ValidateOutputFlag(flagOutput); err != nil {
return err
}
cfg, err := f.Config()
if err != nil {
return err
}
host, hc, err := cfg.DefaultHost()
if err != nil {
return err
}
client := api.NewClient(
host,
hc.Token,
"/api/console/v1/graphql",
cfg.HTTPTimeoutDuration(),
)
variables := map[string]any{
"id": args[0],
}
if flagOrderBy != "" {
if err := cmdutil.ValidateEnum("order-by", flagOrderBy, []string{"CREATED_AT", "CONTROL_SECTION_TITLE"}); err != nil {
return err
}
variables["orderBy"] = map[string]any{
"field": flagOrderBy,
"direction": flagOrderDir,
}
}
statements, totalCount, err := api.Paginate(
client,
listQuery,
variables,
flagLimit,
func(data json.RawMessage) (*api.Connection[applicabilityStatement], error) {
var resp struct {
Node *struct {
Typename string `json:"__typename"`
ApplicabilityStatements api.Connection[applicabilityStatement] `json:"applicabilityStatements"`
} `json:"node"`
}
if err := json.Unmarshal(data, &resp); err != nil {
return nil, err
}
if resp.Node == nil {
return nil, fmt.Errorf("statement of applicability %s not found", args[0])
}
if resp.Node.Typename != "StateOfApplicability" {
return nil, fmt.Errorf("expected StateOfApplicability node, got %s", resp.Node.Typename)
}
return &resp.Node.ApplicabilityStatements, nil
},
)
if err != nil {
return err
}
if *flagOutput == cmdutil.OutputJSON {
return cmdutil.PrintJSON(f.IOStreams.Out, statements)
}
if len(statements) == 0 {
_, _ = fmt.Fprintln(f.IOStreams.Out, "No applicability statements found.")
return nil
}
rows := make([][]string, 0, len(statements))
for _, s := range statements {
applicable := "No"
if s.Applicability {
applicable = "Yes"
}
rows = append(rows, []string{
s.ID,
s.Control.SectionTitle,
s.Control.Name,
applicable,
s.Justification,
})
}
t := cmdutil.NewTable("ID", "SECTION", "CONTROL", "APPLICABLE", "JUSTIFICATION").Rows(rows...)
_, _ = fmt.Fprintln(f.IOStreams.Out, t)
if totalCount > len(statements) {
_, _ = fmt.Fprintf(
f.IOStreams.ErrOut,
"\nShowing %d of %d statements\n",
len(statements),
totalCount,
)
}
return nil
},
}
cmd.Flags().IntVarP(&flagLimit, "limit", "L", 30, "Maximum number of statements to list")
cmd.Flags().StringVar(&flagOrderBy, "order-by", "", "Order by field (CREATED_AT, CONTROL_SECTION_TITLE)")
flagOutput = cmdutil.AddOutputFlag(cmd)
cmd.Flags().StringVar(&flagOrderDir, "order-direction", "DESC", "Sort direction (ASC, DESC)")
return cmd
}

View File

@@ -0,0 +1,102 @@
// Copyright (c) 2026 Probo Inc <hello@getprobo.com>.
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
package remove
import (
"fmt"
"github.com/charmbracelet/huh"
"github.com/spf13/cobra"
"go.probo.inc/probo/pkg/cli/api"
"go.probo.inc/probo/pkg/cmd/cmdutil"
)
const deleteMutation = `
mutation($input: DeleteApplicabilityStatementInput!) {
deleteApplicabilityStatement(input: $input) {
deletedApplicabilityStatementId
}
}
`
func NewCmdRemove(f *cmdutil.Factory) *cobra.Command {
var flagYes bool
cmd := &cobra.Command{
Use: "remove <id>",
Short: "Remove an applicability statement from a SoA",
Args: cobra.ExactArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
if !flagYes {
if !f.IOStreams.IsInteractive() {
return fmt.Errorf("cannot remove statement: confirmation required, use --yes to confirm")
}
var confirmed bool
err := huh.NewConfirm().
Title(fmt.Sprintf("Remove applicability statement %s?", args[0])).
Value(&confirmed).
Run()
if err != nil {
return err
}
if !confirmed {
return nil
}
}
cfg, err := f.Config()
if err != nil {
return err
}
host, hc, err := cfg.DefaultHost()
if err != nil {
return err
}
client := api.NewClient(
host,
hc.Token,
"/api/console/v1/graphql",
cfg.HTTPTimeoutDuration(),
)
_, err = client.Do(
deleteMutation,
map[string]any{
"input": map[string]any{
"applicabilityStatementId": args[0],
},
},
)
if err != nil {
return err
}
_, _ = fmt.Fprintf(
f.IOStreams.Out,
"Removed applicability statement %s\n",
args[0],
)
return nil
},
}
cmd.Flags().BoolVarP(&flagYes, "yes", "y", false, "Skip confirmation prompt")
return cmd
}

View File

@@ -0,0 +1,38 @@
// Copyright (c) 2026 Probo Inc <hello@getprobo.com>.
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
package statement
import (
"github.com/spf13/cobra"
"go.probo.inc/probo/pkg/cmd/cmdutil"
"go.probo.inc/probo/pkg/cmd/soa/statement/add"
"go.probo.inc/probo/pkg/cmd/soa/statement/list"
"go.probo.inc/probo/pkg/cmd/soa/statement/remove"
"go.probo.inc/probo/pkg/cmd/soa/statement/update"
)
func NewCmdStatement(f *cmdutil.Factory) *cobra.Command {
cmd := &cobra.Command{
Use: "statement <command>",
Short: "Manage applicability statements in a SoA",
}
cmd.AddCommand(list.NewCmdList(f))
cmd.AddCommand(add.NewCmdAdd(f))
cmd.AddCommand(update.NewCmdUpdate(f))
cmd.AddCommand(remove.NewCmdRemove(f))
return cmd
}

View File

@@ -0,0 +1,142 @@
// Copyright (c) 2026 Probo Inc <hello@getprobo.com>.
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
package update
import (
"encoding/json"
"fmt"
"github.com/spf13/cobra"
"go.probo.inc/probo/pkg/cli/api"
"go.probo.inc/probo/pkg/cmd/cmdutil"
)
const updateMutation = `
mutation($input: UpdateApplicabilityStatementInput!) {
updateApplicabilityStatement(input: $input) {
applicabilityStatement {
id
applicability
justification
control {
id
sectionTitle
name
}
}
}
}
`
type updateResponse struct {
UpdateApplicabilityStatement struct {
ApplicabilityStatement struct {
ID string `json:"id"`
Applicability bool `json:"applicability"`
Justification string `json:"justification"`
Control struct {
ID string `json:"id"`
SectionTitle string `json:"sectionTitle"`
Name string `json:"name"`
} `json:"control"`
} `json:"applicabilityStatement"`
} `json:"updateApplicabilityStatement"`
}
func NewCmdUpdate(f *cmdutil.Factory) *cobra.Command {
var (
flagApplicable bool
flagNotApplicable bool
flagJustification string
)
cmd := &cobra.Command{
Use: "update <id>",
Short: "Update an applicability statement",
Args: cobra.ExactArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
if flagApplicable && flagNotApplicable {
return fmt.Errorf("cannot set both --applicable and --not-applicable")
}
if !flagApplicable && !flagNotApplicable && !cmd.Flags().Changed("justification") {
return fmt.Errorf("at least one of --applicable, --not-applicable, or --justification is required")
}
cfg, err := f.Config()
if err != nil {
return err
}
host, hc, err := cfg.DefaultHost()
if err != nil {
return err
}
client := api.NewClient(
host,
hc.Token,
"/api/console/v1/graphql",
cfg.HTTPTimeoutDuration(),
)
input := map[string]any{
"applicabilityStatementId": args[0],
}
if cmd.Flags().Changed("applicable") || cmd.Flags().Changed("not-applicable") {
input["applicability"] = flagApplicable
}
if cmd.Flags().Changed("justification") {
input["justification"] = flagJustification
}
data, err := client.Do(
updateMutation,
map[string]any{"input": input},
)
if err != nil {
return err
}
var resp updateResponse
if err := json.Unmarshal(data, &resp); err != nil {
return fmt.Errorf("cannot parse response: %w", err)
}
s := resp.UpdateApplicabilityStatement.ApplicabilityStatement
applicable := "not applicable"
if s.Applicability {
applicable = "applicable"
}
_, _ = fmt.Fprintf(
f.IOStreams.Out,
"Updated statement %s: control %s (%s) marked as %s\n",
s.ID,
s.Control.SectionTitle,
s.Control.Name,
applicable,
)
return nil
},
}
cmd.Flags().BoolVar(&flagApplicable, "applicable", false, "Mark control as applicable")
cmd.Flags().BoolVar(&flagNotApplicable, "not-applicable", false, "Mark control as not applicable")
cmd.Flags().StringVar(&flagJustification, "justification", "", "Justification for the applicability decision")
return cmd
}