GH-118447: Fix handling of unreadable symlinks in `os.path.realpath()` #118489

barneygale · 2024-05-01T20:43:32Z

Issue: posixpath.realpath('secretlink') raises #118447

barneygale · 2024-05-06T17:16:44Z

If not resolving unreadable symlinks is acceptable, you still need to raise an error for link/...

realpath() shouldn't raise OSError in non-strict mode.

Lib/posixpath.py

Lib/test/test_posixpath.py

nineteendo

OK, you're right, it shouldn't raise an error. That's what strict is for.

serhiy-storchaka · 2024-05-09T08:28:38Z

I think that it is reasonable to expect that realpath('dir/badlink/rest') returns the same result when badlink does not exist, is a file, is in non-readable directory or is non-readable itself, for any rest. It's error prone, but that's how it was defined.

nineteendo

Barney, would you like to continue working on this? You have my approval if it means anything.

Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com>

barneygale · 2024-05-18T22:26:36Z

Thanks for the reviews and suggestions, both!

miss-islington-app · 2024-05-18T22:40:55Z

Thanks @barneygale for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

…path()` (pythonGH-118489) (cherry picked from commit caf6064) Co-authored-by: Barney Gale <barney.gale@gmail.com> Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com>

miss-islington-app · 2024-05-18T22:41:03Z

Sorry, @barneygale, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker caf6064a1bc15ac344afd78b780188e60b9c628e 3.12

bedevere-app · 2024-05-18T22:41:07Z

GH-119163 is a backport of this pull request to the 3.13 branch.

…path()` (python#118489) Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com> (cherry picked from commit caf6064)

…th.realpath()` (pythonGH-118489) Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com>. (cherry picked from commit caf6064) Co-authored-by: Barney Gale <barney.gale@gmail.com>

barneygale · 2024-05-18T22:51:14Z

If no one objects, I'll skip backporting to 3.12 as this is a fairly minor bug and I can't be bothered to fix the conflicts :)

bedevere-bot · 2024-05-18T22:57:05Z

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Hi! The buildbot AMD64 FreeBSD 3.x has failed when building commit caf6064.

What do you need to do:

Don't panic.
Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
Go to the page of the buildbot that failed (https://buildbot.python.org/all/#builders/1223/builds/3134) and take a look at the build logs.
Check if the failure is related to this commit (caf6064) or if it is a false positive.
If the failure is related to this commit, please, reflect that on the issue and make a new Pull Request with a fix.

You can take a look at the buildbot page here:

https://buildbot.python.org/all/#builders/1223/builds/3134

Failed tests:

test_posixpath

Failed subtests:

test_realpath_unreadable_symlink - test.test_posixpath.PosixPathTest.test_realpath_unreadable_symlink

Summary of the results of the build (if available):

==

Click to see traceback logs

Traceback (most recent call last):
  File "/buildbot/buildarea/3.x.ware-freebsd/build/Lib/test/test_posixpath.py", line 670, in test_realpath_unreadable_symlink
    self.assertEqual(realpath(ABSTFN), ABSTFN)
    ~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^
AssertionError: '/bui[19 chars].ware-freebsd/build/build/test_python_57143æ/@test_57143_tmpæ1' != '/bui[19 chars].ware-freebsd/build/build/test_python_57143æ/@test_57143_tmpæ'
- /buildbot/buildarea/3.x.ware-freebsd/build/build/test_python_57143æ/@test_57143_tmpæ1
?                                                                                     -
+ /buildbot/buildarea/3.x.ware-freebsd/build/build/test_python_57143æ/@test_57143_tmpæ


Traceback (most recent call last):
  File "/buildbot/buildarea/3.x.ware-freebsd/build/Lib/test/test_posixpath.py", line 670, in test_realpath_unreadable_symlink
    self.assertEqual(realpath(ABSTFN), ABSTFN)
    ~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^
AssertionError: '/bui[19 chars].ware-freebsd/build/build/test_python_66351æ/@test_66351_tmpæ1' != '/bui[19 chars].ware-freebsd/build/build/test_python_66351æ/@test_66351_tmpæ'
- /buildbot/buildarea/3.x.ware-freebsd/build/build/test_python_66351æ/@test_66351_tmpæ1
?                                                                                     -
+ /buildbot/buildarea/3.x.ware-freebsd/build/build/test_python_66351æ/@test_66351_tmpæ

bedevere-bot · 2024-05-18T22:57:38Z

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Hi! The buildbot AMD64 FreeBSD14 3.x has failed when building commit caf6064.

What do you need to do:

Don't panic.
Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
Go to the page of the buildbot that failed (https://buildbot.python.org/all/#builders/1232/builds/2352) and take a look at the build logs.
Check if the failure is related to this commit (caf6064) or if it is a false positive.
If the failure is related to this commit, please, reflect that on the issue and make a new Pull Request with a fix.

You can take a look at the buildbot page here:

https://buildbot.python.org/all/#builders/1232/builds/2352

Failed tests:

test_posixpath

Failed subtests:

test_realpath_unreadable_symlink - test.test_posixpath.PosixPathTest.test_realpath_unreadable_symlink

Summary of the results of the build (if available):

==

Click to see traceback logs

Traceback (most recent call last):
  File "/home/buildbot/buildarea/3.x.opsec-fbsd14/build/Lib/test/test_posixpath.py", line 670, in test_realpath_unreadable_symlink
    self.assertEqual(realpath(ABSTFN), ABSTFN)
    ~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^
AssertionError: '/hom[24 chars].opsec-fbsd14/build/build/test_python_79925æ/@test_79925_tmpæ1' != '/hom[24 chars].opsec-fbsd14/build/build/test_python_79925æ/@test_79925_tmpæ'
- /home/buildbot/buildarea/3.x.opsec-fbsd14/build/build/test_python_79925æ/@test_79925_tmpæ1
?                                                                                          -
+ /home/buildbot/buildarea/3.x.opsec-fbsd14/build/build/test_python_79925æ/@test_79925_tmpæ


Traceback (most recent call last):
  File "/home/buildbot/buildarea/3.x.opsec-fbsd14/build/Lib/test/test_posixpath.py", line 670, in test_realpath_unreadable_symlink
    self.assertEqual(realpath(ABSTFN), ABSTFN)
    ~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^
AssertionError: '/hom[24 chars].opsec-fbsd14/build/build/test_python_75684æ/@test_75684_tmpæ1' != '/hom[24 chars].opsec-fbsd14/build/build/test_python_75684æ/@test_75684_tmpæ'
- /home/buildbot/buildarea/3.x.opsec-fbsd14/build/build/test_python_75684æ/@test_75684_tmpæ1
?                                                                                          -
+ /home/buildbot/buildarea/3.x.opsec-fbsd14/build/build/test_python_75684æ/@test_75684_tmpæ

…lpath()` (GH-118489) (#119163) (cherry picked from commit caf6064) Co-authored-by: Barney Gale <barney.gale@gmail.com> Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com>

bedevere-bot · 2024-05-18T23:25:13Z

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Hi! The buildbot AMD64 FreeBSD 3.13 has failed when building commit 7407267.

What do you need to do:

Don't panic.
Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
Go to the page of the buildbot that failed (https://buildbot.python.org/all/#builders/1491/builds/46) and take a look at the build logs.
Check if the failure is related to this commit (7407267) or if it is a false positive.
If the failure is related to this commit, please, reflect that on the issue and make a new Pull Request with a fix.

You can take a look at the buildbot page here:

https://buildbot.python.org/all/#builders/1491/builds/46

Failed tests:

test_posixpath

Failed subtests:

test_realpath_unreadable_symlink - test.test_posixpath.PosixPathTest.test_realpath_unreadable_symlink

Summary of the results of the build (if available):

==

Click to see traceback logs

Traceback (most recent call last):
  File "/buildbot/buildarea/3.13.ware-freebsd/build/Lib/test/test_posixpath.py", line 670, in test_realpath_unreadable_symlink
    self.assertEqual(realpath(ABSTFN), ABSTFN)
    ~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^
AssertionError: '/bui[20 chars].ware-freebsd/build/build/test_python_84680æ/@test_84680_tmpæ1' != '/bui[20 chars].ware-freebsd/build/build/test_python_84680æ/@test_84680_tmpæ'
- /buildbot/buildarea/3.13.ware-freebsd/build/build/test_python_84680æ/@test_84680_tmpæ1
?                                                                                      -
+ /buildbot/buildarea/3.13.ware-freebsd/build/build/test_python_84680æ/@test_84680_tmpæ


Traceback (most recent call last):
  File "/buildbot/buildarea/3.13.ware-freebsd/build/Lib/test/test_posixpath.py", line 670, in test_realpath_unreadable_symlink
    self.assertEqual(realpath(ABSTFN), ABSTFN)
    ~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^
AssertionError: '/bui[20 chars].ware-freebsd/build/build/test_python_77930æ/@test_77930_tmpæ1' != '/bui[20 chars].ware-freebsd/build/build/test_python_77930æ/@test_77930_tmpæ'
- /buildbot/buildarea/3.13.ware-freebsd/build/build/test_python_77930æ/@test_77930_tmpæ1
?                                                                                      -
+ /buildbot/buildarea/3.13.ware-freebsd/build/build/test_python_77930æ/@test_77930_tmpæ

bedevere-bot · 2024-05-18T23:30:35Z

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Hi! The buildbot AMD64 FreeBSD14 3.13 has failed when building commit 7407267.

What do you need to do:

Don't panic.
Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
Go to the page of the buildbot that failed (https://buildbot.python.org/all/#builders/1481/builds/45) and take a look at the build logs.
Check if the failure is related to this commit (7407267) or if it is a false positive.
If the failure is related to this commit, please, reflect that on the issue and make a new Pull Request with a fix.

You can take a look at the buildbot page here:

https://buildbot.python.org/all/#builders/1481/builds/45

Failed tests:

test_posixpath

Failed subtests:

test_realpath_unreadable_symlink - test.test_posixpath.PosixPathTest.test_realpath_unreadable_symlink

Summary of the results of the build (if available):

==

Click to see traceback logs

Traceback (most recent call last):
  File "/home/buildbot/buildarea/3.13.opsec-fbsd14/build/Lib/test/test_posixpath.py", line 670, in test_realpath_unreadable_symlink
    self.assertEqual(realpath(ABSTFN), ABSTFN)
    ~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^
AssertionError: '/hom[25 chars].opsec-fbsd14/build/build/test_python_95351æ/@test_95351_tmpæ1' != '/hom[25 chars].opsec-fbsd14/build/build/test_python_95351æ/@test_95351_tmpæ'
- /home/buildbot/buildarea/3.13.opsec-fbsd14/build/build/test_python_95351æ/@test_95351_tmpæ1
?                                                                                           -
+ /home/buildbot/buildarea/3.13.opsec-fbsd14/build/build/test_python_95351æ/@test_95351_tmpæ


Traceback (most recent call last):
  File "/home/buildbot/buildarea/3.13.opsec-fbsd14/build/Lib/test/test_posixpath.py", line 670, in test_realpath_unreadable_symlink
    self.assertEqual(realpath(ABSTFN), ABSTFN)
    ~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^
AssertionError: '/hom[25 chars].opsec-fbsd14/build/build/test_python_94029æ/@test_94029_tmpæ1' != '/hom[25 chars].opsec-fbsd14/build/build/test_python_94029æ/@test_94029_tmpæ'
- /home/buildbot/buildarea/3.13.opsec-fbsd14/build/build/test_python_94029æ/@test_94029_tmpæ1
?                                                                                           -
+ /home/buildbot/buildarea/3.13.opsec-fbsd14/build/build/test_python_94029æ/@test_94029_tmpæ

…path()` (python#118489) Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com>

pythonGH-118447: Handle unreadable symlinks in os.path.realpath()

1619428

bedevere-app bot added the tests Tests in the Lib/test dir label May 1, 2024

bedevere-app bot mentioned this pull request May 1, 2024

posixpath.realpath('secretlink') raises #118447

Closed

barneygale added 2 commits May 1, 2024 21:45

DRY

fc5e670

Fix + NEWS

8d3fbff

barneygale changed the title ~~GH-118447: Handle unreadable symlinks in os.path.realpath()~~ GH-118447: Fix handling of unreadable symlinks in os.path.realpath() May 1, 2024

barneygale removed the tests Tests in the Lib/test dir label May 1, 2024

barneygale marked this pull request as ready for review May 1, 2024 22:06

bedevere-app bot added the awaiting core review label May 1, 2024

This comment was marked as resolved.

Sign in to view

serhiy-storchaka reviewed May 7, 2024

View reviewed changes

Lib/posixpath.py Outdated Show resolved Hide resolved

Lib/test/test_posixpath.py Show resolved Hide resolved

Lib/test/test_posixpath.py Show resolved Hide resolved

nineteendo reviewed May 9, 2024

View reviewed changes

nineteendo approved these changes May 18, 2024

View reviewed changes

barneygale and others added 5 commits May 18, 2024 23:07

Update Lib/test/test_posixpath.py

90a4fe3

Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com>

Merge branch 'main' into secret-symlinks

8230c3c

Switch back to using os.stat() to raise ELOOP.

f13e494

Unused import

a29e836

Undo unnecessary changes

0af033d

barneygale added needs backport to 3.12 bug and security fixes needs backport to 3.13 bugs and security fixes labels May 18, 2024

barneygale enabled auto-merge (squash) May 18, 2024 22:26

barneygale merged commit caf6064 into python:main May 18, 2024
35 checks passed

bedevere-app bot removed the awaiting core review label May 18, 2024

miss-islington-app bot assigned barneygale May 18, 2024

bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label May 18, 2024

barneygale mentioned this pull request May 19, 2024

GH-118447: Fix FreeBSD test failures. #119170

Merged

JelleZijlstra mentioned this pull request May 28, 2024

backport a9a74da 3.13 #119642

Closed

estyxx pushed a commit to estyxx/cpython that referenced this pull request Jul 17, 2024

pythonGH-118447: Fix handling of unreadable symlinks in `os.path.real…

2a55dab

…path()` (python#118489) Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com>

hugovk removed the needs backport to 3.12 bug and security fixes label Feb 19, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GH-118447: Fix handling of unreadable symlinks in `os.path.realpath()` #118489

GH-118447: Fix handling of unreadable symlinks in `os.path.realpath()` #118489

barneygale commented May 1, 2024 •

edited by bedevere-app bot

Loading

This comment was marked as resolved.

barneygale commented May 6, 2024

nineteendo left a comment

serhiy-storchaka commented May 9, 2024

nineteendo left a comment

barneygale commented May 18, 2024

miss-islington-app bot commented May 18, 2024

miss-islington-app bot commented May 18, 2024

bedevere-app bot commented May 18, 2024

barneygale commented May 18, 2024

bedevere-bot commented May 18, 2024

bedevere-bot commented May 18, 2024

bedevere-bot commented May 18, 2024

bedevere-bot commented May 18, 2024

GH-118447: Fix handling of unreadable symlinks in os.path.realpath() #118489

GH-118447: Fix handling of unreadable symlinks in os.path.realpath() #118489

Conversation

barneygale commented May 1, 2024 • edited by bedevere-app bot Loading

This comment was marked as resolved.

barneygale commented May 6, 2024

nineteendo left a comment

Choose a reason for hiding this comment

serhiy-storchaka commented May 9, 2024

nineteendo left a comment

Choose a reason for hiding this comment

barneygale commented May 18, 2024

miss-islington-app bot commented May 18, 2024

miss-islington-app bot commented May 18, 2024

bedevere-app bot commented May 18, 2024

barneygale commented May 18, 2024

bedevere-bot commented May 18, 2024

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

bedevere-bot commented May 18, 2024

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

bedevere-bot commented May 18, 2024

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

bedevere-bot commented May 18, 2024

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

GH-118447: Fix handling of unreadable symlinks in `os.path.realpath()` #118489

GH-118447: Fix handling of unreadable symlinks in `os.path.realpath()` #118489

barneygale commented May 1, 2024 •

edited by bedevere-app bot

Loading