mirror of
https://github.com/outline/outline.git
synced 2026-06-13 11:25:03 +03:00
codegen-sh[bot]
f284a27941
* feat: Add OIDC well-known endpoint discovery support Co-authored-by: codegen-sh[bot] <131295404+codegen-sh[bot]@users.noreply.github.com> Co-authored-by: Tom Moor <tom@getoutline.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
111 lines
2.9 KiB
TypeScript
111 lines
2.9 KiB
TypeScript
import { IsBoolean, IsOptional, IsUrl, MaxLength } from "class-validator";
|
||
import { Environment } from "@server/env";
|
||
import { Public } from "@server/utils/decorators/Public";
|
||
import environment from "@server/utils/environment";
|
||
import { CannotUseWithout } from "@server/utils/validators";
|
||
|
||
class OIDCPluginEnvironment extends Environment {
|
||
/**
|
||
* OIDC client credentials. To enable authentication with any
|
||
* compatible provider.
|
||
*/
|
||
@IsOptional()
|
||
@CannotUseWithout("OIDC_CLIENT_SECRET")
|
||
public OIDC_CLIENT_ID = this.toOptionalString(environment.OIDC_CLIENT_ID);
|
||
|
||
@IsOptional()
|
||
@CannotUseWithout("OIDC_CLIENT_ID")
|
||
public OIDC_CLIENT_SECRET = this.toOptionalString(
|
||
environment.OIDC_CLIENT_SECRET
|
||
);
|
||
|
||
/**
|
||
* The OIDC issuer URL for automatic discovery of endpoints via the
|
||
* well-known configuration endpoint. When provided, the authorization,
|
||
* token, and userinfo endpoints will be automatically discovered.
|
||
*/
|
||
@IsOptional()
|
||
@IsUrl({
|
||
require_tld: false,
|
||
allow_underscores: true,
|
||
})
|
||
public OIDC_ISSUER_URL = this.toOptionalString(environment.OIDC_ISSUER_URL);
|
||
|
||
/**
|
||
* The name of the OIDC provider, eg "GitLab" – this will be displayed on the
|
||
* sign-in button and other places in the UI. The default value is:
|
||
* "OpenID Connect".
|
||
*/
|
||
@MaxLength(50)
|
||
public OIDC_DISPLAY_NAME = environment.OIDC_DISPLAY_NAME ?? "OpenID Connect";
|
||
|
||
/**
|
||
* The OIDC authorization endpoint.
|
||
*/
|
||
@IsOptional()
|
||
@IsUrl({
|
||
require_tld: false,
|
||
allow_underscores: true,
|
||
})
|
||
public OIDC_AUTH_URI = this.toOptionalString(environment.OIDC_AUTH_URI);
|
||
|
||
/**
|
||
* The OIDC token endpoint.
|
||
*/
|
||
@IsOptional()
|
||
@IsUrl({
|
||
require_tld: false,
|
||
allow_underscores: true,
|
||
})
|
||
public OIDC_TOKEN_URI = this.toOptionalString(environment.OIDC_TOKEN_URI);
|
||
|
||
/**
|
||
* The OIDC userinfo endpoint.
|
||
*/
|
||
@IsOptional()
|
||
@IsUrl({
|
||
require_tld: false,
|
||
allow_underscores: true,
|
||
})
|
||
public OIDC_USERINFO_URI = this.toOptionalString(
|
||
environment.OIDC_USERINFO_URI
|
||
);
|
||
|
||
/**
|
||
* The OIDC profile field to use as the username. The default value is
|
||
* "preferred_username".
|
||
*/
|
||
public OIDC_USERNAME_CLAIM =
|
||
environment.OIDC_USERNAME_CLAIM ?? "preferred_username";
|
||
|
||
/**
|
||
* A space separated list of OIDC scopes to request. Defaults to "openid
|
||
* profile email".
|
||
*/
|
||
public OIDC_SCOPES = environment.OIDC_SCOPES ?? "openid profile email";
|
||
|
||
/**
|
||
* Disable autoredirect to the OIDC login page if there is only one
|
||
* authentication method and that method is OIDC.
|
||
*/
|
||
@Public
|
||
@IsOptional()
|
||
@IsBoolean()
|
||
public OIDC_DISABLE_REDIRECT = this.toOptionalBoolean(
|
||
environment.OIDC_DISABLE_REDIRECT
|
||
);
|
||
|
||
/**
|
||
* The OIDC logout endpoint.
|
||
*/
|
||
@Public
|
||
@IsOptional()
|
||
@IsUrl({
|
||
require_tld: false,
|
||
allow_underscores: true,
|
||
})
|
||
public OIDC_LOGOUT_URI = this.toOptionalString(environment.OIDC_LOGOUT_URI);
|
||
}
|
||
|
||
export default new OIDCPluginEnvironment();
|