This topic has not yet been rated - Rate this topic

CSEncrypt Command-Line Tool

Updated: June 7, 2012

The CSEncrypt Command-Line Tool (CSEncrypt.exe) encrypts a password that is associated to a user account used in remote desktop connections.

Tool Location

If you installed Windows Azure SDK version 1.7 or greater to the default location, CSEncrypt can be found in the C:\Program Files\Microsoft SDKs\Windows Azure\.NET SDK\2012-06\bin folder. In Windows Azure SDK version 1.6 or earlier, CSEncrypt is installed to the C:\Program Files\Windows Azure SDK\<sdk version>\bin\ folder.

Command Line Syntax

CSEncrypt [options] [parameters]

Options

The following table lists the options for CSEncrypt. To view the most current option list, type CSEncrypt Get-Help at a Windows Azure SDK command prompt.

Option

Description

Encrypt-Password

Encrypts a password that is used to access a role instance through a remote desktop connection.

Note
If input to CSEncrypt is redirected from stdin, CSEncrypt reads one line of input and encrypts the result. If the input is from text typed in the command-prompt window, CSEncrypt requests the password to be entered and verified. The following parameters are used to encrypt a password:

–CopyToClipboard – (Optional) Specifies that the encrypted string be placed on the system clipboard.
–Output <string> – (Optional) Specifies that the output of the command be redirected to a file.
–SkipComplexityCheck – (Optional) Specifies that the strength of the password should not be checked.
–Thumbprint <string> – Specifies the thumbprint of the service certificate of the hosted service for which a remote desktop connection is needed. For more information about creating certificates and obtaining the thumbprint of a certificate, see Create a Service Certificate for Windows Azure. You can use the New-PasswordEncryptionCertificate option of CSEncrypt to create the certificate.

Get-PasswordEncryptionCertificate

Queries the personal certificate store and enumerates all of the certificates that are usable for encryption. The following table lists the output of this option:

FriendlyName	The label that is provided for the certificate to be easily recognized.
Thumbprint	The thumbprint that is used to identify the certificate.
Subject	The canonical name of the certificate.
IssuedBy	The entity that issued the certificate.
Validfrom	The date on which the certificate was created.
ValidTo	The date on which the certificate expires.
HasPrivateKey	Either True or False to indicate whether the certificate includes a private key.

The following parameters are used to get certificate information:

–Thumbprint <string> – (Optional) Specifies the thumbprint of the service certificate for which information is queried. If this option is not specified, all of the certificates that are suitable for encryption are listed.

New-PasswordEncryptionCertificate

Create a new certificate that can be used to encrypt a password for a remote desktop connection. The following parameters are used to create a new certificate:

–CopyToClipboard – (Optional) Specifies that the encrypted string be placed on the system clipboard.
–FriendlyName <string> – The name that is used to easily identify the certificate.

Community Additions

ADD

CSEncrypt Command-Line Tool

See Also

Concepts

Community Additions