$cipher.encrypt¶
Description¶
Chiffre un fichier ou un texte.
Syntaxe¶
$cipher.encrypt( source [ , options ] )
Paramètres¶
sourcefile / string- Valeur à chiffrer. Peut désigner un fichier ou une chaîne de caractères contenant la donnée à chiffrer.
optionsmap-
Map d'options de chiffrement. La liste des options dépend de l'algorithme de chiffrement souhaité. L'algorithme doit être spécifié via l'option
algo.Ci-dessous nous présentons les différents algorithmes supportés et les options supplémentaires qui s'y rapportent.
Valeur par défaut, désigne un chiffrement AES basé sur un mot de passe avec sel.
Autres options liées à l'algorithme
default:passwordstring-
Mot de passe à utiliser pour le chiffrement.
Si non défini, la méthode s'appuie sur le mot de passe défini dans la config de l'application (entrée
admin.cipherPassword).Si cette entrée n'est pas renseignée, la méthode se rabat sur la valeur de la variable d'environnement
EWT_ENCRYPT_PASSWORD.
Chiffrement asymétrique PGP. Autres options liées à cet algorithme:
pubkeystring- Clé publique à utiliser pour le chiffrement
destination(oudest) file / string- Fichier ou dossier de destination. Si l'option n'est pas spécifiée, la méthode crée un fichier dans le répertoire de travail de l'application.
compressboolean- Indique que le chiffrement doit effectuer une compression des
données au préalable. L'option est
truepar défaut. armoredKeyboolean- Indique que la clé publique est "armored", c'est-à-dire qu'elle
est dans un format lisible (en base64). L'option est
truepar défaut. armoredOutboolean- Indique que l'on souhaite avoir une sortie au format "armored".
Dans ce cas, les caractères non imprimables sont convertis en
base64. L'option est
falsepar défaut. integrityboolean- Indique d'intégrer des éléments de contrôle d'intégrité dans la
sortie. L'option est
truepar défaut.
Retour¶
Valeur chiffrée
Exemple¶
Exemple de chiffrement PGP, voir $cipher