Les opérations de commande unique Comment utiliser KPScript avec des opérations de commande unique pour effectuer des opérations de base de données simples ?

KPScript peut être appelé à l'aide de commandes uniques. En transmettant l'emplacement de la base de données, sa clé, une commande et éventuellement certains paramètres, des opérations simples comme l'ajout d'une entrée peuvent être effectuées. La syntaxe est très simple, aucune connaissance en script n'est requise. Cette méthode est idéale lorsque vous souhaitez apporter rapidement de petites modifications à la base de données. Il n'est pas recommandé lorsque vous devez effectuer de nombreuses opérations, car pour chaque commande, la base de données doit être chargée à partir du fichier, déchiffrée, modifiée, chiffrée et réécrite dans le fichier.

Les commandes sont spécifiées en passant -c:COMMAND à KPScript, où COMMAND est la commande à exécuter (voir ci-dessous pour une liste des commandes disponibles).

L'emplacement de la base de données est passé à KPScript en le passant simplement comme paramètre, sans aucun préfixe d'option.

La clé principale

La clé principale de la base de données peut être transmise à KPScript de l'une des manières suivantes :

• En paramètres de ligne de commande : En utilisation les paramètres -pw:, -pw-enc:, -keyfile: et -useraccount. Par exemple, pour transmettre "Secret" comme mot de passe, vous devez donner à KPScript le paramètre suivant : -pw:Secret. Si le mot de passe contient des espaces ou d'autres caractères spéciaux, il doit être entouré de doubles quotes : -pw:"Mon mot de passe top secret". Pour -pw-enc:, consultez le paramètre substituable {PASSWORD_ENC}. Le paramètre -keyfile: peut spécifier l'emplacement du fichier clé. Si -useraccount est transmis à KPScript, alors l'accréditation du compte utilisateur de l'utilisateur actuellement connecté est utilisée, sinon non.
• Lecture depuis l'entrée standard (StdIn) : si vous transmettez -keyprompt à KPScript, alors il lira le mot de passe, le chemin du fichier de clé et l'indicateur de compte utilisateur à partir du flux de l'entrée standard. Cette option est destinée à transmettre par programme la clé à KPScript. Pour entrer le mot de passe à la main, il est recommandé d'utiliser à la place la boîte de dialogue normale de la clé principale (car dans cette boîte de dialogue, le mot de passe est masqué par des puces/astérisques et il est chiffré par la protection de la mémoire du processus), voir -guikeyprompt.
• La saisie interactive à l'aide de l'interface graphique de l'utilisateur : si vous transmettez -guikeyprompt à KPScript, alors il vous demandera la clé à l'aide de la boîte de dialogue de clé principale normale de KeePass.

Les commandes disponibles

Veuillez noter que les commandes sont ajoutées progressivement en fonction des demandes des utilisateurs. S'il vous manque une commande, alors veuillez en informer l'équipe KeePass et elle sera ajoutée à la prochaine version de KPScript.

Actuellement, les commandes suivantes sont disponibles :

• ListGroups
• ListEntries
• GetEntryString
• AddEntry
• EditEntry
• MoveEntry
• DeleteEntry
• DeleteAllEntries
• Import
• Export
• Sync
• ChangeMasterKey
• DetachBins
• GenPw
• EstimateQuality

Commande : ListGroups

Cette commande répertorie tous les groupes dans un format facilement lisible par la machine. La sortie n'est pas destinée à être imprimée/utilisée directement. Exemple d'utilisation :

KPScript -c:ListGroups "C:\KeePass\MaBdD.kdbx" -pw:MonMotDePasse
Cela listera tous les groupes contenus dans le fichier de base de données MaBdD.kdbx.

Commande : ListEntries

Cette commande répertorie toutes les entrées dans un format facilement lisible par la machine. La sortie n'est pas destinée à être imprimée/utilisée directement. La syntaxe d'identification d'entrée est exactement la même que dans la commande EditEntry. Exemple d'utilisation :

