Skip to content

Chiffrement en base des secrets d'accès des sources - #620

Open
JeromeBu wants to merge 2 commits into
mainfrom
feat/encrypt-source-credentials
Open

JeromeBu wants to merge 2 commits into
mainfrom
feat/encrypt-source-credentials

Conversation

@JeromeBu

Copy link
Copy Markdown
Collaborator

Suite de la #619 : les secrets d'accès des sources (sources.configuration.auth : jetons GitHub/GitLab, bearer HAL/Zenodo/Wikidata, Client-Id ROR) sont chiffrés en base quand la variable SOURCE_CREDENTIALS_KEY est définie.

  • Chiffrement AES-256-GCM avec node:crypto, sans nouvelle dépendance. Valeur stockée : enc:v1: suivi du base64 de l'IV (12 octets), du tag (16 octets) et du texte chiffré. Grâce au préfixe, les valeurs chiffrées et en clair peuvent coexister, et le format pourra évoluer.
  • Le chiffrement se fait à la frontière de createPgSourceRepository : déchiffrement aux 5 lectures, chiffrement à l'écriture (update). Le reste du code manipule toujours le jeton en clair, en mémoire. Aucun autre chemin ne lit ce champ directement. La seed recopie configuration telle quelle, donc une valeur chiffrée reste chiffrée.
  • La clé est optionnelle, ce qui ne casse aucun déploiement :
    • Sans clé, rien ne change : les jetons restent en clair.
    • Avec clé, l'API chiffre au démarrage les jetons encore en clair (encryptPlainCredentials, idempotent grâce au préfixe). L'écriture ne remplace que auth, et seulement si la valeur n'a pas changé entre-temps.
  • La clé (32 octets en base64) est validée au chargement de l'env, puis transmise explicitement à l'API et aux jobs update, import et import-from-inner-identifiers.
  • Une clé absente ou fausse est signalée au plus tôt : le démarrage vérifie que chaque jeton chiffré se déchiffre, sinon l'API refuse de démarrer. Les jobs échouent à la lecture des sources. Le message d'erreur ne contient jamais le jeton, et aucun jeton chiffré n'est envoyé tel quel à une forge.
  • Le web ne reçoit toujours que isCredentialSet.
  • Doc : nouvelle section « Encryption of the credentials » dans docs/6-env-variables-and-customization.md. Elle décrit l'activation, la requête de vérification et ce qu'implique une clé perdue, une copie de base vers la préprod ou un retour à une version antérieure. Variable ajoutée en commentaire dans les deux .env.sample et dans values.yaml du chart (api.env est aussi transmis au cronjob update).

Choix faits :

  • Chiffrement symétrique : l'asymétrique n'apporterait rien, puisque l'API qui écrit les jetons s'en sert aussi (vérification d'URL de dépôt, préremplissage, test de connexion).
  • Pas de commande pour tout déchiffrer : le format est documenté, et un déchiffrement manuel reste possible avec la clé.
  • Pas de rotation de clé : pour changer de clé, on efface les jetons et on les ressaisit.

Déploiement :

  • Monter de version sans définir la clé ne change rien.
  • Pour activer le chiffrement, ajouter SOURCE_CREDENTIALS_KEY à l'API et aux jobs, puis redémarrer l'API.
  • Pour le SILL, la clé va dans le .env du serveur, partagé par l'API et l'update. Mieux vaut l'ajouter une fois cette version stable en prod : une version antérieure enverrait les valeurs chiffrées comme jetons.

Tests :

  • Unitaires : aller-retour, mauvaise clé, valeur altérée, valeur en clair héritée, valeur chiffrée sans clé, format inconnu, validation de la clé.
  • Intégration (adminSources.e2e.test.ts) :
    • au démarrage, la valeur en base passe en enc:v1: et la lecture rend le clair ;
    • une seconde passe ne change rien ;
    • un jeton saisi par un admin est stocké chiffré et n'est jamais renvoyé ;
    • l'API refuse de démarrer sans clé ou avec une autre clé, et un job sans clé échoue.
  • Ces tests échouent sans le code.
  • Typecheck, lint et format passent. Tests API : 273 passent, 4 ignorés.

🤖 Generated with Claude Code

Encrypt sources.configuration.auth with AES-256-GCM when SOURCE_CREDENTIALS_KEY
is set, at the boundary of the source repository. Credentials stored in clear
are encrypted when the API starts, which also fails fast on a missing or wrong
key.
@JeromeBu
JeromeBu force-pushed the feat/encrypt-source-credentials branch from 8592dc7 to 5eb5129 Compare November 12, 2026 19:05

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant