Skip to content

Clarify and improve encryption documentation#8652

Merged
behlendorf merged 1 commit intoopenzfs:masterfrom
rlaager:encryption-limitations
Apr 25, 2019
Merged

Clarify and improve encryption documentation#8652
behlendorf merged 1 commit intoopenzfs:masterfrom
rlaager:encryption-limitations

Conversation

@rlaager
Copy link
Copy Markdown
Member

@rlaager rlaager commented Apr 22, 2019

Motivation and Context

I've been reviewing documentation, especially that related to new features like encryption. I have a tendency to edit everything under my cursor. ;)

Description

  • Remove the language that "all user data" is encrypted. This is to avoid misunderstandings or arguments about what is "user data", especially in light of "user properties".
  • Document that properties are unencrypted.
  • Document that snapshot names are unencrypted.
  • For consistency with the rest of the zfs.8 man page, use "ZFS" as the generic noun, not (bolded) "zfs". The latter refers to the command. Likewise, use "ZFS" instead of "the kernel module".
  • Give "a passphrase" as an example of a "user's key".

How Has This Been Tested?

I reviewed the changes with man.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Performance enhancement (non-breaking change which improves efficiency)
  • Code cleanup (non-breaking change which makes code smaller or more readable)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (a change to man pages or other documentation)

Checklist:

@rlaager rlaager requested review from behlendorf and gmelikov April 22, 2019 00:11
@rlaager rlaager added this to the 0.8.0 milestone Apr 22, 2019
@rlaager rlaager requested a review from tcaputi April 22, 2019 00:11
@rlaager rlaager added the Status: Code Review Needed Ready for review and testing label Apr 22, 2019
@rlaager
Copy link
Copy Markdown
Member Author

rlaager commented Apr 22, 2019

@tcaputi Am I correct that properties (especially user properties) are not encrypted?

Copy link
Copy Markdown
Contributor

@tcaputi tcaputi left a comment

Choose a reason for hiding this comment

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

You are correct about properties. This LGTM, with 1 small suggestion.

Copy link
Copy Markdown
Member

@gmelikov gmelikov left a comment

Choose a reason for hiding this comment

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

LGTM

- Remove the language that "all user data" is encrypted.  This is to
  avoid misunderstandings or arguments about what is "user data",
  especially in light of "user properties".
- Document that properties are unencrypted.
- Document that snapshot names are unencrypted.
- For consistency with the rest of the zfs.8 man page, use "ZFS" as the
  generic noun, not (bolded) "zfs".  The latter refers to the command.
  Likewise, use "ZFS" instead of "the kernel module".
- Give "a passphrase" as an example of a "user's key".

Signed-off-by: Richard Laager <rlaager@wiktel.com>
@rlaager rlaager force-pushed the encryption-limitations branch from b997ff4 to 128515f Compare April 22, 2019 05:33
@rlaager rlaager removed the request for review from behlendorf April 22, 2019 05:35
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 22, 2019

Codecov Report

Merging #8652 into master will increase coverage by 0.07%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #8652      +/-   ##
==========================================
+ Coverage   78.69%   78.77%   +0.07%     
==========================================
  Files         381      381              
  Lines      117578   117578              
==========================================
+ Hits        92527    92618      +91     
+ Misses      25051    24960      -91
Flag Coverage Δ
#kernel 79.26% <ø> (ø) ⬆️
#user 67.55% <ø> (+0.48%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e8864b1...128515f. Read the comment docs.

@behlendorf behlendorf added Status: Accepted Ready to integrate (reviewed, tested) and removed Status: Code Review Needed Ready for review and testing labels Apr 23, 2019
@behlendorf behlendorf merged commit 2b127af into openzfs:master Apr 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Status: Accepted Ready to integrate (reviewed, tested)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants