Skip to content

doc(tls): improve MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET documentation - #10909

Open
mmustafasenoglu wants to merge 1 commit into
Mbed-TLS:developmentfrom
mmustafasenoglu:fix/doc-new-session-ticket-error
Open

doc(tls): improve MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET documentation#10909
mmustafasenoglu wants to merge 1 commit into
Mbed-TLS:developmentfrom
mmustafasenoglu:fix/doc-new-session-ticket-error

Conversation

@mmustafasenoglu

Copy link
Copy Markdown

Closes #10578

The previous documentation for MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET was minimal (two lines) and did not explain that this is an informational return code rather than a fatal error. After upgrading to mbedtls 4, users see this new error and the docs just say it is experimental.

This PR:

  • Expands the doxygen comment to clearly state the error is not fatal and the connection is still usable
  • Explains that a new session ticket has been received and can be saved via session serialization APIs
  • Adds \return documentation for this error code to mbedtls_ssl_handshake(), mbedtls_ssl_read(), and mbedtls_ssl_write()
  • Updates the \warning sections of these functions to list it among non-fatal return codes

Copilot AI lite review requested due to automatic review settings August 7, 2026 13:18

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@bjwtaylor bjwtaylor added component-tls13 enhancement size-s Estimated task size: small (~2d) priority-medium Medium priority - this can be reviewed as time permits needs-review Every commit must be reviewed by at least two team members, needs-reviewer This PR needs someone to pick it up for review needs-ci Needs to pass CI tests labels Aug 20, 2026
@gilles-peskine-arm

Copy link
Copy Markdown
Contributor

Unfortunately, we can't accept contributions without a developer certificate of origin. If you accept the contents of dco.txt, please indicate it by amending your commit to have a signoff line (git commit --amend --signoff; git push --force …).

@gilles-peskine-arm gilles-peskine-arm added needs-work and removed needs-review Every commit must be reviewed by at least two team members, needs-reviewer This PR needs someone to pick it up for review labels Aug 21, 2026
The previous documentation was minimal and did not explain that this
is an informational return code rather than a fatal error.

Update the doxygen comment to clearly state that it is not a fatal
error, the connection is still usable, and the caller may continue
calling the same function.

Also add return documentation for this error code to
mbedtls_ssl_handshake(), mbedtls_ssl_read(), and mbedtls_ssl_write(),
and update their warning sections to list it among non-fatal codes.

Closes Mbed-TLS#10578

Signed-off-by: Mustafa Senoglu <mmustafasenoglu0@gmail.com>
@mmustafasenoglu
mmustafasenoglu force-pushed the fix/doc-new-session-ticket-error branch from 81d6296 to 1b666a9 Compare August 22, 2026 07:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component-tls13 enhancement needs-ci Needs to pass CI tests needs-work priority-medium Medium priority - this can be reviewed as time permits size-s Estimated task size: small (~2d)

Projects

Status: In Development

Development

Successfully merging this pull request may close these issues.

Document MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET

4 participants