Skip to content

Commit 67f232b

Browse files
committed
Squashed 'src/secp256k1/' changes from b19c000063..2ed54da18a
2ed54da18a Merge bitcoin-core#755: Recovery signing: add to constant time test, and eliminate non ct operators 28609507e7 Add tests for the cmov implementations 73596a85a2 Add ecdsa_sign_recoverable to the ctime tests 2876af4f8d Split ecdsa_sign logic into a new function and use it from ecdsa_sign and recovery 5e1c885efb Merge bitcoin-core#754: Fix uninit values passed into cmov f79a7adcf5 Add valgrind uninit check to cmovs output 05d315affe Merge bitcoin-core#752: autoconf: Use ":" instead of "dnl" as a noop a39c2b09de Fixed UB(arithmetics on uninit values) in cmovs 3a6fd7f636 Merge bitcoin-core#750: Add macOS to the CI 5e8747ae2a autoconf: Use ":" instead of "dnl" as a noop 71757da5cc Explictly pass SECP256K1_BENCH_ITERS to the benchmarks in travis.sh 99bd661d71 Replace travis_wait with a loop printing "\a" to stdout every minute bc818b160c Bump travis Ubuntu from xenial(16.04) to bionic(18.04) 0c5ff9066e Add macOS support to travis b6807d91d8 Move travis script into a standalone sh file f39f99be0e Merge bitcoin-core#701: Make ec_ arithmetic more consistent and add documentation 39198a03ea Merge bitcoin-core#732: Retry if r is zero during signing 59a8de8f64 Merge bitcoin-core#742: Fix typo in ecmult_const_impl.h 4e284655d9 Fix typo in ecmult_const_impl.h f862b4ca13 Merge bitcoin-core#740: Make recovery/main_impl.h non-executable ffef45c98a Make recovery/main_impl.h non-executable 2361b3719a Merge bitcoin-core#735: build: fix OpenSSL EC detection on macOS 3b7d26b23c build: add SECP_TEST_INCLUDES to bench_verify CPPFLAGS 84b5fc5bc3 build: fix OpenSSL EC detection on macOS 37ed51a7ea Make ecdsa_sig_sign constant-time again after reverting 25e3cfb 93d343bfc5 Revert "ecdsa_impl: replace scalar if-checks with VERIFY_CHECKs in ecdsa_sig_sign" 7e3952ae82 Clarify documentation of tweak functions. 89853a0f2e Make tweak function documentation more consistent. 41fc785602 Make ec_privkey functions aliases for ec_seckey_negate, ec_seckey_tweak_add and ec_seckey_mul 22911ee6da Rename private key to secret key in public API (with the exception of function names) 5a73f14d6c Mention that value is unspecified for In/Out parameters if the function returns 0 f03df0e6d7 Define valid ECDSA keys in the documentation of seckey_verify 5894e1f1df Return 0 if the given seckey is invalid in privkey_negate, privkey_tweak_add and privkey_tweak_mul 8f814cddb9 Add test for boundary conditions of scalar_set_b32 with respect to overflows 3fec982608 Use scalar_set_b32_seckey in ecdsa_sign, pubkey_create and seckey_verify 9ab2cbe0eb Add scalar_set_b32_seckey which does the same as scalar_set_b32 and also returns whether it's a valid secret key 4f27e344c6 Merge bitcoin-core#728: Suppress a harmless variable-time optimization by clang in memczero 01993878bb Add test for memczero() 52a03512c1 Suppress a harmless variable-time optimization by clang in memczero 8f78e208ad Merge bitcoin-core#722: Context isn't freed in the ECDH benchmark ed1b91171a Merge bitcoin-core#700: Allow overriding default flags 85b35afa76 Add running benchmarks regularly and under valgrind in travis ca4906b02e Pass num of iters to benchmarks as variable, and define envvar 02dd5f1bbb free the ctx at the end of bench_ecdh e9fccd4de1 Merge bitcoin-core#708: Constant-time behaviour test using valgrind memtest. 08fb6c4926 Run valgrind_ctime_test in travis 3d2302257f Constant-time behaviour test using valgrind memtest. 96d8ccbd16 Merge bitcoin-core#710: Eliminate harmless non-constant time operations on secret data. 0585b8b2ee Merge bitcoin-core#718: Clarify that a secp256k1_ecdh_hash_function must return 0 or 1 7b50483ad7 Adds a declassify operation to aid constant-time analysis. 34a67c773b Eliminate harmless non-constant time operations on secret data. ca739cba23 Compile with optimization flag -O2 by default instead of -O3 eb45ef3384 Clarify that a secp256k1_ecdh_hash_function must return 0 or 1 856a01d6ad Merge bitcoin-core#714: doc: document the length requirements of output parameter. d72b9e2483 Merge bitcoin-core#682: Remove Java Native Interface 4b48a43106 doc: document the length requirements of output parameter. 1b4d256e2e Merge bitcoin-core#713: Docstrings dabfea7e21 field: extend docstring of secp256k1_fe_normalize dc7d8fd9e2 scalar: extend docstring of secp256k1_scalar_set_b32 074ab582dd Merge bitcoin-core#704: README: add a section for test coverage acb7f97eb8 README: add a section for test coverage 227a4f2d07 Merge bitcoin-core#709: Remove secret-dependant non-constant time operation in ecmult_const. d567b779fe Clarify comments about use of rzr on ge functions and abs function. 2241ae6d14 Remove secret-dependant non-constant time operation in ecmult_const. 642cd062bd Remove Java Native Interface 83fb1bcef4 Remove -O2 from default CFLAGS because this would override the -O3 flag (see AC_PROG_CC in the Autoconf manual) ecba8138ec Append instead of Prepend user-CFLAGS to default CFLAGS allowing the user to override default variables 613c34cd86 Remove test in configure.ac because it doesn't have an effect f45d897101 Merge bitcoin-core#703: Overhaul README.md 2e759ec753 Overhaul README.md d644dda5c9 Merge bitcoin-core#689: Remove "except in benchmarks" exception for fp math bde2a32286 Convert bench.h to fixed-point math 387d723c3f Merge bitcoin-core#679: Add SECURITY.md 0db61d25c9 Merge bitcoin-core#685: Fix issue where travis does not show the ./tests seed… a0771d15e6 Explicitly disable buffering for stderr in tests fb424fbba2 Make travis show the ./tests seed by removing stdout buffering and always cat tests.log after a travis run. 22a6031184 Merge bitcoin-core#690: Add valgrind check to travis 544002c008 Merge bitcoin-core#678: Preventing compiler optimizations in benchmarks without a memory fence dd98cc988f travis: Added a valgrind test without endro and enabled recovery+ecdh b4c1382a87 Add valgrind check to travis 0c774d89e6 Merge bitcoin-core#688: Fix ASM setting in travis 5c5f71eea5 Fix ASM setting in travis e2625f8a98 Merge bitcoin-core#684: Make no-float policy explicit bae1bea3c4 Make no-float policy explicit 78c3836341 Add SECURITY.md 362bb25608 Modified bench_scalar_split so it won't get optimized out 73a30c6b58 Added accumulators and checks on benchmarks so they won't get optimized out 770b3dcd6f Merge bitcoin-core#677: Remove note about heap allocation in secp256k1_ecmult_odd_multiples_table_storage_var b76142ff25 Remove note about heap allocation in secp256k1_ecmult_odd_multiples_table_storage_var which was removed in 47045270fa90f81205d989f7107769bce1e71c4d 137d304a6b Merge bitcoin-core#647: Increase robustness against UB in secp256k1_scalar_cadd_bit 0d9540b13f Merge bitcoin-core#664: Remove mention of ec_privkey_export because it doesn't exist 59782c68b4 Remove mention of ec_privkey_export because it doesn't exist 96cd94e385 Merge bitcoin-core#337: variable sized precomputed table for signing dcb2e3b3ff variable signing precompute table b4bff99028 Merge bitcoin-core#661: Make ./configure string consistent a467047e11 Make ./configure string consistent e729cc7f5a Merge bitcoin-core#657: Fix a nit in the recovery tests b64a2e2597 Fix a nit in the recovery tests e028aa33d3 Merge bitcoin-core#650: secp256k1/src/tests.c: Properly handle sscanf return value f1e11d363d Merge bitcoin-core#654: Fix typo (∞) ef83281c3a Merge pull request bitcoin-core#656 from real-or-random/patch-1 556caad2ca Fix typo in docs for _context_set_illegal_callback 0d82732a9a Improve VERIFY_CHECK of overflow in secp256k1_scalar_cadd_bit. This added check ensures that any curve order overflow doesn't go undetected due a uint32_t overflow. 786dfb49f5 Merge bitcoin-core#583: JNI: fix use sig array e95f8ab098 Merge bitcoin-core#644: Avoid optimizing out a verify_check 384f55606a Merge bitcoin-core#652: README.md: update instruction to run tests ee56accd47 Merge bitcoin-core#651: Fix typo in secp256k1_preallocated.h 7b9b117230 Merge bitcoin-core#640: scalar_impl.h: fix includes d99bec2e21 Merge bitcoin-core#655: jni: Use only Guava for hex encoding and decoding 2abcf951af jni: Use only Guava for hex encoding and decoding 271582b3b7 Fix typo ce6d438266 README.md: update instruction to run tests b1e68cb8e6 Fix typo in secp256k1_preallocated.h a11c76c59a secp256k1/src/tests.c: Properly handle sscanf return value 8fe63e5654 Increase robustness against UB. Thanks to elichai2 who noted that the literal '1' is a signed integer, and that shifting a signed 32-bit integer by 31 bits causes an overflow and yields undefined behaviour. While 'scalar_low_impl''s 'secp256k1_scalar_cadd_bit' is only used for testing purposes and currently the 'bit' parameter is only 0 or 1, it is better to avoid undefined behaviour in case the used domain of 'secp256k1_scalar_cadd_bit' expands. 94ae7cbf83 Moved a dereference so the null check will be before the dereferencing 2cb73b1064 scalar_impl.h: fix includes fa33017135 Merge bitcoin-core#634: Add a descriptive comment for secp256k1_ecmult_const. ee9e68cd30 Add a descriptive comment for secp256k1_ecmult_const. d0d738d32d Merge bitcoin-core#631: typo in comment for secp256k1_ec_pubkey_tweak_mul () 6914c25276 typo in comment for secp256k1_ec_pubkey_tweak_mul () e541a90ef6 Merge bitcoin-core#629: Avoid calling _is_zero when _set_b32 fails. f34b0c3f35 Merge bitcoin-core#630: Note intention of timing sidechannel freeness. 8d1563b0ff Note intention of timing sidechannel freeness. 1669bb2865 Merge bitcoin-core#628: Fix ability to compile tests without -DVERIFY. ecc94abcc8 Merge bitcoin-core#627: Guard memcmp in tests against mixed size inputs. 544435fc90 Merge bitcoin-core#578: Avoid implementation-defined and undefined behavior when dealing with sizes 143dc6e9ee Merge bitcoin-core#595: Allow to use external default callbacks e49f7991c2 Add missing #(un)defines to base-config.h 77defd2c3b Add secp256k1_ prefix to default callback functions 908bdce64e Include stdio.h and stdlib.h explicitly in secp256k1.c 5db782e655 Allow usage of external default callbacks 6095a863fa Replace CHECKs for no_precomp ctx by ARG_CHECKs without a return cd473e02c3 Avoid calling secp256k1_*_is_zero when secp256k1_*_set_b32 fails. 6c36de7a33 Merge bitcoin-core#600: scratch space: use single allocation 98836b11f0 scratch: replace frames with "checkpoint" system 7623cf2b97 scratch: save a couple bytes of unnecessarily-allocated memory a7a164f2c6 scratch: rename `max_size` to `size`, document that extra will actually be allocated 5a4bc0bb95 scratch: unify allocations c2b028a281 scratch space: thread `error_callback` into all scratch space functions 0be1a4ae62 scratch: add magic bytes to beginning of structure 92a48a764d scratch space: use single allocation 40839e21b9 Merge bitcoin-core#592: Use trivial algorithm in ecmult_multi if scratch space is small dcf392027b Fix ability to compile tests without -DVERIFY. a484e0008b Merge bitcoin-core#566: Enable context creation in preallocated memory 0522caac8f Explain caller's obligations for preallocated memory 238305fdbb Move _preallocated functions to separate header 695feb6fbd Export _preallocated functions 814cc78d71 Add tests for contexts in preallocated memory ba12dd08da Check arguments of _preallocated functions 5feadde462 Support cloning a context into preallocated memory c4fd5dab45 Switch to a single malloc call ef020de16f Add size constants for preallocated memory 1bf7c056ba Prepare for manual memory management in preallocated memory 248bffb052 Guard memcmp in tests against mixed size inputs. 36698dcfee Merge bitcoin-core#596: Make WINDOW_G configurable a61a93ff50 Clean up ./configure help strings 2842dc523e Make WINDOW_G configurable 1a02d6ce51 Merge bitcoin-core#626: Revert "Merge bitcoin-core#620: Install headers automatically" 662918cb29 Revert "Merge bitcoin-core#620: Install headers automatically" 14c7dbd444 Simplify control flow in DER parsing ec8f20babd Avoid out-of-bound pointers and integer overflows in size comparisons 01ee1b3b3c Parse DER-enconded length into a size_t instead of an int 912680ed86 Merge bitcoin-core#561: Respect LDFLAGS and #undef STATIC_PRECOMPUTATION if using basic config 91fae3ace0 Merge bitcoin-core#620: Install headers automatically 5df77a0eda Merge bitcoin-core#533: Make sure we're not using an uninitialized variable in secp256k1_wnaf_const(...) 975e51e0d9 Merge bitcoin-core#617: Pass scalar by reference in secp256k1_wnaf_const() 735fbde04e Merge bitcoin-core#619: Clear a copied secret key after negation 16e86150d0 Install headers automatically 069870d92a Clear a copied secret key after negation 8979ec0d9a Pass scalar by reference in secp256k1_wnaf_const() 84a808598b Merge bitcoin-core#612: Allow field_10x26_arm.s to compile for ARMv7 architecture d4d270a59c Allow field_10x26_arm.s to compile for ARMv7 architecture 248f046611 Make sure we're not using an uninitialized variable in secp256k1_wnaf_const(...) 9ab96f7b12 Use trivial algorithm in ecmult_multi if scratch space is small dbed75d969 Undefine `STATIC_PRECOMPUTATION` if using the basic config 310111e093 Keep LDFLAGS if `--coverage` 74e2dbd68e JNI: fix use sig array 3cb057f842 Fix possible integer overflow in DER parsing git-subtree-dir: src/secp256k1 git-subtree-split: 2ed54da18add295668ec71c91534b640d2cc029b
1 parent 5424598 commit 67f232b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+2392
-2436
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ bench_internal
99
tests
1010
exhaustive_tests
1111
gen_context
12+
valgrind_ctime_test
1213
*.exe
1314
*.so
1415
*.a

