PROD_PP_Zoom_sur_SWHID

Zoom sur SWHID

Date de publication : 16/09/2025

1. Qu'est-ce qu'un identifiant SWHID ?

Développé par Software Heritage , SWHID (Software Hash Identifier) est un standard international qui permet d’identifier de manière unique les codes sources des logiciels.

L’identifiant SWHID est un code alphanumérique constitué :

• du préfixe "swh",
• du numéro de version du code source, dans l'exemple il s'agit de la version "1",
• d'une balise qui identifie le type de code source, ici "cnt" identifie le contenu d’un fichier unique,
• du hachage cryptographique "object_id" qui garantit l’intégrité et la sécurité des données lors de leur transfert entre systèmes informatiques.

2. À quoi sert un identifiant SWHID ?

L’identifiant SWHID permet de pointer vers différents composants du logiciel ainsi que vers des actions de son historique de développement. Il facilite la citation et, ainsi, la réutilisation des codes. L’identifiant SWHID favorise la reproductibilité de la recherche.

Cas d'utilisation

3. Comment obtenir un identifiant SWHID ?

Il existe plusieurs options pour obtenir un SWHID :

• Via l’archive Software Heritage.

• Via un dépôt de code dans HAL avec transfert vers Software Heritage.

Cas d'utilisation dans Software Heritage

Cas d'utilisation dans HAL

Crédits

Granger S, Mélès B, Santos F. (2024). Préserver et rendre identifiables les logiciels de recherche avec Software Heritage. https://doi.org/10.46430/phfr0034 HAL Documentation (2025). Déposer le code source d’un logiciel. https://doc.hal.science/deposer/deposer-le-code-source/ Software Heritage. (2025, juin). Using the SoftWare Hash Identifier (SWHID): A tutorial. https://www.softwareheritage.org/2025/06/13/software-hash-identifier-swhid-tutorial/

Les cas d’utilisation d’un identifiant SWHID sont :

• Le référencement de code spécifique : il pointe directement vers des versions ou des parties spécifiques du code (fichiers, répertoires, révisions, etc.).

• La reproductibilité d’une recherche : à partir d’un identifiant, il est possible de régénérer ou vérifier le contenu exact auquel il fait référence, même si l'infrastructure d'origine où il a été trouvé n'est plus disponible.

• La citation de logiciels : l’identifiant SWHID est conçu pour être utilisé dans les citations de logiciels. Pour ce faire, il est recommandé d'inclure des fichiers de métadonnées tels que codemeta.json ou citation.cff à côté du code dans le même répertoire.

Source : Software Heritage. (2025, juin). Using the SoftWare Hash Identifier (SWHID): A tutorial.

Dépôt de code dans HAL avec transfert vers Software Heritage :

• Si le code est sur une machine locale : il faut compresser les fichiers et déposer l’archive .zip, .tar, .gz, etc. sur HAL.
• Si le code est sur une plateforme de développement (GitHub, GitLab, etc.) : il faut le sauvegarder sur Software Heritage avec la fonctionnalité « Save code now ». L’identifiant SWHID obtenu est à copier/coller sur HAL.
• Si le code est déjà sur Software Heritage et qu'il est à jour : on peut récupérer l'identifiant SWHID tel quel. La mise à jour en cliquant sur le bouton « Save again » n'intervient seulement qu'en cas de besoin.

L'archive Software Heritage :

• Le plus souvent l'identifiant SWHID existe déjà sur l'archive Software Heritage grâce au moissonnage automatique des plateformes de développement (GitHub, GitLab, etc.). Il suffit alors de le récupérer dans la fenêtre dédiée à l'enregistrement.
• Si l'identifiant SWHID n'est pas présent sur l'archive Software Heritage ou s'il y a besoin d'une mise à jour, il suffit de compléter le formulaire en ligne "Save code now".

Il n’est pas nécessaire de posséder un compte sur Software Heritage et l’obtention d’un identifiant SWHID est gratuite.