Encrypt File

UiPath.Cryptography.Activities.EncryptFile

Description

Encrypts a file using a symmetric algorithm and key, or using PGP with a recipient's public key. The result is written to a new file.

Compatibilité du projet

Windows - Héritage | Windows | Multiplate-forme

Windows, configuration multiplate-forme

• Fichier : le fichier à chiffrer, stocké sous la forme d'une variable IResource . Sélectionnez l’ option Plus pour passer à l'entrée Chemin d'entrée .
• Algorithm - A drop-down menu which enables you to select the encryption algorithm you want to use. The following options are available: AES GCM, ChaCha20-Poly1305 (Non-FIPS), PGP - Pretty Good Privacy (Non-FIPS), AES (Deprecated), DES (Deprecated), RC2 (Non-FIPS) (Deprecated), Rijndael (Non-FIPS) (Deprecated), and TripleDES (Deprecated). AES GCM and ChaCha20-Poly1305 (Non-FIPS) are authenticated (AEAD) algorithms recommended for new workflows. Select PGP to encrypt with a recipient's public key instead of a symmetric key.
• Key - The key that you want to use to encrypt the file. Used by the symmetric algorithms only. This field supports only strings and String variables. To enter the key as a secure string instead of plain text, select the field's input menu and choose Toggle to Secure input - this uses the Key Secure String property (a SecureString).

Options avancées

Options

• Key Encoding - The encoding used to interpret the key specified in the Key property. The dropdown lists all text encodings (code pages) available on the machine, with the most common ones shown first: System default, Unicode (UTF-8) (default), Unicode, Unicode (Big-Endian), Unicode (UTF-32), Unicode (UTF-32 Big-Endian), US-ASCII, and Western European (ISO). Additional regional and legacy code pages follow in the list.
• Output file name and location - The path where you want to save the encrypted file. This field supports only strings and String variables.
  Remarque :

  Il est recommandé d’utiliser des chemins de dossier relatifs afin de tenir compte de la structure de fichier différente entre les machines Windows et Linux lors de l’exécution d’un projet. Un chemin relatif suit le format newFolder/newFileName.enc. L'activité crée le dossier cible s'il n'existe pas déjà.

• Overwrite - If a file already exists, selecting On overwrites it. If the toggle is set to Off, a new file is created. The default value is Off.
• Continuer en cas d'erreur (Continue On Error) : précise si l’automatisation doit se poursuivre même si l’activité génère une erreur. Ce champ prend uniquement en charge les valeurs booléennes (True, False). La valeur par défaut est False. Par conséquent, si le champ est vide et qu’une erreur est générée, l’exécution du projet s’arrête. Si le champ indique au contraire True, l'exécution du projet se poursuit même en cas d'erreur.

Symmetric wire format and interoperability

These options apply to the symmetric algorithms only. They let you produce ciphertext that interoperates with external tools such as openssl enc, Java, and Python. Existing workflows that do not set Wire format keep producing the default Classic output, which is unchanged.

• Wire Format - The symmetric ciphertext layout. The following options are available:
  • UiPath (Classic) (default) - UiPath's byte-stable layout (salt(8) + IV + ciphertext [+ tag], PBKDF2-HMAC-SHA1 at 10,000 iterations). Produces the same output as previous versions.
  • UiPath (OWASP 2026) - The Classic layout with a stronger, OWASP-recommended KDF iteration count.
  • Raw (caller-supplied key and IV) - A caller-supplied key and IV, for third-party interoperability. Requires Key Bytes Format to be Hex or Base64.
  • OpenSSL enc (Salted__ + PBKDF2-SHA256) - Produces openssl enc-compatible output.
• Key Bytes Format - How the Key string is interpreted. The following options are available: Hex and Base64. Required when Wire Format is Raw (caller-supplied key and IV); otherwise the key is treated as a password.
• IV - The initialization vector, used when Wire Format is Raw (caller-supplied key and IV). Interpreted according to Key Bytes Format. Optional - leave it empty to let the cipher generate one. Rejected for all other formats.
• KDF Iterations - The PBKDF2 iteration count. 0 uses the format's OWASP-recommended default (1,300,000 for UiPath (OWASP 2026), 600,000 for OpenSSL enc). Rejected for UiPath (Classic) and Raw (caller-supplied key and IV).
• AES Key Size - The AES key size, in bits. The following options are available: 128-bit, 192-bit, and 256-bit (default). Applies only when Algorithm is AES and Wire Format is OpenSSL enc (Salted__ + PBKDF2-SHA256). Must match the key size the peer uses. It is not stored in the wire format, so the encrypt and decrypt sides must use matching values.

PGP

These options apply when Algorithm is PGP.

• Public Key File Path - The path to the recipient's PGP public key file. Required when Algorithm is PGP.
• Private Key File Path - The path to your PGP private key file. Required only when Sign Data is enabled.
• Passphrase - The passphrase that unlocks your private key when signing. To provide it as a secure string instead of plain text, select the field's input menu and switch to the Passphrase (Secure) input (a SecureString).
• Sign Data - When enabled, signs the encrypted data using your private key. This field only supports Boolean values (True, False). The default value is False.

Selon le chemin de sortie et si le fichier existe déjà, les résultats suivants peuvent se produire :

Nom et emplacement du fichier de sortie	Écraser	Résultat de sortie
Non défini	Désactivé (Off)	Un fichier avec le nom de fichier d'origine + le suffixe « _Encrypted ». Si le fichier existe déjà, une erreur est générée.
Non défini	Sur	Un fichier avec le nom de fichier d'origine + le suffixe « _Encrypted ». Si le fichier existe déjà, il sera écrasé.
Ensemble	Désactivé (Off)	Un fichier selon les préférences de l'utilisateur. Si le fichier existe déjà, une erreur est générée.
Ensemble	Sur	Un fichier selon les préférences de l'utilisateur. Si le fichier existe déjà, il sera écrasé.

Sortie

• Encrypted File - Reference to the encrypted file retrieved by the activity for use in other activities.

Configuration Windows - Héritage

Panneau propriétés

Commun

• Continuer en cas d'erreur (Continue On Error) : précise si l’automatisation doit se poursuivre même si l’activité génère une erreur. Ce champ prend uniquement en charge les valeurs booléennes (True, False). La valeur par défaut est False. Par conséquent, si le champ est vide et qu’une erreur est générée, l’exécution du projet s’arrête. Si le champ indique au contraire True, l'exécution du projet se poursuit même en cas d'erreur.
  Remarque :

  Si cette activité est incluse dans Essayer de capturer (Try Catch) et que la valeur de la propriété Poursuite sur erreur (ContinueOnError) est True, aucune erreur n'est détectée lors de l'exécution du projet.

• NomAffichage (DisplayName) - Nom affiché de l'activité.

Entrée

• Algorithm - A drop-down menu which enables you to select the encryption algorithm you want to use. The following options are available: AES (Deprecated), AES GCM, DES (Deprecated), RC2 (Non-FIPS) (Deprecated), Rijndael (Non-FIPS) (Deprecated), and TripleDES.

  Remarque :

  Lors de l'utilisation de l'algorithme AES GCM , l'entrée de déchiffrement doit être fournie au format de (octets concaténés) : Salt (8bytes) + IV (12 bytes) + encryptedData (variable bytes) + Tag (16 bytes). L'activité utilise également les paramètres suivants :

  • Le nombre d'itérations PBKDF2 est de 10 000
  • La clé générée est de 256 bits (32 octets)

  Notez que la Clé générée 256 bits n'est pas la même que l'option d'entrée Clé .

• Encrypted Filename - The file name you want to use to save the encrypted file.

• Input Path - The path to the file that you want to encrypt. This field supports only strings and String variables.

• Key - The key that you want to use to encrypt the specified file. This field supports only strings and String variables.

• Key Encoding - The encoding used to interpret the key specified in the Key property. This field supports only Encoding variables.

• Key Secure String - The secure string used to encrypt the input file.

• Output file name and location - The path where you want to save the encrypted file. This field supports only strings and String variables.

• Overwrite - If a file already exists at the path specified in the OutputPath field, selecting this check box overwrites it. If unchecked, a new file is created. By default, this check box is cleared.

Divers

• Privé (Private) - Si cette option est sélectionnée, les valeurs des variables et des arguments ne sont plus enregistrées au niveau Détaillé (Verbose).