Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,16 +44,40 @@ see live on separate staff-only kinds (`SubmissionReview`,
Vote and Subscription names are `<post>.<user>`, which gives one per user per
post across the shared collection.

The `owner` admission webhook sets `spec.userRef` on every user-owned kind
from the request: in a user's own context it is always that user. Only the
operator creates them for someone else, and the Security Team logs reports
for external reporters with no owner. The `reviewer` webhook records who
decided on a `SubmissionReview`.

## Roles

| Role | For |
| --- | --- |
| `feedback.miloapis.com-user` | every signed-in user, in their own context, through Milo's `iam-user-self-manage` |
| `feedback.miloapis.com-public-reader` | the datum.net service account |
| `feedback.miloapis.com-viewer`, `-editor`, `-reviewer`, `-admin` | staff |
| `feedback.miloapis.com-security-team` | the Security Team only; the only role that reads every report and their triage |

The service's components (`system:feedback-operator`, `system:feedback-sync`,
`system:feedback-uploads`, all `@feedback.miloapis.com`) authenticate with
client certificates and get Kubernetes RBAC in Milo (`config/milo/rbac`).

## Layout

```
cmd/feedback/ operator and version commands
internal/identity/ who a request comes from, from Milo's user info
internal/webhook/ admission webhooks Milo calls
pkg/apis/feedback/ feedback.miloapis.com/v1alpha1 types (CRDs)
config/crd/ generated CRDs, installed in Milo
config/base/ operator Deployment, Services, leader election RBAC
config/components/ milo-integration: Milo kubeconfig, client and webhook certificates
config/milo/ Milo IAM ProtectedResources and Roles
config/milo/ applied to Milo: IAM (iam/), RBAC for the service's
components (rbac/), webhook config (webhook/), and
optional role bindings (bindings/)
config/samples/ an example of every resource
test/config/ checks config/ against the CRDs
```

## Development
Expand Down
1 change: 1 addition & 0 deletions Taskfile.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ tasks:
cmds:
- "{{.TOOL_DIR}}/controller-gen object:headerFile=hack/boilerplate.go.txt paths=./pkg/apis/..."
- "{{.TOOL_DIR}}/controller-gen crd paths=./pkg/apis/... output:crd:artifacts:config=config/crd/bases"
- "{{.TOOL_DIR}}/controller-gen webhook paths=./internal/webhook/... output:webhook:artifacts:config=config/milo/webhook"

install-tools:
desc: Install code generators into bin/
Expand Down
7 changes: 5 additions & 2 deletions cmd/feedback/operator.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,10 @@ import (
"sigs.k8s.io/controller-runtime/pkg/healthz"
"sigs.k8s.io/controller-runtime/pkg/log/zap"
metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
"sigs.k8s.io/controller-runtime/pkg/webhook"
ctrlwebhook "sigs.k8s.io/controller-runtime/pkg/webhook"

"go.miloapis.com/feedback/internal/version"
"go.miloapis.com/feedback/internal/webhook"
feedbackv1alpha1 "go.miloapis.com/feedback/pkg/apis/feedback/v1alpha1"
)

Expand Down Expand Up @@ -86,12 +87,14 @@ func runOperator(o operatorOptions) error {
LeaderElectionNamespace: o.leaderElectionNamespace,
LeaderElectionConfig: localConfig,
LeaderElectionReleaseOnCancel: true,
WebhookServer: webhook.NewServer(webhook.Options{Port: o.webhookPort, CertDir: o.webhookCertDir}),
WebhookServer: ctrlwebhook.NewServer(ctrlwebhook.Options{Port: o.webhookPort, CertDir: o.webhookCertDir}),
})
if err != nil {
return fmt.Errorf("creating manager: %w", err)
}

webhook.Register(mgr)

if err := mgr.AddHealthzCheck("healthz", healthz.Ping); err != nil {
return err
}
Expand Down
29 changes: 29 additions & 0 deletions config/milo/bindings/kustomization.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Who gets which role, platform-wide. Optional: a deployment includes this
# component, or binds the roles to its own groups instead.
#
# - feedback-security-team gets the security-team role on reports.
# - staff-users get the reviewer role on everything else. PolicyBindings
# select one kind each, so there is one file per kind.
#
# Users get feedback.miloapis.com-user on their own User by adding it to
# inheritedRoles of Milo's iam-user-self-manage role. That role is shared
# with other services, so the deployment patches it, keeping their entries.
apiVersion: kustomize.config.k8s.io/v1alpha1
kind: Component

