Skip to content

Commit 64b3497

Browse files
committed
Merge bitcoin-core/secp256k1#748: Add usage examples
7c9502c Add a copy of the CC0 license to the examples (Elichai Turkel) 42e0343 Add usage examples to the readme (Elichai Turkel) 517644e Optionally compile the examples in autotools, compile+run in travis (Elichai Turkel) 422a7cc Add a ecdh shared secret example (Elichai Turkel) b0cfbcc Add a Schnorr signing and verifying example (Elichai Turkel) fee7d4b Add an ECDSA signing and verifying example (Elichai Turkel) Pull request description: ACKs for top commit: real-or-random: ACK 7c9502c jonasnick: ACK 7c9502c Tree-SHA512: c475cfd5b324b1e2d7126aa5bb1e7da25183b50adb7357d464c140de83d9097cb1bdc027d09aeadf167dbf9c8afd123235b0a1a742c5795089862418fafa1964
2 parents 1253a27 + 7c9502c commit 64b3497

11 files changed

+658
-0
lines changed

.cirrus.yml

+2
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ env:
2323
BENCH: yes
2424
SECP256K1_BENCH_ITERS: 2
2525
CTIMETEST: yes
26+
# Compile and run the tests
27+
EXAMPLES: yes
2628

2729
cat_logs_snippet: &CAT_LOGS
2830
always:

.gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,16 @@ exhaustive_tests
66
precompute_ecmult_gen
77
precompute_ecmult
88
valgrind_ctime_test
9+
ecdh_example
10+
ecdsa_example
11+
schnorr_example
912
*.exe
1013
*.so
1114
*.a
1215
*.csv
1316
!.gitignore
17+
*.log
18+
*.trs
1419

1520
Makefile
1621
configure

Makefile.am

+35
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ noinst_HEADERS += contrib/lax_der_parsing.h
6363
noinst_HEADERS += contrib/lax_der_parsing.c
6464
noinst_HEADERS += contrib/lax_der_privatekey_parsing.h
6565
noinst_HEADERS += contrib/lax_der_privatekey_parsing.c
66+
noinst_HEADERS += examples/random.h
6667

6768
PRECOMPUTED_LIB = libsecp256k1_precomputed.la
6869
noinst_LTLIBRARIES = $(PRECOMPUTED_LIB)
@@ -139,6 +140,40 @@ exhaustive_tests_LDFLAGS = -static
139140
TESTS += exhaustive_tests
140141
endif
141142

143+
if USE_EXAMPLES
144+
noinst_PROGRAMS += ecdsa_example
145+
ecdsa_example_SOURCES = examples/ecdsa.c
146+
ecdsa_example_CPPFLAGS = -I$(top_srcdir)/include
147+
ecdsa_example_LDADD = libsecp256k1.la
148+
ecdsa_example_LDFLAGS = -static
149+
if BUILD_WINDOWS
150+
ecdsa_example_LDFLAGS += -lbcrypt
151+
endif
152+
TESTS += ecdsa_example
153+
if ENABLE_MODULE_ECDH
154+
noinst_PROGRAMS += ecdh_example
155+
ecdh_example_SOURCES = examples/ecdh.c
156+
ecdh_example_CPPFLAGS = -I$(top_srcdir)/include
157+
ecdh_example_LDADD = libsecp256k1.la
158+
ecdh_example_LDFLAGS = -static
159+
if BUILD_WINDOWS
160+
ecdh_example_LDFLAGS += -lbcrypt
161+
endif
162+
TESTS += ecdh_example
163+
endif
164+
if ENABLE_MODULE_SCHNORRSIG
165+
noinst_PROGRAMS += schnorr_example
166+
schnorr_example_SOURCES = examples/schnorr.c
167+
schnorr_example_CPPFLAGS = -I$(top_srcdir)/include
168+
schnorr_example_LDADD = libsecp256k1.la
169+
schnorr_example_LDFLAGS = -static
170+
if BUILD_WINDOWS
171+
schnorr_example_LDFLAGS += -lbcrypt
172+
endif
173+
TESTS += schnorr_example
174+
endif
175+
endif
176+
142177
### Precomputed tables
143178
EXTRA_PROGRAMS = precompute_ecmult precompute_ecmult_gen
144179
CLEANFILES = $(EXTRA_PROGRAMS)

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,14 @@ libsecp256k1 is built using autotools:
6969
$ make check # run the test suite
7070
$ sudo make install # optional
7171

72+
Usage examples
73+
-----------
74+
Usage examples can be found in the [examples](examples) directory. To compile them you need to configure with `--enable-examples`.
75+
For experimental modules, you will also need `--enable-experimental` as well as a flag for each individual module, e.g. `--enable-module-ecdh`.
76+
* [ECDSA example](examples/ecdsa.c)
77+
* [Schnorr Signatures example](examples/schnorr.c)
78+
* [Deriving a shared secret(ECDH) example](examples/ecdh.c)
79+
7280
Test coverage
7381
-----------
7482

ci/cirrus.sh

