Skip to content

Corrections to the mage.exe page #45836

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

BartoszKlonowski
Copy link
Contributor

@BartoszKlonowski BartoszKlonowski commented Apr 16, 2025

This pull request fixes #35326
It makes necessary corrections to the mage.exe page such as:

  • removing the misleading statement regarding the -a option with -Sign
  • adding the other now supported options to the -Sign command
    Those newly added are -TimestampUri and -Algorithm. They are mostly copy-paste from the general table, however, I removed "Use with -update option" statement from Algorithm, since I couldn't see that requirement when applying in -Sign context.

Internal previews

📄 File 🔗 Preview link
docs/framework/tools/mage-exe-manifest-generation-and-editing-tool.md Mage.exe (Manifest Generation and Editing Tool)

@BartoszKlonowski BartoszKlonowski requested review from gewarren and a team as code owners April 16, 2025 16:45
@dotnetrepoman dotnetrepoman bot added this to the April 2025 milestone Apr 16, 2025
@dotnet-policy-service dotnet-policy-service bot added dotnet-framework/svc community-contribution Indicates PR is created by someone from the .NET community. labels Apr 16, 2025
Copy link
Contributor

@gewarren gewarren left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

|**-t, -ToFile** `filePath`|Specifies the output path of the file that has been created or modified.|
|**-a, -Algorithm**|Specifies the algorithm to generate dependency digests with. Value must be "sha256RSA" or "sha1RSA.|
Copy link
Contributor

@gewarren gewarren Apr 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|**-a, -Algorithm**|Specifies the algorithm to generate dependency digests with. Value must be "sha256RSA" or "sha1RSA.|
|**-a, -Algorithm**|Specifies the algorithm to generate dependency digests with. The value must be "sha256RSA".|

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you also place this option first so it's alphabetical?

@@ -78,7 +78,9 @@ The following table shows the options supported by the `-Sign` command, which ap
|**-csp, -CryptoProvider** `provider-name`|Specifies the name of a cryptographic service provider (CSP) that contains the private key container. This option requires the **-KeyContainer** option.<br/><br/>This option is available starting with .NET Framework 4.7.|
|**-kc, -KeyContainer** `name`|Specifies the key container that contains the name of the private key. This option requires the **CryptoProvider** option.<br/><br/>This option is available starting with .NET Framework 4.7.|
|**-pwd, -Password** `passwd`|The password that is used for signing a manifest with a digital certificate. Must be used in conjunction with the **-CertFile** option.|
|**-ti, -TimestampUri** `uri`|The URL of a digital timestamping service. Timestamping the manifests prevents you from having to re-sign the manifests should your digital certificate expire before you deploy the next version of your application.|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|**-ti, -TimestampUri** `uri`|The URL of a digital timestamping service. Timestamping the manifests prevents you from having to re-sign the manifests should your digital certificate expire before you deploy the next version of your application.|
|**-ti, -TimestampUri** `uri`|The URL of a digital timestamping service. Timestamping the manifests prevents you from having to re-sign the manifests if your digital certificate expires before you deploy the next version of your application.|

@@ -42,7 +42,7 @@ The following table shows the options supported by the `-New` and `-Update` comm

|Options|Default Value|Applies To|Description|
|-------------|-------------------|----------------|-----------------|
|**-a, -Algorithm**|sha1RSA|Application manifests.<br /><br /> Deployment manifests.|Specifies the algorithm to generate dependency digests with. Value must be "sha256RSA" or "sha1RSA.<br /><br /> Use with the "-Update" option. This option is ignored when using the "-Sign" option|
|**-a, -Algorithm**|sha1RSA|Application manifests.<br /><br /> Deployment manifests.|Specifies the algorithm to generate dependency digests with. Value must be "sha256RSA" or "sha1RSA.<br /><br /> Use with the "-Update" option.|
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|**-a, -Algorithm**|sha1RSA|Application manifests.<br /><br /> Deployment manifests.|Specifies the algorithm to generate dependency digests with. Value must be "sha256RSA" or "sha1RSA.<br /><br /> Use with the "-Update" option.|
|**-a, -Algorithm**|sha1RSA|Application manifests.<br /><br /> Deployment manifests.|Specifies the algorithm to generate dependency digests with. Value must be "sha256RSA" or "sha1RSA".<br /><br /> Use with the "-Update" option.|

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community-contribution Indicates PR is created by someone from the .NET community. dotnet-framework/svc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

mage.exe: documentation does not detail update Sign command in .NET Framework 4.7.2
2 participants