Seald: documentation

Français

English

Français

English

Liste des commandes ​

Ces commandes supportent en plus ces options globales.

create-account ​

La commande create-account permet de créer un compte, de rejoindre une équipe et, optionnellement, de lui ajouter un email.

bash
seald create-account [--display-name <display_name>] [--email <email> [--email-validation <validation_token>] [--force] [--team-id <team_id>] [--accept-backup-keys]]
seald create-account [--display-name <display_name>] [--email <email> [--email-validation <validation_token>] [--force] [--team-id <team_id>] [--accept-backup-keys]]

Exemples ​

Pour créer un compte :

bash
seald create-account
seald create-account

Pour créer un compte avec un email :

bash
seald create-account --display-name Tim --email tim@seald.io
seald create-account --display-name Tim --email tim@seald.io

Pour créer un compte avec un email et rejoindre une équipe :

bash
seald create-account -d Tim -e tim@seald.io -t 00000000-0000-0000-0000-000000000000 --accept-licence
seald create-account -d Tim -e tim@seald.io -t 00000000-0000-0000-0000-000000000000 --accept-licence

Pour créer un compte avec un email appartenant à un domaine prévalidé :

bash
seald  create-account -d Tim -e tim@seald.io --accept-licence --email-validation 69ddb1130cab76a9f4639e25b442d0358687436bccbf21a3e61bd0c1a2888246107e1cf9fd05f80d607f68fc0c8286ce06275356a01c4bd0e275f055832a5cde
seald  create-account -d Tim -e tim@seald.io --accept-licence --email-validation 69ddb1130cab76a9f4639e25b442d0358687436bccbf21a3e61bd0c1a2888246107e1cf9fd05f80d607f68fc0c8286ce06275356a01c4bd0e275f055832a5cde

