diff --git a/Cargo.toml b/Cargo.toml index 2a87fbe..8a0a43d 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,6 +2,7 @@ name = "symphony" version = "0.1.0" edition = "2021" +license = "Elastic-2.0" [lib] crate-type = ["cdylib"] diff --git a/LICENSE b/LICENSE index 261eeb9..14f1e8e 100644 --- a/LICENSE +++ b/LICENSE @@ -1,201 +1,93 @@ - 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. +Elastic License 2.0 + +URL: https://www.elastic.co/licensing/elastic-license + +## Acceptance + +By using the software, you agree to all of the terms and conditions below. + +## Copyright License + +The licensor grants you a non-exclusive, royalty-free, worldwide, +non-sublicensable, non-transferable license to use, copy, distribute, make +available, and prepare derivative works of the software, in each case subject +to the limitations and conditions below. + +## Limitations + +You may not provide the software to third parties as a hosted or managed +service, where the service provides users with access to any substantial set of +the features or functionality of the software. + +You may not move, change, disable, or circumvent the license key functionality +in the software, and you may not remove or obscure any functionality in the +software that is protected by the license key. + +You may not alter, remove, or obscure any licensing, copyright, or other +notices of the licensor in the software. Any use of the licensor's trademarks +is subject to applicable law. + +## Patents + +The licensor grants you a license, under any patent claims the licensor can +license, or chooses to license, to make, have made, use, sell, offer for sale, +import and have imported the software, in each case subject to the limitations +and conditions in this license. This license does not cover any patent claims +that you cause to be infringed by modifications or additions to the software. +If you or your company make any written claim that the software infringes or +contributes to infringement of any patent, your patent license for the software +granted under these terms ends immediately. If your company makes such a claim, +your patent license ends immediately for work on behalf of your company. + +## Notices + +You must ensure that anyone who gets a copy of any part of the software from +you also gets a copy of these terms. + +If you modify the software, you must include in any modified copies of the +software prominent notices stating that you have modified the software. + +## No Other Rights + +These terms do not imply any licenses other than those expressly granted in +these terms. + +## Termination + +If you use the software in violation of these terms, such use is not licensed, +and your licenses will automatically terminate. If the licensor provides you +with a notice of your violation, and you cease all violation of this license no +later than 30 days after you receive that notice, your licenses will be +reinstated retroactively. However, if you violate these terms after such +reinstatement, any additional violation of these terms will cause your licenses +to terminate automatically and permanently. + +## No Liability + +*As far as the law allows, the software comes as is, without any warranty or +condition, and the licensor will not be liable to you for any damages arising +out of these terms or the use or nature of the software, under any kind of +legal claim.* + +## Definitions + +The **licensor** is the entity offering these terms, and the **software** is +the software the licensor makes available under these terms, including any +portion of it. + +**you** refers to the individual or entity agreeing to these terms. + +**your company** is any legal entity, sole proprietorship, or other kind of +organization that you work for, plus all organizations that have control over, +are under the control of, or are under common control with that organization. +**control** means ownership of substantially all the assets of an entity, or +the power to direct its management and legal affairs. + +**your licenses** are all the licenses granted to you for the software under +these terms. + +**use** includes anything you do with the software requiring one of your +licenses. + +**trademark** includes logos, trade names, trade dress, service marks, +character marks, and all other indicia of source or origin. diff --git a/npm/darwin-arm64/package.json b/npm/darwin-arm64/package.json new file mode 100644 index 0000000..289e307 --- /dev/null +++ b/npm/darwin-arm64/package.json @@ -0,0 +1,10 @@ +{ + "name": "@harperfast/symphony-darwin-arm64", + "version": "0.1.0", + "description": "symphony native binary for macOS arm64 (Apple Silicon)", + "os": ["darwin"], + "cpu": ["arm64"], + "main": "symphony.darwin-arm64.node", + "files": ["symphony.darwin-arm64.node"], + "license": "Elastic-2.0" +} diff --git a/npm/darwin-x64/package.json b/npm/darwin-x64/package.json new file mode 100644 index 0000000..abc7bf0 --- /dev/null +++ b/npm/darwin-x64/package.json @@ -0,0 +1,10 @@ +{ + "name": "@harperfast/symphony-darwin-x64", + "version": "0.1.0", + "description": "symphony native binary for macOS x64", + "os": ["darwin"], + "cpu": ["x64"], + "main": "symphony.darwin-x64.node", + "files": ["symphony.darwin-x64.node"], + "license": "Elastic-2.0" +} diff --git a/npm/linux-arm64-gnu/package.json b/npm/linux-arm64-gnu/package.json index af40377..fec3877 100644 --- a/npm/linux-arm64-gnu/package.json +++ b/npm/linux-arm64-gnu/package.json @@ -1,10 +1,10 @@ { - "name": "@symphony/linux-arm64-gnu", + "name": "@harperfast/symphony-linux-arm64-gnu", "version": "0.1.0", "description": "symphony native binary for linux arm64 glibc", "os": ["linux"], "cpu": ["arm64"], "main": "symphony.linux-arm64-gnu.node", "files": ["symphony.linux-arm64-gnu.node"], - "license": "MIT" + "license": "Elastic-2.0" } diff --git a/npm/linux-arm64-musl/package.json b/npm/linux-arm64-musl/package.json index 0199f59..7ff4a9d 100644 --- a/npm/linux-arm64-musl/package.json +++ b/npm/linux-arm64-musl/package.json @@ -1,10 +1,10 @@ { - "name": "@symphony/linux-arm64-musl", + "name": "@harperfast/symphony-linux-arm64-musl", "version": "0.1.0", "description": "symphony native binary for linux arm64 musl", "os": ["linux"], "cpu": ["arm64"], "main": "symphony.linux-arm64-musl.node", "files": ["symphony.linux-arm64-musl.node"], - "license": "MIT" + "license": "Elastic-2.0" } diff --git a/npm/linux-x64-gnu/package.json b/npm/linux-x64-gnu/package.json index 156c008..7fa08be 100644 --- a/npm/linux-x64-gnu/package.json +++ b/npm/linux-x64-gnu/package.json @@ -1,10 +1,10 @@ { - "name": "@symphony/linux-x64-gnu", + "name": "@harperfast/symphony-linux-x64-gnu", "version": "0.1.0", "description": "symphony native binary for linux x64 glibc", "os": ["linux"], "cpu": ["x64"], "main": "symphony.linux-x64-gnu.node", "files": ["symphony.linux-x64-gnu.node"], - "license": "MIT" + "license": "Elastic-2.0" } diff --git a/npm/linux-x64-musl/package.json b/npm/linux-x64-musl/package.json index 3d3229b..5bdb368 100644 --- a/npm/linux-x64-musl/package.json +++ b/npm/linux-x64-musl/package.json @@ -1,10 +1,10 @@ { - "name": "@symphony/linux-x64-musl", + "name": "@harperfast/symphony-linux-x64-musl", "version": "0.1.0", "description": "symphony native binary for linux x64 musl", "os": ["linux"], "cpu": ["x64"], "main": "symphony.linux-x64-musl.node", "files": ["symphony.linux-x64-musl.node"], - "license": "MIT" + "license": "Elastic-2.0" } diff --git a/package.json b/package.json index fa027b3..562b81d 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "symphony", + "name": "@harperfast/symphony", "version": "0.1.0", "description": "High-performance TLS proxy with SNI routing — Rust/napi-rs, Linux", "main": "dist/index.js", @@ -42,5 +42,5 @@ "linux", "darwin" ], - "license": "MIT" + "license": "Elastic-2.0" } diff --git a/src/proxy_conn.rs b/src/proxy_conn.rs index f5477f5..4d8ea72 100644 --- a/src/proxy_conn.rs +++ b/src/proxy_conn.rs @@ -148,7 +148,7 @@ pub async fn handle(stream: TcpStream, peer_addr: SocketAddr, ctx: Arc proxy_via_tls(tls_stream, &effective_route.destination, peer_ip, &ctx).await, + Ok(Ok(tls_stream)) => proxy_via_tls(tls_stream, &effective_route.destination, peer_addr, &ctx).await, Ok(Err(e)) => { tracing::debug!("TLS handshake error from {peer_ip}: {e}"); ctx.listener_metrics.inc_error(); @@ -166,7 +166,7 @@ pub async fn handle(stream: TcpStream, peer_addr: SocketAddr, ctx: Arc, dest: &Destination, - peer_ip: IpAddr, + peer_addr: SocketAddr, ctx: &ConnContext, ) -> std::io::Result<()> { - let mut upstream = upstream::connect(dest, Some(peer_ip)) + let mut upstream = upstream::connect(dest, Some(peer_addr.ip())) .await .map_err(|e| std::io::Error::new(std::io::ErrorKind::Other, e.to_string()))?; @@ -195,6 +195,7 @@ async fn proxy_via_tls( .map(|_| ()) } UpstreamStream::Uds { ref mut stream, .. } => { + upstream::write_proxy_v1_header(stream, peer_addr).await?; timeout(idle, copy_bidirectional(&mut client, stream)) .await .map_err(|_| std::io::Error::new(std::io::ErrorKind::TimedOut, "idle timeout"))? @@ -206,10 +207,10 @@ async fn proxy_via_tls( async fn proxy_raw( mut client: TcpStream, dest: &Destination, - peer_ip: IpAddr, + peer_addr: SocketAddr, ctx: &ConnContext, ) -> std::io::Result<()> { - let mut upstream = upstream::connect(dest, Some(peer_ip)) + let mut upstream = upstream::connect(dest, Some(peer_addr.ip())) .await .map_err(|e| std::io::Error::new(std::io::ErrorKind::Other, e.to_string()))?; @@ -222,6 +223,7 @@ async fn proxy_raw( .map(|_| ()) } UpstreamStream::Uds { ref mut stream, .. } => { + upstream::write_proxy_v1_header(stream, peer_addr).await?; timeout(idle, copy_bidirectional(&mut client, stream)) .await .map_err(|_| std::io::Error::new(std::io::ErrorKind::TimedOut, "idle timeout"))? diff --git a/src/upstream.rs b/src/upstream.rs index bb8434a..1499a85 100644 --- a/src/upstream.rs +++ b/src/upstream.rs @@ -1,7 +1,8 @@ use crate::balancer::{BalancerGuard, UdsBalancer}; use crate::router::Destination; -use std::net::IpAddr; +use std::net::{IpAddr, SocketAddr}; use std::sync::Arc; +use tokio::io::AsyncWriteExt; use tokio::net::{TcpStream, UnixStream}; /// An established connection to an upstream server. @@ -40,6 +41,20 @@ async fn connect_uds(balancer: &Arc, peer_ip: Option) -> cr Ok(UpstreamStream::Uds { stream, _guard: guard }) } +/// Write a PROXY protocol v1 header to a Unix domain socket upstream so the +/// backend can recover the real client IP and port despite the UDS transport. +/// +/// Format: `PROXY TCP4 \r\n` +pub async fn write_proxy_v1_header(stream: &mut UnixStream, peer_addr: SocketAddr) -> std::io::Result<()> { + let (proto, src_ip, dst_ip) = match peer_addr.ip() { + IpAddr::V4(ip) => ("TCP4", ip.to_string(), "127.0.0.1".to_string()), + IpAddr::V6(ip) => ("TCP6", ip.to_string(), "::1".to_string()), + }; + // dst-port is 0 — a placeholder; the backend only reads src-ip and src-port. + let header = format!("PROXY {proto} {src_ip} {dst_ip} {} 0\r\n", peer_addr.port()); + stream.write_all(header.as_bytes()).await +} + // ── tokio::io::AsyncRead + AsyncWrite impls via delegation ──────────────────── // We need UpstreamStream to work with copy_bidirectional. // The cleanest approach is to use tokio's split + Box or an enum dispatch. diff --git a/ts/proxy.ts b/ts/proxy.ts index 1398c1d..fa5e959 100644 --- a/ts/proxy.ts +++ b/ts/proxy.ts @@ -32,9 +32,9 @@ function loadAddon(): { SymphonyProxyWrap: typeof SymphonyProxyWrap } { // Published scoped packages if (platform === 'linux') { - candidates.push(`@symphony/linux-${arch}-gnu`, `@symphony/linux-${arch}-musl`); + candidates.push(`@harperfast/symphony-linux-${arch}-gnu`, `@harperfast/symphony-linux-${arch}-musl`); } else if (platform === 'darwin') { - candidates.push(`@symphony/darwin-${arch}`); + candidates.push(`@harperfast/symphony-darwin-${arch}`); } for (const c of candidates) {