Bootstrapper.DigitalSignature.Apply hide console output

[Lechl]

Hello Oleg,

i'm using AppVeyor for automated builds. I have a bootstrapper which i sign with a pfx certificate. Works perfect!

But in the AppVeyor build i see the console output of the signtool. This is bad for me because I have no option to suppress the log showing the password of the certificate.

Few enhancement options are: Replace the password always with something like '*****', or add an parameter hiddenLog with default value to the Sign function. Or maybe add a ApplySilent function.

What do you think?

[oleg-shilo]

The easiest way for you is to override DidgitalSignature.Apply and do your silent signing.

As a starting point you can use the current implementation:

public virtual int Apply(string fileToSign)
{
    var retValue = CommonTasks.Tasks.DigitalySign(fileToSign, 
                                                  PfxFilePath, 
                                                  TimeUrl?.AbsoluteUri, 
                                                  Password,
                                                  PrepareOptionalArguments(), 
                                                  WellKnownLocations, 
                                                 UseCertificateStore);

    Console.WriteLine(retValue != 0
        ? $"Could not sign the {fileToSign} file."
        : $"The file {fileToSign} was signed successfully.");

    return retValue;
}

Where,

wixsharp/Source/src/WixSharp/CommonTasks.cs

Line 182 in a2c1a72

static public int DigitalySign(string fileToSign, string pfxFile, string timeURL, string password,

However in the next release you will have the possibility to modify (or even clear) the output content before it is displayed in the console:

ExternalTool.ConsoleOut = (line) => Console.WriteLine(line.Replace("secret", "******"))

[Lechl]

Thank you Oleg!

[oleg-shilo]

👍

[dguder]

I also want to have the password hidden. But I don't understand your proposal.
From my point of view the line L1612 in CommonTasks.ExternalTool() is the point where the password will be written to log/output. And this is not handled by the new log handler. BTW: The signtool.exe log doesn't display any passwords.
So for the moment a "simple" override doesn't help. IMHO ExternalTool() and DigitalySign(...) must be changed.

[oleg-shilo]

Don't I look silly now? I have just released half-done re-implementation of already existing feature.
There was no need for that release. The feature was already available all along.

@Lechl this message is also important for you.

You are absolutely right. This is the line you are referring to:

Compiler.OutputWriteLine("Execute:\n\"" + this.ExePath + "\" " + this.Arguments);

And the default value of Compiler.OutputWriteLine is

class Compiler
{
    public static Action<string> OutputWriteLine = Console.WriteLine;
    . . . 

Thus if you use it as is it will just print the output (e.g. signtool.exe) without any changes. However you can assign it to a new handler that can process the output or even completely "swallow" it.

Compiler.OutputWriteLine = (line)=>{};

I will try to re-release and revoke the change later this week.

Thank you.

[Lechl]

Oh god, we all overlooked this. Thank's @oleg-shilo! Can be closed.

[oleg-shilo]

After further considerations I decided to keep that additional output filtering as it allows output massaging per ExternalTool instance. This in turn let me mask the password specifically in the signing routine.

var tool = new ExternalTool
{
    WellKnownLocations = wellKnownLocations ?? @"C:\Program Files\Microsoft SDKs\Windows\v6.0A\bin;" +
    ...
    ExePath = "signtool.exe",
    Arguments = sha1,
    ConsoleOut = (line) => Compiler.OutputWriteLine(line.Replace(password, "***"))
}

Meaning that from the next release you may remove Compiler.OutputWriteLine = (line)=>{}; as the password will be masked automatically.

[dguder]

Thx @oleg-shilo. I'm sorry, I did not look into Compiler.OutputWriteLine() so I overlooked this too.
And 👍 for the default masking of the password.

With following defined before signature.Apply(exe) the password will be hidden:

Compiler.OutputWriteLine = (line) => Console.WriteLine(line.Replace(secret, "******"));

[oleg-shilo]

To: @Lechl

Hi Dominic, can you please give me some details on your use of AppVeyor. I am evaluating it for the commercial product CI and want to avoid problems that you have described.

My question are:

• Do you use AppVeyor free or commercial account?
• If it is a commercial account, does it mean that the log/output details are still exposed publicly?

Thank you
Oleg

[Lechl]

@oleg-shilo

• I'm using commercial account.
• No, them are not desposed publicly. But in our case not everyone who has access to the account should have access to the private key.

The default masking is very good, so no one has the chance to get the password via changing the code (eg. remove the Compiler.OutputWriteLine = (line)=>{};)

[oleg-shilo]

Great, thank you.