.. crypto_api:

API documentation
#################

.. contents::
   :local:
   :depth: 2

.. _crypto_api_nrf_cc310_bl:

nRF CC310 bootloader crypto library
***********************************

.. doxygengroup:: nrf_cc310_bl
   :project: nrfxlib
   :members:


.. _crypto_api_nrf_cc3xx_platform:

nRF CC3XX platform library
**************************

.. doxygengroup:: nrf_cc3xx_platform
   :project: nrfxlib
   :members:

CC3XX Platform - Defines
========================

.. doxygengroup:: nrf_cc3xx_platform_defines
   :project: nrfxlib
   :members:

CC3XX Platform - Initialization APIs
====================================

.. doxygengroup:: nrf_cc3xx_platform_init
   :project: nrfxlib
   :members:

CC3XX Platform - Entropy APIs
=============================

.. doxygengroup:: nrf_cc3xx_platform_entropy
   :project: nrfxlib
   :members:

CC3XX Platform - Mutex APIs
===========================

.. doxygengroup:: nrf_cc3xx_platform_mutex
   :project: nrfxlib
   :members:

CC3XX Platform - Abort APIs
===========================

.. doxygengroup:: nrf_cc3xx_platform_abort
   :project: nrfxlib
   :members:

CC3XX Platform - KMU APIs
=========================

.. doxygengroup:: nrf_cc3xx_platform_kmu
   :project: nrfxlib
   :members:

CC3XX Platform - CTR-DRBG APIs
==============================

.. doxygengroup:: nrf_cc3xx_platform_ctr_drbg
   :project: nrfxlib
   :members:

CC3XX Platform - HMAC-DRBG APIs
===============================

.. doxygengroup:: nrf_cc3xx_platform_hmac_drbg
   :project: nrfxlib
   :members:

.. _crypto_api_nrf_cc3xx_mbedcrypto:

nRF CC3XX mbedcrypto library
****************************

.. doxygengroup:: nrf_cc3xx_mbedcrypto
   :project: nrfxlib
   :members:

KMU/KDR APIs
========================

.. doxygengroup:: nrf_cc3xx_mbedcrypto_kmu
   :project: nrfxlib
   :members:


.. _crypto_api_nrf_oberon:

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

.. doxygengroup:: ocrypto
   :project: nrfxlib
   :members:

AES - Advanced Encryption Standard
==================================

.. doxygengroup:: ocrypto_aes
   :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
--------------------------

.. doxygengroup:: ocrypto_aes_ctr
   :project: nrfxlib
   :members:

AES EAX Mode
------------

.. doxygengroup:: ocrypto_aes_eax
   :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
---------------------------------

.. doxygengroup:: ocrypto_aes_gcm
   :project: nrfxlib
   :members:

AES key sizes
-------------

.. doxygengroup:: ocrypto_aes_key
   :project: nrfxlib
   :members:

ChaCha20-Poly1305
=================

.. doxygengroup:: ocrypto_chacha_poly
   :project: nrfxlib
   :members:

ChaCha20-Poly1305
-----------------

.. doxygengroup:: ocrypto_chacha_poly_inc
   :project: nrfxlib
   :members:

ChaCha20
--------

.. doxygengroup:: ocrypto_chacha
   :project: nrfxlib
   :members:

Constant time
=============

.. doxygengroup:: ocrypto_constant_time
   :project: nrfxlib
   :members:

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

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

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

.. doxygengroup:: ocrypto_p256
   :project: nrfxlib
   :members:

ECC Curve25519 low-level
========================

.. doxygengroup:: ocrypto_curve25519
   :project: nrfxlib
   :members:

ECDH
====

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

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

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

ECDSA
=====

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

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

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

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

EC-JPAKE
========

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


Ed25519
=======

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

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

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

.. doxygengroup:: ocrypto_hkdf
   :project: nrfxlib
   :members:

HKDF using SHA-256
------------------

.. doxygengroup:: ocrypto_hkdf_sha256
   :project: nrfxlib
   :members:

HKDF using SHA-512
------------------

.. doxygengroup:: ocrypto_hkdf_512
   :project: nrfxlib
   :members:

HMAC - Hash-based Message Authentication Code
=============================================

.. doxygengroup:: ocrypto_hmac
   :project: nrfxlib
   :members:

HMAC using SHA-256
------------------

.. doxygengroup:: ocrypto_hmac_sha256
   :project: nrfxlib
   :members:

HMAC using SHA-512
------------------

.. doxygengroup:: ocrypto_hmac_sha512
   :project: nrfxlib
   :members:

PBKDF2
===========

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

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

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

RSA
--------

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

RSA key
------------

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

SHA Hashing algorithms
======================

SHA-1
-----

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

SHA-224
-------

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

SHA-256
-------

.. doxygengroup:: ocrypto_sha_256
   :project: nrfxlib
   :members:

SHA-256
-------

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

SHA-512
-------

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

SPAKE2+
=======

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

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

.. doxygengroup:: ocrypto_srp
   :project: nrfxlib
   :members:

SRPT - Secure Real-Time Transport Protocol
==========================================

.. doxygengroup:: ocrypto_srtp
   :project: nrfxlib
   :members:

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

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