@orpc/server 2.0.0-beta.49 → 2.0.0-beta.50
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/adapters/aws-lambda/handler.d.ts +17 -15
- package/dist/adapters/aws-lambda/handler.js +23 -23
- package/dist/adapters/aws-lambda/index.d.ts +4 -16
- package/dist/adapters/aws-lambda/index.js +2 -2
- package/dist/adapters/aws-lambda/rpc-handler.d.ts +9 -9
- package/dist/adapters/aws-lambda/rpc-handler.js +20 -17
- package/dist/adapters/crossws/handler.d.ts +44 -42
- package/dist/adapters/crossws/handler.js +53 -60
- package/dist/adapters/crossws/index.d.ts +3 -2
- package/dist/adapters/crossws/index.js +2 -2
- package/dist/adapters/crossws/rpc-handler.d.ts +10 -10
- package/dist/adapters/crossws/rpc-handler.js +17 -14
- package/dist/adapters/fastify/handler.d.ts +17 -15
- package/dist/adapters/fastify/handler.js +20 -20
- package/dist/adapters/fastify/index.d.ts +3 -2
- package/dist/adapters/fastify/index.js +2 -2
- package/dist/adapters/fastify/rpc-handler.d.ts +9 -9
- package/dist/adapters/fastify/rpc-handler.js +16 -13
- package/dist/adapters/fetch/handler.d.ts +19 -17
- package/dist/adapters/fetch/handler.js +22 -22
- package/dist/adapters/fetch/index.d.ts +4 -7
- package/dist/adapters/fetch/index.js +3 -7
- package/dist/adapters/fetch/rpc-handler.d.ts +9 -9
- package/dist/adapters/fetch/rpc-handler.js +18 -15
- package/dist/adapters/message-port/handler.d.ts +58 -60
- package/dist/adapters/message-port/handler.js +72 -86
- package/dist/adapters/message-port/index.d.ts +3 -2
- package/dist/adapters/message-port/index.js +2 -2
- package/dist/adapters/message-port/rpc-handler.d.ts +9 -9
- package/dist/adapters/message-port/rpc-handler.js +17 -14
- package/dist/adapters/node/handler.d.ts +17 -15
- package/dist/adapters/node/handler.js +20 -20
- package/dist/adapters/node/index.d.ts +4 -7
- package/dist/adapters/node/index.js +3 -7
- package/dist/adapters/node/rpc-handler.d.ts +9 -9
- package/dist/adapters/node/rpc-handler.js +17 -14
- package/dist/adapters/standard/codec.d.ts +13 -13
- package/dist/adapters/standard/handler.d.ts +49 -49
- package/dist/adapters/standard/handler.js +205 -205
- package/dist/adapters/standard/index.d.ts +7 -6
- package/dist/adapters/standard/index.js +4 -5
- package/dist/adapters/standard/plugin.d.ts +25 -31
- package/dist/adapters/standard/plugin.js +14 -16
- package/dist/adapters/standard/rpc-handler-codec.d.ts +39 -43
- package/dist/adapters/standard/rpc-handler-codec.js +50 -51
- package/dist/adapters/standard/rpc-matcher.d.ts +40 -40
- package/dist/adapters/standard/rpc-matcher.js +103 -149
- package/dist/adapters/standard/utils.d.ts +8 -8
- package/dist/adapters/standard/utils.js +7 -5
- package/dist/adapters/standard-peer/index.d.ts +2 -1
- package/dist/adapters/standard-peer/index.js +1 -1
- package/dist/adapters/standard-peer/utils.d.ts +6 -4
- package/dist/adapters/standard-peer/utils.js +12 -6
- package/dist/adapters/websocket/handler.d.ts +52 -50
- package/dist/adapters/websocket/handler.js +75 -85
- package/dist/adapters/websocket/index.d.ts +3 -2
- package/dist/adapters/websocket/index.js +2 -2
- package/dist/adapters/websocket/rpc-handler.d.ts +9 -9
- package/dist/adapters/websocket/rpc-handler.js +17 -14
- package/dist/builder-variants.d.ts +195 -195
- package/dist/builder.d.ts +103 -104
- package/dist/builder.js +198 -224
- package/dist/constants.d.ts +1 -1
- package/dist/constants.js +4 -2
- package/dist/context.d.ts +3 -3
- package/dist/extensions/callable.d.ts +11 -11
- package/dist/extensions/callable.js +6 -5
- package/dist/helpers/base64url.d.ts +1 -1
- package/dist/helpers/base64url.js +44 -49
- package/dist/helpers/cookie.d.ts +10 -11
- package/dist/helpers/cookie.js +56 -63
- package/dist/helpers/encryption.d.ts +1 -1
- package/dist/helpers/encryption.js +80 -70
- package/dist/helpers/index.d.ts +5 -4
- package/dist/helpers/index.js +4 -4
- package/dist/helpers/signing.d.ts +1 -1
- package/dist/helpers/signing.js +72 -82
- package/dist/implementer-procedure.d.ts +12 -13
- package/dist/implementer-procedure.js +37 -44
- package/dist/implementer-router.d.ts +30 -36
- package/dist/implementer-router.js +92 -111
- package/dist/implementer.d.ts +8 -8
- package/dist/implementer.js +28 -35
- package/dist/index.d.ts +22 -61
- package/dist/index.js +16 -48
- package/dist/lazy.d.ts +14 -14
- package/dist/lazy.js +19 -30
- package/dist/middleware-decorated.d.ts +8 -9
- package/dist/middleware-decorated.js +66 -70
- package/dist/middleware.d.ts +34 -34
- package/dist/plugins/batch.d.ts +75 -75
- package/dist/plugins/batch.js +345 -379
- package/dist/plugins/cors.d.ts +60 -64
- package/dist/plugins/cors.js +118 -111
- package/dist/plugins/get-method-csrf-protection.d.ts +8 -6
- package/dist/plugins/get-method-csrf-protection.js +47 -63
- package/dist/plugins/head-method.d.ts +11 -9
- package/dist/plugins/head-method.js +97 -94
- package/dist/plugins/index.d.ts +15 -39
- package/dist/plugins/index.js +14 -29
- package/dist/plugins/method-override.d.ts +30 -28
- package/dist/plugins/method-override.js +53 -49
- package/dist/plugins/request-compression.d.ts +11 -9
- package/dist/plugins/request-compression.js +52 -79
- package/dist/plugins/request-headers.d.ts +10 -8
- package/dist/plugins/request-headers.js +27 -29
- package/dist/plugins/request-limit.d.ts +21 -19
- package/dist/plugins/request-limit.js +60 -67
- package/dist/plugins/response-compression.d.ts +42 -39
- package/dist/plugins/response-compression.js +150 -202
- package/dist/plugins/response-headers.d.ts +15 -13
- package/dist/plugins/response-headers.js +43 -46
- package/dist/plugins/rethrow.d.ts +25 -23
- package/dist/plugins/rethrow.js +46 -58
- package/dist/plugins/signal-sync.d.ts +7 -5
- package/dist/plugins/signal-sync.js +71 -86
- package/dist/plugins/timeout.d.ts +29 -27
- package/dist/plugins/timeout.js +61 -58
- package/dist/procedure-client.d.ts +14 -15
- package/dist/procedure-client.js +149 -166
- package/dist/procedure-decorated.d.ts +9 -9
- package/dist/procedure-decorated.js +36 -44
- package/dist/procedure-utils.d.ts +10 -30
- package/dist/procedure-utils.js +39 -40
- package/dist/procedure.d.ts +60 -60
- package/dist/procedure.js +18 -24
- package/dist/router-client.d.ts +9 -11
- package/dist/router-client.js +33 -41
- package/dist/router-hidden.js +10 -12
- package/dist/router-utils.d.ts +13 -30
- package/dist/router-utils.js +146 -191
- package/dist/router.d.ts +12 -26
- package/package.json +10 -10
- package/dist/adapters/standard/codec.js +0 -1
- package/dist/builder-variants.js +0 -1
- package/dist/context.js +0 -1
- package/dist/middleware.js +0 -1
- package/dist/router-hidden.d.ts +0 -5
- package/dist/router.js +0 -1
package/dist/plugins/cors.d.ts
CHANGED
|
@@ -1,56 +1,52 @@
|
|
|
1
|
-
import
|
|
2
|
-
import
|
|
3
|
-
import
|
|
1
|
+
import "../adapters/standard/index.js";
|
|
2
|
+
import { StandardHandlerPlugin } from "../adapters/standard/plugin.js";
|
|
3
|
+
import { StandardHandlerOptions, StandardHandlerRoutingInterceptorOptions } from "../adapters/standard/handler.js";
|
|
4
|
+
import { Context } from "../context.js";
|
|
5
|
+
import { Promisable, Value } from "@orpc/shared";
|
|
4
6
|
export interface CORSHandlerPluginOptions<T extends Context> {
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
*/
|
|
49
|
-
credentials?: boolean | undefined;
|
|
50
|
-
/**
|
|
51
|
-
* Configures the `Access-Control-Expose-Headers` header.
|
|
52
|
-
*/
|
|
53
|
-
exposeHeaders?: readonly string[] | undefined;
|
|
7
|
+
/**
|
|
8
|
+
* Configures the `Access-Control-Allow-Origin` header.
|
|
9
|
+
* Can be a string, an array of allowed origins, or a function (optionally async) that returns the allowed origin(s).
|
|
10
|
+
*
|
|
11
|
+
* A function must only return origins it has validated: returning the incoming origin
|
|
12
|
+
* unchecked allows every origin.
|
|
13
|
+
*
|
|
14
|
+
* @default '*'
|
|
15
|
+
*/
|
|
16
|
+
origin?: Value<Promisable<string | readonly string[] | null | undefined>, [origin: string, options: StandardHandlerRoutingInterceptorOptions<T>]> | undefined;
|
|
17
|
+
/**
|
|
18
|
+
* Configures the `Timing-Allow-Origin` header.
|
|
19
|
+
* Can be a string, an array of allowed origins, or a function (optionally async) that returns the allowed origin(s).
|
|
20
|
+
*/
|
|
21
|
+
timingOrigin?: Value<Promisable<string | readonly string[] | null | undefined>, [origin: string, options: StandardHandlerRoutingInterceptorOptions<T>]> | undefined;
|
|
22
|
+
/**
|
|
23
|
+
* Configures the `Access-Control-Allow-Methods` header for preflight requests.
|
|
24
|
+
*
|
|
25
|
+
* @default ['GET', 'HEAD', 'PUT', 'POST', 'DELETE', 'PATCH', 'QUERY']
|
|
26
|
+
*/
|
|
27
|
+
allowMethods?: readonly string[] | undefined;
|
|
28
|
+
/**
|
|
29
|
+
* Configures the `Access-Control-Allow-Headers` header for preflight requests.
|
|
30
|
+
* Falls back to the request's `Access-Control-Request-Headers` if not set.
|
|
31
|
+
* When set, it replaces that fallback, so include every non-safelisted header
|
|
32
|
+
* clients send, such as `Content-Type`.
|
|
33
|
+
*/
|
|
34
|
+
allowHeaders?: readonly string[] | undefined;
|
|
35
|
+
/**
|
|
36
|
+
* Configures the `Access-Control-Max-Age` header (in seconds) for preflight requests.
|
|
37
|
+
*/
|
|
38
|
+
maxAge?: number | undefined;
|
|
39
|
+
/**
|
|
40
|
+
* Configures the `Access-Control-Allow-Credentials` header.
|
|
41
|
+
*
|
|
42
|
+
* When enabled, `origin` must allow trusted origins only: every allowed origin can send
|
|
43
|
+
* authenticated requests as your users and read the responses.
|
|
44
|
+
*/
|
|
45
|
+
credentials?: boolean | undefined;
|
|
46
|
+
/**
|
|
47
|
+
* Configures the `Access-Control-Expose-Headers` header.
|
|
48
|
+
*/
|
|
49
|
+
exposeHeaders?: readonly string[] | undefined;
|
|
54
50
|
}
|
|
55
51
|
/**
|
|
56
52
|
* Configures the [CORS Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)
|
|
@@ -59,15 +55,15 @@ export interface CORSHandlerPluginOptions<T extends Context> {
|
|
|
59
55
|
* @see {@link https://orpc.dev/docs/plugins/cors | CORS Handler Plugin}
|
|
60
56
|
*/
|
|
61
57
|
export declare class CORSHandlerPlugin<T extends Context> implements StandardHandlerPlugin<T> {
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
}
|
|
58
|
+
private readonly options;
|
|
59
|
+
name: string;
|
|
60
|
+
/**
|
|
61
|
+
* - Do not create spans for CORS preflight requests.
|
|
62
|
+
* - Run CORS interceptors before batch interceptors so headers are applied to
|
|
63
|
+
* the actual response rather than sub-responses.
|
|
64
|
+
*/
|
|
65
|
+
after: string[];
|
|
66
|
+
constructor(options?: CORSHandlerPluginOptions<T>);
|
|
67
|
+
init(options: StandardHandlerOptions<T>): StandardHandlerOptions<T>;
|
|
68
|
+
private resolveOrigin;
|
|
69
|
+
}
|
package/dist/plugins/cors.js
CHANGED
|
@@ -1,112 +1,119 @@
|
|
|
1
|
-
import { toArray } from
|
|
2
|
-
import { flattenStandardHeader } from
|
|
1
|
+
import { toArray } from "@orpc/shared";
|
|
2
|
+
import { flattenStandardHeader } from "@standard-server/core";
|
|
3
|
+
// src/plugins/cors.ts
|
|
3
4
|
/**
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
5
|
+
* Configures the [CORS Policy](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)
|
|
6
|
+
* for your API, including preflight requests.
|
|
7
|
+
*
|
|
8
|
+
* @see {@link https://orpc.dev/docs/plugins/cors | CORS Handler Plugin}
|
|
9
|
+
*/
|
|
10
|
+
var CORSHandlerPlugin = class {
|
|
11
|
+
options;
|
|
12
|
+
name = "~cors";
|
|
13
|
+
/**
|
|
14
|
+
* - Do not create spans for CORS preflight requests.
|
|
15
|
+
* - Run CORS interceptors before batch interceptors so headers are applied to
|
|
16
|
+
* the actual response rather than sub-responses.
|
|
17
|
+
*/
|
|
18
|
+
after = ["~tracing", "~batch"];
|
|
19
|
+
constructor(options = {}) {
|
|
20
|
+
const defaults = {
|
|
21
|
+
origin: "*",
|
|
22
|
+
allowMethods: [
|
|
23
|
+
"GET",
|
|
24
|
+
"HEAD",
|
|
25
|
+
"PUT",
|
|
26
|
+
"POST",
|
|
27
|
+
"DELETE",
|
|
28
|
+
"PATCH",
|
|
29
|
+
"QUERY"
|
|
30
|
+
]
|
|
31
|
+
};
|
|
32
|
+
this.options = {
|
|
33
|
+
...defaults,
|
|
34
|
+
...options
|
|
35
|
+
};
|
|
36
|
+
}
|
|
37
|
+
init(options) {
|
|
38
|
+
const corsHeadersInterceptor = async (interceptorOptions) => {
|
|
39
|
+
const result = await interceptorOptions.next();
|
|
40
|
+
if (!result.matched) return result;
|
|
41
|
+
const resHeaders = { ...result.response.headers };
|
|
42
|
+
const origin = flattenStandardHeader(interceptorOptions.request.headers.origin);
|
|
43
|
+
const allowOrigin = await this.resolveOrigin(this.options.origin, origin, interceptorOptions);
|
|
44
|
+
const timingAllowOrigin = await this.resolveOrigin(this.options.timingOrigin, origin, interceptorOptions);
|
|
45
|
+
if (allowOrigin.value !== void 0) resHeaders["access-control-allow-origin"] = allowOrigin.value;
|
|
46
|
+
if (timingAllowOrigin.value !== void 0) resHeaders["timing-allow-origin"] = timingAllowOrigin.value;
|
|
47
|
+
if (allowOrigin.varies || timingAllowOrigin.varies) {
|
|
48
|
+
const existingVary = flattenStandardHeader(resHeaders.vary);
|
|
49
|
+
if (!existingVary?.split(",").some((v) => v.trim().toLowerCase() === "origin")) resHeaders.vary = existingVary ? `${existingVary}, Origin` : "Origin";
|
|
50
|
+
}
|
|
51
|
+
if (this.options.credentials) resHeaders["access-control-allow-credentials"] = "true";
|
|
52
|
+
if (this.options.exposeHeaders?.length) resHeaders["access-control-expose-headers"] = flattenStandardHeader(this.options.exposeHeaders);
|
|
53
|
+
return {
|
|
54
|
+
...result,
|
|
55
|
+
response: {
|
|
56
|
+
...result.response,
|
|
57
|
+
headers: resHeaders
|
|
58
|
+
}
|
|
59
|
+
};
|
|
60
|
+
};
|
|
61
|
+
const preflightInterceptor = async (interceptorOptions) => {
|
|
62
|
+
if (interceptorOptions.request.method === "OPTIONS") {
|
|
63
|
+
const resHeaders = {};
|
|
64
|
+
if (this.options.maxAge !== void 0) resHeaders["access-control-max-age"] = this.options.maxAge.toString();
|
|
65
|
+
if (this.options.allowMethods?.length) resHeaders["access-control-allow-methods"] = flattenStandardHeader(this.options.allowMethods);
|
|
66
|
+
const allowHeaders = this.options.allowHeaders ?? interceptorOptions.request.headers["access-control-request-headers"];
|
|
67
|
+
if (typeof allowHeaders === "string" || allowHeaders?.length) resHeaders["access-control-allow-headers"] = flattenStandardHeader(allowHeaders);
|
|
68
|
+
return {
|
|
69
|
+
matched: true,
|
|
70
|
+
response: {
|
|
71
|
+
status: 204,
|
|
72
|
+
headers: resHeaders,
|
|
73
|
+
body: void 0
|
|
74
|
+
}
|
|
75
|
+
};
|
|
76
|
+
}
|
|
77
|
+
return interceptorOptions.next();
|
|
78
|
+
};
|
|
79
|
+
return {
|
|
80
|
+
...options,
|
|
81
|
+
routingInterceptors: [
|
|
82
|
+
corsHeadersInterceptor,
|
|
83
|
+
preflightInterceptor,
|
|
84
|
+
...toArray(options.routingInterceptors)
|
|
85
|
+
]
|
|
86
|
+
};
|
|
87
|
+
}
|
|
88
|
+
async resolveOrigin(option, origin, interceptorOptions) {
|
|
89
|
+
if (typeof option === "function") {
|
|
90
|
+
if (origin === void 0) return {
|
|
91
|
+
value: void 0,
|
|
92
|
+
varies: true
|
|
93
|
+
};
|
|
94
|
+
const allowed = toArray(await option(origin, interceptorOptions));
|
|
95
|
+
if (allowed.includes("*")) return {
|
|
96
|
+
value: "*",
|
|
97
|
+
varies: true
|
|
98
|
+
};
|
|
99
|
+
return {
|
|
100
|
+
value: allowed.includes(origin) ? origin : void 0,
|
|
101
|
+
varies: true
|
|
102
|
+
};
|
|
103
|
+
}
|
|
104
|
+
const allowed = toArray(await option);
|
|
105
|
+
if (allowed.includes("*")) return {
|
|
106
|
+
value: "*",
|
|
107
|
+
varies: false
|
|
108
|
+
};
|
|
109
|
+
if (origin !== void 0 && allowed.includes(origin)) return {
|
|
110
|
+
value: origin,
|
|
111
|
+
varies: true
|
|
112
|
+
};
|
|
113
|
+
return {
|
|
114
|
+
value: void 0,
|
|
115
|
+
varies: allowed.length > 0
|
|
116
|
+
};
|
|
117
|
+
}
|
|
118
|
+
};
|
|
119
|
+
export { CORSHandlerPlugin };
|
|
@@ -1,5 +1,7 @@
|
|
|
1
|
-
import
|
|
2
|
-
import
|
|
1
|
+
import "../adapters/standard/index.js";
|
|
2
|
+
import { StandardHandlerPlugin } from "../adapters/standard/plugin.js";
|
|
3
|
+
import { StandardHandlerOptions } from "../adapters/standard/handler.js";
|
|
4
|
+
import { Context } from "../context.js";
|
|
3
5
|
/**
|
|
4
6
|
* Adds Cross-Site Request Forgery (CSRF) protection that makes the safe `GET` method as
|
|
5
7
|
* secure as unsafe ones such as `POST`. It rejects `GET` requests arriving as top-level
|
|
@@ -17,7 +19,7 @@ import type { Context } from '../context.ts';
|
|
|
17
19
|
* @see {@link https://orpc.dev/docs/plugins/get-method-csrf-protection | GET Method CSRF Protection Plugin}
|
|
18
20
|
*/
|
|
19
21
|
export declare class GetMethodCsrfProtectionHandlerPlugin<T extends Context> implements StandardHandlerPlugin<T> {
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
}
|
|
22
|
+
name: string;
|
|
23
|
+
init(options: StandardHandlerOptions<T>): StandardHandlerOptions<T>;
|
|
24
|
+
private isAllowed;
|
|
25
|
+
}
|
|
@@ -1,64 +1,48 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import { flattenStandardHeader } from
|
|
1
|
+
import { toArray } from "@orpc/shared";
|
|
2
|
+
import { ORPCError } from "@orpc/client";
|
|
3
|
+
import { flattenStandardHeader } from "@standard-server/core";
|
|
4
|
+
// src/plugins/get-method-csrf-protection.ts
|
|
4
5
|
/**
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
// Same-site origins are trusted, matching the `SameSite` cookie model where the site is
|
|
49
|
-
// the trust boundary.
|
|
50
|
-
if (site === undefined || site === 'same-origin' || site === 'same-site') {
|
|
51
|
-
return true;
|
|
52
|
-
}
|
|
53
|
-
// Cross-site, and on browser-initiated requests such as email links, `Lax` cookies ride
|
|
54
|
-
// only top-level navigations: mode `navigate` targeting dest `document`. Embedded
|
|
55
|
-
// navigations such as `<iframe>` pass, since they are not top-level. Browsers send both
|
|
56
|
-
// headers together, so a stripped one blocks the request rather than bypassing the check.
|
|
57
|
-
const mode = flattenStandardHeader(request.headers['sec-fetch-mode'])?.toLowerCase();
|
|
58
|
-
const dest = flattenStandardHeader(request.headers['sec-fetch-dest'])?.toLowerCase();
|
|
59
|
-
if (mode === undefined || dest === undefined) {
|
|
60
|
-
return false;
|
|
61
|
-
}
|
|
62
|
-
return mode !== 'navigate' || dest !== 'document';
|
|
63
|
-
}
|
|
64
|
-
}
|
|
6
|
+
* Adds Cross-Site Request Forgery (CSRF) protection that makes the safe `GET` method as
|
|
7
|
+
* secure as unsafe ones such as `POST`. It rejects `GET` requests arriving as top-level
|
|
8
|
+
* navigations initiated cross-site or from outside the browser, the only context where
|
|
9
|
+
* another site can make a browser attach `SameSite=Lax` cookies to a safe-method request.
|
|
10
|
+
* Requests matching no procedure stay unmatched, so they can fall through to whatever
|
|
11
|
+
* serves the rest of the site.
|
|
12
|
+
*
|
|
13
|
+
* @remarks
|
|
14
|
+
* **Note**: Requests browsers send without `SameSite=Lax` cookies, such as cross-site `fetch`
|
|
15
|
+
* and `<img>`, pass through, so procedures stay reachable from other sites. This safeguard
|
|
16
|
+
* requires authentication cookies explicitly marked `SameSite=Lax` or `SameSite=Strict`,
|
|
17
|
+
* since browsers may attach other cookies to the requests that pass.
|
|
18
|
+
*
|
|
19
|
+
* @see {@link https://orpc.dev/docs/plugins/get-method-csrf-protection | GET Method CSRF Protection Plugin}
|
|
20
|
+
*/
|
|
21
|
+
var GetMethodCsrfProtectionHandlerPlugin = class {
|
|
22
|
+
name = "~get-method-csrf-protection";
|
|
23
|
+
init(options) {
|
|
24
|
+
/**
|
|
25
|
+
* Batch sub-requests are judged individually here, which is safe: navigations cannot
|
|
26
|
+
* carry the custom `orpc-batch` header, and the batch plugin's default `mapSubrequest`
|
|
27
|
+
* keeps the transport headers authoritative over client-authored sub-request headers.
|
|
28
|
+
*/
|
|
29
|
+
const interceptor = (interceptorOptions) => {
|
|
30
|
+
if (this.isAllowed(interceptorOptions)) return interceptorOptions.next();
|
|
31
|
+
throw new ORPCError("FORBIDDEN", { message: "Request blocked by CSRF protection." });
|
|
32
|
+
};
|
|
33
|
+
return {
|
|
34
|
+
...options,
|
|
35
|
+
interceptors: [interceptor, ...toArray(options.interceptors)]
|
|
36
|
+
};
|
|
37
|
+
}
|
|
38
|
+
isAllowed({ request }) {
|
|
39
|
+
if (request.method !== "GET") return true;
|
|
40
|
+
const site = flattenStandardHeader(request.headers["sec-fetch-site"])?.toLowerCase();
|
|
41
|
+
if (site === void 0 || site === "same-origin" || site === "same-site") return true;
|
|
42
|
+
const mode = flattenStandardHeader(request.headers["sec-fetch-mode"])?.toLowerCase();
|
|
43
|
+
const dest = flattenStandardHeader(request.headers["sec-fetch-dest"])?.toLowerCase();
|
|
44
|
+
if (mode === void 0 || dest === void 0) return false;
|
|
45
|
+
return mode !== "navigate" || dest !== "document";
|
|
46
|
+
}
|
|
47
|
+
};
|
|
48
|
+
export { GetMethodCsrfProtectionHandlerPlugin };
|
|
@@ -1,5 +1,7 @@
|
|
|
1
|
-
import
|
|
2
|
-
import
|
|
1
|
+
import "../adapters/standard/index.js";
|
|
2
|
+
import { StandardHandlerPlugin } from "../adapters/standard/plugin.js";
|
|
3
|
+
import { StandardHandlerOptions } from "../adapters/standard/handler.js";
|
|
4
|
+
import { Context } from "../context.js";
|
|
3
5
|
/**
|
|
4
6
|
* Answers `HEAD` requests with the headers of the matching `GET` procedure, like Fastify's
|
|
5
7
|
* `exposeHeadRoutes`, so clients can check a resource's existence, type, and size without
|
|
@@ -14,10 +16,10 @@ import type { Context } from '../context.ts';
|
|
|
14
16
|
* @see {@link https://orpc.dev/docs/plugins/head-method | HEAD Method Plugin}
|
|
15
17
|
*/
|
|
16
18
|
export declare class HeadMethodHandlerPlugin<T extends Context> implements StandardHandlerPlugin<T> {
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
}
|
|
19
|
+
name: string;
|
|
20
|
+
/**
|
|
21
|
+
* Discard the body after response compression, so `HEAD` reports the same `Content-Encoding` as `GET`.
|
|
22
|
+
*/
|
|
23
|
+
after: string[];
|
|
24
|
+
init(options: StandardHandlerOptions<T>): StandardHandlerOptions<T>;
|
|
25
|
+
}
|