|
| 1 | +# Contributing to libsecp256k1 |
| 2 | + |
| 3 | +## Scope |
| 4 | + |
| 5 | +libsecp256k1 is a library for elliptic curve cryptography on the curve secp256k1, not a general-purpose cryptography library. |
| 6 | +The library primarily serves the needs of the Bitcoin Core project but provides additional functionality for the benefit of the wider Bitcoin ecosystem. |
| 7 | + |
| 8 | +## Adding new functionality or modules |
| 9 | + |
| 10 | +The libsecp256k1 project welcomes contributions in the form of new functionality or modules, provided they are within the project's scope. |
| 11 | + |
| 12 | +It is the responsibility of the contributors to convince the maintainers that the proposed functionality is within the project's scope, high-quality and maintainable. |
| 13 | +Contributors are recommended to provide the following in addition to the new code: |
| 14 | + |
| 15 | +* **Specification:** |
| 16 | + A specification can help significantly in reviewing the new code as it provides documentation and context. |
| 17 | + It may justify various design decisions, give a motivation and outline security goals. |
| 18 | + If the specification contains pseudocode, a reference implementation or test vectors, these can be used to compare with the proposed libsecp256k1 code. |
| 19 | +* **Security Arguments:** |
| 20 | + In addition to a defining the security goals, it should be argued that the new functionality meets these goals. |
| 21 | + Depending on the nature of the new functionality, a wide range of security arguments are acceptable, ranging from being "obviously secure" to rigorous proofs of security. |
| 22 | +* **Relevance Arguments:** |
| 23 | + The relevance of the new functionality for the Bitcoin ecosystem should be argued by outlining clear use cases. |
| 24 | + |
| 25 | +These are not the only factors taken into account when considering to add new functionality. |
| 26 | +The proposed new libsecp256k1 code must be of high quality, including API documentation and tests, as well as featuring a misuse-resistant API design. |
| 27 | + |
| 28 | +We recommend reaching out to other contributors (see [Communication Channels](#communication-channels)) and get feedback before implementing new functionality. |
| 29 | + |
| 30 | +## Communication channels |
| 31 | + |
| 32 | +Most communication about libsecp256k1 occurs on the GitHub repository: in issues, pull request or on the discussion board. |
| 33 | + |
| 34 | +Additionally, there is an IRC channel dedicated to libsecp256k1, with biweekly meetings (see channel topic). |
| 35 | +The channel is `#secp256k1` on Libera Chat. |
| 36 | +The easiest way to participate on IRC is with the web client, [web.libera.chat](https://web.libera.chat/#secp256k1). |
| 37 | +Chat history logs can be found at https://gnusha.org/secp256k1/. |
| 38 | + |
| 39 | +## Contributor workflow & peer review |
| 40 | + |
| 41 | +The Contributor Workflow & Peer Review in libsecp256k1 are similar to Bitcoin Core's workflow and review processes described in its [CONTRIBUTING.md](https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md). |
| 42 | + |
| 43 | +### Coding conventions |
| 44 | + |
| 45 | +In addition, libsecp256k1 tries to maintain the following coding conventions: |
| 46 | + |
| 47 | +* No runtime heap allocation (e.g., no `malloc`) unless explicitly requested by the caller (via `secp256k1_context_create` or `secp256k1_scratch_space_create`, for example). Morever, it should be possible to use the library without any heap allocations. |
| 48 | +* The tests should cover all lines and branches of the library (see [Test coverage](#coverage)). |
| 49 | +* Operations involving secret data should be tested for being constant time with respect to the secrets (see [src/ctime_tests.c](src/ctime_tests.c)). |
| 50 | +* Local variables containing secret data should be cleared explicitly to try to delete secrets from memory. |
| 51 | +* Use `secp256k1_memcmp_var` instead of `memcmp` (see [#823](https://github.com/bitcoin-core/secp256k1/issues/823)). |
| 52 | + |
| 53 | +#### Style conventions |
| 54 | + |
| 55 | +* Commits should be atomic and diffs should be easy to read. For this reason, do not mix any formatting fixes or code moves with actual code changes. Make sure each individual commit is hygienic: that it builds successfully on its own without warnings, errors, regressions, or test failures. |
| 56 | +* New code should adhere to the style of existing, in particular surrounding, code. Other than that, we do not enforce strict rules for code formatting. |
| 57 | +* The code conforms to C89. Most notably, that means that only `/* ... */` comments are allowed (no `//` line comments). Moreover, any declarations in a `{ ... }` block (e.g., a function) must appear at the beginning of the block before any statements. When you would like to declare a variable in the middle of a block, you can open a new block: |
| 58 | + ```C |
| 59 | + void secp256k_foo(void) { |
| 60 | + unsigned int x; /* declaration */ |
| 61 | + int y = 2*x; /* declaration */ |
| 62 | + x = 17; /* statement */ |
| 63 | + { |
| 64 | + int a, b; /* declaration */ |
| 65 | + a = x + y; /* statement */ |
| 66 | + secp256k_bar(x, &b); /* statement */ |
| 67 | + } |
| 68 | + } |
| 69 | + ``` |
| 70 | +* Use `unsigned int` instead of just `unsigned`. |
| 71 | +* Use `void *ptr` instead of `void* ptr`. |
| 72 | +* Arguments of the publicly-facing API must have a specific order defined in [include/secp256k1.h](include/secp256k1.h). |
| 73 | +* User-facing comment lines in headers should be limited to 80 chars if possible. |
| 74 | +* All identifiers in file scope should start with `secp256k1_`. |
| 75 | +* Avoid trailing whitespace. |
| 76 | + |
| 77 | +### Tests |
| 78 | + |
| 79 | +#### Coverage |
| 80 | + |
| 81 | +This library aims to have full coverage of reachable lines and branches. |
| 82 | + |
| 83 | +To create a test coverage report, configure with `--enable-coverage` (use of GCC is necessary): |
| 84 | + |
| 85 | + $ ./configure --enable-coverage |
| 86 | + |
| 87 | +Run the tests: |
| 88 | + |
| 89 | + $ make check |
| 90 | + |
| 91 | +To create a report, `gcovr` is recommended, as it includes branch coverage reporting: |
| 92 | + |
| 93 | + $ gcovr --exclude 'src/bench*' --print-summary |
| 94 | + |
| 95 | +To create a HTML report with coloured and annotated source code: |
| 96 | + |
| 97 | + $ mkdir -p coverage |
| 98 | + $ gcovr --exclude 'src/bench*' --html --html-details -o coverage/coverage.html |
| 99 | + |
| 100 | +#### Exhaustive tests |
| 101 | + |
| 102 | +There are tests of several functions in which a small group replaces secp256k1. |
| 103 | +These tests are *exhaustive* since they provide all elements and scalars of the small group as input arguments (see [src/tests_exhaustive.c](src/tests_exhaustive.c)). |
| 104 | + |
| 105 | +### Benchmarks |
| 106 | + |
| 107 | +See `src/bench*.c` for examples of benchmarks. |
0 commit comments