KSS Recovery

There can be only one active instance of a KSS with a given ID. If that instance dies and there is no backup server, the one KSS instance must be recovered.

WARNING: Setting up a new KSS without performing recovery initializes a completely new key, requiring all existing users to re-onboard and sharing operations to be repeated.

Once the recovery procedure has been completed, end users who were previously onboarded with the KSS will continue to function uninterrupted and new end users can be onboard with the existing KSS ID.

Recovery Walkthrough:

  1. If possible, identify the profile ID (4 words with dashes in between) of the KSS server that has failed. It is listed in the settings section of the mobile application.

  2. Retrieve the keyserver.yml policy file from the KSS server that has failed if possible.

  3. Install Atakama on the new server. Do not perform onboarding.

  4. Locate/download and copy the “backup-key.txt” file that was created during the initial KSS installation into the “c:\temp” on the new server.

  5. Copy the keyserver.yml policy file to %localappdata%\Atakama on the new server. If the Atakama folder is missing, you can manually create it.

  6. Load a profile from a device of the target profile by running the following command:

    atakama device add --method qr "My Smartphone"

     Scan the QR code.

  7. Run the following command to list the device list: 

    atakama device list
  8. Run the following command to load a profile from the added device:

    atakama profile recovery load-profiles --device [id]

    Note: Device ID is a 4-word ID from the step above

  9. To list the profiles run: 

    atakama profile recovery list-profiles
  10. Select the needed profile by running: 

    atakama profile recovery select-profile --profile [id]
  11. Run the following command to list the device list from the selected profile: 

    atakama device list
  12. Input the recovery words (14 words or 24 words) into the new computer using this command:

    atakama profile recovery ingest-words [words]
  13. Run the following command to shutdown Atakama background processes:
    atakama --shutdown 
  14. Run the following command to ingest the backup key:

    atakama keyserver recovery-ingest-key c:\temp\backup-key.txt
  15. A MofNop will be sent to ALL the devices associated with the KSS profile (similar to the finalize MofNop). 

  16. Approve the MofNop.

  17. Run the following command to shutdown Atakama background processes:
    atakama --shutdown 
  18. Run the following command to finalize the recovery process:

    atakama profile recovery finalize
  19. Approve the MofNop.

  20. You can now add the Secure Folder(s) and launch Atakama normally.

  21. Add the License Key after executing the following command:
    atakama settings update-license 
  22. Run the following command to initialize the KSS:
    For Atakama versions prior to Quantum Quetzalcoatl run the following command:
    On a regular Keyserver

    atakama keyserver enable --backup-path %homepath%\Atakama\backup-key.txt 

    For Atakama versions of Quantum Quetzalcoatl and newer run the following command:
    On a regular Keyserver:

     atakama keyserver create --backup-path %homepath%\backup-key 

    On Cluster Mode:
    To load the policy file to the database and update the ruleset

     atakama keyserver create --db-uri "mysql:host=[IP ADDRESS from the machine with MySQL],port=3306,user=[User],password=[Password assigned to that user],database=cvfs


    Run the following command to load the policy file to the database and update the ruleset:

    atakama keyserver policy --load 


Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.