RPA.Crypto
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
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
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
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
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.
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
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
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
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.