Release Pingora version 0.1.0v0.1.0

Co-authored-by: Andrew Hauck <[email protected]>
Co-authored-by: Edward Wang <[email protected]>

4 files changed, 473 insertions, 0 deletions

diff --git a/pingora-openssl/Cargo.toml b/pingora-openssl/Cargo.toml
new file mode 100644
index 0000000..19b3349
--- /dev/null
+++ b/pingora-openssl/Cargo.toml
@@ -0,0 +1,29 @@
+[package]
+name = "pingora-openssl"
+version = "0.1.0"
+authors = ["Yuchen Wu <[email protected]>"]
+license = "Apache-2.0"
+edition = "2021"
+repository = "https://github.com/cloudflare/pingora"
+categories = ["asynchronous", "network-programming"]
+keywords = ["async", "tls", "ssl", "pingora"]
+description = """
+OpenSSL async APIs for Pingora.
+"""
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+[lib]
+name = "pingora_openssl"
+path = "src/lib.rs"
+
+[dependencies]
+openssl-sys = "0.9"
+openssl = { version = "0.10", features = ["vendored"] }
+openssl-src = { version = "300", features = ["weak-crypto"] }
+tokio-openssl = { version = "0.6" }
+libc = "0.2.70"
+foreign-types = { version = "0.3"}
+
+[dev-dependencies]
+tokio-test = "0.4"
+tokio = { workspace = true, features = ["full"] }
diff --git a/pingora-openssl/LICENSE b/pingora-openssl/LICENSE
new file mode 100644
index 0000000..d645695
--- /dev/null
+++ b/pingora-openssl/LICENSE
@@ -0,0 +1,202 @@
+
+                                 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/pingora-openssl/src/ext.rs b/pingora-openssl/src/ext.rs
new file mode 100644
index 0000000..f8cebb2
--- /dev/null
+++ b/pingora-openssl/src/ext.rs
@@ -0,0 +1,209 @@
+// Copyright 2024 Cloudflare, Inc.
+//
+// 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.
+
+use foreign_types::ForeignTypeRef;
+use libc::*;
+use openssl::error::ErrorStack;
+use openssl::pkey::{HasPrivate, PKeyRef};
+use openssl::ssl::{Ssl, SslAcceptor, SslRef};
+use openssl::x509::store::X509StoreRef;
+use openssl::x509::verify::X509VerifyParamRef;
+use openssl::x509::X509Ref;
+use openssl_sys::{
+    SSL_ctrl, EVP_PKEY, SSL, SSL_CTRL_SET_GROUPS_LIST, SSL_CTRL_SET_VERIFY_CERT_STORE, X509,
+    X509_VERIFY_PARAM,
+};
+use std::ffi::CString;
+use std::os::raw;
+
+fn cvt(r: c_int) -> Result<c_int, ErrorStack> {
+    if r != 1 {
+        Err(ErrorStack::get())
+    } else {
+        Ok(r)
+    }
+}
+
+extern "C" {
+    pub fn X509_VERIFY_PARAM_add1_host(
+        param: *mut X509_VERIFY_PARAM,
+        name: *const c_char,
+        namelen: size_t,
+    ) -> c_int;
+
+    pub fn SSL_use_certificate(ssl: *const SSL, cert: *mut X509) -> c_int;
+    pub fn SSL_use_PrivateKey(ctx: *const SSL, key: *mut EVP_PKEY) -> c_int;
+
+    pub fn SSL_set_cert_cb(
+        ssl: *mut SSL,
+        cb: ::std::option::Option<
+            unsafe extern "C" fn(ssl: *mut SSL, arg: *mut raw::c_void) -> raw::c_int,
+        >,
+        arg: *mut raw::c_void,
+    );
+}
+
+/// Add name as an additional reference identifier that can match the peer's certificate
+///
+/// See [X509_VERIFY_PARAM_set1_host](https://www.openssl.org/docs/man3.1/man3/X509_VERIFY_PARAM_set1_host.html).
+pub fn add_host(verify_param: &mut X509VerifyParamRef, host: &str) -> Result<(), ErrorStack> {
+    if host.is_empty() {
+        return Ok(());
+    }
+    unsafe {
+        cvt(X509_VERIFY_PARAM_add1_host(
+            verify_param.as_ptr(),
+            host.as_ptr() as *const _,
+            host.len(),
+        ))
+        .map(|_| ())
+    }
+}
+
+/// Set the verify cert store of `ssl`
+///
+/// See [SSL_set1_verify_cert_store](https://www.openssl.org/docs/man1.1.1/man3/SSL_set1_verify_cert_store.html).
+pub fn ssl_set_verify_cert_store(
+    ssl: &mut SslRef,
+    cert_store: &X509StoreRef,
+) -> Result<(), ErrorStack> {
+    unsafe {
+        cvt(SSL_ctrl(
+            ssl.as_ptr(),
+            SSL_CTRL_SET_VERIFY_CERT_STORE,
+            1, // increase the ref count of X509Store so that ssl_ctx can outlive X509StoreRef
+            cert_store.as_ptr() as *mut c_void,
+        ) as i32)?;
+    }
+    Ok(())
+}
+
+/// Load the certificate into `ssl`
+///
+/// See [SSL_use_certificate](https://www.openssl.org/docs/man1.1.1/man3/SSL_use_certificate.html).
+pub fn ssl_use_certificate(ssl: &mut SslRef, cert: &X509Ref) -> Result<(), ErrorStack> {
+    unsafe {
+        cvt(SSL_use_certificate(ssl.as_ptr(), cert.as_ptr()))?;
+    }
+    Ok(())
+}
+
+/// Load the private key into `ssl`
+///
+/// See [SSL_use_certificate](https://www.openssl.org/docs/man1.1.1/man3/SSL_use_PrivateKey.html).
+pub fn ssl_use_private_key<T>(ssl: &mut SslRef, key: &PKeyRef<T>) -> Result<(), ErrorStack>
+where
+    T: HasPrivate,
+{
+    unsafe {
+        cvt(SSL_use_PrivateKey(ssl.as_ptr(), key.as_ptr()))?;
+    }
+    Ok(())
+}
+
+/// Add the certificate into the cert chain of `ssl`
+///
+/// See [SSL_add1_chain_cert](https://www.openssl.org/docs/man1.1.1/man3/SSL_add1_chain_cert.html)
+pub fn ssl_add_chain_cert(ssl: &mut SslRef, cert: &X509Ref) -> Result<(), ErrorStack> {
+    const SSL_CTRL_CHAIN_CERT: i32 = 89;
+    unsafe {
+        cvt(SSL_ctrl(
+            ssl.as_ptr(),
+            SSL_CTRL_CHAIN_CERT,
+            1, // increase the ref count of X509 so that ssl can outlive X509StoreRef
+            cert.as_ptr() as *mut c_void,
+        ) as i32)?;
+    }
+    Ok(())
+}
+
+/// Set renegotiation
+///
+/// This function is specific to BoringSSL. This function is noop for OpenSSL.
+pub fn ssl_set_renegotiate_mode_freely(_ssl: &mut SslRef) {}
+
+/// Set the curves/groups of `ssl`
+///
+/// See [set_groups_list](https://www.openssl.org/docs/manmaster/man3/SSL_CTX_set1_curves.html).
+pub fn ssl_set_groups_list(ssl: &mut SslRef, groups: &str) -> Result<(), ErrorStack> {
+    let groups = CString::new(groups).unwrap();
+    unsafe {
+        cvt(SSL_ctrl(
+            ssl.as_ptr(),
+            SSL_CTRL_SET_GROUPS_LIST,
+            0,
+            groups.as_ptr() as *mut c_void,
+        ) as i32)?;
+    }
+    Ok(())
+}
+
+/// Set's whether a second keyshare to be sent in client hello when PQ is used.
+///
+/// This function is specific to BoringSSL. This function is noop for OpenSSL.
+pub fn ssl_use_second_key_share(_ssl: &mut SslRef, _enabled: bool) {}
+
+/// Clear the error stack
+///
+/// SSL calls should check and clear the OpenSSL error stack. But some calls fail to do so.
+/// This causes the next unrelated SSL call to fail due to the leftover errors. This function allow
+/// caller to clear the error stack before performing SSL calls to avoid this issue.
+pub fn clear_error_stack() {
+    let _ = ErrorStack::get();
+}
+
+/// Create a new [Ssl] from &[SslAcceptor]
+///
+/// this function is to unify the interface between this crate and `pingora-boringssl`
+pub fn ssl_from_acceptor(acceptor: &SslAcceptor) -> Result<Ssl, ErrorStack> {
+    Ssl::new(acceptor.context())
+}
+
+/// Suspend the TLS handshake when a certificate is needed.
+///
+/// This function will cause tls handshake to pause and return the error: SSL_ERROR_WANT_X509_LOOKUP.
+/// The caller should set the certificate and then call [unblock_ssl_cert()] before continue the
+/// handshake on the tls connection.
+pub fn suspend_when_need_ssl_cert(ssl: &mut SslRef) {
+    unsafe {
+        SSL_set_cert_cb(ssl.as_ptr(), Some(raw_cert_block), std::ptr::null_mut());
+    }
+}
+
+/// Unblock a TLS handshake after the certificate is set.
+///
+/// The user should continue to call tls handshake after this function is called.
+pub fn unblock_ssl_cert(ssl: &mut SslRef) {
+    unsafe {
+        SSL_set_cert_cb(ssl.as_ptr(), None, std::ptr::null_mut());
+    }
+}
+
+// Just block the handshake
+extern "C" fn raw_cert_block(_ssl: *mut openssl_sys::SSL, _arg: *mut c_void) -> c_int {
+    -1
+}
+
+/// Whether the TLS error is SSL_ERROR_WANT_X509_LOOKUP
+pub fn is_suspended_for_cert(error: &openssl::ssl::Error) -> bool {
+    error.code().as_raw() == openssl_sys::SSL_ERROR_WANT_X509_LOOKUP
+}
+
+#[allow(clippy::mut_from_ref)]
+/// Get a mutable SslRef ouf of SslRef, which is a missing functionality even when holding &mut SslStream
+/// # Safety
+/// the caller need to make sure that they hold a &mut SslStream (or other mutable ref to the Ssl)
+pub unsafe fn ssl_mut(ssl: &SslRef) -> &mut SslRef {
+    SslRef::from_ptr_mut(ssl.as_ptr())
+}
diff --git a/pingora-openssl/src/lib.rs b/pingora-openssl/src/lib.rs
new file mode 100644
index 0000000..b12cee1
--- /dev/null
+++ b/pingora-openssl/src/lib.rs
@@ -0,0 +1,33 @@
+// Copyright 2024 Cloudflare, Inc.
+//
+// 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.
+
+//! The OpenSSL API compatibility layer.
+//!
+//! This crate aims at making [openssl] APIs interchangeable with [boring](https://docs.rs/boring/latest/boring/).
+//! In other words, this crate and `pingora-boringssl` expose identical rust APIs.
+
+#![warn(clippy::all)]
+
+use openssl as ssl_lib;
+pub use openssl_sys as ssl_sys;
+pub use tokio_openssl as tokio_ssl;
+pub mod ext;
+
+// export commonly used libs
+pub use ssl_lib::error;
+pub use ssl_lib::hash;
+pub use ssl_lib::nid;
+pub use ssl_lib::pkey;
+pub use ssl_lib::ssl;
+pub use ssl_lib::x509;