You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/ide/how-to-sign-application-and-deployment-manifests.md
+25-17Lines changed: 25 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,7 @@
1
1
---
2
2
title: 'How to: Sign application and deployment manifests'
3
3
description: Learn about requirements for signing for publishing ClickOnce application and deployment manifests. Signing is optional for .exe-based applications.
4
-
ms.custom: SEO-VS-2020
5
-
ms.date: 11/04/2016
4
+
ms.date: 09/12/2022
6
5
ms.technology: vs-ide-deployment
7
6
ms.topic: conceptual
8
7
helpviewer_keywords:
@@ -27,6 +26,8 @@ ms.workload:
27
26
28
27
If you want to publish an application by using ClickOnce deployment, the application and deployment manifests must be signed with a public/private key pair and signed using Authenticode technology. You can sign the manifests by using a certificate from the Windows certificate store or a key file.
29
28
29
+
The information in this article applies only if you're using the .NET Framework 4.7.2 or earlier. If you're using .NET 5 or later, follow the steps in [Deploy a .NET Windows desktop application using ClickOnce](../deployment/quickstart-deploy-using-clickonce-folder.md).
30
+
30
31
For more information about ClickOnce deployment, see [ClickOnce security and deployment](../deployment/clickonce-security-and-deployment.md).
31
32
32
33
Signing the ClickOnce manifests is optional for *.exe*-based applications. For more information, see the "Generate unsigned manifests" section of this document.
@@ -38,50 +39,57 @@ For information about creating key files, see [How to: Create a public-private k
38
39
39
40
## Sign using a certificate
40
41
42
+
To use this method, you must have a certificate signed by a certificate authority (CA). Certificates are issued by third-party certification service providers, or by authorized organizations within an Enterprise.
43
+
41
44
1. Go to the project properties window (right-click the project node in **Solution Explorer** and select **Properties**). On the **Signing** tab, select the **Sign the ClickOnce manifests** check box.
42
45
43
-
2. Click the **Select from Store** button.
46
+
1. Click the **Select from Store** button.
44
47
45
48
The **Select a Certificate** dialog box appears and displays the contents of the Windows certificate store.
46
49
47
50
> [!TIP]
48
51
> If you click **Click here to view certificate properties**, the **Certificate Details** dialog box appears. This dialog box includes detailed information about the certificate and additional options. Click **Certificates** to view additional help information.
49
52
50
-
3. Select the certificate that you want to use to sign the manifests.
53
+
1. Select the certificate that you want to use to sign the manifests.
51
54
52
-
4. Additionally, you can specify the address of a timestamp server in the **Timestamp server URL** text box. This is a server that provides a timestamp specifying when the manifest was signed.
55
+
> [!TIP]
56
+
> If there aren't any certificates in the store, you can still [sign using a test certificate](#sign-using-a-test-certificate).
57
+
58
+
1. Additionally, you can specify the address of a timestamp server in the **Timestamp server URL** text box. This is a server that provides a timestamp specifying when the manifest was signed. It's usually provided by the same third party that offers certificates signed by a CA.
53
59
54
60
## Sign using an existing key file
55
61
56
62
1. On the **Signing** page, select the **Sign the ClickOnce manifests** check box.
57
63
58
-
2. Click the **Select from File** button.
64
+
1. Click the **Select from File** button.
59
65
60
66
The **Select File** dialog box appears.
61
67
62
-
3. In the **Select File** dialog box, browse to the location of the key file (*.pfx*) that you want to use, and then click **Open**.
68
+
1. In the **Select File** dialog box, browse to the location of the key file (*.pfx*) that you want to use, and then click **Open**.
63
69
64
70
> [!NOTE]
65
71
> This option supports only files that have the *.pfx* extension. If you have a key file or certificate in another format, store it in the Windows certificate store and select the certificate is described in the previous procedure. The selected certificate's purpose should include code signing.
66
72
67
73
The **Enter password to open file** dialog box appears. (If the *.pfx* file is already stored in your Windows certificate store or is not password protected, you aren't prompted to enter a password.)
68
74
69
-
4. Enter the password to access the key file, and then select **Enter**.
75
+
1. Enter the password to access the key file, and then select **Enter**.
70
76
71
77
> [!NOTE]
72
78
> The *.pfx* file cannot include certificate chaining information. If it does, the following import error will occur: **Cannot find the certificate and private key for decryption**. To remove the certificate chaining information, you can use *Certmgr.msc* and [disable the option](/previous-versions/aa730868(v=vs.80)) to **Include all certificates** when exporting the *.pfx file.
73
79
74
80
## Sign using a test certificate
75
81
82
+
Test certificates are not signed by a Certificate Authority (CA) and should only be used for testing purposes. For details on test certificates, see [How using certificates authorities helps users](../deployment/clickonce-and-authenticode.md#how-using-certificate-authorities-helps-users).
83
+
76
84
1. On the **Signing** page, select the **Sign the ClickOnce manifests** check box.
77
85
78
-
2. To create a new certificate for testing, click the **Create Test Certificate** button.
86
+
1. To create a new certificate for testing, click the **Create Test Certificate** button.
79
87
80
-
3. In the **Create Test Certificate** dialog box, enter a password to help secure your test certificate.
88
+
1. In the **Create Test Certificate** dialog box, enter a password to help secure your test certificate.
81
89
82
90
## Generate unsigned manifests
83
91
84
-
Signing the ClickOnce manifests is optional for *.exe*-based applications. The following procedures show how to generate unsigned ClickOnce manifests.
92
+
Signing the ClickOnce manifests is optional for `.exe`-based applications. The following procedures show how to generate unsigned ClickOnce manifests.
85
93
86
94
> [!IMPORTANT]
87
95
> Unsigned manifests can simplify development and testing of your application. However, unsigned manifests introduce substantial security risks in a production environment. Only consider using unsigned manifests if your ClickOnce application runs on computers within an intranet that is completely isolated from the internet or other sources of malicious code.
@@ -90,24 +98,24 @@ By default, ClickOnce automatically generates signed manifests unless one or mor
90
98
91
99
### To generate unsigned manifests and include all files in the generated hash
92
100
93
-
1.To generate unsigned manifests that include all files in the hash, you must first publish the application together with signed manifests. Therefore, first sign the ClickOnce manifests by following one of the previous procedures, and then publish the application.
101
+
To generate unsigned manifests that include all files in the hash, you must first publish the application together with signed manifests. Therefore, first sign the ClickOnce manifests by following one of the previous procedures, and then publish the application.
94
102
95
-
2. On the **Signing**page, clear the **Sign the ClickOnce manifests** check box.
103
+
1. On the **Signing**tab, clear the **Sign the ClickOnce manifests** check box.
96
104
97
-
3. Reset the publish version so that only one version of your application is available. By default, Visual Studio automatically increments the revision number of the publish version every time that you publish an application. For more information, see [How to: Set the ClickOnce publish version](../deployment/how-to-set-the-clickonce-publish-version.md).
105
+
1. On the **Publish** tab, reset the publish version so that only one version of your application is available. Clear the checkbox for **Automatically increment the version with each publish**. By default, Visual Studio automatically increments the revision number of the publish version every time that you publish an application. For more information, see [How to: Set the ClickOnce publish version](../deployment/how-to-set-the-clickonce-publish-version.md).
98
106
99
-
4. Publish the application.
107
+
1. Publish the application. Visual Studio tells you that the application was signed with a different key than the existing application on the server, and asks if you want to overwrite it. Choose **Yes**.
100
108
101
109
### To generate unsigned manifests and exclude one or more files from the generated hash
102
110
103
111
1. On the **Signing** page, clear the **Sign the ClickOnce manifests** check box.
104
112
105
-
2. Open the **Application Files** dialog box and set the **Hash** to **Exclude** for the files that you want to exclude from the generated hash.
113
+
1. On the **Publish** tab, choose the **Application Files**button to open the **Application Files**dialog box, and set the **Hash** to **Exclude** for the files that you want to exclude from the generated hash.
106
114
107
115
> [!NOTE]
108
116
> Excluding a file from the hash configures ClickOnce to disable automatic signing of the manifests, so you do not need to first publish with signed manifests as shown in the previous procedure.
0 commit comments