UNPKG

2.71 kBMarkdownView Raw
1Jodid25519 [![Build Status](https://secure.travis-ci.org/meganz/jodid25519.png)](https://travis-ci.org/meganz/jodid25519)
2===================================================================================================================================
3
4Javascript implementation of the Curve25519 and Ed25519 elliptic cryptography functions by Daniel J. Bernstein.
5
6For the API, please consult the generated documentation under doc/ (you can run `make` to generate it).
7
8To run the tests do the following on the console from the project's root directory:
9
10 $ npm install
11 $ make test
12
13
14Contributors
15------------
16
17If you are one of the contributors and want to add yourself or change the information here, please do submit a pull request. Contributors appear in no particular order.
18
19### For the Curve25519 submodule
20
21* [Graydon Hoare](https://github.com/graydon): suggested clamping the private key by default for increased safety and uniformity with other implementations.
22* [liliakai](https://github.com/liliakai): spotted an unused argument in some of the functions
23* [RyanC](https://github.com/ryancdotorg): removed dependency of a function to the Javascript Math library
24* [Guy Kloss](https://github.com/pohutukawa): performance improvements through bit-shift operations, performance and conformance testing, documentation, compatibility with the npm package ecosystem, and more
25* [Michele Bini](https://github.com/rev22): originally wrote the Javascript implementation
26
27
28Copyright and MIT licensing
29---------------------------
30
31* Copyright (c) 2012 Ron Garret
32* Copyright (c) 2007, 2013, 2014 Michele Bini <michele.bini@gmail.com>
33* Copyright (c) 2014 Mega Limited
34
35Permission is hereby granted, free of charge, to any person obtaining a copy
36of this software and associated documentation files (the "Software"), to deal
37in the Software without restriction, including without limitation the rights
38to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
39copies of the Software, and to permit persons to whom the Software is furnished
40to do so, subject to the following conditions:
41
42The above copyright notice and this permission notice shall be included in all
43copies or substantial portions of the Software.
44
45THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
46IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
47FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
48AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
49LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
50OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
51THE SOFTWARE.