Skip to content

Commit

Permalink
Improving security section in CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dr-orlovsky committed Apr 29, 2021
1 parent 4e64db1 commit 92bb0e5
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions CONTRIBUTING.md
Expand Up @@ -207,9 +207,9 @@ Derivations applied to a data structures should be standardized:
from pt. 1 in the following situations:
- for types that don't have reflexive equality/ordering
- types which has lexicographic ordering defined as a part of a standard must
provide manual derivation
provide manual implementation
- types which may be more efficiently compared with bitcoin-specific rules
should provide manual derivation
should provide manual implementation

3. `Debug` must not be derived on structs and enums which may contain secret
data, and a manual `Debug` implementation should be provided instead.
Expand Down Expand Up @@ -270,7 +270,11 @@ requirement to test unsafe code with sanitizers including Miri.

Security is the primary focus for this library; disclosure of security
vulnerabilities helps prevent user loss of funds. If you believe a vulnerability
may affect other implementations, please inform them.
may affect other implementations, please disclose this information according to
the [security guidelines](./SECURITY.md), work on which is currently in progress.
Before it is completed, feel free to send disclosure to Andrew Poelstra,
apoelstra@wpsoftware.net, and encrypted with his public key, which may be found
at <https://www.wpsoftware.net/andrew/andrew.gpg>.


## Testing
Expand Down

0 comments on commit 92bb0e5

Please sign in to comment.