Skip to content
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

Jump to bottom

Stop using "checksumming" instead of "encrypting" in the docs #76168

Merged
merged 2 commits into from Nov 4, 2021
Merged

Stop using "checksumming" instead of "encrypting" in the docs #76168

merged 2 commits into from Nov 4, 2021

Conversation

vice
Copy link

@vice vice commented Oct 28, 2021

All encryption systems have a formal inverse function to decrypt
A hash is a one way function without inverse by definition

SUMMARY

Change title in template filter documentation that says encrypting when hashing is described

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

Template hashing and checksum filters

@vice
Hashing is not encrypting
2c4d75a 
All encryption systems have a formal inverse function to decrypt
A hash is a one way function without inverse by definition
@vice vice changed the title Hashing is not encrypting Docs: Hashing is not encrypting Oct 28, 2021
@ansibot ansibot added affects_2.13 core_review In order to be merged, this PR must follow the core review workflow. docs This issue/PR relates to or includes documentation. docs_only All changes are to files within the docs/docsite/ directory needs_triage Needs a first human triage before being processed. new_contributor This PR is the first contribution by a new community member. small_patch support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Oct 28, 2021
webknjaz
webknjaz requested changes Oct 28, 2021
View reviewed changes
Copy link
Member

@webknjaz webknjaz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution, I reviewed it and discovered that below the hashing examples in this documentation section, there are also examples of encryption with vault/unvault at the bottom. So it sounds like there's both encryption and hashing present. Note that the title also mentions "checksumming" — I believe that this part is what refers to hashing in the examples. Would you agree with this judgement?

@ansibot ansibot added needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed core_review In order to be merged, this PR must follow the core review workflow. labels Oct 28, 2021
@vice
Copy link
Author

vice commented Oct 28, 2021

You are right that now there is content about vault storage and that is encrypted storage. This content have been added in commit 90518d8 on September 1th 2021 and I haven't read it in https://docs.ansible.com/ansible/latest/user_guide/playbooks_filters.html#encrypting-and-checksumming-strings-and-passwords.

Preparing this pull request I noticed the vault part but thought that it would be another section.

So this title was wrong all this time but could be correct thanks to this recent addition.

@vice
Copy link
Author

vice commented Oct 28, 2021

I agree that cryptographically strong hash code could be a good checksum. But Checksums and hashes have different uses and requirements.

See introductions from wikipedia:
https://en.wikipedia.org/wiki/Checksum
https://en.wikipedia.org/wiki/Hash_function

@webknjaz
Copy link
Member

Well, it is there now: https://docs.ansible.com/ansible-core/devel/user_guide/playbooks_filters.html#encrypting-and-checksumming-strings-and-passwords.

@nitzmahone nitzmahone removed the needs_triage Needs a first human triage before being processed. label Oct 28, 2021
@samccann
Copy link
Contributor

samccann commented Nov 4, 2021

@webknjaz what do you think of the updated heading now?

@ansibot ansibot added needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI. core_review In order to be merged, this PR must follow the core review workflow. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. core_review In order to be merged, this PR must follow the core review workflow. labels Nov 4, 2021
webknjaz
webknjaz approved these changes Nov 4, 2021
View reviewed changes
Copy link
Member

@webknjaz webknjaz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@webknjaz webknjaz changed the title Docs: Hashing is not encrypting Stop using "checksumming" instead of "encrypting" in the docs Nov 4, 2021
@webknjaz webknjaz merged commit a1236a5 into ansible:devel Nov 4, 2021
ariordan-redhat pushed a commit to ariordan-redhat/ansible that referenced this pull request Nov 16, 2021
@vice @samccann @ariordan-redhat
Stop using "checksumming" instead of "encrypting" in the docs (ansibl…
802f342 
…e#76168)

* Hashing is not encrypting

All encryption systems have a formal inverse function to decrypt
A hash is a one way function without inverse by definition

* Update docs/docsite/rst/user_guide/playbooks_filters.rst

Co-authored-by: Sandra McCann <samccann@redhat.com>
@ariordan-redhat ariordan-redhat mentioned this pull request Nov 16, 2021
Merged
nitzmahone pushed a commit that referenced this pull request Nov 24, 2021
@ariordan-redhat @vice
@samccann @felixfontein @samdoran @lilatomic @nkoechling
[Backport][Docs] Docs 2.12 backportapalooza7 (#76298)
04967a5 
* Stop using "checksumming" instead of "encrypting" in the docs (#76168)

* Hashing is not encrypting

All encryption systems have a formal inverse function to decrypt
A hash is a one way function without inverse by definition

* Update docs/docsite/rst/user_guide/playbooks_filters.rst

Co-authored-by: Sandra McCann <samccann@redhat.com>

* ansible-core 2.12 dropped support for galaxy.yaml. (#76179)

* apt - remove obsolete documentation (#76243)

The lock_timeout feature was recently added to the apt module making
this section in the documentation no longer necessary

* Documentation for other types in collection `requirements.yml` (#75872)

* Docs: Link to valid data types for role parameters (#76276)

* Fixed typo in keyword_desc.yml (#76280)

The description of 'max_fail_percentage' had a typo.

* Restore documentation on M() and R() (#76284)

* Undo most of bf99442, add note on where R() does not work.
Co-authored-by: Brian Scholer <1260690+briantist@users.noreply.github.com>

Co-authored-by: Vicente Jimenez Aguilar <googuy@gmail.com>
Co-authored-by: Sandra McCann <samccann@redhat.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Sam Doran <sdoran@redhat.com>
Co-authored-by: Daniel Goldman <merkavabuilder@gmail.com>
Co-authored-by: nkoechling <nkoechling@users.noreply.github.com>
@ansible ansible locked and limited conversation to collaborators Nov 25, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@samccann samccann samccann left review comments

@webknjaz webknjaz webknjaz approved these changes

Assignees
No one assigned
Labels
affects_2.13 docs_only All changes are to files within the docs/docsite/ directory docs This issue/PR relates to or includes documentation. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. new_contributor This PR is the first contribution by a new community member. small_patch support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@vice @webknjaz @samccann @ansibot @nitzmahone