.travis.yml

Lines changed: 56 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,23 @@
11
language: c
2-
os: linux
2+
os:
3+
- linux
4+
- osx
5+
6+
dist: bionic
7+
# Valgrind currently supports upto macOS 10.13, the latest xcode of that version is 10.1
8+
osx_image: xcode10.1
39
addons:
410
apt:
5-
packages: libgmp-dev
11+
packages:
12+
- libgmp-dev
13+
- valgrind
14+
- libtool-bin
615
compiler:
716
- clang
817
- gcc
9-
cache:
10-
directories:
11-
- src/java/guava/
1218
env:
1319
global:
14-
- FIELD=auto BIGNUM=auto SCALAR=auto ENDOMORPHISM=no STATICPRECOMPUTATION=yes ASM=no BUILD=check EXTRAFLAGS= HOST= ECDH=no RECOVERY=no EXPERIMENTAL=no JNI=no
15-
- GUAVA_URL=https://search.maven.org/remotecontent?filepath=com/google/guava/guava/18.0/guava-18.0.jar GUAVA_JAR=src/java/guava/guava-18.0.jar
20+
- FIELD=auto BIGNUM=auto SCALAR=auto ENDOMORPHISM=no STATICPRECOMPUTATION=yes ECMULTGENPRECISION=auto ASM=no BUILD=check EXTRAFLAGS= HOST= ECDH=no RECOVERY=no EXPERIMENTAL=no CTIMETEST=yes BENCH=yes ITERS=2
1621
matrix:
1722
- SCALAR=32bit RECOVERY=yes
1823
- SCALAR=32bit FIELD=32bit ECDH=yes EXPERIMENTAL=yes
@@ -26,43 +31,78 @@ env:
2631
- BIGNUM=no
2732
- BIGNUM=no ENDOMORPHISM=yes RECOVERY=yes EXPERIMENTAL=yes
2833
- BIGNUM=no STATICPRECOMPUTATION=no
29-
- BUILD=distcheck
30-
- EXTRAFLAGS=CPPFLAGS=-DDETERMINISTIC
31-
- EXTRAFLAGS=CFLAGS=-O0
32-
- BUILD=check-java JNI=yes ECDH=yes EXPERIMENTAL=yes
34+
- BUILD=distcheck CTIMETEST= BENCH=
35+
- CPPFLAGS=-DDETERMINISTIC
36+
- CFLAGS=-O0 CTIMETEST=
37+
- ECMULTGENPRECISION=2
38+
- ECMULTGENPRECISION=8
39+
- VALGRIND=yes ENDOMORPHISM=yes BIGNUM=no ASM=x86_64 EXPERIMENTAL=yes ECDH=yes RECOVERY=yes EXTRAFLAGS="--disable-openssl-tests" CPPFLAGS=-DVALGRIND BUILD=
40+
- VALGRIND=yes BIGNUM=no ASM=x86_64 EXPERIMENTAL=yes ECDH=yes RECOVERY=yes EXTRAFLAGS="--disable-openssl-tests" CPPFLAGS=-DVALGRIND BUILD=
3341
matrix:
3442
fast_finish: true
3543
include:
3644
- compiler: clang
45+
os: linux
3746
env: HOST=i686-linux-gnu ENDOMORPHISM=yes
3847
addons:
3948
apt:
4049
packages:
4150
- gcc-multilib
4251
- libgmp-dev:i386
52+
- valgrind
53+
- libtool-bin
54+
- libc6-dbg:i386
4355
- compiler: clang
4456
env: HOST=i686-linux-gnu
57+
os: linux
4558
addons:
4659
apt:
4760
packages:
4861
- gcc-multilib
62+
- valgrind
63+
- libtool-bin
64+
- libc6-dbg:i386
4965
- compiler: gcc
5066
env: HOST=i686-linux-gnu ENDOMORPHISM=yes
67+
os: linux
5168
addons:
5269
apt:
5370
packages:
5471
- gcc-multilib
72+
- valgrind
73+
- libtool-bin
74+
- libc6-dbg:i386
5575
- compiler: gcc
76+
os: linux
5677
env: HOST=i686-linux-gnu
5778
addons:
5879
apt:
5980
packages:
6081
- gcc-multilib
6182
- libgmp-dev:i386
62-
before_install: mkdir -p `dirname $GUAVA_JAR`
63-
install: if [ ! -f $GUAVA_JAR ]; then wget $GUAVA_URL -O $GUAVA_JAR; fi
83+
- valgrind
84+
- libtool-bin
85+
- libc6-dbg:i386
86+
87+
# We use this to install macOS dependencies instead of the built in `homebrew` plugin,
88+
# because in xcode earlier than 11 they have a bug requiring updating the system which overall takes ~8 minutes.
89+
# https://travis-ci.community/t/macos-build-fails-because-of-homebrew-bundle-unknown-command/7296
90+
before_install:
91+
- if [ "${TRAVIS_OS_NAME}" = "osx" ]; then HOMEBREW_NO_AUTO_UPDATE=1 brew install gmp valgrind gcc@9; fi
92+
6493
before_script: ./autogen.sh
94+
95+
# travis auto terminates jobs that go for 10 minutes without printing to stdout, but travis_wait doesn't work well with forking programs like valgrind (https://docs.travis-ci.com/user/common-build-problems/#build-times-out-because-no-output-was-received https://github.com/bitcoin-core/secp256k1/pull/750#issuecomment-623476860)
6596
script:
66-
- if [ -n "$HOST" ]; then export USE_HOST="--host=$HOST"; fi
67-
- if [ "x$HOST" = "xi686-linux-gnu" ]; then export CC="$CC -m32"; fi
68-
- ./configure --enable-experimental=$EXPERIMENTAL --enable-endomorphism=$ENDOMORPHISM --with-field=$FIELD --with-bignum=$BIGNUM --with-scalar=$SCALAR --enable-ecmult-static-precomputation=$STATICPRECOMPUTATION --enable-module-ecdh=$ECDH --enable-module-recovery=$RECOVERY --enable-jni=$JNI $EXTRAFLAGS $USE_HOST && make -j2 $BUILD
97+
- function keep_alive() { while true; do echo -en "\a"; sleep 60; done }
98+
- keep_alive &
99+
- ./contrib/travis.sh
100+
- kill %keep_alive
101+
102+
after_script:
103+
- cat ./tests.log
104+
- cat ./exhaustive_tests.log
105+
- cat ./valgrind_ctime_test.log
106+
- cat ./bench.log
107+
- $CC --version
108+
- valgrind --version

