Change secret extensions to emit secret without JSON wrapping

Author: Steve Lee (POWERSHELL HE/HIM) (from Dev Box)

dsc/tests/dsc_functions_secret.tests.ps1 dsc/tests/dsc_extension_secret.tests.ps1dsc/tests/dsc_functions_secret.tests.ps1 renamed to dsc/tests/dsc_extension_secret.tests.ps1

@@ -9,7 +9,20 @@ use schemars::JsonSchema;
 use std::{fmt::Display, path::Path};
 use tracing::{debug, info, trace};
 
-use crate::{discovery::command_discovery::{load_manifest, ImportedManifest}, dscerror::DscError, dscresources::{command_resource::{invoke_command, process_args}, dscresource::DscResource}, extensions::{import::ImportArgKind, secret::SecretResult}};
+use crate::{
+    discovery::command_discovery::{
+        load_manifest, ImportedManifest
+    },
+    dscerror::DscError,
+    dscresources::{
+        command_resource::{
+            invoke_command,
+            process_args
+        },
+        dscresource::DscResource
+    },
+    extensions::import::ImportArgKind
+};
 
 use super::{discover::DiscoverResult, extension_manifest::ExtensionManifest, secret::SecretArgKind};
 
@@ -232,18 +245,8 @@ impl DscExtension {
                 info!("{}", t!("extensions.dscextension.secretNoResults", extension = self.type_name));
                 Ok(None)
             } else {
-                let result: SecretResult = match serde_json::from_str(&stdout) {
-                    Ok(value) => value,
-                    Err(err) => {
-                        return Err(DscError::Extension(t!("extensions.dscextension.secretExtensionReturnedInvalidJson", extension = self.type_name, error = err).to_string()));
-                    }
-                };
-                if result.secure_string.is_some() {
-                    debug!("{}", t!("extensions.dscextension.extensionReturnedSecret", extension = self.type_name));
-                } else {
-                    debug!("{}", t!("extensions.dscextension.extensionReturnedNoSecret", extension = self.type_name));
-                }
-                Ok(result.secure_string)
+                debug!("{}", t!("extensions.dscextension.extensionReturnedSecret", extension = self.type_name));
+                Ok(Some(stdout))
             }
         } else {
             Err(DscError::UnsupportedCapability(

dsc_lib/src/extensions/dscextension.rs

@@ -30,9 +30,3 @@ pub struct SecretMethod {
     /// The arguments to pass to the command to perform a Get.
     pub args: Option<Vec<SecretArgKind>>,
 }
-
-#[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
-pub struct SecretResult {
-    #[serde(rename = "secureString")]
-    pub secure_string: Option<String>,
-}

dsc_lib/src/extensions/secret.rs

@@ -1,5 +1,5 @@
 {
-    "$schema": "https://aka.ms/dsc/schemas/v3/bundled/resource/manifest.json",
+    "$schema": "https://aka.ms/dsc/schemas/v3/bundled/extension/manifest.json",
     "type": "Microsoft.DSC.Extension/Bicep",
     "version": "0.1.0",
     "description": "Enable passing Bicep file directly to DSC, but requires bicep executable to be available.",

extensions/bicep/bicep.dsc.extension.json

@@ -43,10 +43,8 @@ function get-secret($hashtable, $name, $vault) {
     return $null
 }
 
-$secret = if ($Second) {
+if ($Second) {
     get-secret -hashtable $secretTwo -name $Name -vault $Vault
 } else {
     get-secret -hashtable $secretsOne -name $Name -vault $Vault
 }
-
-@{ secureString = $secret } | ConvertTo-Json -Compress | Write-Output

extensions/test/secret/secret.ps1

@@ -1,8 +1,8 @@
 {
-    "$schema": "https://aka.ms/dsc/schemas/v3/bundled/resource/manifest.json",
+    "$schema": "https://aka.ms/dsc/schemas/v3/bundled/extension/manifest.json",
     "type": "Test/Secret",
     "version": "0.1.0",
-    "description": "Example secret resource for testing.",
+    "description": "Example secret extension for testing.",
     "secret": {
         "executable": "pwsh",
         "args": [

extensions/test/secret/testSecret.dsc.extension.json

@@ -1,8 +1,8 @@
 {
-    "$schema": "https://aka.ms/dsc/schemas/v3/bundled/resource/manifest.json",
+    "$schema": "https://aka.ms/dsc/schemas/v3/bundled/extension/manifest.json",
     "type": "Test/Secret2",
     "version": "0.1.0",
-    "description": "Duplicate secret resource for testing.",
+    "description": "Duplicate secret extension for testing.",
     "secret": {
         "executable": "pwsh",
         "args": [