[Bug 1570997] [NEW] fail if HOME environment variable is not set

[Scott Moser]

Public bug reported:

I've modified /usr/bin/ssh-import-id to show a stack trace rather than unhelpful message:
TypeError: join() argument must be str or bytes, not 'NoneType'

Then, running:
$ env -u HOME ssh-import-id smoser
Traceback (most recent call last):
File "/usr/bin/ssh-import-id", line 62, in <module>
main()
File "/usr/bin/ssh-import-id", line 45, in main
k = import_keys(proto, username, parser.options.useragent)
File "/usr/lib/python3/dist-packages/ssh_import_id/__init__.py", line 204, in import_keys
local_keys = key_list(read_keyfile())
File "/usr/lib/python3/dist-packages/ssh_import_id/__init__.py", line 135, in read_keyfile
output_file = parser.options.output or os.path.join(os.getenv("HOME"), ".ssh", "authorized_keys")
File "/usr/lib/python3.5/posixpath.py", line 89, in join
genericpath._check_arg_types('join', a, *p)
File "/usr/lib/python3.5/genericpath.py", line 143, in _check_arg_types
(funcname, s.__class__.__name__)) from None
TypeError: join() argument must be str or bytes, not 'NoneType'

I came to find this by trying to launch an instance with:

$ ec2metadata --user-data
#!/bin/sh
exec >/my.log 2>&1
cat /proc/uptime
date -R
ssh-import-id smoser

The basic issue is that the environment that cloud-init runs in does not
have HOME set.

I suggest using os.path.expanduser
def authorized_key_file():
return os.path.join(os.path.expanduser("~"), ".ssh", "authorized_keys")

ProblemType: Bug
DistroRelease: Ubuntu 16.04
Package: ssh-import-id 5.5-0ubuntu1 [modified: usr/bin/ssh-import-id]
ProcVersionSignature: User Name 4.4.0-18.34-generic 4.4.6
Uname: Linux 4.4.0-18-generic x86_64
ApportVersion: 2.20.1-0ubuntu1
Architecture: amd64
Date: Fri Apr 15 17:36:09 2016
Ec2AMI: ami-929f8cf8
Ec2AMIManifest: ubuntu-us-east-1/images-testing/hvm-instance/ubuntu-xenial-daily-amd64-server-20160412.manifest.xml
Ec2AvailabilityZone: us-east-1c
Ec2InstanceType: m3.medium
Ec2Kernel: unavailable
Ec2Ramdisk: unavailable
PackageArchitecture: all
ProcEnviron:
TERM=xterm-256color
PATH=(custom, no user)
XDG_RUNTIME_DIR=<set>
LANG=en_US.UTF-8
SHELL=/bin/bash
SourcePackage: ssh-import-id
UpgradeStatus: No upgrade log present (probably fresh install)

** Affects: ssh-import-id (Ubuntu)
Importance: Undecided
Status: New


** Tags: amd64 apport-bug ec2-images xenial
--
You received this bug notification because you are a member of Ubuntu
Bugs, which is subscribed to Ubuntu.
https://bugs.launchpad.net/bugs/1570997

Title:
fail if HOME environment variable is not set

To manage notifications about this bug go to:
https://bugs.launchpad.net/ubuntu/+source/ssh-import-id/+bug/1570997/+subscriptions

[Scott Moser]

** Changed in: ssh-import-id (Ubuntu)
Status: New => Confirmed

** Changed in: ssh-import-id (Ubuntu)
Importance: Undecided => Low

** Also affects: ssh-import-id
Importance: Undecided
Status: New
--
You received this bug notification because you are a member of Ubuntu
Bugs, which is subscribed to Ubuntu.
https://bugs.launchpad.net/bugs/1570997

Title:
fail if HOME environment variable is not set

To manage notifications about this bug go to:
https://bugs.launchpad.net/ssh-import-id/+bug/1570997/+subscriptions

[Scott Moser]

** Changed in: ssh-import-id
Status: New => Confirmed

** Changed in: ssh-import-id
Importance: Undecided => Low
--
You received this bug notification because you are a member of Ubuntu
Bugs, which is subscribed to Ubuntu.
https://bugs.launchpad.net/bugs/1570997

Title:
fail if HOME environment variable is not set

To manage notifications about this bug go to:
https://bugs.launchpad.net/ssh-import-id/+bug/1570997/+subscriptions

