Skip to content

Commit 1bdf7de

Browse files
Vge0rgerlubos
authored andcommitted
crypto: doc: Update ocrypto groups
Update the docs to be compatible with the new ocrypto 3.0.16. Removes groups which are not defined anymore and updates the renamed ones. Signed-off-by: Georgios Vasilakis <[email protected]>
1 parent 310ee46 commit 1bdf7de

File tree

1 file changed

+23
-16
lines changed

1 file changed

+23
-16
lines changed

crypto/doc/api.rst

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -85,8 +85,6 @@ nrf_oberon crypto library
8585
AES - Advanced Encryption Standard
8686
==================================
8787

88-
.. doxygengroup:: ocrypto_aes
89-
9088
AES-CBC - AES Cipher Block Chaining Mode
9189
----------------------------------------
9290

@@ -137,11 +135,6 @@ ChaCha20-Poly1305
137135

138136
.. doxygengroup:: ocrypto_chacha_poly
139137

140-
ChaCha20-Poly1305
141-
-----------------
142-
143-
.. doxygengroup:: ocrypto_chacha_poly_inc
144-
145138
ChaCha20
146139
--------
147140

@@ -203,7 +196,10 @@ Ed25519
203196
HKDF - HMAC based Key Derivation Function
204197
=========================================
205198

206-
.. doxygengroup:: ocrypto_hkdf
199+
HKDF using SHA-1
200+
------------------
201+
202+
.. doxygengroup:: ocrypto_hkdf_sha1
207203

208204
HKDF using SHA-256
209205
------------------
@@ -213,12 +209,15 @@ HKDF using SHA-256
213209
HKDF using SHA-512
214210
------------------
215211

216-
.. doxygengroup:: ocrypto_hkdf_512
212+
.. doxygengroup:: ocrypto_hkdf_sha512
217213

218214
HMAC - Hash-based Message Authentication Code
219215
=============================================
220216

221-
.. doxygengroup:: ocrypto_hmac
217+
HMAC using SHA-1
218+
------------------
219+
220+
.. doxygengroup:: ocrypto_hmac_sha1
222221

223222
HMAC using SHA-256
224223
------------------
@@ -233,7 +232,20 @@ HMAC using SHA-512
233232
PBKDF2
234233
===========
235234

236-
.. doxygengroup:: ocrypto_pbkdf2
235+
PBKDF2 using HMAC and SHA-1
236+
---------------------------
237+
238+
.. doxygengroup:: ocrypto_pbkdf2_hmac_sha1
239+
240+
PBKDF2 using HMAC and SHA-256
241+
-----------------------------
242+
243+
.. doxygengroup:: ocrypto_pbkdf2_hmac_sha256
244+
245+
PBKDF2 using CMAC
246+
------------------
247+
248+
.. doxygengroup:: ocrypto_pbkdf2_hmac_aes_cmac_prf_128
237249

238250
RSA - Rivest-Shamir-Adleman algorithm
239251
=====================================
@@ -288,11 +300,6 @@ SRP - Secure Remote Password
288300

289301
.. doxygengroup:: ocrypto_srp
290302

291-
SRPT - Secure Real-Time Transport Protocol
292-
==========================================
293-
294-
.. doxygengroup:: ocrypto_srtp
295-
296303
ocrypto internal types
297304
======================
298305

0 commit comments

Comments
 (0)