SubtleCrypto.digest()

Contexte sécurisé
Cette fonctionnalité est uniquement disponible dans des contextes sécurisés (HTTPS), pour certains navigateurs qui la prennent en charge.

La méthode digest() de l'interface SubtleCrypto génère un digest de la donnée fournie. Un condensé est une petite valeur de taille fixe issue d'une donnée de taille variable. Les condensés cryptographiques doivent résister à la collision, ce qui signifie qu'il doit être très difficile d'obtenir le même condensé à partir de deux entrés différentes.

Il prend en argument un identifiant pour l'algorithme de condensé et les données à traiter. Il retourne une Promise qui contiendra le condensé.

Syntaxe

const digest = crypto.subtle.digest(algorithm, data);

Paramètres

  • algorithm est une DOMString indiquant la fonction de condensé à utiliser. Les valeurs possibles sont:
    • SHA-1 (ne pas utiliser pour des applications cryptographiques)
    • SHA-256
    • SHA-384
    • SHA-512.
  • data est un ArrayBuffer ou un ArrayBufferView contenant les données à traiter.

Valeur retournée

Algorithmes supportés

Les algorithmes de condensé, aussi connue sous le nom de fonctions de hachage cryptographique, transforme un bloque de données de longueur arbitraire dans un résultat de taille fixe, souvent plus petit que l'entré. Ils ont de nombreuses utilisations en cryptographie.

SHA-1

Cet algorithme est spécifié dans FIPS 180-4, section 6.1, et produit un résultat de 160 bits de long.

Avertissement: Cet algorithme est maintenant considérer comme vulnérable et ne doit pas être utilisé pour des applications cryptographiques.

SHA-256

Cet algorithme est spécifié dans FIPS 180-4, section 6.2, et produit un résultat de 256 bits de long.

SHA-384

Cet algorithme est spécifié dans FIPS 180-4, section 6.5, et produit un résultat de 384 bits de long.

SHA-512

Cet algorithme est spécifié dans FIPS 180-4, section 6.4, et produit un résultat de 512 bits de long.

Indice: Si vous cherchez à créer un condensé pour authentifié un message (HMAC), vous aurez plutôt besoin de SubtleCrypto.sign().

Exemples

Exemple basique

Cet exemple encode un message, puis calcule le condensé avec SHA-256, enfin affiche la longueur du résultat.

const text = 'Un obscur message venant du le système S-K, votre majesté. Ses habitants le nomment la planète Terre.';

async function digestMessage(message) {
  const encoder = new TextEncoder();
  const data = encoder.encode(message);
  const hash = await crypto.subtle.digest('SHA-256', data);
  return hash;
}

const digestBuffer = await digestMessage(text);
console.log(digestBuffer.byteLength);

Convertir un condensé vers une chaîne hexadécimale

Le condensé est retourné sous forme d'un ArrayBuffer, mais la comparaison et l'affichage se fait souvent avec des chaînes hexadécimales. Cet exemple calcule un condensé puis converti l'ArrayBuffer vers une chaîne hexadécimale.

const text = 'Un obscur message venant du le système S-K, votre majesté. Ses habitants le nomment la planète Terre.';

async function digestMessage(message) {
  const msgUint8 = new TextEncoder().encode(message);                           // encode comme (utf-8) Uint8Array
  const hashBuffer = await crypto.subtle.digest('SHA-256', msgUint8);           // fait le condensé
  const hashArray = Array.from(new Uint8Array(hashBuffer));                     // convertit le buffer en tableau d'octet
  const hashHex = hashArray.map(b => b.toString(16).padStart(2, '0')).join(''); // convertit le tableau en chaîne hexadélimale
  return hashHex;
}

const digestHex = await digestMessage(text);
console.log(digestHex);

Spécifications

Spécifications Statue Commentaire
Web Cryptography API
La définition de 'SubtleCrypto.digest()' dans cette spécification.
Recommendation Définition intiale

Compatibilité des navigateurs

Update compatibility data on GitHub
OrdinateurMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariWebview AndroidChrome pour AndroidFirefox pour AndroidOpera pour AndroidSafari sur iOSSamsung Internet
digestChrome Support complet 37Edge Support partiel 12
Notes
Support partiel 12
Notes
Notes Not supported: SHA-1.
Firefox Support complet 34
Support complet 34
Aucun support 32 — 34
Désactivée
Désactivée From version 32 until version 34 (exclusive): this feature is behind the dom.webcrypto.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.
IE Support partiel 11
Notes
Support partiel 11
Notes
Notes Returns CryptoOperation instead of Promise
Opera Support complet 24Safari Support complet 7WebView Android Support complet 37Chrome Android Support complet 37Firefox Android Support complet 34
Support complet 34
Aucun support 32 — 34
Désactivée
Désactivée From version 32 until version 34 (exclusive): this feature is behind the dom.webcrypto.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.
Opera Android Support complet 24Safari iOS Support complet 7Samsung Internet Android Support complet 6.0

Légende

Support complet  
Support complet
Support partiel  
Support partiel
Voir les notes d'implémentation.
Voir les notes d'implémentation.
Une action explicite de l'utilisateur est nécessaire pour activer cette fonctionnalité.
Une action explicite de l'utilisateur est nécessaire pour activer cette fonctionnalité.

 Dans Chrome 60, une fonctionnalité a été ajoutée qui désactive crypto.subtle pour les connexions non TLS.

Voir aussi