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

Atexit handler and other auto-cleanup behavior is not documented #4042

Closed
maddeleine opened this issue Jun 6, 2023 · 0 comments · Fixed by #4037
Closed

Atexit handler and other auto-cleanup behavior is not documented #4042

maddeleine opened this issue Jun 6, 2023 · 0 comments · Fixed by #4037

Comments

@maddeleine
Copy link
Contributor

Security issue notifications

If you discover a potential security issue in s2n we ask that you notify
AWS Security via our vulnerability reporting page. Please do not create a public github issue.

Problem:

The automatic cleanup part of our code is super confusing to read and also is not documented. This leads to any cleanup issue taking a lot longer than it should since no one remembers how this code works.

Solution:

Minimally, we should update the development guide to explain how s2n deals with automatic cleanup of memory. Ideally we would fix the code so it is less confusing.

Requirements / Acceptance Criteria:

We should document in the development guide our autocleanup behavior.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants