mbedtls/include/mbedtls
Manuel Pégourié-Gonnard 3ba84d5bd6 Improve documentation of cipher_auth_xxcrypt()
- Document constraints on buffers/pointers NULLability explicitly.
- Simplify terminology around IV/nonce: all AEADs implemented so far call that
  a nonce. Keep the parameter names (iv, iv_len) to avoid having to change the
code (or having different names in the header and C files).
- Align documentation to the code regarding parameter constraints: the
  documentation said the for ciphers with fixed nonce/tag length, the
iv_len/tag_len arguments were ignored, while the code enforced them to be the
expected value. This is more consistent with what's done with GCM/CCM, which
for tag_len for example accept more than one value, but from a relatively
small set, and will return errors for values outside that set. Accepting a
single value is a particular case of that (the set of acceptable value only
has one element).

Don't document behaviour with NIST KW as we're about to change that.

Note: this function is currently only defined if at least one of GCM, CCM or
ChachaPoly is enabled, even though it's supposed to handle NIST KW as well. No
need to fix this as the function will soon no longer support NIST KW.

Signed-off-by: Manuel Pégourié-Gonnard <manuel.pegourie-gonnard@arm.com>
2020-12-03 10:01:28 +01:00
..
aes.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
aesni.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
arc4.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
aria.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
asn1.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
asn1write.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
base64.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
bignum.h adjusting comment on sliding window memory usage. 2020-09-07 13:07:14 +02:00
blowfish.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
bn_mul.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
camellia.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
ccm.h Fix docs to desribe written-into buffer parameter as writable 2020-09-12 01:24:45 +03:00
certs.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
chacha20.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
chachapoly.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
check_config.h State PSA_CRYPTO_KEY_ID_ENCODES_OWNER and USE_PSA_CRYPTO incompatibility 2020-11-10 16:00:41 +01:00
cipher.h Improve documentation of cipher_auth_xxcrypt() 2020-12-03 10:01:28 +01:00
cipher_internal.h psa: Move from key handle to key identifier 2020-11-10 16:00:41 +01:00
cmac.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
compat-1.3.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
config.h Merge pull request #3547 from ronald-cron-arm/psa-openless 2020-11-20 18:48:33 +01:00
config_psa.h Updates to PSA crypto library based on review comments 2020-11-18 08:09:49 -08:00
ctr_drbg.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
debug.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
des.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
dhm.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
ecdh.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
ecdsa.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
ecjpake.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
ecp.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
ecp_internal.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
entropy.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
entropy_poll.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
error.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
gcm.h Fix docs to desribe written-into buffer parameter as writable 2020-09-12 01:24:45 +03:00
havege.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
hkdf.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
hmac_drbg.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
md.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
md2.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
md4.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
md5.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
md_internal.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
memory_buffer_alloc.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
net.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
net_sockets.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
nist_kw.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
oid.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
padlock.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
pem.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
pk.h psa: Move from key handle to key identifier 2020-11-10 16:00:41 +01:00
pk_internal.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
pkcs5.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
pkcs11.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
pkcs12.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
platform.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
platform_time.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
platform_util.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
poly1305.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
psa_util.h Merge pull request #3480 from stevew817/feature/aes-ecb 2020-09-14 14:45:14 +02:00
ripemd160.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
rsa.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
rsa_internal.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
sha1.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
sha256.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
sha512.h Move "internal use" sentence attached to the wrong function 2020-11-22 13:59:43 +01:00
ssl.h Merge pull request #3547 from ronald-cron-arm/psa-openless 2020-11-20 18:48:33 +01:00
ssl_cache.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
ssl_ciphersuites.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
ssl_cookie.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
ssl_internal.h Merge pull request #3547 from ronald-cron-arm/psa-openless 2020-11-20 18:48:33 +01:00
ssl_ticket.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
threading.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
timing.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
version.h Bump version to Mbed TLS 2.24.0 2020-08-26 16:22:57 +01:00
x509.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
x509_crl.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
x509_crt.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
x509_csr.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00
xtea.h Update copyright notices to use Linux Foundation guidance 2020-08-19 10:35:41 +02:00