Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Corrected links that should have been relative instead of absolute.

Earlier in the Adeptia Suite, you could not create any separate Truststores. Now you can create separate Keystores and Truststores. A keystore is collection of certificates and private keys. You can use a keystore with your security policies and web service consumer activities. Keystore stores your certificates and private keys that you can give to your client. Whereas, a Truststore stores all your trusted parties' certificates. Adeptia Suite also allows backward compatibility to support all you previously created keystores. However, the Adeptia Suite will treat all of your previous truststores as keystores.

You can create a keystore either manually or by uploading a keystore file. If you want to manually create a keystore then, you need to provide information for many fields. You can find the description about these fields in the table below.

Table 1: Description of Keystore Fields

Keystore Fields

Description

KeyStore Password

Enter a password of your keystore that you want to set

Confirm Password

Confirm the password of your keystore

Private Key Password

Enter a password of your private key that you want to set

Confirm Password

Confirm the password of your private key

Alias

Enter a name for the identity of the keystore that you are creating

Key Algorithm

Select an algorithm to encrypt your keystore. You can choose from either DSA or RSA

Key Size

Specify the encryption key size of the encryption algorithm. The minimum size for DSA is 512 and for RSA is 1024 but we recommend you to use an algorithm of at least 1024 and 2048 key size respectively.

Common Name

Enter a name that you want to associate with the generated certificate, like a name of a person, e.g. "Susan Jones".

Organization Unit

Name of the organization unit where you work

Organization Name

Name of your organization

Locality

Locality of your organization

State

State where your organization is situated

Country

Country where your organization is located

Validity

Enter the number of days for which your keystore will be valid.

Signature Algorithm

Select an algorithm to encrypt your signature. You can choose from SHA1 with DSA, SHA1 with RSA, MD5 with RSA, and RIPEMD160 with RSA.

...

  1. Click the Develop tab and then click Services > Security > Keystore/Truststore. This action will show you the Manage Keystore/Truststore screen (see Figure 365).

    Image Removed

    Figure 365: Manage Keystore/Truststore 

  2. Click the Create New link. This action will show you the Create New Keystore/Truststore screen (see Figure 366).

    Image Removed

    Figure 366: Create New Keystore/Truststore Screen

  3. To create a new keystore enter the name and description of the keystore activity in the Name and Description textboxes respectively.
  4. In the Create field, select the KeyStore radio button.
  5. In the Creation Mode field, select the Upload radio button if you want to create a keystore by uploading a keystore file. Or select the Manual radio button if you want to manually configure a keystore.

    Info

    If you select the Upload radio button then, follow step 6. Alternatively if you select the Manual radio button then, follow 7 - 10 steps.

  6. In the Upload KeyStore field, select the Browse button. In the Choose File to Upload dialog box, navigate to your PKCS12 or JKS keystore file type and select the Open button to upload your keystore file. 

    If you select a keystore file with no extension then, from the Keystore Type dropdown list select the type of keystore (see Figure 367).

    Image Removed

    Figure 367: Keystore Type Dropdown List

  7. Enter the keystore password in KeyStore Password and Confirm Password text boxes.
  8. Enter the private key password in Private Key Password and Confirm Password text boxes.
  9. Enter the values in all the fields as per your requirement and click Save. This action will create a keystore and the private public key pair inside the keystore ( see Figure 368).

    Image Removed

    Figure 368: Manually Configure A Keystore

  10. Click the Save button to save the keystore.
Info

The Adeptia Suite does not support keystore with multiple key entries.

...

Click the Develop tab and then click Services > Security > Keystore/Truststore. This action will show you the Manage Keystore/Truststore screen (see Figure 369).

Image Removed

Figure 369: Manage Keystore/Truststore

...

Click the Create New link. This action will show you the Create New Keystore/Truststore screen (see Figure 370).

Image Removed

Figure 370: Create New Keystore/Truststore Screen

...

In the Upload TrustStore field, select the Browse button. In the Choose File to Upload dialog box, navigate to your JKS truststore file type and select the Open button to upload your truststore file.

Info

Truststore only supports JKS file type.

...

Enter the confirmation password in the Confirm Password textbox.

Info

When you upload a single certificate and enter a password for it then we are creating a truststore.
You can create a truststore with a single certificate.

...

Vault is a repository that keeps confidential information secured in the Database. Vault provides a robust security level, by adding more security while saving and accessing the classified data. Instead of storing information as a plain text, Vault is used to securely save and fetch data in an encrypted form. The services that use Vault includes Database Info, Custom Plugin, Web Service REST Consumer, and Put-Context-Var Action.

Expand
titleCreate Vault and Keys

To create a Vault and define its custom keys to store and fetch the confidential information:

  1. Go to Develop > Services > Security Vault

    Image Added

  2. Click Create New.

    Image Added

  3. Type the name and description of the new Vault.
    Image Added

  4. You can change Vault Alias before you hit Save. Once saved, you cannot modify the field.

    Info
    titleNote

    Vault Alias is a unique field. It holds the parameters which in turn are used to save the confidential information.

  5. Type in a key and its value.

  6. Click Add to add a new Parameter.

    Image Added

  7. Click Image Added to view the hidden values. Click Image Added to mask the password. To delete a parameter, click Image Added in front of it.

    Image Added

  8. Expand Advanced Properties to change the project and owner of this vault. Also provide/update permission of Read, Write, or Execute to Owner, Group, and Others. Click here for more information on how permissions work.
  9. Click Save.
Expand
titleUsing Vault

Anchor
Using_Vault
Using_Vault

After you have created a vault, replace the confidential information while using a service, with the text in the following syntax:

{Vault.aliasName.key}

where,

  • Vault is a keyword (V in 'Vault' is UPPERCASE), preceded by opening curly parentheses.
  • aliasName is the Vault Alias, where the parameter is defined.
  • key is the parameter which stores the confidential information.
  • Finally closed by a closing curly parentheses.
  • A period is used as a separator between Vault and aliasName; and aliasName and key.

You can use Vault to mask the confidential information instead of providing it as a plain text, in the following services:

Expand
titleEdit Vault
  1. Click the Vault Name or, Click Image Added next to the Vault you wish to edit, and select Edit.

    Image Added

    You can edit the information in the window that appears. Note that you CANNOT rename Alias once it is created. Other details that CANNOT be modified are 'Creation Date', 'Modified Date' and, 'Last Modified by'.

    Image Added

  2. Click Save.
Expand
titleView Vault
  1. Click Image Added next to the Vault you wish to view.
  2. Click 'View'. A new window will open up with information about the vault.

    Image Added