Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document some structure fields as public #4603

Closed
gilles-peskine-arm opened this issue Jun 1, 2021 · 2 comments · Fixed by #4671
Closed

Document some structure fields as public #4603

gilles-peskine-arm opened this issue Jun 1, 2021 · 2 comments · Fixed by #4671
Labels
component-crypto Crypto primitives and low-level interfaces component-tls component-x509 enhancement size-s Estimated task size: small (~2d)

Comments

@gilles-peskine-arm
Copy link
Contributor

gilles-peskine-arm commented Jun 1, 2021

#4511 systematically documents all structure fields as private.

But some structure fields should remain public. The goal of this task is to take care of fields that should obviously remain public.

@mpg
Copy link
Contributor

mpg commented Jun 2, 2021

In the past I've seen application code access the state field of mbedtls_ssl_context. I don't think we necessarily want to make that field public (as it could hinder work on 1.3 which has a different state machine), but we probably want to make some info public, for example "is the handshake over yet?", otherwise exposing mbedtls_ssl_handshake_step() in the API makes little sense.

@mpg
Copy link
Contributor

mpg commented Jun 18, 2021

I'm marking this issue as "size: S" and closed by #4671 as the description says this is about "obvious" fields and apparently this is the last "obvious" thing we notice. Further work in this area is tracked in #4383 and #4683 for the somewhat-known parts, and the mostly-unknown parts are represented by #4682.

@bensze01 bensze01 modified the milestone: Mbed TLS 3.x Jul 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component-crypto Crypto primitives and low-level interfaces component-tls component-x509 enhancement size-s Estimated task size: small (~2d)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants