From da81e438252be3a251a34bbb8e2b48b2a5a3d6d4 Mon Sep 17 00:00:00 2001 From: owenthewizard Date: Wed, 4 Dec 2024 23:42:46 -0600 Subject: [PATCH] Update to 0.1.1 Some internals are now `const`. --- CHANGELOG.md | 10 +++ Cargo.toml | 4 +- LICENSE-APACHE.md | 195 ++++++++++++++++++++++++++++++++++++++++++++++ LICENSE-MIT.md | 26 +++++++ README.md | 4 +- src/lib.rs | 82 ++++++++++++++----- 6 files changed, 295 insertions(+), 26 deletions(-) create mode 100644 LICENSE-APACHE.md create mode 100644 LICENSE-MIT.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 21c79e7..4ed3301 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). +## [0.1.1] - 2024-12-04 + +### Changed + +- Internal `Uts64` instance is now `const`. +- Use idna's upstream implementation for `idna_is_punycode`. +- `idna_is_punycode` is now `const`. + ## [0.1.0] - 2024-11-13 + ### Added + - Initial Release diff --git a/Cargo.toml b/Cargo.toml index ca28521..a2225c4 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,9 +1,9 @@ [package] name = "pg_idna" -version = "0.1.0" +version = "0.1.1" authors = ["Owen Walpole "] edition = "2021" -description = "WHATWG URL IDNA helpers for PostgreSQL" +description = "IDNA helpers for PostgreSQL" # TODO documentation = "https://docs.rs/pg_idna" readme = "README.md" diff --git a/LICENSE-APACHE.md b/LICENSE-APACHE.md new file mode 100644 index 0000000..f5f4b8b --- /dev/null +++ b/LICENSE-APACHE.md @@ -0,0 +1,195 @@ +Apache License +============== + +_Version 2.0, January 2004_ +_<>_ + +### 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.md b/LICENSE-MIT.md new file mode 100644 index 0000000..f31168b --- /dev/null +++ b/LICENSE-MIT.md @@ -0,0 +1,26 @@ +The MIT License (MIT) +===================== + +Copyright © 2024 Owen Walpole + +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 index 2ca1b72..dd8cc1a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # 🌐 pg_idna -[WHATWG URL IDNA](https://url.spec.whatwg.org/#idna) helpers for PostgreSQL. +[IDNA](https://crates.io/crates/idna) helpers for PostgreSQL. [![Rust](https://img.shields.io/badge/Language-Rust-blue?style=flat-square)](https://www.rust-lang.org) [![Build Status](https://github.com/owenthewizard/pg_idna/actions/workflows/rust_ci.yml/badge.svg?style=flat-square)](https://github.com/owenthewizard/pg_idna/actions) @@ -69,6 +69,4 @@ See LICENSE-APACHE and LICENSE-MIT for details. ## 🫶 Acknowledgements - [rust-url/idna](https://crates.io/crates/idna) by [The Servo Project Developers](https://servo.org/) - - `ToAscii` and `ToUnicode` implementation - [pgrx](https://crates.io/crates/pgrx) by Various Authors - - Create PostgreSQL extensions in Rust, in minutes. diff --git a/src/lib.rs b/src/lib.rs index a870f18..0b85303 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,4 +1,4 @@ -//! [WHATWG URL IDNA](https://url.spec.whatwg.org/#idna) helpers for `PostgreSQL`. +//! [IDNA](https://crates.io/crates/idna) helpers for `PostgreSQL`. use std::str::FromStr; @@ -10,16 +10,56 @@ use my_config::{MyAsciiDenyList, MyDnsLength, MyHyphens}; ::pgrx::pg_module_magic!(); +const UTS46: Uts46 = Uts46::new(); + /// Checks if `input` is ASCII. #[pg_extern] -const fn idna_is_ascii(input: &str) -> bool { +#[must_use] +pub const fn idna_is_ascii(input: &str) -> bool { input.is_ascii() } +/// Copyright (c) 2013-2022 The rust-url developers +/// +/// This code was copied from [rust-url](https://crates.io/crates/url) +/// and is used under the terms of the +/// [MIT license](https://github.com/servo/rust-url/blob/main/LICENSE-MIT). +const PUNYCODE_PREFIX: u32 = + ((b'-' as u32) << 24) | ((b'-' as u32) << 16) | ((b'N' as u32) << 8) | b'X' as u32; + +/// Copyright (c) 2013-2022 The rust-url developers +/// +/// This code was copied from [rust-url](https://crates.io/crates/url) +/// and is used under the terms of the +/// [MIT license](https://github.com/servo/rust-url/blob/main/LICENSE-MIT). +const PUNYCODE_PREFIX_MASK: u32 = (0xFF << 24) | (0xFF << 16) | (0xDF << 8) | 0xDF; + /// Checks if `input` is Punycode. +/// +/// This is merely a hint, as it only checks for the `xn--` prefix. +/// Thus, invalid punycode, or even non-ASCII, could return `true`. +/// +/// Copyright (c) 2013-2022 The rust-url developers +/// +/// This code was copied from [rust-url](https://crates.io/crates/url) +/// and is used under the terms of the +/// [MIT license](https://github.com/servo/rust-url/blob/main/LICENSE-MIT). #[pg_extern] -fn idna_is_punycode(input: &str) -> bool { - input.starts_with("xn--") +#[must_use] +#[allow(clippy::many_single_char_names)] +pub const fn idna_is_punycode(slice: &[u8]) -> bool { + if slice.len() < 4 { + return false; + } + // Sadly, the optimizer doesn't figure out that more idiomatic code + // should compile to masking on 32-bit value. + let a = slice[0]; + let b = slice[1]; + let c = slice[2]; + let d = slice[3]; + // `as` instead of From for `const` + let u = ((d as u32) << 24) | ((c as u32) << 16) | ((b as u32) << 8) | (a as u32); + (u & PUNYCODE_PREFIX_MASK) == PUNYCODE_PREFIX } /// Encodes `input` as ASCII Punycode. @@ -37,20 +77,20 @@ fn idna_is_punycode(input: &str) -> bool { /// - If unspecified, the default [`Hyphens`](idna::uts46::Hyphens) is [`Allow`](idna::uts46::Hyphens::Allow). /// - If unspecified, the default [`DnsLength`](idna::uts46::DnsLength) is [`Verify`](idna::uts46::DnsLength::Verify). /// -/// For more information, see [Uts46::to_ascii]. +/// For more information, see [`Uts46::to_ascii`]. #[pg_extern] -fn idna_to_ascii( +#[must_use] +pub fn idna_to_ascii( input: &str, adl: default!(&str, "'url'"), h: default!(&str, "'allow'"), dl: default!(&str, "'verify'"), ) -> String { - let uts46 = Uts46::new(); let adl = MyAsciiDenyList::from_str(adl).expect("invalid argument"); let h = MyHyphens::from_str(h).expect("invalid argument"); let dl = MyDnsLength::from_str(dl).expect("invalid argument"); - uts46 + UTS46 .to_ascii(input.as_bytes(), *adl.inner(), *h.inner(), *dl.inner()) .expect("ToAscii conversion failed") .into_owned() @@ -68,21 +108,21 @@ fn idna_to_ascii( /// /// # Defaults /// -/// - If unspecified, the default [`AsciiDenyList`](idna::uts46::AsciiDenyList) is [URL](idna::uts46::AsciiDenyList::URL). -/// - If unspecified, the default [`Hyphens`](idna::uts46::Hyphens) is [Allow](idna::uts46::Hyphens::Allow). +/// - If unspecified, the default [`AsciiDenyList`](idna::uts46::AsciiDenyList) is [`URL`](idna::uts46::AsciiDenyList::URL). +/// - If unspecified, the default [`Hyphens`](idna::uts46::Hyphens) is [`Allow`](idna::uts46::Hyphens::Allow). /// -/// For more information, see [Uts46::to_unicode]. +/// For more information, see [`Uts46::to_unicode`]. #[pg_extern] -fn idna_to_unicode( +#[must_use] +pub fn idna_to_unicode( input: &str, adl: default!(&str, "'url'"), h: default!(&str, "'allow'"), ) -> String { - let uts46 = Uts46::new(); let adl = MyAsciiDenyList::from_str(adl).expect("invalid argument"); let h = MyHyphens::from_str(h).expect("invalid argument"); - idna_to_unicode_internal(input, &uts46, adl, h, false) + idna_to_unicode_internal(input, adl, h, false) } /// Attemps to encode `input` as UTF-8. @@ -97,32 +137,32 @@ fn idna_to_unicode( /// /// # Defaults /// -/// - If unspecified, the default [`AsciiDenyList`](idna::uts46::AsciiDenyList) is [URL](idna::uts46::AsciiDenyList::URL). -/// - If unspecified, the default [`Hyphens`](idna::uts46::Hyphens) is [Allow](idna::uts46::Hyphens::Allow). +/// - If unspecified, the default [`AsciiDenyList`](idna::uts46::AsciiDenyList) is [`URL`](idna::uts46::AsciiDenyList::URL). +/// - If unspecified, the default [`Hyphens`](idna::uts46::Hyphens) is [`Allow`](idna::uts46::Hyphens::Allow). /// /// For more information, see [`Uts46::to_unicode`]. #[pg_extern] -fn idna_to_unicode_lossy( +#[must_use] +pub fn idna_to_unicode_lossy( input: &str, adl: default!(&str, "'url'"), h: default!(&str, "'allow'"), ) -> String { - let uts46 = Uts46::new(); let adl = MyAsciiDenyList::from_str(adl).expect("invalid argument"); let h = MyHyphens::from_str(h).expect("invalid argument"); - idna_to_unicode_internal(input, &uts46, adl, h, true) + idna_to_unicode_internal(input, adl, h, true) } /// Internal function used to perform the `ToUnicode` conversion. +#[must_use] fn idna_to_unicode_internal( input: &str, - uts46: &Uts46, adl: MyAsciiDenyList, h: MyHyphens, lossy: bool, ) -> String { - let (out, res) = uts46.to_unicode(input.as_bytes(), *adl.inner(), *h.inner()); + let (out, res) = UTS46.to_unicode(input.as_bytes(), *adl.inner(), *h.inner()); if res.is_ok() || lossy { out.into_owned()