net: lib: tls_credentials: clarify secure tag usage for TLS credentials

Updated documentation to clarify that while credential pairs should
generally share the same secure tag for subsystems supporting multiple
credentials per tag, some implementations may expect only one credential
per tag.

Signed-off-by: Maxwell Weru <mburumaxwell@gmail.com>
This commit is contained in:
Maxwell Weru 2025-06-24 13:22:25 +01:00 committed by Benjamin Cabé
parent 12ed0528b3
commit a972203871

View File

@ -70,8 +70,10 @@ enum tls_credential_type {
* @note Some TLS credentials come in pairs:
* - TLS_CREDENTIAL_PUBLIC_CERTIFICATE with TLS_CREDENTIAL_PRIVATE_KEY,
* - TLS_CREDENTIAL_PSK with TLS_CREDENTIAL_PSK_ID.
* Such pairs of credentials must be assigned the same secure tag to be
* correctly handled in the system.
* Such pairs of credentials should generally be assigned the same secure tag
* when used with subsystems that support fetching multiple credentials per tag,
* such as TLS sockets. However, note that certain subsystems or implementations
* may expect only one credential per secure tag.
*
* @note Negative values are reserved for internal use.
*/