misc(notary): add common crate for server and client (#871)

* Add notary-common crate.

* Add cargo lock changes.

* Add copy.

---------

Co-authored-by: yuroitaki <>

Author: yuroitaki

Cargo.lock

@@ -15,6 +15,7 @@ members = [
     "crates/examples",
     "crates/formats",
     "crates/notary/client",
+    "crates/notary/common",
     "crates/notary/server",
     "crates/notary/tests-integration",
     "crates/prover",
@@ -45,6 +46,7 @@ opt-level = 1
 
 [workspace.dependencies]
 notary-client = { path = "crates/notary/client" }
+notary-common = { path = "crates/notary/common" }
 notary-server = { path = "crates/notary/server" }
 tls-server-fixture = { path = "crates/tls/server-fixture" }
 tlsn-cipher = { path = "crates/components/cipher" }

Cargo.toml

@@ -7,7 +7,7 @@ edition = "2021"
 workspace = true
 
 [dependencies]
-notary-server = { workspace = true }
+notary-common = { workspace = true }
 
 derive_builder = { workspace = true }
 futures = { workspace = true }

crates/notary/client/Cargo.toml

@@ -10,7 +10,7 @@ use hyper::{
     Request, Response, StatusCode,
 };
 use hyper_util::rt::TokioIo;
-use notary_server::{
+use notary_common::{
     ClientType, NotarizationSessionRequest, NotarizationSessionResponse, X_API_KEY_HEADER,
 };
 use std::{

crates/notary/client/src/client.rs

@@ -0,0 +1,11 @@
+[package]
+name = "notary-common"
+version = "0.1.0-alpha.11-pre"
+description = "Common code shared between notary-server and notary-client"
+edition = "2021"
+
+[lints]
+workspace = true
+
+[dependencies]
+serde = { workspace = true, features = ["derive"] }

crates/notary/common/Cargo.toml

@@ -0,0 +1,34 @@
+use serde::{Deserialize, Serialize};
+
+/// Custom HTTP header used for specifying a whitelisted API key.
+pub const X_API_KEY_HEADER: &str = "X-API-Key";
+
+/// Types of client that the prover is using.
+#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
+pub enum ClientType {
+    /// Client that has access to the transport layer.
+    Tcp,
+    /// Client that cannot directly access the transport layer, e.g. browser
+    /// extension.
+    Websocket,
+}
+
+/// Request object of the /session API.
+#[derive(Debug, Clone, Copy, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct NotarizationSessionRequest {
+    pub client_type: ClientType,
+    /// Maximum data that can be sent by the prover.
+    pub max_sent_data: Option<usize>,
+    /// Maximum data that can be received by the prover.
+    pub max_recv_data: Option<usize>,
+}
+
+/// Response object of the /session API.
+#[derive(Debug, Clone, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub struct NotarizationSessionResponse {
+    /// Unique session id that is generated by the notary and shared to the
+    /// prover.
+    pub session_id: String,
+}

crates/notary/common/src/lib.rs

@@ -13,6 +13,7 @@ tee_quote = [
 ]
 
 [dependencies]
+notary-common = { workspace = true }
 tlsn-core = { workspace = true }
 tlsn-common = { workspace = true }
 tlsn-verifier = { workspace = true }

crates/notary/server/Cargo.toml

@@ -12,9 +12,6 @@ use tracing::{debug, error, info};
 
 use crate::{util::parse_csv_file, NotaryServerProperties};
 
-/// Custom HTTP header used for specifying a whitelisted API key
-pub const X_API_KEY_HEADER: &str = "X-API-Key";
-
 /// Structure of each whitelisted record of the API key whitelist for
 /// authorization purpose
 #[derive(Clone, Debug, Deserialize, Serialize)]

crates/notary/server/src/auth.rs

@@ -12,7 +12,6 @@ mod tee;
 mod types;
 mod util;
 
-pub use auth::X_API_KEY_HEADER;
 pub use cli::CliFields;
 pub use config::{
     AuthorizationProperties, LogProperties, NotarizationProperties, NotaryServerProperties,
@@ -21,5 +20,4 @@ pub use config::{
 pub use error::NotaryServerError;
 pub use server::{read_pem_file, run_server};
 pub use server_tracing::init_tracing;
-pub use types::{ClientType, NotarizationSessionRequest, NotarizationSessionResponse};
 pub use util::parse_config_file;

crates/notary/server/src/lib.rs

@@ -1,13 +1,10 @@
 use axum::http::request::Parts;
 use axum_core::extract::{FromRef, FromRequestParts};
+use notary_common::X_API_KEY_HEADER;
 use std::collections::HashMap;
 use tracing::{error, trace};
 
-use crate::{
-    auth::{AuthorizationWhitelistRecord, X_API_KEY_HEADER},
-    types::NotaryGlobals,
-    NotaryServerError,
-};
+use crate::{auth::AuthorizationWhitelistRecord, types::NotaryGlobals, NotaryServerError};
 
 /// Auth middleware to prevent DOS
 pub struct AuthorizationMiddleware;