[ChristianEhrhardt]

** Tags added: bot-stop-nagging
--
You received this bug notification because you are a member of Ubuntu
Bugs, which is subscribed to Ubuntu.
https://bugs.launchpad.net/bugs/1570997

Title:
fail if HOME environment variable is not set

To manage notifications about this bug go to:
https://bugs.launchpad.net/ssh-import-id/+bug/1570997/+subscriptions

[Launchpad Bug Tracker]

** Branch linked: lp:~smoser/ssh-import-id/trunk.lp1570997
--
You received this bug notification because you are a member of Ubuntu
Bugs, which is subscribed to Ubuntu.
https://bugs.launchpad.net/bugs/1570997

Title:
fail if HOME environment variable is not set

To manage notifications about this bug go to:
https://bugs.launchpad.net/ssh-import-id/+bug/1570997/+subscriptions

[Scott Moser]

A recreate for this is as simple as:
$ ud=$(printf '%s\n%s\n' '#!/bin/sh' 'ssh-import-id smoser')
$ lxc launch ubuntu-daily:xenial "--config=user.user-data=$ud"

A work around is to just to set the HOME environment:

$ ud=$(printf '%s\n%s\n' '#!/bin/sh' 'HOME=/root ssh-import-id smoser')
--
You received this bug notification because you are a member of Ubuntu
Bugs, which is subscribed to Ubuntu.
https://bugs.launchpad.net/bugs/1570997

Title:
fail if HOME environment variable is not set

To manage notifications about this bug go to:
https://bugs.launchpad.net/ssh-import-id/+bug/1570997/+subscriptions

[ChristianEhrhardt]

** Changed in: ssh-import-id (Ubuntu)
Assignee: (unassigned) => Scott Moser (smoser)
--
You received this bug notification because you are a member of Ubuntu
Bugs, which is subscribed to Ubuntu.
https://bugs.launchpad.net/bugs/1570997

Title:
fail if HOME environment variable is not set

To manage notifications about this bug go to:
https://bugs.launchpad.net/ssh-import-id/+bug/1570997/+subscriptions

[Andreas Hasenack]

Scott, since you have an MP up for this, could you assign the ssh-
import-id task to yourself and mark it as in progress please?

** Changed in: ssh-import-id (Ubuntu)
Assignee: Scott Moser (smoser) => (unassigned)
--
You received this bug notification because you are a member of Ubuntu
Bugs, which is subscribed to Ubuntu.
https://bugs.launchpad.net/bugs/1570997

Title:
fail if HOME environment variable is not set

To manage notifications about this bug go to:
https://bugs.launchpad.net/ssh-import-id/+bug/1570997/+subscriptions

[Scott Moser]

** Changed in: ssh-import-id
Status: Confirmed => In Progress

** Changed in: ssh-import-id
Assignee: (unassigned) => Scott Moser (smoser)
--
You received this bug notification because you are a member of Ubuntu
Bugs, which is subscribed to Ubuntu.
https://bugs.launchpad.net/bugs/1570997

Title:
fail if HOME environment variable is not set

To manage notifications about this bug go to:
https://bugs.launchpad.net/ssh-import-id/+bug/1570997/+subscriptions

[Dustin Kirkland ]

** Changed in: ssh-import-id
Assignee: Scott Moser (smoser) => Dustin Kirkland  (kirkland)
--
You received this bug notification because you are a member of Ubuntu
Bugs, which is subscribed to Ubuntu.
https://bugs.launchpad.net/bugs/1570997

Title:
fail if HOME environment variable is not set

To manage notifications about this bug go to:
https://bugs.launchpad.net/ssh-import-id/+bug/1570997/+subscriptions

[Launchpad Bug Tracker]

** Branch linked: lp:ssh-import-id
--
You received this bug notification because you are a member of Ubuntu
Bugs, which is subscribed to Ubuntu.
https://bugs.launchpad.net/bugs/1570997

Title:
fail if HOME environment variable is not set

To manage notifications about this bug go to:
https://bugs.launchpad.net/ssh-import-id/+bug/1570997/+subscriptions

[Dustin Kirkland ]

** Changed in: ssh-import-id
Status: In Progress => Fix Committed

** Changed in: ssh-import-id (Ubuntu)
Status: Confirmed => Fix Committed

