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

[sanitizer] Document AddressSanitizer security considerations #100937

Merged
merged 1 commit into from
Oct 8, 2024

Conversation

bigb4ng
Copy link
Contributor

@bigb4ng bigb4ng commented Jul 28, 2024

Follow-up to #92593.

Also makes #92611, google/sanitizers#1130 obsolete.

Copy link

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be
notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write
permissions for the repository. In which case you can instead tag reviewers by
name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review
by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate
is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

@llvmbot llvmbot added the clang Clang issues not falling into any other category label Jul 28, 2024
@llvmbot
Copy link
Collaborator

llvmbot commented Jul 28, 2024

@llvm/pr-subscribers-clang

Author: None (bigb4ng)

Changes

Follow-up to #92593.

Also makes #92611, google/sanitizers#1130 obsolete.


Full diff: https://github.com/llvm/llvm-project/pull/100937.diff

1 Files Affected:

  • (modified) clang/docs/AddressSanitizer.rst (+8)
diff --git a/clang/docs/AddressSanitizer.rst b/clang/docs/AddressSanitizer.rst
index e1997153f2037..d543b49d64c05 100644
--- a/clang/docs/AddressSanitizer.rst
+++ b/clang/docs/AddressSanitizer.rst
@@ -313,6 +313,14 @@ Limitations
   usually expected.
 * Static linking of executables is not supported.
 
+Security Considerations
+=======================
+
+AddressSanitizer is a bug detection tool and is not meant to be linked
+against production executables. While it may be useful for testing,
+AddressSanitizer's runtime was not developed with security-sensitive
+constraints in mind and may compromise the security of the resulting executable.
+
 Supported Platforms
 ===================
 

@fmayer fmayer requested a review from eugenis August 7, 2024 21:09
Copy link

⚠️ We detected that you are using a GitHub private e-mail address to contribute to the repo.
Please turn off Keep my email addresses private setting in your account.
See LLVM Discourse for more information.

@fmayer
Copy link
Contributor

fmayer commented Aug 12, 2024

⚠️ We detected that you are using a GitHub private e-mail address to contribute to the repo. Please turn off Keep my email addresses private setting in your account. See LLVM Discourse for more information.

@bigb4ng please do this. Thank you

@vitalybuka
Copy link
Collaborator

This applies as well to MemorySanitizer, ThreadSanitizer, LeakSanitizer, HWAddressSanitizer, more or less UBSan with diagnostics. Would you like to update those as well?

@bigb4ng
Copy link
Contributor Author

bigb4ng commented Sep 10, 2024

@vitalybuka Done.

@fmayer If you have any other nits (especially for GWP-ASan section) I'd be glad to hear them.

@vitalybuka
Copy link
Collaborator

Don't forget to click "re-request review" after updating PRs, or it's not displayed as pending review request.

Copy link
Contributor

@fmayer fmayer left a comment

Choose a reason for hiding this comment

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

LGTM % vitaly's comment

@bigb4ng
Copy link
Contributor Author

bigb4ng commented Oct 5, 2024

@vitalybuka Unfortunately I cannot re-request since previous review is still pending. Anyway I've included trap mode too.

@vitalybuka vitalybuka requested a review from fmayer October 8, 2024 06:09
@fmayer fmayer merged commit baa51ff into llvm:main Oct 8, 2024
7 of 11 checks passed
Copy link

github-actions bot commented Oct 8, 2024

@bigb4ng Congratulations on having your first Pull Request (PR) merged into the LLVM Project!

Your changes will be combined with recent changes from other authors, then tested by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR.

Please check whether problems have been caused by your change specifically, as the builds can include changes from many authors. It is not uncommon for your change to be included in a build that fails due to someone else's changes, or infrastructure issues.

How to do this, and the rest of the post-merge process, is covered in detail here.

If your change does cause a problem, it may be reverted, or you can revert it yourself. This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again.

If you don't get any reports, no action is required from you. Your changes are working as expected, well done!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clang Clang issues not falling into any other category
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants