commit de5ba5d0d3d50f4a260174ff8c2d3fa01d240d34 Author: Julien Fontanet Date: Tue Mar 17 16:28:31 2015 +0100 Initial commit. diff --git a/packages/xo-server-auth-ldap/.editorconfig b/packages/xo-server-auth-ldap/.editorconfig new file mode 100644 index 000000000..da21ef4c5 --- /dev/null +++ b/packages/xo-server-auth-ldap/.editorconfig @@ -0,0 +1,65 @@ +# http://EditorConfig.org +# +# Julien Fontanet's configuration +# https://gist.github.com/julien-f/8096213 + +# Top-most EditorConfig file. +root = true + +# Common config. +[*] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespaces = true + +# CoffeeScript +# +# https://github.com/polarmobile/coffeescript-style-guide/blob/master/README.md +[*.{,lit}coffee] +indent_size = 2 +indent_style = space + +# Markdown +[*.{md,mdwn,mdown,markdown}] +indent_size = 4 +indent_style = space + +# Package.json +# +# This indentation style is the one used by npm. +[/package.json] +indent_size = 2 +indent_style = space + +# Jade +[*.jade] +indent_size = 2 +indent_style = space + +# JavaScript +# +# Two spaces seems to be the standard most common style, at least in +# Node.js (http://nodeguide.com/style.html#tabs-vs-spaces). +[*.js] +indent_size = 2 +indent_style = space + +# Less +[*.less] +indent_size = 2 +indent_style = space + +# Sass +# +# Style used for http://libsass.com +[*.s[ac]ss] +indent_size = 2 +indent_style = space + +# YAML +# +# Only spaces are allowed. +[*.yaml] +indent_size = 2 +indent_style = space diff --git a/packages/xo-server-auth-ldap/.gitignore b/packages/xo-server-auth-ldap/.gitignore new file mode 100644 index 000000000..a4a5666f8 --- /dev/null +++ b/packages/xo-server-auth-ldap/.gitignore @@ -0,0 +1,7 @@ +/bower_components/ +/dist/ + +npm-debug.log + +!node_modules/* +node_modules/*/ diff --git a/packages/xo-server-auth-ldap/.jshintrc b/packages/xo-server-auth-ldap/.jshintrc new file mode 100644 index 000000000..f920ae826 --- /dev/null +++ b/packages/xo-server-auth-ldap/.jshintrc @@ -0,0 +1,95 @@ +{ + // 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 +} diff --git a/packages/xo-server-auth-ldap/README.md b/packages/xo-server-auth-ldap/README.md new file mode 100644 index 000000000..45c37b665 --- /dev/null +++ b/packages/xo-server-auth-ldap/README.md @@ -0,0 +1,17 @@ +# xo-server-auth-ldap + +> XO-Server LDAP authentication plugin. + +To enable this plugin you have to add it into the configuration file +of XO-Server: + +```json +{ + "plugins": { + "auth-ldap": { + "uri": "ldap://ldap.example.org", + "base": "ou=people,dc=example,dc=org" + } + } +} +``` diff --git a/packages/xo-server-auth-ldap/index.js b/packages/xo-server-auth-ldap/index.js new file mode 100644 index 000000000..aeae9f277 --- /dev/null +++ b/packages/xo-server-auth-ldap/index.js @@ -0,0 +1,49 @@ +'use strict'; + +//==================================================================== + +var Bluebird = require('bluebird'); +var createClient = require('ldapjs').createClient; +var escape = require('ldapjs/lib/filters/escape'); + +//==================================================================== + +function AuthLdap(conf) { + var base = conf.base ? ',' + conf.base : ''; + + this._provider = function (credentials) { + return new Bluebird(function (resolve, reject) { + var client = createClient({ + url: conf.uri, + }); + + client.bind( + 'uid=' + escape(credentials.username) + base, + credentials.password, + function (error) { + if (error) { + reject(error); + } else { + resolve(); + } + + 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); +}; diff --git a/packages/xo-server-auth-ldap/index.spec.js b/packages/xo-server-auth-ldap/index.spec.js new file mode 100644 index 000000000..2bd761ed2 --- /dev/null +++ b/packages/xo-server-auth-ldap/index.spec.js @@ -0,0 +1,11 @@ +'use strict'; + +//==================================================================== + +var myLib = require('./'); + +var expect = require('must'); + +//==================================================================== + +describe('myLib'); diff --git a/packages/xo-server-auth-ldap/package.json b/packages/xo-server-auth-ldap/package.json new file mode 100644 index 000000000..e5816f708 --- /dev/null +++ b/packages/xo-server-auth-ldap/package.json @@ -0,0 +1,35 @@ +{ + "name": "xo-server-auth-ldap", + "version": "0.0.0", + "license": "ISC", + "description": "LDAP authentication plugin for XO-Server", + "keywords": [ + "xo-server", + "ldap" + ], + "homepage": "https://github.com/vatesfr/xo-server-auth-ldap", + "bugs": "https://github.com/vatesfr/xo-server-auth-ldap/issues", + "repository": { + "type": "git", + "url": "https://github.com/vatesfr/xo-server-auth-ldap" + }, + "author": { + "name": "Julien Fontanet", + "email": "julien.fontanet@isonoe.net" + }, + "preferGlobal": false, + "files": [ + "index.js" + ], + "devDependencies": { + "ldapjs": "^0.7.1", + "mocha": "*", + "must": "*" + }, + "scripts": { + "test": "mocha *.spec.js" + }, + "dependencies": { + "bluebird": "^2.9.14" + } +}