Skip to content

Commit 6031bc2

Browse files
author
deepikabhavnani
committed
Updated doxygen comments
1 parent c43a3f4 commit 6031bc2

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

features/device_key/source/DeviceKey.h

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -72,20 +72,20 @@ class DeviceKey : private mbed::NonCopyable<DeviceKey> {
7272

7373
~DeviceKey();
7474

75-
/** Derive a new key based on the salt string. key type can be with values 16 bytes and 32 bytes
76-
* @param isalt input buffer used to create the new key. Same input will generate always the same key
77-
* @param isalt_size size of the data in salt buffer
78-
* @param output buffer to receive the derived key. Size must be 16 bytes or 32 bytes
75+
/** Derive a new key based on the salt string.
76+
* @param isalt Input buffer used to create the new key. Same input will always generate the same key
77+
* @param isalt_size Size of the data in salt buffer.
78+
* @param output Buffer to receive the derived key. Size must be 16 bytes or 32 bytes
7979
* according to the ikey_type parameter
80-
* @param ikey_type type of the required key. Type must be 16 bytes or 32 bytes.
80+
* @param ikey_type Type of the required key. Must be 16 bytes or 32 bytes.
8181
* @return 0 on success, negative error code on failure
8282
*/
8383
int generate_derived_key(const unsigned char *isalt, size_t isalt_size, unsigned char *output, uint16_t ikey_type);
8484

8585
/** Set a device key into the NVStore. In case TRNG support is missing, Call this method
8686
* before calling device_key_derived_key. This method should be called only once!
87-
* @param value input buffer contain the key.
88-
* @param isize size of the supplied key. Must be 16 bytes or 32 bytes.
87+
* @param value Input buffer contain the key.
88+
* @param isize Size of the supplied key. Must be 16 bytes or 32 bytes.
8989
* @return 0 on success, negative error code on failure
9090
*/
9191
int device_inject_root_of_trust(uint32_t *value, size_t isize);
@@ -95,40 +95,40 @@ class DeviceKey : private mbed::NonCopyable<DeviceKey> {
9595
DeviceKey();
9696

9797
/** Read a device key from the NVStore
98-
* @param output buffer for the returned key.
99-
* @param size input: the size of the output buffer.
100-
* output: the actual size of the written data
98+
* @param output Buffer for the returned key.
99+
* @param size Input: The size of the output buffer.
100+
* Output: The actual size of the written data
101101
* @return 0 on success, negative error code on failure
102102
*/
103103
int read_key_from_nvstore(uint32_t *output, size_t& size);
104104

105105
/** Set a device key into the NVStore
106-
* @param input input buffer contain the key.
107-
* @param isize the size of the input buffer.
106+
* @param input Input buffer contain the key.
107+
* @param isize The size of the input buffer.
108108
* @return 0 on success, negative error code on failure
109109
*/
110110
int write_key_to_nvstore(uint32_t *input, size_t isize);
111111

112-
/** Get a derived key base on a salt string. The methods implements
113-
* Section 5.1 in NIST SP 800-108, Recommendation for Key Derivation Using Pseudorandom Functions
114-
* @param ikey_buff input buffer holding the ROT key
115-
* @param ikey_size size of the input key. Must be 16 bytes or 32 bytes.
116-
* @param isalt input buffer contain some string.
117-
* @param isalt_size size of the supplied input string.
118-
* @param output buffer for the derived key result.
119-
* @param ikey_type the requested key size. Must be 16 bytes or 32 bytes.
112+
/** Get a derived key base on a salt string. The methods implements Section 5.1
113+
* in NIST SP 800-108, Recommendation for Key Derivation Using Pseudorandom Functions
114+
* @param ikey_buff Input buffer holding the ROT key
115+
* @param ikey_size Size of the input key. Must be 16 bytes or 32 bytes.
116+
* @param isalt Input buffer contain some string.
117+
* @param isalt_size Size of the supplied input string.
118+
* @param output Buffer for the derived key result.
119+
* @param ikey_type The requested key size. Must be 16 bytes or 32 bytes.
120120
* @return 0 on success, negative error code on failure
121121
*/
122122
int get_derived_key(uint32_t *ikey_buff, size_t ikey_size, const unsigned char *isalt, size_t isalt_size,
123123
unsigned char *output, uint32_t ikey_type);
124124

125125
/** Generate a random ROT key by using TRNG
126-
* @param output output buffer for the generated key.
127-
* @param size input: the size of the buffer. if size is less
126+
* @param output Output buffer for the generated key.
127+
* @param size Input: The size of the buffer. if size is less
128128
* then 16 bytes the method will generate an
129129
* error. 16-31 bytes will create a 16 byte key.
130130
* 32 or higher will generate a 32 bytes key
131-
* output: the actual written size to the buffer
131+
* Output: The actual written size to the buffer
132132
* @return 0 on success, negative error code on failure
133133
*/
134134
int generate_key_by_trng(uint32_t *output, size_t size);

0 commit comments

Comments
 (0)