File Decryption

A command-line tool to create new files or decrypt files loaded to Title Storage and Player Data Storage.

2 mins to read

You can the File Decryption tool to create new files or decrypt files loaded to Title Storage and Player Data Storage easily and conveniently. To decrypt a file, you need the encryption key and a copy of the encrypted file. Encrypting files requires the same key and the unencrypted file you want to encrypt.

For other tools to access, link, and delete the data stored on your behalf for your users by Epic Online Services, check the Data Rights Services page.

Locate FileDecryptionTool in the SDK distribution and run it from the command line. This tool supports a single-file mode and a directory mode. Single-file mode takes a single input file, encrypts or decrypts it, and outputs the result to another file. Directory mode goes through all files in the target directory and its subdirectories, and places the output files in a duplicate directory structure elsewhere.

Because the tool supports Player Data Storage files as its default type, you will need to use the "-mode title" parameter to enable Title Storage mode. If the tool encounters a Player Data Storage file while in Title Storage mode, or a Title Storage file while in Player Data Storage mode, it will skip over the file and report an error.

Parameter Listing

ParameterEffect
-input (Location)Sets the path to the file (or folder) containing encrypted data to read
-output (Location)Sets the path to the file (or folder) where the decrypted data will be written
-key (EncryptionKey)Sets the encryption key to use for encrypting and decrypting operations; must be in hexadecimal and no more than 64 characters long
-mode (Title or user for Title Storage or Player Data storage mode)Enables Title Storage or Player Data Storage mode (the latter is by default)
-encryptEnables encryption mode, meaning the output files will be encrypted copies of the input files; if not set, the output files will be decrypted copies of the input files

The data format of the input files is unknown to the tool, so providing an incorrect encryption key will not cause an error. However, the output files will be unusable by the application due to the mismatch between keys.

Sample Command Lines

  • FileDecryptionTool -input encrypted_ts_data -output unencrypted_ts_data -key 123abcdef -mode title

  • FileDecryptionTool -input raw_ts_data_file -output encrypted_ts_data_file -key 123abcdef -encrypt -mode title

  • FileDecryptionTool -input encrypted_pds_file -output decrypted_pds_file -key 123abcdef -user 123abcdef

  • FileDecryptionTool -input folder_with_encrypted_pds_files -output folder_with_decrypted_pds_files -key 123abcdef -user 123abcdef