keylime-agent: move JsonWrapper from common.rs to the library

Move the JsonWrapper structure from common.rs to the library,
effectively making the common.rs empty.

Remove the common.rs file.

Signed-off-by: Anderson Toshiyuki Sasaki <[email protected]>

Author: ansasaki

keylime-agent/src/agent_handler.rs

@@ -1,10 +1,10 @@
 // SPDX-License-Identifier: Apache-2.0
 // Copyright 2023 Keylime Authors
 
-use crate::common::JsonWrapper;
 use crate::{tpm, Error as KeylimeError, QuoteData};
 use actix_web::{http, web, HttpRequest, HttpResponse, Responder};
 use base64::{engine::general_purpose, Engine as _};
+use keylime::json_wrapper::JsonWrapper;
 use log::*;
 use serde::{Deserialize, Serialize};
 

keylime-agent/src/api.rs

@@ -1,11 +1,11 @@
 use crate::{
-    agent_handler, common::JsonWrapper, config, errors_handler, keys_handler,
+    agent_handler, config, errors_handler, keys_handler,
     notifications_handler, quotes_handler, QuoteData,
 };
 use actix_web::{http, web, HttpRequest, HttpResponse, Responder, Scope};
 use keylime::{
-    config::SUPPORTED_API_VERSIONS, list_parser::parse_list,
-    version::KeylimeVersion,
+    config::SUPPORTED_API_VERSIONS, json_wrapper::JsonWrapper,
+    list_parser::parse_list, version::KeylimeVersion,
 };
 use log::*;
 use serde::{Deserialize, Serialize};

keylime-agent/src/common.rs

@@ -1,15 +1,15 @@
 // SPDX-License-Identifier: Apache-2.0
 // Copyright 2021 Keylime Authors
 
-use crate::{common::JsonWrapper, QuoteData};
+use crate::QuoteData;
 use actix_web::{
     body, dev,
     error::{InternalError, JsonPayloadError, PathError, QueryPayloadError},
     http,
     middleware::{ErrorHandlerResponse, ErrorHandlers},
     web, Error, HttpRequest, HttpResponse, Responder, Result,
 };
-use keylime::version::Version;
+use keylime::{json_wrapper::JsonWrapper, version::Version};
 use log::*;
 
 pub(crate) async fn app_default(

keylime-agent/src/errors_handler.rs

@@ -2,18 +2,20 @@
 // Copyright 2021 Keylime Authors
 
 use crate::{
-    common::JsonWrapper,
     config::KeylimeConfig,
     payloads::{Payload, PayloadMessage},
     Error, QuoteData, Result,
 };
 use actix_web::{http, web, HttpRequest, HttpResponse, Responder};
 use base64::{engine::general_purpose, Engine as _};
-use keylime::crypto::{
-    self,
-    auth_tag::AuthTag,
-    encrypted_data::EncryptedData,
-    symmkey::{KeySet, SymmKey},
+use keylime::{
+    crypto::{
+        self,
+        auth_tag::AuthTag,
+        encrypted_data::EncryptedData,
+        symmkey::{KeySet, SymmKey},
+    },
+    json_wrapper::JsonWrapper,
 };
 use log::*;
 use serde::{Deserialize, Serialize};

keylime-agent/src/keys_handler.rs

@@ -33,7 +33,6 @@
 
 mod agent_handler;
 mod api;
-mod common;
 mod errors_handler;
 mod keys_handler;
 mod notifications_handler;
@@ -44,7 +43,6 @@ mod revocation;
 use actix_web::{dev::Service, http, middleware, rt, web, App, HttpServer};
 use base64::{engine::general_purpose, Engine as _};
 use clap::{Arg, Command as ClapApp};
-use common::*;
 use futures::{
     future::{ok, TryFutureExt},
     try_join,

keylime-agent/src/main.rs

@@ -2,11 +2,11 @@
 // Copyright 2021 Keylime Authors
 
 use crate::{
-    common::JsonWrapper,
     revocation::{Revocation, RevocationMessage},
     Error, QuoteData, Result,
 };
 use actix_web::{http, web, HttpRequest, HttpResponse, Responder};
+use keylime::json_wrapper::JsonWrapper;
 use log::*;
 use serde::{Deserialize, Serialize};
 use std::path::{Path, PathBuf};

keylime-agent/src/notifications_handler.rs

@@ -1,13 +1,15 @@
 // SPDX-License-Identifier: Apache-2.0
 // Copyright 2021 Keylime Authors
 
-use crate::common::JsonWrapper;
 use crate::crypto;
 use crate::serialization::serialize_maybe_base64;
 use crate::{tpm, Error as KeylimeError, QuoteData};
 use actix_web::{http, web, HttpRequest, HttpResponse, Responder};
 use base64::{engine::general_purpose, Engine as _};
-use keylime::quote::{Integ, KeylimeQuote};
+use keylime::{
+    json_wrapper::JsonWrapper,
+    quote::{Integ, KeylimeQuote},
+};
 use log::*;
 use serde::{Deserialize, Serialize};
 use std::{

keylime-agent/src/quotes_handler.rs

@@ -0,0 +1,87 @@
+use serde::{Deserialize, Serialize};
+use serde_json::{json, Value};
+use std::fmt::{self, Debug, Display};
+
+#[derive(Serialize, Deserialize, Debug)]
+pub struct JsonWrapper<A> {
+    pub code: u16,
+    pub status: String,
+    pub results: A,
+}
+
+impl JsonWrapper<Value> {
+    pub fn error(code: u16, status: impl ToString) -> JsonWrapper<Value> {
+        JsonWrapper {
+            code,
+            status: status.to_string(),
+            results: json!({}),
+        }
+    }
+}
+
+impl<'de, A> JsonWrapper<A>
+where
+    A: Deserialize<'de> + Serialize + Debug,
+{
+    pub fn success(results: A) -> JsonWrapper<A> {
+        JsonWrapper {
+            code: 200,
+            status: String::from("Success"),
+            results,
+        }
+    }
+}
+
+impl<'de, A> Display for JsonWrapper<A>
+where
+    A: Deserialize<'de> + Serialize + Debug + Display,
+{
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        let out = json!(self).to_string();
+        write!(f, "{}", out)
+    }
+}
+
+#[cfg(test)]
+mod test {
+    use super::*;
+
+    #[derive(Serialize, Deserialize, Debug, PartialEq)]
+    struct TestResult {
+        result: String,
+    }
+
+    impl Display for TestResult {
+        fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+            let out = json!(self).to_string();
+            write!(f, "{}", out)
+        }
+    }
+
+    #[test]
+    fn test_json_wrapper_success() {
+        let expected = json!({
+            "code": 200,
+            "status": "Success",
+            "results": TestResult{
+                result: "Success".to_string(),
+            },
+        });
+        let j = JsonWrapper::success(TestResult {
+            result: "Success".to_string(),
+        });
+        assert_eq!(j.to_string(), expected.to_string());
+    }
+
+    #[test]
+    fn test_json_wrapper_error() {
+        let expected = json!({
+            "code": 400,
+            "status": "Testing JsonWrapper error",
+            "results": {},
+        });
+        let j =
+            JsonWrapper::error(400, "Testing JsonWrapper error".to_string());
+        assert_eq!(j.to_string(), expected.to_string());
+    }
+}

keylime/src/json_wrapper.rs

@@ -12,6 +12,7 @@ pub mod hostname_parser;
 pub mod https_client;
 pub mod ima;
 pub mod ip_parser;
+pub mod json_wrapper;
 pub mod list_parser;
 pub mod permissions;
 pub mod quote;