X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Flib%2Fredis.ts;h=8430b2227cfad5a3f7d52ffb88bdbe9a889acfe5;hb=0c302acb3c358b4d4d8dee45aed1de1108ea37ea;hp=158f3c08090e7106c165847cdac9c49ae14e4cfb;hpb=fba911e2c89708a166636e3a93fcd8fcbc3de7e1;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/lib/redis.ts b/server/lib/redis.ts index 158f3c080..8430b2227 100644 --- a/server/lib/redis.ts +++ b/server/lib/redis.ts @@ -1,4 +1,4 @@ -import { createClient, RedisClientOptions, RedisModules, RedisScripts } from 'redis' +import IoRedis, { RedisOptions } from 'ioredis' import { exists } from '@server/helpers/custom-validators/misc' import { sha256 } from '@shared/extra-utils' import { logger } from '../helpers/logger' @@ -8,24 +8,20 @@ import { AP_CLEANER, CONTACT_FORM_LIFETIME, RESUMABLE_UPLOAD_SESSION_LIFETIME, - TRACKER_RATE_LIMITS, - USER_EMAIL_VERIFY_LIFETIME, + TWO_FACTOR_AUTH_REQUEST_TOKEN_LIFETIME, + EMAIL_VERIFY_LIFETIME, USER_PASSWORD_CREATE_LIFETIME, USER_PASSWORD_RESET_LIFETIME, VIEW_LIFETIME, WEBSERVER } from '../initializers/constants' -// Only used for typings -// TODO: remove when https://github.com/microsoft/TypeScript/issues/37181 is fixed -const redisClientWrapperForType = () => createClient<{}, RedisScripts>() - class Redis { private static instance: Redis private initialized = false private connected = false - private client: ReturnType + private client: IoRedis private prefix: string private constructor () { @@ -36,45 +32,58 @@ class Redis { if (this.initialized === true) return this.initialized = true - this.client = createClient(Redis.getRedisClientOptions()) + const redisMode = CONFIG.REDIS.SENTINEL.ENABLED ? 'sentinel' : 'standalone' + logger.info('Connecting to redis ' + redisMode + '...') - logger.info('Connecting to redis...') + this.client = new IoRedis(Redis.getRedisClientOptions('', { enableAutoPipelining: true })) + this.client.on('error', err => logger.error('Redis failed to connect', { err })) + this.client.on('connect', () => { + logger.info('Connected to redis.') - this.client.connect() - .then(() => { - logger.info('Connected to redis.') + this.connected = true + }) + this.client.on('reconnecting', (ms) => { + logger.error(`Reconnecting to redis in ${ms}.`) + }) + this.client.on('close', () => { + logger.error('Connection to redis has closed.') + this.connected = false + }) - this.connected = true - }).catch(err => { - logger.error('Cannot connect to redis', { err }) - process.exit(-1) - }) + this.client.on('end', () => { + logger.error('Connection to redis has closed and no more reconnects will be done.') + }) this.prefix = 'redis-' + WEBSERVER.HOST + '-' } - static getRedisClientOptions () { - let config: RedisClientOptions = { - socket: { - connectTimeout: 20000 // Could be slow since node use sync call to compile PeerTube - } - } - - if (CONFIG.REDIS.AUTH) { - config = { ...config, password: CONFIG.REDIS.AUTH } - } + static getRedisClientOptions (name?: string, options: RedisOptions = {}): RedisOptions { + const connectionName = [ 'PeerTube', name ].join('') + const connectTimeout = 20000 // Could be slow since node use sync call to compile PeerTube - if (CONFIG.REDIS.DB) { - config = { ...config, database: CONFIG.REDIS.DB } + if (CONFIG.REDIS.SENTINEL.ENABLED) { + return { + connectionName, + connectTimeout, + enableTLSForSentinelMode: CONFIG.REDIS.SENTINEL.ENABLE_TLS, + sentinelPassword: CONFIG.REDIS.AUTH, + sentinels: CONFIG.REDIS.SENTINEL.SENTINELS, + name: CONFIG.REDIS.SENTINEL.MASTER_NAME, + ...options + } } - if (CONFIG.REDIS.HOSTNAME && CONFIG.REDIS.PORT) { - config.socket = { ...config.socket, host: CONFIG.REDIS.HOSTNAME, port: CONFIG.REDIS.PORT } - } else { - config.socket = { ...config.socket, path: CONFIG.REDIS.SOCKET } + return { + connectionName, + connectTimeout, + password: CONFIG.REDIS.AUTH, + db: CONFIG.REDIS.DB, + host: CONFIG.REDIS.HOSTNAME, + port: CONFIG.REDIS.PORT, + path: CONFIG.REDIS.SOCKET, + showFriendlyErrorStack: true, + ...options } - - return config } getClient () { @@ -111,22 +120,48 @@ class Redis { return this.removeValue(this.generateResetPasswordKey(userId)) } - async getResetPasswordLink (userId: number) { + async getResetPasswordVerificationString (userId: number) { return this.getValue(this.generateResetPasswordKey(userId)) } + /* ************ Two factor auth request ************ */ + + async setTwoFactorRequest (userId: number, otpSecret: string) { + const requestToken = await generateRandomString(32) + + await this.setValue(this.generateTwoFactorRequestKey(userId, requestToken), otpSecret, TWO_FACTOR_AUTH_REQUEST_TOKEN_LIFETIME) + + return requestToken + } + + async getTwoFactorRequestToken (userId: number, requestToken: string) { + return this.getValue(this.generateTwoFactorRequestKey(userId, requestToken)) + } + /* ************ Email verification ************ */ - async setVerifyEmailVerificationString (userId: number) { + async setUserVerifyEmailVerificationString (userId: number) { + const generatedString = await generateRandomString(32) + + await this.setValue(this.generateUserVerifyEmailKey(userId), generatedString, EMAIL_VERIFY_LIFETIME) + + return generatedString + } + + async getUserVerifyEmailLink (userId: number) { + return this.getValue(this.generateUserVerifyEmailKey(userId)) + } + + async setRegistrationVerifyEmailVerificationString (registrationId: number) { const generatedString = await generateRandomString(32) - await this.setValue(this.generateVerifyEmailKey(userId), generatedString, USER_EMAIL_VERIFY_LIFETIME) + await this.setValue(this.generateRegistrationVerifyEmailKey(registrationId), generatedString, EMAIL_VERIFY_LIFETIME) return generatedString } - async getVerifyEmailLink (userId: number) { - return this.getValue(this.generateVerifyEmailKey(userId)) + async getRegistrationVerifyEmailLink (registrationId: number) { + return this.getValue(this.generateRegistrationVerifyEmailKey(registrationId)) } /* ************ Contact form per IP ************ */ @@ -149,16 +184,6 @@ class Redis { return this.exists(this.generateIPViewKey(ip, videoUUID)) } - /* ************ Tracker IP block ************ */ - - setTrackerBlockIP (ip: string) { - return this.setValue(this.generateTrackerBlockIPKey(ip), '1', TRACKER_RATE_LIMITS.BLOCK_IP_LIFETIME) - } - - async doesTrackerBlockIPExist (ip: string) { - return this.exists(this.generateTrackerBlockIPKey(ip)) - } - /* ************ Video views stats ************ */ addVideoViewStats (videoId: number) { @@ -345,16 +370,20 @@ class Redis { return 'reset-password-' + userId } - private generateVerifyEmailKey (userId: number) { - return 'verify-email-' + userId + private generateTwoFactorRequestKey (userId: number, token: string) { + return 'two-factor-request-' + userId + '-' + token } - private generateIPViewKey (ip: string, videoUUID: string) { - return `views-${videoUUID}-${ip}` + private generateUserVerifyEmailKey (userId: number) { + return 'verify-email-user-' + userId + } + + private generateRegistrationVerifyEmailKey (registrationId: number) { + return 'verify-email-registration-' + registrationId } - private generateTrackerBlockIPKey (ip: string) { - return `tracker-block-ip-${ip}` + private generateIPViewKey (ip: string, videoUUID: string) { + return `views-${videoUUID}-${ip}` } private generateContactFormKey (ip: string) { @@ -372,15 +401,15 @@ class Redis { } private getSet (key: string) { - return this.client.sMembers(this.prefix + key) + return this.client.smembers(this.prefix + key) } private addToSet (key: string, value: string) { - return this.client.sAdd(this.prefix + key, value) + return this.client.sadd(this.prefix + key, value) } private deleteFromSet (key: string, value: string) { - return this.client.sRem(this.prefix + key, value) + return this.client.srem(this.prefix + key, value) } private deleteKey (key: string) { @@ -394,16 +423,14 @@ class Redis { return JSON.parse(value) } - private setObject (key: string, value: { [ id: string ]: number | string }) { - return this.setValue(key, JSON.stringify(value)) + private setObject (key: string, value: { [ id: string ]: number | string }, expirationMilliseconds?: number) { + return this.setValue(key, JSON.stringify(value), expirationMilliseconds) } private async setValue (key: string, value: string, expirationMilliseconds?: number) { - const options = expirationMilliseconds - ? { PX: expirationMilliseconds } - : {} - - const result = await this.client.set(this.prefix + key, value, options) + const result = expirationMilliseconds !== undefined + ? await this.client.set(this.prefix + key, value, 'PX', expirationMilliseconds) + : await this.client.set(this.prefix + key, value) if (result !== 'OK') throw new Error('Redis set result is not OK.') }