** Changed in: ssh-import-id (Ubuntu)
Assignee: (unassigned) => Dustin Kirkland  (kirkland)
--
You received this bug notification because you are a member of Ubuntu
Bugs, which is subscribed to Ubuntu.
https://bugs.launchpad.net/bugs/1570997

Title:
fail if HOME environment variable is not set

To manage notifications about this bug go to:
https://bugs.launchpad.net/ssh-import-id/+bug/1570997/+subscriptions

[Launchpad Bug Tracker]

This bug was fixed in the package ssh-import-id - 5.7-0ubuntu1

---------------
ssh-import-id (5.7-0ubuntu1) artful; urgency=medium

[ Scott Moser ]
* ssh_import_id/__init__.py: LP: #1570997
- read_keyfile: use getpass and expanduser if HOME not set.
If the HOME environment variable was not set, then use getpass and
expanduser to try to find the right path.
Recreate was as simple as:
env -u HOME ssh-import-id bob

[ Dustin Kirkland ]
* ssh_import_id/__init__.py:
- fix typo, missing colon

-- Dustin Kirkland <***@ubuntu.com> Fri, 16 Sep 2016 10:13:35
-0500

** Changed in: ssh-import-id (Ubuntu)
Status: Fix Committed => Fix Released
--
You received this bug notification because you are a member of Ubuntu
Bugs, which is subscribed to Ubuntu.
https://bugs.launchpad.net/bugs/1570997

Title:
fail if HOME environment variable is not set

To manage notifications about this bug go to:
https://bugs.launchpad.net/ssh-import-id/+bug/1570997/+subscriptions

[Scott Moser]

** Also affects: ssh-import-id (Ubuntu Xenial)
Importance: Undecided
Status: New
--
You received this bug notification because you are a member of Ubuntu
Bugs, which is subscribed to Ubuntu.
https://bugs.launchpad.net/bugs/1570997

Title:
fail if HOME environment variable is not set

To manage notifications about this bug go to:
https://bugs.launchpad.net/ssh-import-id/+bug/1570997/+subscriptions

[Scott Moser]

** Description changed:

+ === Begin SRU Template ===
+ [Impact]
+ Running ssh-import-id without environment variable HOME set
+ will fail and print an error message like:
+
+  TypeError: join() argument must be str or bytes, not 'NoneType'
+
+ [Test Case]
+ $ name="my-x"
+ $ ud=$(printf '%s\n%s\n' '#!/bin/sh' 'ssh-import-id smoser')
+ $ lxc launch ubuntu-daily:xenial "$name" "--config=user.user-data=$ud"
+
+ To see failure, you can then just:
+ $ lxc exec "$name" -- cat /run/cloud-init/result.json
+ {
+ "v1": {
+ "datasource": "DataSourceHetzner",
+ "errors": [
+ "('scripts-user', RuntimeError('Runparts: 1 failures in 1 attempted commands',))"
+ ]
+ }
+ }
+
+ $ lxc exec "$name" -- grep "ssh-import-id smoser" /root/.ssh/authorized_keys &&
+ echo GOOD || echo FAIL
+
+ [Regression Potential]
+ Regression is unlikely. The code only does anything if HOME is not present.
+ This has been in Artful and Bionic since 2016-09-16.
+
+ [Other Info]
+ Upstream merge proposal:
+ https://code.launchpad.net/~smoser/ssh-import-id/trunk.lp1570997/+merge/326692
+
+ === End SRU Template ===
+
I've modified /usr/bin/ssh-import-id to show a stack trace rather than unhelpful message:
- TypeError: join() argument must be str or bytes, not 'NoneType'
+  TypeError: join() argument must be str or bytes, not 'NoneType'

