Proposal: "Recommended" badges

Ouverte
#10 5 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
5/5
Temps estimé
Plus d'une semaine
Accessibilité débutants
25/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
rust

Piste de recherche

Read the linked algorithm guidance issues and HAZMAT.md for the existing rubric. The proposal calls for a shared explanation of the badges and consistent recommendations across crates; it is marked in progress and points to tracking issues for AEADs, hashes, and password hashes. Done means those recommendations are consistently documented and the badge meanings link to their guidance.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

question

Edit: this is in-progress. See the following tracking issues:


We have a few open issues about algorithm guidance, such as https://github.com/RustCrypto/password-hashes/issues/48

While we have some precedent for this, such as the "Security" rubric here:

https://github.com/rustcrypto/hashes#supported-algorithms

...we don't have a consistent way of communicating this information across all repos/crates, which I think would be helpful.

I'd like to propose adding a "recommended" badge to each crate which uses the following rubric and links back to documentation (similar to HAZMAT.md) about what the badge means.

Recommended: Yes

Recommended: Yes

Preferred modern algorithms we suggest people embrace in new projects.

Recommended: Neutral

Recommended: Neutral

Algorithms which are still considered secure, but are obscure, uncommonly used, and/or poorly-analyzed.

Recommended: No!

Recommended: No!

Algorithms which are known to be cryptographically broken and should only be used because legacy interop requires it.

Langage dominant
Aucune donnée de langage
Étoiles
13
Forks
4
Merge moyen
41 min
PR mergées (30 j)
1

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de RustCrypto/meta

Toutes les issues de RustCrypto/meta

Issues similaires

Plus d'issues Documentation

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.