Skip to content

[7441] Consolidate broker credential generation #7642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
n-lark wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[7441] Consolidate broker credential generation #7642

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0da171d
Consolidate createClient into a helper fn
n-lark Jun 30, 2026
847a289
Merge branch 'main' into 7441-createClient
cstns Jul 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
201 changes: 70 additions & 131 deletions forge/db/controllers/BrokerClient.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
const { generateToken, compareHash } = require('../utils')

async function createClient (app, { username, ownerId, ownerType, prefix, where, usePublicUrl = true }) {
const existingClient = await app.db.models.BrokerClient.findOne({
where: where ?? { ownerId, ownerType }
})
if (existingClient) {
await existingClient.destroy()
}
const password = generateToken(32, prefix)
await app.db.models.BrokerClient.create({ username, password, ownerId, ownerType })
const url = usePublicUrl
? (app.config.broker.public_url || app.config.broker.url || null)
: (app.config.broker.url || null)
return { url, username, password }
}

module.exports = {
/**
* Validate the username/password
Expand Down Expand Up @@ -46,100 +61,51 @@ module.exports = {
*
*/
createClientForProject: async function (app, project) {
if (app.comms) {
const existingClient = await app.db.models.BrokerClient.findOne({
where: {
ownerId: project.id,
ownerType: 'project'
}
})
if (existingClient) {
await existingClient.destroy()
}
if (!project.Team) {
// When restarting the platform, the container drivers get a minimal list
// of projects to restart. They don't necessarily include the Team in their
// query - so we need to ensure its available.
await project.reload({
include: [{
model: app.db.models.Team,
attributes: ['hashid', 'id', 'name', 'slug', 'links']
}]
})
}
const username = `project:${project.Team.hashid}:${project.id}`
const password = generateToken(32, 'ffbp')
await app.db.models.BrokerClient.create({
username,
password,
ownerId: project.id,
ownerType: 'project'
if (!app.comms) {
return null
}
if (!project.Team) {
// When restarting the platform, the container drivers get a minimal list
// of projects to restart. They don't necessarily include the Team in their
// query - so we need to ensure its available.
await project.reload({
include: [{
model: app.db.models.Team,
attributes: ['hashid', 'id', 'name', 'slug', 'links']
}]
})
return {
url: app.config.broker.url || null,
username,
password
}
}
return null
return createClient(app, {
username: `project:${project.Team.hashid}:${project.id}`,
ownerId: project.id,
ownerType: 'project',
prefix: 'ffbp',
usePublicUrl: false
})
},

createClientForDevice: async function (app, device) {
if (app.comms) {
const existingClient = await app.db.models.BrokerClient.findOne({
where: {
ownerId: '' + device.id,
ownerType: 'device'
}
})
if (existingClient) {
await existingClient.destroy()
}
const username = `device:${device.Team.hashid}:${device.hashid}`
const password = generateToken(32, 'ffbd')
await app.db.models.BrokerClient.create({
username,
password,
ownerId: '' + device.id,
ownerType: 'device'
})
return {
// Devices should default to the public url if set
url: app.config.broker.public_url || app.config.broker.url || null,
username,
password
}
if (!app.comms) {
return null
}
return null
return createClient(app, {
username: `device:${device.Team.hashid}:${device.hashid}`,
ownerId: '' + device.id,
ownerType: 'device',
prefix: 'ffbd'
})
},

createClientForFrontend: async function (app, device) {
if (app.comms) {
const existingClient = await app.db.models.BrokerClient.findOne({
where: {
ownerId: '' + device.id,
ownerType: 'frontend'
}
})
if (existingClient) {
await existingClient.destroy()
}

const username = `frontend:${device.Team.hashid}:${device.hashid}`
const password = generateToken(32, 'ffbf')
await app.db.models.BrokerClient.create({
username,
password,
ownerId: '' + device.id,
ownerType: 'frontend'
})
return {
url: app.config.broker.public_url || app.config.broker.url || null,
username,
password
}
if (!app.comms) {
return null
}
return null
return createClient(app, {
username: `frontend:${device.Team.hashid}:${device.hashid}`,
ownerId: '' + device.id,
ownerType: 'frontend',
prefix: 'ffbf'
})
},

createClientForExpertAgent: async function (app) {
Expand Down Expand Up @@ -183,57 +149,30 @@ module.exports = {
},

createClientForTeamFrontend: async function (app, user, team, sessionId) {
if (app.comms) {
const username = `fe-team:${user.hashid}:${team.hashid}:${sessionId}`
const existingClient = await app.db.models.BrokerClient.findOne({
where: { username }
})
if (existingClient) {
await existingClient.destroy()
}
const password = generateToken(32, 'ffbtf')
await app.db.models.BrokerClient.create({
username,
password,
ownerId: '' + user.id,
ownerType: 'fe-team'
})
return {
url: app.config.broker.public_url || app.config.broker.url || null,
username,
password
}
if (!app.comms) {
return null
}
return null
const username = `fe-team:${user.hashid}:${team.hashid}:${sessionId}`
return createClient(app, {
where: { username },
username,
ownerId: '' + user.id,
ownerType: 'fe-team',
prefix: 'ffbtf'
})
},

createClientForExpertClient: async function (app, user, sessionId) {
if (app.comms) {
const existingClient = await app.db.models.BrokerClient.findOne({
where: {
ownerId: '' + user.id,
ownerType: 'expert-user',
username: `expert-client:${user.hashid}:${sessionId}`
}
})
if (existingClient) {
await existingClient.destroy()
}

const username = `expert-client:${user.hashid}:${sessionId}`
const password = generateToken(32, 'ffbec') // ff broker expert client
await app.db.models.BrokerClient.create({
username,
password,
ownerId: '' + user.id,
ownerType: 'expert-user'
})
return {
url: app.config.broker.public_url || app.config.broker.url || null,
username,
password
}
if (!app.comms) {
return null
}
return null
const username = `expert-client:${user.hashid}:${sessionId}`
return createClient(app, {
where: { ownerId: '' + user.id, ownerType: 'expert-user', username },
username,
ownerId: '' + user.id,
ownerType: 'expert-user',
prefix: 'ffbec'
})
}
}
Loading