Makefile.am

Lines changed: 17 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,8 @@
11
ACLOCAL_AMFLAGS = -I build-aux/m4
22

33
lib_LTLIBRARIES = libsecp256k1.la
4-
if USE_JNI
5-
JNI_LIB = libsecp256k1_jni.la
6-
noinst_LTLIBRARIES = $(JNI_LIB)
7-
else
8-
JNI_LIB =
9-
endif
104
include_HEADERS = include/secp256k1.h
5+
include_HEADERS += include/secp256k1_preallocated.h
116
noinst_HEADERS =
127
noinst_HEADERS += src/scalar.h
138
noinst_HEADERS += src/scalar_4x64.h
@@ -39,8 +34,6 @@ noinst_HEADERS += src/field_5x52.h
3934
noinst_HEADERS += src/field_5x52_impl.h
4035
noinst_HEADERS += src/field_5x52_int128_impl.h
4136
noinst_HEADERS += src/field_5x52_asm_impl.h
42-
noinst_HEADERS += src/java/org_bitcoin_NativeSecp256k1.h
43-
noinst_HEADERS += src/java/org_bitcoin_Secp256k1Context.h
4437
noinst_HEADERS += src/util.h
4538
noinst_HEADERS += src/scratch.h
4639
noinst_HEADERS += src/scratch_impl.h
@@ -74,16 +67,19 @@ endif
7467

7568
libsecp256k1_la_SOURCES = src/secp256k1.c
7669
libsecp256k1_la_CPPFLAGS = -DSECP256K1_BUILD -I$(top_srcdir)/include -I$(top_srcdir)/src $(SECP_INCLUDES)
77-
libsecp256k1_la_LIBADD = $(JNI_LIB) $(SECP_LIBS) $(COMMON_LIB)
70+
libsecp256k1_la_LIBADD = $(SECP_LIBS) $(COMMON_LIB)
7871

79-
libsecp256k1_jni_la_SOURCES = src/java/org_bitcoin_NativeSecp256k1.c src/java/org_bitcoin_Secp256k1Context.c
80-
libsecp256k1_jni_la_CPPFLAGS = -DSECP256K1_BUILD $(JNI_INCLUDES)
72+
if VALGRIND_ENABLED
73+
libsecp256k1_la_CPPFLAGS += -DVALGRIND
74+
endif
8175

8276
noinst_PROGRAMS =
8377
if USE_BENCHMARK
8478
noinst_PROGRAMS += bench_verify bench_sign bench_internal bench_ecmult
8579
bench_verify_SOURCES = src/bench_verify.c
8680
bench_verify_LDADD = libsecp256k1.la $(SECP_LIBS) $(SECP_TEST_LIBS) $(COMMON_LIB)
81+
# SECP_TEST_INCLUDES are only used here for CRYPTO_CPPFLAGS
82+
bench_verify_CPPFLAGS = -DSECP256K1_BUILD $(SECP_TEST_INCLUDES)
8783
bench_sign_SOURCES = src/bench_sign.c
8884
bench_sign_LDADD = libsecp256k1.la $(SECP_LIBS) $(SECP_TEST_LIBS) $(COMMON_LIB)
8985
bench_internal_SOURCES = src/bench_internal.c
@@ -99,6 +95,12 @@ if USE_TESTS
9995
noinst_PROGRAMS += tests
10096
tests_SOURCES = src/tests.c
10197
tests_CPPFLAGS = -DSECP256K1_BUILD -I$(top_srcdir)/src -I$(top_srcdir)/include $(SECP_INCLUDES) $(SECP_TEST_INCLUDES)
98+
if VALGRIND_ENABLED
99+
tests_CPPFLAGS += -DVALGRIND
100+
noinst_PROGRAMS += valgrind_ctime_test
101+
valgrind_ctime_test_SOURCES = src/valgrind_ctime_test.c
102+
valgrind_ctime_test_LDADD = libsecp256k1.la $(SECP_LIBS) $(SECP_TEST_LIBS) $(COMMON_LIB)
103+
endif
102104
if !ENABLE_COVERAGE
103105
tests_CPPFLAGS += -DVERIFY
104106
endif
@@ -119,42 +121,12 @@ exhaustive_tests_LDFLAGS = -static
119121
TESTS += exhaustive_tests
120122
endif
121123

