Merge pull request #10039 from Budibase/fix/api-key-error
Improve invalid API key error messaging
This commit is contained in:
commit
02d4fc2d31
2 changed files with 31 additions and 11 deletions
|
@ -16,6 +16,7 @@ export abstract class BudibaseError extends Error {
|
||||||
export enum ErrorCode {
|
export enum ErrorCode {
|
||||||
USAGE_LIMIT_EXCEEDED = "usage_limit_exceeded",
|
USAGE_LIMIT_EXCEEDED = "usage_limit_exceeded",
|
||||||
FEATURE_DISABLED = "feature_disabled",
|
FEATURE_DISABLED = "feature_disabled",
|
||||||
|
INVALID_API_KEY = "invalid_api_key",
|
||||||
HTTP = "http",
|
HTTP = "http",
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -85,3 +86,14 @@ export class FeatureDisabledError extends HTTPError {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// AUTH
|
||||||
|
|
||||||
|
export class InvalidAPIKeyError extends BudibaseError {
|
||||||
|
constructor() {
|
||||||
|
super(
|
||||||
|
"Invalid API key - may need re-generated, or user doesn't exist",
|
||||||
|
ErrorCode.INVALID_API_KEY
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
|
@ -14,6 +14,7 @@ import { decrypt } from "../security/encryption"
|
||||||
import * as identity from "../context/identity"
|
import * as identity from "../context/identity"
|
||||||
import env from "../environment"
|
import env from "../environment"
|
||||||
import { Ctx, EndpointMatcher } from "@budibase/types"
|
import { Ctx, EndpointMatcher } from "@budibase/types"
|
||||||
|
import { InvalidAPIKeyError, ErrorCode } from "../errors"
|
||||||
|
|
||||||
const ONE_MINUTE = env.SESSION_UPDATE_PERIOD
|
const ONE_MINUTE = env.SESSION_UPDATE_PERIOD
|
||||||
? parseInt(env.SESSION_UPDATE_PERIOD)
|
? parseInt(env.SESSION_UPDATE_PERIOD)
|
||||||
|
@ -48,22 +49,27 @@ async function checkApiKey(apiKey: string, populateUser?: Function) {
|
||||||
const decrypted = decrypt(apiKey)
|
const decrypted = decrypt(apiKey)
|
||||||
const tenantId = decrypted.split(SEPARATOR)[0]
|
const tenantId = decrypted.split(SEPARATOR)[0]
|
||||||
return doInTenant(tenantId, async () => {
|
return doInTenant(tenantId, async () => {
|
||||||
const db = getGlobalDB()
|
let userId
|
||||||
// api key is encrypted in the database
|
try {
|
||||||
const userId = (await queryGlobalView(
|
const db = getGlobalDB()
|
||||||
ViewName.BY_API_KEY,
|
// api key is encrypted in the database
|
||||||
{
|
userId = (await queryGlobalView(
|
||||||
key: apiKey,
|
ViewName.BY_API_KEY,
|
||||||
},
|
{
|
||||||
db
|
key: apiKey,
|
||||||
)) as string
|
},
|
||||||
|
db
|
||||||
|
)) as string
|
||||||
|
} catch (err) {
|
||||||
|
userId = undefined
|
||||||
|
}
|
||||||
if (userId) {
|
if (userId) {
|
||||||
return {
|
return {
|
||||||
valid: true,
|
valid: true,
|
||||||
user: await getUser(userId, tenantId, populateUser),
|
user: await getUser(userId, tenantId, populateUser),
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
throw "Invalid API key"
|
throw new InvalidAPIKeyError()
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
@ -164,8 +170,10 @@ export default function (
|
||||||
console.error(`Auth Error: ${err.message}`)
|
console.error(`Auth Error: ${err.message}`)
|
||||||
console.error(err)
|
console.error(err)
|
||||||
// invalid token, clear the cookie
|
// invalid token, clear the cookie
|
||||||
if (err && err.name === "JsonWebTokenError") {
|
if (err?.name === "JsonWebTokenError") {
|
||||||
clearCookie(ctx, Cookie.Auth)
|
clearCookie(ctx, Cookie.Auth)
|
||||||
|
} else if (err?.code === ErrorCode.INVALID_API_KEY) {
|
||||||
|
ctx.throw(403, err.message)
|
||||||
}
|
}
|
||||||
// allow configuring for public access
|
// allow configuring for public access
|
||||||
if ((opts && opts.publicAllowed) || publicEndpoint) {
|
if ((opts && opts.publicAllowed) || publicEndpoint) {
|
||||||
|
|
Loading…
Reference in a new issue