KPScript -c:ListEntries "C:\KeePass\MaBdD.kdbx" -pw:MonMotDePasse -keyfile:"C:\KeePass\MaBdD.key"
Ouvre la base de données MaBdD.kdbx en utilisant 'MonMotDePasse' comme mot de passe et le fichier MaBdD.key comme fichier clé. Il affichera une liste de toutes les entrées contenues dans le fichier de base de données MaBdD.kdbx.

Commande : GetEntryString

Récupère la valeur d'un champ de chaîne de caractères d'une entrée. La syntaxe d'identification de l'entrée est exactement la même que dans la commande EditEntry. Des paramètres de ligne de commande supplémentaires :

• -Field:NOM
  Le nom du champ peut être spécifié à l'aide du paramètre '-Field'. Les noms de champs pris en charge sont par ex. Title, UserName, Password, URL, Notes, etc.
• -FailIfNotExists
  Si vous passez l'option '-FailIfNotExists' et que le champ spécifié n'existe pas, alors l'opération est abandonnée et une erreur est renvoyée.
• -FailIfNoEntry
  Si vous passez l'option '-FailIfNoEntry' et qu'aucune entrée n'est trouvée, alors KPScript se termine avec une erreur.
• -Spr
  Spr-compile la valeur du champ, c'est-à-dire que les paramètres substituables sont remplacés, les références de champ sont résolues, etc.

Exemple d'utilisation :

KPScript -c:GetEntryString "C:\KeePass\MaBdD.kdbx" -pw:MonMotDePasse -Field:UserName -ref-Title:"Compte de Démo"
Ouvre la base de données MaBdD.kdbx en utilisant 'MonMotDePasse' comme mot de passe. Il affiche tous les noms d'utilisateur de toutes les entrées qui ont le titre "Compte de Démo".

Commande : AddEntry

Cette commande ajoute une entrée à la base de données. Pour spécifier les détails de l'entrée, utilisez les identificateurs de champ de chaîne de caractères standard comme noms de paramètres et leurs valeurs pour le contenu. Les champs de chaîne de caractères standard pris en charge sont : Title, UserName, Password, URL, and Notes. Exemples d'utilisation :

KPScript -c:AddEntry "C:\KeePass\MaBdD.kdbx" -pw:MonMdP -Title:"Titre de la nouvelle entrée"

KPScript -c:AddEntry "C:\KeePass\MaBdD.kdbx" -pw:MonMdP -Title:UnSiteWeb -UserName:Don -Password:pao5j3eg -URL:https://exemple.com/

Les paramètres de ligne de commande supplémentaires :

• -GroupName:NOM
  Le paramètre -GroupName: peut être utilisé pour spécifier le groupe dans lequel l'entrée est créée. Pour la recherche, KPScript effectue une traversée de préordre et utilise le premier groupe correspondant (le nom est sensible à la casse). Si aucun groupe avec le nom spécifié n'est trouvé, alors il sera créé dans le groupe racine.
• -GroupPath:CHEMIN
  Le chemin complet du groupe peut être spécifié à l'aide du paramètre -GroupPath: (utilisez '/' comme séparateur). Si vous ne spécifiez pas de nom de groupe ou de chemin, alors l'entrée sera créée dans le groupe racine.
• -setx-Icon:ID
  Positionne l'icône de l'entrée sur l'icône standard ayant un ID d'index.
• -setx-CustomIcon:ID
  Positionne l'icône de l'entrée sur l'icône personnalisée ayant l'ID d'index.
• -setx-Expires:VALEUR
  Positionne si l'entrée est expirée ou pas.VALEUR doit être soit true soit false.
• -setx-ExpiryTime:VALEUR
  Poistionne le temps/la date d'expiration de l'entrée.

Exemple d'utilisation :

KPScript -c:AddEntry "C:\KeePass\MaBdD.kdbx" -pw:MonMdP -Title:"Mon Fournisseur" -GroupName:"Sites Internet"

Commande : EditEntry

Cette commande modifie les entrées existantes.

Utilisez un ou plusieurs des paramètres suivants pour identifier les entrées à modifier ; toutes les conditions spécifiées doivent correspondre :

