Proposal: "Recommended" badges

Aberta
#10 5 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
25/100
Tipo de issue
Funcionalidade
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
rust

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante
Sem dados de linguagem
Estrelas
13
Forks
4
Merge médio
41min
PRs com merge (30d)
1

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de RustCrypto/meta

Todas as issues de RustCrypto/meta

Issues semelhantes

Mais issues de Documentation

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.