ES6 & standard style
This commit is contained in:
Julien Fontanet
parent
1feaa43d2e
commit
62618acfed
@ -1,95 +0,0 @@
|
||||
{
|
||||
// Julien Fontanet JSHint configuration
|
||||
// https://gist.github.com/julien-f/8095615
|
||||
//
|
||||
// Changes from defaults:
|
||||
// - all enforcing options (except `++` & `--`) enabled
|
||||
// - single quotes
|
||||
// - indentation set to 2 instead of 4
|
||||
// - almost all relaxing options disabled
|
||||
// - allow expression statements (necessary for chai.expect())
|
||||
// - allow global strict (most of my devs are in Node.js or Browserify)
|
||||
// - environments are set to Browserify, mocha & Node.js
|
||||
//
|
||||
// See http://jshint.com/docs/ for more details
|
||||
|
||||
"maxerr" : 50, // {int} Maximum error before stopping
|
||||
|
||||
// Enforcing
|
||||
"bitwise" : true, // true: Prohibit bitwise operators (&, |, ^, etc.)
|
||||
"camelcase" : true, // true: Identifiers must be in camelCase
|
||||
"curly" : true, // true: Require {} for every new block or scope
|
||||
"eqeqeq" : true, // true: Require triple equals (===) for comparison
|
||||
"forin" : true, // true: Require filtering for..in loops with obj.hasOwnProperty()
|
||||
"freeze" : true, // true: Prohibit overwriting prototypes of native objects (Array, Date, ...)
|
||||
"immed" : true, // true: Require immediate invocations to be wrapped in parens e.g. `(function () { } ());`
|
||||
"indent" : 2, // {int} Number of spaces to use for indentation
|
||||
"latedef" : true, // true: Require variables/functions to be defined before being used
|
||||
"newcap" : true, // true: Require capitalization of all constructor functions e.g. `new F()`
|
||||
"noarg" : true, // true: Prohibit use of `arguments.caller` and `arguments.callee`
|
||||
"noempty" : true, // true: Prohibit use of empty blocks
|
||||
"nonbsp" : true, // true: Prohibit use of non breakable spaces
|
||||
"nonew" : true, // true: Prohibit use of constructors for side-effects (without assignment)
|
||||
"plusplus" : false, // true: Prohibit use of `++` & `--`
|
||||
"quotmark" : "single", // Quotation mark consistency:
|
||||
// false : do nothing (default)
|
||||
// true : ensure whatever is used is consistent
|
||||
// "single" : require single quotes
|
||||
// "double" : require double quotes
|
||||
"undef" : true, // true: Require all non-global variables to be declared (prevents global leaks)
|
||||
"unused" : true, // true: Require all defined variables be used
|
||||
"strict" : true, // true: Requires all functions run in ES5 Strict Mode
|
||||
"maxcomplexity" : 7, // {int} Max cyclomatic complexity per function
|
||||
"maxdepth" : 3, // {int} Max depth of nested blocks (within functions)
|
||||
"maxlen" : 80, // {int} Max number of characters per line
|
||||
"maxparams" : 4, // {int} Max number of formal params allowed per function
|
||||
"maxstatements" : 20, // {int} Max number statements per function
|
||||
|
||||
// Relaxing
|
||||
"asi" : false, // true: Tolerate Automatic Semicolon Insertion (no semicolons)
|
||||
"boss" : false, // true: Tolerate assignments where comparisons would be expected
|
||||
"debug" : false, // true: Allow debugger statements e.g. browser breakpoints.
|
||||
"eqnull" : false, // true: Tolerate use of `== null`
|
||||
"esnext" : false, // true: Allow ES.next (ES6) syntax (ex: `const`)
|
||||
"evil" : false, // true: Tolerate use of `eval` and `new Function()`
|
||||
"expr" : true, // true: Tolerate `ExpressionStatement` as Programs
|
||||
"funcscope" : false, // true: Tolerate defining variables inside control statements
|
||||
"globalstrict" : true, // true: Allow global "use strict" (also enables 'strict')
|
||||
"iterator" : false, // true: Tolerate using the `__iterator__` property
|
||||
"lastsemic" : false, // true: Tolerate omitting a semicolon for the last statement of a 1-line block
|
||||
"laxbreak" : false, // true: Tolerate possibly unsafe line breakings
|
||||
"laxcomma" : false, // true: Tolerate comma-first style coding
|
||||
"loopfunc" : false, // true: Tolerate functions being defined in loops
|
||||
"moz" : false, // true: Allow Mozilla specific syntax (extends and overrides esnext features)
|
||||
// (ex: `for each`, multiple try/catch, function expression…)
|
||||
"multistr" : false, // true: Tolerate multi-line strings
|
||||
"notypeof" : false, // true: Tolerate typeof comparison with unknown values.
|
||||
"proto" : false, // true: Tolerate using the `__proto__` property
|
||||
"scripturl" : false, // true: Tolerate script-targeted URLs
|
||||
"shadow" : false, // true: Allows re-define variables later in code e.g. `var x=1; x=2;`
|
||||
"sub" : false, // true: Tolerate using `[]` notation when it can still be expressed in dot notation
|
||||
"supernew" : false, // true: Tolerate `new function () { ... };` and `new Object;`
|
||||
"validthis" : false, // true: Tolerate using this in a non-constructor function
|
||||
"noyield" : false, // true: Tolerate generators without yields
|
||||
|
||||
// Environments
|
||||
"browser" : false, // Web Browser (window, document, etc)
|
||||
//"browserify" : true, // Browserify (node.js code in the browser)
|
||||
"couch" : false, // CouchDB
|
||||
"devel" : true, // Development/debugging (alert, confirm, etc)
|
||||
"dojo" : false, // Dojo Toolkit
|
||||
"jquery" : false, // jQuery
|
||||
"mocha" : true, // mocha
|
||||
"mootools" : false, // MooTools
|
||||
"node" : true, // Node.js
|
||||
"nonstandard" : false, // Widely adopted globals (escape, unescape, etc)
|
||||
"phantom" : false, // PhantomJS
|
||||
"prototypejs" : false, // Prototype and Scriptaculous
|
||||
"rhino" : false, // Rhino
|
||||
"worker" : false, // Web Workers
|
||||
"wsh" : false, // Windows Scripting Host
|
||||
"yui" : false, // Yahoo User Interface
|
||||
|
||||
// Custom Globals
|
||||
"globals" : {} // additional predefined global variables
|
||||
}
|
||||
@ -1,6 +1,16 @@
|
||||
# xo-server-auth-ldap
|
||||
# xo-server-auth-ldap [](https://travis-ci.org/vatesfr/xo-server-auth-ldap)
|
||||
|
||||
> XO-Server LDAP authentication plugin.
|
||||
> LDAP authentication plugin for XO-Server
|
||||
|
||||
## Install
|
||||
|
||||
Installation of the [npm package](https://npmjs.org/package/xo-server-auth-ldap):
|
||||
|
||||
```
|
||||
> npm install xo-server-auth-ldap
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
To enable this plugin you have to add it into the configuration file
|
||||
of XO-Server:
|
||||
@ -12,3 +22,40 @@ plugins:
|
||||
uri: "ldap://ldap.example.org",
|
||||
base: "ou=people,dc=example,dc=org"
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
### Installing dependencies
|
||||
|
||||
```
|
||||
> npm install
|
||||
```
|
||||
|
||||
### Compilation
|
||||
|
||||
The sources files are watched and automatically recompiled on changes.
|
||||
|
||||
```
|
||||
> npm run dev
|
||||
```
|
||||
|
||||
### Tests
|
||||
|
||||
```
|
||||
> npm run test-dev
|
||||
```
|
||||
|
||||
## Contributions
|
||||
|
||||
Contributions are *very* welcomed, either on the documentation or on
|
||||
the code.
|
||||
|
||||
You may:
|
||||
|
||||
- report any [issue](https://github.com/vatesfr/xo-server-auth-ldap/issues)
|
||||
you've encountered;
|
||||
- fork and create a pull request.
|
||||
|
||||
## License
|
||||
|
||||
AGPL3 © [Vates SAS](http://vates.fr)
|
||||
|
||||
@ -1,56 +0,0 @@
|
||||
'use strict';
|
||||
|
||||
//====================================================================
|
||||
|
||||
var Bluebird = require('bluebird');
|
||||
var createClient = require('ldapjs').createClient;
|
||||
var escape = require('ldapjs/lib/filters/escape').escape;
|
||||
|
||||
//====================================================================
|
||||
|
||||
function AuthLdap(conf) {
|
||||
var base = conf.base ? ',' + conf.base : '';
|
||||
var clientOpts = {
|
||||
url: conf.uri,
|
||||
};
|
||||
|
||||
this._provider = function (credentials) {
|
||||
var username = credentials.username;
|
||||
var password = credentials.password;
|
||||
if (username === undefined || password === undefined) {
|
||||
return Bluebird.reject(new Error('invalid credentials'));
|
||||
}
|
||||
|
||||
return new Bluebird(function (resolve, reject) {
|
||||
var client = createClient(clientOpts);
|
||||
|
||||
client.bind(
|
||||
'uid=' + escape(username) + base,
|
||||
password,
|
||||
function (error) {
|
||||
if (error) {
|
||||
reject(error);
|
||||
} else {
|
||||
resolve({ username: username });
|
||||
}
|
||||
|
||||
client.unbind();
|
||||
}
|
||||
);
|
||||
});
|
||||
};
|
||||
}
|
||||
|
||||
AuthLdap.prototype.load = function load(xo) {
|
||||
xo.registerAuthenticationProvider(this._provider);
|
||||
};
|
||||
|
||||
AuthLdap.prototype.unload = function unload(xo) {
|
||||
xo.unregisterAuthenticationProvider(this._provider);
|
||||
};
|
||||
|
||||
//====================================================================
|
||||
|
||||
exports = module.exports = function (conf) {
|
||||
return new AuthLdap(conf);
|
||||
};
|
||||
@ -1,11 +0,0 @@
|
||||
'use strict';
|
||||
|
||||
//====================================================================
|
||||
|
||||
var myLib = require('./');
|
||||
|
||||
var expect = require('must');
|
||||
|
||||
//====================================================================
|
||||
|
||||
describe('myLib');
|
||||
@ -18,18 +18,32 @@
|
||||
"email": "julien.fontanet@isonoe.net"
|
||||
},
|
||||
"preferGlobal": false,
|
||||
"main": "dist/",
|
||||
"files": [
|
||||
"index.js"
|
||||
"dist/"
|
||||
],
|
||||
"dependencies": {
|
||||
"babel-runtime": "^4",
|
||||
"bluebird": "^2.9.21",
|
||||
"ldapjs": "^0.7.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"babel": "^4",
|
||||
"mocha": "*",
|
||||
"must": "*"
|
||||
"must": "*",
|
||||
"sinon": "*",
|
||||
"standard": "*"
|
||||
},
|
||||
"scripts": {
|
||||
"test": "mocha *.spec.js"
|
||||
"build": "mkdir --parents dist && babel --optional=runtime --compact=true --source-maps --out-dir=dist/ src/",
|
||||
"dev": "mkdir --parents dist && babel --watch --optional=runtime --compact=true --source-maps --out-dir=dist/ src/",
|
||||
"prepublish": "npm build",
|
||||
"test": "standard && mocha 'dist/**/*.spec.js'",
|
||||
"test-dev": "standard && mocha --watch --reporter=min 'dist/**/*.spec.js'"
|
||||
},
|
||||
"dependencies": {
|
||||
"bluebird": "^2.9.14",
|
||||
"ldapjs": "^0.7.1"
|
||||
"standard": {
|
||||
"ignore": [
|
||||
"dist/**"
|
||||
]
|
||||
}
|
||||
}
|
||||
|
||||
51
packages/xo-server-auth-ldap/src/index.js
Normal file
51
packages/xo-server-auth-ldap/src/index.js
Normal file
@ -0,0 +1,51 @@
|
||||
import Bluebird from 'bluebird'
|
||||
import {createClient} from 'ldapjs'
|
||||
import {escape} from 'ldapjs/lib/filters/escape'
|
||||
|
||||
// ===================================================================
|
||||
|
||||
class AuthLdap {
|
||||
constructor (conf) {
|
||||
const base = conf.base ? ',' + conf.base : ''
|
||||
const clientOpts = {
|
||||
url: conf.uri
|
||||
}
|
||||
|
||||
this._provider = (credentials) => {
|
||||
const {username, password} = credentials
|
||||
if (username === undefined || password === undefined) {
|
||||
return Bluebird.reject(new Error('invalid credentials'))
|
||||
}
|
||||
|
||||
return new Bluebird((resolve, reject) => {
|
||||
const client = createClient(clientOpts)
|
||||
|
||||
client.bind(
|
||||
'uid=' + escape(username) + base,
|
||||
password,
|
||||
(error) => {
|
||||
if (error) {
|
||||
reject(error)
|
||||
} else {
|
||||
resolve({ username })
|
||||
}
|
||||
|
||||
client.unbind()
|
||||
}
|
||||
)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
load (xo) {
|
||||
xo.registerAuthenticationProvider(this._provider)
|
||||
}
|
||||
|
||||
unload (xo) {
|
||||
xo.unregisterAuthenticationProvider(this._provider)
|
||||
}
|
||||
}
|
||||
|
||||
// ===================================================================
|
||||
|
||||
export default (conf) => new AuthLdap(conf)
|
||||
Loading…
Reference in New Issue
Block a user