Implement ListKeys operation

Signed-off-by: Joe Ellis <[email protected]>

Author: Joe Ellis

src/operations/mod.rs

@@ -26,6 +26,7 @@ pub mod psa_aead_decrypt;
 pub mod list_opcodes;
 pub mod list_providers;
 pub mod list_authenticators;
+pub mod list_keys;
 pub mod psa_generate_random;
 pub mod psa_raw_key_agreement;
 
@@ -44,6 +45,8 @@ pub enum NativeOperation {
     ListOpcodes(list_opcodes::Operation),
     /// ListAuthenticators operation
     ListAuthenticators(list_authenticators::Operation),
+    /// ListKeys operation
+    ListKeys(list_keys::Operation),
     /// Ping operation
     Ping(ping::Operation),
     /// PsaGenerateKey operation
@@ -95,6 +98,7 @@ impl NativeOperation {
             NativeOperation::ListOpcodes(_) => Opcode::ListOpcodes,
             NativeOperation::ListProviders(_) => Opcode::ListProviders,
             NativeOperation::ListAuthenticators(_) => Opcode::ListAuthenticators,
+            NativeOperation::ListKeys(_) => Opcode::ListKeys,
             NativeOperation::PsaAsymmetricEncrypt(_) => Opcode::PsaAsymmetricEncrypt,
             NativeOperation::PsaAsymmetricDecrypt(_) => Opcode::PsaAsymmetricDecrypt,
             NativeOperation::PsaAeadEncrypt(_) => Opcode::PsaAeadEncrypt,
@@ -115,6 +119,8 @@ pub enum NativeResult {
     ListOpcodes(list_opcodes::Result),
     /// ListAuthenticators result
     ListAuthenticators(list_authenticators::Result),
+    /// ListKeys result
+    ListKeys(list_keys::Result),
     /// Ping result
     Ping(ping::Result),
     /// PsaGenerateKey result
@@ -166,6 +172,7 @@ impl NativeResult {
             NativeResult::ListOpcodes(_) => Opcode::ListOpcodes,
             NativeResult::ListProviders(_) => Opcode::ListProviders,
             NativeResult::ListAuthenticators(_) => Opcode::ListAuthenticators,
+            NativeResult::ListKeys(_) => Opcode::ListKeys,
             NativeResult::PsaAsymmetricEncrypt(_) => Opcode::PsaAsymmetricEncrypt,
             NativeResult::PsaAsymmetricDecrypt(_) => Opcode::PsaAsymmetricDecrypt,
             NativeResult::PsaAeadEncrypt(_) => Opcode::PsaAeadEncrypt,
@@ -225,6 +232,12 @@ impl From<list_authenticators::Operation> for NativeOperation {
     }
 }
 
+impl From<list_keys::Operation> for NativeOperation {
+    fn from(op: list_keys::Operation) -> Self {
+        NativeOperation::ListKeys(op)
+    }
+}
+
 impl From<ping::Operation> for NativeOperation {
     fn from(op: ping::Operation) -> Self {
         NativeOperation::Ping(op)
@@ -338,6 +351,12 @@ impl From<list_authenticators::Result> for NativeResult {
     }
 }
 
+impl From<list_keys::Result> for NativeResult {
+    fn from(op: list_keys::Result) -> Self {
+        NativeResult::ListKeys(op)
+    }
+}
+
 impl From<ping::Result> for NativeResult {
     fn from(op: ping::Result) -> Self {
         NativeResult::Ping(op)

src/operations_protobuf/convert_list_keys.rs

@@ -0,0 +1,89 @@
+// Copyright 2020 Contributors to the Parsec project.
+// SPDX-License-Identifier: Apache-2.0
+use super::generated_ops::list_keys::{
+    KeyInfo as KeyInfoProto, Operation as OperationProto, Result as ResultProto,
+};
+use crate::operations::list_keys::{KeyInfo, Operation, Result};
+use crate::requests::{ProviderID, ResponseStatus};
+use log::error;
+use num::FromPrimitive;
+use std::convert::{TryFrom, TryInto};
+
+impl TryFrom<OperationProto> for Operation {
+    type Error = ResponseStatus;
+
+    fn try_from(_proto_op: OperationProto) -> std::result::Result<Self, Self::Error> {
+        Ok(Operation {})
+    }
+}
+
+impl TryFrom<Operation> for OperationProto {
+    type Error = ResponseStatus;
+
+    fn try_from(_op: Operation) -> std::result::Result<Self, Self::Error> {
+        Ok(Default::default())
+    }
+}
+
+impl TryFrom<KeyInfoProto> for KeyInfo {
+    type Error = ResponseStatus;
+
+    fn try_from(proto_info: KeyInfoProto) -> std::result::Result<Self, Self::Error> {
+        let id: ProviderID = match FromPrimitive::from_u32(proto_info.provider_id) {
+            Some(id) => id,
+            None => return Err(ResponseStatus::ProviderDoesNotExist),
+        };
+
+        let attributes = proto_info
+            .attributes
+            .ok_or_else(|| {
+                error!("attributes field of KeyInfo protobuf message is empty.");
+                ResponseStatus::InvalidEncoding
+            })?
+            .try_into()?;
+
+        Ok(KeyInfo {
+            provider_id: id as u32,
+            name: proto_info.name,
+            attributes,
+        })
+    }
+}
+
+impl TryFrom<KeyInfo> for KeyInfoProto {
+    type Error = ResponseStatus;
+
+    fn try_from(info: KeyInfo) -> std::result::Result<Self, Self::Error> {
+        Ok(KeyInfoProto {
+            provider_id: info.provider_id,
+            name: info.name,
+            attributes: Some(info.attributes.try_into()?),
+        })
+    }
+}
+
+impl TryFrom<ResultProto> for Result {
+    type Error = ResponseStatus;
+
+    fn try_from(proto_op: ResultProto) -> std::result::Result<Self, Self::Error> {
+        let mut keys: Vec<KeyInfo> = Vec::new();
+        for key in proto_op.keys {
+            keys.push(key.try_into()?);
+        }
+
+        Ok(Result { keys })
+    }
+}
+
+impl TryFrom<Result> for ResultProto {
+    type Error = ResponseStatus;
+
+    fn try_from(op: Result) -> std::result::Result<Self, Self::Error> {
+        let mut keys: Vec<KeyInfoProto> = Vec::new();
+        for key in op.keys {
+            keys.push(key.try_into()?);
+        }
+
+        Ok(ResultProto { keys })
+    }
+}

src/operations_protobuf/generated_ops.rs

@@ -29,6 +29,7 @@ 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!(ping);
 include_protobuf_as_module!(psa_key_attributes);
 include_protobuf_as_module!(psa_algorithm);
@@ -140,6 +141,8 @@ empty_clear_message!(list_providers::Operation);
 empty_clear_message!(list_providers::Result);
 empty_clear_message!(list_authenticators::Operation);
 empty_clear_message!(list_authenticators::Result);
+empty_clear_message!(list_keys::Operation);
+empty_clear_message!(list_keys::Result);
 empty_clear_message!(ping::Operation);
 empty_clear_message!(ping::Result);
 empty_clear_message!(psa_destroy_key::Operation);

src/operations_protobuf/mod.rs

@@ -18,6 +18,7 @@ mod convert_psa_hash_compare;
 mod convert_list_providers;
 mod convert_list_opcodes;
 mod convert_list_authenticators;
+mod convert_list_keys;
 mod convert_psa_asymmetric_encrypt;
 mod convert_psa_asymmetric_decrypt;
 mod convert_psa_aead_encrypt;
@@ -34,6 +35,7 @@ use crate::requests::{
     request::RequestBody, response::ResponseBody, BodyType, Opcode, ResponseStatus, Result,
 };
 use generated_ops::list_authenticators as list_authenticators_proto;
+use generated_ops::list_keys as list_keys_proto;
 use generated_ops::list_opcodes as list_opcodes_proto;
 use generated_ops::list_providers as list_providers_proto;
 use generated_ops::ping as ping_proto;
@@ -103,6 +105,10 @@ impl Convert for ProtobufConverter {
                 body.bytes(),
                 list_authenticators_proto::Operation
             ))),
+            Opcode::ListKeys => Ok(NativeOperation::ListKeys(wire_to_native!(
+                body.bytes(),
+                list_keys_proto::Operation
+            ))),
             Opcode::Ping => Ok(NativeOperation::Ping(wire_to_native!(
                 body.bytes(),
                 ping_proto::Operation
@@ -179,6 +185,10 @@ impl Convert for ProtobufConverter {
             NativeOperation::ListAuthenticators(operation) => Ok(RequestBody::from_bytes(
                 native_to_wire!(operation, list_authenticators_proto::Operation),
             )),
+            NativeOperation::ListKeys(operation) => Ok(RequestBody::from_bytes(native_to_wire!(
+                operation,
+                list_keys_proto::Operation
+            ))),
             NativeOperation::Ping(operation) => Ok(RequestBody::from_bytes(native_to_wire!(
                 operation,
                 ping_proto::Operation
@@ -245,6 +255,10 @@ impl Convert for ProtobufConverter {
                 body.bytes(),
                 list_authenticators_proto::Result
             ))),
+            Opcode::ListKeys => Ok(NativeResult::ListKeys(wire_to_native!(
+                body.bytes(),
+                list_keys_proto::Result
+            ))),
             Opcode::Ping => Ok(NativeResult::Ping(wire_to_native!(
                 body.bytes(),
                 ping_proto::Result
@@ -323,6 +337,10 @@ impl Convert for ProtobufConverter {
             NativeResult::ListAuthenticators(result) => Ok(ResponseBody::from_bytes(
                 native_to_wire!(result, list_authenticators_proto::Result),
             )),
+            NativeResult::ListKeys(result) => Ok(ResponseBody::from_bytes(native_to_wire!(
+                result,
+                list_keys_proto::Result
+            ))),
             NativeResult::Ping(result) => Ok(ResponseBody::from_bytes(native_to_wire!(
                 result,
                 ping_proto::Result

src/requests/mod.rs

@@ -111,6 +111,8 @@ pub enum Opcode {
     PsaAeadDecrypt = 18,
     /// PsaRawKeyAgreement operation
     PsaRawKeyAgreement = 19,
+    /// ListKeys operations
+    ListKeys = 26,
 }
 
 /// Listing of available authentication methods.