@pgaubatz/npm-registry-couchapp/registry/_auth.js

The CouchApp implementation of an npm registry

// sync to $host/_users/_design/_auth

var isArray = Array.isArray
var ddoc = {_id:"_design/scratch", language:"javascript"}

module.exports = ddoc

ddoc.lists = {
  index: function (head,req) {
    var row
      , out = {}
      , id, data
    while (row = getRow()) {
      id = row.id.replace(/^org\.couchdb\.user:/, '')
      data = row.value
      delete data._id
      delete data._rev
      delete data.salt
      delete data.password_sha
      delete data.type
      delete data.roles
      delete data._deleted_conflicts
      out[id] = data
    }
    send(toJSON(out))
  },
  email:function (head, req) {
    var row
      , data
      , id
      , email = req.query.email || undefined
      , out = []
    while (row = getRow()) {
      id = row.id.replace(/^org\.couchdb\.user:/, '')
      data = row.value
      var dm = data.email || undefined
      if (data.email !== email) continue
      out.push(row.value.name)
    }
    send(toJSON(out))
  }

}


ddoc.validate_doc_update = function (newDoc, oldDoc, userCtx, secObj) {
  if (newDoc._deleted === true) {
    // allow deletes by admins
    if (userCtx && (userCtx.roles.indexOf('_admin') !== -1)) {
      return;
    } else {
      throw({forbidden: 'Only admins may delete user docs.'});
    }
  }

  if ((oldDoc && oldDoc.type !== 'user') || newDoc.type !== 'user') {
    throw({forbidden : 'doc.type must be user'});
  } // we only allow user docs for now

  if (!newDoc.name) {
    throw({forbidden: 'doc.name is required'});
  }

  if (newDoc.roles && !isArray(newDoc.roles)) {
    throw({forbidden: 'doc.roles must be an array'});
  }

  if (newDoc._id !== ('org.couchdb.user:' + newDoc.name)) {
    throw({
      forbidden: 'Doc ID must be of the form org.couchdb.user:name'
    });
  }

  if (newDoc.name !== newDoc.name.toLowerCase()) {
    throw({
      forbidden: 'Name must be lower-case'
    })
  }

  if (newDoc.name !== encodeURIComponent(newDoc.name)) {
    throw({
      forbidden: 'Name cannot contain non-url-safe characters'
    })
  }

  if (newDoc.name.charAt(0) === '.') {
    throw({
      forbidden: 'Name cannot start with .'
    })
  }

  if (!(newDoc.email && newDoc.email.match(/^.+@.+\..+$/))) {
    throw({forbidden: 'Email must be an email address'})
  }

  if (oldDoc) { // validate all updates
    if (oldDoc.name !== newDoc.name) {
      throw({forbidden: 'Usernames can not be changed.'});
    }
  }

  if (newDoc.password_sha && !newDoc.salt) {
    throw({
      forbidden: 'Users with password_sha must have a salt.'
    });
  }

  var is_server_or_database_admin = function(userCtx, secObj) {
    // see if the user is a server admin
    if(userCtx && userCtx.roles.indexOf('_admin') !== -1) {
      return true; // a server admin
    }

    // see if the user a database admin specified by name
    if(secObj && secObj.admins && secObj.admins.names) {
      if(secObj.admins.names.indexOf(userCtx.name) !== -1) {
        return true; // database admin
      }
    }

    // see if the user a database admin specified by role
    if(secObj && secObj.admins && secObj.admins.roles) {
      var db_roles = secObj.admins.roles;
      for(var idx = 0; idx < userCtx.roles.length; idx++) {
        var user_role = userCtx.roles[idx];
        if(db_roles.indexOf(user_role) !== -1) {
          return true; // role matches!
        }
      }
    }

    return false; // default to no admin
  }

  if (newDoc.name.length > 50) {
    throw({
      forbidden: 'Username is too long.  Pick a shorter one.'
    })
  }

  if (!is_server_or_database_admin(userCtx, secObj)) {
    if (oldDoc) { // validate non-admin updates
      if (userCtx.name !== newDoc.name) {
        throw({
          forbidden: 'You may only update your own user document.'
        });
      }
      if (oldDoc.email !== newDoc.email) {
        throw({
          forbidden: 'You may not change your email address\n' +
            'Please visit https://npmjs.org/email-edit to do so.'
        })
      }
      // validate role updates
      var oldRoles = oldDoc.roles.sort();
      var newRoles = newDoc.roles.sort();

      if (oldRoles.length !== newRoles.length) {
        throw({forbidden: 'Only _admin may edit roles'});
      }

      for (var i = 0; i < oldRoles.length; i++) {
        if (oldRoles[i] !== newRoles[i]) {
          throw({forbidden: 'Only _admin may edit roles'});
        }
      }
    } else if (newDoc.roles.length > 0) {
      throw({forbidden: 'Only _admin may set roles'});
    }
  }

  // no system roles in users db
  for (var i = 0; i < newDoc.roles.length; i++) {
    if (newDoc.roles[i][0] === '_') {
      throw({
        forbidden: 'No system roles (starting with underscore) in users db.'
      });
    }
  }

  // no system names as names
  if (newDoc.name[0] === '_') {
    throw({forbidden: 'Username may not start with underscore.'});
  }

  var badUserNameChars = [':'];

  for (var i = 0; i < badUserNameChars.length; i++) {
    if (newDoc.name.indexOf(badUserNameChars[i]) >= 0) {
      throw({forbidden: 'Character `' + badUserNameChars[i] +
          '` is not allowed in usernames.'});
    }
  }

  if (newDoc.password)
    throw {forbidden: 'Plain-text passwords may not be stored in the db'}

  if (newDoc.password_scheme === 'pbkdf2') {
    if (newDoc.password_sha)
      throw {forbidden: 'may not mix password_sha and pbkdf2\n' +
                        'You may need to upgrade your version of npm:\n' +
                        '  npm install npm -g\n' +
                        'Note that this may need to be run as root/admin (sudo, etc.)\n\n' }
    if (!newDoc.derived_key)
      throw {forbidden: 'missing pbkdf2 derived_key'}
    if (typeof newDoc.derived_key !== 'string')
      throw {forbidden: 'pbkdf2 derived_key must be a string'}
    if (!newDoc.derived_key.match(/^[a-f0-9]{40}$/))
      throw {forbidden: 'pbkdf2 derived_key must be 20 hex bytes'}
    if (!newDoc.salt)
      throw {forbidden: 'missing pbkdf2 salt'}
    if (typeof newDoc.iterations !== 'number')
      throw {forbidden: 'doc.iterations must be a number'}
    if (newDoc.iterations < 10)
      throw {forbidden: 'not enough pbkdf2 iterations'}
    if (newDoc.iterations > 100)
      throw {forbidden: 'too many pbkdf2 iterations'}
  } else {
    if (!newDoc.salt)
      throw {forbidden: 'missing salt'}
    if (!newDoc.password_sha)
      throw {forbidden: 'missing password_sha'}
  }
}

