Print security notice when index is added #616

chriskim06 · 2020-06-23T23:52:26Z

Right now I have the warning when the index is added as:

WARNING: You have added a new index from "/home/kimc/playground/temp"
The plugins in this index are not audited for security by the Krew maintainers.
Install them at your own risk.

let me know if you guys think I should change this.

Fixes #615
Related issue: #576

/area multi-index

Only print security notice on install/upgrade when plugin comes from krew-index

ahmetb · 2020-06-26T19:55:15Z

I think I'm good with this in principle.
/approve
/assign @corneliusweig

k8s-ci-robot · 2020-06-26T19:55:24Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ahmetb, chriskim06

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [ahmetb]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

ahmetb · 2020-06-26T19:56:03Z

cmd/krew/cmd/upgrade.go

@@ -104,7 +105,9 @@ kubectl krew upgrade foo bar"`,
 					return errors.Wrapf(err, "failed to upgrade plugin %q", pluginDisplayName)
 				}
 				fmt.Fprintf(os.Stderr, "Upgraded plugin: %s\n", pluginDisplayName)
-				internal.PrintSecurityNotice(plugin.Name)
+				if indexName == constants.DefaultIndexName {


TestKrewInstallDoesntShowSecurityWarningForCustomIndex

+1
Even if it looks redundant, it is an important documentation of our intended logic.

ahmetb · 2020-06-26T19:56:56Z

cmd/krew/cmd/index.go

@@ -75,7 +75,13 @@ var indexAddCmd = &cobra.Command{
 		if !indexoperations.IsValidIndexName(name) {
 			return errInvalidIndexName
 		}
-		return indexoperations.AddIndex(paths, name, args[1])
+		err := indexoperations.AddIndex(paths, name, args[1])
+		if err == nil {


I think if err != nil { return err} then printing this outside the if-block would be better.

also worth adding tests for (just to check WARNING: exists)

ahmetb · 2020-06-26T21:44:40Z

cmd/krew/cmd/index.go

+		}
+		internal.PrintWarning(os.Stderr, `You have added a new index from %q
+The plugins in this index are not audited for security by the Krew maintainers.
+Run them at your own risk.`+"\n", args[1])


It might be better to say Install them at your own risk. for this particular msg.

corneliusweig

Overall, looks good to me!

corneliusweig · 2020-06-27T22:57:03Z

cmd/krew/cmd/index.go

+		}
+		internal.PrintWarning(os.Stderr, `You have added a new index from %q
+The plugins in this index are not audited for security by the Krew maintainers.
+Install them at your own risk.`+"\n", args[1])


nit:

Suggested change

Install them at your own risk.`+"\n", args[1])

Install them at your own risk.

`, args[1])

We are already using multiline string litrals with odd indentation. Then let's not bother about prettifying the trailing newline.

corneliusweig · 2020-06-27T23:01:30Z

integration_test/index_test.go

+
+	test.WithEnv(constants.EnableMultiIndexSwitch, 1).WithDefaultIndex()
+	out := string(test.Krew("index", "add", "foo", test.TempDir().Path("index/"+constants.DefaultIndexName)).RunOrFailOutput())
+	if !strings.Contains(out, "WARNING") {


Can you also check for a more specific message? Just in case when add prints two warnings, we want to make sure the test asserts on the correct one.

corneliusweig · 2020-06-27T23:03:21Z

cmd/krew/cmd/upgrade.go

@@ -104,7 +105,9 @@ kubectl krew upgrade foo bar"`,
 					return errors.Wrapf(err, "failed to upgrade plugin %q", pluginDisplayName)
 				}
 				fmt.Fprintf(os.Stderr, "Upgraded plugin: %s\n", pluginDisplayName)
-				internal.PrintSecurityNotice(plugin.Name)
+				if indexName == constants.DefaultIndexName {


+1
Even if it looks redundant, it is an important documentation of our intended logic.

ahmetb · 2020-06-29T15:55:47Z

/lgtm
Thanks!

Print security notice when index is added

90d2da2

Only print security notice on install/upgrade when plugin comes from krew-index

k8s-ci-robot added area/multi-index cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Jun 23, 2020

k8s-ci-robot requested review from corneliusweig and soltysh June 23, 2020 23:52

k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jun 23, 2020

k8s-ci-robot assigned corneliusweig Jun 26, 2020

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jun 26, 2020

ahmetb reviewed Jun 26, 2020

View reviewed changes

Add integration tests for security warnings

be13d52

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jun 26, 2020

ahmetb approved these changes Jun 26, 2020

View reviewed changes

Update index add warning

018003f

corneliusweig reviewed Jun 27, 2020

View reviewed changes

chriskim06 added 2 commits June 27, 2020 17:18

Code review changes

56ac20d

Add test for upgrade not showing warning

c2d0f7a

k8s-ci-robot assigned ahmetb Jun 29, 2020

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jun 29, 2020

k8s-ci-robot merged commit bc5bea2 into kubernetes-sigs:master Jun 29, 2020

chriskim06 deleted the index-warning branch June 29, 2020 15:58

ahmetb mentioned this pull request Dec 6, 2021

Proposal: Support for signatures via sigstore stack #745

Closed

keisku mentioned this pull request Jan 19, 2022

Unable to verify integrity of package keisku/kubectl-secretdata#9

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Print security notice when index is added #616

Print security notice when index is added #616

chriskim06 commented Jun 23, 2020 •

edited

Loading

ahmetb commented Jun 26, 2020

k8s-ci-robot commented Jun 26, 2020

ahmetb Jun 26, 2020

corneliusweig Jun 27, 2020

ahmetb Jun 26, 2020

ahmetb Jun 26, 2020

corneliusweig left a comment

corneliusweig Jun 27, 2020

corneliusweig Jun 27, 2020

corneliusweig Jun 27, 2020

ahmetb commented Jun 29, 2020

	Install them at your own risk.`+"\n", args[1])
	Install them at your own risk.
	`, args[1])

Print security notice when index is added #616

Print security notice when index is added #616

Conversation

chriskim06 commented Jun 23, 2020 • edited Loading

ahmetb commented Jun 26, 2020

k8s-ci-robot commented Jun 26, 2020

ahmetb Jun 26, 2020

Choose a reason for hiding this comment

corneliusweig Jun 27, 2020

Choose a reason for hiding this comment

ahmetb Jun 26, 2020

Choose a reason for hiding this comment

ahmetb Jun 26, 2020

Choose a reason for hiding this comment

corneliusweig left a comment

Choose a reason for hiding this comment

corneliusweig Jun 27, 2020

Choose a reason for hiding this comment

corneliusweig Jun 27, 2020

Choose a reason for hiding this comment

corneliusweig Jun 27, 2020

Choose a reason for hiding this comment

ahmetb commented Jun 29, 2020

chriskim06 commented Jun 23, 2020 •

edited

Loading