• -ref-NOMDUCHAMP:VALEURDUCHAMP
  Le champ de la chaîne de caractère NOMDUCHAMP doit avoir la valeur VALEURDUCHAMP.
  Si la valeur est entourée entre '//', alors elle est traitée comme "https://docs.microsoft.com/en-us/dotnet/standard/base-types/regular-expression-language-quick-reference expression régulière, qui doit apparaître dans le champ de l'entrée pour l'entrée qui correspond. Par exemple : -ref-Title:"//Test\d\d//" correspond à toutes les entrées qui contiennent 'Test' suivi par au moins deux chiffres.
• -refx-UUID:VALEUR
  L'UUID de l'entrée doit être VALEUR.
• -refx-Tags:VALEUR
  L'entrée doit avoir les balises (tags) spécifiées. Plusieurs balises peuvent être séparées par des virgules ','.
• -refx-Expires:VALEUR
  VALEUR doit être true ou false. Ce paramètre permet de spécifier si l'entrée expire parfois (c'est-à-dire si la case à cocher 'Expire le :' est cochée, indépendant du temps d'expiration).
• -refx-Expired:VALEUR
  VALEUR doit être true ou false. Ce paramètre permet de spécifier si l'entrée a expiré (c'est-à-dire si la case à cocher 'Expire le :' est cochée et que le temps d'expiration n'est pas dans le futur).
• -refx-Group:VALEUR
  Le nom du groupe parent group de l'entrée doit être VALEUR.
• -refx-GroupPath:VALEUR
  Le chemin complet du groupe parent de l'entrée doit être VALEUR. Dans le chemin utiliser '/' comme séparateur de groupe.
• -refx-All
  Correspond à toutes les entrées.

Utilisez un ou plusieurs des paramètres suivants pour spécifier comment l'entrée doit être modifiée :

• -set-NOMDUCHAMP:VALEURDUCHAMP
  Positionne le champ de chaîne de caractères NOMDUCHAMP de l'entrée à la valeur VALEURDUCHAMP.
• -setx-Icon:ID
  Poistionne l'icône de l'entrée à l'icône standard ayant l'index ID.
• -setx-CustomIcon:ID
  Poistionne l'icône de l'entrée à l'icône personnalisée ayant l'index ID.
• -setx-Expires:VALEUR
  Positionne si l'entrée expire ou pas. VALEUR doit être soit true ou false.
• -setx-ExpiryTime:VALEUR
  Positionne la date/le temps d'expiration.

Exemples d'utilisation :

KPScript -c:EditEntry "C:\KeePass\MaBdD.kdbx" -pw:MonMdP -ref-Title:"Titre d'une entrée existante" -set-UserName:"Nouveauy Nom d'utilisateur"

KPScript -c:EditEntry "C:\KeePass\MaBdD.kdbx" -pw:MonMdP -ref-UserName:MonNom -set-UserName:NouveauNom -set-Password:"Top Secret"

Si vous transmettez en plus -CreateBackup, alors KPScript créera d'abord des sauvegardes des entrées avant de les modifier.

Commande : MoveEntry

Cette commande déplace une ou plusieurs entrées existantes. La syntaxe d'identification d'entrée est exactement la même que dans la commande EditEntry.

• -GroupPath:CHEMIN
  Le groupe cible peut être spécifié à l'aide du paramètre -GroupPath:. '/' doit être utilisé comme séparateur (par exemple : -GroupPath:Internet/Courriel déplace les entrées spécifiées vers le sous-groupe 'Courriel' du sous-groupe 'Internet').
• -NomGroupe:NOM
  Le paramètre -GroupName: peut être utilisé (voir la commande AddEntry pour plus de détails).

Commande : DeleteEntry

Cette commande supprime une ou plusieurs entrées existantes. La syntaxe d'identification de l'entrée est exactement la même que dans la commande EditEntry.

Commande : DeleteAllEntries

Cette commande supprime toutes les entrées (dans tous les sous-groupes).

Commande : Import

Cette commande importe un fichier dans la base de données.

