third_party: Add chromium_verifier
Add an initial entry for the third party chromium verifier. The
verifier requires a number of dependencies to be implmented. These will
be uploaded in separate changes.
Bug: 394
Change-Id: I5b3172b510137983257cb9af026828456496b5b8
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/49502
Commit-Queue: Yecheng Zhao <zyecheng@google.com>
Reviewed-by: Ali Zhang <alizhang@google.com>
diff --git a/pw_tls_client/docs.rst b/pw_tls_client/docs.rst
index 26c6bcb..348ad44 100644
--- a/pw_tls_client/docs.rst
+++ b/pw_tls_client/docs.rst
@@ -29,15 +29,31 @@
This module is under construction, not ready for use, and the documentation
is incomplete.
-System Dependencies
-===================
+Prerequisites
+=============
This module requires the following dependencies:
1. Entropy
+-----------
TLS requires an entropy source for generating random bytes. Users of this
module should provide one by implementing a backend to the
``pw_tls_client:entropy`` facade.
+2. Chromium Verifier
+---------------------
+BoringSSL backend uses chromium verifier for certication verification. If the
+downstream project uses BoringSSL as the backend, the sources of the verifier,
+which is part of the chorimum sources, needs to be downloaded in order for
+``//third_party/chromium_verifier`` to build. It is recommended to use our
+support in pw_package for downloading compatible and tested version:
+
+.. code-block:: sh
+
+ pw package install chromium_verifier
+
+Then follow instruction for setting ``dir_pw_third_party_chromium_verifier`` to
+the path of the downloaded repo.
+
Setup
=====
This module requires the following setup: