Create the Main Key

Admin Interface

In general, when using pre-packaged applications and the standard Aspire Admin interface (i.e. http://localhost:50505), all password encryption will be handled automatically. All passwords will be encrypted when stored in the relational database or in configuration files on disk.

---

All password encryption / decryption is based on a master passwordmain key. Use the following steps to create the master passworda new random main key:

1. Go to ASPIRE_HOME
2. Run bin\createMaster.bat/generateMasterKeyFile. This script creates an encrypted master main password file (in the config/passwords security directory). This file will contain a random key used to decrypt passwords inside Aspire.

NoteNotes:

• The Master main key file must be secured by the operating system. This means that administrators should grant "read" access only to the user running Aspire.
• The main key file path value is stored inside the settings file as a property called "masterKeyFilePath"
  
  

Note
title Important security concern
If you skip this step, all of the encryption on Aspire will use the default main key, which comes with all Aspire Distributions. All of your encrypted passwords will be exposed (to be decrypted in any other Aspire Distribution). Using a main Key is extremely important to prevent this exposure.

Password Encryption Aspire Administration UI

If you want to secure Aspire access to the Administration UI using the ConfigFile method, the best and most secure way is by encrypting the passwords. Complete the following steps.

1. Run bin/encryptPassword. This script will create passwords of the "administrator" and "developer" users to be encrypted inside the settings.xml file when you use the optional "username" parameter.

2. Enable the ConfigFile authentication on the settings.xml file:

   Code Block
   title settings.xml
   <authentication> <type>ConfigFile</type> </authentication>

3. Start Aspire and use the "administrator" or "developer" users to log in using the recently added passwords.
   
   

Password Encryption for Maven Repositories and Custom Applications

You always need to encrypt your password to Aspire Maven repository. Also If you are creating a custom application which requires password encryption, you may need to encrypt it. In both cases, use the "encryptPassword" script.

• The encrypted password will be stored as a property in the settings.xml file..
• In case of Maven repository you might need to copy the encrypted password from the property to the "remoteRepository/password" element in settings.xml.
• In case of custom application the property should The property should then be specified to the appropriate component's configuration in the application.xml file.

To use password encryption, follow these instructions:complete the following steps.

1. Run bin\/encryptPassword.bat. This script will prompt for the password you need to encrypt, and a property name where the encrypted password will be stored. This property is an optional username. The password is as the property with the name passwordEncrypted written to the Aspire settings.xml file. When you specify the username then the name of the property will be usernamePassword.
   
2. Reference the created property from the component's configuration using ${propertyName} syntax.
3. Make sure your component allows password encryption.

Important

Notes

By default, Aspire

uses a secret pre-configured

main key unless an administrator uses

generateMasterKeyFile to create a new one.