Skip to content

NET-5947 Add NET_BIND_SERVICE capability in security context for api-gateway pod on OpenShift #3070

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nathancoleman merged 6 commits into from
Oct 12, 2023
Merged

NET-5947 Add NET_BIND_SERVICE capability in security context for api-gateway pod on OpenShift #3070

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fce8305
Add NET_BIND_SERVICE capability in security context for api-gateway p…
nathancoleman Oct 11, 2023
27fe808
Add changelog entry
nathancoleman Oct 11, 2023
c0fbca9
Use proper casing for ALL capabilities constant
nathancoleman Oct 12, 2023
ba8bac4
Add test assertion verifying security context is set for every api-ga…
nathancoleman Oct 12, 2023
9d427b8
Update .changelog/3070.txt
nathancoleman Oct 12, 2023
1b639af
Update 3070.txt
nathancoleman Oct 12, 2023
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
3 changes: 3 additions & 0 deletions .changelog/3070.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:bug
api-gateway: fix issue where missing `NET_BIND_SERVICE` capability prevented api-gateway `Pod` from starting up when deployed to OpenShift
```
30 changes: 13 additions & 17 deletions control-plane/api-gateway/gatekeeper/dataplane.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,8 @@ import (
"strconv"

corev1 "k8s.io/api/core/v1"
"k8s.io/utils/pointer"

"k8s.io/apimachinery/pkg/util/intstr"
"k8s.io/utils/pointer"

"github.com/hashicorp/consul-k8s/control-plane/api-gateway/common"
"github.com/hashicorp/consul-k8s/control-plane/api/v1alpha1"
Expand All @@ -19,7 +18,7 @@ import (
)

const (
allCapabilities = "all"
allCapabilities = "ALL"
Copy link
Copy Markdown
Member Author

@nathancoleman nathancoleman Oct 12, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was causing an odd merge when the OpenShift controller added ALL alongside our all since they're not equal strings, resulting in

drop:
- ALL
- all

Copy link
Copy Markdown
Contributor

@missylbytes missylbytes Oct 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed:
image

netBindCapability = "NET_BIND_SERVICE"
consulDataplaneDNSBindHost = "127.0.0.1"
consulDataplaneDNSBindPort = 8600
Expand Down Expand Up @@ -106,21 +105,18 @@ func consulDataplaneContainer(config common.HelmConfig, gcc v1alpha1.GatewayClas
container.Resources = *gcc.Spec.DeploymentSpec.Resources
}

// If not running in an OpenShift environment,
// skip setting the security context and let OpenShift set it for us.
// If running in vanilla K8s, run as root to allow binding to privileged ports;
// otherwise, allow the user to be assigned by OpenShift.
container.SecurityContext = &corev1.SecurityContext{
ReadOnlyRootFilesystem: pointer.Bool(true),
// Drop any Linux capabilities you'd get as root other than NET_BIND_SERVICE.
Capabilities: &corev1.Capabilities{
Add: []corev1.Capability{netBindCapability},
Drop: []corev1.Capability{allCapabilities},
},
}
if !config.EnableOpenShift {
container.SecurityContext = &corev1.SecurityContext{
ReadOnlyRootFilesystem: pointer.Bool(true),
// We have to run as root if we want to bind to any
// sort of privileged ports. The drop "all" is intended
// to drop any Linux capabilities you'd get as root
// other than NET_BIND_SERVICE.
RunAsUser: pointer.Int64(0),
Capabilities: &corev1.Capabilities{
Add: []corev1.Capability{netBindCapability},
Drop: []corev1.Capability{allCapabilities},
},
}
container.SecurityContext.RunAsUser = pointer.Int64(0)
}

return container, nil
Expand Down
80 changes: 63 additions & 17 deletions control-plane/api-gateway/gatekeeper/gatekeeper_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ import (
"testing"

logrtest "github.com/go-logr/logr/testr"
common "github.com/hashicorp/consul-k8s/control-plane/api-gateway/common"
"github.com/hashicorp/consul-k8s/control-plane/api/v1alpha1"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
Expand All @@ -23,11 +22,15 @@ import (
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/client/fake"
gwv1beta1 "sigs.k8s.io/gateway-api/apis/v1beta1"

"github.com/hashicorp/consul-k8s/control-plane/api-gateway/common"
"github.com/hashicorp/consul-k8s/control-plane/api/v1alpha1"
)

var (
createdAtLabelKey = "gateway.consul.hashicorp.com/created"
createdAtLabelValue = "101010"
dataplaneImage = "hashicorp/consul-dataplane"
name = "test"
namespace = "default"
labels = map[string]string{
Expand Down Expand Up @@ -102,7 +105,9 @@ func TestUpsert(t *testing.T) {
ServiceType: (*corev1.ServiceType)(common.PointerTo("NodePort")),
},
},
helmConfig: common.HelmConfig{},
helmConfig: common.HelmConfig{
ImageDataplane: dataplaneImage,
},
initialResources: resources{},
finalResources: resources{
deployments: []*appsv1.Deployment{
Expand Down Expand Up @@ -149,7 +154,9 @@ func TestUpsert(t *testing.T) {
MapPrivilegedContainerPorts: 2000,
},
},
helmConfig: common.HelmConfig{},
helmConfig: common.HelmConfig{
ImageDataplane: dataplaneImage,
},
initialResources: resources{},
finalResources: resources{
deployments: []*appsv1.Deployment{
Expand Down Expand Up @@ -199,7 +206,9 @@ func TestUpsert(t *testing.T) {
ServiceType: (*corev1.ServiceType)(common.PointerTo("NodePort")),
},
},
helmConfig: common.HelmConfig{},
helmConfig: common.HelmConfig{
ImageDataplane: dataplaneImage,
},
initialResources: resources{},
finalResources: resources{
deployments: []*appsv1.Deployment{
Expand Down Expand Up @@ -250,7 +259,8 @@ func TestUpsert(t *testing.T) {
},
},
helmConfig: common.HelmConfig{
AuthMethod: "method",
AuthMethod: "method",
ImageDataplane: dataplaneImage,
},
initialResources: resources{},
finalResources: resources{
Expand Down Expand Up @@ -308,7 +318,9 @@ func TestUpsert(t *testing.T) {
ServiceType: (*corev1.ServiceType)(common.PointerTo("NodePort")),
},
},
helmConfig: common.HelmConfig{},
helmConfig: common.HelmConfig{
ImageDataplane: dataplaneImage,
},
initialResources: resources{},
finalResources: resources{
deployments: []*appsv1.Deployment{
Expand Down Expand Up @@ -343,7 +355,9 @@ func TestUpsert(t *testing.T) {
ServiceType: (*corev1.ServiceType)(common.PointerTo("NodePort")),
},
},
helmConfig: common.HelmConfig{},
helmConfig: common.HelmConfig{
ImageDataplane: dataplaneImage,
},
initialResources: resources{},
finalResources: resources{
deployments: []*appsv1.Deployment{
Expand Down Expand Up @@ -379,7 +393,8 @@ func TestUpsert(t *testing.T) {
},
},
helmConfig: common.HelmConfig{
AuthMethod: "method",
AuthMethod: "method",
ImageDataplane: dataplaneImage,
},
initialResources: resources{
deployments: []*appsv1.Deployment{
Expand Down Expand Up @@ -462,7 +477,8 @@ func TestUpsert(t *testing.T) {
},
},
helmConfig: common.HelmConfig{
AuthMethod: "method",
AuthMethod: "method",
ImageDataplane: dataplaneImage,
},
initialResources: resources{
deployments: []*appsv1.Deployment{
Expand Down Expand Up @@ -541,7 +557,9 @@ func TestUpsert(t *testing.T) {
ServiceType: (*corev1.ServiceType)(common.PointerTo("NodePort")),
},
},
helmConfig: common.HelmConfig{},
helmConfig: common.HelmConfig{
ImageDataplane: dataplaneImage,
},
initialResources: resources{
deployments: []*appsv1.Deployment{
configureDeployment(name, namespace, labels, 5, nil, nil, "", "1"),
Expand Down Expand Up @@ -580,7 +598,9 @@ func TestUpsert(t *testing.T) {
ServiceType: (*corev1.ServiceType)(common.PointerTo("NodePort")),
},
},
helmConfig: common.HelmConfig{},
helmConfig: common.HelmConfig{
ImageDataplane: dataplaneImage,
},
initialResources: resources{
deployments: []*appsv1.Deployment{
configureDeployment(name, namespace, labels, 8, nil, nil, "", "1"),
Expand Down Expand Up @@ -619,7 +639,9 @@ func TestUpsert(t *testing.T) {
ServiceType: (*corev1.ServiceType)(common.PointerTo("NodePort")),
},
},
helmConfig: common.HelmConfig{},
helmConfig: common.HelmConfig{
ImageDataplane: dataplaneImage,
},
initialResources: resources{
deployments: []*appsv1.Deployment{
configureDeployment(name, namespace, labels, 1, nil, nil, "", "1"),
Expand Down Expand Up @@ -658,7 +680,9 @@ func TestUpsert(t *testing.T) {
ServiceType: (*corev1.ServiceType)(common.PointerTo("NodePort")),
},
},
helmConfig: common.HelmConfig{},
helmConfig: common.HelmConfig{
ImageDataplane: dataplaneImage,
},
initialResources: resources{
deployments: []*appsv1.Deployment{
configureDeployment(name, namespace, labels, 10, nil, nil, "", "1"),
Expand Down Expand Up @@ -699,6 +723,7 @@ func TestUpsert(t *testing.T) {
},
helmConfig: common.HelmConfig{
EnableOpenShift: true,
ImageDataplane: "hashicorp/consul-dataplane",
},
initialResources: resources{},
finalResources: resources{
Expand Down Expand Up @@ -770,7 +795,9 @@ func TestDelete(t *testing.T) {
ServiceType: (*corev1.ServiceType)(common.PointerTo("NodePort")),
},
},
helmConfig: common.HelmConfig{},
helmConfig: common.HelmConfig{
ImageDataplane: dataplaneImage,
},
initialResources: resources{
deployments: []*appsv1.Deployment{
configureDeployment(name, namespace, labels, 3, nil, nil, "", "1"),
Expand Down Expand Up @@ -807,7 +834,9 @@ func TestDelete(t *testing.T) {
ServiceType: (*corev1.ServiceType)(common.PointerTo("NodePort")),
},
},
helmConfig: common.HelmConfig{},
helmConfig: common.HelmConfig{
ImageDataplane: dataplaneImage,
},
initialResources: resources{
deployments: []*appsv1.Deployment{
configureDeployment(name, namespace, labels, 3, nil, nil, "", "1"),
Expand Down Expand Up @@ -861,7 +890,8 @@ func TestDelete(t *testing.T) {
},
},
helmConfig: common.HelmConfig{
AuthMethod: "method",
AuthMethod: "method",
ImageDataplane: dataplaneImage,
},
initialResources: resources{
deployments: []*appsv1.Deployment{
Expand Down Expand Up @@ -977,6 +1007,22 @@ func validateResourcesExist(t *testing.T, client client.Client, resources resour
require.NotNil(t, actual.Spec.Replicas)
require.EqualValues(t, *expected.Spec.Replicas, *actual.Spec.Replicas)
}

// Ensure there is a consul-dataplane container dropping ALL capabilities, adding
// back the NET_BIND_SERVICE capability, and establishing a read-only root filesystem
hasDataplaneContainer := false
for _, container := range actual.Spec.Template.Spec.Containers {
if container.Image == dataplaneImage {
hasDataplaneContainer = true
require.NotNil(t, container.SecurityContext)
require.NotNil(t, container.SecurityContext.Capabilities)
require.NotNil(t, container.SecurityContext.ReadOnlyRootFilesystem)
assert.True(t, *container.SecurityContext.ReadOnlyRootFilesystem)
assert.Equal(t, []corev1.Capability{netBindCapability}, container.SecurityContext.Capabilities.Add)
assert.Equal(t, []corev1.Capability{allCapabilities}, container.SecurityContext.Capabilities.Drop)
}
}
assert.True(t, hasDataplaneContainer)
}

for _, expected := range resources.roles {
Expand Down