Then, running:
$ env -u HOME ssh-import-id smoser
Traceback (most recent call last):
- File "/usr/bin/ssh-import-id", line 62, in <module>
- main()
- File "/usr/bin/ssh-import-id", line 45, in main
- k = import_keys(proto, username, parser.options.useragent)
- File "/usr/lib/python3/dist-packages/ssh_import_id/__init__.py", line 204, in import_keys
- local_keys = key_list(read_keyfile())
- File "/usr/lib/python3/dist-packages/ssh_import_id/__init__.py", line 135, in read_keyfile
- output_file = parser.options.output or os.path.join(os.getenv("HOME"), ".ssh", "authorized_keys")
- File "/usr/lib/python3.5/posixpath.py", line 89, in join
- genericpath._check_arg_types('join', a, *p)
- File "/usr/lib/python3.5/genericpath.py", line 143, in _check_arg_types
- (funcname, s.__class__.__name__)) from None
+   File "/usr/bin/ssh-import-id", line 62, in <module>
+     main()
+   File "/usr/bin/ssh-import-id", line 45, in main
+     k = import_keys(proto, username, parser.options.useragent)
+   File "/usr/lib/python3/dist-packages/ssh_import_id/__init__.py", line 204, in import_keys
+     local_keys = key_list(read_keyfile())
+   File "/usr/lib/python3/dist-packages/ssh_import_id/__init__.py", line 135, in read_keyfile
+     output_file = parser.options.output or os.path.join(os.getenv("HOME"), ".ssh", "authorized_keys")
+   File "/usr/lib/python3.5/posixpath.py", line 89, in join
+     genericpath._check_arg_types('join', a, *p)
+   File "/usr/lib/python3.5/genericpath.py", line 143, in _check_arg_types
+     (funcname, s.__class__.__name__)) from None
TypeError: join() argument must be str or bytes, not 'NoneType'

I came to find this by trying to launch an instance with:

$ ec2metadata --user-data
#!/bin/sh
exec >/my.log 2>&1
cat /proc/uptime
date -R
ssh-import-id smoser

The basic issue is that the environment that cloud-init runs in does not
have HOME set.

I suggest using os.path.expanduser
def authorized_key_file():
- return os.path.join(os.path.expanduser("~"), ".ssh", "authorized_keys")
+         return os.path.join(os.path.expanduser("~"), ".ssh", "authorized_keys")

ProblemType: Bug
DistroRelease: Ubuntu 16.04
Package: ssh-import-id 5.5-0ubuntu1 [modified: usr/bin/ssh-import-id]
ProcVersionSignature: User Name 4.4.0-18.34-generic 4.4.6
Uname: Linux 4.4.0-18-generic x86_64
ApportVersion: 2.20.1-0ubuntu1
Architecture: amd64
Date: Fri Apr 15 17:36:09 2016
Ec2AMI: ami-929f8cf8
Ec2AMIManifest: ubuntu-us-east-1/images-testing/hvm-instance/ubuntu-xenial-daily-amd64-server-20160412.manifest.xml
Ec2AvailabilityZone: us-east-1c
Ec2InstanceType: m3.medium
Ec2Kernel: unavailable
Ec2Ramdisk: unavailable
PackageArchitecture: all
ProcEnviron:
- TERM=xterm-256color
- PATH=(custom, no user)
- XDG_RUNTIME_DIR=<set>
- LANG=en_US.UTF-8
- SHELL=/bin/bash
+  TERM=xterm-256color
+  PATH=(custom, no user)
+  XDG_RUNTIME_DIR=<set>
+  LANG=en_US.UTF-8
+  SHELL=/bin/bash
SourcePackage: ssh-import-id
UpgradeStatus: No upgrade log present (probably fresh install)
--
You received this bug notification because you are a member of Ubuntu
Bugs, which is subscribed to Ubuntu.
https://bugs.launchpad.net/bugs/1570997

Title:
fail if HOME environment variable is not set

To manage notifications about this bug go to:
https://bugs.launchpad.net/ssh-import-id/+bug/1570997/+subscriptions

[Launchpad Bug Tracker]

** Merge proposal linked:
https://code.launchpad.net/~smoser/ubuntu/+source/ssh-import-id/+git/ssh-import-id/+merge/342231
--
You received this bug notification because you are a member of Ubuntu
Bugs, which is subscribed to Ubuntu.
https://bugs.launchpad.net/bugs/1570997

Title:
fail if HOME environment variable is not set

To manage notifications about this bug go to:
https://bugs.launchpad.net/ssh-import-id/+bug/1570997/+subscriptions

[Scott Moser]

** Changed in: ssh-import-id (Ubuntu Xenial)
Status: New => In Progress

** Changed in: ssh-import-id (Ubuntu Xenial)
Importance: Undecided => Low

** Changed in: ssh-import-id (Ubuntu Xenial)
Assignee: (unassigned) => Scott Moser (smoser)
--
You received this bug notification because you are a member of Ubuntu
Bugs, which is subscribed to Ubuntu.
https://bugs.launchpad.net/bugs/1570997

