Gathering detailed insights and metrics for keytar
Gathering detailed insights and metrics for keytar
Installations
npm install keytarDeveloper
Developer Guide
BETA
Module System
CommonJS
Min. Node Version
Typescript Support
Yes
Node Version
15.14.0
NPM Version
7.7.6
Statistics
1,371 Stars
502 Commits
193 Forks
28 Watching
10 Branches
51 Contributors
Updated on 15 Oct 2024
Languages
C++ (72.13%)
JavaScript (16.42%)
Python (4.18%)
Dockerfile (3.79%)
PowerShell (2.92%)
Shell (0.55%)
Total Downloads
Cumulative downloads
Total Downloads
94,456,032
Last day
-6.1%
104,447
Compared to previous day
Last week
-1%
562,486
Compared to previous week
Last month
11.3%
2,389,977
Compared to previous month
Last year
0.5%
24,865,376
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
2
Versions
keytar - Node module to manage system keychain
A native Node module to get, add, replace, and delete passwords in system's keychain. On macOS the passwords are managed by the Keychain, on Linux they are managed by the Secret Service API/libsecret, and on Windows they are managed by Credential Vault.
Installing
1npm install keytar
On Linux
Currently this library uses libsecret so you may need to install it before running npm install.
Depending on your distribution, you will need to run the following command:
- Debian/Ubuntu:
sudo apt-get install libsecret-1-dev - Red Hat-based:
sudo yum install libsecret-devel - Arch Linux:
sudo pacman -S libsecret
Building
- Clone the repository
- Run
npm install - Run
npm testto run the tests
Supported versions
Each release of keytar includes prebuilt binaries for the versions of Node and Electron that are actively supported by these projects. Please refer to the release documentation for Node and Electron to see what is supported currently.
Bindings from other languages
Docs
1const keytar = require('keytar')
Every function in keytar is asynchronous and returns a promise. The promise will be rejected with any error that occurs or will be resolved with the function's "yields" value.
getPassword(service, account)
Get the stored password for the service and account.
service - The string service name.
account - The string account name.
Yields the string password or null if an entry for the given service and account was not found.
setPassword(service, account, password)
Save the password for the service and account to the keychain. Adds a new entry if necessary, or updates an existing entry if one exists.
service - The string service name.
account - The string account name.
password - The string password.
Yields nothing.
deletePassword(service, account)
Delete the stored password for the service and account.
service - The string service name.
account - The string account name.
Yields true if a password was deleted, or false if an entry with the given service and account was not found.
findCredentials(service)
Find all accounts and password for the service in the keychain.
service - The string service name.
Yields an array of { account: 'foo', password: 'bar' }.
findPassword(service)
Find a password for the service in the keychain. This is ideal for scenarios where an account is not required.
service - The string service name.
Yields the string password, or null if an entry for the given service was not found.
No vulnerabilities found.
Reason
all changesets reviewed
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE.md:0
- Info: FSF or OSI recognized license: MIT License: LICENSE.md:0
Reason
SAST tool detected but not run on all commits
Details
- Info: SAST configuration detected: CodeQL
- Warn: 0 commits out of 30 are checked with a SAST tool
Reason
project is archived
Details
- Warn: Repository is archived.
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/ci.yml:1
- Warn: no topLevel permission defined: .github/workflows/codeql.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:115: update your workflow using https://app.stepsecurity.io/secureworkflow/atom/node-keytar/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:146: update your workflow using https://app.stepsecurity.io/secureworkflow/atom/node-keytar/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:148: update your workflow using https://app.stepsecurity.io/secureworkflow/atom/node-keytar/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/atom/node-keytar/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/atom/node-keytar/ci.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/atom/node-keytar/codeql.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/atom/node-keytar/codeql.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/atom/node-keytar/codeql.yml/master?enable=pin
- Warn: containerImage not pinned by hash: docker/arm64-cross-compile/Dockerfile:1: pin your Docker image by updating debian:buster to debian:buster@sha256:58ce6f1271ae1c8a2006ff7d3e54e9874d839f573d8009c20154ad0f2fb0a225
- Warn: containerImage not pinned by hash: docker/armv7l-cross-compile/Dockerfile:1: pin your Docker image by updating debian:buster to debian:buster@sha256:58ce6f1271ae1c8a2006ff7d3e54e9874d839f573d8009c20154ad0f2fb0a225
- Warn: containerImage not pinned by hash: docker/i386/Dockerfile:1: pin your Docker image by updating i386/debian:stretch to i386/debian:stretch@sha256:5be6b5853a13d413e4ef557ed1cbf6cf0ba4896769c7c37422fada653e0cdee5
- Warn: downloadThenRun not pinned by hash: docker/arm64-cross-compile/Dockerfile:28
- Warn: downloadThenRun not pinned by hash: docker/armv7l-cross-compile/Dockerfile:28
- Warn: downloadThenRun not pinned by hash: docker/i386/Dockerfile:12
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yml:157
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yml:57
- Warn: pipCommand not pinned by hash: .github/workflows/ci.yml:64
- Warn: pipCommand not pinned by hash: .github/workflows/ci.yml:65
- Warn: npmCommand not pinned by hash: .github/workflows/ci.yml:121
- Warn: npmCommand not pinned by hash: .github/workflows/codeql.yml:35
- Info: 0 out of 8 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 4 npmCommand dependencies pinned
- Info: 0 out of 2 pipCommand dependencies pinned
- Info: 0 out of 3 containerImage dependencies pinned
- Info: 0 out of 3 downloadThenRun dependencies pinned
Reason
Project has not signed or included provenance with any releases.
Details
- Warn: release artifact v7.9.0 not signed: https://api.github.com/repos/atom/node-keytar/releases/59796291
- Warn: release artifact v7.8.0 not signed: https://api.github.com/repos/atom/node-keytar/releases/58500438
- Warn: release artifact v7.7.0 not signed: https://api.github.com/repos/atom/node-keytar/releases/42066422
- Warn: release artifact v7.6.0 not signed: https://api.github.com/repos/atom/node-keytar/releases/40583669
- Warn: release artifact v7.5.0 not signed: https://api.github.com/repos/atom/node-keytar/releases/40420374
- Warn: release artifact v7.9.0 does not have provenance: https://api.github.com/repos/atom/node-keytar/releases/59796291
- Warn: release artifact v7.8.0 does not have provenance: https://api.github.com/repos/atom/node-keytar/releases/58500438
- Warn: release artifact v7.7.0 does not have provenance: https://api.github.com/repos/atom/node-keytar/releases/42066422
- Warn: release artifact v7.6.0 does not have provenance: https://api.github.com/repos/atom/node-keytar/releases/40583669
- Warn: release artifact v7.5.0 does not have provenance: https://api.github.com/repos/atom/node-keytar/releases/40420374
Reason
16 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h
- Warn: Project is vulnerable to: GHSA-4q6p-r6v2-jvc5
- Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
- Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Score
3.9
/10
Last Scanned on 2024-11-25
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More