Always show error message returned by NetHSM #140
Merged
Conversation
This file contains hidden or 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
ansiwen
reviewed
Oct 9, 2025
nethsm/__init__.py
Outdated
| body = json.loads(e.api_response.response.data) | ||
| if body is not None and "message" in body: | ||
| message += "\n" + body["message"] | ||
| message += "\nNetHSM error message: " + body["message"] |
There was a problem hiding this comment.
Did you check in the NetHSM code, that it always uses a "message" field? Otherwise I maybe would just dump the whole body.
There was a problem hiding this comment.
I did not perform an exhaustive search but I’ve never seen a case where it returned something else.
There was a problem hiding this comment.
I checked, and in fact we only return the error JSON for "400 Bad request" and for "412 Precondition Failed", however in the second case without useful information. And in these cases it is always of that format. So all good.
Merged
daringer
approved these changes
Oct 15, 2025
Previously, we only showed the custom error message for the returned error code if there is one. This can be confusing if the custom error message does not match the error returned by the NetHSM. This patch always adds the NetHSM error message to the error returned by the API.
robin-nitrokey
had a problem deploying
to
testpypi
GitHub Actions
Failure
robin-nitrokey
temporarily deployed
to
testpypi
GitHub Actions
Inactive
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously, we only showed the custom error message for the returned error code if there is one. This can be confusing if the custom error message does not match the error returned by the NetHSM. This patch always adds the NetHSM error message to the error returned by the API.