Files
planka/server/api/helpers/utils/resolve-access-token.js
T
Daniel Hiller de4d768831 fix: close the gaps a security review found in the default install
Reported against 2.2.1 by someone reading the source. Every finding held.

**Sign-in had no ceiling.** Failures were logged with the caller's address
and nothing more. Two counters now — one per address, one per account —
because the two attacks look different: one source working through many
accounts is caught by the first, many sources working on one account by the
second, and behind a proxy only the second still means anything.

The count is kept in the process that serves the request. PLANKA needs no
Redis and the stock deployment is one container; run several and each keeps
its own count, which multiplies the ceiling by their number. That trade is
written where the limits are configured.

**The second factor could be guessed at leisure.** Six digits, and a
pending token that stayed valid for its full ten minutes however many codes
were wrong. Wrong codes are now counted on the session row — in the
database, so the count survives a restart and holds across every process —
and when the budget is spent the session is destroyed. After that even the
right code is refused and the login starts over from the password.

**Avatars, background images and favicons** checked the token's signature
and nothing else, so a revoked session, a deactivated account or a changed
password all kept working there for as long as the signature lasted, which
is a year by default. The five checks the API makes now live in one helper
that both use, rather than the shortened copy that had drifted from it.

**A link attachment's favicon** was fetched from wherever the URL pointed.
Storing a link is harmless — it is a string the user typed — but fetching
its icon is a request the server makes to an address the user chose, and
whether an icon came back reported on what is reachable from inside the
network. Server-side fetches now refuse private, loopback and link-local
addresses, `169.254.169.254` among them. The attachment is still created:
linking to an internal wiki is a legitimate thing to do, and it was the
server's own request that had to stop.

**The signing key.** Our own compose file ships `notsecretkey`, and it is
printed in the documentation — so on any instance that copied it, anyone can
sign a token for any account. PLANKA now says so on every start, and keeps
saying it, along with a key that is missing or shorter than 32 characters.
The placeholder carries the warning inline, where it is copied from.

**The backup script** wrote password hashes, live sessions, TOTP secrets and
SMTP credentials to an unencrypted archive. `BACKUP_PASSPHRASE` now encrypts
it, and without one the script says what it just put on disk. It also says
what it is — an example for the stock compose stack, not a backup concept —
and names the window between the database dump and the file copy, which no
ordering closes.
2026-08-28 20:55:54 +02:00

70 lines
1.9 KiB
JavaScript

/*!
* Copyright (c) 2026 PLANKA Software GmbH
* Licensed under the Fair Use License: https://github.com/plankanban/planka/blob/master/LICENSE.md
*/
// Everything that has to be true before an access token means anything, in one
// place. A valid signature is the first of five, not the whole answer: a token
// keeps its signature after the session behind it was revoked, after the
// account was deactivated, and after the password was changed — and the default
// lifetime is a year.
//
// It lives here rather than inside the `current-user` hook because the routes
// that serve avatars, background images and favicons need the same answer, and
// when they had their own shortened version of it they let revoked tokens
// through for as long as the signature lasted.
//
// Returns null whenever the token should not be honoured, so a caller cannot
// mistake "no session" for a session.
module.exports = {
inputs: {
accessToken: {
type: 'string',
required: true,
},
// The paired cookie value, where the session was issued with one. A session
// that carries an httpOnlyToken is only valid alongside its cookie.
httpOnlyToken: {
type: 'string',
allowNull: true,
},
},
async fn(inputs) {
let payload;
try {
payload = sails.helpers.utils.verifyJwtToken(inputs.accessToken);
} catch (error) {
return null;
}
const session = await Session.qm.getOneUndeletedByAccessToken(inputs.accessToken);
if (!session) {
return null;
}
if (session.httpOnlyToken && inputs.httpOnlyToken !== session.httpOnlyToken) {
return null;
}
const user = await User.qm.getOneById(payload.subject, {
withDeactivated: false,
});
if (!user) {
return null;
}
if (user.passwordChangedAt > payload.issuedAt) {
return null;
}
return {
session,
user,
};
},
};