From c418120be37c2a0dedbaafd5477d34f059ec789b Mon Sep 17 00:00:00 2001 From: German Date: Wed, 2 Feb 2022 18:46:01 +0100 Subject: [PATCH 1/2] Adding security considerations --- doc/source/coding_style/best_practices.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/doc/source/coding_style/best_practices.rst b/doc/source/coding_style/best_practices.rst index 90875c70..9be78d37 100644 --- a/doc/source/coding_style/best_practices.rst +++ b/doc/source/coding_style/best_practices.rst @@ -709,3 +709,16 @@ letter is a consonant. The second approach is more readable and better documented. Additionally, you could implement a unit test for ``is_consonant``. + + +Security Considerations +~~~~~~~~~~~~~~~~~~~~~~~ + +Security is is an ongoing process involving people and practices, and ensures application confidentiality, integrity, and availability [#]_. +Any library should be secure and implement good practices that avoid or mitigate possible security risks. +This is especially relevant in libraries that requests user input (such web-services). +Security is a very wide topic hence we do recommend to have a look at the following useful resources: + +* `10 Unknown Security Pitfalls for Python `_ - By Dennis Brinkrolf - Sonar source blog + +.. [#] Wikipedia - `Software development security `_. From 1ccd2b49b07ab2dbf0d3d50794a0f91c75ab9818 Mon Sep 17 00:00:00 2001 From: German <28149841+germa89@users.noreply.github.com> Date: Thu, 3 Feb 2022 15:47:51 +0100 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> --- doc/source/coding_style/best_practices.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/source/coding_style/best_practices.rst b/doc/source/coding_style/best_practices.rst index 9be78d37..1b3da7e2 100644 --- a/doc/source/coding_style/best_practices.rst +++ b/doc/source/coding_style/best_practices.rst @@ -714,10 +714,10 @@ you could implement a unit test for ``is_consonant``. Security Considerations ~~~~~~~~~~~~~~~~~~~~~~~ -Security is is an ongoing process involving people and practices, and ensures application confidentiality, integrity, and availability [#]_. +Security, an ongoing process involving people and practices, ensures application confidentiality, integrity, and availability [#]_. Any library should be secure and implement good practices that avoid or mitigate possible security risks. -This is especially relevant in libraries that requests user input (such web-services). -Security is a very wide topic hence we do recommend to have a look at the following useful resources: +This is especially relevant in libraries that request user input (such as web services). +Because security is a broad topic, we recommend you review this useful Python-specific resource: * `10 Unknown Security Pitfalls for Python `_ - By Dennis Brinkrolf - Sonar source blog