Google Git
Sign in
boringssl / boringssl / e1cfbf1898d77e851f2d9adb9b1f950f918f8e7e
commite1cfbf1898d77e851f2d9adb9b1f950f918f8e7e[log] [tgz]
authorDavid Benjamin <davidben@google.com>Thu Apr 25 13:53:35 2024 -0400
committerBoringssl LUCI CQ <boringssl-scoped@luci-project-accounts.iam.gserviceaccount.com>Thu Apr 25 21:15:15 2024 +0000
tree3ce7a36df1c2f97420321cb214e71c10e26988cb
parent54821d806d574dd8f2869a8c7f5725b65a67af42 [diff]
Discuss pointer rules in even more detail in API-CONVENTIONS

This covers:
- The empty slices mess, and specifically Rust's unsafe FFIs
- Whether objects may be NULL by default
- When we use C's array syntax for static lengths

Also remove the note about ASN.1 and X.509 APIs being undocumented.
We've now documented them.

Change-Id: Ie12eee5ec16b9f87790076cbbe3a269f288dda03
Reviewed-on: https://boringssl-review.googlesource.com/c/boringssl/+/68047
Reviewed-by: Adam Langley <agl@google.com>
Reviewed-by: Bob Beck <bbe@google.com>
Commit-Queue: David Benjamin <davidben@google.com>
1 file changed
tree: 3ce7a36df1c2f97420321cb214e71c10e26988cb
  1. .github/
  2. cmake/
  3. crypto/
  4. decrepit/
  5. fuzz/
  6. gen/
  7. include/
  8. pki/
  9. rust/
  10. ssl/
  11. third_party/
  12. tool/
  13. util/
  14. .clang-format
  15. .gitignore
  16. API-CONVENTIONS.md
  17. BREAKING-CHANGES.md
  18. build.json
  19. BUILDING.md
  20. CMakeLists.txt
  21. codereview.settings
  22. CONTRIBUTING.md
  23. FUZZING.md
  24. go.mod
  25. go.sum
  26. INCORPORATING.md
  27. LICENSE
  28. PORTING.md
  29. PrivacyInfo.xcprivacy
  30. README.md
  31. SANDBOXING.md
  32. STYLE.md
README.md

BoringSSL

BoringSSL is a fork of OpenSSL that is designed to meet Google's needs.

Although BoringSSL is an open source project, it is not intended for general use, as OpenSSL is. We don't recommend that third parties depend upon it. Doing so is likely to be frustrating because there are no guarantees of API or ABI stability.

Programs ship their own copies of BoringSSL when they use it and we update everything as needed when deciding to make API changes. This allows us to mostly avoid compromises in the name of compatibility. It works for us, but it may not work for you.

BoringSSL arose because Google used OpenSSL for many years in various ways and, over time, built up a large number of patches that were maintained while tracking upstream OpenSSL. As Google's product portfolio became more complex, more copies of OpenSSL sprung up and the effort involved in maintaining all these patches in multiple places was growing steadily.

Currently BoringSSL is the SSL library in Chrome/Chromium, Android (but it's not part of the NDK) and a number of other apps/programs.

Project links:

There are other files in this directory which might be helpful: