Cryptography - Delete

Declaration

<AMCRYPTOGRAPHY ACTIVITY="delete" KEYCONTAINERNAME="text" 
KEYCONTAINERLEVEL="text (options)" />

Description: Deletes a previously created User-Level or Machine-Level key container.

General Parameters

Property

Type

Required

Default

Markup

Description

Key Container Name

Text

Yes

(Empty)

KEYCONTAINERNAME="Automate"

Indicates the name of the key container to identify which private or public key to use. You must select the key container by clicking on Select Key Container Button.

Key Container Level

Text

No

User

  1. KEYCONTAINERLEVEL="user"

  2. KEYCONTAINERLEVEL="machine"

Specifies whether the key container to delete is set to User-Level or Machine-Level. The available options are:

  • User (Default)

  • Machine

More details regarding Machine-Level and User-Level key containers can be found below.

Description tab - A custom description can be provided on the Description tab to convey additional information or share special notes about a task step.

Error Causes tab - Specify how this step should behave upon the occurrence of an error. (Refer to Task Builder > Error Causes Tab for details.)

On Error tab - Specify what AWE should do if this step encounters an error as defined on the Error Causes tab. (Refer to Task Builder > On Error Tab for details.)

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 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.

Examples

The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.

Example 1: Delete USER Level Key Container

<AMCRYPTOGRAPHY ACTIVITY="delete" KEYCONTAINERNAME="AutoMate" 
KEYCONTAINERLEVEL="user" />

Example 2: Delete MACHINE Level Key Container

<AMCRYPTOGRAPHY ACTIVITY="delete" KEYCONTAINERNAME="AutoMate" 
KEYCONTAINERLEVEL="machine" />