Skip to content

fix(bank-transfer): correct encryption key env var names #1168

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
ferr3ira-gabriel merged 1 commit into from
Apr 2, 2026
+13 −11
Merged

fix(bank-transfer): correct encryption key env var names #1168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions charts/plugin-br-bank-transfer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,8 +188,8 @@ Key secrets configured via `bankTransfer.secrets`:
| `REDIS_PASSWORD` | Redis/Valkey password |
| `MONGO_PASSWORD` | MongoDB password |
| `MONGO_URI` | MongoDB connection URI (auto-generated if not provided) |
| `JD_INCOMING_RAW_XML_ENCRYPTION_KEY_BASE64` | Encryption key (32-byte base64) |
| `RECIPIENT_DETAILS_ENCRYPTION_KEY_BASE64` | Encryption key (32-byte base64) |
| `JD_INCOMING_RAW_XML_ENCRYPTION_KEY` | Encryption key (hex-encoded 32-byte AES-256, 64 hex chars) |
| `RECIPIENT_DETAILS_ENCRYPTION_KEY` | Encryption key (hex-encoded 32-byte AES-256, 64 hex chars) |
| `JD_WEBHOOK_NOTIFICATION_RAW_XML_DECRYPTION_KEY_BASE64` | Decryption key (32-byte base64) |
Comment on lines +191 to 193
Copy link
Copy Markdown

@coderabbitai coderabbitai bot Apr 2, 2026

Choose a reason for hiding this comment

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

🧹 Nitpick | 🔵 Trivial

Consider adding upgrade/migration notes for this breaking change.

The documentation correctly reflects the renamed variables and hex-encoding format. However, since the PR summary indicates this is a breaking change requiring users to rename their values and convert from base64 to hex encoding, consider adding a brief "Upgrading" or "Migration Notes" section documenting:

  • The renamed values (*_BASE64 → non-suffixed)
  • The encoding change (base64 → hex-encoded 64-character string)

This would help users upgrading from previous chart versions.

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@charts/plugin-br-bank-transfer/README.md` around lines 191 - 193, Add a new
"Upgrading" or "Migration Notes" section to the README that documents the
breaking change: list the environment variable renames (e.g.,
JD_WEBHOOK_NOTIFICATION_RAW_XML_DECRYPTION_KEY_BASE64 →
JD_WEBHOOK_NOTIFICATION_RAW_XML_DECRYPTION_KEY, RECIPIENT_DETAILS_ENCRYPTION_KEY
and JD_INCOMING_RAW_XML_ENCRYPTION_KEY name changes if applicable), and clearly
state the encoding change from base64 to hex (32-byte AES-256 key must now be
hex-encoded as 64 hex characters). Provide a short migration recipe: how to
convert an existing base64 key to a hex string (one-line guidance) and instruct
users to rename the variables in their values/Secrets; reference the exact
variable names shown in the diff (JD_INCOMING_RAW_XML_ENCRYPTION_KEY,
RECIPIENT_DETAILS_ENCRYPTION_KEY,
JD_WEBHOOK_NOTIFICATION_RAW_XML_DECRYPTION_KEY_BASE64) so users can find and
update them.


---
Expand Down
8 changes: 5 additions & 3 deletions charts/plugin-br-bank-transfer/templates/secrets.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,11 @@ stringData:
JD_PRIVATE_KEY_PEM: {{ .Values.bankTransfer.secrets.JD_PRIVATE_KEY_PEM | quote }}
{{- end }}

# Encryption Keys (32-byte base64 encoded)
JD_INCOMING_RAW_XML_ENCRYPTION_KEY_BASE64: {{ required "bankTransfer.secrets.JD_INCOMING_RAW_XML_ENCRYPTION_KEY_BASE64 is required" .Values.bankTransfer.secrets.JD_INCOMING_RAW_XML_ENCRYPTION_KEY_BASE64 | quote }}
RECIPIENT_DETAILS_ENCRYPTION_KEY_BASE64: {{ required "bankTransfer.secrets.RECIPIENT_DETAILS_ENCRYPTION_KEY_BASE64 is required" .Values.bankTransfer.secrets.RECIPIENT_DETAILS_ENCRYPTION_KEY_BASE64 | quote }}
# Encryption Keys
# The application expects hex-encoded 32-byte AES-256 keys (64 hex characters).
# Values.bankTransfer.secrets should provide hex-encoded keys directly.
JD_INCOMING_RAW_XML_ENCRYPTION_KEY: {{ required "bankTransfer.secrets.JD_INCOMING_RAW_XML_ENCRYPTION_KEY is required" .Values.bankTransfer.secrets.JD_INCOMING_RAW_XML_ENCRYPTION_KEY | quote }}
RECIPIENT_DETAILS_ENCRYPTION_KEY: {{ required "bankTransfer.secrets.RECIPIENT_DETAILS_ENCRYPTION_KEY is required" .Values.bankTransfer.secrets.RECIPIENT_DETAILS_ENCRYPTION_KEY | quote }}

# Midaz M2M Credentials (optional)
{{- if .Values.bankTransfer.secrets.MIDAZ_CLIENT_ID }}
Expand Down
6 changes: 3 additions & 3 deletions charts/plugin-br-bank-transfer/values-template.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,9 +202,9 @@ bankTransfer:
# JD_PASSWORD: ""
# JD_PRIVATE_KEY_PEM: ""

# Encryption Keys - REQUIRED (32-byte base64 encoded)
JD_INCOMING_RAW_XML_ENCRYPTION_KEY_BASE64: "" # REQUIRED
RECIPIENT_DETAILS_ENCRYPTION_KEY_BASE64: "" # REQUIRED
# Encryption Keys - REQUIRED (hex-encoded 32-byte AES-256 keys, 64 hex characters)
JD_INCOMING_RAW_XML_ENCRYPTION_KEY: "" # REQUIRED
RECIPIENT_DETAILS_ENCRYPTION_KEY: "" # REQUIRED

# Midaz M2M Credentials (if MIDAZ_AUTH_ENABLED=true)
# MIDAZ_CLIENT_ID: ""
Expand Down
6 changes: 3 additions & 3 deletions charts/plugin-br-bank-transfer/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,9 +360,9 @@ bankTransfer:
# JD_PASSWORD: ""
# JD_PRIVATE_KEY_PEM: ""

# Encryption Keys (REQUIRED - 32-byte base64 encoded)
JD_INCOMING_RAW_XML_ENCRYPTION_KEY_BASE64: ""
RECIPIENT_DETAILS_ENCRYPTION_KEY_BASE64: ""
# Encryption Keys (REQUIRED - hex-encoded 32-byte AES-256 keys, 64 hex characters)
JD_INCOMING_RAW_XML_ENCRYPTION_KEY: ""
RECIPIENT_DETAILS_ENCRYPTION_KEY: ""
# Midaz M2M Credentials (optional)
# MIDAZ_CLIENT_ID: ""
# MIDAZ_CLIENT_SECRET: ""
Expand Down
Loading