Export (0) Print
Expand All

Set-AuthenticodeSignature

Published: February 29, 2012

Updated: August 15, 2012

Applies To: Windows PowerShell 2.0, Windows PowerShell 3.0

Set-AuthenticodeSignature

Adds an Authenticode signature to a Windows PowerShell script or other file.

Syntax

Parameter Set: ByPath
Set-AuthenticodeSignature [-FilePath] <String[]> [-Certificate] <X509Certificate2> [-Force] [-HashAlgorithm <String> ] [-IncludeChain <String> ] [-TimestampServer <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: ByLiteralPath
Set-AuthenticodeSignature [-Certificate] <X509Certificate2> -LiteralPath <String[]> [-Force] [-HashAlgorithm <String> ] [-IncludeChain <String> ] [-TimestampServer <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Set-AuthenticodeSignature cmdlet adds an Authenticode signature to any file that supports Subject Interface Package (SIP).

In a Windows PowerShell script file, the signature takes the form of a block of text that indicates the end of the instructions that are executed in the script. If there is a signature in the file when this cmdlet runs, that signature is removed.

Parameters

-Certificate<X509Certificate2>

Specifies the certificate that will be used to sign the script or file. Enter a variable that stores an object representing the certificate or an expression that gets the certificate.

To find a certificate, use Get-PfxCertificate or use the Get-ChildItem cmdlet in the Certificate (Cert:) drive. If the certificate is not valid or does not have code-signing authority, the command fails.


Aliases

none

Required?

true

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-FilePath<String[]>

Specifies the path to a file that is being signed.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-Force

Allows the cmdlet to append a signature to a read-only file. Even using the Force parameter, the cmdlet cannot override security restrictions.


Aliases

none

Required?

false

Position?

named

Default Value

False

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-HashAlgorithm<String>

Specifies the hashing algorithm that Windows uses to compute the digital signature for the file.

For Windows PowerShell 3.0, the default is SHA256, which is the Windows default hashing algorithm. For Windows PowerShell 2.0, the default is SHA1. Files that are signed with a different hashing algorithm might not be recognized on other systems.


Aliases

none

Required?

false

Position?

named

Default Value

SHA256

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IncludeChain<String>

Determines which certificates in the certificate trust chain are included in the digital signature. "NotRoot" is the default.

Valid values are:

-- Signer: Includes only the signer's certificate.

-- NotRoot: Includes all of the certificates in the certificate chain, except for the root authority.

--All: Includes all the certificates in the certificate chain.


Aliases

none

Required?

false

Position?

named

Default Value

NotRoot

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-TimestampServer<String>

Uses the specified time stamp server to add a time stamp to the signature. Type the URL of the time stamp server as a string.

The time stamp represents the exact time that the certificate was added to the file. A time stamp prevents the script from failing if the certificate expires because users and programs can verify that the certificate was valid at the time of signing.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-LiteralPath<String[]>

Specifies the path to a file that is being signed. Unlike FilePath, the value of the LiteralPath parameter is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell Windows PowerShell not to interpret any characters as escape sequences.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see  about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String

    You can pipe a string that contains the file path to Set-AuthenticodeSignature.


Outputs

The output type is the type of the objects that the cmdlet emits.

  • System.Management.Automation.Signature

Examples

-------------------------- EXAMPLE 1 --------------------------

These commands retrieve a code-signing certificate from the Windows PowerShell certificate provider and use it to sign a Windows PowerShell script.

The first command uses the Get-ChildItem cmdlet and the Windows PowerShell certificate provider to get the certificates in the Cert:\CurrentUser\My subdirectory of the certificate store. (The Cert: drive is the drive exposed by the certificate provider.) The CodeSigningCert parameter, which is supported only by the certificate provider, limits the certificates retrieved to those with code-signing authority. The command stores the result in the $cert variable.

The second command uses the Set-AuthenticodeSignature cmdlet to sign the PSTestInternet2.ps1 script. It uses the FilePath parameter to specify the name of the script and the Certificate parameter to specify that the certificate is stored in the $cert variable.


PS C:\> $cert=Get-ChildItem -Path cert:\CurrentUser\my -CodeSigningCert
PS C:\>Set-AuthenticodeSignature -FilePath PsTestInternet2.ps1 -certificate $cert

-------------------------- EXAMPLE 2 --------------------------

These commands use the Get-PfxCertificate cmdlet to find a code signing certificate. Then, they use it to sign a Windows PowerShell script.

The first command uses the Get-PfxCertificate cmdlet to find the C:\Test\MySign.pfx certificate and store it in the $cert variable.

The second command uses Set-AuthenticodeSignature to sign the script. The FilePath parameter of Set-AuthenticodeSignature specifies the path to the script file being signed and the Cert parameter passes the $cert variable containing the certificate to Set-AuthenticodeSignature.

If the certificate file is password protected, Windows PowerShell prompts you for the password.


PS C:\> $cert = Get-PfxCertificate C:\Test\Mysign.pfx
PS C:\>Set-AuthenticodeSignature -Filepath ServerProps.ps1 -Cert $cert

-------------------------- EXAMPLE 3 --------------------------

This command adds a digital signature that includes the root authority in the trust chain, and it is signed by a third-party timestamp server.

The command uses the FilePath parameter to specify the script being signed and the Certificate parameter to specify the certificate that is saved in the $cert variable. It uses the IncludeChain parameter to include all of the signatures in the trust chain (including the root authority). It also uses the TimeStampServer parameter to add a timestamp to the signature. This prevents the script from failing when the certificate expires.


PS C:\> Set-AuthenticodeSignature -filepath c:\scripts\Remodel.ps1 -certificate $cert -IncludeChain All -TimeStampServer "http://timestamp.fabrikam.com/scripts/timstamper.dll"

Related topics



Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft