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.

Sign up for GitHub

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

feat: Adds cleanup_final #4853

Merged
merged 6 commits into from
Oct 25, 2024
Merged

feat: Adds cleanup_final #4853

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8e44018
Adds cleanup_final
maddeleine Oct 18, 2024
e61502e
PR feedback
maddeleine Oct 23, 2024
aed64a2
More PR feedback
maddeleine Oct 23, 2024
88f3405
Merge branch 'main' into cleanup_final
maddeleine Oct 23, 2024
7aed1d4
Merge branch 'main' into cleanup_final
maddeleine Oct 23, 2024
fab82d1
Merge branch 'main' into cleanup_final
maddeleine Oct 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions api/s2n.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,16 @@ S2N_API extern int s2n_init(void);
*/
S2N_API extern int s2n_cleanup(void);

/*
* Performs a complete deinitialization and cleanup of the s2n-tls library.
*
* The difference between this API and s2n_cleanup is that s2n_cleanup may not fully clean up
* the library if it is called on a thread that did not initialize s2n-tls.
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure it's clear when this API should be used vs s2n_cleanup. It sounds like this API should maybe always be used instead of s2n_cleanup? If so, should we say something in s2n_cleanup to use this instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Basically, s2n_cleanup_final doesn't really have a usecase unless you disable the atexit handler. If the atexit handler is on, you don't need cleanup_final. And we are planning on turning off the atexit handler soon, just not in this specific PR. I just don't want to write docs that I'm going to have to rewrite in this PR #4846.

*
* @returns S2N_SUCCESS on success. S2N_FAILURE on failure
*/
S2N_API extern int s2n_cleanup_final(void);

typedef enum {
S2N_FIPS_MODE_DISABLED = 0,
S2N_FIPS_MODE_ENABLED,
Expand Down
Loading