aws / aws/aws-encryption-sdk-python
Document that non-Encryption SDK exceptions can be raised
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- Python
- Estrelas
- 255
- Forks
- 92
- Merge médio
- 2d 17h
- PRs com merge (30d)
- 2
Descrição
The API documentation for the Python Encryption SDK lists [custom exception types](https://aws-encryption-sdk-python.readthedocs.io/en/latest/generated/aws_encryption_sdk.exceptions.html), but the APIs may let through exceptions from underlying libraries (e.g. `InvalidTag` and `InvalidSignature`) from pyca/cryptography. We should add a note to the documentation stating this.
Alternatively (or additionally) we can try to wrap these kind of exceptions into Encryption SDK custom exceptions with additional context.
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece pela documentação da API do Python Encryption SDK e pela página de exceções geradas vinculada na issue; verifique como os tipos de exceção personalizados são descritos atualmente. Considera-se concluído quando a documentação indicar claramente que exceções criptográficas subjacentes, como InvalidTag e InvalidSignature, podem ser propagadas, a menos que o projeto escolha a alternativa de encapsulá-las.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- cryptography, python
- Domínio
- documentation, security
- Tipo de issue
- Documentação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 45/100