-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat!: allow configurability of SSH and harden application settings (#…
…196) ## Description This PR disables SSH more fully by default but adds an option to reconfigure it later - it also adds a way to harden specific settings in GitLab declaratively. > [!IMPORTANT] >⚠️ BREAKING CHANGE - this is a breaking change as it will force hardened settings on the end user unless the settingsJob is disabled or reconfigured. ## Related Issue Fixes #189 Fixes #190 ## Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [X] New feature (non-breaking change which adds functionality) - [ ] Other (security config, docs update, etc) ## Checklist before merging - [X] Test, docs, adr added or updated as needed - [X] [Contributor Guide Steps](https://github.com/defenseunicorns/uds-package-gitlab/blob/main/CONTRIBUTING.md#developer-workflow) followed Release-As: v17.2.7-uds.1
- Loading branch information
Showing
38 changed files
with
454 additions
and
73 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| {{- if .Values.ssh.enabled }} | ||
| apiVersion: networking.istio.io/v1beta1 | ||
| kind: Gateway | ||
| metadata: | ||
| name: gitlab-ssh-gateway | ||
| namespace: istio-tenant-gateway | ||
| spec: | ||
| selector: | ||
| app: tenant-ingressgateway | ||
| servers: | ||
| - hosts: | ||
| - gitlab.{{ .Values.domain }} | ||
| port: | ||
| name: tcp-ssh | ||
| number: {{ .Values.ssh.port }} | ||
| protocol: TCP | ||
| {{- end }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| {{- if .Values.ssh.enabled }} | ||
| apiVersion: networking.istio.io/v1beta1 | ||
| kind: VirtualService | ||
| metadata: | ||
| name: gitlab-ssh | ||
| namespace: {{ .Release.Namespace }} | ||
| spec: | ||
| gateways: | ||
| - istio-tenant-gateway/gitlab-ssh-gateway | ||
| hosts: | ||
| - gitlab.{{ .Values.domain }} | ||
| tcp: | ||
| - match: | ||
| - port: {{ .Values.ssh.port }} | ||
| route: | ||
| - destination: | ||
| host: gitlab-gitlab-shell.gitlab.svc.cluster.local | ||
| port: | ||
| number: {{ .Values.ssh.port }} | ||
| {{- end }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,9 @@ | ||
| domain: "###ZARF_VAR_DOMAIN###" | ||
|
|
||
| ssh: | ||
| enabled: false | ||
| port: 2222 | ||
|
|
||
| sso: | ||
| enabled: true | ||
| protocol: saml | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # Patterns to ignore when building packages. | ||
| # This supports shell glob matching, relative path matching, and | ||
| # negation (prefixed with !). Only one pattern per line. | ||
| .DS_Store | ||
| # Common VCS dirs | ||
| .git/ | ||
| .gitignore | ||
| .bzr/ | ||
| .bzrignore | ||
| .hg/ | ||
| .hgignore | ||
| .svn/ | ||
| # Common backup files | ||
| *.swp | ||
| *.bak | ||
| *.tmp | ||
| *.orig | ||
| *~ | ||
| # Various IDEs | ||
| .project | ||
| .idea/ | ||
| *.tmproj | ||
| .vscode/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| apiVersion: v2 | ||
| name: uds-gitlab-settings | ||
| description: uds-gitlab-settings | ||
|
|
||
| # A chart can be either an 'application' or a 'library' chart. | ||
| # | ||
| # Application charts are a collection of templates that can be packaged into versioned archives | ||
| # to be deployed. | ||
| # | ||
| # Library charts provide useful utilities or functions for the chart developer. They're included as | ||
| # a dependency of application charts to inject those utilities and functions into the rendering | ||
| # pipeline. Library charts do not define any templates and therefore cannot be deployed. | ||
| type: application | ||
|
|
||
| # This is the chart version. This version number should be incremented each time you make changes | ||
| # to the chart and its templates, including the app version. | ||
| # Versions are expected to follow Semantic Versioning (https://semver.org/) | ||
| version: 0.1.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| # Reusable Pod spec for settings jobs | ||
| {{- define "uds-gitlab-settings.settings-pod" }} | ||
| metadata: | ||
| labels: | ||
| app: gitlab | ||
| spec: | ||
| serviceAccountName: gitlab-settings-sa | ||
| containers: | ||
| - name: gitlab-settings | ||
| image: "{{ .Values.global.kubectl.image.repository }}:{{ .Values.global.kubectl.image.tag }}" | ||
| command: ["/bin/sh", "-c"] | ||
| args: | ||
| - | | ||
| # Read the JSON file from the mounted application settings secret | ||
| SETTINGS=$(cat /etc/gitlab-settings/application.json) | ||
|
|
||
| # Dynamically parse each key-value pair in the JSON using yq and construct query parameters | ||
| QUERY_PARAMS=$(echo $SETTINGS | yq e 'to_entries | map("\(.key)=\(.value)") | join("&")' -) | ||
|
|
||
| # Generate and capture a GitLab token from the GitLab Toolbox Rails Console | ||
| TOKEN=$(kubectl exec -n gitlab deployment/gitlab-toolbox -- \ | ||
| gitlab-rails runner -e production \ | ||
| "random_token = SecureRandom.hex(32); token = User.find_by_username('root').personal_access_tokens.create(scopes: ['api', 'admin_mode'], name: 'Application Settings Token', expires_at: 1.days.from_now); token.set_token(random_token); token.save!; puts random_token" | tail -n 1) | ||
|
|
||
| # Use the generated token to set GitLab settings | ||
| kubectl exec -n gitlab deployment/gitlab-toolbox -- \ | ||
| curl --request PUT --header "PRIVATE-TOKEN: $TOKEN" \ | ||
| "http://gitlab-webservice-default.gitlab.svc.cluster.local:8181/api/v4/application/settings?$QUERY_PARAMS" | ||
|
|
||
| # Revoke the token after use | ||
| kubectl exec -n gitlab deployment/gitlab-toolbox -- \ | ||
| gitlab-rails runner -e production \ | ||
| "token = PersonalAccessToken.find_by_token('$TOKEN'); token.revoke!" | ||
| volumeMounts: | ||
| - name: gitlab-settings-volume | ||
| mountPath: /etc/gitlab-settings | ||
| readOnly: true | ||
| restartPolicy: OnFailure | ||
| volumes: | ||
| - name: gitlab-settings-volume | ||
| secret: | ||
| secretName: gitlab-settings-secret | ||
| {{- end }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| {{- if .Values.settingsJob.enabled }} | ||
| apiVersion: v1 | ||
| kind: ServiceAccount | ||
| metadata: | ||
| name: gitlab-settings-sa | ||
| namespace: {{ .Release.Namespace }} | ||
| --- | ||
| apiVersion: rbac.authorization.k8s.io/v1 | ||
| kind: Role | ||
| metadata: | ||
| name: gitlab-settings-role | ||
| namespace: {{ .Release.Namespace }} | ||
| rules: | ||
| # Only allow exec into the toolbox pod | ||
| - apiGroups: [""] | ||
| resources: ["pods/exec"] | ||
| verbs: ["create"] | ||
| - apiGroups: [""] | ||
| resources: ["pods"] | ||
| verbs: ["list"] | ||
| - apiGroups: ["apps"] | ||
| resources: ["deployments"] | ||
| verbs: ["get"] | ||
| resourceNames: | ||
| - gitlab-toolbox | ||
| --- | ||
| apiVersion: rbac.authorization.k8s.io/v1 | ||
| kind: RoleBinding | ||
| metadata: | ||
| name: gitlab-settings-rolebinding | ||
| namespace: {{ .Release.Namespace }} | ||
| subjects: | ||
| - kind: ServiceAccount | ||
| name: gitlab-settings-sa | ||
| namespace: {{ .Release.Namespace }} | ||
| roleRef: | ||
| kind: Role | ||
| name: gitlab-settings-role | ||
| apiGroup: rbac.authorization.k8s.io | ||
| {{- end }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| {{- if .Values.settingsJob.enabled }} | ||
| # CronJob to reapply settings on schedule | ||
| apiVersion: batch/v1 | ||
| kind: CronJob | ||
| metadata: | ||
| name: gitlab-settings-cronjob | ||
| namespace: {{ .Release.Namespace }} | ||
| spec: | ||
| schedule: "{{ .Values.settingsJob.schedule }}" | ||
| successfulJobsHistoryLimit: 1 | ||
| failedJobsHistoryLimit: 1 | ||
| jobTemplate: | ||
| spec: | ||
| ttlSecondsAfterFinished: 30 | ||
| template: | ||
| {{ include "uds-gitlab-settings.settings-pod" . | indent 8 }} | ||
| {{- end }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| {{- if .Values.settingsJob.enabled }} | ||
| # Job to apply settings immediately on deployment | ||
| apiVersion: batch/v1 | ||
| kind: Job | ||
| metadata: | ||
| name: gitlab-settings-job | ||
| namespace: {{ .Release.Namespace }} | ||
| spec: | ||
| ttlSecondsAfterFinished: 30 | ||
| template: | ||
| {{ include "uds-gitlab-settings.settings-pod" . | indent 4 }} | ||
| {{- end }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| {{- if .Values.settingsJob.enabled }} | ||
| apiVersion: v1 | ||
| kind: Secret | ||
| metadata: | ||
| name: gitlab-settings-secret | ||
| namespace: gitlab | ||
| type: Opaque | ||
| stringData: | ||
| application.json: {{ .Values.settingsJob.application | toJson | quote }} | ||
| {{- end }} |
Oops, something went wrong.