Bug #17010: [patch] backport #16787 for 2.7: allow Dir.home to work for non-login procs when $HOME not set

• Status: Closed
• Assignee: -
• Target version: -
• ruby -v: ruby 2.7.1p87 (2020-06-27 revision 799c5766a4) [x86_64-linux]
• Backport: 2.5: UNKNOWN, 2.6: UNKNOWN, 2.7: UNKNOWN

[salewski (Alan Salewski)]

The attached patch backports to ruby_2_7 change c15cddd1d515c5bd8dfe8fb2725e3f723aec63b8,
which fixes the issue described in bug #16787.

The original commit message:

Allow Dir.home to work for non-login procs when $HOME not set

Allow the 'Dir.home' method to reliably locate the user's home directory when
all three of the following are true at the same time:

    1. Ruby is running on a Unix-like OS
    2. The $HOME environment variable is not set
    3. The process is not a descendant of login(1) (or a work-alike)

The prior behavior was that the lookup could only work for login-descended
processes.

This is accomplished by looking up the user's record in the password database
by uid (getpwuid_r(3)) as a fallback to the lookup by name (getpwname_r(3))
which is still attempted first (based on the name, if any, returned by
getlogin_r(3)).

If getlogin_r(3), getpwnam_r(3), and/or getpwuid_r(3) is not available at
compile time, will fallback on using their respective non-*_r() variants:
getlogin(3), getpwnam(3), and/or getpwuid(3).

The rationale for attempting to do the lookup by name prior to doing it by uid
is to accommodate the possibility of multiple login names (each with its own
record in the password database, so each with a potentially different home
directory) being mapped to the same uid (as is explicitly allowed for by
POSIX; see getlogin(3posix)).

Preserves the existing behavior for login-descended processes, and adds the
new capability of having Dir.home being able to find the user's home directory
for non-login-descended processes.

Fixes [Bug #16787]

Related discussion:
    https://bugs.ruby-lang.org/issues/16787
    https://github.com/ruby/ruby/pull/3034

[salewski (Alan Salewski)]

I created a pull request for this over on GitHub:

https://github.com/ruby/ruby/pull/3288

The integration tests are still running as I write this.

[jeremyevans0 (Jeremy Evans)]

• Status changed from Open to Closed

Please don't create issues just for backporting if there is an existing issue. Just update the Backport field in the original issue. I did this for #16787.

[salewski (Alan Salewski)]

jeremyevans0 (Jeremy Evans) wrote in #note-2:

Please don't create issues just for backporting if there is an existing issue. Just update the Backport field in the original issue. I did this for #16787.

Thanks for the info, @jeremyevans0 (Jeremy Evans). I'll add my 2.6 and 2.7 backport patches (#17009 and #17010, respectively) to the original issue (#16787).