122-
JAVAROOT=src/java
123-
JAVAORG=org/bitcoin
124-
JAVA_GUAVA=$(srcdir)/$(JAVAROOT)/guava/guava-18.0.jar
125-
CLASSPATH_ENV=CLASSPATH=$(JAVA_GUAVA)
126-
JAVA_FILES= \
127-
$(JAVAROOT)/$(JAVAORG)/NativeSecp256k1.java \
128-
$(JAVAROOT)/$(JAVAORG)/NativeSecp256k1Test.java \
129-
$(JAVAROOT)/$(JAVAORG)/NativeSecp256k1Util.java \
130-
$(JAVAROOT)/$(JAVAORG)/Secp256k1Context.java
131-
132-
if USE_JNI
133-
134-
$(JAVA_GUAVA):
135-
@echo Guava is missing. Fetch it via: \
136-
wget https://search.maven.org/remotecontent?filepath=com/google/guava/guava/18.0/guava-18.0.jar -O $(@)
137-
@false
138-
139-
.stamp-java: $(JAVA_FILES)
140-
@echo Compiling $^
141-
$(AM_V_at)$(CLASSPATH_ENV) javac $^
142-
@touch $@
143-
144-
if USE_TESTS
145-
146-
check-java: libsecp256k1.la $(JAVA_GUAVA) .stamp-java
147-
$(AM_V_at)java -Djava.library.path="./:./src:./src/.libs:.libs/" -cp "$(JAVA_GUAVA):$(JAVAROOT)" $(JAVAORG)/NativeSecp256k1Test
148-
149-
endif
150-
endif
151-
152124
if USE_ECMULT_STATIC_PRECOMPUTATION
153-
CPPFLAGS_FOR_BUILD +=-I$(top_srcdir)
125+
CPPFLAGS_FOR_BUILD +=-I$(top_srcdir) -I$(builddir)/src
154126

