Skip to main content
Version: Next

Return codes (noxtls_return_t)

Return type for NoxTLS API functions. Implemented as an unsigned integer (not a C enum) so return constants have the same essential type as the API return type (MISRA C:2025 Rule 10.3). Numeric values match the historical enum order.

API​

noxtls_return_t​

Return type for NoxTLS API functions. Implemented as an unsigned integer (not a C enum) so return constants have the same essential type as the API return type (MISRA C:2025 Rule 10.3). Numeric values match the historical enum order.

NOXTLS_MSVC_WARNING_PUSH​

NOXTLS_MSVC_WARNING_POP​

NOXTLS_MSVC_DISABLE_PADDING​

NOXTLS_UNUSED_ATTR​

NOXTLS_PACK_BEGIN​

NOXTLS_PACK_END​

NOXTLS_PACKED​

NOXTLS_RETURN_SUCCESS​

Operation completed successfully.

NOXTLS_RETURN_FAILED​

General failure.

NOXTLS_RETURN_NULL​

A required pointer argument was NULL.

NOXTLS_RETURN_INVALID_PARAM​

An argument was invalid.

NOXTLS_RETURN_INVALID_BLOCK_SIZE​

Block or buffer size invalid.

NOXTLS_RETURN_INVALID_KEY_SIZE​

Key size invalid.

NOXTLS_RETURN_INVALID_MODE​

Cipher mode invalid or unsupported.

NOXTLS_RETURN_INVALID_ALGORITHM​

Algorithm not supported or invalid.

NOXTLS_RETURN_BAD_DATA​

Input data was malformed or invalid.

NOXTLS_RETURN_TIMEOUT​

Operation timed out.

NOXTLS_RETURN_NOT_SUPPORTED​

Feature or option not supported.

NOXTLS_RETURN_NOT_INITIALIZED​

Context or module not initialized.

NOXTLS_RETURN_NOT_ENOUGH_MEMORY​

Memory allocation failed.

NOXTLS_RETURN_NOT_ENOUGH_ENTROPY​

Insufficient entropy.

NOXTLS_RETURN_CERT_PARSE_FAILED​

Certificate parsing failed.

NOXTLS_RETURN_CERT_VERIFY_FAILED​

Certificate verification failed.

NOXTLS_RETURN_TLS_ERROR​

TLS/protocol error.

NOXTLS_RETURN_CERT_VERIFY_SIGNATURE_FAILED​

Certificate signature verification failed.

NOXTLS_RETURN_CERT_VERIFY_HOSTNAME_MISMATCH​

Hostname does not match certificate.

NOXTLS_RETURN_CERT_EXPIRED​

Certificate has expired.

NOXTLS_RETURN_CERT_NOT_YET_VALID​

Certificate not yet valid.

NOXTLS_RETURN_CERT_VERIFY_CHAIN_FAILED​

Certificate chain verification failed.

NOXTLS_RETURN_CERT_REVOKED​

Certificate appears on CRL.

NOXTLS_RETURN_CRL_PARSE_FAILED​

CRL parsing failed.

NOXTLS_RETURN_CRL_VERIFY_FAILED​

CRL signature verification failed.

NOXTLS_RETURN_CRL_EXPIRED​

CRL validity window not acceptable.

NOXTLS_RETURN_TLS_WEAK_DHE_PARAMS​

Weak/unsupported DHE parameters.

NOXTLS_RETURN_RECORD_OVERFLOW​

TLS record plaintext exceeds maximum.

NOXTLS_RETURN_CERT_REQUIRED​

Client certificate was required but missing.

NOXTLS_RETURN_TLS_ALERT_DECODE_ERROR​

Malformed handshake (decode_error).

NOXTLS_RETURN_TLS_ALERT_ILLEGAL_PARAMETER​

Invalid handshake field (illegal_parameter).

NOXTLS_RETURN_TLS_RECORD_AUTH_FAILED​

AEAD record open failed (bad_record_mac).

NOXTLS_RETURN_TLS_FINISHED_VERIFY_FAILED​

Finished verify_data mismatch.

NOXTLS_RETURN_NEGOTIATED_TLS12​

Downgrade path: continue as TLS 1.2.

NOXTLS_RETURN_WANT_READ​

Nonblocking: need more input bytes.

NOXTLS_RETURN_WANT_WRITE​

Nonblocking: encrypted output pending.

NOXTLS_RETURN_ECDH_PRIVATE_KEY_INVALID​

ECDH private-key context invalid.

NOXTLS_RETURN_ECDH_OUTPUT_TOO_SMALL​

ECDH output buffer too small.

NOXTLS_RETURN_ECDH_PEER_PUBLIC_KEY_INVALID​

ECDH peer public key invalid.

NOXTLS_RETURN_ECDH_SCALAR_MULTIPLY_FAILED​

ECDH scalar multiplication failed.

NOXTLS_RETURN_ECDH_SHARED_POINT_INFINITY​

ECDH result was the point at infinity.

NOXTLS_RETURN_DTLS_RECORD_REPLAYED​

DTLS record is duplicate or older than the replay window; discard without closing.