adduser(8): Add documentation for ZFS encrypted home dataset
Needs ReviewPublic
Actions

Authored by lme on Dec 8 2024, 10:18 PM.

Details

Reviewers

john.grafton_runbox.com
des
wosch
bcr
kevans
• grahamperrin

Group Reviewers

manpages

Summary

Fill in missing documentation on how to configure a ZFS encrypted
home dataset to auto mount during login and provide an example
configuration through commented lines in PAM configuration that
match test plan from https://reviews.freebsd.org/D28018

PR: 282957
Reported by: Mike Watkins <git@mikewatkins.ca>

Diff Detail

Repository

rG FreeBSD src repository

Lint

Lint Skipped

Unit

Tests Skipped

Build Status

Buildable 61149
Build 58033: arc lint + arc unit

Event Timeline

john.grafton_runbox.com created this revision.Dec 8 2024, 10:18 PM

Herald added a subscriber: imp. · View Herald TranscriptDec 8 2024, 10:18 PM

john.grafton_runbox.com requested review of this revision.Dec 8 2024, 10:18 PM

Harbormaster completed remote builds in B61040: Diff 147713.Dec 8 2024, 10:18 PM

• grahamperrin added a subscriber: • grahamperrin.Dec 11 2024, 5:52 PM

• grahamperrin requested changes to this revision.Dec 12 2024, 12:18 AM

• grahamperrin added inline comments.

usr.sbin/adduser/adduser.8
148
150
151–152
153–154
163
166
167
168
169
usr.sbin/adduser/adduser.sh
260–261
261
639

This revision now requires changes to proceed.Dec 12 2024, 12:18 AM

Updated language to match Graham's suggestions

Harbormaster completed remote builds in B61149: Diff 147935.Dec 13 2024, 9:24 PM

patmaddox added a subscriber: patmaddox.Dec 18 2024, 10:12 AM

Thanks. With all inlines hidden, the language looks OK, to me.

(I can't comment on the effects; I have not tested.)

This revision is now accepted and ready to land.Dec 19 2024, 6:10 PM

ziaee added a subscriber: ziaee.Dec 25 2024, 4:59 AM

lwhsu added a subscriber: lwhsu.Mar 28 2025, 3:30 PM

john.grafton_runbox.com added a reviewer: manpages.Jun 14 2025, 2:41 AM

john.grafton_runbox.com marked 12 inline comments as done.

• grahamperrin removed a subscriber: • grahamperrin.Feb 24 2026, 8:12 PM

• grahamperrin resigned from this revision.Feb 24 2026, 8:28 PM

This revision now requires review to proceed.Feb 24 2026, 8:28 PM

lme added a subscriber: lme.Apr 25 2026, 10:36 AM

lme commandeered this revision.Apr 25 2026, 12:53 PM

lme added a reviewer: john.grafton_runbox.com.

Add a note that ZFS encryption needs at least a password length of 8 characters

Harbormaster completed remote builds in B72539: Diff 176450.Apr 25 2026, 1:04 PM

Add des@ as reviewer because the change touches PAM.

The manual page changes looks good.

This revision is now accepted and ready to land.Apr 25 2026, 1:13 PM

bcr accepted this revision.Apr 25 2026, 2:15 PM

des added inline comments.Apr 25 2026, 4:49 PM

lib/libpam/pam.d/login
7	Are you sure? First of all, I think this belongs in `system`, not in `login`. Second, if you uncomment this line in its current position, `login` will always prompt for a password even when an already logged-in user runs `login $USER`.
17	This probably belongs in `system` rather than in `login`.

Couple of manpage markup nits

usr.sbin/adduser/adduser.8
150	use the Em dash character instead of double hyphen. Also, no need to escape hyphens, that was a thing for a different manpage language and different compiler from long ago.
158–159	if you use the Pa macro, these will be added to the whatis database.
167