Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge #688: Release tracking PR:
secp256k1-sys 0.10.0
2bba8f9 secp256k1-sys: Vendor latest secp256k1 (Tobin C. Harding) Pull request description: Vendor latest tagged version of `secp256k1` and prepare for release: - Bump the version number to `0.10.0` - Run the vendor script (vendoring `secp256k1 0.4.1`) - Update lock files - Add changelog entry - Depend on new version in `secp256k1/Cargo.toml` ACKs for top commit: apoelstra: ACK 2bba8f9 Tree-SHA512: 86ab44574d31657f0c99d32a7cf950a54deda4eac6f67ab08cb08a04aa60e65e268893fc1d158fb9895745963c687416c0158e693250d41cefdaf2b71583ff96
- Loading branch information
Showing
132 changed files
with
8,089 additions
and
8,160 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| # This file was automatically created by vendor-libsecp.sh | ||
| 199d27cea32203b224b208627533c2e813cd3b21 | ||
| 1ad5185cd42c0636104129fcc9f6a4bf9c67cc40 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| env: | ||
| ### cirrus config | ||
| CIRRUS_CLONE_DEPTH: 1 | ||
| ### compiler options | ||
| HOST: | ||
| WRAPPER_CMD: | ||
| # Specific warnings can be disabled with -Wno-error=foo. | ||
| # -pedantic-errors is not equivalent to -Werror=pedantic and thus not implied by -Werror according to the GCC manual. | ||
| WERROR_CFLAGS: -Werror -pedantic-errors | ||
| MAKEFLAGS: -j4 | ||
| BUILD: check | ||
| ### secp256k1 config | ||
| ECMULTWINDOW: auto | ||
| ECMULTGENPRECISION: auto | ||
| ASM: no | ||
| WIDEMUL: auto | ||
| WITH_VALGRIND: yes | ||
| EXTRAFLAGS: | ||
| ### secp256k1 modules | ||
| EXPERIMENTAL: no | ||
| ECDH: no | ||
| RECOVERY: no | ||
| SCHNORRSIG: no | ||
| ELLSWIFT: no | ||
| ### test options | ||
| SECP256K1_TEST_ITERS: | ||
| BENCH: yes | ||
| SECP256K1_BENCH_ITERS: 2 | ||
| CTIMETESTS: yes | ||
| # Compile and run the tests | ||
| EXAMPLES: yes | ||
|
|
||
| cat_logs_snippet: &CAT_LOGS | ||
| always: | ||
| cat_tests_log_script: | ||
| - cat tests.log || true | ||
| cat_noverify_tests_log_script: | ||
| - cat noverify_tests.log || true | ||
| cat_exhaustive_tests_log_script: | ||
| - cat exhaustive_tests.log || true | ||
| cat_ctime_tests_log_script: | ||
| - cat ctime_tests.log || true | ||
| cat_bench_log_script: | ||
| - cat bench.log || true | ||
| cat_config_log_script: | ||
| - cat config.log || true | ||
| cat_test_env_script: | ||
| - cat test_env.log || true | ||
| cat_ci_env_script: | ||
| - env | ||
|
|
||
| linux_arm64_container_snippet: &LINUX_ARM64_CONTAINER | ||
| env_script: | ||
| - env | tee /tmp/env | ||
| build_script: | ||
| - DOCKER_BUILDKIT=1 docker build --file "ci/linux-debian.Dockerfile" --tag="ci_secp256k1_arm" | ||
| - docker image prune --force # Cleanup stale layers | ||
| test_script: | ||
| - docker run --rm --mount "type=bind,src=./,dst=/ci_secp256k1" --env-file /tmp/env --replace --name "ci_secp256k1_arm" "ci_secp256k1_arm" bash -c "cd /ci_secp256k1/ && ./ci/ci.sh" | ||
|
|
||
| task: | ||
| name: "ARM64: Linux (Debian stable)" | ||
| persistent_worker: | ||
| labels: | ||
| type: arm64 | ||
| env: | ||
| ECDH: yes | ||
| RECOVERY: yes | ||
| SCHNORRSIG: yes | ||
| ELLSWIFT: yes | ||
| matrix: | ||
| # Currently only gcc-snapshot, the other compilers are tested on GHA with QEMU | ||
| - env: { CC: 'gcc-snapshot' } | ||
| << : *LINUX_ARM64_CONTAINER | ||
| << : *CAT_LOGS | ||
|
|
||
| task: | ||
| name: "ARM64: Linux (Debian stable), Valgrind" | ||
| persistent_worker: | ||
| labels: | ||
| type: arm64 | ||
| env: | ||
| ECDH: yes | ||
| RECOVERY: yes | ||
| SCHNORRSIG: yes | ||
| ELLSWIFT: yes | ||
| WRAPPER_CMD: 'valgrind --error-exitcode=42' | ||
| SECP256K1_TEST_ITERS: 2 | ||
| matrix: | ||
| - env: { CC: 'gcc' } | ||
| - env: { CC: 'clang' } | ||
| - env: { CC: 'gcc-snapshot' } | ||
| - env: { CC: 'clang-snapshot' } | ||
| << : *LINUX_ARM64_CONTAINER | ||
| << : *CAT_LOGS |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| # Contributing to libsecp256k1 | ||
|
|
||
| ## Scope | ||
|
|
||
| libsecp256k1 is a library for elliptic curve cryptography on the curve secp256k1, not a general-purpose cryptography library. | ||
| The library primarily serves the needs of the Bitcoin Core project but provides additional functionality for the benefit of the wider Bitcoin ecosystem. | ||
|
|
||
| ## Adding new functionality or modules | ||
|
|
||
| The libsecp256k1 project welcomes contributions in the form of new functionality or modules, provided they are within the project's scope. | ||
|
|
||
| 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. | ||
| Contributors are recommended to provide the following in addition to the new code: | ||
|
|
||
| * **Specification:** | ||
| A specification can help significantly in reviewing the new code as it provides documentation and context. | ||
| It may justify various design decisions, give a motivation and outline security goals. | ||
| If the specification contains pseudocode, a reference implementation or test vectors, these can be used to compare with the proposed libsecp256k1 code. | ||
| * **Security Arguments:** | ||
| In addition to a defining the security goals, it should be argued that the new functionality meets these goals. | ||
| 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. | ||
| * **Relevance Arguments:** | ||
| The relevance of the new functionality for the Bitcoin ecosystem should be argued by outlining clear use cases. | ||
|
|
||
| These are not the only factors taken into account when considering to add new functionality. | ||
| The proposed new libsecp256k1 code must be of high quality, including API documentation and tests, as well as featuring a misuse-resistant API design. | ||
|
|
||
| We recommend reaching out to other contributors (see [Communication Channels](#communication-channels)) and get feedback before implementing new functionality. | ||
|
|
||
| ## Communication channels | ||
|
|
||
| Most communication about libsecp256k1 occurs on the GitHub repository: in issues, pull request or on the discussion board. | ||
|
|
||
| Additionally, there is an IRC channel dedicated to libsecp256k1, with biweekly meetings (see channel topic). | ||
| The channel is `#secp256k1` on Libera Chat. | ||
| The easiest way to participate on IRC is with the web client, [web.libera.chat](https://web.libera.chat/#secp256k1). | ||
| Chat history logs can be found at https://gnusha.org/secp256k1/. | ||
|
|
||
| ## Contributor workflow & peer review | ||
|
|
||
| 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). | ||
|
|
||
| ### Coding conventions | ||
|
|
||
| In addition, libsecp256k1 tries to maintain the following coding conventions: | ||
|
|
||
| * No runtime heap allocation (e.g., no `malloc`) unless explicitly requested by the caller (via `rustsecp256k1_v0_10_0_context_create` or `rustsecp256k1_v0_10_0_scratch_space_create`, for example). Morever, it should be possible to use the library without any heap allocations. | ||
| * The tests should cover all lines and branches of the library (see [Test coverage](#coverage)). | ||
| * 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)). | ||
| * Local variables containing secret data should be cleared explicitly to try to delete secrets from memory. | ||
| * Use `rustsecp256k1_v0_10_0_memcmp_var` instead of `memcmp` (see [#823](https://github.com/bitcoin-core/secp256k1/issues/823)). | ||
|
|
||
| #### Style conventions | ||
|
|
||
| * 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. | ||
| * 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. | ||
| * 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: | ||
| ```C | ||
| void secp256k_foo(void) { | ||
| unsigned int x; /* declaration */ | ||
| int y = 2*x; /* declaration */ | ||
| x = 17; /* statement */ | ||
| { | ||
| int a, b; /* declaration */ | ||
| a = x + y; /* statement */ | ||
| secp256k_bar(x, &b); /* statement */ | ||
| } | ||
| } | ||
| ``` | ||
| * Use `unsigned int` instead of just `unsigned`. | ||
| * Use `void *ptr` instead of `void* ptr`. | ||
| * Arguments of the publicly-facing API must have a specific order defined in [include/secp256k1.h](include/secp256k1.h). | ||
| * User-facing comment lines in headers should be limited to 80 chars if possible. | ||
| * All identifiers in file scope should start with `rustsecp256k1_v0_10_0_`. | ||
| * Avoid trailing whitespace. | ||
|
|
||
| ### Tests | ||
|
|
||
| #### Coverage | ||
|
|
||
| This library aims to have full coverage of reachable lines and branches. | ||
|
|
||
| To create a test coverage report, configure with `--enable-coverage` (use of GCC is necessary): | ||
|
|
||
| $ ./configure --enable-coverage | ||
|
|
||
| Run the tests: | ||
|
|
||
| $ make check | ||
|
|
||
| To create a report, `gcovr` is recommended, as it includes branch coverage reporting: | ||
|
|
||
| $ gcovr --exclude 'src/bench*' --print-summary | ||
|
|
||
| To create a HTML report with coloured and annotated source code: | ||
|
|
||
| $ mkdir -p coverage | ||
| $ gcovr --exclude 'src/bench*' --html --html-details -o coverage/coverage.html | ||
|
|
||
| #### Exhaustive tests | ||
|
|
||
| There are tests of several functions in which a small group replaces secp256k1. | ||
| 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)). | ||
|
|
||
| ### Benchmarks | ||
|
|
||
| See `src/bench*.c` for examples of benchmarks. |
Oops, something went wrong.