Generate Key Files

 

Declaration

<AMGENERATEKEYFILES KEYCONTAINERNAME="Filename"KEYCONTAINERLEVEL="text [options]" PRIKEYFILE="Keyname" PUBKEYFILE="Keyname"/>

See Also

Delete Key Container | Create Key Container |  Generate Key Files | Sign | Verify | Encrypt | Decrypt | Generate Password | Compress Files | Decompress Files | Write to File | Calculate File Checksum | Set Attributes

Description

Generates public and private key files from the specified key container.

Practical Usage

This action can be used as a task step following Create Key Container action to properly generate public and private key files. Other cryptography actions (i.e. Sign and Encrypt actions) can follow this step allowing the procedure of encrypting and decrypting files to be fully automated.

Parameters

General Properties

Property

Type

Required

Default

Markup

Description

Key Container Name

Text

Yes

(Empty)

KEYCONTAINERNAME="Automate"

Specifies the name of the key container to identify which public/private key to use. Clicking the Select Key Container button will open a key container browser in which to select a container from.

Key Container Level

Text (Options)

Yes

User

KEYCONTAINERLEVEL="MACHINE"

 

Specifies whether to use a machine-level or user-level RSA key container. Microsoft Windows makes machine-level key containers available to all users, whereas a user-level key container is available only to the user that created (or imported) the key container. This parameter is active only if the Decrypt using parameter is set to Key Container. The available options are:

  • User (Default)

  • Machine

Public key file

Text

Yes

(Empty)

PUBKEYFILE="c:\publicfile.pub"

Specifies the path and file name of the public key to be generated.

Overwrite if public key file exists

Yes/No

No

No

OVERWRITEPUBKEYFILE="YES"

If set to YES, Indicate that if a public key file with the same name already exists within the location where the new public key will be stored, the existing key will be overwritten.

Private key file

Text

Yes

(Empty)

PRIKEYFILE="c:\privatefile.pri"

Specifies the path and file name of the private key to be generated.

Overwrite Private key file

Yes/No

No

No

OVERWRITEPRIKEYFILE="YES"

If set to YES, indicate that if a private key file with the same name already exists within the location where the new private key will be stored, the existing key will be overwritten.

↑ Top of Page 

Comparing Machine-Level and User-Level RSA Key Containers

User-level RSA key containers are stored with the Windows user profile for a particular user and can be used to encrypt and decrypt information for applications that run under that specific user identity. User-level RSA key containers can be useful if you want to ensure that the RSA key information is removed when the Windows user profile is removed. However, because you must be logged in with the specific user account that makes use of the user-level RSA key container in order to encrypt or decrypt protected configuration sections, they are inconvenient to use.

Machine-level RSA key containers are available to all users that can log in to a computer, by default, and are the most useful as you can use them to encrypt or decrypt protected configuration sections while logged in with an administrator account. A machine-level RSA key container can be used to protect information for a single application, all the applications on a server, or a group of applications on a server that run under the same user identity. Although machine-level RSA key containers are available to all users, they can be secured with NTFS Access Control Lists (ACLs) so that only required users can access them.

Description Properties

The Description tab allows you to customize the text description of any step as it appears in the Task Builder's Steps Pane.

More on setting custom step description

Error Causes Properties

The Error Causes tab properties lets you instruct a task step to react only to specific errors or ignore certain errors that should cause it to fail.

More on Error Causes properties

On Error Properties

The On Error tab properties lets you determine what the task should do if a particular step encounters an error as defined in the Error Causes properties.

More about On Error properties

Additional Notes

Expressions, Variables & Functions

A percent sign is used as a special character in AutoMate to indicate the beginning and end of an expression. This allows variables, functions and other expressions to be entered in any text parameter of a task's properties. For example: %1+1% inside a task will resolve to 2 at runtime. A more elaborate example is %FileDateTime(myFile)% which results to the date/time of myFile. To help construct expressions, you can open Expression Builder by clicking the Insert Expression (%) button or by pressing F2.

More on expressions

More on variables

More on functions

More on extended functions
More on the expression builder

Example

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

 

Example 1 - Generate USER Level Key Files

 

<AMDELETEKEYCONTAINER KEYCONTAINERNAME="marie.black" KEYCONTAINERLEVEL="USER" />

 

 

Example 2 - Generate MACHINE Level Key Files

 

<AMDELETEKEYCONTAINER KEYCONTAINERNAME="JavaWebStart" KEYCONTAINERLEVEL="MACHINE" />

 

↑ Top of Page