Merge pull request #49 from EspressoSystems/open-source

add MIT license

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Espresso Systems
+
+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.

README.md

@@ -103,4 +103,4 @@ It requires installation of `KeyDB` or `Redis`.
 ## License
 ### Copyright
 **(c) 2024 Espresso Systems**.
-`Push-CDN` was developed by Espresso Systems. While we plan to adopt an open source license, we have not yet selected one. As such, all rights are reserved for the time being. Please reach out to us if you have thoughts on licensing.
+`Push-CDN` was developed by Espresso Systems. 

cdn-broker/benches/broadcast.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! Benchmarks for allocating and sending broadcast messages.
 //! If run with `--profile-time=N seconds`, it will output a flamegraph.
 

cdn-broker/benches/direct.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! Benchmarks for allocating and sending direct messages.
 //! If run with `--profile-time=N seconds`, it will output a flamegraph.
 

cdn-broker/src/binaries/bad-broker.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! `bad-broker` is a simple binary that starts a broker with a random key and
 //! attempts to start a broker every 100ms. This is useful for testing the
 //! broker's ability to handle multiple brokers connecting to it.

cdn-broker/src/binaries/broker.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! The following is the main `Broker` binary, which just instantiates and runs
 //! a `Broker` object.
 use cdn_broker::{Broker, Config};

cdn-broker/src/connections/broadcast/mod.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! This is where we define routing for broadcast messages.
 
 mod relational_map;

cdn-broker/src/connections/broadcast/relational_map.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 use std::{
     collections::{HashMap, HashSet},
     hash::Hash,

cdn-broker/src/connections/direct/mod.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! This is where we define routing for direct messages.
 use cdn_proto::{connection::UserPublicKey, discovery::BrokerIdentifier};
 

cdn-broker/src/connections/mod.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! This module defines almost all of the connection lookup, addition,
 //! and removal process.
 

cdn-broker/src/connections/versioned_map.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! This map defines our implementation of a map for making use
 //! of versioned vectors. This lets us become eventually consistent
 //! over connected user data.

cdn-broker/src/lib.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! This file contains the implementation of the `Broker`, which routes messages
 //! for the Push CDN.
 

cdn-broker/src/metrics.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! Here is where we define broker-specific metrics that we need.
 //! They are lazily loaded during runtime.
 

cdn-broker/src/reexports.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! This module defines re-exports that the broker uses and that
 //! a downstream user may want to use.
 

cdn-broker/src/tasks/broker/handler.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! This file defines the broker connection handler.
 
 use std::{sync::Arc, time::Duration};

cdn-broker/src/tasks/broker/heartbeat.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! The heartbeat task periodically posts our state to either Redis or an embeddable file DB.
 
 use std::{collections::HashSet, sync::Arc, time::Duration};

cdn-broker/src/tasks/broker/listener.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! The broker listener task listens and handles connections from new brokers.
 
 use std::sync::Arc;

cdn-broker/src/tasks/broker/mod.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 pub mod handler;
 pub mod heartbeat;
 pub mod listener;

cdn-broker/src/tasks/broker/sender.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 use std::sync::Arc;
 
 use cdn_proto::{connection::Bytes, def::RunDef, discovery::BrokerIdentifier};

cdn-broker/src/tasks/broker/sync.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! The sync task syncs both users and topics to other brokers.
 
 use std::{sync::Arc, time::Duration};

cdn-broker/src/tasks/mod.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! This file defines the different types of tasks we have implemented
 //! for `Arc<Inner<>>`.
 

cdn-broker/src/tasks/user/handler.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! This file defines the user handler module, wherein we define connection handlers for
 //! `Arc<Inner>`.
 

cdn-broker/src/tasks/user/listener.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! The user listener tasks listens and deals with user connections.
 
 use std::sync::Arc;

cdn-broker/src/tasks/user/mod.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 pub mod handler;
 pub mod listener;
 pub mod sender;

cdn-broker/src/tasks/user/sender.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 use std::sync::Arc;
 
 use cdn_proto::connection::UserPublicKey;

cdn-broker/src/tests/broadcast.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! Deterministic tests for sending and receiving broadcast messages.
 //! Asserts they all go to the right place.
 

cdn-broker/src/tests/direct.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! Deterministic tests for sending and receiving direct messages.
 //! Asserts they all go to the right place.
 

cdn-broker/src/tests/mod.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! Commonalities for deterministic (non-networked) testing of our broker.
 //! This is not guarded by `![cfg(test)]` because we use the same functions
 //! when running benchmarks.

cdn-client/src/binaries/bad-connector.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! "Bad connector" is a simple example of a client that connects to the broker every
 //! 200ms. This is useful for testing the broker's ability to handle many connections.
 

cdn-client/src/binaries/bad-sender.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! "Bad sender" is a simple example of a client that continuously sends a message to itself.
 //! This is useful for testing the broker's ability to handle many messages.
 

cdn-client/src/binaries/client.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! The following is an example of a Push CDN client implementation.
 //! In this example, we send messages to ourselves via broadcast and direct
 //! systems.

cdn-client/src/lib.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! In here we define an API that is a little more higher-level and ergonomic
 //! for end users. It is a light wrapper on top of a `Retry` connection.
 

cdn-client/src/reexports.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! This module defines re-exports that the client uses and that
 //! a downstream user may want to use.
 

cdn-client/src/retry.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! This file provides a `Retry` connection, which allows for reconnections
 //! on top of a normal connection.
 //!

cdn-marshal/src/binaries/marshal.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! The following is the main `Marshal` binary, which just instantiates and runs
 //! a `Marshal` object.
 

cdn-marshal/src/handlers.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 use std::time::Duration;
 
 use cdn_proto::{

cdn-marshal/src/lib.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! This file contains the implementation of the `Marshal`, which the user
 //! connects to before a broker. It is used to "marshal" a user to the broker
 //! (right now) with the least amount of connections. It's basically a load

cdn-proto/benches/protocols.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 //! Benchmarks for network protocols [Quic/TCP]
 
 use cdn_proto::{

cdn-proto/build.rs

@@ -1,3 +1,9 @@
+// Copyright (c) 2024 Espresso Systems (espressosys.com)
+// This file is part of the Push-CDN repository.
+
+// You should have received a copy of the MIT License
+// along with the Push-CDN repository. If not, see <https://mit-license.org/>.
+
 use std::{env, fs, path::Path};
 
 use rcgen::{CertificateParams, IsCa, KeyPair, PKCS_ECDSA_P256_SHA256};