MirrorSave
/
budibase
mirror of https://github.com/Budibase/budibase.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1391 from Budibase/group-admin-apis 

Group admin apis
This commit is contained in:
Martin McKeaveney 2021-04-20 13:59:21 +01:00 committed by GitHub
parent 954a46278a b5e19e4216
commit 3b4c25326b
13 changed files with 245 additions and 93 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
packages/auth/package.json
View File

@ -12,6 +12,7 @@
"passport-google-auth": "^1.0.2",
"passport-google-oauth": "^2.0.0",
"passport-jwt": "^4.0.0",
"passport-local": "^1.0.0"
"passport-local": "^1.0.0",
"uuid": "^8.3.2"
}
}

7
packages/auth/src/constants.js
View File

@ -7,3 +7,10 @@ exports.Cookies = {
CurrentApp: "budibase:currentapp",
Auth: "budibase:auth",
}
exports.GlobalRoles = {
OWNER: "owner",
ADMIN: "admin",
BUILDER: "builder",
GROUP_MANAGER: "group_manager",
}

24
packages/auth/src/db/utils.js
View File

@ -1,3 +1,5 @@
const { newid } = require("../hashing")
exports.StaticDatabases = {
GLOBAL: {
name: "global-db",
@ -7,6 +9,7 @@ exports.StaticDatabases = {
const DocumentTypes = {
USER: "us",
APP: "app",
GROUP: "group",
}
exports.DocumentTypes = DocumentTypes
@ -30,7 +33,26 @@ exports.getEmailFromUserID = userId => {
}
/**
* Gets parameters for retrieving users, this is a utility function for the getDocParams function.
* Generates a new group ID.
* @returns {string} The new group ID which the group doc can be stored under.
*/
exports.generateGroupID = () => {
return `${DocumentTypes.GROUP}${SEPARATOR}${newid()}`
}
/**
* Gets parameters for retrieving groups.
*/
exports.getGroupParams = (id = "", otherProps = {}) => {
return {
...otherProps,
startkey: `${DocumentTypes.GROUP}${SEPARATOR}${id}`,
endkey: `${DocumentTypes.GROUP}${SEPARATOR}${id}${UNICODE_MAX}`,
}
}
/**
* Gets parameters for retrieving users.
*/
exports.getUserParams = (email = "", otherProps = {}) => {
if (!email) {

5
packages/auth/src/hashing.js
View File

@ -1,5 +1,6 @@
const bcrypt = require("bcryptjs")
const env = require("./environment")
const { v4 } = require("uuid")
const SALT_ROUNDS = env.SALT_ROUNDS || 10
@ -11,3 +12,7 @@ exports.hash = async data => {
exports.compare = async (data, encrypted) => {
return bcrypt.compare(data, encrypted)
}
exports.newid = function() {
return v4().replace(/-/g, "")
}

4
packages/auth/src/index.js
View File

@ -17,6 +17,8 @@ const {
const {
generateUserID,
getUserParams,
generateGroupID,
getGroupParams,
getEmailFromUserID,
} = require("./db/utils")
@ -49,6 +51,8 @@ module.exports = {
StaticDatabases,
generateUserID,
getUserParams,
generateGroupID,
getGroupParams,
getEmailFromUserID,
hash,
compare,

5
packages/auth/yarn.lock
View File

@ -584,6 +584,11 @@ uuid@^3.3.2:
resolved "https://registry.yarnpkg.com/uuid/-/uuid-3.4.0.tgz#b23e4358afa8a202fe7a100af1f5f883f02007ee"
integrity sha512-HjSDRw6gZE5JMggctHBcjVak08+KEVhSIiDzFnT9S9aegmp85S/bReBVTb4QTFaRNptJ9kuYaNhnbNEOkbKb/A==
uuid@^8.3.2:
version "8.3.2"
resolved "https://registry.yarnpkg.com/uuid/-/uuid-8.3.2.tgz#80d5b5ced271bb9af6c445f21a1a04c606cefbe2"
integrity sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==
verror@1.10.0:
version "1.10.0"
resolved "https://registry.yarnpkg.com/verror/-/verror-1.10.0.tgz#3a105ca17053af55d6e270c1f8288682e18da400"

58
packages/worker/src/api/controllers/admin/groups.js Normal file
View File

@ -0,0 +1,58 @@
const CouchDB = require("../../../db")
const { getGroupParams, StaticDatabases } = require("@budibase/auth")
const { generateGroupID } = require("@budibase/auth")
const GLOBAL_DB = StaticDatabases.GLOBAL.name
exports.save = async function(ctx) {
const db = new CouchDB(GLOBAL_DB)
const groupDoc = ctx.request.body
// Group does not exist yet
if (!groupDoc._id) {
groupDoc._id = generateGroupID()
}
try {
const response = await db.post(groupDoc)
ctx.body = {
_id: response.id,
_rev: response.rev,
}
} catch (err) {
ctx.throw(err.status, err)
}
}
exports.fetch = async function(ctx) {
const db = new CouchDB(GLOBAL_DB)
const response = await db.allDocs(
getGroupParams(undefined, {
include_docs: true,
})
)
const groups = response.rows.map(row => row.doc)
ctx.body = groups
}
exports.find = async function(ctx) {
const db = new CouchDB(GLOBAL_DB)
try {
const record = await db.get(ctx.params.id)
ctx.body = record
} catch (err) {
ctx.throw(err.status, err)
}
}
exports.destroy = async function(ctx) {
const db = new CouchDB(GLOBAL_DB)
const { id, rev } = ctx.params
try {
await db.remove(id, rev)
ctx.body = { message: "Group deleted successfully" }
} catch (err) {
ctx.throw(err.status, err)
}
}

93
packages/worker/src/api/controllers/admin/index.js
View File

@ -1,90 +1,7 @@
const CouchDB = require("../../../db")
const {
hash,
generateUserID,
getUserParams,
StaticDatabases,
} = require("@budibase/auth")
const { UserStatus } = require("../../../constants")
const users = require("./users")
const groups = require("./groups")
const GLOBAL_DB = StaticDatabases.GLOBAL.name
exports.userSave = async ctx => {
const db = new CouchDB(GLOBAL_DB)
const { email, password, _id } = ctx.request.body
const hashedPassword = password ? await hash(password) : null
let user = {
...ctx.request.body,
_id: generateUserID(email),
password: hashedPassword,
}
let dbUser
// in-case user existed already
if (_id) {
dbUser = await db.get(_id)
}
// add the active status to a user if its not provided
if (user.status == null) {
user.status = UserStatus.ACTIVE
}
try {
const response = await db.post({
password: hashedPassword || dbUser.password,
...user,
})
ctx.body = {
_id: response.id,
_rev: response.rev,
email,
}
} catch (err) {
if (err.status === 409) {
ctx.throw(400, "User exists already")
} else {
ctx.throw(err.status, err)
}
}
}
exports.userDelete = async ctx => {
const db = new CouchDB(GLOBAL_DB)
const dbUser = await db.get(generateUserID(ctx.params.email))
await db.remove(dbUser._id, dbUser._rev)
ctx.body = {
message: `User ${ctx.params.email} deleted.`,
}
}
// called internally by app server user fetch
exports.userFetch = async ctx => {
const db = new CouchDB(GLOBAL_DB)
const response = await db.allDocs(
getUserParams(null, {
include_docs: true,
})
)
const users = response.rows.map(row => row.doc)
// user hashed password shouldn't ever be returned
for (let user of users) {
if (user) {
delete user.password
}
}
ctx.body = users
}
// called internally by app server user find
exports.userFind = async ctx => {
const db = new CouchDB(GLOBAL_DB)
let user
try {
user = await db.get(generateUserID(ctx.params.email))
} catch (err) {
// no user found, just return nothing
user = {}
}
if (user) {
delete user.password
}
ctx.body = user
module.exports = {
users,
groups,
}

90
packages/worker/src/api/controllers/admin/users.js Normal file
View File

@ -0,0 +1,90 @@
const CouchDB = require("../../../db")
const {
hash,
generateUserID,
getUserParams,
StaticDatabases,
} = require("@budibase/auth")
const { UserStatus } = require("../../../constants")
const GLOBAL_DB = StaticDatabases.GLOBAL.name
exports.userSave = async ctx => {
const db = new CouchDB(GLOBAL_DB)
const { email, password, _id } = ctx.request.body
const hashedPassword = password ? await hash(password) : null
let user = {
...ctx.request.body,
_id: generateUserID(email),
password: hashedPassword,
}
let dbUser
// in-case user existed already
if (_id) {
dbUser = await db.get(_id)
}
// add the active status to a user if its not provided
if (user.status == null) {
user.status = UserStatus.ACTIVE
}
try {
const response = await db.post({
password: hashedPassword || dbUser.password,
...user,
})
ctx.body = {
_id: response.id,
_rev: response.rev,
email,
}
} catch (err) {
if (err.status === 409) {
ctx.throw(400, "User exists already")
} else {
ctx.throw(err.status, err)
}
}
}
exports.userDelete = async ctx => {
const db = new CouchDB(GLOBAL_DB)
const dbUser = await db.get(generateUserID(ctx.params.email))
await db.remove(dbUser._id, dbUser._rev)
ctx.body = {
message: `User ${ctx.params.email} deleted.`,
}
}
// called internally by app server user fetch
exports.userFetch = async ctx => {
const db = new CouchDB(GLOBAL_DB)
const response = await db.allDocs(
getUserParams(null, {
include_docs: true,
})
)
const users = response.rows.map(row => row.doc)
// user hashed password shouldn't ever be returned
for (let user of users) {
if (user) {
delete user.password
}
}
ctx.body = users
}
// called internally by app server user find
exports.userFind = async ctx => {
const db = new CouchDB(GLOBAL_DB)
let user
try {
user = await db.get(generateUserID(ctx.params.email))
} catch (err) {
// no user found, just return nothing
user = {}
}
if (user) {
delete user.password
}
ctx.body = user
}

38
packages/worker/src/api/routes/admin/groups.js Normal file
View File

@ -0,0 +1,38 @@
const Router = require("@koa/router")
const controller = require("../../controllers/admin/groups")
const joiValidator = require("../../../middleware/joi-validator")
const { authenticated } = require("@budibase/auth")
const Joi = require("joi")
const router = Router()
function buildGroupSaveValidation() {
// prettier-ignore
return joiValidator.body(Joi.object({
_id: Joi.string().optional(),
_rev: Joi.string().optional(),
name: Joi.string().required(),
users: Joi.array().required(),
managers: Joi.array().required(),
roles: Joi.object({
default: Joi.string().optional(),
app: Joi.object()
.pattern(/.*/, Joi.string())
.required()
.unknown(true),
}).unknown(true).optional(),
}).required().unknown(true))
}
router
.post(
"/api/admin/groups",
buildGroupSaveValidation(),
authenticated,
controller.save
)
.delete("/api/admin/groups/:id", authenticated, controller.destroy)
.get("/api/admin/groups", authenticated, controller.fetch)
.get("/api/admin/groups/:id", authenticated, controller.find)
module.exports = router

2
packages/worker/src/api/routes/admin/index.js → packages/worker/src/api/routes/admin/users.js
View File

@ -1,5 +1,5 @@
const Router = require("@koa/router")
const controller = require("../../controllers/admin")
const controller = require("../../controllers/admin/users")
const joiValidator = require("../../../middleware/joi-validator")
const { authenticated } = require("@budibase/auth")
const Joi = require("joi")

5
packages/worker/src/api/routes/index.js
View File

@ -1,5 +1,6 @@
const adminRoutes = require("./admin")
const userRoutes = require("./admin/users")
const groupRoutes = require("./admin/groups")
const authRoutes = require("./auth")
const appRoutes = require("./app")
exports.routes = [adminRoutes, authRoutes, appRoutes]
exports.routes = [userRoutes, groupRoutes, authRoutes, appRoutes]

4
packages/worker/src/constants/index.js
View File

@ -2,3 +2,7 @@ exports.UserStatus = {
ACTIVE: "active",
INACTIVE: "inactive",
}
exports.Groups = {
ALL_USERS: "all_users",
}