21 Commits

Author SHA1 Message Date
d87bc5f1d5 v0.0.23 2023-09-20 09:09:51 +00:00
0e79a81f3d v0.0.22 2023-05-10 13:17:35 +00:00
6bf5fbd794 0.0.21 fit contain 2023-04-19 14:28:09 +00:00
72431d805e 0.0.20 2023-04-15 15:07:46 +00:00
c3738a339a Merge branch 'master' of https://github.com/misskey-dev/media-proxy 2023-04-15 14:59:34 +00:00
99f0160e17 Content-Dispositionのパースでエラーが発生した場合にもダウンロードが完了するように 2023-04-15 14:59:24 +00:00
bd6f63b60e Update README.md 2023-04-13 11:57:42 +09:00
384c51569f update SPECIFICATION.md 2023-03-17 15:51:04 +00:00
57aa87f370 0.0.19 2023-03-17 15:50:07 +00:00
d86823e32d 0.0.18 2023-03-17 13:44:13 +00:00
405e6a5adb quality, effort変更 2023-03-17 13:43:45 +00:00
78cf2469d4 0.0.17 2023-03-03 16:43:52 +00:00
969d27e1b3 0.0.16 2023-02-28 17:12:01 +00:00
d5f5f4023c 0.0.15 2023-02-28 16:06:23 +00:00
30c8088b8e modify SPECIFICATION.md 2023-02-28 15:26:49 +00:00
4d3869020a 0.0.14 2023-02-28 15:23:21 +00:00
4e2230d7cf fix build 2023-02-28 15:22:36 +00:00
cfaf017c15 Content-Dispositionでダウンロード時の名前を指定
Fix https://github.com/misskey-dev/media-proxy/issues/6
2023-02-28 15:22:00 +00:00
808dacda41 0.0.13 2023-02-28 08:03:15 +00:00
0f65312eef fix readme 2023-02-28 05:57:34 +00:00
495f655973 Access-Control-Allow-Originが'*'に設定されている時要求Originを鸚鵡返し
Resolve #5
2023-02-20 15:34:51 +00:00
22 changed files with 964 additions and 629 deletions

View File

@ -1,32 +0,0 @@
module.exports = {
parserOptions: {
tsconfigRootDir: __dirname,
project: ['./tsconfig.json'],
},
extends: [
'../shared/.eslintrc.js',
],
rules: {
'import/order': ['warn', {
'groups': ['builtin', 'external', 'internal', 'parent', 'sibling', 'index', 'object', 'type'],
'pathGroups': [
{
'pattern': '@/**',
'group': 'external',
'position': 'after'
}
],
}],
'no-restricted-globals': [
'error',
{
'name': '__dirname',
'message': 'Not in ESModule. Use `import.meta.url` instead.'
},
{
'name': '__filename',
'message': 'Not in ESModule. Use `import.meta.url` instead.'
}
]
},
};

View File