+1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ valgrind --version || true
1919
--with-ecmult-gen-precision="$ECMULTGENPRECISION" \
2020
--enable-module-ecdh="$ECDH" --enable-module-recovery="$RECOVERY" \
2121
--enable-module-schnorrsig="$SCHNORRSIG" \
22+
--enable-examples="$EXAMPLES" \
2223
--with-valgrind="$WITH_VALGRIND" \
2324
--host="$HOST" $EXTRAFLAGS
2425

configure.ac

+13
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ if test x"$ac_cv_prog_cc_c89" = x"no"; then
4444
fi
4545
AM_PROG_AS
4646

47+
build_windows=no
48+
4749
case $host_os in
4850
*darwin*)
4951
if test x$cross_compiling != xyes; then
@@ -67,6 +69,9 @@ case $host_os in
6769
fi
6870
fi
6971
;;
72+
cygwin*|mingw*)
73+
build_windows=yes
74+
;;
7075
esac
7176

7277
# Try if some desirable compiler flags are supported and append them to SECP_CFLAGS.
@@ -134,6 +139,11 @@ AC_ARG_ENABLE(exhaustive_tests,
134139
[use_exhaustive_tests=$enableval],
135140
[use_exhaustive_tests=yes])
136141

142+
AC_ARG_ENABLE(examples,
143+
AS_HELP_STRING([--enable-examples],[compile the examples [default=no]]),
144+
[use_examples=$enableval],
145+
[use_examples=no])
146+
137147
AC_ARG_ENABLE(module_ecdh,
138148
AS_HELP_STRING([--enable-module-ecdh],[enable ECDH shared secret computation]),
139149
[enable_module_ecdh=$enableval],
@@ -392,13 +402,15 @@ AC_SUBST(SECP_CFLAGS)
392402
AM_CONDITIONAL([ENABLE_COVERAGE], [test x"$enable_coverage" = x"yes"])
393403
AM_CONDITIONAL([USE_TESTS], [test x"$use_tests" != x"no"])
394404
AM_CONDITIONAL([USE_EXHAUSTIVE_TESTS], [test x"$use_exhaustive_tests" != x"no"])
405+
AM_CONDITIONAL([USE_EXAMPLES], [test x"$use_examples" != x"no"])
395406
AM_CONDITIONAL([USE_BENCHMARK], [test x"$use_benchmark" = x"yes"])
396407
AM_CONDITIONAL([ENABLE_MODULE_ECDH], [test x"$enable_module_ecdh" = x"yes"])
397408
AM_CONDITIONAL([ENABLE_MODULE_RECOVERY], [test x"$enable_module_recovery" = x"yes"])
398409
AM_CONDITIONAL([ENABLE_MODULE_EXTRAKEYS], [test x"$enable_module_extrakeys" = x"yes"])
399410
AM_CONDITIONAL([ENABLE_MODULE_SCHNORRSIG], [test x"$enable_module_schnorrsig" = x"yes"])
400411
AM_CONDITIONAL([USE_EXTERNAL_ASM], [test x"$use_external_asm" = x"yes"])
401412
AM_CONDITIONAL([USE_ASM_ARM], [test x"$set_asm" = x"arm"])
413+
AM_CONDITIONAL([BUILD_WINDOWS], [test "$build_windows" = "yes"])
402414
AC_SUBST(LIB_VERSION_CURRENT, _LIB_VERSION_CURRENT)
403415
AC_SUBST(LIB_VERSION_REVISION, _LIB_VERSION_REVISION)
404416
AC_SUBST(LIB_VERSION_AGE, _LIB_VERSION_AGE)
@@ -416,6 +428,7 @@ echo " with external callbacks = $use_external_default_callbacks"
416428
echo " with benchmarks = $use_benchmark"
417429
echo " with tests = $use_tests"
418430
echo " with coverage = $enable_coverage"
431+
echo " with examples = $use_examples"
419432
echo " module ecdh = $enable_module_ecdh"
420433
echo " module recovery = $enable_module_recovery"
421434
echo " module extrakeys = $enable_module_extrakeys"

examples/EXAMPLES_COPYING

+121
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
Creative Commons Legal Code
2+
3+
CC0 1.0 Universal
4+
5+
CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
6+
LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
7+
ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
8+
INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
9+
REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
10+
PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
11+
THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
12+
HEREUNDER.
13+
14+
Statement of Purpose
15+
16+
The laws of most jurisdictions throughout the world automatically confer
17+
exclusive Copyright and Related Rights (defined below) upon the creator
18+
and subsequent owner(s) (each and all, an "owner") of an original work of
19+
authorship and/or a database (each, a "Work").
20+
21+
Certain owners wish to permanently relinquish those rights to a Work for
22+
the purpose of contributing to a commons of creative, cultural and
23+
scientific works ("Commons") that the public can reliably and without fear
24+
of later claims of infringement build upon, modify, incorporate in other
25+
works, reuse and redistribute as freely as possible in any form whatsoever
26+
and for any purposes, including without limitation commercial purposes.
27+
These owners may contribute to the Commons to promote the ideal of a free
28+
culture and the further production of creative, cultural and scientific
29+
works, or to gain reputation or greater distribution for their Work in
30+
part through the use and efforts of others.
31+
32+
For these and/or other purposes and motivations, and without any
33+
expectation of additional consideration or compensation, the person
34+
associating CC0 with a Work (the "Affirmer"), to the extent that he or she
35+
is an owner of Copyright and Related Rights in the Work, voluntarily
36+
elects to apply CC0 to the Work and publicly distribute the Work under its
37+
terms, with knowledge of his or her Copyright and Related Rights in the
38+
Work and the meaning and intended legal effect of CC0 on those rights.
39+
40+
1. Copyright and Related Rights. A Work made available under CC0 may be
41+
protected by copyright and related or neighboring rights ("Copyright and
42+
Related Rights"). Copyright and Related Rights include, but are not
43+
limited to, the following:
44+
45+
i. the right to reproduce, adapt, distribute, perform, display,
46+
communicate, and translate a Work;
47+
ii. moral rights retained by the original author(s) and/or performer(s);
48+
iii. publicity and privacy rights pertaining to a person's image or
49+
likeness depicted in a Work;
50+
iv. rights protecting against unfair competition in regards to a Work,
51+
subject to the limitations in paragraph 4(a), below;
52+
v. rights protecting the extraction, dissemination, use and reuse of data
53+
in a Work;
54+
vi. database rights (such as those arising under Directive 96/9/EC of the
55+
European Parliament and of the Council of 11 March 1996 on the legal
56+
protection of databases, and under any national implementation
57+
thereof, including any amended or successor version of such
58+
directive); and
59+
vii. other similar, equivalent or corresponding rights throughout the
60+
world based on applicable law or treaty, and any national
61+
implementations thereof.
62+
63+
2. Waiver. To the greatest extent permitted by, but not in contravention
64+
of, applicable law, Affirmer hereby overtly, fully, permanently,
65+
irrevocably and unconditionally waives, abandons, and surrenders all of
66+
Affirmer's Copyright and Related Rights and associated claims and causes
67+
of action, whether now known or unknown (including existing as well as
68+
future claims and causes of action), in the Work (i) in all territories
69+
worldwide, (ii) for the maximum duration provided by applicable law or
70+
treaty (including future time extensions), (iii) in any current or future
71+
medium and for any number of copies, and (iv) for any purpose whatsoever,
72+
including without limitation commercial, advertising or promotional
73+
purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
74+
member of the public at large and to the detriment of Affirmer's heirs and
75+
successors, fully intending that such Waiver shall not be subject to
76+
revocation, rescission, cancellation, termination, or any other legal or
77+
equitable action to disrupt the quiet enjoyment of the Work by the public
78+
as contemplated by Affirmer's express Statement of Purpose.
79+
80+
3. Public License Fallback. Should any part of the Waiver for any reason
81+
be judged legally invalid or ineffective under applicable law, then the
82+
Waiver shall be preserved to the maximum extent permitted taking into
83+
account Affirmer's express Statement of Purpose. In addition, to the
84+
extent the Waiver is so judged Affirmer hereby grants to each affected
85+
person a royalty-free, non transferable, non sublicensable, non exclusive,
86+
irrevocable and unconditional license to exercise Affirmer's Copyright and
87+
Related Rights in the Work (i) in all territories worldwide, (ii) for the
88+
maximum duration provided by applicable law or treaty (including future
89+
time extensions), (iii) in any current or future medium and for any number
90+
of copies, and (iv) for any purpose whatsoever, including without
91+
limitation commercial, advertising or promotional purposes (the
92+
"License"). The License shall be deemed effective as of the date CC0 was
93+
applied by Affirmer to the Work. Should any part of the License for any
94+
reason be judged legally invalid or ineffective under applicable law, such
95+
partial invalidity or ineffectiveness shall not invalidate the remainder
96+
of the License, and in such case Affirmer hereby affirms that he or she
97+
will not (i) exercise any of his or her remaining Copyright and Related
98+
Rights in the Work or (ii) assert any associated claims and causes of
99+
action with respect to the Work, in either case contrary to Affirmer's
100+
express Statement of Purpose.
101+
102+
4. Limitations and Disclaimers.
103+
104+
a. No trademark or patent rights held by Affirmer are waived, abandoned,
105+
surrendered, licensed or otherwise affected by this document.
106+
b. Affirmer offers the Work as-is and makes no representations or
107+
warranties of any kind concerning the Work, express, implied,
108+
statutory or otherwise, including without limitation warranties of
109+
title, merchantability, fitness for a particular purpose, non
110+
infringement, or the absence of latent or other defects, accuracy, or
111+
the present or absence of errors, whether or not discoverable, all to
112+
the greatest extent permissible under applicable law.
113+
c. Affirmer disclaims responsibility for clearing rights of other persons
114+
that may apply to the Work or any use thereof, including without
115+
limitation any person's Copyright and Related Rights in the Work.
116+
Further, Affirmer disclaims responsibility for obtaining any necessary
117+
consents, permissions or other rights required for any use of the
118+
Work.
119+
d. Affirmer understands and acknowledges that Creative Commons is not a
120+
party to this document and has no duty or obligation with respect to
121+
this CC0 or use of the Work.

0 commit comments

Comments
 (0)