Skip to content
Open
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
7 changes: 5 additions & 2 deletions chart/templates/secrets/jwt-secret.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,13 @@ metadata:
{{- with .Values.labels }}
{{- toYaml . | nindent 4 }}
{{- end }}
{{- with .Values.jwtSecretAnnotations }}
annotations:
"helm.sh/hook": "pre-install"
"helm.sh/hook-delete-policy": "before-hook-creation"
"helm.sh/hook-weight": "0"
Comment on lines +39 to +41
Copy link
Contributor

Choose a reason for hiding this comment

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

After some time I think that we could go with the Helm lookup function to determine if it exists or not

Copy link
Member

Choose a reason for hiding this comment

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

I don't recall exactly why, but I have in my mind that there is some funkiness with helm lookup that makes it not great for our needs. But maybe in some of these cases, it's better than nothing?

{{- with .Values.jwtSecretAnnotations }}
{{- toYaml . | nindent 4 }}
{{- end }}
{{- end }}
type: Opaque
data:
jwt-secret: {{ (.Values.jwtSecret) | default (randAlphaNum 32) | b64enc | quote }}
Expand Down
52 changes: 52 additions & 0 deletions helm-tests/tests/helm_tests/security/test_jwt_secret.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
from __future__ import annotations

import base64

import jmespath
from chart_utils.helm_template_generator import render_chart


class TestJwtSecret:
"""Tests jwt secret."""

def test_should_add_annotations_to_jwt_secret(self):
"""Test that annotations are properly added to JWT secret and the secret is correctly encoded.

This test verifies that:
1. Custom annotations can be added to the JWT secret
2. The JWT secret is properly base64 encoded in the template
3. The decoded secret matches the input value
"""
# Create JWT secret with custom annotation
docs = render_chart(
values={
"jwtSecret": "verysecret",
"jwtSecretAnnotations": {"test_annotation": "test_annotation_value"},
},
show_only=["templates/secrets/jwt-secret.yaml"],
)[0]
assert "annotations" in jmespath.search("metadata", docs)
assert jmespath.search("metadata.annotations", docs)["test_annotation"] == "test_annotation_value"

# Extract and decode the JWT secret
jwt_secret_b64 = jmespath.search('data."jwt-secret"', docs).strip('"')
jwt_secret = base64.b64decode(jwt_secret_b64).decode()

# Verify the decoded secret matches original input
assert jwt_secret == "verysecret"
Loading