mirror of
https://github.com/outline/outline.git
synced 2026-11-20 21:23:06 +03:00
* fix: Validate API key scopes with Sequelize-level validators * test: Add API regression tests for duplicate OAuth redirect URIs * fix: Preserve wildcard scope and guard non-string redirect URIs --------- Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
128 lines
3.2 KiB
TypeScript
128 lines
3.2 KiB
TypeScript
import type { InferAttributes, InferCreationAttributes } from "sequelize";
|
|
import {
|
|
Column,
|
|
DataType,
|
|
BelongsTo,
|
|
ForeignKey,
|
|
Table,
|
|
Length,
|
|
} from "sequelize-typescript";
|
|
import { OAuthClientValidation } from "@shared/validations";
|
|
import env from "@server/env";
|
|
import User from "@server/models/User";
|
|
import IdModel from "@server/models/base/IdModel";
|
|
import { SkipChangeset } from "@server/models/decorators/Changeset";
|
|
import IsScope from "@server/models/validators/IsScope";
|
|
import { hash } from "@server/utils/crypto";
|
|
import OAuthClient from "./OAuthClient";
|
|
|
|
@Table({
|
|
tableName: "oauth_authorization_codes",
|
|
modelName: "oauth_authorization_code",
|
|
updatedAt: false,
|
|
})
|
|
class OAuthAuthorizationCode extends IdModel<
|
|
InferAttributes<OAuthAuthorizationCode>,
|
|
Partial<InferCreationAttributes<OAuthAuthorizationCode>>
|
|
> {
|
|
static eventNamespace = "oauthAuthorizationCodes";
|
|
|
|
/** The lifetime of an authorization code in seconds. */
|
|
public static authorizationCodeLifetime =
|
|
env.OAUTH_PROVIDER_AUTHORIZATION_CODE_LIFETIME;
|
|
|
|
/** A recognizable prefix for authorization codes. */
|
|
public static authorizationCodePrefix = "ol_ac_";
|
|
|
|
@Column(DataType.STRING)
|
|
@SkipChangeset
|
|
authorizationCodeHash: string;
|
|
|
|
@Column(DataType.STRING)
|
|
@SkipChangeset
|
|
codeChallenge?: string;
|
|
|
|
@Column(DataType.STRING)
|
|
@SkipChangeset
|
|
codeChallengeMethod?: string;
|
|
|
|
/**
|
|
* The ID of the grant that this authorization code belongs to. Used for
|
|
* refresh token rotation and revocation of all tokens in a grant.
|
|
*/
|
|
@Column(DataType.UUID)
|
|
@SkipChangeset
|
|
grantId: string | null;
|
|
|
|
/** A list of scopes that this authorization code has access to */
|
|
@IsScope
|
|
@Column(DataType.ARRAY(DataType.STRING))
|
|
scope: string[];
|
|
|
|
@Length({ max: OAuthClientValidation.maxRedirectUriLength })
|
|
@Column(DataType.STRING)
|
|
redirectUri: string;
|
|
|
|
@Column(DataType.DATE)
|
|
expiresAt: Date;
|
|
|
|
// associations
|
|
|
|
@BelongsTo(() => OAuthClient, "oauthClientId")
|
|
oauthClient: OAuthClient;
|
|
|
|
@ForeignKey(() => OAuthClient)
|
|
@Column(DataType.UUID)
|
|
oauthClientId: string;
|
|
|
|
@BelongsTo(() => User, "userId")
|
|
user: User;
|
|
|
|
@ForeignKey(() => User)
|
|
@Column(DataType.UUID)
|
|
userId: string;
|
|
|
|
/**
|
|
* Finds an OAuthAuthorizationCode by the given code. Use `consume` to claim
|
|
* the code before a token is issued from it.
|
|
*
|
|
* @param input The code to search for
|
|
* @returns The OAuthAuthentication if found
|
|
*/
|
|
public static findByCode(input: string) {
|
|
const authorizationCodeHash = hash(input);
|
|
|
|
return this.findOne({
|
|
where: {
|
|
authorizationCodeHash,
|
|
},
|
|
include: [
|
|
{
|
|
association: "user",
|
|
required: true,
|
|
},
|
|
],
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Deletes the authorization code with the given code, so that it can only be
|
|
* exchanged once. The delete is atomic, so concurrent attempts to exchange one
|
|
* code result in a single successful caller.
|
|
*
|
|
* @param input The code to consume
|
|
* @returns True if this call consumed the code
|
|
*/
|
|
public static async consume(input: string) {
|
|
const count = await this.destroy({
|
|
where: {
|
|
authorizationCodeHash: hash(input),
|
|
},
|
|
});
|
|
|
|
return count > 0;
|
|
}
|
|
}
|
|
|
|
export default OAuthAuthorizationCode;
|