xref: /aosp_15_r20/external/boringssl/src/README.md (revision 8fb009dc861624b67b6cdb62ea21f0f22d0c584b)
1*8fb009dcSAndroid Build Coastguard Worker# BoringSSL
2*8fb009dcSAndroid Build Coastguard Worker
3*8fb009dcSAndroid Build Coastguard WorkerBoringSSL is a fork of OpenSSL that is designed to meet Google's needs.
4*8fb009dcSAndroid Build Coastguard Worker
5*8fb009dcSAndroid Build Coastguard WorkerAlthough BoringSSL is an open source project, it is not intended for general
6*8fb009dcSAndroid Build Coastguard Workeruse, as OpenSSL is. We don't recommend that third parties depend upon it. Doing
7*8fb009dcSAndroid Build Coastguard Workerso is likely to be frustrating because there are no guarantees of API or ABI
8*8fb009dcSAndroid Build Coastguard Workerstability.
9*8fb009dcSAndroid Build Coastguard Worker
10*8fb009dcSAndroid Build Coastguard WorkerPrograms ship their own copies of BoringSSL when they use it and we update
11*8fb009dcSAndroid Build Coastguard Workereverything as needed when deciding to make API changes. This allows us to
12*8fb009dcSAndroid Build Coastguard Workermostly avoid compromises in the name of compatibility. It works for us, but it
13*8fb009dcSAndroid Build Coastguard Workermay not work for you.
14*8fb009dcSAndroid Build Coastguard Worker
15*8fb009dcSAndroid Build Coastguard WorkerBoringSSL arose because Google used OpenSSL for many years in various ways and,
16*8fb009dcSAndroid Build Coastguard Workerover time, built up a large number of patches that were maintained while
17*8fb009dcSAndroid Build Coastguard Workertracking upstream OpenSSL. As Google's product portfolio became more complex,
18*8fb009dcSAndroid Build Coastguard Workermore copies of OpenSSL sprung up and the effort involved in maintaining all
19*8fb009dcSAndroid Build Coastguard Workerthese patches in multiple places was growing steadily.
20*8fb009dcSAndroid Build Coastguard Worker
21*8fb009dcSAndroid Build Coastguard WorkerCurrently BoringSSL is the SSL library in Chrome/Chromium, Android (but it's
22*8fb009dcSAndroid Build Coastguard Workernot part of the NDK) and a number of other apps/programs.
23*8fb009dcSAndroid Build Coastguard Worker
24*8fb009dcSAndroid Build Coastguard WorkerProject links:
25*8fb009dcSAndroid Build Coastguard Worker
26*8fb009dcSAndroid Build Coastguard Worker  * [API documentation](https://commondatastorage.googleapis.com/chromium-boringssl-docs/headers.html)
27*8fb009dcSAndroid Build Coastguard Worker  * [Bug tracker](https://issues.chromium.org/issues?q=status:open%20componentid:1590116%2B&s=created_time:desc)
28*8fb009dcSAndroid Build Coastguard Worker    * [Filing new issues](https://issues.chromium.org/issues/new?component=1590116&template=2003314)
29*8fb009dcSAndroid Build Coastguard Worker    * [Filing new security issues](https://issues.chromium.org/issues/new?component=1590116&template=2003205)
30*8fb009dcSAndroid Build Coastguard Worker  * [CI](https://ci.chromium.org/p/boringssl/g/main/console)
31*8fb009dcSAndroid Build Coastguard Worker  * [Code review](https://boringssl-review.googlesource.com)
32*8fb009dcSAndroid Build Coastguard Worker
33*8fb009dcSAndroid Build Coastguard WorkerThere are other files in this directory which might be helpful:
34*8fb009dcSAndroid Build Coastguard Worker
35*8fb009dcSAndroid Build Coastguard Worker  * [PORTING.md](./PORTING.md): how to port OpenSSL-using code to BoringSSL.
36*8fb009dcSAndroid Build Coastguard Worker  * [BUILDING.md](./BUILDING.md): how to build BoringSSL
37*8fb009dcSAndroid Build Coastguard Worker  * [INCORPORATING.md](./INCORPORATING.md): how to incorporate BoringSSL into a project.
38*8fb009dcSAndroid Build Coastguard Worker  * [API-CONVENTIONS.md](./API-CONVENTIONS.md): general API conventions for BoringSSL consumers and developers.
39*8fb009dcSAndroid Build Coastguard Worker  * [STYLE.md](./STYLE.md): rules and guidelines for coding style.
40*8fb009dcSAndroid Build Coastguard Worker  * include/openssl: public headers with API documentation in comments. Also [available online](https://commondatastorage.googleapis.com/chromium-boringssl-docs/headers.html).
41*8fb009dcSAndroid Build Coastguard Worker  * [FUZZING.md](./FUZZING.md): information about fuzzing BoringSSL.
42*8fb009dcSAndroid Build Coastguard Worker  * [CONTRIBUTING.md](./CONTRIBUTING.md): how to contribute to BoringSSL.
43*8fb009dcSAndroid Build Coastguard Worker  * [BREAKING-CHANGES.md](./BREAKING-CHANGES.md): notes on potentially-breaking changes.
44*8fb009dcSAndroid Build Coastguard Worker  * [SANDBOXING.md](./SANDBOXING.md): notes on using BoringSSL in a sandboxed environment.
45