Title:
fail if HOME environment variable is not set

To manage notifications about this bug go to:
https://bugs.launchpad.net/ssh-import-id/+bug/1570997/+subscriptions

[touny]

** Changed in: ssh-import-id
Status: Fix Committed => Confirmed

** Changed in: ssh-import-id
Status: Confirmed => Incomplete

** Changed in: ssh-import-id
Status: Incomplete => Fix Released

** Changed in: ssh-import-id (Ubuntu Xenial)
Status: In Progress => Fix Released
--
You received this bug notification because you are a member of Ubuntu
Bugs, which is subscribed to Ubuntu.
https://bugs.launchpad.net/bugs/1570997

Title:
fail if HOME environment variable is not set

To manage notifications about this bug go to:
https://bugs.launchpad.net/ssh-import-id/+bug/1570997/+subscriptions

[Brian Murray]

Hello Scott, or anyone else affected,

Accepted ssh-import-id into xenial-proposed. The package will build now
and be available at https://launchpad.net/ubuntu/+source/ssh-import-
id/5.5-0ubuntu1.1 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See
https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how
to enable and use -proposed.Your feedback will aid us getting this
update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug,
mentioning the version of the package you tested and change the tag from
verification-needed-xenial to verification-done-xenial. If it does not
fix the bug for you, please add a comment stating that, and change the
tag to verification-failed-xenial. In either case, without details of
your testing we will not be able to proceed.

Further information regarding the verification process can be found at
https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in
advance!

** Changed in: ssh-import-id (Ubuntu Xenial)
Status: Fix Released => Fix Committed

** Tags added: verification-needed verification-needed-xenial
--
You received this bug notification because you are a member of Ubuntu
Bugs, which is subscribed to Ubuntu.
https://bugs.launchpad.net/bugs/1570997

Title:
fail if HOME environment variable is not set

To manage notifications about this bug go to:
https://bugs.launchpad.net/ssh-import-id/+bug/1570997/+subscriptions

[Scott Moser]

The upstream commit didnt' actually fix the issue, as there are 2
occurences that use HOME.


** Tags removed: verification-needed verification-needed-xenial
** Tags added: verification-failed-xeniall
--
You received this bug notification because you are a member of Ubuntu
Bugs, which is subscribed to Ubuntu.
https://bugs.launchpad.net/bugs/1570997

Title:
fail if HOME environment variable is not set

To manage notifications about this bug go to:
https://bugs.launchpad.net/ssh-import-id/+bug/1570997/+subscriptions

[Jean-Baptiste Lallement]

** Tags removed: verification-failed-xeniall
** Tags added: verification-failed-xenial
--
You received this bug notification because you are a member of Ubuntu
Bugs, which is subscribed to Ubuntu.
https://bugs.launchpad.net/bugs/1570997

Title:
fail if HOME environment variable is not set

To manage notifications about this bug go to:
https://bugs.launchpad.net/ssh-import-id/+bug/1570997/+subscriptions

[Brian Murray]

Hello Scott, or anyone else affected,

Accepted ssh-import-id into bionic-proposed. The package will build now
and be available at https://launchpad.net/ubuntu/+source/ssh-import-
id/5.7-0ubuntu1.1 in a few hours, and then in the -proposed repository.

Please help us by testing this new package. See
https://wiki.ubuntu.com/Testing/EnableProposed for documentation on how
to enable and use -proposed.Your feedback will aid us getting this
update out to other Ubuntu users.

If this package fixes the bug for you, please add a comment to this bug,
mentioning the version of the package you tested and change the tag from
verification-needed-bionic to verification-done-bionic. If it does not
fix the bug for you, please add a comment stating that, and change the
tag to verification-failed-bionic. In either case, without details of
your testing we will not be able to proceed.

Further information regarding the verification process can be found at
https://wiki.ubuntu.com/QATeam/PerformingSRUVerification . Thank you in
advance!

** Changed in: ssh-import-id (Ubuntu Bionic)
Status: New => Fix Committed

** Tags added: verification-needed verification-needed-bionic
--
You received this bug notification because you are a member of Ubuntu
Bugs, which is subscribed to Ubuntu.
https://bugs.launchpad.net/bugs/1570997

Title:
fail if HOME environment variable is not set

To manage notifications about this bug go to:
https://bugs.launchpad.net/ssh-import-id/+bug/1570997/+subscriptions