Generate Strong Name Key File

Posted on  by
Generate Strong Name Key File 7,0/10 992 reviews

At the command prompt, navigate to the location where you want to create the key file. For example, type cd C: Sample, and then press ENTER. At the command prompt, type sn -k key file name.snk, and then press ENTER. At the command prompt, type exit, and then press ENTER. More information: Create a Strong-Name Key File. A drop down box below 'Sign the assembly' checkbox will get enable 'choose a strong name key file' select New in it will ask you for file name pass Edraw.snk to it. If you want the file to be password protected pass the password information to the same dialog box otherwise uncheck the 'protect my key file with a password' checkbox. You are done.

  1. Create Strong Name Key File
  2. Generate Key File From Pem

A drop down box below 'Sign the assembly' checkbox will get enable 'choose a strong name key file' select New in it will ask you for file name pass Edraw.snk to it. If you want the file to be password protected pass the password information to the same dialog box otherwise uncheck the 'protect my key file with a password' checkbox. You are done. Create and use strong-named assemblies.; 3 minutes to read; In this article. A strong name consists of the assembly's identity—its simple text name, version number, and culture information (if provided)—plus a public key and a digital signature.

-->

Note

Although .NET Core supports strong-named assemblies, and all assemblies in the .NET Core library are signed, the majority of third-party assemblies do not need strong names. For more information, see Strong Name Signing on GitHub.

There are a number of ways to sign an assembly with a strong name:

  • By using the Signing tab in a project's Properties dialog box in Visual Studio. This is the easiest and most convenient way to sign an assembly with a strong name.

  • By using the Assembly Linker (Al.exe) to link a .NET Framework code module (a .netmodule file) with a key file.

  • By using assembly attributes to insert the strong name information into your code. You can use either the AssemblyKeyFileAttribute or the AssemblyKeyNameAttribute attribute, depending on where the key file to be used is located.

  • By using compiler options.

You must have a cryptographic key pair to sign an assembly with a strong name. For more information about creating a key pair, see How to: Create a public-private key pair.

Create and sign an assembly with a strong name by using Visual Studio

  1. In Solution Explorer, open the shortcut menu for the project, and then choose Properties.

  2. Choose the Signing tab.

  3. Select the Sign the assembly box.

  4. In the Choose a strong name key file box, choose Browse, and then navigate to the key file. To create a new key file, choose New and enter its name in the Create Strong Name Key dialog box.

Note

In order to delay sign an assembly, choose a public key file.

Create and sign an assembly with a strong name by using the Assembly Linker

At the Developer Command Prompt for Visual Studio, enter the following command:

Generate random api key javascript. al/out:<assemblyName> <moduleName>/keyfile:<keyfileName>

Where:

  • assemblyName is the name of the strongly signed assembly (a .dll or .exe file) that Assembly Linker will emit.

  • moduleName is the name of a .NET Framework code module (a .netmodule file) that includes one or more types. You can create a .netmodule file by compiling your code with the /target:module switch in C# or Visual Basic.

  • keyfileName is the name of the container or file that contains the key pair. Assembly Linker interprets a relative path in relation to the current directory.

The following example signs the assembly MyAssembly.dll with a strong name by using the key file sgKey.snk.

For more information about this tool, see Assembly Linker.

Sign an assembly with a strong name by using attributes

  1. Add the System.Reflection.AssemblyKeyFileAttribute or AssemblyKeyNameAttribute attribute to your source code file, and specify the name of the file or container that contains the key pair to use when signing the assembly with a strong name.

  2. Compile the source code file normally.

    Note

    The C# and Visual Basic compilers issue compiler warnings (CS1699 and BC41008, respectively) when they encounter the AssemblyKeyFileAttribute or AssemblyKeyNameAttribute attribute in source code. You can ignore the warnings.

The following example uses the AssemblyKeyFileAttribute attribute with a key file called keyfile.snk, which is located in the directory where the assembly is compiled.

You can also delay sign an assembly when compiling your source file. For more information, see Delay-sign an assembly.

Sign an assembly with a strong name by using the compiler

Compile your source code file or files with the /keyfile or /delaysign compiler option in C# and Visual Basic, or the /KEYFILE or /DELAYSIGN linker option in C++. After the option name, add a colon and the name of the key file. When using command-line compilers, you can copy the key file to the directory that contains your source code files.

