X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=server%2Flib%2Fredis.ts;h=b7523492a5895ba50ce3c487e7d1cd0f9161d8fc;hb=37ff5005b47b9df2933a0b8812609a6c41faa170;hp=0478bfc895d78a8ce0300c2ff507f771ff0d6c36;hpb=e5d91a9b9cc27b8de55dcf299c8569c89e23debb;p=github%2FChocobozzz%2FPeerTube.git diff --git a/server/lib/redis.ts b/server/lib/redis.ts index 0478bfc89..b7523492a 100644 --- a/server/lib/redis.ts +++ b/server/lib/redis.ts @@ -1,13 +1,15 @@ -import express from 'express' -import { createClient } from 'redis' +import { createClient, RedisClientOptions, RedisModules } from 'redis' import { exists } from '@server/helpers/custom-validators/misc' +import { sha256 } from '@shared/extra-utils' import { logger } from '../helpers/logger' import { generateRandomString } from '../helpers/utils' import { CONFIG } from '../initializers/config' import { + AP_CLEANER, CONTACT_FORM_LIFETIME, RESUMABLE_UPLOAD_SESSION_LIFETIME, TRACKER_RATE_LIMITS, + TWO_FACTOR_AUTH_REQUEST_TOKEN_LIFETIME, USER_EMAIL_VERIFY_LIFETIME, USER_PASSWORD_CREATE_LIFETIME, USER_PASSWORD_RESET_LIFETIME, @@ -15,15 +17,12 @@ import { WEBSERVER } from '../initializers/constants' -// Only used for typings -const redisClientWrapperForType = () => createClient<{}>() - class Redis { private static instance: Redis private initialized = false private connected = false - private client: ReturnType + private client: ReturnType private prefix: string private constructor () { @@ -35,30 +34,45 @@ class Redis { this.initialized = true this.client = createClient(Redis.getRedisClientOptions()) + this.client.on('error', err => logger.error('Redis Client Error', { err })) + + logger.info('Connecting to redis...') this.client.connect() - .then(() => { this.connected = true }) - .catch(err => { + .then(() => { + logger.info('Connected to redis.') + + this.connected = true + }).catch(err => { logger.error('Cannot connect to redis', { err }) process.exit(-1) }) - this.client.on('error', err => { - logger.error('Error in Redis client.', { err }) - process.exit(-1) - }) - this.prefix = 'redis-' + WEBSERVER.HOST + '-' } static getRedisClientOptions () { - return Object.assign({}, - CONFIG.REDIS.AUTH ? { password: CONFIG.REDIS.AUTH } : {}, - (CONFIG.REDIS.DB) ? { db: CONFIG.REDIS.DB } : {}, - (CONFIG.REDIS.HOSTNAME && CONFIG.REDIS.PORT) - ? { host: CONFIG.REDIS.HOSTNAME, port: CONFIG.REDIS.PORT } - : { path: CONFIG.REDIS.SOCKET } - ) + 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 } + } + + if (CONFIG.REDIS.DB) { + config = { ...config, database: CONFIG.REDIS.DB } + } + + 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 config } getClient () { @@ -95,10 +109,24 @@ 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) { @@ -129,18 +157,10 @@ class Redis { return this.setValue(this.generateIPViewKey(ip, videoUUID), '1', VIEW_LIFETIME.VIEW) } - setIPVideoViewer (ip: string, videoUUID: string) { - return this.setValue(this.generateIPViewerKey(ip, videoUUID), '1', VIEW_LIFETIME.VIEWER) - } - async doesVideoIPViewExist (ip: string, videoUUID: string) { return this.exists(this.generateIPViewKey(ip, videoUUID)) } - async doesVideoIPViewerExist (ip: string, videoUUID: string) { - return this.exists(this.generateIPViewerKey(ip, videoUUID)) - } - /* ************ Tracker IP block ************ */ setTrackerBlockIP (ip: string) { @@ -233,6 +253,45 @@ class Redis { ]) } + /* ************ Video viewers stats ************ */ + + getLocalVideoViewer (options: { + key?: string + // Or + ip?: string + videoId?: number + }) { + if (options.key) return this.getObject(options.key) + + const { viewerKey } = this.generateLocalVideoViewerKeys(options.ip, options.videoId) + + return this.getObject(viewerKey) + } + + setLocalVideoViewer (ip: string, videoId: number, object: any) { + const { setKey, viewerKey } = this.generateLocalVideoViewerKeys(ip, videoId) + + return Promise.all([ + this.addToSet(setKey, viewerKey), + this.setObject(viewerKey, object) + ]) + } + + listLocalVideoViewerKeys () { + const { setKey } = this.generateLocalVideoViewerKeys() + + return this.getSet(setKey) + } + + deleteLocalVideoViewersKeys (key: string) { + const { setKey } = this.generateLocalVideoViewerKeys() + + return Promise.all([ + this.deleteFromSet(setKey, key), + this.deleteKey(key) + ]) + } + /* ************ Resumable uploads final responses ************ */ setUploadSession (uploadId: string, response?: { video: { id: number, shortUUID: string, uuid: string } }) { @@ -261,12 +320,31 @@ class Redis { return this.deleteKey('resumable-upload-' + uploadId) } + /* ************ AP resource unavailability ************ */ + + async addAPUnavailability (url: string) { + const key = this.generateAPUnavailabilityKey(url) + + const value = await this.increment(key) + await this.setExpiration(key, AP_CLEANER.PERIOD * 2) + + return value + } + /* ************ Keys generation ************ */ - private generateLocalVideoViewsKeys (videoId?: Number) { + private generateLocalVideoViewsKeys (videoId: number): { setKey: string, videoKey: string } + private generateLocalVideoViewsKeys (): { setKey: string } + private generateLocalVideoViewsKeys (videoId?: number) { return { setKey: `local-video-views-buffer`, videoKey: `local-video-views-buffer-${videoId}` } } + private generateLocalVideoViewerKeys (ip: string, videoId: number): { setKey: string, viewerKey: string } + private generateLocalVideoViewerKeys (): { setKey: string } + private generateLocalVideoViewerKeys (ip?: string, videoId?: number) { + return { setKey: `local-video-viewer-stats-keys`, viewerKey: `local-video-viewer-stats-${ip}-${videoId}` } + } + private generateVideoViewStatsKeys (options: { videoId?: number, hour?: number }) { const hour = exists(options.hour) ? options.hour @@ -279,6 +357,10 @@ class Redis { return 'reset-password-' + userId } + private generateTwoFactorRequestKey (userId: number, token: string) { + return 'two-factor-request-' + userId + '-' + token + } + private generateVerifyEmailKey (userId: number) { return 'verify-email-' + userId } @@ -287,10 +369,6 @@ class Redis { return `views-${videoUUID}-${ip}` } - private generateIPViewerKey (ip: string, videoUUID: string) { - return `viewer-${videoUUID}-${ip}` - } - private generateTrackerBlockIPKey (ip: string) { return `tracker-block-ip-${ip}` } @@ -299,6 +377,10 @@ class Redis { return 'contact-form-' + ip } + private generateAPUnavailabilityKey (url: string) { + return 'ap-unavailability-' + sha256(url) + } + /* ************ Redis helpers ************ */ private getValue (key: string) { @@ -321,8 +403,23 @@ class Redis { return this.client.del(this.prefix + key) } - private async setValue (key: string, value: string, expirationMilliseconds: number) { - const result = await this.client.set(this.prefix + key, value, { PX: expirationMilliseconds }) + private async getObject (key: string) { + const value = await this.getValue(key) + if (!value) return null + + return JSON.parse(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) if (result !== 'OK') throw new Error('Redis set result is not OK.') } @@ -331,16 +428,18 @@ class Redis { return this.client.del(this.prefix + key) } - private getObject (key: string) { - return this.client.hGetAll(this.prefix + key) - } - private increment (key: string) { return this.client.incr(this.prefix + key) } - private exists (key: string) { - return this.client.exists(this.prefix + key) + private async exists (key: string) { + const result = await this.client.exists(this.prefix + key) + + return result !== 0 + } + + private setExpiration (key: string, ms: number) { + return this.client.expire(this.prefix + key, ms / 1000) } static get Instance () {