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

chore(deps): Bump keyring from 2.3.3 to 3.0.4 #1201

Closed
wants to merge 1 commit into from

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Jul 24, 2024

Bumps keyring from 2.3.3 to 3.0.4.

Release notes

Sourced from keyring's releases.

v3.0.4: expose cross-platform module alias

As reported in #197, there's no way for a client to access an instance of the default credential builder with platform-independent code. This releases fixes that oversight, and provides an example as part of the documentation of the credential module.

v3.0.3: Fix feature linux-native

Earlier releases didn't correctly use the keyring when the linux-native feature was specified. This release does.

Thanks to @​Brooooooklyn for finding this issue!

v3.0.2: fix iOS and doc issues in v3 release

This patch release adds in the missing iOS APIs reported in #187 and the missing CHANGELOG entries reported in #189. It also updates the README to be a lot clearer about how the new feature system interacts with platforms.

v3.0.1: Support for new keystores and binary secrets

The major functional change between v2 and v3 is the addition of synchronous support for the Secret Service via the dbus-secret-service crate. This means that keyring users of the Secret Service no longer need to link with an async runtime.

The main API change between v2 and v3 is the addition of support for non-string (i.e., binary) "password" data. To accommodate this, two changes have been made:

  1. There are two new methods on Entry objects: set_secret and get_secret. These are the analogs of set_password and get_password, but instead of taking or returning strings they take or return binary data (byte arrays/vectors).

  2. The v2 method delete_password has been renamed delete_credential, both to clarify what's actually being deleted and to emphasize that it doesn't matter whether it's holding a "password" or a "secret".

Another API change between v2 and v3 is that the notion of a default feature set has gone away: you must now specify explicitly which crate-supported keystores you want included (other than the mock keystore, which is always present). So all keyring client developers will need to update their Cargo.toml file to use the new features correctly.

All v2 data is fully forward-compatible with v3 data; there have been no changes at all in that respect.

The MSRV has been moved to 1.75, and all direct dependencies are at their latest stable versions.

(The original 3.0.0 release had a compile-time issue related to Error traits in some environments; v3.0.1 fixes that.)

v3.0.0-rc.2: Likely final candidate for next major release

This is likely the final RC for the v3 release. Please try it out and provide feedback. From the README:

The major functional change between v2 and v3 is the addition of synchronous support for the Secret Service via the dbus-secret-service crate. This means that keyring users of the Secret Service no longer need to link with an async runtime.

The main API change between v2 and v3 is the addition of support for non-string (i.e., binary) "password" data. To accommodate this, two changes have been made:

  1. There are two new methods on Entry objects: set_secret and get_secret. These are the analogs of set_password and get_password, but instead of taking or returning strings they take or return binary data (byte arrays/vectors).

  2. The v2 method delete_password has been renamed delete_credential, both to clarify what's actually being deleted and to emphasize that it doesn't matter whether it's holding a "password" or a "secret".

Another API change between v2 and v3 is that the notion of a default feature set has gone away: you must now specify explicitly which crate-supported keystores you want included (other than the mock keystore, which is always present). So all keyring client developers will need to update their Cargo.toml file to use the new features correctly.

All v2 data is fully forward-compatible with v3 data; there have been no changes at all in that respect.

The MSRV has been moved to 1.75, and all direct dependencies are at their latest stable versions.

v3.0.0-rc.1: Next major version

From the README:

The major functional change between v2 and v3 is the addition of synchronous support for the Secret Service via the dbus-secret-service crate. This means that keyring users of the Secret Service no longer need to link with an async runtime.

... (truncated)

Changelog

Sourced from keyring's changelog.

Version 3.0.2

  • add missing implementations for iOS set_secret and get_secret

Version 3.0.1

  • add back missing Sync trait on errors.

Version 3.0.0

  • add dbus-secret-service dependency to allow use on *n*x without an async runtime
  • (API change) rework feature controls on included keystores: now there is a feature for each keystore, and that keystore is included in a build if and only if its feature is specified and the keystore is supported by the target OS.
  • (API change) add direct support for setting and reading binary secret data, not just UTF-8 strings.

Version 2.0.1

  • fix the example in the README.

Version 2.0

  • (API change) Allow creation of entries to fail.
  • (API change) Introduce an ambiguous error on credential lookup.
  • (API change) Make the Error enum non-exhaustive.
  • (API change) Introduce traits for pluggable credential-store implementations. (This removes the old platform module.)
  • Add a mock credential store for easy cross-platform client testing.
  • Upgrade to secret-service v3.
  • Always use service-level search in secret-service.
  • Allow creation of new collections in secret-service.
  • Add the kernel keyutils as a linux credential store.
  • Add build support for FreeBSD (thanks @​ryanavella).

Version 1.2.1

  • password length was not validated correctly on Windows (#85)

Version 1.2

  • introduce protection against the use of empty arguments

Version 1.1.2

  • replace structopt with new, improved clap that incorporates all the same functionality.

Version 1.1.1

  • no functional updates, just documentation improvements

Version 1.1.0

  • add iOS support

Version 1.0.1

  • fix #80: missing winapi features (jyuch)

Version 1.0.0

  • Breaking API changes:
    • Keyring struct renamed to Entry
    • KeyringError enum renamed to Error, and is completely cross-platform.
  • API enhancements:
    • Clients can now control how entries map to credentials; see Entry::new_with_target and Entry::new_with_credential

... (truncated)

Commits
  • 47c8daf Merge pull request #198 from brotskydotcom/issue-197
  • 676d4d9 Release v3.0.4.
  • 3853136 Make the default module alias public.
  • 3bbe2da Merge pull request #195 from brotskydotcom/linux-native-feature
  • d663afd Release v3.0.3
  • 70ce2f9 Merge pull request #192 from brotskydotcom/release-3.0.2
  • 959bbb6 Release 3.0.2.
  • d0edffb Merge pull request #191 from brotskydotcom/iOS-issues
  • 176ee2e Include missing CHANGELOG entries.
  • 4d5cbea Release 3.0.2-rc.1
  • Additional commits viewable in compare view

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Bumps [keyring](https://github.com/hwchen/keyring-rs) from 2.3.3 to 3.0.4.
- [Release notes](https://github.com/hwchen/keyring-rs/releases)
- [Changelog](https://github.com/hwchen/keyring-rs/blob/master/CHANGELOG.md)
- [Commits](hwchen/keyring-rs@v2.3.3...v3.0.4)

---
updated-dependencies:
- dependency-name: keyring
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file rust Pull requests that update Rust code labels Jul 24, 2024
Copy link
Member

@notheotherben notheotherben left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This PR has been automatically approved because it was created by @dependabot.

Copy link
Contributor Author

dependabot bot commented on behalf of github Aug 2, 2024

Superseded by #1207.

@dependabot dependabot bot closed this Aug 2, 2024
auto-merge was automatically disabled August 2, 2024 07:49

Pull request was closed

@dependabot dependabot bot deleted the dependabot/cargo/keyring-3.0.4 branch August 2, 2024 07:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file rust Pull requests that update Rust code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant