Correct security_server_reset_pwd description in header.

[Issue#]        PSDAC-106
[Bug]           security_server_reset_pwd performed no checks connected with new password. Header
                didn't include this information in security_server_reset_pwd description.
[Cause]         N/A
[Solution]      Correct information included in security-server.h header.
[Verification]  N/A

Change-Id: I38e8b565121a8b5f3d087fbe0425042a59f73ae0

diff --git a/src/include/security-server.h b/src/include/security-server.h
index 75ce1a2..28e435f 100644 (file)
--- a/src/include/security-server.h
+++ b/src/include/security-server.h
@@ -708,7 +708,8 @@ int security_server_set_pwd_max_challenge(const unsigned int max_challenge);
 
 /**
  * \par Description:
- * This API sets phone password only if current password is invalid or user forgot the password.
+ * This API sets phone password without performing any checks connected with provided password. It
+ * should be used only if current password is invalid or user forgot the password.
  *
  * \par Purpose:
  * This API should be used by setting application or dedicated processes when the user changes his/her phone password.
@@ -717,7 +718,9 @@ int security_server_set_pwd_max_challenge(const unsigned int max_challenge);
  * User forgets the password. He calls emergency manager(auto or manual)  for reset password. Emergency manager calls this API and reset phone password.
  *
  * \par Method of function operation:
- * Resetting phone password with input string without any matching current password.
+ * Resetting phone password with input string without any matching current password. Function does
+ * no checks before password replacement (expiration time check, currently set password checks,
+ * history check and attempt count check are skipped).
  *
  * \par Sync (or) Async:
  * This is a Synchronous API.