ddoc.views = {
  listAll: {
    map: function (doc) {
      return emit(doc._id, doc)
    }
  },

  userByEmail: {
    map: function (doc) {
      if (doc.email || doc.name) {
        emit([ doc.email, doc.name ], 1)
      }
    },
    reduce: "_sum"
  },

  invalidUser: {
    map: function (doc) {
      var errors = []
      if (doc.type !== 'user') {
        errors.push('doc.type must be user')
      }

      if (!doc.name) {
        errors.push('doc.name is required')
      }

      if (doc.roles && !isArray(doc.roles)) {
        errors.push('doc.roles must be an array')
      }

      if (doc._id !== ('org.couchdb.user:' + doc.name)) {
        errors.push('Doc ID must be of the form org.couchdb.user:name')
      }

      if (doc.name !== doc.name.toLowerCase()) {
        errors.push('Name must be lower-case')
      }

      if (doc.name !== encodeURIComponent(doc.name)) {
        errors.push('Name cannot contain non-url-safe characters')
      }

      if (doc.name.charAt(0) === '.') {
        errors.push('Name cannot start with .')
      }

      if (!(doc.email && doc.email.match(/^.+@.+\..+$/))) {
        errors.push('Email must be an email address')
      }

      if (doc.password_sha && !doc.salt) {
        errors.push('Users with password_sha must have a salt.')
      }
      if (!errors.length) return
      emit([doc.name, doc.email], errors)
    }
  },

  invalid: {
    map: function (doc) {
      if (doc.type !== 'user') {
        return emit(['doc.type must be user', doc.email, doc.name], 1)
      }

      if (!doc.name) {
        return emit(['doc.name is required', doc.email, doc.name], 1)
      }

      if (doc.roles && !isArray(doc.roles)) {
        return emit(['doc.roles must be an array', doc.email, doc.name], 1)
      }

      if (doc._id !== ('org.couchdb.user:' + doc.name)) {
        return emit(['Doc ID must be of the form org.couchdb.user:name', doc.email, doc.name], 1)
      }

      if (doc.name !== doc.name.toLowerCase()) {
        return emit(['Name must be lower-case', doc.email, doc.name], 1)
      }

      if (doc.name !== encodeURIComponent(doc.name)) {
        return emit(['Name cannot contain non-url-safe characters', doc.email, doc.name], 1)
      }

      if (doc.name.charAt(0) === '.') {
        return emit(['Name cannot start with .', doc.email, doc.name], 1)
      }

      if (!(doc.email && doc.email.match(/^.+@.+\..+$/))) {
        return emit(['Email must be an email address', doc.email, doc.name], 1)
      }

      if (doc.password_sha && !doc.salt) {
        return emit(['Users with password_sha must have a salt.', doc.email, doc.name], 1)
      }
    },
    reduce: '_sum'
  },

  pbkdfsha: {
    map: function(doc) {
      if (doc.password_sha && doc.derived_key) {
        emit([doc._id, doc], 1)
      }
    },
    reduce: "_sum"
  },

  string_iterations: {
    map: function(doc) {
      if (typeof doc.iterations === 'string') {
        emit([doc._id, doc], 1)
      }
    },
    reduce: "_sum"
  },

  conflicts: {
    map: function (doc) {
      if (doc._conflicts) {
        for (var i = 0; i < doc._conflicts.length; i++) {
          emit([doc._id, doc._conflicts[i]], 1)
        }
      }
    },
    reduce: "_sum"
  }
}

