Skip to content

Commit

Permalink
Added pip style keyring password lookup as a fallback.
Browse files Browse the repository at this point in the history
This way Poetry gives keyring backends like Microsoft's `artifacts-keyring` or Google's `keyrings.google-artifactregistry-auth` a change to retrieve the credentials.
Since Microsoft Azure DevOps Personal Access Tokens will expire after some time the `artifacts-keyring` implementation will generate a new one for you to counteract that.
  • Loading branch information
Darsstar committed May 22, 2021
1 parent 4ec09d4 commit 6d28c56
Show file tree
Hide file tree
Showing 6 changed files with 185 additions and 91 deletions.
14 changes: 14 additions & 0 deletions docs/docs/repositories.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,20 @@ If a system keyring is available and supported, the password is stored to and re

Keyring support is enabled using the [keyring library](https://pypi.org/project/keyring/). For more information on supported backends refer to the [library documentation](https://keyring.readthedocs.io/en/latest/?badge=latest).

!!!note

```
Poetry will fallback to Pip style use of keyring so that backends like
Microsoft's [artifacts-keyring](https://pypi.org/project/artifacts-keyring/). It will need to be properly
installed into Poetry's virtualenv, preferrably by installing a plugin.

If you are letting Poetry manage your virtual environments you will want a virtualenv
seeder installed in Poetry's virtualenv that installs the desired keyring backend
during `poetry install`. To again use Azure DecOps as an example: [azure-devops-artifacts-helpers](https://pypi.org/project/azure-devops-artifacts-helpers/)
provides such a seeder. This would of course best achieved by installing a Poetry plugin
if it exists for you use case instead of doing it yourself.
```

Alternatively, you can use environment variables to provide the credentials:

```bash
Expand Down
38 changes: 36 additions & 2 deletions poetry/installation/authenticator.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

from typing import TYPE_CHECKING
from typing import Any
from typing import Dict
from typing import Optional
from typing import Tuple

Expand Down Expand Up @@ -108,7 +109,7 @@ def get_credentials_for_url(self, url: str) -> Tuple[Optional[str], Optional[str

if credentials == (None, None):
if "@" not in netloc:
credentials = self._get_credentials_for_netloc_from_config(netloc)
credentials = self._get_credentials_for_netloc(netloc)
else:
# Split from the right because that's how urllib.parse.urlsplit()
# behaves if more than one @ is present (which can be checked using
Expand All @@ -133,7 +134,7 @@ def get_credentials_for_url(self, url: str) -> Tuple[Optional[str], Optional[str

return credentials[0], credentials[1]

def _get_credentials_for_netloc_from_config(
def _get_credentials_for_netloc(
self, netloc: str
) -> Tuple[Optional[str], Optional[str]]:
credentials = (None, None)
Expand All @@ -152,9 +153,42 @@ def _get_credentials_for_netloc_from_config(
if netloc == parsed_url.netloc:
auth = self._password_manager.get_http_auth(repository_name)

if auth is None or auth["password"] is None:
username = auth["username"] if auth else None
auth = self._get_credentials_for_netloc_from_keyring(
url, netloc, username
)

if auth is None:
continue

return auth["username"], auth["password"]

return credentials

def _get_credentials_for_netloc_from_keyring(
self, url: str, netloc: str, username: str
) -> Optional[Dict[str, str]]:
import keyring

cred = keyring.get_credential(url, username)
if cred is not None:
return {
"username": cred.username,
"password": cred.password,
}

cred = keyring.get_credential(netloc, username)
if cred is not None:
return {
"username": cred.username,
"password": cred.password,
}

if username:
return {
"username": username,
"password": None,
}

return None
56 changes: 56 additions & 0 deletions tests/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
import pytest

from cleo.testers.command_tester import CommandTester
from keyring.backend import KeyringBackend

from poetry.config.config import Config as BaseConfig
from poetry.config.dict_config_source import DictConfigSource
Expand Down Expand Up @@ -53,6 +54,61 @@ def all(self) -> Dict[str, Any]:
return super(Config, self).all()


class DummyBackend(KeyringBackend):
def __init__(self):
self._passwords = {}

@classmethod
def priority(cls):
return 42

def set_password(self, service, username, password):
self._passwords[service] = {username: password}

def get_password(self, service, username):
return self._passwords.get(service, {}).get(username)

def get_credential(self, service, username):
return self._passwords.get(service, {}).get(username)

def delete_password(self, service, username):
if service in self._passwords and username in self._passwords[service]:
del self._passwords[service][username]


@pytest.fixture()
def dummy_keyring():
return DummyBackend()


@pytest.fixture()
def with_simple_keyring(dummy_keyring):
import keyring

keyring.set_keyring(dummy_keyring)


@pytest.fixture()
def with_fail_keyring():
import keyring

from keyring.backends.fail import Keyring

keyring.set_keyring(Keyring())


@pytest.fixture()
def with_chained_keyring(mocker):
from keyring.backends.fail import Keyring

mocker.patch("keyring.backend.get_all_keyring", [Keyring()])
import keyring

from keyring.backends.chainer import ChainerBackend

keyring.set_keyring(ChainerBackend())


@pytest.fixture
def config_cache_dir(tmp_dir):
path = Path(tmp_dir) / ".cache" / "pypoetry"
Expand Down
52 changes: 50 additions & 2 deletions tests/installation/test_authenticator.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@
from poetry.installation.authenticator import Authenticator


class SimpleCredential:
def __init__(self, username, password):
self.username = username
self.password = password


@pytest.fixture()
def mock_remote(http):
http.register_uri(
Expand Down Expand Up @@ -52,7 +58,9 @@ def test_authenticator_uses_credentials_from_config_if_not_provided(
assert "Basic YmFyOmJheg==" == request.headers["Authorization"]


def test_authenticator_uses_username_only_credentials(config, mock_remote, http):
def test_authenticator_uses_username_only_credentials(
config, mock_remote, http, with_simple_keyring
):
config.merge(
{
"repositories": {"foo": {"url": "https://foo.bar/simple/"}},
Expand Down Expand Up @@ -85,7 +93,7 @@ def test_authenticator_uses_password_only_credentials(config, mock_remote, http)


def test_authenticator_uses_empty_strings_as_default_password(
config, mock_remote, http
config, mock_remote, http, with_simple_keyring
):
config.merge(
{
Expand Down Expand Up @@ -120,6 +128,46 @@ def test_authenticator_uses_empty_strings_as_default_username(
assert "Basic OmJhcg==" == request.headers["Authorization"]


def test_authenticator_falls_back_to_keyring_url(
config, mock_remote, http, with_simple_keyring, dummy_keyring
):
config.merge(
{
"repositories": {"foo": {"url": "https://foo.bar/simple/"}},
}
)

dummy_keyring.set_password(
"https://foo.bar/simple/", None, SimpleCredential(None, "bar")
)

authenticator = Authenticator(config, NullIO())
authenticator.request("get", "https://foo.bar/files/foo-0.1.0.tar.gz")

request = http.last_request()

assert "Basic OmJhcg==" == request.headers["Authorization"]


def test_authenticator_falls_back_to_keyring_netloc(
config, mock_remote, http, with_simple_keyring, dummy_keyring
):
config.merge(
{
"repositories": {"foo": {"url": "https://foo.bar/simple/"}},
}
)

dummy_keyring.set_password("foo.bar", None, SimpleCredential(None, "bar"))

authenticator = Authenticator(config, NullIO())
authenticator.request("get", "https://foo.bar/files/foo-0.1.0.tar.gz")

request = http.last_request()

assert "Basic OmJhcg==" == request.headers["Authorization"]


def test_authenticator_request_retries_on_exception(mocker, config, http):
sleep = mocker.patch("time.sleep")
sdist_uri = "https://foo.bar/files/{}/foo-0.1.0.tar.gz".format(str(uuid.uuid4()))
Expand Down
12 changes: 6 additions & 6 deletions tests/test_factory.py
Original file line number Diff line number Diff line change
Expand Up @@ -156,13 +156,13 @@ def test_create_poetry_with_multi_constraints_dependency():
assert len(package.requires) == 2


def test_poetry_with_default_source():
def test_poetry_with_default_source(with_simple_keyring):
poetry = Factory().create_poetry(fixtures_dir / "with_default_source")

assert 1 == len(poetry.pool.repositories)


def test_poetry_with_non_default_source():
def test_poetry_with_non_default_source(with_simple_keyring):
poetry = Factory().create_poetry(fixtures_dir / "with_non_default_source")

assert len(poetry.pool.repositories) == 2
Expand All @@ -176,7 +176,7 @@ def test_poetry_with_non_default_source():
assert isinstance(poetry.pool.repositories[1], PyPiRepository)


def test_poetry_with_non_default_secondary_source():
def test_poetry_with_non_default_secondary_source(with_simple_keyring):
poetry = Factory().create_poetry(fixtures_dir / "with_non_default_secondary_source")

assert len(poetry.pool.repositories) == 2
Expand All @@ -192,7 +192,7 @@ def test_poetry_with_non_default_secondary_source():
assert isinstance(repository, LegacyRepository)


def test_poetry_with_non_default_multiple_secondary_sources():
def test_poetry_with_non_default_multiple_secondary_sources(with_simple_keyring):
poetry = Factory().create_poetry(
fixtures_dir / "with_non_default_multiple_secondary_sources"
)
Expand All @@ -214,7 +214,7 @@ def test_poetry_with_non_default_multiple_secondary_sources():
assert isinstance(repository, LegacyRepository)


def test_poetry_with_non_default_multiple_sources():
def test_poetry_with_non_default_multiple_sources(with_simple_keyring):
poetry = Factory().create_poetry(fixtures_dir / "with_non_default_multiple_sources")

assert len(poetry.pool.repositories) == 3
Expand Down Expand Up @@ -245,7 +245,7 @@ def test_poetry_with_no_default_source():
assert isinstance(poetry.pool.repositories[0], PyPiRepository)


def test_poetry_with_two_default_sources():
def test_poetry_with_two_default_sources(with_simple_keyring):
with pytest.raises(ValueError) as e:
Factory().create_poetry(fixtures_dir / "with_two_default_sources")

Expand Down
Loading

0 comments on commit 6d28c56

Please sign in to comment.