├── .editorconfig
├── .gitignore
├── .travis.yml
├── LICENSE
├── check.js
├── config
└── default.json
├── contracts
└── .gitkeep
├── index.js
├── lib
├── contract-event.js
├── generate-code.js
├── has-requested.js
├── manual-rpc-call.js
├── node-is-synced.js
├── normalize-number.js
├── nr-of-peers.js
├── post-to-contract.js
├── send-sms.js
├── storage.js
└── web3.js
├── mainnet.pm2.json
├── package.json
├── process.yml
├── readme.md
├── testnet.pm2.json
└── verify.js
/.editorconfig:
--------------------------------------------------------------------------------
1 | # editorconfig.org
2 | root = true
3 |
4 | [*]
5 | end_of_line = lf
6 | charset = utf-8
7 | insert_final_newline = true
8 | trim_trailing_whitespace = true
9 | indent_style = space
10 | indent_size = 2
11 |
12 | [*.sol]
13 | indent_size = 4
14 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | .DS_STORE
2 | thumbs.db
3 |
4 | node_modules
5 | npm-debug.log
6 |
7 | SMSVerification.sol
8 | contracts
9 |
10 | config/*
11 | !config/default.json
12 |
13 | dev.leveldb
14 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | sudo: false
2 | language: node_js
3 | node_js:
4 | - 'stable'
5 | - '7'
6 | - '6'
7 | cache:
8 | directories:
9 | - node_modules
10 | script:
11 | - npm run get-contract
12 | - npm run lint
13 | - npm run compile
14 |
--------------------------------------------------------------------------------
/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 |
635 | Copyright (C)
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 | Copyright (C)
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 | .
675 |
--------------------------------------------------------------------------------
/check.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const co = require('co-express')
4 | const boom = require('boom')
5 | const sha3 = require('web3/lib/utils/sha3')
6 |
7 | const web3 = require('./lib/web3')
8 | const normalizeNumber = require('./lib/normalize-number')
9 | const hasRequested = require('./lib/has-requested')
10 | const storage = require('./lib/storage')
11 |
12 | module.exports = co(function* (req, res) {
13 | let number = req.query.number
14 | try {
15 | number = yield normalizeNumber(number)
16 | } catch (err) {
17 | throw boom.badRequest('Phone number is invalid.')
18 | }
19 | const anonymized = '0x' + sha3(number)
20 |
21 | const address = req.query.address && req.query.address.toLowerCase()
22 | if (!web3.isAddress(address)) throw boom.badRequest('Address is invalid.')
23 |
24 | try {
25 | if (!(yield hasRequested(address))) {
26 | throw boom.badRequest('There is no request by this address.')
27 | }
28 | } catch (err) {
29 | if (err.isBoom) throw err
30 | throw boom.wrap(err, 500, 'An error occured while querying Parity')
31 | }
32 |
33 | try {
34 | const hasRequested = yield storage.has(anonymized)
35 | if (!hasRequested) throw boom.notFound('There has not been sent any code to this phone number.')
36 | return res.status(200).json({
37 | status: 'ok',
38 | message: 'A code has been sent to this phone number.'
39 | })
40 | } catch (err) {
41 | if (err.isBoom) throw err
42 | console.error('Error querying the database: ', err)
43 | throw boom.internal('An error occured while querying the database.')
44 | }
45 | })
46 |
--------------------------------------------------------------------------------
/config/default.json:
--------------------------------------------------------------------------------
1 | {
2 | "twilio": {
3 | "id": "",
4 | "token": "",
5 | "sender": "",
6 | "test": false
7 | },
8 | "http": {
9 | "port": 8000
10 | },
11 | "db": "./dev.leveldb",
12 | "passwordFile": "",
13 | "parity": {
14 | "host": "localhost:8545"
15 | }
16 | }
17 |
--------------------------------------------------------------------------------
/contracts/.gitkeep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/paritytech/sms-verification/df1d817fcdea4f8babcd65a44825f0457bc5eb2a/contracts/.gitkeep
--------------------------------------------------------------------------------
/index.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const express = require('express')
4 | const hsts = require('hsts')
5 | const corser = require('corser')
6 | const noCache = require('nocache')()
7 | const morgan = require('morgan')
8 | const sha3 = require('web3/lib/utils/sha3')
9 | const bodyParser = require('body-parser')
10 | const config = require('config')
11 | const http = require('http')
12 | const spdy = require('spdy')
13 | const fs = require('fs')
14 |
15 | const nodeIsSynced = require('./lib/node-is-synced')
16 | const nrOfPeers = require('./lib/nr-of-peers')
17 | const check = require('./check')
18 | const verify = require('./verify')
19 |
20 | const api = express()
21 | module.exports = api
22 |
23 | if (config.http.cert) {
24 | api.use(hsts({ maxAge: 3 * 24 * 60 * 60 * 1000 })) // 3 days
25 | }
26 |
27 | // CORS
28 | const allowed = corser.simpleRequestHeaders.concat(['User-Agent'])
29 | api.use(corser.create({requestHeaders: allowed}))
30 |
31 | api.use(bodyParser.json())
32 |
33 | morgan.token('number', (req) => sha3(req.query.number))
34 | morgan.token('address', (req) => req.query.address)
35 | api.use(morgan(':date[iso] :number :address :status :response-time ms'))
36 |
37 | api.get('/health', noCache, (req, res, next) => {
38 | Promise.all([
39 | nodeIsSynced(),
40 | nrOfPeers()
41 | ])
42 | .catch(() => [false, 0])
43 | .then(([isSynced, nrOfPeers]) => {
44 | res.status(isSynced && nrOfPeers > 0 ? 200 : 500).json({
45 | isSynced,
46 | nrOfPeers
47 | })
48 | })
49 | })
50 |
51 | api.get('/', noCache, check)
52 |
53 | api.post('/', noCache, verify)
54 |
55 | api.use((err, req, res, next) => {
56 | if (res.headersSent) return next()
57 | return res
58 | .status(err.isBoom ? err.output.statusCode : 500)
59 | .json({status: 'error', message: err.message})
60 | })
61 |
62 | const server = () => {
63 | if (config.http.cert) {
64 | return spdy.createServer({
65 | cert: fs.readFileSync(config.http.cert),
66 | key: fs.readFileSync(config.http.key)
67 | }, api)
68 | } else {
69 | return http.createServer(api)
70 | }
71 | }
72 |
73 | server().listen(config.http.port, (err) => {
74 | if (err) return console.error(err)
75 | console.info(`Listening on ${config.http.port}.`)
76 | })
77 |
--------------------------------------------------------------------------------
/lib/contract-event.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const co = require('co')
4 | const utils = require('web3/lib/utils/utils')
5 | const sha3 = require('web3/lib/utils/sha3')
6 |
7 | const web3 = require('./web3')
8 | const manualRpcCall = require('./manual-rpc-call')
9 |
10 | const getBlockNumber = () =>
11 | new Promise((resolve, reject) => {
12 | web3.eth.getBlockNumber((err, currentBlock) => {
13 | if (err) reject(err)
14 | else resolve(currentBlock)
15 | })
16 | })
17 |
18 | const contractEvent = co.wrap(function* (contract, abi, name, topics = []) {
19 | const event = abi.find((item) => item.name === name)
20 |
21 | const currentBlock = yield getBlockNumber()
22 |
23 | const filterId = yield manualRpcCall({
24 | method: 'eth_newFilter',
25 | params: [{
26 | address: contract.address,
27 | topics: [
28 | '0x' + sha3(utils.transformToFullName(event)) // event signature
29 | ].concat(topics),
30 | fromBlock: '0x0',
31 | toBlock: utils.toHex(currentBlock),
32 | limit: 1
33 | }]
34 | })
35 |
36 | const unsubscribe = () =>
37 | manualRpcCall({
38 | method: 'eth_uninstallFilter',
39 | params: [filterId]
40 | })
41 |
42 | const getLogs = () =>
43 | manualRpcCall({
44 | method: 'eth_getFilterLogs',
45 | params: [filterId]
46 | })
47 | .then((logs) => logs.map((log) => {
48 | log.params = log.topics.slice(1).reduce((params, topic, i) => {
49 | params[event.inputs[i].name] = topic
50 | return params
51 | }, {})
52 | return log
53 | }))
54 |
55 | return {getLogs, unsubscribe}
56 | })
57 |
58 | module.exports = contractEvent
59 |
--------------------------------------------------------------------------------
/lib/generate-code.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const web3 = require('./web3')
4 |
5 | // TODO use `web3._extend` for this
6 | const generateCode = () =>
7 | new Promise((resolve, reject) => {
8 | web3._requestManager.sendAsync({
9 | method: 'parity_generateSecretPhrase'
10 | }, (err, code) => {
11 | if (typeof code !== 'string') {
12 | return reject(new Error('invalid code given by Parity'))
13 | }
14 | const words = code.split(' ')
15 | if (err) reject(err)
16 | else resolve(words.slice(0, 4).join(' '))
17 | })
18 | })
19 |
20 | module.exports = generateCode
21 |
--------------------------------------------------------------------------------
/lib/has-requested.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const fs = require('fs')
4 | const path = require('path')
5 | const co = require('co')
6 | const coder = require('web3/lib/solidity/coder')
7 |
8 | const { address } = require('config')
9 | const web3 = require('./web3')
10 | const contractEvent = require('./contract-event')
11 |
12 | const abi = JSON.parse(fs.readFileSync(path.join(__dirname, '../contracts/ProofOfSMS.abi')))
13 | const contract = web3.eth.contract(abi).at(address)
14 |
15 | // In order to find the last `Requested` event for an account efficiently, we need to use the Parity-proprietary `limit` parameter (https://github.com/ethcore/parity/blob/a58fad06a7955247e4f01dd98cd97bab2d82f71f/js/src/jsonrpc/interfaces/eth.js#L933-L937). web3.js filters it out, so we need to make the RPC calls manually.
16 | // todo: move back to web3 once `limit` or some comparable mechanism is in the standard or switch to Parity.js
17 | const hasRequested = co.wrap(function* (who) {
18 | const event = yield contractEvent(contract, abi, 'Requested', [
19 | '0x' + coder.encodeParam('address', who) // 1st indexed param
20 | ])
21 |
22 | try {
23 | const [log] = yield event.getLogs()
24 | yield event.unsubscribe()
25 | return !!log
26 | } catch (err) {
27 | yield event.unsubscribe()
28 | throw err
29 | }
30 | })
31 |
32 | module.exports = hasRequested
33 |
--------------------------------------------------------------------------------
/lib/manual-rpc-call.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const config = require('config')
4 |
5 | const {fetch} = require('fetch-ponyfill')()
6 |
7 | const manualCall = (body) =>
8 | fetch('http://' + config.parity.host, {
9 | method: 'POST',
10 | headers: {
11 | 'Content-Type': 'application/json'
12 | },
13 | body: JSON.stringify(Object.assign({
14 | jsonrpc: '2.0',
15 | params: [],
16 | id: Math.round(Math.random() * 1000)
17 | }, body))
18 | })
19 | .then((res) => {
20 | if (res.ok) return res.json()
21 | throw new Error('response not ok')
22 | })
23 | .then((data) => {
24 | if (data.error) {
25 | const err = new Error(data.error.message)
26 | err.code = data.error.code
27 | throw err
28 | }
29 | return data.result
30 | })
31 |
32 | module.exports = manualCall
33 |
--------------------------------------------------------------------------------
/lib/node-is-synced.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const manualCall = require('./manual-rpc-call')
4 |
5 | // todo: remove this once https://github.com/ethereum/web3.js/pull/545 is merged & released
6 | const nodeIsSynced = () =>
7 | manualCall({method: 'eth_syncing'})
8 | .then((isSyncing) => isSyncing === false)
9 |
10 | module.exports = nodeIsSynced
11 |
--------------------------------------------------------------------------------
/lib/normalize-number.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const cfg = require('config').twilio
4 | const Client = require('twilio').LookupsClient
5 | const twilio = new Client(cfg.id, cfg.token)
6 |
7 | const normalizeNumber = (number) =>
8 | twilio.phoneNumbers(number).get()
9 | .then((data) => data.phone_number)
10 |
11 | module.exports = normalizeNumber
12 |
--------------------------------------------------------------------------------
/lib/nr-of-peers.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const manualCall = require('./manual-rpc-call')
4 | const {toDecimal} = require('web3/lib/utils/utils')
5 |
6 | // todo: remove this once there's an async web3.net.peerCount()
7 | const nrOfPeers = () =>
8 | manualCall({method: 'net_peerCount'})
9 | .then((peers) => toDecimal(peers))
10 |
11 | module.exports = nrOfPeers
12 |
--------------------------------------------------------------------------------
/lib/post-to-contract.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const fs = require('fs')
4 | const path = require('path')
5 | const sha3 = require('web3/lib/utils/sha3')
6 |
7 | const { address, owner, passwordFile } = require('config')
8 | const web3 = require('./web3')
9 | const hasRequested = require('./has-requested')
10 |
11 | const password = fs.readFileSync(passwordFile, {encoding: 'utf8'}).trim()
12 |
13 | const abi = JSON.parse(fs.readFileSync(path.join(__dirname, '../contracts/ProofOfSMS.abi')))
14 | const contract = web3.eth.contract(abi).at(address)
15 |
16 | // TODO use `web3._extend` for this
17 | const signAndSendTransaction = (data, password, cb) =>
18 | web3._requestManager.sendAsync({
19 | method: 'personal_sendTransaction',
20 | params: [data, password]
21 | }, (err, data) => {
22 | if (err) cb(err)
23 | else cb(null, data)
24 | })
25 |
26 | const postToContract = (who, code) =>
27 | new Promise((resolve, reject) => {
28 | // The response to the challenge. Because arbitrary-length strings don't play nicely with contracts, we use `sha3(code)`.
29 | const token = '0x' + sha3(code)
30 | // Will be stored inside the (public) contract, paired with `who`.
31 | const tokenHash = '0x' + sha3(token, {encoding: 'hex'})
32 |
33 | if (contract.certified(who)) {
34 | return reject(new Error('This address has already been verified.'))
35 | }
36 |
37 | hasRequested(who)
38 | .then((hasRequested) => {
39 | if (!hasRequested) return reject(new Error('Verification of this address not requested.'))
40 |
41 | console.info(`Sending challenge to contract.`)
42 | signAndSendTransaction({
43 | from: owner,
44 | to: address,
45 | data: contract.puzzle.getData(who, tokenHash)
46 | }, password, (err, txHash) => {
47 | if (err) reject(err)
48 | else resolve(txHash)
49 | })
50 | })
51 | .catch(reject)
52 | })
53 |
54 | module.exports = postToContract
55 |
--------------------------------------------------------------------------------
/lib/send-sms.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const cfg = require('config').twilio
4 | const twilio = require('twilio')(cfg.id, cfg.token)
5 |
6 | const sendSMS = (receiver, code) =>
7 | new Promise((resolve, reject) => {
8 | if (cfg.test) {
9 | console.info('code: ', code)
10 | return resolve('No code has been sent.')
11 | }
12 | twilio.messages.create({
13 | from: cfg.sender,
14 | to: receiver,
15 | body: `Your Parity verification code is "${code}".`
16 | }, (err, msg) => {
17 | if (err) reject(err)
18 | else resolve(msg)
19 | })
20 | })
21 |
22 | module.exports = sendSMS
23 |
--------------------------------------------------------------------------------
/lib/storage.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const levelup = require('levelup')
4 | const config = require('config')
5 |
6 | const db = levelup(config.db)
7 |
8 | module.exports = {
9 | has: (key) => new Promise((resolve, reject) => {
10 | db.get(key, (err) => {
11 | if (!err) resolve(true)
12 | else if (err.notFound) resolve(false)
13 | else reject(err)
14 | })
15 | }),
16 |
17 | get: (key) => new Promise((resolve, reject) => {
18 | db.get(key, (err, value) => {
19 | if (err) reject(err)
20 | else resolve(value)
21 | })
22 | }),
23 |
24 | put: (key, value) => new Promise((resolve, reject) => {
25 | db.put(key, value, (err) => {
26 | if (err) reject(err)
27 | else resolve()
28 | })
29 | })
30 | }
31 |
--------------------------------------------------------------------------------
/lib/web3.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const Web3 = require('web3')
4 | const config = require('config')
5 |
6 | const web3 = new Web3(new Web3.providers.HttpProvider('http://' + config.parity.host))
7 |
8 | module.exports = web3
9 |
--------------------------------------------------------------------------------
/mainnet.pm2.json:
--------------------------------------------------------------------------------
1 | {
2 | "name" : "sms-verification-mainnet",
3 | "exec_interpreter" : "node",
4 | "script" : "index.js",
5 | "log_date_format" : "YYYY-MM-DD HH:mm Z",
6 | "merge_logs" : false,
7 | "watch" : false,
8 | "max_restarts" : 10,
9 | "env": {
10 | "NODE_ENV" : "mainnet"
11 | }
12 | }
13 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "private": true,
3 | "name": "sms-verification",
4 | "version": "0.1.0",
5 | "description": "SMS verification for Parity.",
6 | "main": "index.js",
7 | "scripts": {
8 | "get-contract": "curl --fail -L 'https://raw.githubusercontent.com/ethcore/contracts/master/SMSVerification.sol' > SMSVerification.sol",
9 | "lint": "standard",
10 | "prepush": "npm run get-contract && npm run lint && npm run compile",
11 | "compile": "solcjs --abi --bin --optimize SMSVerification.sol -o contracts"
12 | },
13 | "keywords": [],
14 | "author": "Ethcore Team ",
15 | "maintainers": [
16 | "Jannis R "
17 | ],
18 | "license": "GPL-3.0",
19 | "repository": "ethcore/sms-verification",
20 | "engine": {
21 | "node": ">=6"
22 | },
23 | "dependencies": {
24 | "body-parser": "^1.15.2",
25 | "boom": "^5.0.0",
26 | "co": "^4.6.0",
27 | "co-express": "^2.0.0",
28 | "config": "^1.24.0",
29 | "corser": "^2.0.1",
30 | "express": "^4.14.0",
31 | "fetch-ponyfill": "^4.0.0",
32 | "hsts": "^2.0.0",
33 | "leveldown": "^1.5.0",
34 | "levelup": "^1.3.3",
35 | "morgan": "^1.7.0",
36 | "nocache": "^2.0.0",
37 | "solc": "^0.4.4",
38 | "spdy": "^3.4.4",
39 | "standard": "^8.5.0",
40 | "then-levelup": "^1.0.1",
41 | "twilio": "^3.0.0",
42 | "web3": "^0.19.0"
43 | },
44 | "peerDependencies": {
45 | "pm2": "^2.0.18"
46 | },
47 | "devDependencies": {
48 | "standard": "^8.4.0",
49 | "husky": "^0.14.1"
50 | }
51 | }
52 |
--------------------------------------------------------------------------------
/process.yml:
--------------------------------------------------------------------------------
1 | apps:
2 | - script : ./index.js
3 | name : 'sms-verification'
4 | env_production:
5 | NODE_ENV: production
6 |
--------------------------------------------------------------------------------
/readme.md:
--------------------------------------------------------------------------------
1 | # [Parity](https://ethcore.io/parity.html) SMS verification
2 |
3 | [![Join the chat at https://gitter.im/ethcore/parity][gitter-image]][gitter-url] [![GPLv3][license-image]][license-url]
4 |
5 | [gitter-image]: https://badges.gitter.im/Join%20Chat.svg
6 | [gitter-url]: https://gitter.im/ethcore/parity
7 | [license-image]: https://img.shields.io/badge/license-GPL%20v3-green.svg
8 | [license-url]: https://www.gnu.org/licenses/gpl-3.0.en.html
9 |
10 | The following process **verifies a number**:
11 |
12 | ```
13 | confirm(token)
14 | +-------------------> +--------+
15 | | |contract| puzzle(address, sha(token))
16 | | +-----------> +--------+ <-----------+
17 | | | |
18 | | | request() |
19 | | | |
20 | | | |
21 | | +------+ POST /?number=…&address=… +------+
22 | +-- |client| +-------------------------> |server| code=rand()
23 | +------+ +------+ token=sha(code)
24 | token=sha(code) ^ SMS with code |
25 | +------------------------------------+
26 | ```
27 |
28 | 1. client requests verification (`request()`)
29 | 2. client calls verification server (`POST /?number=…&address=…`)
30 | 3. server generates `code` and computes `token`
31 | 4. server posts challenge (`puzzle(address, sha(token))`)
32 | 5. server sends SMS to client (with `code`)
33 | 6. client computes `token`
34 | 7. client posts response (`confirm(token)`)
35 |
36 | Now, anyone can easily **check if a number is verified by calling `certified(address)`** on the contract.
37 |
38 | [latest deployed `SMSVerification.sol`](https://github.com/ethcore/contracts/blob/58842b9/SMSVerification.sol)
39 |
40 | ## Installation
41 |
42 | ```shell
43 | git clone https://github.com/ethcore/sms-verification.git
44 | cd sms-verification
45 | npm install --production
46 | ```
47 |
48 | ## Usage
49 |
50 | **The account calling `puzzle` has to be the `delegate` of the contract.**
51 |
52 | 1. Set up an account and put its password in a file.
53 | 2. Run Parity with `--jsonrpc-apis net,eth,personal,parity`.
54 | 3. Create a config file `config/.json`, which partially overrides `config/default.json`.
55 | 4. `env NODE_ENV= node index.js`
56 |
57 | Deploy to production using process managers like [forever](https://github.com/foreverjs/forever#readme).
58 |
59 | ---
60 |
61 | To run on both testnet and mainnet, just create two config files. Make sure to use
62 |
63 | - separate Parity processes listening on different ports (`parity.host`)
64 | - separate `db` files
65 | - separate ports to listen on (`http.port`)
66 |
--------------------------------------------------------------------------------
/testnet.pm2.json:
--------------------------------------------------------------------------------
1 | {
2 | "name" : "sms-verification-testnet",
3 | "exec_interpreter" : "node",
4 | "script" : "index.js",
5 | "log_date_format" : "YYYY-MM-DD HH:mm Z",
6 | "merge_logs" : false,
7 | "watch" : false,
8 | "max_restarts" : 10,
9 | "env": {
10 | "NODE_ENV" : "testnet"
11 | }
12 | }
13 |
--------------------------------------------------------------------------------
/verify.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 |
3 | const co = require('co-express')
4 | const boom = require('boom')
5 | const sha3 = require('web3/lib/utils/sha3')
6 |
7 | const web3 = require('./lib/web3')
8 | const normalizeNumber = require('./lib/normalize-number')
9 | const storage = require('./lib/storage')
10 | const generateCode = require('./lib/generate-code')
11 | const postToContract = require('./lib/post-to-contract')
12 | const sendSMS = require('./lib/send-sms')
13 |
14 | function internal (msg, err = null) {
15 | console.info(msg, err)
16 | return boom.internal(msg)
17 | }
18 |
19 | module.exports = co(function* (req, res) {
20 | let number = req.query.number
21 | try {
22 | number = yield normalizeNumber(number)
23 | } catch (err) {
24 | console.error(err)
25 | throw boom.badRequest('Phone number is invalid.')
26 | }
27 |
28 | const address = req.query.address && req.query.address.toLowerCase()
29 | if (!web3.isAddress(address)) throw boom.badRequest('Address is invalid.')
30 |
31 | let code
32 | try {
33 | code = yield generateCode()
34 | } catch (err) {
35 | throw internal('An error occured while generating a code.', err)
36 | }
37 |
38 | const anonymized = '0x' + sha3(number)
39 | try {
40 | if (yield storage.has(anonymized)) {
41 | throw boom.badRequest('This number has already been verified.')
42 | }
43 | } catch (err) {
44 | if (err.isBoom) throw err
45 | throw internal('An error occured while querying the database.', err)
46 | }
47 |
48 | try {
49 | yield sendSMS(number, code)
50 | console.info(`Verification code sent to ${anonymized}.`)
51 | } catch (err) {
52 | throw internal('An error occured while sending the SMS.', err)
53 | }
54 |
55 | try {
56 | const txHash = yield postToContract(address, code)
57 | console.info(`Challenge sent to contract (tx ${txHash}).`)
58 | } catch (err) {
59 | throw internal('An error occured while querying Parity.', err)
60 | }
61 |
62 | try {
63 | yield storage.put(anonymized, code)
64 | console.info(`Hash of phone number (${anonymized}) put into DB.`)
65 | } catch (err) {
66 | throw internal('An error occured while querying the database.', err)
67 | }
68 |
69 | return res.status(202).json({
70 | status: 'ok',
71 | message: `Verification code sent to ${number}.`
72 | })
73 | })
74 |
--------------------------------------------------------------------------------