Merge pull request #117 from hug-dev/protobuf-generated

Commit the generated Rust protobuf files in tree

Author: hug-dev

Cargo.toml

@@ -11,7 +11,7 @@ categories = ["encoding"]
 edition = "2018"
 
 [build-dependencies]
-prost-build = "0.6.1"
+prost-build = { version = "0.6.1", optional = true }
 
 [dependencies]
 serde = { version = "1.0.115", features = ["derive"] }
@@ -31,3 +31,4 @@ derivative = "2.1.1"
 [features]
 testing = []
 fuzz = ["arbitrary"]
+regenerate-protobuf = ["prost-build"]

README.md

@@ -17,6 +17,11 @@ trying to compile otherwise it will not work ("`No such file or directory`").
 $ git submodule update --init
 ```
 
+By default, the crate will use the pre-generated Rust Protobuf files in
+`src/operations_protobuf/generated_ops`. To re-generate them from the `parsec-operations`
+submodule, compile this
+crate with the feature `regenerate-protobuf`.
+
 ## License
 
 The software is provided under Apache-2.0. Contributions to this project are accepted under the same license.

build.rs

@@ -4,11 +4,16 @@
 // This one is hard to avoid.
 #![allow(clippy::multiple_crate_versions)]
 
-use std::fs::read_dir;
-use std::io::{Error, ErrorKind, Result};
-use std::path::Path;
+use std::io::Result;
 
+// Replace the committed protobuf files with the generated one.
+#[cfg(feature = "regenerate-protobuf")]
 fn generate_proto_sources() -> Result<()> {
+    use std::fs::read_dir;
+    use std::io::{Error, ErrorKind};
+    use std::path::Path;
+    use std::process::Command;
+
     let path = String::from("parsec-operations/protobuf");
     let dir_entries = read_dir(Path::new(&path))?;
     let files: Result<Vec<String>> = dir_entries
@@ -31,9 +36,31 @@ fn generate_proto_sources() -> Result<()> {
         .filter(|string| string.ends_with(".proto"))
         .collect();
     let files_slices: Vec<&str> = proto_files.iter().map(|file| &file[..]).collect();
-    prost_build::compile_protos(&files_slices, &[&path])
+
+    prost_build::compile_protos(&files_slices, &[&path])?;
+
+    // Copy all files generated in src/operations_protobuf/generated_ops
+    let status = Command::new("bash")
+        .arg("-c")
+        .arg(format!(
+            "cp {}/*.rs src/operations_protobuf/generated_ops",
+            std::env::var("OUT_DIR").expect("OUT_DIR env var is empty")
+        ))
+        .status()?;
+
+    if !status.success() {
+        Err(Error::new(
+            ErrorKind::InvalidData,
+            "failed copying generated protobuf files",
+        ))
+    } else {
+        Ok(())
+    }
 }
 
 fn main() -> Result<()> {
-    generate_proto_sources()
+    #[cfg(feature = "regenerate-protobuf")]
+    generate_proto_sources()?;
+
+    Ok(())
 }

src/operations_protobuf/generated_ops/delete_client.rs

@@ -0,0 +1,8 @@
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct Operation {
+    #[prost(string, tag="1")]
+    pub client: std::string::String,
+}
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct Result {
+}

src/operations_protobuf/generated_ops/list_authenticators.rs

@@ -0,0 +1,21 @@
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct AuthenticatorInfo {
+    #[prost(string, tag="1")]
+    pub description: std::string::String,
+    #[prost(uint32, tag="2")]
+    pub version_maj: u32,
+    #[prost(uint32, tag="3")]
+    pub version_min: u32,
+    #[prost(uint32, tag="4")]
+    pub version_rev: u32,
+    #[prost(uint32, tag="5")]
+    pub id: u32,
+}
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct Operation {
+}
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct Result {
+    #[prost(message, repeated, tag="1")]
+    pub authenticators: ::std::vec::Vec<AuthenticatorInfo>,
+}

src/operations_protobuf/generated_ops/list_clients.rs

@@ -0,0 +1,8 @@
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct Operation {
+}
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct Result {
+    #[prost(string, repeated, tag="1")]
+    pub clients: ::std::vec::Vec<std::string::String>,
+}

src/operations_protobuf/generated_ops/list_keys.rs

@@ -0,0 +1,17 @@
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct KeyInfo {
+    #[prost(uint32, tag="1")]
+    pub provider_id: u32,
+    #[prost(string, tag="2")]
+    pub name: std::string::String,
+    #[prost(message, optional, tag="3")]
+    pub attributes: ::std::option::Option<super::psa_key_attributes::KeyAttributes>,
+}
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct Operation {
+}
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct Result {
+    #[prost(message, repeated, tag="1")]
+    pub keys: ::std::vec::Vec<KeyInfo>,
+}

src/operations_protobuf/generated_ops/list_opcodes.rs

@@ -0,0 +1,10 @@
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct Operation {
+    #[prost(uint32, tag="1")]
+    pub provider_id: u32,
+}
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct Result {
+    #[prost(uint32, repeated, tag="1")]
+    pub opcodes: ::std::vec::Vec<u32>,
+}

src/operations_protobuf/generated_ops/list_providers.rs

@@ -0,0 +1,25 @@
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct ProviderInfo {
+    #[prost(string, tag="1")]
+    pub uuid: std::string::String,
+    #[prost(string, tag="2")]
+    pub description: std::string::String,
+    #[prost(string, tag="3")]
+    pub vendor: std::string::String,
+    #[prost(uint32, tag="4")]
+    pub version_maj: u32,
+    #[prost(uint32, tag="5")]
+    pub version_min: u32,
+    #[prost(uint32, tag="6")]
+    pub version_rev: u32,
+    #[prost(uint32, tag="7")]
+    pub id: u32,
+}
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct Operation {
+}
+#[derive(Clone, PartialEq, ::prost::Message)]
+pub struct Result {
+    #[prost(message, repeated, tag="1")]
+    pub providers: ::std::vec::Vec<ProviderInfo>,
+}

src/operations_protobuf/generated_ops.rs renamed to src/operations_protobuf/generated_ops/mod.rs

@@ -1,46 +1,34 @@
 // Copyright 2020 Contributors to the Parsec project.
 // SPDX-License-Identifier: Apache-2.0
-// Include the Rust generated file in its own module.
-use zeroize::Zeroize;
 
-macro_rules! include_protobuf_as_module {
-    ($name:ident) => {
-        pub mod $name {
-            #[allow(unused)]
-            #[macro_export]
-            use zeroize::Zeroize;
-            // The generated Rust file is in OUT_DIR, named $name.rs
-            include!(concat!(env!("OUT_DIR"), "/", stringify!($name), ".rs"));
-        }
-    };
-}
+pub mod psa_sign_hash;
+pub mod psa_verify_hash;
+pub mod psa_sign_message;
+pub mod psa_verify_message;
+pub mod psa_asymmetric_encrypt;
+pub mod psa_asymmetric_decrypt;
+pub mod psa_aead_encrypt;
+pub mod psa_aead_decrypt;
+pub mod psa_generate_key;
+pub mod psa_destroy_key;
+pub mod psa_export_public_key;
+pub mod psa_export_key;
+pub mod psa_import_key;
+pub mod list_opcodes;
+pub mod list_providers;
+pub mod list_authenticators;
+pub mod list_keys;
+pub mod list_clients;
+pub mod delete_client;
+pub mod ping;
+pub mod psa_key_attributes;
+pub mod psa_algorithm;
+pub mod psa_generate_random;
+pub mod psa_hash_compute;
+pub mod psa_hash_compare;
+pub mod psa_raw_key_agreement;
 
-include_protobuf_as_module!(psa_sign_hash);
-include_protobuf_as_module!(psa_verify_hash);
-include_protobuf_as_module!(psa_sign_message);
-include_protobuf_as_module!(psa_verify_message);
-include_protobuf_as_module!(psa_asymmetric_encrypt);
-include_protobuf_as_module!(psa_asymmetric_decrypt);
-include_protobuf_as_module!(psa_aead_encrypt);
-include_protobuf_as_module!(psa_aead_decrypt);
-include_protobuf_as_module!(psa_generate_key);
-include_protobuf_as_module!(psa_destroy_key);
-include_protobuf_as_module!(psa_export_public_key);
-include_protobuf_as_module!(psa_export_key);
-include_protobuf_as_module!(psa_import_key);
-include_protobuf_as_module!(list_opcodes);
-include_protobuf_as_module!(list_providers);
-include_protobuf_as_module!(list_authenticators);
-include_protobuf_as_module!(list_keys);
-include_protobuf_as_module!(list_clients);
-include_protobuf_as_module!(delete_client);
-include_protobuf_as_module!(ping);
-include_protobuf_as_module!(psa_key_attributes);
-include_protobuf_as_module!(psa_algorithm);
-include_protobuf_as_module!(psa_generate_random);
-include_protobuf_as_module!(psa_hash_compute);
-include_protobuf_as_module!(psa_hash_compare);
-include_protobuf_as_module!(psa_raw_key_agreement);
+use zeroize::Zeroize;
 
 use crate::requests::{ResponseStatus, Result};
 use log::error;