Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

disable keyring per default #9866

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -532,10 +532,12 @@ for more information.

**Type**: `boolean`

**Default**: `true`
**Default**: `false`

**Environment Variable**: `POETRY_KEYRING_ENABLED`

*Changed default to `false` in 2.0.0*

Enable the system keyring for storing credentials.
See [Repositories - Configuring credentials]({{< relref "repositories#configuring-credentials" >}})
for more information.
15 changes: 9 additions & 6 deletions docs/repositories.md
Original file line number Diff line number Diff line change
Expand Up @@ -472,16 +472,19 @@ poetry config http-basic.pypi <username> <password>
You can also specify the username and password when using the `publish` command
with the `--username` and `--password` options.

If a system keyring is available and supported, the password is stored to and retrieved from the keyring. In the above example, the credential will be stored using the name `poetry-repository-pypi`. If access to keyring fails or is unsupported, this will fall back to writing the password to the `auth.toml` file along with the username.

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).

If you do not want to use the keyring, you can tell Poetry to disable it and store the credentials in plaintext config files:
If a system keyring is available and supported, the password is stored to and retrieved from the keyring.
Otherwise, credentials are stored in plaintext config files.
In order to use keyring, you have to enable keyring support:

```bash
poetry config keyring.enabled false
poetry config keyring.enabled true
```

In the above example, the credential will be stored using the name `poetry-repository-pypi`.
If access to keyring is disabled, fails or is unsupported, this will fall back to writing the password to the `auth.toml` file along with the username.

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 fall back to Pip style use of keyring so that backends like
Expand Down
2 changes: 1 addition & 1 deletion src/poetry/config/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ class Config:
},
"system-git-client": False,
"keyring": {
"enabled": True,
"enabled": False,
},
}

Expand Down
6 changes: 5 additions & 1 deletion src/poetry/utils/password_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,11 @@ def keyring(self) -> PoetryKeyring:

@staticmethod
def warn_plaintext_credentials_stored() -> None:
logger.warning("Using a plaintext file to store credentials")
logger.warning(
"Using a plaintext file to store credentials.\n"
"Enable keyring support (`poetry config keyring.enabled true`)"
" to store credentials securely."
)

def set_pypi_token(self, repo_name: str, token: str) -> None:
if not self.use_keyring:
Expand Down
4 changes: 4 additions & 0 deletions tests/config/test_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,10 @@ def test_config_expands_tilde_for_virtualenvs_path(
def test_disabled_keyring_is_unavailable(
config: Config, with_simple_keyring: None, dummy_keyring: DummyBackend
) -> None:
manager = PasswordManager(config)
assert not manager.use_keyring

config.config["keyring"]["enabled"] = True
manager = PasswordManager(config)
assert manager.use_keyring

Expand Down
12 changes: 6 additions & 6 deletions tests/console/commands/test_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ def test_list_displays_default_value_if_not_set(
installer.only-binary = null
installer.parallel = true
installer.re-resolve = true
keyring.enabled = true
keyring.enabled = false
requests.max-retries = 0
solver.lazy-wheel = true
system-git-client = false
Expand Down Expand Up @@ -92,7 +92,7 @@ def test_list_displays_set_get_setting(
installer.only-binary = null
installer.parallel = true
installer.re-resolve = true
keyring.enabled = true
keyring.enabled = false
requests.max-retries = 0
solver.lazy-wheel = true
system-git-client = false
Expand Down Expand Up @@ -145,7 +145,7 @@ def test_unset_setting(
installer.only-binary = null
installer.parallel = true
installer.re-resolve = true
keyring.enabled = true
keyring.enabled = false
requests.max-retries = 0
solver.lazy-wheel = true
system-git-client = false
Expand Down Expand Up @@ -176,7 +176,7 @@ def test_unset_repo_setting(
installer.only-binary = null
installer.parallel = true
installer.re-resolve = true
keyring.enabled = true
keyring.enabled = false
requests.max-retries = 0
solver.lazy-wheel = true
system-git-client = false
Expand Down Expand Up @@ -305,7 +305,7 @@ def test_list_displays_set_get_local_setting(
installer.only-binary = null
installer.parallel = true
installer.re-resolve = true
keyring.enabled = true
keyring.enabled = false
requests.max-retries = 0
solver.lazy-wheel = true
system-git-client = false
Expand Down Expand Up @@ -344,7 +344,7 @@ def test_list_must_not_display_sources_from_pyproject_toml(
installer.only-binary = null
installer.parallel = true
installer.re-resolve = true
keyring.enabled = true
keyring.enabled = false
repositories.foo.url = "https://foo.bar/simple/"
requests.max-retries = 0
solver.lazy-wheel = true
Expand Down
6 changes: 6 additions & 0 deletions tests/utils/test_authenticator.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,12 @@ def repo() -> dict[str, dict[str, str]]:
return {"foo": {"url": "https://foo.bar/simple/"}}


@pytest.fixture
def config(config: Config) -> Config:
config.config["keyring"]["enabled"] = True
return config


@pytest.fixture
def mock_config(config: Config, repo: dict[str, dict[str, str]]) -> Config:
config.merge(
Expand Down
6 changes: 6 additions & 0 deletions tests/utils/test_password_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@
from tests.conftest import DummyBackend


@pytest.fixture
def config(config: Config) -> Config:
config.config["keyring"]["enabled"] = True
return config


def test_set_http_password(
config: Config, with_simple_keyring: None, dummy_keyring: DummyBackend
) -> None:
Expand Down
Loading