webpasswordsafe

Simple API Wrapper for WebPasswordSafe, an online Java-based password store.

Requirements

• Node >= 8.0 (It doesn't use any too modern JavaScript features, but I haven't tried it. Good luck!)
• Depends on axios for all the heavy networking stuff.

Installation

$ npm install webpasswordsafe

Classes

Password

Interface used by many of WPS's methods

WPS

Main class of the client

Password

This is a description of the password objects returned and consumed by the WebPasswordSafe-API.

Kind: global interface
Properties

WPS

Kind: global class

• WPS
  • new WPS(options)
  • .getPasswordList(query) ⇒ Promise.<Array.<Password>>
  • .getPassword(passwordId, [includeValue]) ⇒ Promise.<Password>
  • .getCurrentPassword(passwordId) ⇒ Promise.<string>
  • .addPassword(password) ⇒ Promise.<Password>
  • .updatePassword(password) ⇒ Promise.<Password>

new WPS(options)

Create an instance of the WebPasswordStore client.

Example

const https = require('https');
const wps = require('webpasswordsafe')({
  url: 'https://pwstore.local:8443/',
  username: 'jack',
  password: '*********',
 
  // pass this to allow self-signed certificates.
  // httpsAgent: new https.Agent({ rejectUnauthorized: false })
});
 
// search all passwords matching 'npm'
wps.getPasswordList('npm')
  .then(passwords => Promise.all(passwords.map(password =>
    // get the actual password for each of them
    wps.getCurrentPassword(password.id, true)
      .then(value => {
        // convert this value to an object containing the interesting bits
        return {
          title: password.title,
          username: password.username,
          value: value
        };
      })
  )))
  // here we get a promise that is resolved once all password values are converted
  .then(passwordsData => {
    passwordsData.forEach(password => {
      // print all the passwords!
      console.log(password.title, '::', password.username, '::', password.value);
    })
  })

WPS.getPasswordList(query) ⇒ Promise.<Array.<Password>>

Search for passwords on the server. This is equivalent of using the search function in the client app. The passwords returned by this function do not include their value. To get the actual password, use the getPassword or getCurrentPassword functions.

Kind: instance method of WPS
Returns: Promise.<Array.<Password>> - A list of passwords matching query

WPS.getPassword(passwordId, [includeValue]) ⇒ Promise.<Password>

Get a single password.

Kind: instance method of WPS
Returns: Promise.<Password> - The password

WPS.getCurrentPassword(passwordId) ⇒ Promise.<string>

Get only the value of a password.

Kind: instance method of WPS
Returns: Promise.<string> - The password's value.

WPS.addPassword(password) ⇒ Promise.<Password>

Add a password to the WebPasswordSafe and grant the logged in user permissions to it. Unfortunately, there is no way to set additional permission using the API.

Kind: instance method of WPS
Returns: Promise.<Password> - The newly safed password, including their id.

WPS.updatePassword(password) ⇒ Promise.<Password>

Update password data. Passwords are matched by their id. Note that this might be broken: https://github.com/joshdrummond/webpasswordsafe/issues/120

Kind: instance method of WPS
Returns: Promise.<Password> - The newly updated password, without the actual value.