Skip to content

Move off of Keytar #185677

@TylerLeonhardt

Description

@TylerLeonhardt

With node-keytar now archived and unmaintained, we need a path forward for securely storing secrets and additionally, reflect the fact that we do not need to follow the shape of keytar anymore.

On Desktop, we will take advantage of Electron's safeStorage API. We will also get rid of vscode-encrypt because it would be providing no benefit in this new world.

Additionally, we will remove the KeytarShim that has been in the product. This was the solution to secrets before the SecretStorage API.

Outlined are the steps to get this done:

### Tasks
- [x] Implement new `EncryptionService` & `SecretStorageService` services with a migration story. Use new services for extension SecretStorage API
- [ ] https://github.com/microsoft/vscode/issues/186241
- [x] Write new docs for troubleshooting keyring issues & update remote docs
- [x] Notify top X extensions of KeytarShim that we will remove it
- [x] Make discussion post: https://github.com/microsoft/vscode-discussions/discussions/662
- [ ] https://github.com/microsoft/vscode/issues/115215

Metadata

Metadata

Labels

authenticationIssues with the Authentication platformengineeringVS Code - Build / issue tracking / etc.feature-requestRequest for new features or functionalityon-release-notesIssue/pull request mentioned in release noteson-testplan

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions