From a2de5d70283712892ed8e790f382c2fab0623a8b Mon Sep 17 00:00:00 2001 From: Jack Grigg Date: Wed, 13 Mar 2019 05:46:17 +0000 Subject: [PATCH] Add security disclaimer to README --- zcash_client_sqlite/README.md | 40 +++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/zcash_client_sqlite/README.md b/zcash_client_sqlite/README.md index 2c244f839..b5fc4f182 100644 --- a/zcash_client_sqlite/README.md +++ b/zcash_client_sqlite/README.md @@ -1,3 +1,43 @@ +# Security Disclaimer + +#### :warning: WARNING: This is an *early preview* + +---- + +In the spirit of transparency, we provide this as a window into what we are actively +developing. This is an alpha build, not yet intended for 3rd party use. Please be advised +of the following: + +* 🛑 This code currently is not audited. 🛑 +* ❌ This is a public, active branch with **no support**. +* ❌ The code **does not have** documentation that is reviewed and approved by our Documentation team. +* ❌ The code **does not have** adequate unit tests, acceptance tests and stress tests. +* ❌ The code **does not have** automated tests that use the officially supported CI system. +* ❌ The code **has not been subjected to thorough review** by engineers at the Electric Coin Company. +* :warning: This library **is** compatible with the latest version of zcashd, but there **is no** automated testing of this. +* :heavy_check_mark: The library **is not** majorly broken in some way. +* ❌ The library **only runs** on testnet. +* ❌ The library **does not run** on mainnet or regtest. +* ❌ We **are actively rebasing** this branch and adding features where/when needed. +* ❌ We **do not** undertake appropriate security coverage (threat models, review, response, etc.). +* :heavy_check_mark: There is a product manager for this library. +* :heavy_check_mark: Electric Coin Company maintains the library as we discover bugs and do network upgrades/minor releases. +* :heavy_check_mark: Users can expect to get a response within a few weeks after submitting an issue. +* ❌ The User Support team **has not yet been briefed** on the features provided to users and the functionality of the associated test-framework. +* ❌ The code is **not fully-documented**. + + +### 🛑 Use of this code may lead to a loss of funds 🛑 + +Use of this code in its current form or with modifications may lead to loss of funds, loss +of "expected" privacy, or denial of service for a large portion of users, or a bug which +could leverage any of those kinds of attacks (especially a "0 day" where we suspect few +people know about the vulnerability). + +### :eyes: At this time, this is for preview purposes only. :eyes: + +---- + # zcash_client_sqlite This library contains APIs that collectively implement a Zcash light client in