Proposal: "Recommended" badges

Offen
#10 5 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
25/100
Issue-Typ
Feature
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Tech-Stack
rust

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.

Vorherrschende Sprache
Keine Sprachdaten
Sterne
13
Forks
4
Ø Merge
41 Min.
Gemergte PRs (30 T.)
1

Entwicklungsumgebung

Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus RustCrypto/meta

Alle Issues in RustCrypto/meta

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.