commit 40aa7afd3ea3a569f799d86653578b56ea50e5f3 Author: Bauke Date: Sat Sep 4 13:44:28 2021 +0200 Initial commit! 🌠 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..088ba6b --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +# Generated by Cargo +# will have compiled files and executables +/target/ + +# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries +# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html +Cargo.lock + +# These are backup files generated by rustfmt +**/*.rs.bk diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..365dccf --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,19 @@ +# https://doc.rust-lang.org/cargo/reference/manifest.html + +[package] +name = "web-ext-native-messaging" +description = "WebExtension native messaging with serde_json as the (de)serializer." +version = "0.1.0" +authors = ["Holllo "] +license = "MIT OR Apache-2.0" +repository = "https://github.com/Holllo/web-ext-native-messaging" +edition = "2018" + +[lib] +path = "source/lib.rs" + +[dependencies] +byteorder = "1.4.3" +serde = { version = "1.0", features = ["derive"] } +serde_json = "1.0" +thiserror = "1.0" diff --git a/LICENSE-Apache b/LICENSE-Apache new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE-Apache @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://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 + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..34f7121 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 Holllo + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..074fa43 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# web-ext-native-messaging + +WebExtension native messaging with serde_json as the (de)serializer. + +## Documentation + +See [docs.rs](https://docs.rs/web-ext-native-messaging) for documentation. + +## License + +Licensed under either of + +- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or https://www.apache.org/licenses/LICENSE-2.0) +- MIT license ([LICENSE-MIT](LICENSE-MIT) or https://opensource.org/licenses/MIT) + +at your option. + +#### Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in the work by you, as defined in the Apache-2.0 license, shall be +dual licensed as above, without any additional terms or conditions. diff --git a/rustfmt.toml b/rustfmt.toml new file mode 100644 index 0000000..4c1eefa --- /dev/null +++ b/rustfmt.toml @@ -0,0 +1,2 @@ +max_width = 80 +tab_spaces = 2 diff --git a/source/lib.rs b/source/lib.rs new file mode 100644 index 0000000..738c074 --- /dev/null +++ b/source/lib.rs @@ -0,0 +1,167 @@ +#![forbid(unsafe_code)] +#![warn(missing_docs, clippy::missing_docs_in_private_items)] + +//! # web-ext-native-messaging +//! +//! WebExtension [native messaging] with [`serde_json`] as the (de)serializer. +//! +//! [native messaging]: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Native_messaging#app_side +//! +//! ## Reading +//! +//! In your web extension: +//! +//! ```js +//! const port = browser.runtime.connectNative('native executable'); +//! +//! port.postMessage('Hey, there!'); +//! ``` +//! +//! Then in your native executable: +//! +//! ```rust,no_run +//! use web_ext_native_messaging::read_message; +//! +//! let message = read_message::().unwrap(); +//! println!("{}", message); +//! ``` +//! +//! ## Writing +//! +//! In your web extension: +//! +//! ```js +//! const port = browser.runtime.connectNative('native executable'); +//! +//! port.onMessage.addListener((message) => { +//! console.log(message); +//! }); +//! ``` +//! +//! Then in your native executable: +//! +//! ```rust,no_run +//! use web_ext_native_messaging::write_message; +//! +//! let message = "Hey, there!".to_string(); +//! write_message(&message).unwrap(); +//! ``` +//! +//! See the [native messaging documentation] for precise instructions on how to +//! send and receive messages. +//! +//! [native messaging documentation]: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Native_messaging + +use std::{ + convert::TryInto, + io::{Read, Write}, +}; + +use byteorder::{NativeEndian, ReadBytesExt, WriteBytesExt}; + +/// All possible errors that can happen with reading or writing messages. +#[derive(Debug, thiserror::Error)] +pub enum MessagingError { + /// Infallible errors. + #[error(transparent)] + Infallible(#[from] std::convert::Infallible), + #[error(transparent)] + /// IO errors. + Io(#[from] std::io::Error), + #[error(transparent)] + /// JSON (de)serialization errors. + Json(#[from] serde_json::Error), + /// Integer parsing errors. + #[error(transparent)] + TryFromInt(#[from] std::num::TryFromIntError), +} + +/// Read message function with a generic [`Read`]er so that we can test it +/// without having to actually use standard in/out. +pub(crate) fn generic_read_message( + mut reader: R, +) -> Result +where + D: for<'a> serde::Deserialize<'a>, + R: Read, +{ + let message_length = reader.read_u32::()?.try_into()?; + let message_bytes = reader.take(message_length); + + serde_json::from_reader(message_bytes).map_err(Into::into) +} + +/// Attempts to read a message from the program's stdin in the +/// [native messaging] format. +/// +/// [native messaging]: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Native_messaging#app_side +pub fn read_message() -> Result +where + D: for<'a> serde::Deserialize<'a>, +{ + let stdin = std::io::stdin(); + let stdin = stdin.lock(); + generic_read_message(stdin) +} + +/// Write message function with a generic [`Write`]r so that we can test it +/// without having to actually use standard in/out. +pub(crate) fn generic_write_message( + message: &S, + mut writer: W, +) -> Result<(), MessagingError> +where + S: serde::Serialize, + W: Write, +{ + let message_bytes = serde_json::to_vec(message)?; + let message_length = message_bytes.len().try_into()?; + + writer.write_u32::(message_length)?; + writer.write_all(&message_bytes)?; + writer.flush().map_err(MessagingError::Io) +} + +/// Attempts to write a message to the program's stdout in the +/// [native messaging] format. +/// +/// [native messaging]: https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Native_messaging#app_side +pub fn write_message(message: &S) -> Result<(), MessagingError> +where + S: serde::Serialize, +{ + let stdout = std::io::stdout(); + let stdout = stdout.lock(); + generic_write_message(message, stdout) +} + +#[cfg(test)] +pub(crate) mod tests { + use crate::{generic_read_message, generic_write_message, MessagingError}; + + #[derive(Debug, serde::Deserialize, serde::Serialize, PartialEq)] + struct Message { + text: String, + } + + #[test] + fn test_messaging() -> Result<(), MessagingError> { + let test_message = Message { + text: "This is a test".to_string(), + }; + + // Create a buffer that will act as both the reader and writer + // (i.e. stdin and stdout). + let mut buffer: Vec = vec![]; + + // Write the message to the buffer. + generic_write_message(&test_message, &mut buffer)?; + + // Then read the message, we get `std::io::Read` by dereferencing the + // `Vec` to `&[u8]`. + let message = generic_read_message::(&*buffer)?; + + assert_eq!(message, test_message); + Ok(()) + } +}