Skip to content

Commit

Permalink
Update description for register credential api
Browse files Browse the repository at this point in the history
  • Loading branch information
cb-github-robot authored Aug 25, 2024
2 parents ab50325 + 637cdc1 commit 65dfa55
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/api/rest/server/common/utility.go
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ func RestGetPublicKeyForCredentialEncryption(c echo.Context) error {
// RestRegisterCredential is a REST API handler for registering credentials.
// @ID RegisterCredential
// @Summary Register Credential Information
// @Description This API registers credential information using hybrid encryption. 1. First, compress and encrypt sensitive data using a client generated AES with a 256-bit key. 2. Then, encrypt the AES key using an RSA public key obtained from `GET /credential/publicKey`. 3. RSA encryption uses a 4096-bit key with OAEP padding and SHA-256 as the hash function. Ensure that all values are base64 encoded before sending them in the request. The public key token ID must be included in the request to allow the server to decrypt the data.
// @Description This API registers credential information using hybrid encryption. The process involves compressing and encrypting sensitive data with AES-256, encrypting the AES key with a 4096-bit RSA public key (retrieved via `GET /credential/publicKey`), and using OAEP padding with SHA-256. All values, including the AES key, must be base64 encoded before sending, and the public key token ID must be included in the request.
// @Tags [Admin] Credential Management
// @Accept json
// @Produce json
Expand Down

0 comments on commit 65dfa55

Please sign in to comment.