155127
gen_context_OBJECTS = gen_context.o
156128
gen_context_BIN = gen_context$(BUILD_EXEEXT)
157-
gen_%.o: src/gen_%.c
129+
gen_%.o: src/gen_%.c src/libsecp256k1-config.h
158130
$(CC_FOR_BUILD) $(CPPFLAGS_FOR_BUILD) $(CFLAGS_FOR_BUILD) -c $< -o $@
159131

160132
$(gen_context_BIN): $(gen_context_OBJECTS)
@@ -168,10 +140,10 @@ $(bench_ecmult_OBJECTS): src/ecmult_static_context.h
168140
src/ecmult_static_context.h: $(gen_context_BIN)
169141
./$(gen_context_BIN)
170142

171-
CLEANFILES = $(gen_context_BIN) src/ecmult_static_context.h $(JAVAROOT)/$(JAVAORG)/*.class .stamp-java
143+
CLEANFILES = $(gen_context_BIN) src/ecmult_static_context.h
172144
endif
173145

174-
EXTRA_DIST = autogen.sh src/gen_context.c src/basic-config.h $(JAVA_FILES)
146+
EXTRA_DIST = autogen.sh src/gen_context.c src/basic-config.h
175147

176148
if ENABLE_MODULE_ECDH
177149
include src/modules/ecdh/Makefile.am.include

README.md

Lines changed: 54 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,22 @@ libsecp256k1
33

44
[![Build Status](https://travis-ci.org/bitcoin-core/secp256k1.svg?branch=master)](https://travis-ci.org/bitcoin-core/secp256k1)
55

6-
Optimized C library for EC operations on curve secp256k1.
6+
Optimized C library for ECDSA signatures and secret/public key operations on curve secp256k1.
77

8-
This library is a work in progress and is being used to research best practices. Use at your own risk.
8+
This library is intended to be the highest quality publicly available library for cryptography on the secp256k1 curve. However, the primary focus of its development has been for usage in the Bitcoin system and usage unlike Bitcoin's may be less well tested, verified, or suffer from a less well thought out interface. Correct usage requires some care and consideration that the library is fit for your application's purpose.
99

1010
Features:
1111
* secp256k1 ECDSA signing/verification and key generation.
12-
* Adding/multiplying private/public keys.
13-
* Serialization/parsing of private keys, public keys, signatures.
14-
* Constant time, constant memory access signing and pubkey generation.
15-
* Derandomized DSA (via RFC6979 or with a caller provided function.)
12+
* Additive and multiplicative tweaking of secret/public keys.
13+
* Serialization/parsing of secret keys, public keys, signatures.
14+
* Constant time, constant memory access signing and public key generation.
15+
* Derandomized ECDSA (via RFC6979 or with a caller provided function.)
1616
* Very efficient implementation.
17+
* Suitable for embedded systems.
18+
* Optional module for public key recovery.
19+
* Optional module for ECDH key exchange (experimental).
20+
21+
Experimental features have not received enough scrutiny to satisfy the standard of quality of this library but are made available for testing and review by the community. The APIs of these features should not be considered stable.
1722

1823
Implementation details
1924
----------------------
@@ -23,11 +28,12 @@ Implementation details
2328
* Extensive testing infrastructure.
2429
* Structured to facilitate review and analysis.
2530
* Intended to be portable to any system with a C89 compiler and uint64_t support.
31+
* No use of floating types.
2632
* Expose only higher level interfaces to minimize the API surface and improve application security. ("Be difficult to use insecurely.")
2733
* Field operations
2834
* Optimized implementation of arithmetic modulo the curve's field size (2^256 - 0x1000003D1).
2935
* Using 5 52-bit limbs (including hand-optimized assembly for x86_64, by Diederik Huys).
30-
* Using 10 26-bit limbs.
36+
* Using 10 26-bit limbs (including hand-optimized assembly for 32-bit ARM, by Wladimir J. van der Laan).
3137
* Field inverses and square roots using a sliding window over blocks of 1s (by Peter Dettman).
3238
* Scalar operations
3339
* Optimized implementation without data-dependent branches of arithmetic modulo the curve's order.
@@ -45,9 +51,11 @@ Implementation details
4551
* Optionally (off by default) use secp256k1's efficiently-computable endomorphism to split the P multiplicand into 2 half-sized ones.
4652
* Point multiplication for signing
4753
* Use a precomputed table of multiples of powers of 16 multiplied with the generator, so general multiplication becomes a series of additions.
48-
* Access the table with branch-free conditional moves so memory access is uniform.
49-
* No data-dependent branches
50-
* The precomputed tables add and eventually subtract points for which no known scalar (private key) is known, preventing even an attacker with control over the private key used to control the data internally.
54+
* Intended to be completely free of timing sidechannels for secret-key operations (on reasonable hardware/toolchains)
55+
* Access the table with branch-free conditional moves so memory access is uniform.
56+
* No data-dependent branches
57+
* Optional runtime blinding which attempts to frustrate differential power analysis.
58+
* The precomputed tables add and eventually subtract points for which no known scalar (secret key) is known, preventing even an attacker with control over the secret key used to control the data internally.
5159

5260
Build steps
5361
-----------
@@ -57,5 +65,40 @@ libsecp256k1 is built using autotools:
5765
$ ./autogen.sh
5866
$ ./configure
5967
$ make
60-
$ ./tests
68+
$ make check
6169
$ sudo make install # optional
70+
71+
Exhaustive tests
72+
-----------
73+
74+
$ ./exhaustive_tests
75+
76+
With valgrind, you might need to increase the max stack size:
77+
78+
$ valgrind --max-stackframe=2500000 ./exhaustive_tests
79+
80+
Test coverage
81+
-----------
82+
83+
This library aims to have full coverage of the reachable lines and branches.
84+
85+
To create a test coverage report, configure with `--enable-coverage` (use of GCC is necessary):
86+
87+
$ ./configure --enable-coverage
88+
89+
Run the tests:
90+
91+
$ make check
92+
93+
To create a report, `gcovr` is recommended, as it includes branch coverage reporting:
94+
95+
$ gcovr --exclude 'src/bench*' --print-summary
96+
97+
To create a HTML report with coloured and annotated source code:
98+
99+
$ gcovr --exclude 'src/bench*' --html --html-details -o coverage.html
100+
101+
Reporting a vulnerability
102+
------------
103+
104+
See [SECURITY.md](SECURITY.md)

SECURITY.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Security Policy
2+
3+
## Reporting a Vulnerability
4+
5+
To report security issues send an email to [email protected] (not for support).
6+
7+
The following keys may be used to communicate sensitive information to developers:
8+
9+
| Name | Fingerprint |
10+
|------|-------------|
11+
| Pieter Wuille | 133E AC17 9436 F14A 5CF1 B794 860F EB80 4E66 9320 |
12+
| Andrew Poelstra | 699A 63EF C17A D3A9 A34C FFC0 7AD0 A91C 40BD 0091 |
13+
| Tim Ruffing | 09E0 3F87 1092 E40E 106E 902B 33BC 86AB 80FF 5516 |
14+
15+
You can import a key by running the following command with that individual’s fingerprint: `gpg --recv-keys "<fingerprint>"` Ensure that you put quotes around fingerprints containing spaces.

0 commit comments

Comments
 (0)