@ -1,8 +1,8 @@
# Media Proxy for Misskey
Misskeyの/proxyが単体で動作しますMisskeyのコードがほぼそのまま移植されています
[→ メディアプロキシの仕様](./SPECIFICATION.md)
/proxyは画像ではないと403を返しますが、Media Proxyではそのまま内容を送信します。
Misskeyの/proxyが単体で動作しますMisskeyのコードがほぼそのまま移植されています
**Fastifyプラグインとして動作する気がします。**
`pnpm start`は[fastify-cli](https://github.com/fastify/fastify-cli)が動作します。
@ -10,6 +10,8 @@ Misskeyの/proxyが単体で動作しますMisskeyのコードがほぼその
一応AWS Lambdaで動かす実装を用意しましたが、全くおすすめしません。
https://github.com/tamaina/media-proxy-lambda
Sharp.jsを使っているため、メモリアロケータにjemallocを指定することをお勧めします。
## Fastifyプラグインとして動作させる
### npm install
@ -36,6 +38,13 @@ git clone https://github.com/misskey-dev/media-proxy.git
cd media-proxy
```
### jemallocをインストール
Debian/Ubuntuのaptの場合
```
sudo apt install libjemalloc2
```
### pnpm install
```
NODE_ENV=production pnpm install
@ -61,11 +70,11 @@ export default {
maxSize: 262144000,
// CORS
['Access-Control-Allow-Origin']: '*',
['Access-Control-Allow-Headers']: '*',
'Access-Control-Allow-Origin': '*',
'Access-Control-Allow-Headers': '*',
// CSP
['Content-Security-Policy']: `default-src 'none'; img-src 'self'; media-src 'self'; style-src 'unsafe-inline'`,
'Content-Security-Policy': `default-src 'none'; img-src 'self'; media-src 'self'; style-src 'unsafe-inline'`,
// フォワードプロキシ
// proxy: 'http://127.0.0.1:3128'
@ -76,14 +85,17 @@ export default {
適当にサーバーを公開してください。
ここではmediaproxy.example.comで公開するものとします。
メモ書き程度にsystemdでの開始方法を残しますが、もしかしたらAWS Lambdaとかで動かしたほうが楽かもしれません
メモ書き程度にsystemdでの開始方法を残します。
サーバーレスだとsharp.jsが動かない可能性が高いため、そこはなんとかしてください
systemdサービスのファイルを作成…
/etc/systemd/system/misskey-proxy.service
エディタで開き、以下のコードを貼り付けて保存(ユーザーやポートは適宜変更すること):
エディタで開き、以下のコードを貼り付けて保存
ユーザーやポートは適宜変更すること。
また、arm64の場合`Environment="LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libjemalloc.so.2"`のx86_64をaarch64に変更する必要がある。jemallocのパスはディストリビューションによって変わる可能性がある。
```systemd
[Unit]
@ -94,6 +106,7 @@ Type=simple
User=misskey
ExecStart=/usr/bin/npm start
WorkingDirectory=/home/misskey/media-proxy
Environment="LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libjemalloc.so.2"
Environment="NODE_ENV=production"
Environment="PORT=3000"
TimeoutSec=60

85
SPECIFICATION.md Normal file
View File

@ -0,0 +1,85 @@
# Misskeyメディアプロキシ仕様書
## メディアプロキシの種類と目的
Misskeyメディアプロキシは、リモートのファイルをインスタンス管理者が管理するドメインでプロキシ配信し、また、縮小・加工された画像を提供するためのアプリケーションである。
Misskeyサーバー本体の/proxy/で提供されている「本体メディアプロキシ (local media proxy)」と、[github.com/misskey-dev/media-proxy](https://github.com/misskey-dev/media-proxy)で配布されている「外部メディアプロキシ (external media proxy)」がある。
外部メディアプロキシを設定・使用することで、本体のサーバー負荷を軽減できる。また、複数のインスタンスで外部プロキシを共用すると、さらなる負荷軽減が期待できる。
## 外部メディアプロキシの設定と使用
外部メディアプロキシを設定するには、[README.md](./README.md)に記載されている通りインストールする。
外部メディアプロキシが設定されている場合、本体メディアプロキシは外部メディアプロキシへ301リダイレクトを返答するoriginクエリが指定されている場合を除く
Misskeyサーバーのapi/metaの応答に、使用するべきメディアプロキシのURLを示す`mediaProxy`プロパティが存在する。
外部メディアプロキシが指定されているならそのURLが、指定されていなければ本体メディアプロキシ(/proxy/)のURLが入っている。
本体メディアプロキシはリダイレクトを行うものの、Misskeyクライアントは`mediaProxy`の値に応じて適切なメディアプロキシへ直接要求を行うべきである。
メディアプロキシへは、クエリ文字列によって命令を行う。
拡張子によってキャッシュの挙動を変えるCDNがあるため、image.webp、avatar.webp、static.webpなどの適当なファイル名を付加するべきである。
例:
`https://example.com/proxy/image.webp?url=https%3A%2F%2F......`
Acceptヘッダーは無視される。
Cache-Controlは、正常なレスポンスの場合`max-age=31536000, immutable`、エラーレスポンスの場合`max-age=300`である。
Content-Typeは、ファイルの内容について適切なものが挿入される。
Content-Security-Policyは、`default-src 'none'; img-src 'self'; media-src 'self'; style-src 'unsafe-inline'`となっている。
Content-Dispositionは、filenameは元画像のContent-Disposition.filenameもしくはファイル名に基づいて挿入される。拡張子は適宜変更され、octet-streamの場合は拡張子として.unknownが付加される。inlineが指定される。
### クエリの一覧
#### url (必須)
変換ないしはプロキシを行う対象の、元画像のURLを指定する。
指定がなかった場合はHTTPコード400が返される。
https://www.google.com/images/errors/robot.png をプロキシする場合:
`https://example.com/proxy/image.webp?url=https%3A%2F%2Fwww.google.com%2Fimages%2Ferrors%2Frobot.png`
#### origin (本体のみ)
存在すると、外部メディアプロキシへのリダイレクトを行わない。
`https://example.com/proxy/image.webp?url=https%3A%2F%2F...&origin=1`
「存在すると」というのは、Fastifyで`'origin' in request.query`がtureになる場合という意味である。以下同様。
#### fallback
存在すると、元画像に到達できなかったり画像の変換中にエラーが起きたりした場合、正常なレスポンスCache-Controlは`max-age=300`)としてフォールバック画像(カラーバー)が表示される。
#### 変換クエリが存在しない場合の挙動
次の項目からは変換形式を指定するクエリとなっている。
変換形式が指定されていなかった場合は、画像ファイルもしくは許可されたファイルFILE_TYPE_BROWSERSAFEである場合のみプロキシファイルの再配信が行われる。
ただし、svgは、webpに変換される最大サイズ2048x2048
#### 変換クエリ付加時の挙動
一方、以下の変換クエリが指定されているが、元ファイルがsharp.jsで変換できない形式の場合、404が返される。
#### emoji
存在すると、高さ128px以下のwebpが応答される。
ただし、sharp.jsの都合により、元画像がapngの場合は無変換で応答される。
`https://example.com/proxy/emoji.webp?url=https%3A%2F%2F...&emoji=1`
「以下」というのは、元画像がこれ未満だった場合は拡大を行わないという意味である。以下同様。
#### avatar
存在すると、高さ320px以下のwebpが応答される。
ただし、sharp.jsの都合により、元画像がapngの場合は無変換で応答される。
`https://example.com/proxy/avatar.webp?url=https%3A%2F%2F...&avatar=1`
#### static
存在すると、アニメーション画像では最初のフレームのみの静止画のwebpが応答される。
emojiまたはavatarとstaticが同時に指定された場合は、それぞれに応じた高さが、指定されていない場合は幅498px・高さ422pxに収まるサイズ以下に縮小される。
#### preview
存在すると、幅200px・高さ200pxに収まるサイズ以下のwebpが応答される。
#### badge
Webプッシュ通知のバッジに適したpngが応答される。
https://developer.mozilla.org/ja/docs/Web/API/Notification/badge
サイズは96x96で、元画像がアルファチャンネルのみで表現される。

BIN
assets/dummy.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.1 KiB

View File

@ -30,6 +30,10 @@ export const FILE_TYPE_BROWSERSAFE = [
'video/webm',
'audio/webm',
'audio/aac',
// see https://github.com/misskey-dev/misskey/pull/10686
'audio/flac',
'audio/wav',
// backward compatibility
'audio/x-flac',
'audio/vnd.wave',
];

8
built/download.d.ts vendored
View File

@ -1,5 +1,5 @@
/// <reference types="node" />
/// <reference types="node" />
/// <reference types="node" resolution-mode="require"/>
/// <reference types="node" resolution-mode="require"/>
import * as http from 'node:http';
import * as https from 'node:https';
export type DownloadConfig = {
@ -19,4 +19,6 @@ export declare const defaultDownloadConfig: {
maxSize: number;
proxy: boolean;
};
export declare function downloadUrl(url: string, path: string, settings?: DownloadConfig): Promise<void>;
export declare function downloadUrl(url: string, path: string, settings?: DownloadConfig): Promise<{
filename: string;
}>;

View File

@ -1,11 +1,11 @@
import * as fs from 'node:fs';
import * as stream from 'node:stream';
import * as util from 'node:util';
import ipaddr from 'ipaddr.js';
import got, * as Got from 'got';
import IPCIDR from 'ip-cidr';
import PrivateIp from 'private-ip';
import { StatusError } from './status-error.js';
import { getAgents } from './http.js';
import { parse } from 'content-disposition';
const pipeline = util.promisify(stream.pipeline);
export const defaultDownloadConfig = {
userAgent: `MisskeyMediaProxy/0.0.0`,
@ -19,6 +19,8 @@ export async function downloadUrl(url, path, settings = defaultDownloadConfig) {
console.log(`Downloading ${url} to ${path} ...`);
const timeout = 30 * 1000;
const operationTimeout = 60 * 1000;
const urlObj = new URL(url);
let filename = urlObj.pathname.split('/').pop() ?? 'unknown';
const req = got.stream(url, {
headers: {
'User-Agent': settings.userAgent,
@ -56,6 +58,18 @@ export async function downloadUrl(url, path, settings = defaultDownloadConfig) {
req.destroy();
}
}
const contentDisposition = res.headers['content-disposition'];
if (contentDisposition != null) {
try {
const parsed = parse(contentDisposition);
if (parsed.parameters.filename) {
filename = parsed.parameters.filename;
}
}
catch (e) {
console.log(`Failed to parse content-disposition: ${contentDisposition}\n${e}`);
}
}
}).on('downloadProgress', (progress) => {
if (progress.transferred > settings.maxSize) {
console.log(`maxSize exceeded (${progress.transferred} > ${settings.maxSize}) on downloadProgress`);
@ -75,13 +89,16 @@ export async function downloadUrl(url, path, settings = defaultDownloadConfig) {
}
if (process.env.NODE_ENV !== 'production')
console.log(`Download finished: ${url}`);
return {
filename,
};
}
function isPrivateIp(ip, allowedPrivateNetworks) {
const parsedIp = ipaddr.parse(ip);
for (const net of allowedPrivateNetworks ?? []) {
const cidr = new IPCIDR(net);
if (cidr.contains(ip)) {
if (parsedIp.match(ipaddr.parseCIDR(net))) {
return false;
}
}
return PrivateIp(ip) ?? false;
return parsedIp.range() !== 'unicast';
}

View File

@ -30,7 +30,7 @@ export async function detectType(path) {
return TYPE_OCTET_STREAM;
}
return {
mime: type.mime,
mime: fixMime(type.mime),
ext: type.ext,
};
}
@ -46,7 +46,7 @@ async function checkSvg(path) {
const size = await getFileSize(path);
if (size > 1 * 1024 * 1024)
return false;
return isSvg(fs.readFileSync(path));
return isSvg(fs.readFileSync(path, { encoding: 'utf-8' }));
}
catch {
return false;
@ -55,7 +55,17 @@ async function checkSvg(path) {
import { FILE_TYPE_BROWSERSAFE } from './const.js';
const dictionary = {
'safe-file': FILE_TYPE_BROWSERSAFE,
'sharp-convertible-image': ['image/jpeg', 'image/png', 'image/gif', 'image/apng', 'image/vnd.mozilla.apng', 'image/webp', 'image/avif', 'image/svg+xml'],
'sharp-animation-convertible-image': ['image/jpeg', 'image/png', 'image/gif', 'image/webp', 'image/avif', 'image/svg+xml'],
'sharp-convertible-image': ['image/jpeg', 'image/png', 'image/gif', 'image/apng', 'image/vnd.mozilla.apng', 'image/webp', 'image/avif', 'image/svg+xml', 'image/x-icon', 'image/bmp'],
'sharp-animation-convertible-image': ['image/jpeg', 'image/png', 'image/gif', 'image/webp', 'image/avif', 'image/svg+xml', 'image/x-icon', 'image/bmp'],
};
export const isMimeImage = (mime, type) => dictionary[type].includes(mime);
function fixMime(mime) {
// see https://github.com/misskey-dev/misskey/pull/10686
if (mime === "audio/x-flac") {
return "audio/flac";
}
if (mime === "audio/vnd.wave") {
return "audio/wav";
}
return mime;
}

4
built/http.d.ts vendored
View File

@ -1,5 +1,5 @@
/// <reference types="node" />
/// <reference types="node" />
/// <reference types="node" resolution-mode="require"/>
/// <reference types="node" resolution-mode="require"/>
import * as http from 'node:http';
import * as https from 'node:https';
export declare function getAgents(proxy?: string): {

View File

@ -1,5 +1,5 @@
/// <reference types="node" />
/// <reference types="node" />
/// <reference types="node" resolution-mode="require"/>
/// <reference types="node" resolution-mode="require"/>
import sharp from 'sharp';
import { Readable } from 'node:stream';
export type IImage = {

View File

@ -1,11 +1,12 @@
import sharp from 'sharp';
export const webpDefault = {
quality: 85,
quality: 77,
alphaQuality: 95,
lossless: false,
nearLossless: false,
smartSubsample: true,
mixed: true,
effort: 2,
};
export function convertToWebpStream(path, width, height, options = webpDefault) {
return convertSharpToWebpStream(sharp(path), width, height, options);

4
built/index.d.ts vendored
View File

@ -1,5 +1,5 @@
/// <reference types="node" />
/// <reference types="node" />
/// <reference types="node" resolution-mode="require"/>
/// <reference types="node" resolution-mode="require"/>
import * as http from 'node:http';
import * as https from 'node:https';
import type { FastifyInstance } from 'fastify';

View File

@ -3,15 +3,18 @@ import { fileURLToPath } from 'node:url';
import { dirname } from 'node:path';
import fastifyStatic from '@fastify/static';
import { createTemp } from './create-temp.js';
import { convertToWebpStream, webpDefault } from './image-processor.js';
import { FILE_TYPE_BROWSERSAFE } from './const.js';
import { convertToWebpStream, webpDefault, convertSharpToWebpStream } from './image-processor.js';
import { detectType, isMimeImage } from './file-info.js';
import sharp from 'sharp';
import { sharpBmp } from 'sharp-read-bmp';
import { StatusError } from './status-error.js';
import { defaultDownloadConfig, downloadUrl } from './download.js';
import { getAgents } from './http.js';
import _contentDisposition from 'content-disposition';
const _filename = fileURLToPath(import.meta.url);
const _dirname = dirname(_filename);
const assets = `${_dirname}/../../server/file/assets/`;
const assets = `${_dirname}/../assets/`;
let config = defaultDownloadConfig;
export function setMediaProxyConfig(setting) {
const proxy = process.env.HTTP_PROXY ?? process.env.http_proxy;
@ -41,11 +44,14 @@ export function setMediaProxyConfig(setting) {
}
export default function (fastify, options, done) {
setMediaProxyConfig(options);
const corsOrigin = options['Access-Control-Allow-Origin'] ?? '*';
const corsHeader = options['Access-Control-Allow-Headers'] ?? '*';
const csp = options['Content-Security-Policy'] ?? `default-src 'none'; img-src 'self'; media-src 'self'; style-src 'unsafe-inline'`;
fastify.addHook('onRequest', (request, reply, done) => {
reply.header('Access-Control-Allow-Origin', options['Access-Control-Allow-Origin'] ?? '*');
reply.header('Access-Control-Allow-Headers', options['Access-Control-Allow-Headers'] ?? '*');
reply.header('Access-Control-Allow-Origin', corsOrigin);
reply.header('Access-Control-Allow-Headers', corsHeader);
reply.header('Access-Control-Allow-Methods', 'GET, OPTIONS');
reply.header('Content-Security-Policy', options['Content-Security-Policy'] ?? `default-src 'none'; img-src 'self'; media-src 'self'; style-src 'unsafe-inline'`);
reply.header('Content-Security-Policy', csp);
done();
});
fastify.register(fastifyStatic, {
@ -102,7 +108,7 @@ async function proxyHandler(request, reply) {
};
}
else {
const data = sharp(file.path, { animated: !('static' in request.query) })
const data = (await sharpBmp(file.path, file.mime, { animated: !('static' in request.query) }))
.resize({
height: 'emoji' in request.query ? 128 : 320,
withoutEnlargement: true,
@ -116,15 +122,16 @@ async function proxyHandler(request, reply) {
}
}
else if ('static' in request.query) {
image = convertToWebpStream(file.path, 498, 280);
image = convertSharpToWebpStream(await sharpBmp(file.path, file.mime), 498, 422);
}
else if ('preview' in request.query) {
image = convertToWebpStream(file.path, 200, 200);
image = convertSharpToWebpStream(await sharpBmp(file.path, file.mime), 200, 200);
}
else if ('badge' in request.query) {
const mask = sharp(file.path)
const mask = (await sharpBmp(file.path, file.mime))
.resize(96, 96, {
fit: 'inside',
fit: 'contain',
position: 'centre',
withoutEnlargement: false,
})
.greyscale()
@ -151,6 +158,9 @@ async function proxyHandler(request, reply) {
else if (file.mime === 'image/svg+xml') {
image = convertToWebpStream(file.path, 2048, 2048);
}
else if (!file.mime.startsWith('image/') || !FILE_TYPE_BROWSERSAFE.includes(file.mime)) {
throw new StatusError('Rejected type', 403, 'Rejected type');
}
if (!image) {
image = {
data: fs.createReadStream(file.path),
@ -175,6 +185,7 @@ async function proxyHandler(request, reply) {
}
reply.header('Content-Type', image.type);
reply.header('Cache-Control', 'max-age=31536000, immutable');
reply.header('Content-Disposition', contentDisposition('inline', correctFilename(file.filename, image.ext)));
return reply.send(image.data);
}
catch (e) {
@ -186,12 +197,13 @@ async function proxyHandler(request, reply) {
async function downloadAndDetectTypeFromUrl(url) {
const [path, cleanup] = await createTemp();
try {
await downloadUrl(url, path, config);
const { filename } = await downloadUrl(url, path, config);
const { mime, ext } = await detectType(path);
return {
state: 'remote',
mime, ext,
path, cleanup,
filename: correctFilename(filename, ext),
};
}
catch (e) {
@ -199,3 +211,20 @@ async function downloadAndDetectTypeFromUrl(url) {
throw e;
}
}
function correctFilename(filename, ext) {
const dotExt = ext ? `.${ext}` : '.unknown';
if (filename.endsWith(dotExt)) {
return filename;
}
if (ext === 'jpg' && filename.endsWith('.jpeg')) {
return filename;
}
if (ext === 'tif' && filename.endsWith('.tiff')) {
return filename;
}
return `${filename}${dotExt}`;
}
function contentDisposition(type, filename) {
const fallback = filename.replace(/[^\w.-]/g, '_');
return _contentDisposition(filename, { type, fallback });
}

View File

@ -1,9 +1,9 @@
{
"name": "misskey-media-proxy",
"version": "0.0.11",
"version": "0.0.23",
"description": "The Media Proxy for Misskey",
"main": "built/index.js",
"packageManager": "pnpm@7.26.0",
"packageManager": "pnpm@8.7.5",
"type": "module",
"files": [
"built",
@ -26,25 +26,28 @@
},
"homepage": "https://github.com/misskey-dev/media-proxy#readme",
"devDependencies": {
"@swc/cli": "^0.1.61",
"@swc/core": "^1.3.32",
"@types/node": "^18.11.19",
"@types/sharp": "^0.31.1",
"@types/tmp": "^0.2.3",
"typescript": "^4.9.5"
"@swc/cli": "^0.1.62",
"@swc/core": "^1.3.86",
"@types/content-disposition": "^0.5.6",
"@types/node": "^20.6.3",
"@types/tmp": "^0.2.4",
"typescript": "^5.2.2"
},
"dependencies": {
"@fastify/static": "^6.8.0",
"@fastify/static": "^6.11.2",
"cacheable-lookup": "^7.0.0",
"fastify": "^4.12.0",
"fastify-cli": "^5.7.1",
"file-type": "^18.2.0",
"got": "^12.5.3",
"content-disposition": "^0.5.4",
"fastify": "^4.23.2",
"fastify-cli": "^5.8.0",
"file-type": "^18.5.0",
"got": "^13.0.0",
"hpagent": "^1.2.0",
"ip-cidr": "^3.1.0",
"is-svg": "^4.3.2",
"private-ip": "^3.0.0",
"sharp": "^0.31.3",
"ipaddr.js": "^2.1.0",
"is-svg": "^5.0.0",
"private-ip": "^3.0.1",
"sharp": "^0.32.6",
"sharp-read-bmp": "github:misskey-dev/sharp-read-bmp",
"tmp": "^0.2.1"
}
}

1149
pnpm-lock.yaml generated

File diff suppressed because it is too large Load Diff

View File

@ -36,6 +36,11 @@ export const FILE_TYPE_BROWSERSAFE = [
'audio/webm',
'audio/aac',
// see https://github.com/misskey-dev/misskey/pull/10686
'audio/flac',
'audio/wav',
// backward compatibility
'audio/x-flac',
'audio/vnd.wave',
];

View File

@ -3,11 +3,11 @@ import * as stream from 'node:stream';
import * as util from 'node:util';
import * as http from 'node:http';
import * as https from 'node:https';
import ipaddr from 'ipaddr.js';
import got, * as Got from 'got';
import IPCIDR from 'ip-cidr';
import PrivateIp from 'private-ip';
import { StatusError } from './status-error.js';
import { getAgents } from './http.js';
import { parse } from 'content-disposition';
const pipeline = util.promisify(stream.pipeline);
@ -29,12 +29,17 @@ export const defaultDownloadConfig = {
...getAgents()
}
export async function downloadUrl(url: string, path: string, settings:DownloadConfig = defaultDownloadConfig): Promise<void> {
export async function downloadUrl(url: string, path: string, settings:DownloadConfig = defaultDownloadConfig): Promise<{
filename: string;
}> {
if (process.env.NODE_ENV !== 'production') console.log(`Downloading ${url} to ${path} ...`);
const timeout = 30 * 1000;
const operationTimeout = 60 * 1000;
const urlObj = new URL(url);
let filename = urlObj.pathname.split('/').pop() ?? 'unknown';
const req = got.stream(url, {
headers: {
'User-Agent': settings.userAgent,
@ -73,6 +78,18 @@ export async function downloadUrl(url: string, path: string, settings:DownloadCo
req.destroy();
}
}
const contentDisposition = res.headers['content-disposition'];
if (contentDisposition != null) {
try {
const parsed = parse(contentDisposition);
if (parsed.parameters.filename) {
filename = parsed.parameters.filename;
}
} catch (e) {
console.log(`Failed to parse content-disposition: ${contentDisposition}\n${e}`);
}
}
}).on('downloadProgress', (progress: Got.Progress) => {
if (progress.transferred > settings.maxSize) {
console.log(`maxSize exceeded (${progress.transferred} > ${settings.maxSize}) on downloadProgress`);
@ -91,15 +108,20 @@ export async function downloadUrl(url: string, path: string, settings:DownloadCo
}
if (process.env.NODE_ENV !== 'production') console.log(`Download finished: ${url}`);
return {
filename,
}
}
function isPrivateIp(ip: string, allowedPrivateNetworks: string[]): boolean {
const parsedIp = ipaddr.parse(ip);
for (const net of allowedPrivateNetworks ?? []) {
const cidr = new IPCIDR(net);
if (cidr.contains(ip)) {
if (parsedIp.match(ipaddr.parseCIDR(net))) {
return false;
}
}
return PrivateIp(ip) ?? false;
return parsedIp.range() !== 'unicast';
}

View File

@ -1,5 +1,6 @@
import fs from 'node:fs';
import { fileTypeFromFile } from 'file-type';
import type { MimeType } from 'file-type';
import isSvg from 'is-svg';
import { promisify } from 'node:util';
@ -39,7 +40,7 @@ export async function detectType(path: string): Promise<{
}
return {
mime: type.mime,
mime: fixMime(type.mime),
ext: type.ext,
};
}
@ -56,7 +57,7 @@ async function checkSvg(path: string) {
try {
const size = await getFileSize(path);
if (size > 1 * 1024 * 1024) return false;
return isSvg(fs.readFileSync(path));
return isSvg(fs.readFileSync(path, { encoding: 'utf-8' }));
} catch {
return false;
}
@ -66,8 +67,20 @@ import { FILE_TYPE_BROWSERSAFE } from './const.js';
const dictionary = {
'safe-file': FILE_TYPE_BROWSERSAFE,
'sharp-convertible-image': ['image/jpeg', 'image/png', 'image/gif', 'image/apng', 'image/vnd.mozilla.apng', 'image/webp', 'image/avif', 'image/svg+xml'],
'sharp-animation-convertible-image': ['image/jpeg', 'image/png', 'image/gif', 'image/webp', 'image/avif', 'image/svg+xml'],
'sharp-convertible-image': ['image/jpeg', 'image/png', 'image/gif', 'image/apng', 'image/vnd.mozilla.apng', 'image/webp', 'image/avif', 'image/svg+xml', 'image/x-icon', 'image/bmp'],
'sharp-animation-convertible-image': ['image/jpeg', 'image/png', 'image/gif', 'image/webp', 'image/avif', 'image/svg+xml', 'image/x-icon', 'image/bmp'],
};
export const isMimeImage = (mime: string, type: keyof typeof dictionary): boolean => dictionary[type].includes(mime);
function fixMime(mime: string | MimeType): string {
// see https://github.com/misskey-dev/misskey/pull/10686
if (mime === "audio/x-flac") {
return "audio/flac";
}
if (mime === "audio/vnd.wave") {
return "audio/wav";
}
return mime;
}

View File

@ -2,6 +2,7 @@ import * as http from 'node:http';
import * as https from 'node:https';
import CacheableLookup from 'cacheable-lookup';
import { HttpProxyAgent, HttpsProxyAgent } from 'hpagent';
import { LookupFunction } from 'node:net';
const cache = new CacheableLookup({
maxTtl: 3600, // 1hours
@ -12,13 +13,13 @@ const cache = new CacheableLookup({
const _http = new http.Agent({
keepAlive: true,
keepAliveMsecs: 30 * 1000,
lookup: cache.lookup,
lookup: cache.lookup as unknown as LookupFunction,
} as http.AgentOptions);
const _https = new https.Agent({
keepAlive: true,
keepAliveMsecs: 30 * 1000,
lookup: cache.lookup,
lookup: cache.lookup as unknown as LookupFunction,
} as https.AgentOptions);
export function getAgents(proxy?: string) {

View File

@ -16,12 +16,13 @@ export type IImageStream = {
export type IImageStreamable = IImage | IImageStream;
export const webpDefault: sharp.WebpOptions = {
quality: 85,
quality: 77,
alphaQuality: 95,
lossless: false,
nearLossless: false,
smartSubsample: true,
mixed: true,
effort: 2,
};
export function convertToWebpStream(path: string, width: number, height: number, options: sharp.WebpOptions = webpDefault): IImageStream {

View File

@ -6,18 +6,20 @@ import { dirname } from 'node:path';
import fastifyStatic from '@fastify/static';
import { createTemp } from './create-temp.js';
import { FILE_TYPE_BROWSERSAFE } from './const.js';
import { IImageStreamable, convertToWebpStream, webpDefault } from './image-processor.js';
import { IImageStreamable, convertToWebpStream, webpDefault, convertSharpToWebpStream } from './image-processor.js';
import type { FastifyInstance, FastifyRequest, FastifyReply, FastifyPluginOptions } from 'fastify';
import { detectType, isMimeImage } from './file-info.js';
import sharp from 'sharp';
import { sharpBmp } from 'sharp-read-bmp';
import { StatusError } from './status-error.js';
import { DownloadConfig, defaultDownloadConfig, downloadUrl } from './download.js';
import { getAgents } from './http.js';
import _contentDisposition from 'content-disposition';
const _filename = fileURLToPath(import.meta.url);
const _dirname = dirname(_filename);
const assets = `${_dirname}/../../server/file/assets/`;
const assets = `${_dirname}/../assets/`;
export type MediaProxyOptions = {
['Access-Control-Allow-Origin']?: string;
@ -68,11 +70,15 @@ export function setMediaProxyConfig(setting?: MediaProxyOptions | null) {
export default function (fastify: FastifyInstance, options: MediaProxyOptions | null | undefined, done: (err?: Error) => void) {
setMediaProxyConfig(options);
const corsOrigin = options!['Access-Control-Allow-Origin'] ?? '*';
const corsHeader = options!['Access-Control-Allow-Headers'] ?? '*';
const csp = options!['Content-Security-Policy'] ?? `default-src 'none'; img-src 'self'; media-src 'self'; style-src 'unsafe-inline'`;
fastify.addHook('onRequest', (request, reply, done) => {
reply.header('Access-Control-Allow-Origin', options!['Access-Control-Allow-Origin'] ?? '*');
reply.header('Access-Control-Allow-Headers', options!['Access-Control-Allow-Headers'] ?? '*');
reply.header('Access-Control-Allow-Origin', corsOrigin);
reply.header('Access-Control-Allow-Headers', corsHeader);
reply.header('Access-Control-Allow-Methods', 'GET, OPTIONS');
reply.header('Content-Security-Policy', options!['Content-Security-Policy'] ?? `default-src 'none'; img-src 'self'; media-src 'self'; style-src 'unsafe-inline'`);
reply.header('Content-Security-Policy', csp);
done();
});
@ -148,12 +154,12 @@ async function proxyHandler(request: FastifyRequest<{ Params: { url: string; };
type: file.mime,
};
} else {
const data = sharp(file.path, { animated: !('static' in request.query) })
.resize({
height: 'emoji' in request.query ? 128 : 320,
withoutEnlargement: true,
})
.webp(webpDefault);
const data = (await sharpBmp(file.path, file.mime, { animated: !('static' in request.query) }))
.resize({
height: 'emoji' in request.query ? 128 : 320,
withoutEnlargement: true,
})
.webp(webpDefault);
image = {
data,
@ -162,13 +168,14 @@ async function proxyHandler(request: FastifyRequest<{ Params: { url: string; };
};
}
} else if ('static' in request.query) {
image = convertToWebpStream(file.path, 498, 280);
image = convertSharpToWebpStream(await sharpBmp(file.path, file.mime), 498, 422);
} else if ('preview' in request.query) {
image = convertToWebpStream(file.path, 200, 200);
image = convertSharpToWebpStream(await sharpBmp(file.path, file.mime), 200, 200);
} else if ('badge' in request.query) {
const mask = sharp(file.path)
const mask = (await sharpBmp(file.path, file.mime))
.resize(96, 96, {
fit: 'inside',
fit: 'contain',
position: 'centre',
withoutEnlargement: false,
})
.greyscale()
@ -197,6 +204,8 @@ async function proxyHandler(request: FastifyRequest<{ Params: { url: string; };
};
} else if (file.mime === 'image/svg+xml') {
image = convertToWebpStream(file.path, 2048, 2048);
} else if (!file.mime.startsWith('image/') || !FILE_TYPE_BROWSERSAFE.includes(file.mime)) {
throw new StatusError('Rejected type', 403, 'Rejected type');
}
if (!image) {
@ -224,6 +233,12 @@ async function proxyHandler(request: FastifyRequest<{ Params: { url: string; };
reply.header('Content-Type', image.type);
reply.header('Cache-Control', 'max-age=31536000, immutable');
reply.header('Content-Disposition',
contentDisposition(
'inline',
correctFilename(file.filename, image.ext)
)
);
return reply.send(image.data);
} catch (e) {
if ('cleanup' in file) file.cleanup();
@ -232,11 +247,11 @@ async function proxyHandler(request: FastifyRequest<{ Params: { url: string; };
}
async function downloadAndDetectTypeFromUrl(url: string): Promise<
{ state: 'remote'; mime: string; ext: string | null; path: string; cleanup: () => void; }
{ state: 'remote'; mime: string; ext: string | null; path: string; cleanup: () => void; filename: string; }
> {
const [path, cleanup] = await createTemp();
try {
await downloadUrl(url, path, config);
const { filename } = await downloadUrl(url, path, config);
const { mime, ext } = await detectType(path);
@ -244,9 +259,29 @@ async function downloadAndDetectTypeFromUrl(url: string): Promise<
state: 'remote',
mime, ext,
path, cleanup,
filename: correctFilename(filename, ext),
}
} catch (e) {
cleanup();
throw e;
}
}
function correctFilename(filename: string, ext: string | null) {
const dotExt = ext ? `.${ext}` : '.unknown';
if (filename.endsWith(dotExt)) {
return filename;
}
if (ext === 'jpg' && filename.endsWith('.jpeg')) {
return filename;
}
if (ext === 'tif' && filename.endsWith('.tiff')) {
return filename;
}
return `${filename}${dotExt}`;
}
function contentDisposition(type: 'inline' | 'attachment', filename: string): string {
const fallback = filename.replace(/[^\w.-]/g, '_');
return _contentDisposition(filename, { type, fallback });
}

View File

@ -10,8 +10,8 @@
"declaration": true,
"sourceMap": false,
"target": "es2021",
"module": "esnext",
"moduleResolution": "node",
"module": "nodenext",
"moduleResolution": "nodenext",
"allowSyntheticDefaultImports": true,
"removeComments": false,
"noLib": false,
@ -36,6 +36,7 @@
],
"typeRoots": [
"./node_modules/@types",
"./node_modules",
"./src/@types"
],
"lib": [