Skip to content

Adding security considerations #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 3, 2022
Merged

Adding security considerations #38

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c418120
Adding security considerations
germa89 Feb 2, 2022
1ccd2b4
Apply suggestions from code review
germa89 Feb 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions doc/source/coding_style/best_practices.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://blog.sonarsource.com/10-unknown-security-pitfalls-for-python>`_ - By Dennis Brinkrolf - Sonar source blog

.. [#] Wikipedia - `Software development security <https://en.wikipedia.org/wiki/Software_development_security>`_.