https://github.com/pouchdb-community/pouchdb-authentication

User authentication plugin for PouchDB and CouchDB.
https://github.com/pouchdb-community/pouchdb-authentication

Last synced: 5 days ago
JSON representation

User authentication plugin for PouchDB and CouchDB.

• Host: GitHub
• URL: https://github.com/pouchdb-community/pouchdb-authentication
• Owner: pouchdb-community
• License: apache-2.0
• Created: 2014-03-28T00:21:00.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2023-02-27T17:25:57.000Z (over 1 year ago)
• Last Synced: 2024-10-30T04:54:37.620Z (10 days ago)
• Language: JavaScript
• Homepage:
• Size: 2.28 MB
• Stars: 775
• Watchers: 27
• Forks: 118
• Open Issues: 47
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Security: docs/security_button.png

Awesome Lists containing this project

• awesome-starred - pouchdb-community/pouchdb-authentication - User authentication plugin for PouchDB and CouchDB. (others)

README

        
PouchDB Authentication

=====

[![Build Status](https://travis-ci.org/pouchdb-community/pouchdb-authentication.svg?branch=master)](https://travis-ci.org/pouchdb-community/pouchdb-authentication)

[![Greenkeeper badge](https://badges.greenkeeper.io/pouchdb-community/pouchdb-authentication.svg)](https://greenkeeper.io/)

[![npm version](https://img.shields.io/npm/v/pouchdb-authentication.svg)](https://www.npmjs.com/package/pouchdb-authentication)



Easy user authentication for PouchDB/CouchDB.

```js

var db = new PouchDB('http://mysite:5984/mydb', {skip_setup: true});

db.logIn('batman', 'brucewayne').then(function (batman) {

  console.log("I'm Batman.");

  return db.logOut();

});

```

Overview

----------

You know what's hard?  **Security**.  You know what makes security really easy?  **CouchDB**.

That's right, CouchDB is more than a database: it's also a RESTful web server with a built-in authentication framework. And it boasts some top-notch security features:

* **salts and hashes** passwords automatically with [PBKDF2](https://en.wikipedia.org/wiki/PBKDF2)

* **stores a cookie** in the browser

* **refreshes the cookie** every 10 minutes (default)

And best of all, CouchDB does it with good ol'-fashioned HTTP. Just open up the network tab and watch the JSON fly back and forth.

To get started, just install CouchDB, throw in [a little SSL](https://wiki.apache.org/couchdb/How_to_enable_SSL), and you've got everything you need for your site's authentication.

### Project status

This plugin uses vanilla CouchDB.  The goal is to give you a lightweight authentication API that doesn't require anything fancy – no additional server daemons, no third-party providers, just straight-up Pouch and Couch.

So this is more of a reference implementation than an all-in-one solution. If there's a feature missing that you need, you will probably need to write a custom server (see the [CouchDB Authentication recipes][recipes] section for details).

Since version 1.0.0, this plugin **does support Node.js**.

Using PouchDB Authentication

------

* [Setup](https://github.com/pouchdb-community/pouchdb-authentication/blob/master/docs/setup.md)

* [API](https://github.com/pouchdb-community/pouchdb-authentication/blob/master/docs/api.md)

* [CouchDB Authentication recipes][recipes]

Changelog

------

PouchDB Authentication follows [semantic versioning](http://semver.org/). To see a changelog with all PouchDB Authentication releases, check out the [Github releases page](https://github.com/pouchdb-community/pouchdb-authentication/releases).

Contributing

------

We use [standard-version](https://github.com/conventional-changelog/standard-version) for release versioning along with [Angular-style commit messages](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit) to automate the changelog generation. To help you make good commit messages, you are advised to install and use [commitizen](https://github.com/commitizen/cz-cli).

PouchDB Authentication is heavily tested, so you'll also want to check out the [testing guide](https://github.com/pouchdb-community/pouchdb-authentication/blob/master/TESTING.md).

[recipes]: https://github.com/pouchdb-community/pouchdb-authentication/blob/master/docs/recipes.md

Big Thanks

------

Cross-browser Testing Platform and Open Source <3 Provided by [Sauce Labs][sauce labs homepage].

![sauce labs logo][]

[sauce labs homepage]: https://saucelabs.com

[sauce labs logo]: https://raw.githubusercontent.com/pouchdb-community/pouchdb-authentication/master/docs/sauce_labs.png