Update of Security chapter in CAMARA-API-Design-Guide.md#467
Merged
rartych merged 1 commit intocamaraproject:mainfrom Jun 3, 2025
Merged
Update of Security chapter in CAMARA-API-Design-Guide.md#467rartych merged 1 commit intocamaraproject:mainfrom
rartych merged 1 commit intocamaraproject:mainfrom
Conversation
based on comments from PR camaraproject#441
PedroDiez
approved these changes
May 29, 2025
Contributor
PedroDiez
left a comment
There was a problem hiding this comment.
Minor suggestions.
LGTM in advance
|
|
||
| 5. **Authentication and authorization must be considered** | ||
| CAMARA uses the authentication and authorization protocols and flows as described in the [Camara Security and Interoperability Profile](https://github.com/camaraproject/IdentityAndConsentManagement/blob/main/documentation/CAMARA-Security-Interoperability.md). | ||
| Validate the request parameters as the first step before they reach the application logic. |
Contributor
There was a problem hiding this comment.
Suggested change
| Validate the request parameters as the first step before they reach the application logic. | |
| Validate the request parameters as the first step before they reach the application logic. | |
| send relevant error messages and an example of the correct input format to improve the user experience. | ||
| 5. **Hashing passwords**. | ||
|
|
||
| Passwords should never be transmitted in API bodies; however, if it becomes absolutely necessary, they must be hashed to protect the system and minimize potential damage in the event of a compromise. Utilizing strong hashing algorithms is crucial for password security. Effective options include Argon2, PBKDF2, bcrypt, and scrypt, which are designed to securely hash passwords and withstand various attack vectors. |
Contributor
There was a problem hiding this comment.
Suggested change
| Passwords should never be transmitted in API bodies; however, if it becomes absolutely necessary, they must be hashed to protect the system and minimize potential damage in the event of a compromise. Utilizing strong hashing algorithms is crucial for password security. Effective options include Argon2, PBKDF2, bcrypt, and scrypt, which are designed to securely hash passwords and withstand various attack vectors. | |
| Passwords should never be transmitted in API bodies; however, if it becomes absolutely necessary, they must be hashed to protect the system and minimize potential damage in the event of a compromise. Utilizing strong hashing algorithms is crucial for password security. Effective options include Argon2, PBKDF2, bcrypt, and scrypt, which are designed to securely hash passwords and withstand various attack vectors. | |
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
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.
What type of PR is this?
What this PR does / why we need it:
Update of Security chapter based on comments from PR #441
Mainly Good practices to secure REST APIs were modified.
Reference to OWASP API Security was added.
Which issue(s) this PR fixes:
Fixes #446
Does this PR introduce a breaking change?
Special notes for reviewers:
Some implementation related points can be transfered to "CAMARA API Implementation Guide" in the future - currently there is no such document.
Changelog input