Skip to content
This repository has been archived by the owner on Jun 8, 2023. It is now read-only.

Commit

Permalink
Authorization in Hubot
Browse files Browse the repository at this point in the history
- Allow roles to be assigned by admins
- admins defined by HUBOT_AUTH_ADMIN environment variable
- Enable scripts to verify a user's roles
- Solves the problem of random users running potentially dangerous Hubot commands
  • Loading branch information
aw committed May 9, 2012
1 parent 7b41b17 commit 9b85835
Showing 1 changed file with 79 additions and 0 deletions.
79 changes: 79 additions & 0 deletions src/scripts/auth.coffee
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Auth allows you to assign roles to users which can be used by other scripts to restrict access to Hubot commands
#
# Environment variables:
# HUBOT_AUTH_ADMIN - the user(s) who can assign roles to other users, comma-separated
#
# Use in your script
# - Call the method: robot.Auth.hasRole('<user>','<role>')
# - returns bool true or false
#
# Notes:
# - the 'admin' role can only be assigned through the environment variable
# - roles are all transformed to lower case
#
# <user> has <role> role - Assigns a role to a user
# <user> doesn't have <role> role - Removes a role from a user
# what role does <user> have - Find out what roles are assigned to a specific user
# who has admin role - Find out who's an admin and can assign roles

# hubot alex has role op


module.exports = (robot) ->
admin = process.env.HUBOT_AUTH_ADMIN

class Auth
hasRole: (name, role) ->
user = robot.userForName(name)
if user? and user.roles?
if role in user.roles then return true

return false

robot.Auth = new Auth

robot.respond /@?([\w .-_]+) (has) (["'\w: -_]+) (role)/i, (msg) ->
name = msg.match[1].trim()
newRole = msg.match[3].trim().toLowerCase()

unless name.toLowerCase() in ['', 'who', 'what', 'where', 'when', 'why']
user = robot.userForName(name)
user.roles = user.roles or [ ]

if newRole in user.roles
msg.reply "#{name} already has the '#{newRole}' role."
else
if newRole == 'admin'
msg.reply "Sorry, the 'admin' role can only be defined in the HUBOT_AUTH_ADMIN env variable."
else
myRoles = msg.message.user.roles or [ ]
if msg.message.user.name.toLowerCase() in admin.toLowerCase().split(',')
user.roles.push(newRole)
msg.reply "Ok, #{name} has the '#{newRole}' role."

robot.respond /@?([\w .-_]+) (doesn't have|does not have) (["'\w: -_]+) (role)/i, (msg) ->
name = msg.match[1].trim()
newRole = msg.match[3].trim().toLowerCase()

unless name.toLowerCase() in ['', 'who', 'what', 'where', 'when', 'why']
user = robot.userForName(name)
user.roles = user.roles or [ ]
if newRole == 'admin'
msg.reply "Sorry, the 'admin' role can only be removed from the HUBOT_AUTH_ADMIN env variable."
else
myRoles = msg.message.user.roles or [ ]
if msg.message.user.name.toLowerCase() in admin.toLowerCase().split(',')
user.roles = (role for role in user.roles when role isnt newRole)
msg.reply "Ok, #{name} doesn't have the '#{newRole}' role."

robot.respond /(what role does|what roles does) @?([\w .-]+) (have)\?*$/i, (msg) ->
name = msg.match[2].trim()

user = robot.userForName(name)
user.roles = user.roles or [ ]

if name.toLowerCase() in admin.toLowerCase().split(',') then isAdmin = ' and is also an admin' else isAdmin = ''
msg.reply "#{name} has the following roles: " + user.roles + isAdmin + "."

robot.respond /who has admin role\?*$/i, (msg) ->
msg.reply "The following people have the 'admin' role: #{admin.split(',')}"

0 comments on commit 9b85835

Please sign in to comment.