https://github.com/weisjohn/mongoose-bcrypt-simple

encrypt and verify mongoose schemas
https://github.com/weisjohn/mongoose-bcrypt-simple

Last synced: about 1 month ago
JSON representation

encrypt and verify mongoose schemas

• Host: GitHub
• URL: https://github.com/weisjohn/mongoose-bcrypt-simple
• Owner: weisjohn
• License: mit
• Created: 2015-07-23T17:35:54.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-10-15T08:24:46.000Z (about 9 years ago)
• Last Synced: 2024-04-14T16:04:32.590Z (9 months ago)
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/mongoose-bcrypt-simple
• Size: 152 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mongoose-bcrypt-simple

encrypt and verify mongoose schemas

### usage

#### `mbs(schema, String|Object)`

Pass the property name, or an object to control the number of [salt steps](https://www.npmjs.com/package/bcrypt#api) for bcrypt.

```javascript

var mongoose = require('mongoose');

var mbs = require('mongoose-bcrypt-simple');

var user = new mongoose.Schema({ username: String });

user.plugin(mbs, 'password');

user.plugin(mbs, { prop : 'pin', steps : 14 });

user = mongoose.model('user', user);

```

### virtuals

A virtual field is created for the property that automatically salts and hashes the value.

### verify

Verification methods are added based on the property name, prefixed with `verify_`, e.g. `verify_password` and `verify_pin`. If a callback is provided, the verification is async.

```javascript

user.findOne({ email : '[email protected]' }, function(err, user1) {

    user1.verify_password('foobar');         // sync

    user1.verify_pin('1234', cb);            // async

});

```

### schema

A path for the property is created on the schema prefixed with `hash_`, e.g. `hash_password` and `hash_pin`. You do not work with these properties directly.

### encapsulation

When calling `toJSON()` on the object, properties which were generated to store the hash are not returned. `toObject()` is not modified. This is helpful when returning objects across an API. For example:

```javascript

console.log(user1);

/*

{ __v: 0,

  username: 'foo',

  hash_password: '$2a$12$ePVnPYtqIZTyDcNcVVYobeoddBPLieO6XRoVDX0ICBC9I0i369nWO',

  hash_pin: '$2a$08$sI.7KylAh6eER33gULi7JulTR3PG1hEAcdh/1Cque.RGvww0o.32K',

  _id: 55b13b4b74e155f484fc3b72 }

*/

```

```javascript

console.log(user1.toJSON());

/*

{ __v: 0, username: 'foo', _id: 55b13b4b74e155f484fc3b72 }

*/

```