For information on delay signing, see Delay-sign an assembly.

The following example uses the C# compiler and signs the assembly UtilityLibrary.dll with a strong name by using the key file sgKey.snk.

See also

-->Generate Strong Name Key File

The Strong Name tool (Sn.exe) helps sign assemblies with strong names. Sn.exe provides options for key management, signature generation, and signature verification.

Warning

Do not rely on strong names for security. They provide a unique identity only.

For more information on strong naming and strong-named assemblies, see Strong-Named Assemblies and How to: Sign an Assembly with a Strong Name.

The Strong Name tool is automatically installed with Visual Studio. To start the tool, use the Developer Command Prompt (or the Visual Studio Command Prompt in Windows 7). For more information, see Command Prompts.

Note

On 64-bit computers, run the 32-bit version of Sn.exe by using the Developer Command Prompt for Visual Studio and the 64-bit version by using the Visual Studio x64 Win64 Command Prompt.

At the command prompt, type the following:

Syntax

Parameters

OptionDescription
-a identityKeyPairFile signaturePublicKeyFileGenerates AssemblySignatureKeyAttribute data to migrate the identity key to the signature key from a file.
-ac identityPublicKeyFile identityKeyPairContainer signaturePublicKeyFileGenerates AssemblySignatureKeyAttribute data to migrate the identity key to the signature key from a key container.
-c [csp]Sets the default cryptographic service provider (CSP) to use for strong name signing. This setting applies to the entire computer. If you do not specify a CSP name, Sn.exe clears the current setting.
-d containerDeletes the specified key container from the strong name CSP.
-D assembly1 assembly2Verifies that two assemblies differ only by signature. This is often used as a check after an assembly has been re-signed with a different key pair.
-e assembly outfileExtracts the public key from assembly and stores it in outfile.
-hDisplays command syntax and options for the tool.
-i infile containerInstalls the key pair from infile in the specified key container. The key container resides in the strong name CSP.
-k [keysize] outfileGenerates a new RSACryptoServiceProvider key of the specified size and writes it to the specified file. Both a public and private key are written to the file.
If you do not specify a key size, a 1,024-bit key is generated by default if you have the Microsoft enhanced cryptographic provider installed; otherwise, a 512-bit key is generated.
The keysize parameter supports key lengths from 384 bits to 16,384 bits in increments of 8 bits if you have the Microsoft enhanced cryptographic provider installed. It supports key lengths from 384 bits to 512 bits in increments of 8 bits if you have the Microsoft base cryptographic provider installed.
-m [y n]Specifies whether key containers are computer-specific, or user-specific. If you specify y, key containers are computer-specific. If you specify n, key containers are user-specific.
If neither y nor n is specified, this option displays the current setting.
-o infile [outfile]Extracts the public key from the infile and stores it in a .csv file. A comma separates each byte of the public key. This format is useful for hard-coding references to keys as initialized arrays in source code. If you do not specify an outfile, this option places the output on the Clipboard. Note: This option does not verify that the input is only a public key. If the infile contains a key pair with a private key, the private key is also extracted.
-p infile outfile [hashalg]Extracts the public key from the key pair in infile and stores it in outfile, optionally using the RSA algorithm specified by hashalg. This public key can be used to delay-sign an assembly using the /delaysign+ and /keyfile options of the Assembly Linker (Al.exe). When an assembly is delay-signed, only the public key is set at compile time and space is reserved in the file for the signature to be added later, when the private key is known.
-pc container outfile [hashalg]Extracts the public key from the key pair in container and stores it in outfile. If you use the hashalg option, the RSA algorithm is used to extract the public key.
-Pb [y n]Specifies whether the strong-name bypass policy is enforced. If you specify y, strong names for full-trust assemblies are not validated when loaded into a full-trust AppDomain. If you specify n, strong names are validated for correctness, but not for a specific strong name. The StrongNameIdentityPermission has no effect on full-trust assemblies. You must perform your own check for a strong name match.
If neither y nor n is specified, this option displays the current setting. The default is y. Note: On 64-bit computers, you must set this parameter in both the 32-bit and the 64-bit instances of Sn.exe.
-q[uiet]Specifies quiet mode; suppresses the display of success messages.
-R[a] assembly infileRe-signs a previously signed or delay-signed assembly with the key pair in infile.
If -Ra is used, hashes are recomputed for all files in the assembly.
-Rc[a] assembly containerRe-signs a previously signed or delay-signed assembly with the key pair in container.
If -Rca is used, hashes are recomputed for all files in the assembly.
-Rh assemblyRecomputes hashes for all files in the assembly.
-t[p] infileDisplays the token for the public key stored in infile. The contents of infile must be a public key previously generated from a key pair file using -p. Do not use the -t[p] option to extract the token directly from a key pair file.
Sn.exe computes the token by using a hash function from the public key. To save space, the common language runtime stores public key tokens in the manifest as part of a reference to another assembly when it records a dependency to an assembly that has a strong name. The -tp option displays the public key in addition to the token. If the AssemblySignatureKeyAttribute attribute has been applied to the assembly, the token is for the identity key, and the name of the hash algorithm and the identity key is displayed.
Note that this option does not verify the assembly signature and should not be used to make trust decisions. This option only displays the raw public key token data.
-T[p] assemblyDisplays the public key token for assembly. The assembly must be the name of a file that contains an assembly manifest.
Sn.exe computes the token by using a hash function from the public key. To save space, the runtime stores public key tokens in the manifest as part of a reference to another assembly when it records a dependency to an assembly that has a strong name. The -Tp option displays the public key in addition to the token. If the AssemblySignatureKeyAttribute attribute has been applied to the assembly, the token is for the identity key, and the name of the hash algorithm and the identity key is displayed.
Note that this option does not verify the assembly signature and should not be used to make trust decisions. This option only displays the raw public key token data.
-TS assembly infileTest-signs the signed or partially signed assembly with the key pair in infile.
-TSc assembly containerTest-signs the signed or partially signed assembly with the key pair in the key container container.
-v assemblyVerifies the strong name in assembly, where assembly is the name of a file that contains an assembly manifest.
-vf assemblyVerifies the strong name in assembly. Unlike the -v option, -vf forces verification even if it is disabled using the -Vr option.
-Vk regfile.reg assembly [userlist] [infile]Creates a registration entries (.reg) file you can use to register the specified assembly for verification skipping. The rules for assembly naming that apply to the -Vr option apply to –Vk as well. For information about the userlist and infile options, see the –Vr option.
-VlLists current settings for strong-name verification on this computer.
-Vr assembly [userlist] [infile]Registers assembly for verification skipping. Optionally, you can specify a comma-separated list of user names the skip verification should apply to. If you specify infile, verification remains enabled, but the public key in infile is used in verification operations. You can specify assembly in the form *, strongname to register all assemblies with the specified strong name. For strongname, specify the string of hexadecimal digits representing the tokenized form of the public key. See the -t and -T options to display the public key token. Caution: Use this option only during development. Adding an assembly to the skip verification list creates a security vulnerability. A malicious assembly could use the fully specified assembly name (assembly name, version, culture, and public key token) of the assembly added to the skip verification list to fake its identity. This would allow the malicious assembly to also skip verification.
-Vu assemblyUnregisters assembly for verification skipping. The same rules for assembly naming that apply to -Vr apply to -Vu.
-VxRemoves all verification-skipping entries.
-?Displays command syntax and options for the tool.

Note

All Sn.exe options are case-sensitive and must be typed exactly as shown to be recognized by the tool.

Remarks

The -R and –Rc options are useful with assemblies that have been delay-signed. In this scenario, only the public key has been set at compile time and signing is performed later, when the private key is known.

Note

For parameters (for example, –Vr) that write to protected resources such as the registry, run SN.exe as an administrator.

The Strong Name tool assumes that public/private key pairs are generated with the AT_SIGNATURE algorithm identifier. Public/private key pairs generated with the AT_KEYEXCHANGE algorithm generate an error.

Examples

The following command creates a new, random key pair and stores it in keyPair.snk.

The following command stores the key in keyPair.snk in the container MyContainer in the strong name CSP.

The following command extracts the public key from keyPair.snk and stores it in publicKey.snk.

The following command displays the public key and the token for the public key contained in publicKey.snk.

The following command verifies the assembly MyAsm.dll.

Create Strong Name Key File

The following command deletes MyContainer from the default CSP.

Generate Key File From Pem

See also