You will need roughly 2 minutes to read this article.
Decrypt a file using an AES key
jet decrypt /path/to/input_encrypted_file /path/to/output_file [flags]
| Name, shorthand | Default | Description |
|---|---|---|
| --key-path | codeship.aes | The key path for encrypting secure environment variables. |
The jet decrypt function will take any encrypted file as input, and output a decrypted file using the key found in your Project Settings.
If you encounter the error No AES key provided, and you have already downloaded the key, verify that the file is named codeship.aes and in the same directory where you are executing jet decrypt, or you are passing in the correct key-path value.
As of jet version 2.6.0 all newly encrypted files are also signed with a checksum during encryption. This allows Codeship to verify that both the key used to decrypt the file is the same as was used to encrypt it, as well as that the encrypted data itself has not been tampered with. Signed encrypted files all contain the value codeship:v2 at the head of the file.
During decryption, the checksum encoded in the file will be compared with a new checksum generated against the decoded data. In case of a checksum mismatch you will see the following error:
checksum for decrypted data is invalid, corrupt AES key or data
If you see this error this means that either the wrong key is being used to try and decrypt the data, or the encrypted data itself has been corrupted or tampered with.
This version of jet decrypt is backwards compatible with the previous version of encrypted file data so no action is required if you do not wish to take advantage of this new version of jet encrypt.
See the section on encryption for more information.
$ jet decrypt env.encrypted env
This will create env from the env.encrypted file using the key in the codeship.aes file.
$ jet decrypt env.encrypted env --key-path PATH_TO_AES_KEY
This will create env from the env.encrypted file using the key located at PATH_TO_AES_KEY.
Contact our support team or post on Stack Overflow using the tag #codeship. Did you check the status page and changelog?
There are also several code examples and sample projects available for you to get started with.
Does this article need improvement? If so, please send feedback or submit a pull request!