├── .formatter.exs ├── .gitignore ├── .gitmodules ├── .travis.yml ├── LICENSE ├── Makefile ├── README.md ├── c_src ├── ntru_nif.c └── sample.c ├── config └── config.exs ├── lib ├── ntru_elixir.ex └── ntru_elixir │ ├── base.ex │ └── key_pair.ex ├── mix.exs ├── mix.lock └── test ├── ntru_elixir_base_test.exs ├── ntru_elixir_keypair_test.exs ├── ntru_elixir_test.exs └── test_helper.exs /.formatter.exs: -------------------------------------------------------------------------------- 1 | # Formatter config 2 | [ 3 | inputs: ["mix.exs", "{config,lib,test}/**/*.{ex,exs}"] 4 | ] 5 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # The directory Mix will write compiled artifacts to. 2 | /_build/ 3 | 4 | # Priv binaries 5 | /priv/ 6 | 7 | # If you run "mix test --cover", coverage assets end up here. 8 | /cover/ 9 | 10 | # The directory Mix downloads your dependencies sources to. 11 | /deps/ 12 | 13 | # Where 3rd-party dependencies like ExDoc output generated docs. 14 | /doc/ 15 | 16 | # Ignore .fetch files in case you like to edit your project deps locally. 17 | /.fetch 18 | 19 | # If the VM crashes, it generates a dump, let's ignore it too. 20 | erl_crash.dump 21 | 22 | # Also ignore archive artifacts (built via "mix archive.build"). 23 | *.ez 24 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "libntru"] 2 | path = libntru 3 | url = https://github.com/tbuktu/libntru.git 4 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: elixir 2 | elixir: 3 | - '1.5.2' 4 | otp_release: 5 | - '20.1' 6 | script: 7 | - "MIX_ENV=test mix do deps.get, test && MIX_ENV=test mix compile && MIX_ENV=test mix coveralls.travis" 8 | -------------------------------------------------------------------------------- /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 | ntru_elixir Copyright (C) 2020 Alisina Bahadori 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 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | # Argon2 password hashing algorithm for use with Elixir 2 | # Makefile 3 | # 4 | # Copyright 2016-2017 David Whitlock 5 | # 6 | # This is licensed under the Apache Public License 2.0 7 | # 8 | # The license and copyright information for the reference implementation 9 | # is detailed below: 10 | # 11 | # Argon2 reference source code package - reference C implementations 12 | # 13 | # Copyright 2015 14 | # Daniel Dinu, Dmitry Khovratovich, Jean-Philippe Aumasson, and Samuel Neves 15 | # 16 | # You may use this work under the terms of a Creative Commons CC0 1.0 17 | # License/Waiver or the Apache Public License 2.0, at your option. The terms of 18 | # these licenses can be found at: 19 | # 20 | # - CC0 1.0 Universal : http://creativecommons.org/publicdomain/zero/1.0 21 | # - Apache 2.0 : http://www.apache.org/licenses/LICENSE-2.0 22 | # 23 | # You should have received a copy of both of these licenses along with this 24 | # software. If not, they may be obtained at the above URLs. 25 | # 26 | 27 | SRC_DIR = libntru/src 28 | 29 | SRC = $(SRC_DIR)/ntru.c $(SRC_DIR)/encparams.c $(SRC_DIR)/key.c\ 30 | $(SRC_DIR)/hash.c $(SRC_DIR)/rand.c $(SRC_DIR)/idxgen.c\ 31 | $(SRC_DIR)/sha2.c $(SRC_DIR)/sha1.c $(SRC_DIR)/poly.c\ 32 | $(SRC_DIR)/nist_ctr_drbg.c $(SRC_DIR)/rijndael.c $(SRC_DIR)/bitstring.c\ 33 | $(SRC_DIR)/mgf.c $(SRC_DIR)/arith.c\ 34 | c_src/ntru_nif.c 35 | 36 | ERLANG_PATH = $(shell erl -eval 'io:format("~s", [lists:concat([code:root_dir(), "/erts-", erlang:system_info(version), "/include"])])' -s init stop -noshell) 37 | CFLAGS += -pthread -O3 -Wall -g -I$(SRC_DIR) -Ic_src -I$(ERLANG_PATH) 38 | #CFLAGS += -std=c89 -pedantic -pthread -O3 -Wall -g -I$(SRC_INC) -I$(SRC_DIR) -Ic_src -I$(ERLANG_PATH) 39 | 40 | KERNEL_NAME := $(shell uname -s) 41 | 42 | LIB_NAME = priv/ntru_nif.so 43 | ifneq ($(CROSSCOMPILE),) 44 | LIB_CFLAGS := -shared -fPIC -fvisibility=hidden 45 | SO_LDFLAGS := -Wl,-soname,libntru.so.0 46 | else 47 | ifeq ($(KERNEL_NAME), Linux) 48 | LIB_CFLAGS := -shared -fPIC -fvisibility=hidden 49 | SO_LDFLAGS := -Wl,-soname,libntru.so.0 50 | endif 51 | ifeq ($(KERNEL_NAME), Darwin) 52 | LIB_CFLAGS := -dynamiclib -undefined dynamic_lookup 53 | endif 54 | ifeq ($(KERNEL_NAME), $(filter $(KERNEL_NAME),OpenBSD FreeBSD NetBSD)) 55 | LIB_CFLAGS := -shared -fPIC 56 | endif 57 | endif 58 | 59 | all: $(LIB_NAME) 60 | 61 | $(LIB_NAME): $(SRC) 62 | mkdir -p priv 63 | $(CC) $(CFLAGS) $(LIB_CFLAGS) $(SO_LDFLAGS) $^ -o $@ 64 | 65 | clean: 66 | rm -f $(LIB_NAME) 67 | 68 | .PHONY: all clean 69 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # NtruElixir 2 | [![Build Status](https://travis-ci.org/alisinabh/ntru_elixir.svg?branch=master)](https://travis-ci.org/alisinabh/ntru_elixir) [![Coverage Status](https://coveralls.io/repos/github/alisinabh/ntru_elixir/badge.svg?branch=master)](https://coveralls.io/github/alisinabh/ntru_elixir?branch=master) 3 | 4 | 5 | A wrapper around [libntru](https://github.com/tbuktu/libntru) using NIFs. 6 | 7 | **WARNING:** This is a work in progress and shall not be used in production 8 | projects yet. 9 | 10 | ## What is NTRU? 11 | 12 | NTRU is a patented and open source public-key cryptosystem that uses lattice-based cryptography to encrypt and decrypt data. It consists of two algorithms: NTRUEncrypt, which is used for encryption, and NTRUSign, which is used for digital signatures. Unlike other popular public-key cryptosystems, it is resistant to attacks using Shor's algorithm and its performance has been shown to be significantly better 13 | 14 | [More on Wikipedia](https://en.wikipedia.org/wiki/NTRU) 15 | 16 | ## Installation 17 | 18 | Add `:ntru_elixir` to your deps. 19 | 20 | ```elixir 21 | def deps do 22 | [ 23 | {:ntru_elixir, "~> 0.0.0"} 24 | ] 25 | end 26 | ``` 27 | 28 | ## Documentation 29 | 30 | Please visit [hexdocs.pm/ntru_elixir](https://hexdocs.pm/ntru_elixir/NtruElixir.html) 31 | for complete documentations. 32 | 33 | ### Creating KeyPairs 34 | 35 | In NTRU each private key can have multiple public keys. However to decrypt the 36 | encrypted data the same public key which data was encrypted with is necessarry. 37 | 38 | To Create a KeyPair: 39 | 40 | ```elixir 41 | NtruElixir.generate_key_pair(pub_count, ntru_params(optional)) 42 | {:ok, 43 | [%NtruElixir.KeyPair{ntru_params: :NTRU_DEFAULT_PARAMS_128_BITS, 44 | priv_key: <<...>>, 45 | pub_key: <<...>>}, ...]} 46 | ``` 47 | 48 | Note that if you specify `pub_count` you will get multiple KeyPair structs. 49 | 50 | ### Encrypting 51 | 52 | Binaries can be encrypted with a keypair having the public key 53 | 54 | ```elixir 55 | NtruElixir.encrypt(key_pair, binary_to_encrypt) 56 | {:ok, encrypted_binary} 57 | ``` 58 | 59 | ### Decrypting 60 | 61 | Encrypted binaries can be decrypted with a keypair having BOTH public key and 62 | private key. 63 | Note that the public key should be the same as encryption public key. 64 | 65 | ```elixir 66 | NtruElixir.decrypt(key_pair, binary_to_decrypt) 67 | {:ok, decrypted_binary} 68 | ``` 69 | 70 | ## License 71 | 72 | The `ntru_elixir` project is licensed under **GNU GPLv3** however 73 | it uses another libraries with different licenses. 74 | 75 | `libntru` is licensed under BSD-3-Clause 76 | -------------------------------------------------------------------------------- /c_src/ntru_nif.c: -------------------------------------------------------------------------------- 1 | #include "ntru.h" 2 | #include "encparams.h" 3 | #include 4 | #include 5 | #include "erl_nif.h" 6 | 7 | static int 8 | determine_enc(ErlNifEnv *env, ERL_NIF_TERM arg, struct NtruEncParams *params) { 9 | unsigned ptype_atom_len; 10 | 11 | if(!enif_get_atom_length(env, arg, &ptype_atom_len, ERL_NIF_LATIN1)) { 12 | return 0; 13 | } 14 | 15 | char params_type[ptype_atom_len + 1]; 16 | (void)memset(¶ms_type, '\0', sizeof(params_type)); 17 | 18 | if (enif_get_atom(env, arg, params_type, sizeof(params_type), ERL_NIF_LATIN1) < 1) { 19 | return 0; 20 | } 21 | 22 | if (strcmp(params_type, "EES401EP1") == 0) { 23 | *params = EES401EP1; 24 | } else if (strcmp(params_type, "EES541EP1") == 0) { 25 | *params = EES541EP1; 26 | } else if (strcmp(params_type, "EES659EP1") == 0) { 27 | *params = EES659EP1; 28 | } else if (strcmp(params_type, "EES401EP2") == 0) { 29 | *params = EES401EP2; 30 | } else if (strcmp(params_type, "NTRU_DEFAULT_PARAMS_112_BITS") == 0) { 31 | *params = NTRU_DEFAULT_PARAMS_112_BITS; 32 | } else if (strcmp(params_type, "EES449EP1") == 0) { 33 | *params = EES449EP1; 34 | } else if (strcmp(params_type, "EES613EP1") == 0) { 35 | *params = EES613EP1; 36 | } else if (strcmp(params_type, "EES761EP1") == 0) { 37 | *params = EES761EP1; 38 | } else if (strcmp(params_type, "EES439EP1") == 0) { 39 | *params = EES439EP1; 40 | } else if (strcmp(params_type, "EES443EP1") == 0) { 41 | *params = EES443EP1; 42 | } else if (strcmp(params_type, "NTRU_DEFAULT_PARAMS_128_BITS") == 0) { 43 | *params = NTRU_DEFAULT_PARAMS_128_BITS; 44 | } else if (strcmp(params_type, "EES677EP1") == 0) { 45 | *params = EES677EP1; 46 | } else if (strcmp(params_type, "EES887EP1") == 0) { 47 | *params = EES887EP1; 48 | } else if (strcmp(params_type, "EES1087EP1") == 0) { 49 | *params = EES1087EP1; 50 | } else if (strcmp(params_type, "EES593EP1") == 0) { 51 | *params = EES593EP1; 52 | } else if (strcmp(params_type, "EES587EP1") == 0) { 53 | *params = EES587EP1; 54 | } else if (strcmp(params_type, "NTRU_DEFAULT_PARAMS_192_BITS") == 0) { 55 | *params = NTRU_DEFAULT_PARAMS_192_BITS; 56 | } else if (strcmp(params_type, "EES1087EP2") == 0) { 57 | *params = EES1087EP2; 58 | } else if (strcmp(params_type, "EES1171EP1") == 0) { 59 | *params = EES541EP1; 60 | } else if (strcmp(params_type, "EES1499EP1") == 0) { 61 | *params = EES1499EP1; 62 | } else if (strcmp(params_type, "EES743EP1") == 0) { 63 | *params = EES743EP1; 64 | } else if (strcmp(params_type, "NTRU_DEFAULT_PARAMS_256_BITS") == 0) { 65 | *params = NTRU_DEFAULT_PARAMS_256_BITS; 66 | } else { 67 | return 0; 68 | } 69 | 70 | return 1; 71 | } 72 | 73 | static ERL_NIF_TERM 74 | gen_key_pair(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]) { 75 | if (argc != 2) { 76 | return enif_make_badarg(env); 77 | } 78 | 79 | ErlNifBinary pub_bin, priv_bin; 80 | 81 | struct NtruEncParams params; 82 | if(determine_enc(env, argv[0], ¶ms) != 1) 83 | return enif_make_badarg(env); 84 | 85 | NtruRandGen rng_def = NTRU_RNG_DEFAULT; 86 | 87 | unsigned rng_atom_len; 88 | 89 | if(!enif_get_atom_length(env, argv[1], &rng_atom_len, ERL_NIF_LATIN1)) { 90 | return enif_make_badarg(env); 91 | } 92 | 93 | char rng_def_str[rng_atom_len + 1]; 94 | (void)memset(&rng_def_str, '\0', sizeof(rng_def_str)); 95 | 96 | if (enif_get_atom(env, argv[1], rng_def_str, sizeof(rng_def_str), ERL_NIF_LATIN1) < 1) { 97 | return enif_make_badarg(env); 98 | } 99 | 100 | NtruRandContext rand_ctx_def; 101 | if (ntru_rand_init(&rand_ctx_def, &rng_def) != NTRU_SUCCESS) 102 | return enif_make_tuple2(env, enif_make_atom(env, "error"), enif_make_atom(env, "init_rand_fail")); 103 | 104 | NtruEncKeyPair kp; 105 | if (ntru_gen_key_pair(¶ms, &kp, &rand_ctx_def) != NTRU_SUCCESS) 106 | return enif_make_tuple2(env, enif_make_atom(env, "error"), enif_make_atom(env, "keygen_fail")); 107 | 108 | if (ntru_rand_release(&rand_ctx_def) != NTRU_SUCCESS) 109 | return enif_make_tuple2(env, enif_make_atom(env, "error"), enif_make_atom(env, "release_rnd_fail")); 110 | 111 | int pub_len = ntru_pub_len(¶ms); 112 | uint8_t pub_arr[pub_len]; 113 | ntru_export_pub(&kp.pub, pub_arr); 114 | 115 | if (enif_alloc_binary(pub_len, &pub_bin)) 116 | { 117 | size_t i; 118 | for (i = 0; i < pub_len; i++) { 119 | pub_bin.data[i] = pub_arr[i]; 120 | } 121 | 122 | int priv_len = ntru_priv_len(¶ms); 123 | uint8_t priv_arr[priv_len]; 124 | ntru_export_priv(&kp.priv, priv_arr); 125 | 126 | if(enif_alloc_binary(priv_len, &priv_bin)) 127 | { 128 | for (i = 0; i < priv_len; i++) { 129 | priv_bin.data[i] = priv_arr[i]; 130 | } 131 | 132 | return enif_make_tuple3( 133 | env, 134 | enif_make_atom(env, "ok"), 135 | enif_make_binary(env, &pub_bin), 136 | enif_make_binary(env, &priv_bin) 137 | ); 138 | } 139 | } 140 | 141 | return enif_make_badarg(env); 142 | } 143 | 144 | static ERL_NIF_TERM 145 | gen_pub_key(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]) { 146 | ErlNifBinary pub_bin, priv_bin; 147 | 148 | struct NtruEncParams params; 149 | 150 | if(argc != 2 151 | || !enif_inspect_binary(env, argv[0], &priv_bin) 152 | || determine_enc(env, argv[1], ¶ms) != 1) 153 | return enif_make_badarg(env); 154 | 155 | uint8_t priv_data[priv_bin.size]; 156 | size_t i; 157 | for (i = 0; i < sizeof(priv_data); i++) { 158 | priv_data[i] = priv_bin.data[i]; 159 | } 160 | 161 | NtruEncPrivKey priv_key; 162 | ntru_import_priv(priv_data, &priv_key); 163 | 164 | NtruRandGen rng_def = NTRU_RNG_DEFAULT; 165 | NtruRandContext rand_ctx_def; 166 | if (ntru_rand_init(&rand_ctx_def, &rng_def) != NTRU_SUCCESS) 167 | return enif_make_tuple2(env, enif_make_atom(env, "error"), enif_make_atom(env, "init_rand_fail")); 168 | 169 | NtruEncPubKey pub_key; 170 | 171 | if (ntru_gen_pub(¶ms, &priv_key, &pub_key, &rand_ctx_def) != NTRU_SUCCESS) 172 | return enif_make_tuple2(env, enif_make_atom(env, "error"), enif_make_atom(env, "pub_gen_fail")); 173 | 174 | int pub_len = ntru_pub_len(¶ms); 175 | uint8_t pub_arr[pub_len]; 176 | ntru_export_pub(&pub_key, pub_arr); 177 | 178 | if (!enif_alloc_binary(pub_len, &pub_bin)) 179 | return enif_make_tuple2(env, enif_make_atom(env, "error"), enif_make_atom(env, "pub_alloc_fail")); 180 | 181 | for (i = 0; i < pub_len; i++) { 182 | pub_bin.data[i] = pub_arr[i]; 183 | } 184 | 185 | return enif_make_tuple2(env, enif_make_atom(env, "ok"), enif_make_binary(env, &pub_bin)); 186 | } 187 | 188 | static ERL_NIF_TERM 189 | gen_key_pair_multi(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]) { 190 | 191 | if (argc != 3) { 192 | return enif_make_badarg(env); 193 | } 194 | 195 | struct NtruEncParams params; 196 | if(determine_enc(env, argv[1], ¶ms) != 1) 197 | return enif_make_badarg(env); 198 | 199 | int pub_count; 200 | 201 | if(!enif_get_int(env, argv[0], &pub_count)) 202 | return enif_make_badarg(env); 203 | 204 | NtruRandGen rng_def = NTRU_RNG_DEFAULT; 205 | 206 | NtruRandContext rand_ctx_def; 207 | if (ntru_rand_init(&rand_ctx_def, &rng_def) != NTRU_SUCCESS) 208 | return enif_make_tuple2(env, enif_make_atom(env, "error"), enif_make_atom(env, "init_rand_fail")); 209 | 210 | NtruEncPubKey pubs[pub_count]; 211 | NtruEncPrivKey priv; 212 | if(ntru_gen_key_pair_multi(¶ms, &priv, pubs, &rand_ctx_def, pub_count) != NTRU_SUCCESS) 213 | return enif_make_tuple2(env, enif_make_atom(env, "error"), enif_make_atom(env, "keygen_fail")); 214 | 215 | if (ntru_rand_release(&rand_ctx_def) != NTRU_SUCCESS) 216 | return enif_make_tuple2(env, enif_make_atom(env, "error"), enif_make_atom(env, "release_rnd_fail")); 217 | 218 | ERL_NIF_TERM pubs_term[pub_count]; 219 | int pub_len = ntru_pub_len(¶ms); 220 | 221 | size_t i; 222 | for (i = 0; i < pub_count; i++) { 223 | uint8_t pub_arr[pub_len]; 224 | ErlNifBinary tmp_bin; 225 | 226 | ntru_export_pub(&pubs[i], pub_arr); 227 | 228 | if (!enif_alloc_binary(pub_len, &tmp_bin)) 229 | return enif_make_tuple2(env, enif_make_atom(env, "error"), enif_make_atom(env, "keygen_fail")); 230 | 231 | size_t j; 232 | for (j = 0; j < pub_len; j++) { 233 | tmp_bin.data[j] = pub_arr[j]; 234 | } 235 | 236 | pubs_term[i] = enif_make_binary(env, &tmp_bin); 237 | } 238 | 239 | int priv_len = ntru_priv_len(¶ms); 240 | uint8_t priv_arr[priv_len]; 241 | ntru_export_priv(&priv, priv_arr); 242 | 243 | ErlNifBinary priv_bin; 244 | if (!enif_alloc_binary(priv_len, &priv_bin)) 245 | return enif_make_tuple2(env, enif_make_atom(env, "error"), enif_make_atom(env, "priv_fail")); 246 | 247 | for (i = 0; i < priv_len; i++) { 248 | priv_bin.data[i] = priv_arr[i]; 249 | } 250 | 251 | return enif_make_tuple3(env, 252 | enif_make_atom(env, "ok"), 253 | enif_make_list_from_array(env, pubs_term, pub_count), 254 | enif_make_binary(env, &priv_bin)); 255 | } 256 | 257 | static ERL_NIF_TERM 258 | encrypt(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]) { 259 | ErlNifBinary pub_bin, inp_data; 260 | 261 | struct NtruEncParams params; 262 | 263 | if(argc != 3 264 | || !enif_inspect_binary(env, argv[0], &pub_bin) 265 | || determine_enc(env, argv[2], ¶ms) != 1 266 | || !enif_inspect_binary(env, argv[1], &inp_data)) 267 | return enif_make_badarg(env); 268 | 269 | /* encryption */ 270 | uint8_t data[inp_data.size]; 271 | uint8_t enc[ntru_enc_len(¶ms)]; 272 | 273 | size_t i; 274 | for (i = 0; i < sizeof(data); i++) { 275 | data[i] = inp_data.data[i]; 276 | } 277 | 278 | uint8_t pub_data[pub_bin.size]; 279 | for (i = 0; i < sizeof(pub_data); i++) { 280 | pub_data[i] = pub_bin.data[i]; 281 | } 282 | 283 | // uint8_t priv_data[priv_bin.size]; 284 | // for (size_t i = 0; i < sizeof(priv_data); i++) { 285 | // priv_data[i] = priv_bin.data[i]; 286 | // } 287 | 288 | //NtruEncKeyPair kp; 289 | 290 | NtruEncPubKey pub_key; 291 | ntru_import_pub(pub_data, &pub_key); 292 | 293 | NtruRandGen rng_def = NTRU_RNG_DEFAULT; 294 | NtruRandContext rand_ctx_def; 295 | if (ntru_rand_init(&rand_ctx_def, &rng_def) != NTRU_SUCCESS) 296 | return enif_make_tuple2(env, enif_make_atom(env, "error"), enif_make_atom(env, "init_rand_fail")); 297 | 298 | if (ntru_encrypt(data, sizeof(data), &pub_key, ¶ms, &rand_ctx_def, enc) != NTRU_SUCCESS) 299 | return enif_make_tuple2(env, enif_make_atom(env, "error"), enif_make_atom(env, "enc_fail")); 300 | 301 | if (ntru_rand_release(&rand_ctx_def) != NTRU_SUCCESS) 302 | return enif_make_tuple2(env, enif_make_atom(env, "error"), enif_make_atom(env, "release_rnd_fail")); 303 | 304 | ErlNifBinary enc_out; 305 | 306 | if(!enif_alloc_binary(sizeof(enc), &enc_out)) 307 | return enif_make_badarg(env); 308 | 309 | for (i = 0; i < sizeof(enc); i++) { 310 | enc_out.data[i] = enc[i]; 311 | } 312 | 313 | return enif_make_tuple2(env, enif_make_atom(env, "ok"), enif_make_binary(env, &enc_out)); 314 | } 315 | 316 | static ERL_NIF_TERM 317 | decrypt(ErlNifEnv *env, int argc, const ERL_NIF_TERM argv[]) { 318 | ErlNifBinary pub_bin, priv_bin, inp_data; 319 | 320 | struct NtruEncParams params; 321 | 322 | if (argc != 4 323 | || !enif_inspect_binary(env, argv[0], &pub_bin) 324 | || !enif_inspect_binary(env, argv[1], &priv_bin) 325 | || determine_enc(env, argv[3], ¶ms) != 1 326 | || !enif_inspect_binary(env, argv[2], &inp_data)) 327 | return enif_make_badarg(env); 328 | 329 | /* encryption */ 330 | uint8_t data[inp_data.size]; 331 | uint8_t dec[ntru_max_msg_len(¶ms)]; 332 | 333 | size_t i; 334 | for (i = 0; i < sizeof(data); i++) { 335 | data[i] = inp_data.data[i]; 336 | } 337 | 338 | uint8_t pub_data[pub_bin.size]; 339 | for (i = 0; i < sizeof(pub_data); i++) { 340 | pub_data[i] = pub_bin.data[i]; 341 | } 342 | 343 | uint8_t priv_data[priv_bin.size]; 344 | for (i = 0; i < sizeof(priv_data); i++) { 345 | priv_data[i] = priv_bin.data[i]; 346 | } 347 | 348 | NtruEncKeyPair kp; 349 | 350 | NtruEncPubKey pub_key; 351 | ntru_import_pub(pub_data, &pub_key); 352 | 353 | NtruEncPrivKey priv_key; 354 | ntru_import_priv(priv_data, &priv_key); 355 | 356 | kp.pub = pub_key; 357 | kp.priv = priv_key; 358 | 359 | NtruRandGen rng_def = NTRU_RNG_DEFAULT; 360 | NtruRandContext rand_ctx_def; 361 | if (ntru_rand_init(&rand_ctx_def, &rng_def) != NTRU_SUCCESS) 362 | return enif_make_tuple2(env, enif_make_atom(env, "error"), enif_make_atom(env, "init_rand_fail")); 363 | 364 | uint16_t dec_len; 365 | if (ntru_decrypt((uint8_t*)&data, &kp, ¶ms, (uint8_t*)&dec, &dec_len) != NTRU_SUCCESS) 366 | return enif_make_tuple2(env, enif_make_atom(env, "error"), enif_make_atom(env, "dec_fail")); 367 | 368 | if (ntru_rand_release(&rand_ctx_def) != NTRU_SUCCESS) 369 | return enif_make_tuple2(env, enif_make_atom(env, "error"), enif_make_atom(env, "release_rnd_fail")); 370 | 371 | ErlNifBinary dec_out; 372 | 373 | if(!enif_alloc_binary(dec_len, &dec_out)) 374 | return enif_make_badarg(env); 375 | 376 | for (i = 0; i < dec_len; i++) { 377 | dec_out.data[i] = dec[i]; 378 | } 379 | 380 | return enif_make_tuple2(env, enif_make_atom(env, "ok"), enif_make_binary(env, &dec_out)); 381 | } 382 | 383 | static ErlNifFunc nif_funcs[] = { 384 | {"gen_key_pair", 2, gen_key_pair}, 385 | {"gen_pub_key", 2, gen_pub_key}, 386 | {"gen_key_pair_multi", 3, gen_key_pair_multi}, 387 | {"encrypt", 3, encrypt}, 388 | {"decrypt", 4, decrypt} 389 | }; 390 | 391 | ERL_NIF_INIT(Elixir.NtruElixir.Base, nif_funcs, NULL, NULL, NULL, NULL) 392 | -------------------------------------------------------------------------------- /c_src/sample.c: -------------------------------------------------------------------------------- 1 | #include "ntru.h" 2 | 3 | /* key generation */ 4 | struct NtruEncParams params = NTRU_DEFAULT_PARAMS_128_BITS; /*see section "Parameter Sets" below*/ 5 | NtruRandGen rng_def = NTRU_RNG_DEFAULT; 6 | NtruRandContext rand_ctx_def; 7 | if (ntru_rand_init(&rand_ctx_def, &rng_def) != NTRU_SUCCESS) 8 | printf("rng fail\n"); 9 | NtruEncKeyPair kp; 10 | if (ntru_gen_key_pair(¶ms, &kp, &rand_ctx_def) != NTRU_SUCCESS) 11 | printf("keygen fail\n"); 12 | 13 | /* deterministic key generation from password */ 14 | uint8_t seed[17]; 15 | strcpy(seed, "my test password"); 16 | NtruRandGen rng_ctr_drbg = NTRU_RNG_CTR_DRBG; 17 | NtruRandContext rand_ctx_ctr_drbg; 18 | if (ntru_rand_init_det(&rand_ctx_ctr_drbg, &rng_ctr_drbg, seed, strlen(seed)) != NTRU_SUCCESS) 19 | printf("rng fail\n"); 20 | if (ntru_gen_key_pair(¶ms, &kp, &rand_ctx_ctr_drbg) != NTRU_SUCCESS) 21 | printf("keygen fail\n"); 22 | 23 | /* encryption */ 24 | uint8_t msg[9]; 25 | strcpy(msg, "whatever"); 26 | uint8_t enc[ntru_enc_len(¶ms)]; 27 | if (ntru_encrypt(msg, strlen(msg), &kp.pub, ¶ms, &rand_ctx_def, enc) != NTRU_SUCCESS) 28 | printf("encrypt fail\n"); 29 | 30 | /* decryption */ 31 | uint8_t dec[ntru_max_msg_len(¶ms)]; 32 | uint16_t dec_len; 33 | if (ntru_decrypt((uint8_t*)&enc, &kp, ¶ms, (uint8_t*)&dec, &dec_len) != NTRU_SUCCESS) 34 | printf("decrypt fail\n"); 35 | 36 | /* generate another public key for the existing private key */ 37 | NtruEncPubKey pub2; 38 | if (ntru_gen_pub(¶ms, &kp.priv, &pub2, &rand_ctx_def) != NTRU_SUCCESS) 39 | printf("pub key generation fail\n"); 40 | 41 | /* release RNG resources */ 42 | if (ntru_rand_release(&rand_ctx_def) != NTRU_SUCCESS) 43 | printf("rng fail\n"); 44 | if (ntru_rand_release(&rand_ctx_ctr_drbg) != NTRU_SUCCESS) 45 | printf("rng fail\n"); 46 | 47 | /* export key to uint8_t array */ 48 | uint8_t pub_arr[ntru_pub_len(¶ms)]; 49 | ntru_export_pub(&kp.pub, pub_arr); 50 | 51 | /* import key from uint8_t array */ 52 | NtruEncPubKey pub; 53 | ntru_import_pub(pub_arr, &pub); 54 | -------------------------------------------------------------------------------- /config/config.exs: -------------------------------------------------------------------------------- 1 | # This file is responsible for configuring your application 2 | # and its dependencies with the aid of the Mix.Config module. 3 | use Mix.Config 4 | 5 | # This configuration is loaded before any dependency and is restricted 6 | # to this project. If another project depends on this project, this 7 | # file won't be loaded nor affect the parent project. For this reason, 8 | # if you want to provide default values for your application for 9 | # 3rd-party users, it should be done in your "mix.exs" file. 10 | 11 | # You can configure your application as: 12 | # 13 | # config :ntru_elixir, key: :value 14 | # 15 | # and access this configuration in your application as: 16 | # 17 | # Application.get_env(:ntru_elixir, :key) 18 | # 19 | # You can also configure a 3rd-party app: 20 | # 21 | # config :logger, level: :info 22 | # 23 | 24 | # It is also possible to import configuration files, relative to this 25 | # directory. For example, you can emulate configuration per environment 26 | # by uncommenting the line below and defining dev.exs, test.exs and such. 27 | # Configuration from the imported file will override the ones defined 28 | # here (which is why it is important to import them last). 29 | # 30 | # import_config "#{Mix.env}.exs" 31 | -------------------------------------------------------------------------------- /lib/ntru_elixir.ex: -------------------------------------------------------------------------------- 1 | defmodule NtruElixir do 2 | @moduledoc """ 3 | Documentation for NtruElixir. 4 | """ 5 | 6 | alias NtruElixir.Base 7 | alias NtruElixir.KeyPair 8 | 9 | require Logger 10 | 11 | @doc """ 12 | Generates an NTRU key pair with given ntru_params 13 | 14 | For more information on ntru_params please visit 15 | [libntru - Parameter Sets](https://github.com/tbuktu/libntru#parameter-sets) 16 | 17 | ## Parameters 18 | - pub_count: Number of public keys to generate 19 | - ntru_params: An atom representing the params of generated NTRU keypair. 20 | 21 | Returns a tuple like {:ok, %KeyPair{...}} on success 22 | """ 23 | @spec generate_key_pair(Base.ntru_params_t()) :: 24 | {:ok, List.t()} 25 | | {:error, atom()} 26 | def generate_key_pair( 27 | pub_count \\ 1, 28 | ntru_params \\ :NTRU_DEFAULT_PARAMS_128_BITS 29 | ) 30 | 31 | def generate_key_pair(1, ntru_params) do 32 | case Base.gen_key_pair(ntru_params, :default) do 33 | {:ok, pub_key, priv_key} -> 34 | {:ok, [KeyPair.new!(pub_key, ntru_params, priv_key)]} 35 | 36 | {:error, reason} -> 37 | Logger.debug("Generating single key error: #{inspect(reason)}") 38 | {:error, reason} 39 | 40 | error -> 41 | Logger.error("Unknown error in single key pair generation! #{inspect(error)}") 42 | {:error, :unknown} 43 | end 44 | end 45 | 46 | def generate_key_pair(pub_count, ntru_params) do 47 | case Base.gen_key_pair_multi(pub_count, ntru_params, :default) do 48 | {:ok, pub_keys, priv_key} -> 49 | {:ok, get_key_pairs(priv_key, ntru_params, pub_keys)} 50 | 51 | {:error, reason} -> 52 | Logger.debug("Generating single key error: #{inspect(reason)}") 53 | {:error, reason} 54 | 55 | error -> 56 | Logger.error("Unknown error in single key pair generation! #{inspect(error)}") 57 | {:error, :unknown} 58 | end 59 | end 60 | 61 | @doc """ 62 | Generates an NTRU key pair with given ntru_params and private key 63 | 64 | Note that in NTRU a single private key can have multiple public keys. 65 | But you'll need the public key whick encrypted the data in order to decrypt it. 66 | 67 | For more information on ntru_params please visit 68 | [libntru - Parameter Sets](https://github.com/tbuktu/libntru#parameter-sets) 69 | 70 | ## Parameters 71 | - priv_key: Binary of the private key 72 | - pub_count: Number of public keys to generate 73 | - ntru_params: An atom representing the params of generated NTRU keypair. 74 | 75 | Returns a tuple like {:ok, %KeyPair{...}} on success 76 | """ 77 | @spec generate_key_pair(binary(), Integer.t(), Base.ntru_params_t()) :: 78 | {:ok, List.t()} 79 | | {:error, atom()} 80 | def generate_key_pair(priv_key, pub_count, ntru_params) when is_binary(priv_key) do 81 | do_generate_key_pair(priv_key, ntru_params, [], pub_count) 82 | end 83 | 84 | defp do_generate_key_pair(_, _, acc, 0) when is_list(acc), do: {:ok, acc} 85 | 86 | defp do_generate_key_pair(priv_key, ntru_params, acc, pub_cnt) do 87 | case Base.gen_pub_key(priv_key, ntru_params) do 88 | {:ok, pub_key} -> 89 | do_generate_key_pair( 90 | priv_key, 91 | ntru_params, 92 | [KeyPair.new!(pub_key, ntru_params, priv_key) | acc], 93 | pub_cnt - 1 94 | ) 95 | 96 | {:error, reason} -> 97 | Logger.debug("Generating extra pub key error: #{inspect(reason)}") 98 | {:error, reason} 99 | 100 | error -> 101 | Logger.error("Unknown error in gen pub key #{inspect(error)}") 102 | {:error, :unknown} 103 | end 104 | end 105 | 106 | defp do_generate_key_pair(_, _, _, _), do: {:error, :bad_args} 107 | 108 | @doc """ 109 | Encrypts a given binary with a keypair 110 | 111 | ## Parameters 112 | - kp: The KeyPair which holds the public key and ntru_params 113 | - data_bin: the binary to encrypt 114 | - ntru_params(optional): ntru params. if not provided the params in kp will 115 | be used 116 | 117 | Returns a tuple like `{:ok, encrypted_bin}` on success. 118 | """ 119 | @spec encrypt(KeyPair.t(), binary()) :: 120 | {:ok, binary()} 121 | | {:error, atom()} 122 | def encrypt(kp, data_bin, ntru_params) do 123 | case Base.encrypt(kp.pub_key, data_bin, ntru_params) do 124 | {:ok, enc_data} -> 125 | {:ok, enc_data} 126 | 127 | {:error, reason} -> 128 | Logger.debug("Encrypt failed: #{inspect(reason)}") 129 | {:error, reason} 130 | 131 | error -> 132 | Logger.error("Encrypt failed unknown error: #{inspect(error)}") 133 | {:error, :unknown} 134 | end 135 | end 136 | 137 | @doc "Bang version of `encrypt`" 138 | @spec encrypt!(KeyPair.t(), binary(), Base.ntru_params_t()) :: binary 139 | def encrypt!(kp, data_bin, ntru_params) do 140 | {:ok, enc_data} = encrypt(kp, data_bin, ntru_params) 141 | enc_data 142 | end 143 | 144 | @doc false 145 | @spec encrypt(KeyPair.t(), binary()) :: 146 | {:ok, binary()} 147 | | {:error, atom()} 148 | def encrypt(kp, data_bin), do: encrypt(kp, data_bin, kp.ntru_params) 149 | 150 | @doc false 151 | @spec encrypt!(KeyPair.t(), binary()) :: binary() 152 | def encrypt!(kp, data_bin) do 153 | {:ok, enc_data} = encrypt(kp, data_bin) 154 | enc_data 155 | end 156 | 157 | @doc """ 158 | Decrypts a given binary with a keypair 159 | 160 | Note that the KeyPair should contain the `priv_key` in order to decrypt! 161 | 162 | ## Parameters 163 | - kp: The KeyPair which holds the public key, private_key and ntru_params 164 | - enc_data: the binary to decry[t] 165 | - ntru_params(optional): ntru params. if not provided the params in kp will 166 | be used 167 | 168 | Returns a tuple like `{:ok, encrypted_bin}` on success. 169 | """ 170 | @spec decrypt(KeyPair.t(), binary(), Base.ntru_params_t()) :: 171 | {:ok, binary()} 172 | | {:error, atom()} 173 | def decrypt(kp, enc_data, ntru_params) do 174 | case kp do 175 | %{priv_key: nil} -> 176 | {:error, :no_private_key_in_pair} 177 | 178 | _ -> 179 | do_decrypt(kp, enc_data, ntru_params) 180 | end 181 | end 182 | 183 | @doc "Bang version of `decrypt`" 184 | @spec decrypt!(KeyPair.t(), binary(), Base.ntru_params_t()) :: binary() 185 | def decrypt!(kp, enc_data, ntru_params) do 186 | {:ok, dec_data} = decrypt(kp, enc_data, ntru_params) 187 | dec_data 188 | end 189 | 190 | @doc false 191 | @spec decrypt(KeyPair.t(), binary()) :: 192 | {:ok, binary()} 193 | | {:error, atom()} 194 | def decrypt(kp, enc_data) do 195 | decrypt(kp, enc_data, kp.ntru_params) 196 | end 197 | 198 | @doc false 199 | @spec decrypt!(KeyPair.t(), binary()) :: binary() 200 | def decrypt!(kp, enc_data) do 201 | decrypt!(kp, enc_data, kp.ntru_params) 202 | end 203 | 204 | defp do_decrypt(kp, enc_data, ntru_params) do 205 | case Base.decrypt(kp.pub_key, kp.priv_key, enc_data, ntru_params) do 206 | {:ok, dec_data} -> 207 | {:ok, dec_data} 208 | 209 | {:error, reason} -> 210 | Logger.debug("Decrypt failed: #{inspect(reason)}") 211 | {:error, reason} 212 | 213 | error -> 214 | Logger.error("Decrypt failed unknown error: #{inspect(error)}") 215 | {:error, :unknown} 216 | end 217 | end 218 | 219 | # 220 | # Helpers 221 | # 222 | 223 | defp get_key_pairs(priv_key, ntru_params, pub_keys, acc \\ []) 224 | 225 | defp get_key_pairs(priv_key, ntru_params, [pub_key | tail], acc), 226 | do: 227 | get_key_pairs(priv_key, ntru_params, tail, [ 228 | KeyPair.new!(pub_key, ntru_params, priv_key) | acc 229 | ]) 230 | 231 | defp get_key_pairs(_, _, [], acc), do: acc 232 | end 233 | -------------------------------------------------------------------------------- /lib/ntru_elixir/base.ex: -------------------------------------------------------------------------------- 1 | defmodule NtruElixir.Base do 2 | @moduledoc """ 3 | Base libntru NIF interface 4 | 5 | **It is NOT recommended to use this module directly.** 6 | 7 | You can use `NtruElixir` module which has better documentation and better api 8 | """ 9 | 10 | @on_load :load_nifs 11 | 12 | @typedoc """ 13 | These are NTRU parameters. It is recommended to Use one of: 14 | 15 | - `:NTRU_DEFAULT_PARAMS_112_BITS` 16 | - `:NTRU_DEFAULT_PARAMS_128_BITS` 17 | - `:NTRU_DEFAULT_PARAMS_192_BITS` 18 | - `:NTRU_DEFAULT_PARAMS_256_BITS` 19 | 20 | For more information please visit: 21 | [libntru - Parameter Sets](https://github.com/tbuktu/libntru#parameter-sets) 22 | """ 23 | @type ntru_params_t :: 24 | :EES401EP1 25 | | :EES541EP1 26 | | :EES659EP1 27 | | :NTRU_DEFAULT_PARAMS_112_BITS 28 | | :EES449EP1 29 | | :EES613EP1 30 | | :EES761EP1 31 | | :EES439EP1 32 | | :EES443EP1 33 | | :NTRU_DEFAULT_PARAMS_128_BITS 34 | | :EES677EP1 35 | | :EES887EP1 36 | | :EES1087EP1 37 | | :EES593EP1 38 | | :EES587EP1 39 | | :NTRU_DEFAULT_PARAMS_192_BITS 40 | | :EES1087EP2 41 | | :EES1171EP1 42 | | :EES1499EP1 43 | | :EES743EP1 44 | | :NTRU_DEFAULT_PARAMS_256_BITS 45 | 46 | @doc false 47 | def load_nifs do 48 | path = :filename.join(:code.priv_dir(:ntru_elixir), 'ntru_nif') 49 | :erlang.load_nif(path, 0) 50 | end 51 | 52 | @doc """ 53 | Generates a new key pair with public key and private key as binaries 54 | 55 | ## Parameters 56 | - ntru_params: NTRU parameters for key 57 | - rng: random number generator type (not implemented yet) 58 | 59 | Returns a tuple in format {:ok, pub_bin, priv_bin} on success. 60 | """ 61 | @spec gen_key_pair(ntru_params_t, atom()) :: 62 | {:ok, binary(), binary()} 63 | | {:error, :init_rand_fail} 64 | | {:error, :keygen_fail} 65 | | {:error, :release_rnd_fail} 66 | def gen_key_pair(ntru_params \\ :NTRU_DEFAULT_PARAMS_128_BITS, rng \\ :NTRU_RNG_DEFAULT) 67 | 68 | def gen_key_pair(_, _) do 69 | raise "Function gen_key_pair is not implemented!" 70 | end 71 | 72 | @doc """ 73 | Generates a new public key for a given private key 74 | 75 | ## Parameters 76 | - priv_key: Binary of the private key 77 | - ntru_params: NTRU parameters for key 78 | 79 | Returns a tuple in format `{:ok, pub_bin}` on success. 80 | """ 81 | @spec gen_pub_key(binary(), ntru_params_t) :: 82 | {:ok, binary()} 83 | | {:error, :init_rand_fail} 84 | | {:error, :pub_gen_fail} 85 | | {:error, :pub_alloc_fail} 86 | def gen_pub_key(priv_key, ntru_params \\ :NTRU_DEFAULT_PARAMS_128_BITS) 87 | 88 | def gen_pub_key(_, _) do 89 | raise "Function gen_pub_key is not imeplemented!" 90 | end 91 | 92 | @doc """ 93 | Generates a key pair with one private key and multiple public keys. 94 | 95 | ## Paramters 96 | - pub_count: Number of public keys to generate 97 | - ntru_params: NTRU parameters for key 98 | - rng: random number generator type (not implemented yet) 99 | 100 | Returns a tuple like `{:ok, [pub_key1, pub_key2], priv_key}` on success. 101 | """ 102 | @spec gen_key_pair_multi(Integer.t(), ntru_params_t, atom()) :: 103 | {:ok, List.t(), binary()} 104 | | {:error, :init_rand_fail} 105 | | {:error, :keygen_fail} 106 | | {:error, :release_rnd_fail} 107 | def gen_key_pair_multi( 108 | pub_count, 109 | ntru_params \\ :NTRU_DEFAULT_PARAMS_128_BITS, 110 | rng \\ :NTRU_RNG_DEFAULT 111 | ) 112 | 113 | def gen_key_pair_multi(_, _, _) do 114 | raise "Function gen_key_pair_multi is not implemented!" 115 | end 116 | 117 | @doc """ 118 | Encrypts a binary with public key and ntru_params. 119 | 120 | ## Parameters: 121 | - pub_key: The public key in binary format 122 | - data_bin: Binary of the data to encrypt 123 | - ntru_params: NTRU parameters for key 124 | 125 | Returns a tuple like `{:ok, enc_bin}` on success. 126 | """ 127 | @spec encrypt(binary(), binary(), ntru_params_t) :: 128 | {:ok, binary()} 129 | | {:error, :init_rand_fail} 130 | | {:error, :enc_fail} 131 | | {:error, :release_rnd_fail} 132 | def encrypt(pub_key, data_bin, ntru_params \\ :NTRU_DEFAULT_PARAMS_128_BITS) 133 | 134 | def encrypt(_, _, _) do 135 | raise "Function encrypt is not implemented!" 136 | end 137 | 138 | @doc """ 139 | Decrypts a binary with a given public_key and private_key 140 | 141 | ## Parameters 142 | - pub_key: The public key in binary format (should be same as encryption key) 143 | - priv_key: The private key in binary format 144 | - enc_bin: encrypted data as binary 145 | 146 | Returns a tuple like `{:ok, dec_bin}` on success. 147 | """ 148 | @spec decrypt(binary(), binary(), binary(), ntru_params_t) :: 149 | {:ok, binary()} 150 | | {:error, :init_rand_fail} 151 | | {:error, :dec_fail} 152 | | {:error, :release_rnd_fail} 153 | def decrypt(pub_key, priv_key, enc_bin, ntru_params \\ :NTRU_DEFAULT_PARAMS_128_BITS) 154 | 155 | def decrypt(_, _, _, _) do 156 | raise "Function decrypt is not implemented!" 157 | end 158 | end 159 | -------------------------------------------------------------------------------- /lib/ntru_elixir/key_pair.ex: -------------------------------------------------------------------------------- 1 | defmodule NtruElixir.KeyPair do 2 | @moduledoc """ 3 | KeyPair struct 4 | """ 5 | 6 | alias NtruElixir.Base 7 | 8 | @enforce_keys [:pub_key] 9 | 10 | defstruct [:pub_key, :priv_key, :ntru_params] 11 | 12 | @type t :: %__MODULE__{pub_key: binary(), priv_key: binary(), ntru_params: Base.ntru_params_t()} 13 | 14 | @doc """ 15 | Creates a new KeyPair struct with given public_key and private_key 16 | 17 | ## Parameters 18 | - pub_key: binary of public key 19 | - priv_key: binary of private key 20 | 21 | Returns a tuple like `{:ok, %KeyPair{...}}` on success. 22 | """ 23 | @spec new(binary(), Base.ntru_params_t(), binary()) :: 24 | {:ok, __MODULE__.t()} 25 | | {:error, :pub_key_type_error} 26 | | {:error, :bad_keys} 27 | def new(pub_key, ntru_params, priv_key \\ nil) 28 | 29 | def new(pub_key, ntru_params, priv_key) 30 | when is_binary(pub_key) and is_atom(ntru_params) do 31 | cond do 32 | is_nil(priv_key) or is_binary(priv_key) -> 33 | {:ok, 34 | %__MODULE__{ 35 | pub_key: pub_key, 36 | priv_key: priv_key, 37 | ntru_params: ntru_params 38 | }} 39 | 40 | true -> 41 | {:error, :bad_private_key} 42 | end 43 | end 44 | 45 | def new(pub_key, _ntru_params, _priv_key) when not is_binary(pub_key), 46 | do: {:error, :bad_public_key} 47 | 48 | def new(_, ntru_prams, _) when not is_atom(ntru_prams), do: {:error, :bad_ntru_params} 49 | 50 | def new(_, _, priv_key) when not is_binary(priv_key), do: {:error, :bad_private_key} 51 | 52 | def new!(pub_keys, ntru_params, priv_key) do 53 | {:ok, key_pair} = new(pub_keys, ntru_params, priv_key) 54 | key_pair 55 | end 56 | end 57 | -------------------------------------------------------------------------------- /mix.exs: -------------------------------------------------------------------------------- 1 | defmodule NtruElixir.Mixfile do 2 | use Mix.Project 3 | 4 | @version "0.0.0" 5 | 6 | @description """ 7 | libntru wrapper for elixir. NTRU is a post quantom cryptography algorithm. 8 | """ 9 | 10 | def project do 11 | [ 12 | app: :ntru_elixir, 13 | version: @version, 14 | elixir: "~> 1.3", 15 | description: @description, 16 | start_permanent: Mix.env() == :prod, 17 | compilers: [:elixir_make] ++ Mix.compilers(), 18 | deps: deps(), 19 | package: package(), 20 | preferred_cli_env: [ 21 | coveralls: :test, 22 | "coveralls.detail": :test, 23 | "coveralls.post": :test, 24 | "coveralls.html": :test 25 | ], 26 | test_coverage: [tool: ExCoveralls] 27 | ] 28 | end 29 | 30 | # Run "mix help compile.app" to learn about applications. 31 | def application do 32 | [ 33 | extra_applications: [:logger] 34 | ] 35 | end 36 | 37 | # Run "mix help deps" to learn about dependencies. 38 | defp deps do 39 | [ 40 | {:elixir_make, "~> 0.4", runtime: false}, 41 | {:ex_doc, "~> 0.18.1", runtime: false}, 42 | {:excoveralls, ">= 0.0.0 ", only: :test} 43 | ] 44 | end 45 | 46 | defp package() do 47 | [ 48 | # This option is only needed when you don't want to use the OTP application name 49 | name: "ntru_elixir", 50 | # These are the default files included in the package 51 | files: ["lib", "c_src", "mix.exs", "README*", "LICENSE*", "libntru", "Makefile"], 52 | maintainers: ["alisinabh"], 53 | licenses: ["GNU GPLv3"], 54 | links: %{"GitHub" => "https://github.com/alisinabh/ntru_elixir"} 55 | ] 56 | end 57 | end 58 | -------------------------------------------------------------------------------- /mix.lock: -------------------------------------------------------------------------------- 1 | %{"certifi": {:hex, :certifi, "2.0.0", "a0c0e475107135f76b8c1d5bc7efb33cd3815cb3cf3dea7aefdd174dabead064", [], [], "hexpm"}, 2 | "earmark": {:hex, :earmark, "1.2.4", "99b637c62a4d65a20a9fb674b8cffb8baa771c04605a80c911c4418c69b75439", [], [], "hexpm"}, 3 | "elixir_make": {:hex, :elixir_make, "0.4.0", "992f38fabe705bb45821a728f20914c554b276838433349d4f2341f7a687cddf", [], [], "hexpm"}, 4 | "ex_doc": {:hex, :ex_doc, "0.18.1", "37c69d2ef62f24928c1f4fdc7c724ea04aecfdf500c4329185f8e3649c915baf", [], [{:earmark, "~> 1.1", [hex: :earmark, repo: "hexpm", optional: false]}], "hexpm"}, 5 | "excoveralls": {:hex, :excoveralls, "0.7.5", "339e433e5d3bce09400dc8de7b9040741a409c93917849916c136a0f51fdc183", [], [{:exjsx, ">= 3.0.0", [hex: :exjsx, repo: "hexpm", optional: false]}, {:hackney, ">= 0.12.0", [hex: :hackney, repo: "hexpm", optional: false]}], "hexpm"}, 6 | "exjsx": {:hex, :exjsx, "4.0.0", "60548841e0212df401e38e63c0078ec57b33e7ea49b032c796ccad8cde794b5c", [], [{:jsx, "~> 2.8.0", [hex: :jsx, repo: "hexpm", optional: false]}], "hexpm"}, 7 | "hackney": {:hex, :hackney, "1.10.1", "c38d0ca52ea80254936a32c45bb7eb414e7a96a521b4ce76d00a69753b157f21", [], [{:certifi, "2.0.0", [hex: :certifi, repo: "hexpm", optional: false]}, {:idna, "5.1.0", [hex: :idna, repo: "hexpm", optional: false]}, {:metrics, "1.0.1", [hex: :metrics, repo: "hexpm", optional: false]}, {:mimerl, "1.0.2", [hex: :mimerl, repo: "hexpm", optional: false]}, {:ssl_verify_fun, "1.1.1", [hex: :ssl_verify_fun, repo: "hexpm", optional: false]}], "hexpm"}, 8 | "idna": {:hex, :idna, "5.1.0", "d72b4effeb324ad5da3cab1767cb16b17939004e789d8c0ad5b70f3cea20c89a", [], [{:unicode_util_compat, "0.3.1", [hex: :unicode_util_compat, repo: "hexpm", optional: false]}], "hexpm"}, 9 | "jsx": {:hex, :jsx, "2.8.3", "a05252d381885240744d955fbe3cf810504eb2567164824e19303ea59eef62cf", [], [], "hexpm"}, 10 | "metrics": {:hex, :metrics, "1.0.1", "25f094dea2cda98213cecc3aeff09e940299d950904393b2a29d191c346a8486", [], [], "hexpm"}, 11 | "mimerl": {:hex, :mimerl, "1.0.2", "993f9b0e084083405ed8252b99460c4f0563e41729ab42d9074fd5e52439be88", [], [], "hexpm"}, 12 | "ssl_verify_fun": {:hex, :ssl_verify_fun, "1.1.1", "28a4d65b7f59893bc2c7de786dec1e1555bd742d336043fe644ae956c3497fbe", [], [], "hexpm"}, 13 | "unicode_util_compat": {:hex, :unicode_util_compat, "0.3.1", "a1f612a7b512638634a603c8f401892afbf99b8ce93a45041f8aaca99cadb85e", [], [], "hexpm"}} 14 | -------------------------------------------------------------------------------- /test/ntru_elixir_base_test.exs: -------------------------------------------------------------------------------- 1 | defmodule NtruElixirTest.BaseTest do 2 | use ExUnit.Case 3 | 4 | alias NtruElixir.Base, as: NtruBase 5 | 6 | require Logger 7 | 8 | @all_ntru_params [ 9 | :EES401EP1, 10 | :EES541EP1, 11 | :EES659EP1, 12 | :NTRU_DEFAULT_PARAMS_112_BITS, 13 | :EES449EP1, 14 | :EES613EP1, 15 | :EES761EP1, 16 | :EES439EP1, 17 | :EES443EP1, 18 | :NTRU_DEFAULT_PARAMS_128_BITS, 19 | :EES677EP1, 20 | :EES887EP1, 21 | :EES1087EP1, 22 | :EES593EP1, 23 | :EES587EP1, 24 | :NTRU_DEFAULT_PARAMS_192_BITS, 25 | :EES1087EP2, 26 | :EES1171EP1, 27 | :EES1499EP1, 28 | :EES743EP1, 29 | :NTRU_DEFAULT_PARAMS_256_BITS 30 | ] 31 | 32 | @sample_input "This is a message from alice to bob." 33 | 34 | test "create a new keypair" do 35 | assert :ok = test_gen_keypair(@all_ntru_params) 36 | end 37 | 38 | test "generate a new pub key for a given private key" do 39 | assert :ok = test_gen_pub_key(@all_ntru_params) 40 | end 41 | 42 | test "create a milti pub_key key pair" do 43 | assert :ok = test_gen_multi_pub_pair(@all_ntru_params) 44 | end 45 | 46 | test "a successful encryption" do 47 | assert :ok = test_success_encryption(@all_ntru_params) 48 | end 49 | 50 | test "default ntru params" do 51 | assert {:ok, pub_key, priv_key} = NtruBase.gen_key_pair() 52 | assert {:ok, pub_key} = NtruBase.gen_pub_key(priv_key) 53 | assert {:ok, pub_keys, _priv_key} = NtruBase.gen_key_pair_multi(10) 54 | assert {:ok, enc_bin} = NtruBase.encrypt(pub_key, "test data") 55 | assert {:ok, "test data"} = NtruBase.decrypt(pub_key, priv_key, enc_bin) 56 | end 57 | 58 | defp test_success_encryption([ntru_params | tail]) do 59 | {:ok, pub_key, priv_key} = NtruBase.gen_key_pair(ntru_params) 60 | {:ok, enc_bin} = NtruBase.encrypt(pub_key, @sample_input, ntru_params) 61 | dec_result = NtruBase.decrypt(pub_key, priv_key, enc_bin, ntru_params) 62 | 63 | case dec_result do 64 | {:ok, @sample_input} -> 65 | test_success_encryption(tail) 66 | 67 | {:ok, other_bin} -> 68 | Logger.error( 69 | "Decryption of '#{@sample_input}' resulted in wrong" <> " decryption '#{other_bin}'" 70 | ) 71 | 72 | {:error, :wrong_decryption} 73 | 74 | {:error, reason} -> 75 | {:error, reason} 76 | 77 | error -> 78 | {:error, inspect(error)} 79 | end 80 | end 81 | 82 | defp test_success_encryption([]), do: :ok 83 | 84 | defp test_gen_multi_pub_pair([ntru_params | tail]) do 85 | pub_count = Enum.random(1..15) 86 | {:ok, pub_keys, _priv_key} = NtruElixir.Base.gen_key_pair_multi(pub_count, ntru_params) 87 | 88 | case Enum.count(pub_keys) do 89 | ^pub_count when is_list(pub_keys) -> 90 | test_gen_multi_pub_pair(tail) 91 | 92 | count -> 93 | {:error, :wrong_key_count} 94 | end 95 | end 96 | 97 | defp test_gen_multi_pub_pair([]), do: :ok 98 | 99 | defp test_gen_pub_key([ntru_params | tail]) do 100 | {:ok, pub, priv} = NtruBase.gen_key_pair(ntru_params) 101 | 102 | case NtruBase.gen_pub_key(priv, ntru_params) do 103 | {:ok, new_pub} -> 104 | if new_pub == pub do 105 | {:error, :same_key} 106 | else 107 | test_gen_pub_key(tail) 108 | end 109 | 110 | {:error, reason} -> 111 | {:error, reason} 112 | 113 | error -> 114 | {:error, inspect(error)} 115 | end 116 | end 117 | 118 | defp test_gen_pub_key([]), do: :ok 119 | 120 | defp test_gen_keypair([ntru_params | tail]) do 121 | case NtruBase.gen_key_pair(ntru_params) do 122 | {:ok, _key, _priv_key} -> 123 | test_gen_keypair(tail) 124 | 125 | {:error, reason} -> 126 | {:error, reason} 127 | 128 | error -> 129 | {:error, inspect(error)} 130 | end 131 | end 132 | 133 | defp test_gen_keypair([]), do: :ok 134 | end 135 | -------------------------------------------------------------------------------- /test/ntru_elixir_keypair_test.exs: -------------------------------------------------------------------------------- 1 | defmodule NtruElixirTest.KeyPairTest do 2 | use ExUnit.Case 3 | doctest NtruElixir.KeyPair 4 | 5 | alias NtruElixir.KeyPair 6 | 7 | test "All paramteres sent to key pair are added to it" do 8 | pub_key = "public_key_test" 9 | priv_key = "private_key_test" 10 | ntru_params = :EES593EP1 11 | assert {:ok, key} = KeyPair.new(pub_key, ntru_params, priv_key) 12 | assert %{pub_key: ^pub_key, priv_key: ^priv_key, ntru_params: ^ntru_params} = key 13 | end 14 | 15 | test "Add a private key less key" do 16 | pub_key = "public_key_test" 17 | ntru_params = :EES593EP1 18 | assert {:ok, key} = KeyPair.new(pub_key, ntru_params) 19 | assert %{pub_key: ^pub_key, priv_key: nil, ntru_params: ^ntru_params} = key 20 | end 21 | 22 | test "Only binary public key is accepted" do 23 | pub_key = ["public_key_test"] 24 | priv_key = "private_key_test" 25 | ntru_params = :EES593EP1 26 | assert {:error, :bad_public_key} = KeyPair.new(pub_key, ntru_params, priv_key) 27 | end 28 | 29 | test "Only binary private key is accepted" do 30 | pub_key = "public_key_test" 31 | priv_key = 1234 32 | ntru_params = :EES593EP1 33 | assert {:error, :bad_private_key} = KeyPair.new(pub_key, ntru_params, priv_key) 34 | end 35 | 36 | test "Ntru params filteration" do 37 | pub_key = "public_key_test" 38 | priv_key = "priv_key_test" 39 | ntru_params = "junk" 40 | assert {:error, :bad_ntru_params} = KeyPair.new(pub_key, ntru_params, priv_key) 41 | end 42 | end 43 | -------------------------------------------------------------------------------- /test/ntru_elixir_test.exs: -------------------------------------------------------------------------------- 1 | defmodule NtruElixirTest do 2 | use ExUnit.Case 3 | doctest NtruElixir 4 | 5 | alias NtruElixir.KeyPair 6 | 7 | setup_all do 8 | {:ok, [kp1, kp2]} = NtruElixir.generate_key_pair(2) 9 | {:ok, keys: %{key1: kp1, key2: kp2}} 10 | end 11 | 12 | test "greets the world" do 13 | assert 1 == 1 14 | end 15 | 16 | test "Single KeyPair generation" do 17 | assert {:ok, [%KeyPair{}]} = NtruElixir.generate_key_pair() 18 | end 19 | 20 | test "Multi pub KeyPair generation" do 21 | pub_count = Enum.random(2..10) 22 | assert {:ok, keys} = NtruElixir.generate_key_pair(pub_count) 23 | assert Enum.count(keys) == pub_count 24 | end 25 | 26 | test "Encryption and decryption", state do 27 | bin = "test binary" 28 | assert {:ok, enc_data} = NtruElixir.encrypt(state.keys.key1, bin) 29 | assert is_binary(enc_data) 30 | 31 | refute bin == enc_data 32 | 33 | assert {:ok, dec_data} = NtruElixir.decrypt(state.keys.key1, enc_data) 34 | 35 | assert dec_data == bin 36 | end 37 | 38 | test "Decryption only with key pair", state do 39 | bin = "test binary" 40 | assert {:ok, enc_data} = NtruElixir.encrypt(state.keys.key1, bin) 41 | assert is_binary(enc_data) 42 | 43 | assert bin != enc_data 44 | 45 | assert {:error, :dec_fail} = NtruElixir.decrypt(state.keys.key2, enc_data) 46 | end 47 | 48 | test "encrypt! and decrypt! functions", state do 49 | bin = "test binary" 50 | enc_data = NtruElixir.encrypt!(state.keys.key1, bin) 51 | 52 | assert is_binary(enc_data) 53 | 54 | assert ^bin = NtruElixir.decrypt!(state.keys.key1, enc_data) 55 | 56 | enc_data = NtruElixir.encrypt!(state.keys.key1, bin, :NTRU_DEFAULT_PARAMS_128_BITS) 57 | 58 | assert is_binary(enc_data) 59 | 60 | assert ^bin = NtruElixir.decrypt!(state.keys.key1, enc_data, :NTRU_DEFAULT_PARAMS_128_BITS) 61 | end 62 | end 63 | -------------------------------------------------------------------------------- /test/test_helper.exs: -------------------------------------------------------------------------------- 1 | ExUnit.start() 2 | --------------------------------------------------------------------------------