resources:
- security-team-group.yaml
- security-team-securityreports.yaml
- security-team-securityreporttriages.yaml
- security-team-securityacknowledgements.yaml
- staff-reviewer-feedbacksources.yaml
- staff-reviewer-posts.yaml
- staff-reviewer-releases.yaml
- staff-reviewer-changelogentries.yaml
- staff-reviewer-votes.yaml
- staff-reviewer-subscriptions.yaml
- staff-reviewer-submissions.yaml
- staff-reviewer-submissionreviews.yaml
- staff-reviewer-securityacknowledgements.yaml
- staff-reviewer-feedbackprofiles.yaml
- staff-reviewer-feedbackdigests.yaml
7 changes: 7 additions & 0 deletions config/milo/bindings/security-team-group.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Members are added with GroupMemberships. Keep it to the people who handle
# vulnerability reports: membership grants every report's contents.
apiVersion: iam.miloapis.com/v1alpha1
kind: Group
metadata:
name: feedback-security-team
namespace: milo-system
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
apiVersion: iam.miloapis.com/v1alpha1
kind: PolicyBinding
metadata:
name: feedback-security-team-securityacknowledgements
namespace: milo-system
spec:
roleRef:
name: feedback.miloapis.com-security-team
namespace: milo-system
subjects:
- kind: Group
name: feedback-security-team
namespace: milo-system
resourceSelector:
resourceKind:
apiGroup: feedback.miloapis.com
kind: SecurityAcknowledgement
17 changes: 17 additions & 0 deletions config/milo/bindings/security-team-securityreports.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
apiVersion: iam.miloapis.com/v1alpha1
kind: PolicyBinding
metadata:
name: feedback-security-team-securityreports
namespace: milo-system
spec:
roleRef:
name: feedback.miloapis.com-security-team
namespace: milo-system
subjects:
- kind: Group
name: feedback-security-team
namespace: milo-system
resourceSelector:
resourceKind:
apiGroup: feedback.miloapis.com
kind: SecurityReport
17 changes: 17 additions & 0 deletions config/milo/bindings/security-team-securityreporttriages.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
apiVersion: iam.miloapis.com/v1alpha1
kind: PolicyBinding
metadata:
name: feedback-security-team-securityreporttriages
namespace: milo-system
spec:
roleRef:
name: feedback.miloapis.com-security-team
namespace: milo-system
subjects:
- kind: Group
name: feedback-security-team
namespace: milo-system
resourceSelector:
resourceKind:
apiGroup: feedback.miloapis.com
kind: SecurityReportTriage
17 changes: 17 additions & 0 deletions config/milo/bindings/staff-reviewer-changelogentries.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
apiVersion: iam.miloapis.com/v1alpha1
kind: PolicyBinding
metadata:
name: feedback-staff-reviewer-changelogentries
namespace: milo-system
spec:
roleRef:
name: feedback.miloapis.com-reviewer
namespace: milo-system
subjects:
- kind: Group
name: staff-users
namespace: milo-system
resourceSelector:
resourceKind:
apiGroup: feedback.miloapis.com
kind: ChangelogEntry
17 changes: 17 additions & 0 deletions config/milo/bindings/staff-reviewer-feedbackdigests.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
apiVersion: iam.miloapis.com/v1alpha1
kind: PolicyBinding
metadata:
name: feedback-staff-reviewer-feedbackdigests
namespace: milo-system
spec:
roleRef:
name: feedback.miloapis.com-reviewer
namespace: milo-system
subjects:
- kind: Group
name: staff-users
namespace: milo-system
resourceSelector:
resourceKind:
apiGroup: feedback.miloapis.com
kind: FeedbackDigest
17 changes: 17 additions & 0 deletions config/milo/bindings/staff-reviewer-feedbackprofiles.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
apiVersion: iam.miloapis.com/v1alpha1
kind: PolicyBinding
metadata:
name: feedback-staff-reviewer-feedbackprofiles
namespace: milo-system
spec:
roleRef:
name: feedback.miloapis.com-reviewer
namespace: milo-system
subjects:
- kind: Group
name: staff-users
namespace: milo-system
resourceSelector:
resourceKind:
apiGroup: feedback.miloapis.com
kind: FeedbackProfile
17 changes: 17 additions & 0 deletions config/milo/bindings/staff-reviewer-feedbacksources.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
apiVersion: iam.miloapis.com/v1alpha1
kind: PolicyBinding
metadata:
name: feedback-staff-reviewer-feedbacksources
namespace: milo-system
spec:
roleRef:
name: feedback.miloapis.com-reviewer
namespace: milo-system
subjects:
- kind: Group
name: staff-users
namespace: milo-system
resourceSelector:
resourceKind:
apiGroup: feedback.miloapis.com
kind: FeedbackSource
17 changes: 17 additions & 0 deletions config/milo/bindings/staff-reviewer-posts.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
apiVersion: iam.miloapis.com/v1alpha1
kind: PolicyBinding
metadata:
name: feedback-staff-reviewer-posts
namespace: milo-system
spec:
roleRef:
name: feedback.miloapis.com-reviewer
namespace: milo-system
subjects:
- kind: Group
name: staff-users
namespace: milo-system
resourceSelector:
resourceKind:
apiGroup: feedback.miloapis.com
kind: Post
17 changes: 17 additions & 0 deletions config/milo/bindings/staff-reviewer-releases.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
apiVersion: iam.miloapis.com/v1alpha1
kind: PolicyBinding
metadata:
name: feedback-staff-reviewer-releases
namespace: milo-system
spec:
roleRef:
name: feedback.miloapis.com-reviewer
namespace: milo-system
subjects:
- kind: Group
name: staff-users
namespace: milo-system
resourceSelector:
resourceKind:
apiGroup: feedback.miloapis.com
kind: Release
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
apiVersion: iam.miloapis.com/v1alpha1
kind: PolicyBinding
metadata:
name: feedback-staff-reviewer-securityacknowledgements
namespace: milo-system
spec:
roleRef:
name: feedback.miloapis.com-reviewer
namespace: milo-system
subjects:
- kind: Group
name: staff-users
namespace: milo-system
resourceSelector:
resourceKind:
apiGroup: feedback.miloapis.com
kind: SecurityAcknowledgement
17 changes: 17 additions & 0 deletions config/milo/bindings/staff-reviewer-submissionreviews.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
apiVersion: iam.miloapis.com/v1alpha1
kind: PolicyBinding
metadata:
name: feedback-staff-reviewer-submissionreviews
namespace: milo-system
spec:
roleRef:
name: feedback.miloapis.com-reviewer
namespace: milo-system
subjects:
- kind: Group
name: staff-users
namespace: milo-system
resourceSelector:
resourceKind:
apiGroup: feedback.miloapis.com
kind: SubmissionReview
17 changes: 17 additions & 0 deletions config/milo/bindings/staff-reviewer-submissions.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
apiVersion: iam.miloapis.com/v1alpha1
kind: PolicyBinding
metadata:
name: feedback-staff-reviewer-submissions
namespace: milo-system
spec:
roleRef:
name: feedback.miloapis.com-reviewer
namespace: milo-system
subjects:
- kind: Group
name: staff-users
namespace: milo-system
resourceSelector:
resourceKind:
apiGroup: feedback.miloapis.com
kind: Submission
17 changes: 17 additions & 0 deletions config/milo/bindings/staff-reviewer-subscriptions.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
apiVersion: iam.miloapis.com/v1alpha1
kind: PolicyBinding
metadata:
name: feedback-staff-reviewer-subscriptions
namespace: milo-system
spec:
roleRef:
name: feedback.miloapis.com-reviewer
namespace: milo-system
subjects:
- kind: Group
name: staff-users
namespace: milo-system
resourceSelector:
resourceKind:
apiGroup: feedback.miloapis.com
kind: Subscription
17 changes: 17 additions & 0 deletions config/milo/bindings/staff-reviewer-votes.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
apiVersion: iam.miloapis.com/v1alpha1
kind: PolicyBinding
metadata:
name: feedback-staff-reviewer-votes
namespace: milo-system
spec:
roleRef:
name: feedback.miloapis.com-reviewer
namespace: milo-system
subjects:
- kind: Group
name: staff-users
namespace: milo-system
resourceSelector:
resourceKind:
apiGroup: feedback.miloapis.com
kind: Vote
27 changes: 27 additions & 0 deletions config/milo/iam/resources/changelogentries.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
apiVersion: iam.miloapis.com/v1alpha1
kind: ProtectedResource
metadata:
name: feedback.miloapis.com-changelogentries
spec:
serviceRef:
name: "feedback.miloapis.com"
kind: ChangelogEntry
plural: changelogentries
singular: changelogentry
subresources:
- name: status
permissions:
- get
- update
- patch
permissions:
- get
- list
- watch
- create
- update
- patch
- delete
parentResources:
- apiGroup: iam.miloapis.com
kind: User
Loading
Loading