"Fossies" - the Fresh Open Source Software Archive

Member "Atom/resources/app/apm/node_modules/keytar/README.md" (25 Nov 2016, 2234 Bytes) of archive /windows/misc/atom-windows.zip:


As a special service "Fossies" has tried to format the requested source page into HTML format (assuming markdown format). Alternatively you can here view or download the uninterpreted source code file. A member file download can also be achieved by clicking within a package contents listing on the according byte size field.

keytar - Node module to manage system keychain

Build Status

A native Node module to get, add, replace, and delete passwords in system's keychain. On OS X the passwords are managed by the Keychain, on Linux they are managed by Gnome Keyring and on Windows they are managed by Credential Vault.

Installing

npm install keytar

On Linux

Currently this library uses the gnome-keyring so you may need to run sudo apt-get install libgnome-keyring-dev before npm installing.

If you are using a Red Hat-based system you need to run sudo yum install libgnome-keyring-devel.

Building

Docs

keytar = require 'keytar'

getPassword(service, account)

Get the stored password for the service and account.

service - The string service name.

account - The string account name.

Returns the string password or null on failures.

addPassword(service, account, password)

Add the password for the service and account to the keychain.

service - The string service name.

account - The string account name.

password - The string password.

Returns true on success, false on failure.

deletePassword(service, account)

Delete the stored password for the service and account.

service - The string service name.

account - The string account name.

Returns the string password or null on failures.

replacePassword(service, account, password)

Replace the password for the service and account in the keychain.

This is a simple convenience function that internally calls deletePassword(service, account) followed by addPassword(service, account, password).

service - The string service name.

account - The string account name.

password - The string password.

Returns true on success, false on failure.

findPassword(service)

Find a password for the service in the keychain.

service - The string service name.

Returns the string password or null on failures.