Skip to content

Commit

Permalink
doc: crypto: Add missing ocrypto APIs to doxygen
Browse files Browse the repository at this point in the history
There were several API docs missing for the ocrypto library added them

Signed-off-by: Markus Swarowsky <[email protected]>
  • Loading branch information
mswarowsky committed Feb 22, 2024
1 parent ce411c0 commit f8c2aab
Showing 1 changed file with 114 additions and 7 deletions.
121 changes: 114 additions & 7 deletions crypto/doc/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ KMU/KDR APIs


.. _crypto_api_nrf_oberon:

nrf_oberon crypto library
*************************

Expand All @@ -115,6 +115,20 @@ AES - Advanced Encryption Standard APIs
:project: nrfxlib
:members:

AES-CBC - AES Cipher Block Chaining Mode
--------------------------

.. doxygengroup:: ocrypto_aes_cbc
:project: nrfxlib
:members:

AES-CBC - AES CCipher Block Chaining Mode with PKCS7 padding
--------------------------

.. doxygengroup:: ocrypto_aes_cbc_pkcs7
:project: nrfxlib
:members:

AES-CTR - AES Counter Mode
--------------------------

Expand All @@ -129,6 +143,27 @@ AES EAX APIs
:project: nrfxlib
:members:

AES-CBC - AES Electronic Code Book Mode
--------------------------

.. doxygengroup:: ocrypto_aes_ecb
:project: nrfxlib
:members:

AES-CCM - AES Cipher-based Message Authentication Code
--------------------------

.. doxygengroup:: ocrypto_aes_cmac
:project: nrfxlib
:members:

AES-CCM - AES Counter with CBC-MAC Mode
--------------------------

.. doxygengroup:: ocrypto_aes_ccm
:project: nrfxlib
:members:

AES GCM - AES Galois/Counter Mode APIs
--------------------------------------

Expand Down Expand Up @@ -171,6 +206,13 @@ Constant time APIs
:project: nrfxlib
:members:

ECC secp224r1 low-level APIs
============================

.. doxygengroup:: ocrypto_p224
:project: nrfxlib
:members:

ECC secp256r1 low-level APIs
============================

Expand All @@ -188,33 +230,56 @@ ECC Curve25519 low-level APIs
ECDH APIs
=========

.. doxygengroup:: ocrypto_ecdh_p256
.. doxygengroup:: ocrypto_ecdh_p224
:project: nrfxlib
:members:

.. doxygengroup:: ocrypto_ecdh_p224
.. doxygengroup:: ocrypto_ecdh_p256
:project: nrfxlib
:members:

.. doxygengroup:: ocrypto_ecdh_p384
:project: nrfxlib
:members:

ECDSA APIs
==========

.. doxygengroup:: ocrypto_ecdsa_p224
:project: nrfxlib
:members:

.. doxygengroup:: ocrypto_ecdsa_p256
:project: nrfxlib
:members:

.. doxygengroup:: ocrypto_ecdsa_p224
.. doxygengroup:: ocrypto_ecdsa_p384
:project: nrfxlib
:members:

.. doxygengroup:: ocrypto_ecdsa_p521
:project: nrfxlib
:members:

EC-JPAKE APIs
=============

.. doxygengroup:: ocrypto_ecjpake
:project: nrfxlib
:members:


Ed25519 APIs
=============

.. doxygengroup:: ocrypto_ed25519
:project: nrfxlib
:members:

.. doxygengroup:: ocrypto_ed25519ph
:project: nrfxlib
:members:

HKDF - HMAC based Key Derivation Function
=========================================

Expand Down Expand Up @@ -257,26 +322,47 @@ HMAC APIs using SHA-512
:project: nrfxlib
:members:

PBKDF2 APIs
===========

.. doxygengroup:: ocrypto_pbkdf2
:project: nrfxlib
:members:

RSA - Rivest-Shamir-Adleman algorithm
=====================================

.. doxygengroup:: ocrypto_rsa
:project: nrfxlib
:members:
:members:

RSA APIs
--------

.. doxygengroup:: ocrypto_rsa_api
:project: nrfxlib
:members:
:members:

RSA key APIs
------------

.. doxygengroup:: ocrypto_rsa_key
:project: nrfxlib
:members:
:members:

SHA-1 APIs
============

.. doxygengroup:: ocrypto_sha_1
:project: nrfxlib
:members:

SHA-224 APIs
============

.. doxygengroup:: ocrypto_sha_224
:project: nrfxlib
:members:

SHA-256 APIs
============
Expand All @@ -285,13 +371,27 @@ SHA-256 APIs
:project: nrfxlib
:members:

SHA-256 APIs
============

.. doxygengroup:: ocrypto_sha_384
:project: nrfxlib
:members:

SHA-512 APIs
============

.. doxygengroup:: ocrypto_sha_512
:project: nrfxlib
:members:

SPAKE2+ APIs
=================================

.. doxygengroup:: ocrypto_spake2p
:project: nrfxlib
:members:

SRP - Secure Remote Password APIs
=================================

Expand All @@ -305,3 +405,10 @@ SRPT - Secure Real-Time Transport Protocol APIs
.. doxygengroup:: ocrypto_srtp
:project: nrfxlib
:members:

ocrypto internal types
======================

.. doxygengroup:: ocrypto_types
:project: nrfxlib
:members:

0 comments on commit f8c2aab

Please sign in to comment.