Options ​

  • --display-name, -d Nom de l'utilisateur. Celui ci n'est pas modifiable en CLI. [default: "CLI Account"]
  • --device-name, -n Nom à donner à l'appareil (36 caractères max) [string] [required]
  • --email, -e Adresse email de l'utilisateur. [string] [default: null]
  • --email-validation Jeton de validation automatique. [string] [require: email]
  • --accept-license, --accept-licence Accepter automatiquement le contrat de licence et la politique de confidentialité. [boolean] [default: false]
  • --force, -f Force l'ajout de l'email si celui si est déjà enregistré. [boolean] [default: false]
  • --team-id, -t UUID de l'équipe à rejoindre. [string] [default: null] [require: email]
  • --accept-backup-keys Force l'acceptation des clés de sauvegarde de l'équipe (nécessite d'avoir rejoint une équipe). [boolean] [default: false]
  • --disable-db-password Désactive la demande d'un mot de passe lors de la création de la base de données. Cette option n'est pas disponible pour l'application bureau. [boolean] [default: false]
  • --signup-jwt, --jwt JWT à utiliser. [string]

add-email ​

La commande add-email permet d'ajouter un email au compte.

Cette opération nécessite d'avoir créé un compte au préalable via la commande create-account.

Un compte nécessite au moins un email pour pouvoir être utilisé. Un compte peut avoir plusieurs emails.

Pour valider l'ajout d'un email, il est nécessaire de rentrer un code de validation qui est envoyé par email.

Si l'adresse email est déjà associée à un compte Seald, une confirmation sera demandée. L'option --force permet d'éviter cette confirmation.

Si vous utilisez un domaine pré-validé, vous pouvez utiliser un jeton de validation automatique via l'option --email-validation lors des commandes create-account et add-email. L'utilisation de ce jeton valide automatiquement l'email et ajoute l'utilisateur à l'équipe.

bash
seald add-email --email <email> [--email-validation <validation_token>] [--force]
seald add-email --email <email> [--email-validation <validation_token>] [--force]

Exemples ​

bash
seald add-email --email tim@seald.io
seald add-email -e tim@seald.io --force --email-validation 69ddb1130cab76a9f4639e25b442d0358687436bccbf21a3e61bd0c1a2888246107e1cf9fd05f80d607f68fc0c8286ce06275356a01c4bd0e275f055832a5cde
seald add-email --email tim@seald.io
seald add-email -e tim@seald.io --force --email-validation 69ddb1130cab76a9f4639e25b442d0358687436bccbf21a3e61bd0c1a2888246107e1cf9fd05f80d607f68fc0c8286ce06275356a01c4bd0e275f055832a5cde

Options: ​

  • --email, -e Adresse email de l'utilisateur. [string] [required]
  • --email-validation Jeton de validation automatique. [string]
  • --skip-validation Ne pas valider l'email. L'email devra être validé plus tard en utilisant la commande validate-email. [boolean] [default: false]
  • --force, -f Force l'ajout de l'email si celui si est déjà enregistré. [boolean] [default: false]
  • --accept-backup-keys Force l'acceptation des clés de sauvegarde de l'équipe (nécessite d'avoir rejoint une équipe). [boolean] [default: false]
  • --auto-accept-contacts Est-ce qu'il faut demander une confirmation avant d'enregistrer de nouveaux contacts. Défaut à demander confirmation en mode strict, ne pas en demander en mode non strict. [boolean]

list-team-invitations ​

Cette commande nécessite d'avoir un compte avec au moins un email validé.

Cette commande ne prend pas d'argument.

bash
seald list-team-invitations
seald list-team-invitations

Exemple ​

bash
seald list-team-invitations

Sortie attendue :
team: <team_name>, invited by: <inviter_email>, team ID: <team_id>
seald list-team-invitations

Sortie attendue :
team: <team_name>, invited by: <inviter_email>, team ID: <team_id>

join-team ​

La commande join-team permet de rejoindre une équipe en acceptant une invitation. Cette commande nécessite d'avoir un compte avec au moins un email validé.

bash
seald join-team --team-id <team_id>
seald join-team --team-id <team_id>

Exemple ​

bash
$ seald join-team --team-id 00000000-0000-0000-0000-000000000000
$ seald join-team --team-id 00000000-0000-0000-0000-000000000000

Options ​

  • --team-id, -t UUID de l'équipe que vous souhaitez rejoindre. [string] [required]
  • --accept-backup-keys Force l'acceptation des clés de sauvegarde de l'équipe (nécessite d'avoir rejoint une équipe). [boolean] [default: false]

list-backup-keys ​

La commande list-backup-keys permet de lister et d'accepter les clés de sauvegarde dernièrement ajoutées.

Cette opération nécessite d'avoir un compte et une équipe.

bash
seald list-backup-keys --accept-backup-keys
seald list-backup-keys --accept-backup-keys

Exemple ​

bash
$ seald list-backup-keys --accept-backup-keys
$ seald list-backup-keys --accept-backup-keys

Options ​

  • --accept-backup-keys Force l'acceptation des clés de sauvegarde de l'équipe. [boolean] [default: false]

encrypt ​

La commande encrypt permet de chiffrer un ou plusieurs fichiers.

Cette opération nécessite d'avoir un compte et une équipe. Si le mode strict est activé, il est interdit d'ajouter des destinataires n'ayant pas Seald.

bash
seald encrypt [--output <output_file>] [--recipients-ids <...recipients_ids>] [--recipients-emails <...recipients_emails>] [--recipients-emails-file <recipients_emails_file>] [--force-self] --input <files_to_encrypt..>
seald encrypt [--output <output_file>] [--recipients-ids <...recipients_ids>] [--recipients-emails <...recipients_emails>] [--recipients-emails-file <recipients_emails_file>] [--force-self] --input <files_to_encrypt..>

Alias ​

  • encrypt-file

Exemples ​

Chiffrer un fichier uniquement pour soi-même, sans demander de confirmation :

bash
seald encrypt --input chemin/fichier.pdf --output chemin/fichier.pdf.seald --force-self
seald encrypt --input chemin/fichier.pdf --output chemin/fichier.pdf.seald --force-self

Chiffrer deux fichiers pour deux destinataires :

bash
seald encrypt -i 'chemin/fichier.pdf' 'chemin/annexe.pdf' --recipients-ids 'JqTsYFZAAuSHVGofjmsg8g' 'ZAAJqTsYFSHVGofjmsg8gu' --emails 'email@domain.tld' 'email@domain.tld'
seald encrypt -i 'chemin/fichier.pdf' 'chemin/annexe.pdf' --recipients-ids 'JqTsYFZAAuSHVGofjmsg8g' 'ZAAJqTsYFSHVGofjmsg8gu' --emails 'email@domain.tld' 'email@domain.tld'

Chiffrer un dossier de manière récursive, avec suppression des fichiers en clair, afficher un avertissement si le chiffrement de fichier a échoué :

bash
seald encrypt -i chemin/dossierClair/ -o chemin/dossierChiffre/ --emails-file chemin/emails.txt --recursive --remove --on-error warn
seald encrypt -i chemin/dossierClair/ -o chemin/dossierChiffre/ --emails-file chemin/emails.txt --recursive --remove --on-error warn

Options ​

  • --input, -i, --file, --files, -f Chemin des fichiers à chiffrer. [array] [required]
  • --output, -o Chemin où seront écrits les fichiers chiffrés. Par défaut, le chemin courant est utilisé, avec le nom du fichier d'entrée + .seald [string]
  • --recipients-ids, --uids Liste des IDs des destinataires. Peut-être de la forme UID ou UID:sigchainHash pour vérifier le sigchainHash. [array] [default: []]
  • --recipients-emails, --emails Liste des emails des destinataires. Peut-être de la forme user@domain.ext, user@domain.ext:sigchainHash pour vérifier le sigchainHash. Pour les utilisateurs n'ayant pas Seald, si votre équipe a l'option activée, vous pouvez spécifier un numéro de téléphone en utilisant la forme user@domain.ext#+33612345678. [array] [default: []]
  • --recipients-emails-file, --emails-file Chemin d'un fichier contenant les emails des destinataires. [string]
  • --force-self Ne pas demander de confirmation s'il n'y a pas d'autre destinataire que le compte chiffrant. [boolean]
  • --recursive, -r Si l'entrée est un dossier, chiffrer récursivement tous les fichiers. [boolean]
  • --retries Lors du chiffrement de plusieurs fichiers et qu'il y a une erreur, retenter ce nombre de fois. [number] [default: 3]
  • --on-error Choix du comportement quand une erreur survient lors du chiffrement de plusieurs fichiers. [string] [choices: "ignore", "warn", "fail"] [default: "fail"]
  • --parallel Nombre de processus de chiffrement lors du chiffrement de plusieurs fichiers. [number] [default: 10]
  • --remove, -R Après le chiffrement, supprimer le fichier en clair. S'il s'agit d'un dossier, supprimer le dossier. [boolean]
  • --remove-files Après le chiffrement, supprimer le fichier clair. S'il s'agit d'un dossier, supprimer seulement les fichiers. [boolean]
  • --on-same-file-name Comportement en cas de conflit sur le nom du fichier de sortie [string] [choices: "overwrite", "error", "increment", "skip"] [default: "error"]
  • --auto-accept-contacts Est-ce qu'il faut demander une confirmation avant d'enregistrer de nouveaux contacts. Défaut à demander confirmation en mode strict, ne pas en demander en mode non strict. [boolean]
  • --progress Afficher une barre de progression. Activé par défaut, utiliser --no-progress pour le désactiver. [boolean] [default: true]
  • --encrypt-for-self Est-ce qu'il faut inclure l'utilisateur actuel comme destinataire. [boolean] [default: true]

decrypt ​

La commande decrypt permet de déchiffrer un ou plusieurs fichiers.

Cette opération nécessite d'avoir un compte et une team.

bash
seald decrypt --file <file_to_decrypt> [--output <output_directory>] [--offline-database <offline_database_path>] [--force] [--safe]
seald decrypt --file <file_to_decrypt> [--output <output_directory>] [--offline-database <offline_database_path>] [--force] [--safe]

Alias ​

  • decrypt-file

Exemples ​

Déchiffrer un fichier :

bash
seald decrypt -i chemin/fichier.txt.seald -o chemin/fichier.txt
seald decrypt -i chemin/fichier.txt.seald -o chemin/fichier.txt

Déchiffrer un fichier en utilisant un fichier de sauvegarde des clés :

bash
seald decrypt -i chemin/fichier.txt.seald -o chemin/fichier.txt --offline-database chemin/backup-database.txt
seald decrypt -i chemin/fichier.txt.seald -o chemin/fichier.txt --offline-database chemin/backup-database.txt

Déchiffrer un dossier de manière récursive, en affichant un avertissement si certains fichiers ne peuvent pas être déchiffrés :

bash
seald decrypt -i chemin/dossierChiffre/ -o chemin/dossierClair/ --on-error warn --on-non-seald warn
seald decrypt -i chemin/dossierChiffre/ -o chemin/dossierClair/ --on-error warn --on-non-seald warn

Options ​

  • --input, -i, --file, --files, -f Chemin des fichiers à déchiffrer. [array] [required]
  • --output, --output-dir, -o Chemin où seront écrits les fichiers déchiffrés. Par default, le chemin courant est utilisé. [string]
  • --offline-database, -d Utiliser un fichier de sauvegarde des clés de chiffrement. [string]
  • --force, -f Forcer les déchiffrements s'il y a un avertissement, sans confirmation. Seulement quand on déchiffre un fichier unique. Toujours vrai en déchiffrant plusieurs fichiers. [array]
  • --safe, -s Ne pas déchiffrer s'il y a un avertissement, sans demander confirmation. [boolean]
  • --recursive, -r Si l'entrée est un dossier, déchiffrer récursivement tous les fichiers. [boolean]
  • --retries Lors du chiffrement de plusieurs fichiers et qu'il y a une erreur, retenter ce nombre de fois. [number] [default: 3]
  • --on-error Choix du comportement quand une erreur survient lors du déchiffrement de plusieurs fichiers. [string] [choices: "ignore", "warn", "fail"] [default: "fail"]
  • --on-non-seald Choix du comportement si un fichier n'est pas un fichier Seald lors du déchiffrement de plusieurs fichiers. [string] [choices: "ignore", "warn", "fail"] [default: "warn"]
  • --parallel Nombre de processus de déchiffrement lors du déchiffrement de plusieurs fichiers. [number] [default: 10]
  • --remove, -R Après le déchiffrement, supprimer le fichier chiffré. S'il s'agit d'un dossier, supprimer le dossier. [boolean]
  • --remove-files Après le déchiffrement, supprimer le fichier chiffré. S'il s'agit d'un dossier, supprimer seulement les fichiers. [boolean]
  • --progress Afficher une barre de progression. Activé par défaut, utiliser --no-progress pour le désactiver. [boolean] [default: true]

add-recipients ​

La commande add-recipients permet d'ajouter des destinataires à un fichier chiffré existant.

Cette opération nécessite d'avoir un compte et une équipe. Si le mode strict est activé, il est interdit d'ajouter des destinataires n'ayant pas Seald.

bash
seald add-recipients [input..]
seald add-recipients [input..]

Alias ​

  • authorize-recipients

Exemple ​

Ajouter deux utilisateurs ayant Seald à l'aide de leurs IDs, et deux utilisateurs n'ayant pas Seald à l'aide de leur adresse email.

bash
seald add-recipients -i chemin/fichier.pdf.seald --uids 'JqTsYFZAAuSHVGofjmsg8g' 'AAuSHVJqTsYFZGofjmsg8g' --emails 'email@domain.tld' 'email@domain.tld'
seald add-recipients -i chemin/fichier.pdf.seald --uids 'JqTsYFZAAuSHVGofjmsg8g' 'AAuSHVJqTsYFZGofjmsg8g' --emails 'email@domain.tld' 'email@domain.tld'

Options ​

  • --input, -f, --file, --files, -i Chemin des fichiers chiffrés [array] [required]
  • --recipients-ids, --uids Liste des IDs des destinataires. Peut-être de la forme UID ou UID:sigchainHash pour vérifier le sigchainHash. [array] [default: []]
  • --recipients-emails, --emails Liste des emails des destinataires. Peut-être de la forme user@domain.ext, user@domain.ext:sigchainHash pour vérifier le sigchainHash. Pour les utilisateurs n'ayant pas Seald, si votre équipe a l'option activée, vous pouvez spécifier un numéro de téléphone en utilisant la forme user@domain.ext#+33612345678. Pour supprimer le numéro de téléphone, utilisez la forme email#. [array] [default: []]
  • --recipients-emails-file, --emails-file Chemin d'un fichier contenant les emails des destinataires à ajouter. [string]
  • --recursive, -r Si l'entrée est un dossier, ajouter les destinataires à tous les fichiers. [boolean]
  • --retries When working on multiple files and there is an error, try this number of times [number] [default: 3]
  • --on-error Choix du comportement quand une erreur survient lors du déchiffrement de plusieurs fichiers. [string] [choices: "ignore", "warn", "fail"] [default: "fail"]
  • --on-non-seald Choix du comportement si un fichier n'est pas un fichier Seald lors du déchiffrement de plusieurs fichiers. [string] [choices: "ignore", "warn", "fail"] [default: "warn"]
  • --parallel Nombre de processus lors d'une opération sur plusieurs fichiers. [number] [default: 10]
  • --auto-accept-contacts Est-ce qu'il faut demander une confirmation avant d'enregistrer de nouveaux contacts. Défaut à demander confirmation en mode strict, ne pas en demander en mode non strict. [boolean]
  • --progress Afficher une barre de progression. Activé par défaut, utiliser --no-progress pour le désactiver. [boolean] [default: true]

revoke ​

La commande revoke permet de révoquer des destinataires à un fichier chiffré existant.

Cette opération nécessite d'avoir un compte et une équipe.

bash
seald revoke --file <...files_path> [--revoke-emails <...emails_to_revoke>] [--revoke-emails-file <emails_list_to_revoke>] [--revoke-ids <...ids_to_revoke>]
seald revoke --file <...files_path> [--revoke-emails <...emails_to_revoke>] [--revoke-emails-file <emails_list_to_revoke>] [--revoke-ids <...ids_to_revoke>]

Exemple ​

Révoquer deux utilisateurs ayant seald à l'aide de leur IDs, et deux utilisateurs n'ayant pas Seald à l'aide de leur adresse email.

bash
seald revoke -i chemin/fichier.pdf.seald --uids 'JqTsYFZAAuSHVGofjmsg8g' 'AAuSHVJqTsYFZGofjmsg8g' --emails 'email@domain.tld' 'email@domain.tld'
seald revoke -i chemin/fichier.pdf.seald --uids 'JqTsYFZAAuSHVGofjmsg8g' 'AAuSHVJqTsYFZGofjmsg8g' --emails 'email@domain.tld' 'email@domain.tld'

Options ​

  • --input, -f, --file, --files, -i Chemin des fichiers chiffrés. [array] [required]
  • --revoke-all, --all Révoquer tous les destinataires. [boolean]
  • --revoke-others, --others Révoquer tous les destinataires excepté ce compte. [boolean]
  • --revoke-emails, --emails Tableau des emails des destinataires n'ayant pas de compte Seald à révoquer. [array]
  • --revoke-emails-file, --emails-file Chemin d'un fichier contenant les emails des destinataires à révoquer. [string]
  • --revoke-ids, --uids Tableau des IDs des destinataires ayant un compte Seald à révoquer. [array]
  • --recursive, -r Si l'entrée est un dossier, révoquer les destinataires à tous les fichiers. [boolean]
  • --retries Si le système de fichier a une erreur, retenter ce nombre de fois (cela est toujours réessayé pour les autres erreurs). [number] [default: 3]
  • --on-error Choix du comportement quand une erreur survient lors de la révocation de plusieurs fichiers. [string] [choices: "ignore", "warn", "fail"] [default: "fail"]
  • --on-non-seald Choix du comportement si un fichier n'est pas un fichier Seald lors de la révocation de plusieurs fichiers. [string] [choices: "ignore", "warn", "fail"] [default: "warn"]
  • --parallel Nombre de processus lors d'une opération sur plusieurs fichiers. [number] [default: 10]
  • --auto-accept-contacts Est-ce qu'il faut demander une confirmation avant d'enregistrer de nouveaux contacts. Défaut à demander confirmation en mode strict, ne pas en demander en mode non strict. [boolean]
  • --progress Afficher une barre de progression. Activé par défaut, utiliser --no-progress pour le désactiver. [boolean] [default: true]

get-file-info ​

La commande get-file-info permet d'afficher les informations sur un fichier chiffré. Ces informations sont :

  • les destinataires ;
  • les destinataires révoqués ;
  • accusé de lecture.

Cette opération nécessite d'avoir un compte et une équipe.

bash
seald get-file-info --file <file_path>
seald get-file-info --file <file_path>

Exemple ​

Afficher les informations d'un fichier :

bash
seald get-file-info --file chemin/fichier.pdf.seald
seald get-file-info --file chemin/fichier.pdf.seald

Options ​

  • --input, -f, --file, --files, -i Chemin du fichier chiffré. [string] [required]

watch-encrypt ​

Surveille un dossier et chiffre tous les fichiers écrits dans ce dossier. Les fichiers chiffrés sont écrits dans un dossier de destination. L'arborescence est conservée.

Cette opération nécessite d'avoir un compte et une équipe. Si le mode strict est activé, il est interdit d'ajouter des destinataires n'ayant pas Seald.

bash
seald watch-encrypt --input <input_folder_path> --output <output_folder_path> [--remove] [--existing] [--recipients-ids <...recipients_ids>] [--recipients-emails <...recipients_emails>] [--recipients-emails-file <recipients_emails_file>]
seald watch-encrypt --input <input_folder_path> --output <output_folder_path> [--remove] [--existing] [--recipients-ids <...recipients_ids>] [--recipients-emails <...recipients_emails>] [--recipients-emails-file <recipients_emails_file>]

Options ​

  • --input, -i Dossier à surveiller [string] [required]
  • --output, -o Dossier de destination des fichiers chiffrés [string] [required]
  • --remove, -r Supprimer les fichiers en clair après chiffrement. [boolean]
  • --existing, -e Chiffrer les fichiers existant déjà dans le dossier. [boolean]
  • --retries Si il y a une erreur, réessayer ce nombre de fois [number] [default: 3]
  • --on-error Si il y a une erreur avec un chiffrement ou une suppression de fichier qui dépasse le nombre d'essais, est-ce que le processus doit sauter le fichier en question et afficher un avertissement, ou est-ce qu'il doit quitter. [string] [choices: "skip", "fail"] [default: "fail"]
  • --recipients-ids, --uids Liste des IDs des destinataires. Peut-être de la forme UID ou UID:sigchainHash pour vérifier le sigchainHash. [array] [default: []]
  • --recipients-emails, --emails Liste des emails des destinataires. Peut-être de la forme user@domain.ext, user@domain.ext:sigchainHash pour vérifier le sigchainHash. Pour les utilisateurs n'ayant pas Seald, si votre équipe a l'option activée, vous pouvez spécifier un numéro de téléphone en utilisant la forme user@domain.ext#+33612345678. [array] [default: []]
  • --recipients-emails-file, --emails-file Chemin d'un fichier contenant les emails des destinataires. [string]
  • --ignore-files, --ignore Liste de motifs glob anymatch à ignorer. Comparés de façon insensible à la casse aux noms de fichiers, pas les chemins complets. N'oubliez pas d'échapper les caractères spéciaux, pour éviter qu'ils soient interprétés par votre console. [array] [default: []]
  • --on-same-file-name Comportement en cas de conflit sur le nom du fichier de sortie [string] [choices: "overwrite", "error", "increment", "skip"] [default: "error"]
  • --auto-accept-contacts Est-ce qu'il faut demander une confirmation avant d'enregistrer de nouveaux contacts. Défaut à demander confirmation en mode strict, ne pas en demander en mode non strict. [boolean]
  • --poll-interval Temps d'attente (en millisecondes) entre vérifications du système de fichiers. [number] [default: 10000]
  • --stable-time Temps d'attente (en millisecondes) entre vérifications d'un fichier pour vérifier s'il est encore en cours d'écriture. [number] [default: 500]
  • --method, -m, --watch-method Méthode à utiliser pour surveiller le dossier d'entrée. Chokidar est le plus rapide et le plus efficace en utilisation processeur, mais dans certains cas d'autres méthodes peuvent être plus fiables. [required] [choices: "chokidar", "chokidar-poll", "list", "checksum"] [default: "chokidar"]
  • --parallel Nombre de processus lors d'une opération sur plusieurs fichiers (seulement pour chokidar). [number] [default: 10]
  • --encrypt-for-self Est-ce qu'il faut inclure l'utilisateur actuel comme destinataire. [boolean] [default: true]

Exemple ​

bash
seald watch-encrypt -i chemin/dossierChiffre/ -o chemin/dossierClaire/ -r -e --uids 'AAuSHVJqTsYFZGofjmsg8g' --on-same-file-name=increment
seald watch-encrypt -i chemin/dossierChiffre/ -o chemin/dossierClaire/ -r -e --uids 'AAuSHVJqTsYFZGofjmsg8g' --on-same-file-name=increment

create-backup-key ​

Créer une clé de récupération.

Cette opération nécessite d'avoir un compte et une équipe.

bash
seald create-backup-key [--device-name <device_name>] [--output <output_file>]
seald create-backup-key [--device-name <device_name>] [--output <output_file>]

Options ​

  • --output, -o Fichier dans lequel sera exportée la clé. [string] [default: "./seald-cli-backup.seald_key"]
  • --device-name, -n Nom de la clé de sauvegarde. [string] [default: null]
  • --key-password, -p Mot de passe pour chiffrer l'exportation de la clé. Chaîne vide pour exporter une clé non protégée. Si elle n'est pas spécifiée, le CLI la demandera plus tard. [string]

Exemple ​

bash
seald create-backup-key -o chemin/cle-de-recuperation.seald_key -n ma-cle-de-recuperation
seald create-backup-key -o chemin/cle-de-recuperation.seald_key -n ma-cle-de-recuperation

load-backup-key ​

Utiliser une clé de récupération.

Cette opération nécessite de ne pas avoir de compte créé.

bash
seald load-backup-key --key <key_file> [--offline]
seald load-backup-key --key <key_file> [--offline]

Options ​

  • --key, -k Fichier duquel charger la clé de récupération. [string] [required]
  • --offline Ne pas tenter de récupérer les données du compte en ligne après avoir chargé la clé de récupération. [boolean]
  • --disable-db-password Désactive la demande d'un mot de passe lors de la création de la base de données. Cette option n'est pas disponible pour l'application bureau. [boolean] [default: false]
  • --key-password, -p Mot de passe utilisé pour chiffrer la clé exportée. Si elle n'est pas spécifiée, le CLI la demandera plus tard. [string]

Exemple ​

bash
seald load-backup-key --key cle-de-recuperation.seald_key --offline
seald load-backup-key --key cle-de-recuperation.seald_key --offline

get-user-info ​

La commande get-user-info permet d'afficher des informations sur un utilisateur. Ces informations sont :

  • Le nom de l'utilisateur ;
  • L'identifiant de l'utilisateur ;
  • Le hash du dernier bloc de sa chaine de signatures ;
  • La validité de sa chaine de signatures ;
  • Les adresses email de l'utilisateur ;

Si aucun argument n'est fourni, la commande retourne les informations du compte utilisé.

Cette opération nécessite d'avoir un compte et une équipe.

bash
seald get-user-info [--email email] [--id user-id]
seald get-user-info [--email email] [--id user-id]

Options ​

  • --email, -e Email de l'utilisateur souhaité. [string]
  • --id, -id ID de l'utilisateur souhaité. [string]

Exemple ​

Afficher les informations d'un utilisateur :

bash
seald get-user-info --id G4ChkDGZR0eugk7z1TDwBA
seald get-user-info --email accountEmail-1@seald.io

Sortie attendue :
User informations:
Display name: accountName
User id: G4ChkDGZR0eugk7z1TDwBA
Sigchain hash: ab5c744bff8e537fca62cdb2ef9c966cfda93c579b4113933e04dd245f9f7d4c
Sigchain is valid: true
Known email addresses:
  - accountEmail-1@seald.io
  - accountEmail-2@seald.io
seald get-user-info --id G4ChkDGZR0eugk7z1TDwBA
seald get-user-info --email accountEmail-1@seald.io

Sortie attendue :
User informations:
Display name: accountName
User id: G4ChkDGZR0eugk7z1TDwBA
Sigchain hash: ab5c744bff8e537fca62cdb2ef9c966cfda93c579b4113933e04dd245f9f7d4c
Sigchain is valid: true
Known email addresses:
  - accountEmail-1@seald.io
  - accountEmail-2@seald.io

add-sigchain-transaction ​

La commande add-sigchain-transaction permet d'ajouter une transaction dans la chaine de signatures du compte.

WARNING

Cette commande doit être utilisée uniquement en cas de corruption de la chaine de signatures. Contactez le support Seald avant utilisation.

Cette opération nécessite d'avoir un compte et une équipe.

bash
seald add-sigchain-transaction [--type email] [--device-id device-id] [--created-at] [--expire-after] [--encryption-key-hash] [--encryption-key-b64] [--signing-key-hash] [--signing-key-b64] [--signer-key-hash] [--signer-key-b64] [--verify-sigchain]
seald add-sigchain-transaction [--type email] [--device-id device-id] [--created-at] [--expire-after] [--encryption-key-hash] [--encryption-key-b64] [--signing-key-hash] [--signing-key-b64] [--signer-key-hash] [--signer-key-b64] [--verify-sigchain]

Options ​

  • --type, -t Type d'opération [string] [required] [choices: "creation", "revocation", "renewal"]
  • --device-id, -d DeviceID concerné par l'opération [string] [required]
  • --created-at, -c UNIX Timestamp en secondes. Par défaut, l'heure actuelle est utilisé. [number]
  • --expire-after, -a Durée de validité des clés lors d'un renouvellement ou d'une création. Par défaut, cette durée est de 3 ans. [number]
  • --encryption-key-hash, -e Hash de l'operationEncryptionKey. Il doit s'agir d'une encryptionKey d'un des appareils de l'utilisateur. Sinon utilisez l'argument encryption-key. [string]
  • --encryption-key-b64 La operationEncryptionKey en entier, encodée en Base64. [string]
  • --signing-key-hash, -s Hash de l'operationSigningKey. Il doit s'agir d'une signingKey d'un des appareils de l'utilisateur. Sinon utilisez l'argument signing-key. [string]
  • --signing-key-b64 La operationSigningKey en entier, encodée en Base64. [string]
  • --signer-key-hash, -S Hash de la signingKey utilisée pour signer l'opération. Il doit s'agir de la clé actuelle, où d'une ancienne clé de signature de cet appareil. Sinon utilisez l'argument signer-key. Par défaut, la clé de signature actuelle de l'appareil est utilisée. [string]
  • --signer-key-b64 la signingKey en entier, encodée en Base64. [string]
  • --verify-sigchain Activer la verification de la sigchain coté serveur ou non. [boolean] [default: true]

change-db-password ​

La commande change-db-password permet de créer, changer ou supprimer le mot de passe utilisé pour le chiffrement de la base de données locale.

Cette commande n'est pas disponible pour l'application bureau.

Si un mot de passe est défini, toutes les commandes suivantes nécessiteront d'entrer ce mot de passe.

TIP

Vous pouvez sauvegarder le mot de passe de la base de données dans la variable d'environnement SEALD_DB_PASSWORD pour ne plus avoir à l'entrer à chaque utilisation.

Cette opération nécessite d'avoir créé une base de données.

bash
seald change-db-password
seald change-db-password

request-recovery ​

La commande request-recovery permet de créer une demande de récupération de compte.

Cette opération nécessite de ne pas avoir de compte créé.

bash
seald request-recovery [email] [user-id] [device-name]
seald request-recovery [email] [user-id] [device-name]

Options ​

  • --email, -e Email du compte à récupérer [string] [required]
  • --user-id Id du compte à récupérer [string]
  • --device-name Nom de l'appareil à ajouter [string]
  • --skip-validation Do not interactively await the validation code send by mail. You can validate it later using the validate-recovery command. [boolean] [default: false]

validate-recovery ​

La commande validate-recovery permet valider une demande de récupération.

Cette opération nécessite d'avoir créé une demande de récupération.

bash
seald validate-recovery [challenge]
seald validate-recovery [challenge]

Options ​

  • --challenge, -c Code envoyé par mail. Doit être au format 0000-0000 [string] [required]

verify-recovery ​

Instancie le compte une fois la récupération acceptée.

Cette commande ne peut être utilisée qu'une fois que la demande de récupération validée et acceptée par un administrateur de l'équipe.

bash
seald verify-recovery
seald verify-recovery

cancel-recovery-request ​

Supprime une demande de récupération de compte.

Cette commande ne peut être utilisée qu'après qu'une demande de récupération ait été créée.

bash
seald cancel-recovery-request
seald cancel-recovery-request

set-device-name ​

Définit le nom de l'appareil courant.

Cette opération nécessite d'avoir un compte et une équipe.

seald set-device-name [device-name]
seald set-device-name [device-name]

Options ​

  • --device-name, -n Nom à donner à l'appareil (36 caractères max) [string] [required]

create-group ​

Crée un groupe.

Cette opération nécessite d'avoir un compte et une équipe.

seald create-group [group-name] [members-emails] [admins-emails]
seald create-group [group-name] [members-emails] [admins-emails]

Options ​

  • --group-name, -n Nom du groupe. [string] [required]
  • --members-emails, --emails Emails des membres du groupe. Vous devez être inclus. [array]
  • --members-ids, --uids IDs des membres du groupe. Vous devez être inclus. [array]
  • --members-emails-file, --emails-file Chemin d'un fichier contenant les emails des membres. [string]
  • --admins-emails Emails des administrateurs du groupe. Les administrateurs doivent également être membres. Vous devez être inclus. [array]
  • --admins-ids IDs des administrateurs du groupe. Les administrateurs doivent également être membres. Vous devez être inclus. [array]
  • --auto-accept-contacts Est-ce qu'il faut demander une confirmation avant d'enregistrer de nouveaux contacts. Défaut à demander confirmation en mode strict, ne pas en demander en mode non strict. [boolean]

renew-group-key ​

Renouvelle les clés du groupe.

Cette opération nécessite d'avoir un compte et une équipe.

seald renew-group-key [group-id]
seald renew-group-key [group-id]

Options ​

  • --group-id, --gid ID du groupe. [string] [required]

add-group-members ​

Ajoute des membres à un groupe.

Cette opération nécessite d'avoir un compte et une équipe.

seald add-group-members [group-id] [new-members-emails]
seald add-group-members [group-id] [new-members-emails]

Options ​

  • --group-id, --gid ID du groupe. [string] [required]
  • --new-members-emails, --emails Emails des membres à ajouter. [array]
  • --new-members-ids, --uids IDs des membres à ajouter. [array]
  • --new-members-emails-file, --emails-file Chemin d'un fichier contenant les emails des membres à ajouter. [string]
  • --auto-accept-contacts Est-ce qu'il faut demander une confirmation avant d'enregistrer de nouveaux contacts. Défaut à demander confirmation en mode strict, ne pas en demander en mode non strict. [boolean]

remove-group-members ​

Supprime des membres d'un groupe. Après avoir supprimé un utilisateur, vous devez renouveler les clés du groupe.

Cette opération nécessite d'avoir un compte et une équipe.

seald remove-group-members [group-id] [members-to-remove-emails]
seald remove-group-members [group-id] [members-to-remove-emails]

Options ​

  • --group-id, --gid ID du groupe. [string] [required]
  • --members-to-remove-emails, --emails Emails des membres à supprimer. [array]
  • --members-to-remove-ids, --uids IDs des membres à supprimer. [array]
  • --members-to-remove-emails-file, --emails-file Chemin d'un fichier contenant les emails des membres à supprimer. [string]
  • --auto-accept-contacts Est-ce qu'il faut demander une confirmation avant d'enregistrer de nouveaux contacts. Défaut à demander confirmation en mode strict, ne pas en demander en mode non strict. [boolean]

set-group-admin ​

Définit le statut d'administrateur d'un membre du groupe. Ne peut être fait que par un administrateur du groupe.

Cette opération nécessite d'avoir un compte et une équipe.

seald set-group-admin [group-id] [member-email] [--new-status]
seald set-group-admin [group-id] [member-email] [--new-status]

Options ​

  • --group-id, --gid ID du groupe. [string] [required]
  • --member-email, --email Email du membre dont le status est à définir. [string]
  • --member-id, --uid ID du membre dont le status est à définir. [string]
  • --new-status, -s Statut à définir. [boolean] [required]
  • --auto-accept-contacts Est-ce qu'il faut demander une confirmation avant d'enregistrer de nouveaux contacts. Défaut à demander confirmation en mode strict, ne pas en demander en mode non strict. [boolean]

list-groups ​

Liste les groupes de l'équipe.

Cette opération nécessite d'avoir un compte et une équipe.

seald list-groups
seald list-groups

Options ​

  • --page, -p La liste des groupes est paginée par page de 10. [number]
  • --mine, -m N'afficher que les groupes dont l'utilisateur est membre. [boolean]
  • --all, -a Afficher tous les groupes en une seule fois. [boolean]

list-group-members ​

Liste tous les membres d'un groupe.

Cette opération nécessite d'avoir un compte et une équipe.

seald list-group-members [group-id]
seald list-group-members [group-id]

Options ​

  • --group-id, --gid ID du groupe. [string] [required]

validate-email ​

Valider un connecteur d'email déjà ajouté au compte

Ne peut être utilisé qu'après la création du compte.

seald validate-email [email] [code]
seald validate-email [email] [code]

Options ​

  • --email, -e Adresse électronique à valider. Vous devez spécifier soit email soit email-connector-id. [string]
  • --email-connector-id, --id ID du connecteur de messagerie à valider. Vous devez spécifier soit email soit email-connector-id. [string]
  • --validation-code, --code Code de validation envoyé à l'adresse électronique. [string] [required]

use-jwt ​

Utilisez un JWT pour rejoindre une équipe, ou pour ajouter un connecteur à l'utilisateur actuel.

Ne peut être utilisé qu'après la création du compte.

seald use-jwt
seald use-jwt

Options ​

  • --jwt JWT à utiliser [string] [required]
  • --accept-backup-keys Accepter automatiquement toutes les clés de sauvegarde des équipes (uniquement si le JWT vous ajoute à une équipe) [boolean]

Options globales ​

Aide ​

Une aide peut être affichée en CLI en utilisant l'option --help.

L'option --version retourne la version de Seald actuellement installée.

Niveau de log ​

Trois niveaux de log sont disponibles via l'ajout d'un des arguments suivants :

  • --verbose, -v Niveau de log par défaut.
  • --silly Afficher tous les logs.
  • --silent Niveau minimal de logs.

Proxy ​

Si Seald-CLI est exécuté depuis un poste devant se connecter à un proxy pour avoir accès à internet, il est possible de passer un argument --proxy <url>.

Options avancées ​

Ces options ne sont pas disponibles pour l'application bureau.

  • --seald-dir Chemin de la base de donnée. [string] [default: "$HOME/.seald-cli"]
  • --key-size Spécifie la taille en bits des clés RSA utilisées. [number] [choices: 1024, 2048, 4096] [default: 4096]
  • --strict-mode Active le mode strict. Certaines options seront désactivées, mais la sécurité sera renforcée. [boolean] [default: false]
  • --disable-error-reports Désactive les envois de rapports d'erreurs à Seald. [boolean] [default: false]
  • --issuer-fingerprint Empreinte du certificat de l'émetteur du certificat du serveur API. Plusieurs certificats peuvent être séparés par des virgules. [string] [default: "67:AD:D1:16:6B:02:0A:E6:1B:8F:5F:C9:68:13:C0:4C:2A:A5:89:96:07:96:86:55:72:A3:C7:E7:37:61:3D:FD,73:0C:1B:DC:D8:5F:57:CE:5D:C0:BB:A7:33:E5:F1:BA:5A:92:5B:2A:77:1D:64:0A:26:F7:A4:54:22:4D:AD:3B,46:49:4E:30:37:90:59:DF:18:BE:52:12:43:05:E6:06:FC:59:07:0E:5B:21:07:6C:E1:13:95:4B:60:51:7C:DA,1A:07:52:9A:8B:3F:01:D2:31:DF:AD:2A:BD:F7:18:99:20:0B:B6:5C:D7:E0:3C:59:FA:82:27:25:33:35:5B:74,5A:8F:16:FD:A4:48:D7:83:48:1C:CA:57:A2:42:8D:17:4D:AD:8C:60:94:3C:EB:28:F6:61:AE:31:FD:39:A5:FA,BA:CD:E0:46:30:53:CE:1D:62:F8:BE:74:37:0B:BA:E7:9D:4F:CA:F1:9F:C0:76:43:AE:F1:95:E6:A5:9B:D5:78,73:1D:3D:9C:FA:A0:61:48:7A:1D:71:44:5A:42:F6:7D:F0:AF:CA:2A:6C:2D:2F:98:FF:7B:3C:E1:12:B1:F5:68,25:84:7D:66:8E:B4:F0:4F:DD:40:B1:2B:6B:07:40:C5:67:DA:7D:02:43:08:EB:6C:2C:96:FE:41:D9:DE:21:8D"]
  • --decrypt-url URL du serveur de déchiffrement de Seald. [string] [default: "https://decrypt.seald.io/"]
  • --api-url URL du serveur API de Seald. [string] [default: "https://api.seald.io/"]