diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..b89a17b --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + https://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS \ No newline at end of file diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..bfb1305 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Experimental-Projects-NAS + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index 927a699..c4556a2 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,176 @@ This project was bootstrapped by [create-neon](https://www.npmjs.com/package/create-neon). +## Table of Contents +* [NPM usage](#npm-usage) + + [Installation](#installation) + + [From ed25519 private key to x25519](#from-ed25519-private-key-to-x25519) + + [From ed25519 public key to x25519](#from-ed25519-public-key-to-x25519) + + [Encrypt and decrypt data using ed25519 keys](#encrypt-and-decrypt-data-using-ed25519-keys) +* [Cargo usage](#cargo-usage) + + [Installation](#installation-1) + + [From ed25519 private key to x25519](#from-ed25519-private-key-to-x25519-1) + + [From ed25519 public key to x25519](#from-ed25519-public-key-to-x25519-1) + + [Encrypt and decrypt data using ed25519 keys](#encrypt-and-decrypt-data-using-ed25519-keys-1) +* [Building ed25519_enc](#building-ed25519_enc) +* [Exploring ed25519_enc](#exploring-ed25519_enc) +* [Available Scripts](#available-scripts) + - [`npm run build`](#npm-run-build) + - [`npm run debug`](#npm-run-debug) + - [`npm run cross`](#npm-run-cross) + - [`npm run release`](#npm-run-release) + - [`npm run dryrun`](#npm-run-dryrun) + - [`npm test`](#npm-test) +* [Project Layout](#project-layout) +* [Learn More](#learn-more) +* [LICENSE](#license) + +Table of contents generated with markdown-toc + +## NPM usage + +### Installation +```sh +npm i ed25519_enc +``` + +### From ed25519 private key to x25519 +```js +import { to_x25519_priv } from "ed25519_enc"; +... +const ed25519_priv = Buffer.from( + "D12549B4AE46086002E4110B1F94D0BA942C2967AA83D3003590FD7A5087C6A8", + "hex" +); +const x25519_priv = to_x25519_priv(ed25519_priv); +``` + +### From ed25519 public key to x25519 +```js +import { to_x25519_pub } from "ed25519_enc"; +... +const ed25519_pub = Buffer.from( + "B68F106DAA004E7AE715C5159E1C27CB864EED20D3ACB332BD6F87E89226E925", + "hex" +); +const x25519_pub = to_x25519_pub(ed25519_pub); +``` + +### Encrypt and decrypt data using ed25519 keys +```js +import { encrypt } from "ed25519_enc"; +... +const sender_priv = Buffer.from( + "D12549B4AE46086002E4110B1F94D0BA942C2967AA83D3003590FD7A5087C6A8", + "hex" +); +const sender_pub = Buffer.from( + "B68F106DAA004E7AE715C5159E1C27CB864EED20D3ACB332BD6F87E89226E925", + "hex" +); +const receiver_priv = Buffer.from( + "3C659C3FD72E56861C81C1684C5C342958645E2C459A11A2282B46161E47BF2E", + "hex" +); +const receiver_pub = Buffer.from( + "C02ABDA285014F207D5D31219E0F5647484F6DFF09E595DF38BDBDB07CE6E1B2", + "hex" +); +const data = Buffer.from("Hello world!"); +const encrypted_data = encrypt(sender_priv, receiver_pub, data); +const decrypted_data = decrypt(receiver_priv, sender_pub, encrypted_data); + +console.log("Decrypted data: ", new TextDecoder().decode(dec_data)); +// Decrypted data: Hello World! +``` + +## Cargo usage +### Installation +```sh +cargo add ed25519_enc +``` + +### From ed25519 private key to x25519 + +```rust +use ed25519_enc::{to_x25519_priv}; +... +let ed25519_priv: [u8; 32] = [ + 157, 097, 177, 157, 239, 253, 090, 096, + 186, 132, 074, 244, 146, 236, 044, 196, + 068, 073, 197, 105, 123, 050, 105, 025, + 112, 059, 172, 003, 028, 174, 127, 096, +]; +let x25519_priv: [u8; 32] = to_x25519_priv(ed25519_priv); +``` + +### From ed25519 public key to x25519 + +```rust +use ed25519_enc::{to_x25519_pub}; +... +let ed25519_pub: [u8; 32] = [ + 215, 090, 152, 001, 130, 177, 010, 183, + 213, 075, 254, 211, 201, 100, 007, 058, + 014, 225, 114, 243, 218, 166, 035, 037, + 175, 002, 026, 104, 247, 007, 081, 026, +]; +let x25519_pub: [u8; 32] = to_x25519_pub(ed25519_pub); +``` + +### Encrypt and decrypt data using ed25519 keys + +```rust +use ed25519_enc::{encrypt, decrypt} + +... + +let sender_ed25519_priv: [u8; 32] = [ + 157, 097, 177, 157, 239, 253, 090, 096, + 186, 132, 074, 244, 146, 236, 044, 196, + 068, 073, 197, 105, 123, 050, 105, 025, + 112, 059, 172, 003, 028, 174, 127, 096, +]; + +let sender_ed25519_pub: [u8; 32] = [ + 215, 090, 152, 001, 130, 177, 010, 183, + 213, 075, 254, 211, 201, 100, 007, 058, + 014, 225, 114, 243, 218, 166, 035, 037, + 175, 002, 026, 104, 247, 007, 081, 026, +]; + +let receiver_ed25519_priv: [u8; 32] = [ + 074, 032, 095, 005, 083, 039, 001, 050, + 066, 088, 090, 056, 021, 011, 031, 011, + 087, 068, 033, 014, 025, 028, 010, 043, + 024, 066, 058, 076, 030, 074, 017, 076, +]; + +let receiver_ed25519_pub: [u8; 32] = [ + 204, 095, 038, 061, 080, 055, 143, 219, + 253, 138, 015, 190, 145, 041, 028, 081, + 001, 004, 227, 080, 197, 078, 000, 043, + 160, 130, 158, 047, 197, 058, 228, 232 +]; + +let data: &[u8] = b"Hello world!"; + +let enc_msg: Vec = encrypt( + sender_ed25519_priv, + receiver_ed25519_pub, + data +); + +let dec_data: Vec = decrypt( + receiver_ed25519_priv, + sender_ed25519_pub, + &enc_msg +); + +println!("{:?}", dec_data); // should prints "Hello world!" +``` + + ## Building ed25519_enc Building ed25519_enc requires a [supported version of Node and Rust](https://github.com/neon-bindings/neon#platform-support). @@ -119,3 +289,7 @@ Learn more about: - [Neon](https://neon-bindings.com). - [Rust](https://www.rust-lang.org). - [Node](https://nodejs.org). + +## LICENSE + +[MIT](LICENSE-MIT) or [Apache License 2.0](LICENSE-APACHE) (at your option). \ No newline at end of file