├── .gitignore
├── .travis.yml
├── LICENSE
├── README.md
├── bls
├── __init__.py
├── scheme.py
└── utils.py
├── docs
├── Makefile
├── conf.py
├── index.rst
└── make.bat
├── setup.cfg
├── setup.py
├── tests
├── __init__.py
└── test_bls.py
└── tox.ini
/.gitignore:
--------------------------------------------------------------------------------
1 | # Remove macOS .DS_Store
2 | .DS_Store
3 |
4 | # Byte-compiled / optimized / DLL files
5 | __pycache__/
6 | *.py[cod]
7 | *$py.class
8 |
9 | # C extensions
10 | *.so
11 |
12 | # Distribution / packaging
13 | .Python
14 | env/
15 | build/
16 | develop-eggs/
17 | dist/
18 | downloads/
19 | eggs/
20 | .eggs/
21 | lib/
22 | lib64/
23 | parts/
24 | sdist/
25 | var/
26 | wheels/
27 | *.egg-info/
28 | .installed.cfg
29 | *.egg
30 |
31 | # PyInstaller
32 | # Usually these files are written by a python script from a template
33 | # before PyInstaller builds the exe, so as to inject date/other infos into it.
34 | *.manifest
35 | *.spec
36 |
37 | # Installer logs
38 | pip-log.txt
39 | pip-delete-this-directory.txt
40 |
41 | # Unit test / coverage reports
42 | htmlcov/
43 | .tox/
44 | .coverage
45 | .coverage.*
46 | .cache
47 | nosetests.xml
48 | coverage.xml
49 | *.cover
50 | .hypothesis/
51 |
52 | # Translations
53 | *.mo
54 | *.pot
55 |
56 | # Django stuff:
57 | *.log
58 | local_settings.py
59 |
60 | # Flask stuff:
61 | instance/
62 | .webassets-cache
63 |
64 | # Scrapy stuff:
65 | .scrapy
66 |
67 | # Sphinx documentation
68 | docs/_build/
69 |
70 | # PyBuilder
71 | target/
72 |
73 | # Jupyter Notebook
74 | .ipynb_checkpoints
75 |
76 | # pyenv
77 | .python-version
78 |
79 | # celery beat schedule file
80 | celerybeat-schedule
81 |
82 | # SageMath parsed files
83 | *.sage.py
84 |
85 | # dotenv
86 | .env
87 |
88 | # virtualenv
89 | .venv
90 | venv/
91 | ENV/
92 |
93 | # Spyder project settings
94 | .spyderproject
95 | .spyproject
96 |
97 | # Rope project settings
98 | .ropeproject
99 |
100 | # mkdocs documentation
101 | /site
102 |
103 | # mypy
104 | .mypy_cache/
105 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: python
2 |
3 | python:
4 | - "3.6"
5 |
6 | # command to install dependencies
7 | install:
8 | - pip install tox-travis
9 |
10 |
11 | # command to run tests
12 | script: tox
13 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 | {one line to give the program's name and a brief idea of what it does.}
635 | Copyright (C) 2018 {name of author}
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | ambient-hue Copyright (C) 2018 lsonnino
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # BLS Signatures
2 | [](https://github.com/asonnino/bls/blob/master/LICENSE)
3 | [](https://bls-lib.readthedocs.io/en/latest/?badge=latest)
4 |
5 | A simple Python implementation of threshold BLS signatures.
6 |
7 | A link to the full paper is available at the following address: [https://iacr.org/archive/asiacrypt2001/22480516.pdf](https://iacr.org/archive/asiacrypt2001/22480516.pdf)
8 |
9 |
10 | ## Pre-requisites
11 | This implementation is built on top of [petlib](https://github.com/gdanezis/petlib) and [bplib](https://github.com/gdanezis/bplib), make sure to follow [these instructions](https://github.com/gdanezis/petlib#pre-requisites) to install all the pre-requisites.
12 |
13 |
14 | ## Install
15 | If you have `pip` installed, you can install **bls** with the following command:
16 | ```
17 | $ pip install bls-lib
18 | ```
19 | otherwise, you can build it manually as below:
20 | ```
21 | $ git clone https://github.com/asonnino/bls
22 | $ cd bls
23 | $ pip install -e .
24 | ```
25 |
26 |
27 | ## Test
28 | Tests can be run as follows:
29 | ```
30 | $ pytest -v --cov=bls tests/
31 | ```
32 | or simply using tox:
33 | ```
34 | $ tox
35 | ```
36 |
37 | ## License
38 | [The GPLv3 license](https://www.gnu.org/licenses/gpl-3.0.en.html)
39 |
--------------------------------------------------------------------------------
/bls/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/asonnino/bls/4c693fb4e730ea729f08d288315a9088ec24ed04/bls/__init__.py
--------------------------------------------------------------------------------
/bls/scheme.py:
--------------------------------------------------------------------------------
1 | """
2 | BLS signature scheme.
3 | Example:
4 | >>> m = [3] * 2 # messages
5 | >>> t, n = 2, 3 # number of authorities
6 | >>> params = setup() # generate the public parameters.
7 | >>> (sk, vk) = ttp_keygen(params, t, n) # generate key
8 | >>> aggr_vk = aggregate_vk(params, vk) # aggregate verification keys
9 | >>> sigs = [sign(params, ski, m) for ski in sk] # sign
10 | >>> sigma = aggregate_sigma(params, sigs) # aggregate credentials
11 | >>> assert verify(params, aggr_vk, sigma, m) # verify signature
12 | """
13 | from bplib.bp import BpGroup, G2Elem
14 | from bls.utils import *
15 |
16 |
17 | def setup():
18 | """
19 | Generate the public parameters.
20 |
21 | Returns:
22 | - params: the publc parameters
23 | """
24 | G = BpGroup()
25 | (g1, g2) = G.gen1(), G.gen2()
26 | (e, o) = G.pair, G.order()
27 | return (G, o, g1, g2, e)
28 |
29 |
30 | def ttp_keygen(params, t, n):
31 | """
32 | Generate keys for threshold signature (executed by a TTP).
33 |
34 | Parameters:
35 | - `params`: public parameters generated by `setup`
36 | - `t` (integer): the threshold parameter
37 | - `n` (integer): the total number of authorities
38 |
39 | Returns:
40 | - `sk` [Bn]: array containing the secret key of each authority
41 | - `vk` [G2Elem]: array containing the verification key of each authority
42 | """
43 | assert n >= t and t > 0
44 | (G, o, g1, g2, e) = params
45 | # generate polynomials
46 | v = [o.random() for _ in range(0,t)]
47 | # generate shares
48 | sk = [poly_eval(v,i) % o for i in range(1,n+1)]
49 | # set keys
50 | vk = [xi*g2 for xi in sk]
51 | return (sk, vk)
52 |
53 |
54 | def aggregate_vk(params, vks, threshold=True):
55 | """
56 | Aggregate the verification keys.
57 |
58 | Parameters:
59 | - `params`: public parameters generated by `setup`
60 | - `vks` [G2Elem]: array containing the verification key of each authority
61 | - `threshold` (bool): optional, whether to use threshold cryptography or not
62 |
63 | Returns:
64 | - `aggr_vk` (G2Elem): aggregated verification key
65 | """
66 | (G, o, g1, g2, e) = params
67 | # evaluate all lagrange basis polynomial li(0)
68 | filter = [vk for vk in vks if vk is not None]
69 | indexes = [i+1 for i, vk in enumerate(vks) if vk is not None]
70 | l = lagrange_basis(indexes, o) if threshold else [1 for _ in vks]
71 | # aggregate keys
72 | aggr_vk = ec_sum([l[i]*filter[i] for i in range(len(filter))])
73 | return aggr_vk
74 |
75 |
76 | def sign(params, sk, m):
77 | """
78 | Sign messages.
79 |
80 | Parameters:
81 | - `params`: public parameters generated by `setup`
82 | - `sk` (Bn): the secret key of the authority
83 | - `m` [Bn]: array containing the messages
84 |
85 | Returns:
86 | - `sigma_tilde` (G1Elem, G1Elem): blinded credential
87 | """
88 | assert len(m) > 0
89 | (G, o, g1, g2, e) = params
90 | digest = hash(m)
91 | h = G.hashG1(digest)
92 | sigma = sk*h
93 | return sigma
94 |
95 |
96 | def aggregate_sigma(params, sigs, threshold=True):
97 | """
98 | Aggregate partial signatures.
99 |
100 | Parameters:
101 | - `params`: public parameters generated by `setup`
102 | - `sigs` [G1Elem]: array of partial credentials
103 | - `threshold` (bool): optional, whether to use threshold cryptography or not
104 |
105 | Returns:
106 | - `aggr_sigma` (G1Elem): aggregated credential
107 | """
108 | (G, o, g1, g2, e) = params
109 | # evaluate all lagrange basis polynomial li(0)
110 | filter = [sig for sig in sigs if sig is not None]
111 | indexes = [i+1 for i, sig in enumerate(sigs) if sig is not None]
112 | l = lagrange_basis(indexes, o) if threshold else [1 for _ in sigs]
113 | # aggregate sigature
114 | aggr_s = ec_sum([l[i]*filter[i] for i in range(len(filter))])
115 | return aggr_s
116 |
117 |
118 | def verify(params, aggr_vk, sigma, m):
119 | """
120 | Verify signature.
121 |
122 | Parameters:
123 | - `params`: public parameters generated by `setup`
124 | - `aggr_vk` (G2Elem): aggregated verification key
125 | - `sigma` (G1Elem): signature
126 | - `m` [Bn]: array containing the messages
127 |
128 | Returns:
129 | - `ret` (bool): whether the credential verifies
130 | """
131 | (G, o, g1, g2, e) = params
132 | digest = hash(m)
133 | h = G.hashG1(digest)
134 | return not h.isinf() and e(sigma, g2) == e(h, aggr_vk)
135 |
--------------------------------------------------------------------------------
/bls/utils.py:
--------------------------------------------------------------------------------
1 | """ Utilities """
2 | from hashlib import sha256
3 | from petlib.bn import Bn
4 |
5 |
6 | # ==================================================
7 | # polynomial utilities
8 | # ==================================================
9 | def poly_eval(coeff, x):
10 | """ evaluate a polynomial defined by the list of coefficient coeff at point x """
11 | return sum([coeff[i] * (Bn(x) ** i) for i in range(len(coeff))])
12 |
13 |
14 | def lagrange_basis(indexes, o, x=0):
15 | """ generates all lagrange basis polynomials """
16 | l = []
17 | for i in indexes:
18 | numerator, denominator = 1, 1
19 | for j in indexes:
20 | if j != i:
21 | numerator = (numerator * (x - j)) % o
22 | denominator = (denominator * (i - j)) % o
23 | l.append((numerator * denominator.mod_inverse(o)) % o)
24 | return l
25 |
26 |
27 | # ==================================================
28 | # other
29 | # ==================================================
30 | def ec_sum(list):
31 | """ sum EC points list """
32 | ret = list[0]
33 | for i in range(1, len(list)):
34 | ret = ret + list[i]
35 | return ret
36 |
37 |
38 | def hash(elements):
39 | """ generates a Bn hash by hashing a number of EC points """
40 | Cstring = ",".join([str(x) for x in elements])
41 | return sha256(Cstring.encode()).digest()
42 |
--------------------------------------------------------------------------------
/docs/Makefile:
--------------------------------------------------------------------------------
1 | # Minimal makefile for Sphinx documentation
2 | #
3 |
4 | # You can set these variables from the command line.
5 | SPHINXOPTS =
6 | SPHINXBUILD = sphinx-build
7 | SPHINXPROJ = BLS
8 | SOURCEDIR = .
9 | BUILDDIR = _build
10 |
11 | # Put it first so that "make" without argument is like "make help".
12 | help:
13 | @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14 |
15 | .PHONY: help Makefile
16 |
17 | # Catch-all target: route all unknown targets to Sphinx using the new
18 | # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19 | %: Makefile
20 | @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
--------------------------------------------------------------------------------
/docs/conf.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 | #
3 | # Configuration file for the Sphinx documentation builder.
4 | #
5 | # This file does only contain a selection of the most common options. For a
6 | # full list see the documentation:
7 | # http://www.sphinx-doc.org/en/master/config
8 |
9 | # -- Path setup --------------------------------------------------------------
10 |
11 | # If extensions (or modules to document with autodoc) are in another directory,
12 | # add these directories to sys.path here. If the directory is relative to the
13 | # documentation root, use os.path.abspath to make it absolute, like shown here.
14 | #
15 | import os
16 | import sys
17 | from mock import Mock as MagicMock
18 |
19 | class Mock(MagicMock):
20 | @classmethod
21 | def __getattr__(cls, name):
22 | return Mock()
23 |
24 | MOCK_MODULES = ['bplib', 'bplib.bp', 'bplib.bp.BpGroup', 'bplib.bp.G2Elem']
25 | sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
26 |
27 | sys.path.insert(0, os.path.abspath('..'))
28 |
29 |
30 |
31 | # -- Project information -----------------------------------------------------
32 |
33 | project = 'BLS'
34 | copyright = '2018, Alberto Sonnino'
35 | author = 'Alberto Sonnino'
36 |
37 | # The short X.Y version
38 | version = ''
39 | # The full version, including alpha/beta/rc tags
40 | release = '1.0.0'
41 |
42 |
43 | # -- General configuration ---------------------------------------------------
44 |
45 | # If your documentation needs a minimal Sphinx version, state it here.
46 | #
47 | # needs_sphinx = '1.0'
48 |
49 | # Add any Sphinx extension module names here, as strings. They can be
50 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
51 | # ones.
52 | extensions = [
53 | 'sphinx.ext.autodoc',
54 | 'sphinx.ext.doctest',
55 | 'sphinx.ext.intersphinx',
56 | 'sphinx.ext.coverage',
57 | 'sphinx.ext.mathjax',
58 | 'sphinx.ext.ifconfig',
59 | 'sphinx.ext.viewcode',
60 | 'sphinx.ext.githubpages',
61 | ]
62 |
63 | # Add any paths that contain templates here, relative to this directory.
64 | templates_path = ['_templates']
65 |
66 | # The suffix(es) of source filenames.
67 | # You can specify multiple suffix as a list of string:
68 | #
69 | # source_suffix = ['.rst', '.md']
70 | source_suffix = '.rst'
71 |
72 | # The master toctree document.
73 | master_doc = 'index'
74 |
75 | # The language for content autogenerated by Sphinx. Refer to documentation
76 | # for a list of supported languages.
77 | #
78 | # This is also used if you do content translation via gettext catalogs.
79 | # Usually you set "language" from the command line for these cases.
80 | language = None
81 |
82 | # List of patterns, relative to source directory, that match files and
83 | # directories to ignore when looking for source files.
84 | # This pattern also affects html_static_path and html_extra_path .
85 | exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
86 |
87 | # The name of the Pygments (syntax highlighting) style to use.
88 | pygments_style = 'sphinx'
89 |
90 |
91 | # -- Options for HTML output -------------------------------------------------
92 |
93 | # The theme to use for HTML and HTML Help pages. See the documentation for
94 | # a list of builtin themes.
95 | #
96 | html_theme = 'alabaster'
97 |
98 | # Theme options are theme-specific and customize the look and feel of a theme
99 | # further. For a list of options available for each theme, see the
100 | # documentation.
101 | #
102 | # html_theme_options = {}
103 |
104 | # Add any paths that contain custom static files (such as style sheets) here,
105 | # relative to this directory. They are copied after the builtin static files,
106 | # so a file named "default.css" will overwrite the builtin "default.css".
107 | html_static_path = ['_static']
108 |
109 | # Custom sidebar templates, must be a dictionary that maps document names
110 | # to template names.
111 | #
112 | # The default sidebars (for documents that don't match any pattern) are
113 | # defined by theme itself. Builtin themes are using these templates by
114 | # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
115 | # 'searchbox.html']``.
116 | #
117 | # html_sidebars = {}
118 |
119 |
120 | # -- Options for HTMLHelp output ---------------------------------------------
121 |
122 | # Output file base name for HTML help builder.
123 | htmlhelp_basename = 'BLSdoc'
124 |
125 |
126 | # -- Options for LaTeX output ------------------------------------------------
127 |
128 | latex_elements = {
129 | # The paper size ('letterpaper' or 'a4paper').
130 | #
131 | # 'papersize': 'letterpaper',
132 |
133 | # The font size ('10pt', '11pt' or '12pt').
134 | #
135 | # 'pointsize': '10pt',
136 |
137 | # Additional stuff for the LaTeX preamble.
138 | #
139 | # 'preamble': '',
140 |
141 | # Latex figure (float) alignment
142 | #
143 | # 'figure_align': 'htbp',
144 | }
145 |
146 | # Grouping the document tree into LaTeX files. List of tuples
147 | # (source start file, target name, title,
148 | # author, documentclass [howto, manual, or own class]).
149 | latex_documents = [
150 | (master_doc, 'BLS.tex', 'BLS Documentation',
151 | 'Alberto Sonnino', 'manual'),
152 | ]
153 |
154 |
155 | # -- Options for manual page output ------------------------------------------
156 |
157 | # One entry per manual page. List of tuples
158 | # (source start file, name, description, authors, manual section).
159 | man_pages = [
160 | (master_doc, 'bls', 'BLS Documentation',
161 | [author], 1)
162 | ]
163 |
164 |
165 | # -- Options for Texinfo output ----------------------------------------------
166 |
167 | # Grouping the document tree into Texinfo files. List of tuples
168 | # (source start file, target name, title, author,
169 | # dir menu entry, description, category)
170 | texinfo_documents = [
171 | (master_doc, 'BLS', 'BLS Documentation',
172 | author, 'BLS', 'A simple Python implementation of threshold BLS signatures.',
173 | 'Miscellaneous'),
174 | ]
175 |
176 |
177 | # -- Extension configuration -------------------------------------------------
178 |
179 | add_module_names = False
180 | add_function_parentheses = True
181 |
182 |
183 |
--------------------------------------------------------------------------------
/docs/index.rst:
--------------------------------------------------------------------------------
1 | .. BLS documentation master file, created by
2 | sphinx-quickstart on Wed May 23 12:24:34 2018.
3 | You can adapt this file completely to your liking, but it should at least
4 | contain the root `toctree` directive.
5 |
6 | Welcome to BLS's documentation!
7 | ===============================
8 |
9 | .. toctree::
10 | :maxdepth: 2
11 | :caption: Contents:
12 |
13 | .. image:: https://img.shields.io/badge/license-BSD-brightgreen.svg
14 | :target: https://github.com/asonnino/bls/blob/master/LICENSE
15 |
16 | .. image:: https://travis-ci.org/asonnino/bls.svg?branch=master
17 | :target: https://travis-ci.org/asonnino/bls
18 |
19 | .. image:: https://readthedocs.org/projects/bls-lib/badge/?version=latest
20 | :target: https://bls-lib.readthedocs.io/en/latest/?badge=latest
21 | :alt: Documentation Status
22 |
23 |
24 | A simple Python implementation of threshold BLS signatures.
25 |
26 | A link to the full paper is available here_.
27 |
28 | .. _here: https://iacr.org/archive/asiacrypt2001/22480516.pdf
29 |
30 |
31 | Pre-requisites
32 | --------------
33 | This implementation is built on top of petlib_ , make sure to follow `these instructions`_ to install all the pre-requisites.
34 |
35 | .. _petlib: https://github.com/gdanezis/petlib
36 | .. _`these instructions`: https://github.com/gdanezis/petlib#pre-requisites
37 |
38 |
39 | Install
40 | -------
41 |
42 | If you have `pip` installed, you can install **Coconut** with the following command:
43 |
44 | .. code-block:: none
45 |
46 | pip install bls-lib
47 |
48 |
49 | otherwise, you can build it manually as below:
50 |
51 | .. code-block:: none
52 |
53 | git clone https://github.com/asonnino/bls
54 | cd bls
55 | pip install -e .
56 |
57 |
58 | Test
59 | ----
60 |
61 | Tests can be run as follows:
62 |
63 | .. code-block:: none
64 |
65 | pytest -v --cov=bls tests/
66 |
67 | or simply using tox:
68 |
69 | .. code-block:: none
70 |
71 | tox
72 |
73 |
74 | BLS Modules
75 | -----------
76 | .. automodule:: bls
77 |
78 | .. automodule:: bls.scheme
79 |
80 | .. autofunction:: bls.scheme.setup()
81 |
82 | .. autofunction:: bls.scheme.ttp_keygen(params, t, n)
83 |
84 | .. autofunction:: bls.scheme.aggregate_vk(params, vk, threshold=True)
85 |
86 | .. autofunction:: bls.scheme.sign(params, sk, m)
87 |
88 | .. autofunction:: bls.scheme.aggregate_sigma(params, sigs, threshold=True)
89 |
90 | .. autofunction:: bls.scheme.verify(params, aggr_vk, sigma, m)
91 |
92 |
93 | Indices and tables
94 | ==================
95 |
96 | * :ref:`genindex`
97 | * :ref:`modindex`
98 | * :ref:`search`
99 |
100 |
101 | License
102 | ==================
103 | `The BSD license`_
104 |
105 | .. _`The BSD license`: https://opensource.org/licenses/BSD-3-Clause
106 |
--------------------------------------------------------------------------------
/docs/make.bat:
--------------------------------------------------------------------------------
1 | @ECHO OFF
2 |
3 | pushd %~dp0
4 |
5 | REM Command file for Sphinx documentation
6 |
7 | if "%SPHINXBUILD%" == "" (
8 | set SPHINXBUILD=sphinx-build
9 | )
10 | set SOURCEDIR=.
11 | set BUILDDIR=_build
12 | set SPHINXPROJ=BLS
13 |
14 | if "%1" == "" goto help
15 |
16 | %SPHINXBUILD% >NUL 2>NUL
17 | if errorlevel 9009 (
18 | echo.
19 | echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
20 | echo.installed, then set the SPHINXBUILD environment variable to point
21 | echo.to the full path of the 'sphinx-build' executable. Alternatively you
22 | echo.may add the Sphinx directory to PATH.
23 | echo.
24 | echo.If you don't have Sphinx installed, grab it from
25 | echo.http://sphinx-doc.org/
26 | exit /b 1
27 | )
28 |
29 | %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
30 | goto end
31 |
32 | :help
33 | %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
34 |
35 | :end
36 | popd
37 |
--------------------------------------------------------------------------------
/setup.cfg:
--------------------------------------------------------------------------------
1 | [metadata]
2 | # This includes the license file in the wheel.
3 | license_file = LICENSE
4 |
5 | [bdist_wheel]
6 | # This flag says to generate wheels that support both Python 2 and Python
7 | # 3. If your code will not run unchanged on both Python 2 and 3, you will
8 | # need to generate separate wheels for each Python version that you
9 | # support. Removing this line (or setting universal to 0) will prevent
10 | # bdist_wheel from trying to make a universal wheel. For more see:
11 | # https://packaging.python.org/tutorials/distributing-packages/#wheels
12 | universal=0
--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
1 | """ A setuptools based setup module. """
2 |
3 |
4 | from setuptools import setup, find_packages
5 | from codecs import open
6 | from os import path
7 |
8 | here = path.abspath(path.dirname(__file__))
9 |
10 | # Get the long description from the README file
11 | with open(path.join(here, 'README.md'), encoding='utf-8') as f:
12 | long_description = f.read()
13 |
14 |
15 | setup(
16 | # This is the name of your project.
17 | name='bls-lib', # Required
18 |
19 | # Versions.
20 | version='1.0.1', # Required
21 |
22 | # One-line description.
23 | description='A simple Python implementation of threshold BLS signatures.', # Required
24 |
25 | # Longer description,
26 | long_description=long_description, # Optional
27 |
28 | # Denotes that the long_description is in Markdown.
29 | long_description_content_type='text/markdown', # Optional
30 |
31 | # Link to the project's main homepage.
32 | url='https://pypi.org/project/bls-lib', # Optional
33 |
34 | # Author of the project.
35 | author='Alberto Sonnino', # Optional
36 |
37 | # Email address corresponding to the author listed above.
38 | author_email='alberto.sonnino@ucl.ac.uk', # Optional
39 |
40 | # Classifiers help users find your project by categorizing it.
41 | # For a list of valid classifiers, see https://pypi.org/classifiers/
42 | classifiers=[ # Optional
43 | # How mature is this project? Common values are
44 | # 3 - Alpha
45 | # 4 - Beta
46 | # 5 - Production/Stable
47 | 'Development Status :: 3 - Alpha',
48 |
49 | # Indicate who your project is intended for
50 | 'Intended Audience :: Science/Research',
51 | 'Topic :: Security :: Cryptography',
52 |
53 | # License as you wish
54 | 'License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)',
55 |
56 | # Specify the Python versions are supported.
57 | 'Programming Language :: Python :: 3.6',
58 | ],
59 |
60 | # This field adds keywords to the project which will appear on the
61 | # project page.
62 | #
63 | # Note that this is a string of words separated by whitespace, not a list.
64 | keywords='cryptography signatures digital-signatures threhshold-cryptography', # Optional
65 |
66 | # You can just specify package directories manually here if your project is
67 | # simple. Or you can use find_packages().
68 | #
69 | # Alternatively, if you just want to distribute a single Python file, use
70 | # the `py_modules` argument instead as follows, which will expect a file
71 | # called `my_module.py` to exist:
72 | #
73 | # py_modules=["my_module"],
74 | #
75 | packages=find_packages(exclude=['contrib', 'docs', 'tests']), # Required
76 |
77 | # This field lists other packages that the project depends on to run.
78 | # Any package put here will be installed by pip when the project is
79 | # installed, so they must be valid existing projects.
80 | #
81 | # For an analysis of "install_requires" vs pip's requirements files see:
82 | # https://packaging.python.org/en/latest/requirements.html
83 | install_requires=['petlib', 'bplib'], # Optional
84 |
85 | # List additional groups of dependencies here (e.g. development
86 | # dependencies). Users will be able to install these using the "extras"
87 | # syntax, for example:
88 | #
89 | # $ pip install sampleproject[dev]
90 | #
91 | # Similar to `install_requires` above, these must be valid existing
92 | # projects.
93 | ##extras_require={ # Optional
94 | ## 'dev': ['check-manifest'],
95 | ## 'test': ['coverage'],
96 | ##},
97 |
98 | # If there are data files included in your packages that need to be
99 | # installed, specify them here.
100 | #
101 | # If using Python 2.6 or earlier, then these have to be included in
102 | # MANIFEST.in as well.
103 | ##package_data={ # Optional
104 | ## 'sample': ['package_data.dat'],
105 | ##},
106 |
107 | # Although 'package_data' is the preferred approach, in some case you may
108 | # need to place data files outside of your packages. See:
109 | # http://docs.python.org/3.4/distutils/setupscript.html#installing-additional-files
110 | #
111 | # In this case, 'data_file' will be installed into '/my_data'
112 | ##data_files=[('my_data', ['data/data_file'])], # Optional
113 |
114 | # To provide executable scripts, use entry points in preference to the
115 | # "scripts" keyword. Entry points provide cross-platform support and allow
116 | # `pip` to create the appropriate form of executable for the target
117 | # platform.
118 | #
119 | # For example, the following would provide a command called `sample` which
120 | # executes the function `main` from this package when invoked:
121 | ##entry_points={ # Optional
122 | ## 'console_scripts': [
123 | ## 'sample=sample:main',
124 | ## ],
125 | ##},
126 |
127 | # List additional URLs that are relevant to your project as a dict.
128 | #
129 | # This field corresponds to the "Project-URL" metadata fields:
130 | # https://packaging.python.org/specifications/core-metadata/#project-url-multiple-use
131 | #
132 | # Examples listed include a pattern for specifying where the package tracks
133 | # issues, where the source is hosted, where to say thanks to the package
134 | # maintainers, and where to support the project financially. The key is
135 | # what's used to render the link text on PyPI.
136 | project_urls={ # Optional
137 | 'Paper' : 'https://iacr.org/archive/asiacrypt2001/22480516.pdf',
138 | 'Bug Reports': 'https://github.com/asonnino/bls',
139 | 'Source': 'https://github.com/asonnino/bls',
140 | },
141 | )
142 |
--------------------------------------------------------------------------------
/tests/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/asonnino/bls/4c693fb4e730ea729f08d288315a9088ec24ed04/tests/__init__.py
--------------------------------------------------------------------------------
/tests/test_bls.py:
--------------------------------------------------------------------------------
1 | from bls.scheme import *
2 |
3 |
4 | def test_threshold_authorities():
5 | m = [3] * 2 # messages
6 | t, n = 19, 20 # number of authorities
7 | params = setup()
8 |
9 | # generate key
10 | (sk, vk) = ttp_keygen(params, t, n)
11 |
12 | # aggregate verification keys
13 | aggr_vk = aggregate_vk(params, vk)
14 |
15 | # sign
16 | sigs = [sign(params, ski, m) for ski in sk]
17 |
18 | # aggregate credentials
19 | sigs[1] = None
20 | sigma = aggregate_sigma(params, sigs)
21 |
22 | # verify signature
23 | assert verify(params, aggr_vk, sigma, m)
24 |
25 |
26 | def test_multi_authorities():
27 | m = [3] * 2 # messages
28 | n = 3 # number of authorities
29 | params = setup()
30 |
31 | # generate key
32 | (sk, vk) = ttp_keygen(params, n, n)
33 |
34 | # aggregate verification keys
35 | aggr_vk = aggregate_vk(params, vk, threshold=False)
36 |
37 | # sign
38 | sigs = [sign(params, ski, m) for ski in sk]
39 |
40 | # aggregate credentials
41 | sigma = aggregate_sigma(params, sigs, threshold=False)
42 |
43 | # verify signature
44 | assert verify(params, aggr_vk, sigma, m)
45 |
--------------------------------------------------------------------------------
/tox.ini:
--------------------------------------------------------------------------------
1 | # content of: tox.ini
2 | [tox]
3 | envlist = py36
4 |
5 | [testenv]
6 | changedir = tests
7 | deps = pytest
8 |
--------------------------------------------------------------------------------