Decrypt File
Decrypt a file.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
path | str | null | Path to encrypted input file |
output | str, None | None | Path to decrypted output file |
param path: | Path to encrypted input file |
---|---|
param output: | Path to decrypted output file |
return: | Path to the decrypted file |
If no output path is given, it will generate one from the input path. The resulting output path is returned.
Examples
Use encryption key ${key}
${path}= Decrypt file orders.xlsx.enc
Log Path to decrypted file is: ${path}
Decrypt String
Decrypt a string.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
data | bytes, str | null | Encrypted data as base64 string |
encoding | str | utf-8 | Original encoding of string |
param data: | Encrypted data as base64 string |
---|---|
param encoding: | Original encoding of string |
return: | Decrypted string or raw bytes, if None given as encoding |
Returns the decrypted string that is parsed with the given encoding, or if the encoding is None the raw bytes are returned.
Examples
Use encryption key ${key}
${text}= Decrypt string ${token}
Log Secret string is: ${text}
Encrypt File
Encrypt a file.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
path | str | null | Path to source input file |
output | str, None | None | Path to encrypted output file |
param path: | Path to source input file |
---|---|
param output: | Path to encrypted output file |
return: | Path to the encrypted file |
If no output path is given, it will generate one from the input path. The resulting output path is returned.
Examples
Use encryption key ${key}
${path}= Encrypt file orders.xlsx
Log Path to encrypted file is: ${path}
Encrypt String
Encrypt a string.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
text | bytes, str | null | Source text to encrypt |
encoding | str | utf-8 | Used text encoding |
param text: | Source text to encrypt |
---|---|
param encoding: | Used text encoding |
return: | Token of the encrypted string in bytes |
Examples
Use encryption key ${key}
${token}= Encrypt string This is a secret, don't share it
Generate Key
Generate a Fernet encryption key as base64 string.
return: | Generated key as a string |
---|
This key can be used for encryption/decryption operations with this library.
NOTE: Store the generated key in a secure place! If the key is lost, the encrypted data can not be recovered. If anyone else gains access to it, they can decrypt your data.
Hash File
Calculate a hash from a file, in base64 format.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
path | str | null | Path to file |
method | Hash | SHA1 | The used hashing method |
param path: | Path to file |
---|---|
param method: | The used hashing method |
return: | Hash digest of the file |
Examples
${digest}= Hash file orders.xlsx method=MD5
Should not be equal ${digest} uSlyRHlbu8NzY29YMZhDUpdErP4=
Hash String
Calculate a hash from a string, in base64 format.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
text | str | null | String to hash |
method | Hash | SHA1 | Used hashing method |
encoding | utf-8 | Used text encoding |
param text: | String to hash |
---|---|
param method: | Used hashing method |
param encoding: | Used text encoding |
return: | Hash digest of the string |
Examples
${digest}= Hash string A value that will be hashed
Should be equal ${digest} uSlyRHlbu8NzY29YMZhDUpdErP4=
Use Encryption Key
Set key for all following encryption/decryption operations.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
key | str | null | Encryption key as base64 string |
param key: | Encryption key as base64 string |
---|
Assumes the given key has been generated previously using either the keyword Generate Key or with the matching command line utility.
Examples
${key}= Read file encryption.key
Use encryption key ${key}
Use Encryption Key From Vault
Load an encryption key from Robocorp Vault.
Arguments
Argument | Type | Default value | Description |
---|---|---|---|
name | str | null | Name of secret in Vault |
key | str, None | None | Name of encryption key in secret |
param name: | Name of secret in Vault |
---|---|
param key: | Name of encryption key in secret |
If the secret only has one value, the key argument is optional.
Examples
# Secret with one value
Use encryption key from vault Encryption
# Secret with multiple values
Use encryption key from vault name=Encryption key=CryptoKey