ddoc.updates = {
  email: function (doc, req) {
    if (req.method !== "POST")
      return [ { _id: ".error.", forbidden: "Method not allowed" },
               { error: "method not allowed" } ]

    var data = JSON.parse(req.body)

    doc.email = data.email

    return [doc, JSON.stringify({ok: "updated email address"})]
  },

  profile: function (doc, req) {
    if (req.method !== "POST")
      return [ { _id: ".error.", forbidden: "Method not allowed" },
               { error: "method not allowed" } ]

    var WHITELISTED = [ 'appdotnet', 'avatar', 'avatarMedium', 'avatarLarge',
                      'date', 'email', 'fields', 'freenode', 'fullname',
                      'github', 'homepage', 'name', 'roles', 'twitter', 'type' ]

    var data = JSON.parse(req.body)

    for (var i in data) {
      if (WHITELISTED.indexOf(i) !== -1) {
        doc[i] = data[i]
      }
    }

    return [doc, JSON.stringify({ok: "updated profile"})]
  }
}

if (require.main === module)
  console.log(JSON.stringify(ddoc, function (k, v) {
    if (typeof v !== 'function') return v;
    return v.toString()
  }))
else if (process.env.DEPLOY_VERSION)
  ddoc.deploy_version = process.env.DEPLOY_VERSION
else
  throw new Error('Must set DEPLOY_VERSION env to `git describe` output')