Skip to content

ActivityPub-federated video streaming platform using P2P directly in your web browser

Add ability to disable root login from config

Chocobozzz182772bb7737
diff --git a/config/default.yaml b/config/default.yaml
index 0477bbf6df..50fcf7f14c 100644
--- a/config/default.yaml
+++ b/config/default.yaml
@@ -593,6 +593,10 @@ user:
# Enable or disable video history by default for new users
enabled: true
+ # Disable local login and OAuth token usage for the built-in `root` user.
+ # If enabled, root cannot login and existing root OAuth access/refresh tokens are rejected.
+ disable_root_auth: false
+
# Default value of maximum video bytes the user can upload
# Does not take into account transcoded files or account export archives (that can include user uploaded files)
# Byte format is supported ("1GB" etc)
diff --git a/config/production.yaml.example b/config/production.yaml.example
index 8f731763f9..97a7fbf15a 100644
--- a/config/production.yaml.example
+++ b/config/production.yaml.example
@@ -603,6 +603,10 @@ user:
# Enable or disable video history by default for new users
enabled: true
+ # Disable local login and OAuth token usage for the built-in `root` user.
+ # If enabled, root cannot login and existing root OAuth access/refresh tokens are rejected.
+ disable_root_auth: false
+
# Default value of maximum video bytes the user can upload
# Does not take into account transcoded files or account export archives (that can include user uploaded files)
# Byte format is supported ("1GB" etc)
diff --git a/packages/tests/src/api/users/oauth.ts b/packages/tests/src/api/users/oauth.ts
index 4bf66c059f..9d9a526e49 100644
--- a/packages/tests/src/api/users/oauth.ts
+++ b/packages/tests/src/api/users/oauth.ts
@@ -404,6 +404,41 @@ describe('Test oauth', function () {
})
})
+ describe('Disable root auth', function () {
+ let rootAccessToken: string
+ let rootRefreshToken: string
+
+ it('Should get root tokens when root auth is enabled', async function () {
+ await server.kill()
+ await server.run({ user: { disable_root_auth: false } })
+
+ const res = await server.login.login({ expectedStatus: HttpStatusCode.OK_200 })
+
+ rootAccessToken = res.access_token
+ rootRefreshToken = res.refresh_token
+
+ await server.users.getMyInfo({ token: rootAccessToken, expectedStatus: HttpStatusCode.OK_200 })
+ })
+
+ it('Should not allow root password login when root auth is disabled', async function () {
+ await server.kill()
+ await server.run({ user: { disable_root_auth: true } })
+
+ const body = await server.login.login({ expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
+ expect(body.code).to.equal(OAuth2ErrorCode.INVALID_GRANT)
+ })
+
+ it('Should reject existing root access token when root auth is disabled', async function () {
+ await server.users.getMyInfo({ token: rootAccessToken, expectedStatus: HttpStatusCode.UNAUTHORIZED_401 })
+ })
+
+ it('Should reject existing root refresh token when root auth is disabled', async function () {
+ const { body } = await server.login.refreshToken({ refreshToken: rootRefreshToken, expectedStatus: HttpStatusCode.BAD_REQUEST_400 })
+
+ expect(body.code).to.equal(OAuth2ErrorCode.INVALID_GRANT)
+ })
+ })
+
describe('Custom token lifetime', function () {
before(async function () {
this.timeout(120_000)
diff --git a/server/core/initializers/checker-before-init.ts b/server/core/initializers/checker-before-init.ts
index edae92211e..45d650dec0 100644
--- a/server/core/initializers/checker-before-init.ts
+++ b/server/core/initializers/checker-before-init.ts
@@ -65,6 +65,7 @@ export function checkMissedConfig () {
'open_telemetry.tracing.jaeger_exporter.endpoint',
'open_telemetry.metrics.http_request_duration.enabled',
'user.history.videos.enabled',
+ 'user.disable_root_auth',
'user.video_quota',
'user.video_quota_daily',
'user.password_constraints.min_length',
diff --git a/server/core/initializers/config.ts b/server/core/initializers/config.ts
index 5c45a9f27c..e4d27fe5e8 100644
--- a/server/core/initializers/config.ts
+++ b/server/core/initializers/config.ts
@@ -593,6 +593,9 @@ const CONFIG = {
}
}
},
+ get DISABLE_ROOT_AUTH () {
+ return config.get<boolean>('user.disable_root_auth')
+ },
get VIDEO_QUOTA () {
return parseBytes(config.get<number>('user.video_quota'))
},
diff --git a/server/core/lib/auth/oauth-model.ts b/server/core/lib/auth/oauth-model.ts
index 1202d31616..dfbc492fab 100644
--- a/server/core/lib/auth/oauth-model.ts
+++ b/server/core/lib/auth/oauth-model.ts
@@ -58,6 +58,8 @@ async function getAccessToken (bearerToken: string) {
if (!tokenModel) return undefined
+ if (isRootAuthDisabled(tokenModel.User)) return undefined
+
if (tokenModel.User.pluginAuth) {
const valid = await PluginManager.Instance.isTokenValid(tokenModel, 'access')
@@ -81,6 +83,8 @@ async function getRefreshToken (refreshToken: string) {
const tokenModel = tokenInfo.token
+ if (isRootAuthDisabled(tokenModel.User)) return undefined
+
if (tokenModel.User.pluginAuth) {
const valid = await PluginManager.Instance.isTokenValid(tokenModel, 'refresh')
@@ -147,6 +151,8 @@ async function getUser (usernameOrEmail?: string, password?: string, options?: {
// If we don't find the user, or if the user belongs to a plugin
if (!user || user.pluginAuth !== null || !password) return null
+ if (isRootAuthDisabled(user)) return null
+
const passwordMatch = await user.isPasswordMatch(password)
if (passwordMatch !== true) return null
@@ -332,3 +338,7 @@ function checkUserValidityOrThrow (user: MUser, req: express.Request) {
function buildExpiresIn (expiresAt: Date) {
return Math.floor((expiresAt.getTime() - new Date().getTime()) / 1000)
}
+
+function isRootAuthDisabled (user: Pick<MUser, 'username'>) {
+ return CONFIG.USER.DISABLE_ROOT_AUTH === true && user.username === 'root'
+}
diff --git a/server/server.ts b/server/server.ts
index a625c3d74c..1716aef8d2 100644
--- a/server/server.ts
+++ b/server/server.ts
@@ -4,13 +4,13 @@ await registerOpentelemetryTracing()
process.title = 'peertube'
// ----------- Core checker -----------
-import { checkMissedConfig, checkFFmpeg, checkNodeVersion } from './core/initializers/checker-before-init.js'
+import { checkFFmpeg, checkMissedConfig, checkNodeVersion } from './core/initializers/checker-before-init.js'
// Do not use barrels because we don't want to load all modules here (we need to initialize database first)
+import { initI18n, useI18n } from '@server/helpers/i18n.js'
+import { logger } from './core/helpers/logger.js'
import { CONFIG } from './core/initializers/config.js'
import { API_VERSION, WEBSERVER, loadLanguages } from './core/initializers/constants.js'
-import { logger } from './core/helpers/logger.js'
-import { initI18n, useI18n } from '@server/helpers/i18n.js'
const missed = checkMissedConfig()
if (missed.length !== 0) {
@@ -31,7 +31,7 @@ try {
process.exit(-1)
}
-import { checkConfig, checkActivityPubUrls, checkFFmpegVersion } from './core/initializers/checker-after-init.js'
+import { checkActivityPubUrls, checkConfig, checkFFmpegVersion } from './core/initializers/checker-after-init.js'
try {
checkConfig()
@@ -43,7 +43,7 @@ try {
// ----------- Database -----------
// Initialize database and models
-import { initDatabaseModels, checkDatabaseConnectionOrDie, sequelizeTypescript } from './core/initializers/database.js'
+import { checkDatabaseConnectionOrDie, initDatabaseModels, sequelizeTypescript } from './core/initializers/database.js'
checkDatabaseConnectionOrDie()
import { migrate } from './core/initializers/migrator.js'
@@ -62,13 +62,13 @@ Promise.all([
]).catch(err => logger.error('Cannot load i18n/languages', { err }))
// Express configuration
-import express from 'express'
-import morgan, { token } from 'morgan'
-import cors from 'cors'
+import { program as cli } from 'commander'
import cookieParser from 'cookie-parser'
+import cors from 'cors'
+import express from 'express'
import { frameguard } from 'helmet'
import anonymize from 'ip-anonymize'
-import { program as cli } from 'commander'
+import morgan, { token } from 'morgan'
const app = express().disable('x-powered-by')
@@ -102,57 +102,57 @@ if (CONFIG.SECURITY.FRAMEGUARD.ENABLED) {
}
// ----------- PeerTube modules -----------
-import { installApplication } from './core/initializers/installer.js'
-import { Emailer } from './core/lib/emailer.js'
-import { JobQueue } from './core/lib/job-queue/index.js'
+import { HttpStatusCode } from '@peertube/peertube-models'
+import { isTestOrDevInstance } from '@peertube/peertube-node-utils'
+import { OpenTelemetryMetrics } from '@server/lib/opentelemetry/metrics.js'
+import { RemoveExpiredUserExportsScheduler } from '@server/lib/schedulers/remove-expired-user-exports-scheduler.js'
+import { UpdateTokenSessionScheduler } from '@server/lib/schedulers/update-token-session-scheduler.js'
+import { VideoChannelSyncLatestScheduler } from '@server/lib/schedulers/video-channel-sync-latest-scheduler.js'
+import { ServerConfigManager } from '@server/lib/server-config-manager.js'
+import { VideoViewsManager } from '@server/lib/views/video-views-manager.js'
+import { ApplicationModel } from '@server/models/application/application.js'
import {
activityPubRouter,
apiRouter,
- miscRouter,
clientsRouter,
+ createWebsocketTrackerServer,
+ downloadRouter,
feedsRouter,
- staticRouter,
- wellKnownRouter,
lazyStaticRouter,
- servicesRouter,
+ miscRouter,
objectStorageProxyRouter,
pluginsRouter,
- trackerRouter,
- createWebsocketTrackerServer,
+ servicesRouter,
sitemapRouter,
- downloadRouter
+ staticRouter,
+ trackerRouter,
+ wellKnownRouter
} from './core/controllers/index.js'
-import { advertiseDoNotTrack } from './core/middlewares/dnt.js'
-import { apiFailMiddleware } from './core/middlewares/error.js'
+import { isHTTPSignatureDigestValid } from './core/helpers/peertube-crypto.js'
+import { installApplication } from './core/initializers/installer.js'
+import { Emailer } from './core/lib/emailer.js'
+import { updateStreamingPlaylistsInfohashesIfNeeded } from './core/lib/hls.js'
+import { JobQueue } from './core/lib/job-queue/index.js'
+import { LiveManager } from './core/lib/live/index.js'
+import { PeerTubeSocket } from './core/lib/peertube-socket.js'
+import { Hooks } from './core/lib/plugins/hooks.js'
+import { PluginManager } from './core/lib/plugins/plugin-manager.js'
import { Redis } from './core/lib/redis.js'
import { ActorFollowScheduler } from './core/lib/schedulers/actor-follow-scheduler.js'
-import { RemoveOldViewsScheduler } from './core/lib/schedulers/remove-old-views-scheduler.js'
-import { UpdateVideosScheduler } from './core/lib/schedulers/update-videos-scheduler.js'
-import { YoutubeDlUpdateScheduler } from './core/lib/schedulers/youtube-dl-update-scheduler.js'
-import { VideosRedundancyScheduler } from './core/lib/schedulers/videos-redundancy-scheduler.js'
-import { RemoveOldHistoryScheduler } from './core/lib/schedulers/remove-old-history-scheduler.js'
import { AutoFollowIndexInstances } from './core/lib/schedulers/auto-follow-index-instances.js'
-import { RemoveDanglingResumableUploadsScheduler } from './core/lib/schedulers/remove-dangling-resumable-uploads-scheduler.js'
-import { VideoViewsBufferScheduler } from './core/lib/schedulers/video-views-buffer-scheduler.js'
import { GeoIPUpdateScheduler } from './core/lib/schedulers/geo-ip-update-scheduler.js'
-import { RunnerJobWatchDogScheduler } from './core/lib/schedulers/runner-job-watch-dog-scheduler.js'
-import { isHTTPSignatureDigestValid } from './core/helpers/peertube-crypto.js'
-import { PeerTubeSocket } from './core/lib/peertube-socket.js'
-import { updateStreamingPlaylistsInfohashesIfNeeded } from './core/lib/hls.js'
-import { PluginsCheckScheduler } from './core/lib/schedulers/plugins-check-scheduler.js'
import { PeerTubeVersionCheckScheduler } from './core/lib/schedulers/peertube-version-check-scheduler.js'
-import { Hooks } from './core/lib/plugins/hooks.js'
-import { PluginManager } from './core/lib/plugins/plugin-manager.js'
-import { LiveManager } from './core/lib/live/index.js'
-import { HttpStatusCode } from '@peertube/peertube-models'
-import { ServerConfigManager } from '@server/lib/server-config-manager.js'
-import { VideoViewsManager } from '@server/lib/views/video-views-manager.js'
-import { isTestOrDevInstance } from '@peertube/peertube-node-utils'
-import { OpenTelemetryMetrics } from '@server/lib/opentelemetry/metrics.js'
-import { ApplicationModel } from '@server/models/application/application.js'
-import { VideoChannelSyncLatestScheduler } from '@server/lib/schedulers/video-channel-sync-latest-scheduler.js'
-import { RemoveExpiredUserExportsScheduler } from '@server/lib/schedulers/remove-expired-user-exports-scheduler.js'
-import { UpdateTokenSessionScheduler } from '@server/lib/schedulers/update-token-session-scheduler.js'
+import { PluginsCheckScheduler } from './core/lib/schedulers/plugins-check-scheduler.js'
+import { RemoveDanglingResumableUploadsScheduler } from './core/lib/schedulers/remove-dangling-resumable-uploads-scheduler.js'
+import { RemoveOldHistoryScheduler } from './core/lib/schedulers/remove-old-history-scheduler.js'
+import { RemoveOldViewsScheduler } from './core/lib/schedulers/remove-old-views-scheduler.js'
+import { RunnerJobWatchDogScheduler } from './core/lib/schedulers/runner-job-watch-dog-scheduler.js'
+import { UpdateVideosScheduler } from './core/lib/schedulers/update-videos-scheduler.js'
+import { VideoViewsBufferScheduler } from './core/lib/schedulers/video-views-buffer-scheduler.js'
+import { VideosRedundancyScheduler } from './core/lib/schedulers/videos-redundancy-scheduler.js'
+import { YoutubeDlUpdateScheduler } from './core/lib/schedulers/youtube-dl-update-scheduler.js'
+import { advertiseDoNotTrack } from './core/middlewares/dnt.js'
+import { apiFailMiddleware } from './core/middlewares/error.js'
// ----------- Command line -----------
@@ -349,6 +349,8 @@ async function startApplication () {
server.listen(port, hostname, async () => {
if (cliOptions.plugins) {
try {
+ await PluginManager.Instance.removeUnsecurePluginsIfNeeded()
+
await PluginManager.Instance.rebuildNativePluginsIfNeeded()
await PluginManager.Instance.registerPluginsAndThemes()