• -Format:NOM
  Le format est spécifié en positionnant le paramètre "-Format" (voir les noms dans la boîte de dialogue d'importation de KeePass).
• -File:CHEMIN
  Le fichier à importer est spécifié à l'aide du paramètre "-File".
• -MM:VALEUR
  Si le format prend en charge les UUID, alors le comportement des groupes/entrées qui existent à la fois dans la base de données actuelle et dans le fichier d'importation peut être spécifié à l'aide du paramètre facultatif "-MM". Les VALEURS possibles sont "CreateNewUuids", "KeepExisting", "OverwriteExisting", "OverwriteIfNewer", et "Sync". Par défaut, de nouveaux UUID sont créés.
• -imp_*:VALEUR
  Pour les fichiers d'importation chiffrés, par défaut, la clé principale de la base de données cible est utilisée. Cependant, il est également possible de spécifier une clé principale différente, en utilisant les paramètres de ligne de commande de clé principale habituels avec le préfixe '-imp_' (c'est-à-dire -imp_pw:, -imp_pw-enc:, -imp_keyfile:, -imp_useraccount, -imp_keyprompt, -imp_guikeyprompt).

Exemple d'utilisation :

KPScript -c:Import "C:\KeePass\MaBdD.kdbx" -pw:MonMdP -Format:"KeePass XML (2.x)" -File:FichierSource.xml

Commande : Export

Cette commande exporte (des parties de) la base de données.

• -Format:NOM
  Le format est spécifié en positionnant le paramètre "-Format" (voir les noms dans la boîte de dialogue d'exportation de KeePass).
• -OutFile:CHEMIN
  Le fichier vers lequel exporter est spécifié à l'aide du paramètre "-OutFile".
• -GroupPath:CHEMIN
  Si un groupe spécifique doit être exporté (au lieu de toute la base de données), alors spécifiez le groupe à l'aide du paramètre "-GroupPath" (utilisez '/' comme séparateur).
• -XslFile:PATH
  Pour le module d'export de la transformation XSL, le chemin du fichier XSL peut être passé à l'aide du paramètre "-XslFile".

Exemple d'utilisation :

KPScript -c:Export "C:\KeePass\MaBdD.kdbx" -pw:MonMdP -Format:"KeePass XML (2.x)" -OutFile:FichierCible.xml

Commande : Sync

Cette commande synchronise la base de données avec une autre. L'autre chemin de la base de données doit être spécifié à l'aide du paramètre de ligne de commande "-File". Exemple d'utilisation :

KPScript -c:Sync -guikeyprompt "C:\Chemin\A.kdbx" -File:"C:\Chemin\B.kdbx"

Commande : ChangeMasterKey

Cette commande modifie la clé principale de la base de données. Les nouvelles valeurs de clé sont spécifiées à l'aide des options standard précédées de 'new', c'est-à-dire -newpw:, -newkeyfile: et -newuseraccount (toutes sont facultatives). Exemple d'utilisation :

KPScript -c:ChangeMasterKey "C:\KeePass\MaBdD.kdbx" -pw:MonMdP -newpw:MonNouveauMdP

Commande : DetachBins

Cette commande enregistre toutes les pièces jointes d'entrée (dans le répertoire de la base de données) et les supprime de la base de données. Exemple d'utilisation :

KPScript -c:DetachBins -guikeyprompt "C:\KeePass\MaBdD.kdbx"

Commande : GenPw

Génère des mots de passe :

• -count:NOMBRE
  Le nombre de mots de passe peut être spécifié à l'aide du paramètre optionnel -count:.
• -profile:NOM
  Un profil de générateur de mot de passe peut être spécifié à l'aide du paramètre optionnel -profile: (les noms de tous les profils disponibles peuvent être trouvés dans la boîte de dialogue du générateur de mot de passe).

Exemples d'utilisation :

KPScript -c:GenPw
Génère un mot de passe en utilisant le profil du générateur par défaut.

KPScript -c:GenPw -count:5 -profile:"Hex Key - 128-Bit (built-in)"
Génère cinq mots de passe hexadécimaux sur 128 bits (quand aucune traduction n'est utilisée).

Commande : EstimateQuality

Estime la qualité (en bits) du mot de passe spécifié via le paramètre -text:. Exemple d'utilisation :

KPScript -c:EstimateQuality -text:MonMotDePasseTopSecret

Codage des caractères de la console

Si vous observez des caractères spéciaux brouillés dans la sortie, alors veuillez lire la page Console Character Encoding.