@frontmcp/guard 0.0.1
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/LICENSE +201 -0
- package/README.md +395 -0
- package/concurrency/index.d.ts +2 -0
- package/concurrency/semaphore.d.ts +26 -0
- package/concurrency/types.d.ts +22 -0
- package/errors/errors.d.ts +54 -0
- package/errors/index.d.ts +1 -0
- package/esm/index.mjs +554 -0
- package/esm/package.json +61 -0
- package/index.d.ts +14 -0
- package/index.js +600 -0
- package/ip-filter/index.d.ts +2 -0
- package/ip-filter/ip-filter.d.ts +21 -0
- package/ip-filter/types.d.ts +29 -0
- package/manager/guard.factory.d.ts +15 -0
- package/manager/guard.manager.d.ts +47 -0
- package/manager/index.d.ts +3 -0
- package/manager/types.d.ts +45 -0
- package/package.json +61 -0
- package/partition-key/index.d.ts +2 -0
- package/partition-key/partition-key.resolver.d.ts +14 -0
- package/partition-key/types.d.ts +27 -0
- package/rate-limit/index.d.ts +2 -0
- package/rate-limit/rate-limiter.d.ts +25 -0
- package/rate-limit/types.d.ts +25 -0
- package/schemas/index.d.ts +1 -0
- package/schemas/schemas.d.ts +157 -0
- package/timeout/index.d.ts +2 -0
- package/timeout/timeout.d.ts +9 -0
- package/timeout/types.d.ts +10 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,395 @@
|
|
|
1
|
+
# @frontmcp/guard
|
|
2
|
+
|
|
3
|
+

|
|
4
|
+

|
|
5
|
+
|
|
6
|
+
Rate limiting, concurrency control, timeout enforcement, and IP filtering for FrontMCP applications. Built on the `StorageAdapter` interface from `@frontmcp/utils`, so it works with Memory, Redis, Vercel KV, and Upstash backends out of the box.
|
|
7
|
+
|
|
8
|
+
## Installation
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
npm install @frontmcp/guard
|
|
12
|
+
# or
|
|
13
|
+
yarn add @frontmcp/guard
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Peer dependency:
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
npm install zod@^4
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Quick Start
|
|
23
|
+
|
|
24
|
+
```typescript
|
|
25
|
+
import { createGuardManager } from '@frontmcp/guard';
|
|
26
|
+
|
|
27
|
+
const guard = await createGuardManager({
|
|
28
|
+
config: {
|
|
29
|
+
enabled: true,
|
|
30
|
+
global: { maxRequests: 100, windowMs: 60_000 },
|
|
31
|
+
defaultTimeout: { executeMs: 30_000 },
|
|
32
|
+
ipFilter: {
|
|
33
|
+
denyList: ['10.0.0.0/8'],
|
|
34
|
+
defaultAction: 'allow',
|
|
35
|
+
},
|
|
36
|
+
},
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
// Check IP filter
|
|
40
|
+
const ipResult = guard.checkIpFilter('203.0.113.5');
|
|
41
|
+
|
|
42
|
+
// Check rate limit
|
|
43
|
+
const rlResult = await guard.checkRateLimit('my-tool', undefined, {
|
|
44
|
+
sessionId: 'sess-123',
|
|
45
|
+
});
|
|
46
|
+
|
|
47
|
+
// Acquire concurrency slot
|
|
48
|
+
const ticket = await guard.acquireSemaphore(
|
|
49
|
+
'my-tool',
|
|
50
|
+
{ maxConcurrent: 5 },
|
|
51
|
+
{
|
|
52
|
+
sessionId: 'sess-123',
|
|
53
|
+
},
|
|
54
|
+
);
|
|
55
|
+
try {
|
|
56
|
+
// ... do work ...
|
|
57
|
+
} finally {
|
|
58
|
+
await ticket?.release();
|
|
59
|
+
}
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
## Modules
|
|
63
|
+
|
|
64
|
+
| Module | Main Export | Purpose |
|
|
65
|
+
| ---------------- | ------------------------------------- | --------------------------------------------------------------------- |
|
|
66
|
+
| `errors/` | `GuardError` + subclasses | Error hierarchy with machine-readable codes and HTTP status codes |
|
|
67
|
+
| `schemas/` | `guardConfigSchema` | Zod validation schemas for all configuration objects |
|
|
68
|
+
| `partition-key/` | `resolvePartitionKey` | Resolves request partition keys (ip, session, userId, global, custom) |
|
|
69
|
+
| `rate-limit/` | `SlidingWindowRateLimiter` | Sliding window counter rate limiter |
|
|
70
|
+
| `concurrency/` | `DistributedSemaphore` | Distributed semaphore for concurrency control |
|
|
71
|
+
| `timeout/` | `withTimeout` | Async execution timeout wrapper |
|
|
72
|
+
| `ip-filter/` | `IpFilter` | IP allow/deny list filtering with CIDR support |
|
|
73
|
+
| `manager/` | `GuardManager` + `createGuardManager` | Orchestrator combining all guard modules |
|
|
74
|
+
|
|
75
|
+
## Rate Limiting
|
|
76
|
+
|
|
77
|
+
Uses the **sliding window counter** algorithm. Two adjacent fixed-window counters are maintained; their counts are combined with a time-weighted interpolation to approximate a true sliding window. This provides O(1) storage per key while avoiding the burst edges of simple fixed-window counters.
|
|
78
|
+
|
|
79
|
+
```typescript
|
|
80
|
+
import { SlidingWindowRateLimiter } from '@frontmcp/guard';
|
|
81
|
+
|
|
82
|
+
const limiter = new SlidingWindowRateLimiter(storageAdapter);
|
|
83
|
+
|
|
84
|
+
const result = await limiter.check(
|
|
85
|
+
'user:42', // partition key
|
|
86
|
+
100, // max requests
|
|
87
|
+
60_000, // window in ms
|
|
88
|
+
);
|
|
89
|
+
|
|
90
|
+
if (!result.allowed) {
|
|
91
|
+
console.log(`Rate limited. Retry after ${result.retryAfterMs}ms`);
|
|
92
|
+
}
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
The `RateLimitResult` includes:
|
|
96
|
+
|
|
97
|
+
- `allowed` -- whether the request can proceed
|
|
98
|
+
- `remaining` -- approximate remaining requests in this window
|
|
99
|
+
- `resetMs` -- milliseconds until the current window resets
|
|
100
|
+
- `retryAfterMs` -- (only when blocked) suggested retry delay
|
|
101
|
+
|
|
102
|
+
## Concurrency Control
|
|
103
|
+
|
|
104
|
+
The `DistributedSemaphore` limits the number of concurrent executions for a given key. Each execution acquires a "ticket" via atomic `incr` on a counter key. Individual ticket keys are stored with a TTL for crash safety -- if a process dies without releasing, the ticket TTL expires and the counter self-corrects.
|
|
105
|
+
|
|
106
|
+
When all slots are full, callers can optionally wait in a queue with exponential backoff polling. If the storage backend supports pub/sub, slot releases trigger immediate wakeup of waiting callers.
|
|
107
|
+
|
|
108
|
+
```typescript
|
|
109
|
+
import { DistributedSemaphore } from '@frontmcp/guard';
|
|
110
|
+
|
|
111
|
+
const semaphore = new DistributedSemaphore(storageAdapter, 300 /* ticket TTL seconds */);
|
|
112
|
+
|
|
113
|
+
const ticket = await semaphore.acquire(
|
|
114
|
+
'my-tool:global', // key
|
|
115
|
+
5, // max concurrent
|
|
116
|
+
10_000, // queue timeout ms (0 = no wait)
|
|
117
|
+
'my-tool', // entity name (for error messages)
|
|
118
|
+
);
|
|
119
|
+
|
|
120
|
+
if (!ticket) {
|
|
121
|
+
// Rejected (queueTimeoutMs was 0 and all slots full)
|
|
122
|
+
return;
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
try {
|
|
126
|
+
await doWork();
|
|
127
|
+
} finally {
|
|
128
|
+
await ticket.release();
|
|
129
|
+
}
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
Additional methods:
|
|
133
|
+
|
|
134
|
+
- `getActiveCount(key)` -- returns the current number of active tickets
|
|
135
|
+
- `forceReset(key)` -- resets the counter and removes all ticket keys
|
|
136
|
+
|
|
137
|
+
## Timeout
|
|
138
|
+
|
|
139
|
+
The `withTimeout` utility wraps an async function with a deadline using `AbortController` + `Promise.race`. Throws `ExecutionTimeoutError` if the function does not complete within the specified duration.
|
|
140
|
+
|
|
141
|
+
```typescript
|
|
142
|
+
import { withTimeout } from '@frontmcp/guard';
|
|
143
|
+
|
|
144
|
+
const result = await withTimeout(
|
|
145
|
+
() => fetchData(),
|
|
146
|
+
5_000, // timeout in ms
|
|
147
|
+
'fetch-data', // entity name (for error messages)
|
|
148
|
+
);
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
## IP Filtering
|
|
152
|
+
|
|
153
|
+
The `IpFilter` class checks client IP addresses against allow and deny lists. Supports individual IP addresses and CIDR notation for both IPv4 and IPv6. IPv4-mapped IPv6 addresses (e.g., `::ffff:192.168.1.1`) are also handled.
|
|
154
|
+
|
|
155
|
+
**Precedence**: the deny list is always checked first. If an IP matches the deny list, it is blocked regardless of the allow list. If an allow list is configured and the IP does not match any allow rule, the `defaultAction` determines the outcome.
|
|
156
|
+
|
|
157
|
+
All matching is performed using bigint arithmetic for correctness across the full IPv6 address space.
|
|
158
|
+
|
|
159
|
+
```typescript
|
|
160
|
+
import { IpFilter } from '@frontmcp/guard';
|
|
161
|
+
|
|
162
|
+
const filter = new IpFilter({
|
|
163
|
+
allowList: ['192.168.0.0/16'],
|
|
164
|
+
denyList: ['192.168.1.100'],
|
|
165
|
+
defaultAction: 'deny',
|
|
166
|
+
});
|
|
167
|
+
|
|
168
|
+
const result = filter.check('192.168.2.50');
|
|
169
|
+
// { allowed: true, reason: 'allowlisted', matchedRule: '192.168.0.0/16' }
|
|
170
|
+
|
|
171
|
+
const blocked = filter.check('192.168.1.100');
|
|
172
|
+
// { allowed: false, reason: 'denylisted', matchedRule: '192.168.1.100' }
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
The `isAllowListed(ip)` method provides a quick check for whether an IP is on the allow list, which can be used to bypass rate limiting for trusted addresses.
|
|
176
|
+
|
|
177
|
+
## Partition Keys
|
|
178
|
+
|
|
179
|
+
Partition keys determine how rate limits and concurrency slots are bucketed. Built-in strategies:
|
|
180
|
+
|
|
181
|
+
| Strategy | Behavior |
|
|
182
|
+
| ----------- | --------------------------------------------------------------- |
|
|
183
|
+
| `'global'` | Single shared bucket for all callers (default) |
|
|
184
|
+
| `'ip'` | One bucket per client IP address |
|
|
185
|
+
| `'session'` | One bucket per session ID |
|
|
186
|
+
| `'userId'` | One bucket per authenticated user ID (falls back to session ID) |
|
|
187
|
+
|
|
188
|
+
You can also pass a custom function:
|
|
189
|
+
|
|
190
|
+
```typescript
|
|
191
|
+
const config: RateLimitConfig = {
|
|
192
|
+
maxRequests: 100,
|
|
193
|
+
windowMs: 60_000,
|
|
194
|
+
partitionBy: (ctx) => `org:${ctx.userId?.split(':')[0]}`,
|
|
195
|
+
};
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
The `PartitionKeyContext` passed to custom functions contains `sessionId` (always present), plus optional `clientIp` and `userId`.
|
|
199
|
+
|
|
200
|
+
## Guard Manager
|
|
201
|
+
|
|
202
|
+
`GuardManager` is the central orchestrator. It combines rate limiting, concurrency control, IP filtering, and timeout configuration into a single interface. The `createGuardManager` factory handles storage initialization.
|
|
203
|
+
|
|
204
|
+
The manager supports two levels of configuration:
|
|
205
|
+
|
|
206
|
+
- **Global** -- applied to every request (`global`, `globalConcurrency`)
|
|
207
|
+
- **Default** -- applied to entities that do not specify their own config (`defaultRateLimit`, `defaultConcurrency`, `defaultTimeout`)
|
|
208
|
+
|
|
209
|
+
Per-entity configuration takes precedence over defaults.
|
|
210
|
+
|
|
211
|
+
```typescript
|
|
212
|
+
import { createGuardManager } from '@frontmcp/guard';
|
|
213
|
+
|
|
214
|
+
const guard = await createGuardManager({
|
|
215
|
+
config: {
|
|
216
|
+
enabled: true,
|
|
217
|
+
storage: { provider: 'redis', host: 'localhost', port: 6379 },
|
|
218
|
+
keyPrefix: 'myapp:guard:',
|
|
219
|
+
global: { maxRequests: 1000, windowMs: 60_000, partitionBy: 'ip' },
|
|
220
|
+
globalConcurrency: { maxConcurrent: 50, partitionBy: 'global' },
|
|
221
|
+
defaultRateLimit: { maxRequests: 100, windowMs: 60_000, partitionBy: 'session' },
|
|
222
|
+
defaultConcurrency: { maxConcurrent: 10, queueTimeoutMs: 5_000 },
|
|
223
|
+
defaultTimeout: { executeMs: 30_000 },
|
|
224
|
+
ipFilter: {
|
|
225
|
+
denyList: ['10.0.0.0/8'],
|
|
226
|
+
allowList: ['10.0.1.0/24'],
|
|
227
|
+
defaultAction: 'allow',
|
|
228
|
+
trustProxy: true,
|
|
229
|
+
trustedProxyDepth: 2,
|
|
230
|
+
},
|
|
231
|
+
},
|
|
232
|
+
logger: console,
|
|
233
|
+
});
|
|
234
|
+
|
|
235
|
+
// Use the manager
|
|
236
|
+
const globalRl = await guard.checkGlobalRateLimit({ sessionId: 'sess-1' });
|
|
237
|
+
const entityRl = await guard.checkRateLimit('my-tool', undefined, { sessionId: 'sess-1' });
|
|
238
|
+
const ticket = await guard.acquireSemaphore('my-tool', undefined, { sessionId: 'sess-1' });
|
|
239
|
+
|
|
240
|
+
// Cleanup
|
|
241
|
+
await guard.destroy();
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
## Configuration Reference
|
|
245
|
+
|
|
246
|
+
### `GuardConfig`
|
|
247
|
+
|
|
248
|
+
| Field | Type | Default | Description |
|
|
249
|
+
| -------------------- | ------------------- | -------------- | -------------------------------------------------------- |
|
|
250
|
+
| `enabled` | `boolean` | -- | Whether the guard system is active |
|
|
251
|
+
| `storage` | `StorageConfig` | memory | Storage backend configuration |
|
|
252
|
+
| `keyPrefix` | `string` | `'mcp:guard:'` | Prefix for all storage keys |
|
|
253
|
+
| `global` | `RateLimitConfig` | -- | Global rate limit for ALL requests |
|
|
254
|
+
| `globalConcurrency` | `ConcurrencyConfig` | -- | Global concurrency limit |
|
|
255
|
+
| `defaultRateLimit` | `RateLimitConfig` | -- | Default rate limit for entities without explicit config |
|
|
256
|
+
| `defaultConcurrency` | `ConcurrencyConfig` | -- | Default concurrency for entities without explicit config |
|
|
257
|
+
| `defaultTimeout` | `TimeoutConfig` | -- | Default timeout for entity execution |
|
|
258
|
+
| `ipFilter` | `IpFilterConfig` | -- | IP filtering configuration |
|
|
259
|
+
|
|
260
|
+
### `RateLimitConfig`
|
|
261
|
+
|
|
262
|
+
| Field | Type | Default | Description |
|
|
263
|
+
| ------------- | -------------- | ---------- | ----------------------------------- |
|
|
264
|
+
| `maxRequests` | `number` | -- | Maximum requests allowed per window |
|
|
265
|
+
| `windowMs` | `number` | `60000` | Time window in milliseconds |
|
|
266
|
+
| `partitionBy` | `PartitionKey` | `'global'` | Partition key strategy |
|
|
267
|
+
|
|
268
|
+
### `ConcurrencyConfig`
|
|
269
|
+
|
|
270
|
+
| Field | Type | Default | Description |
|
|
271
|
+
| ---------------- | -------------- | ---------- | ----------------------------------------------- |
|
|
272
|
+
| `maxConcurrent` | `number` | -- | Maximum concurrent executions |
|
|
273
|
+
| `queueTimeoutMs` | `number` | `0` | Max wait time in queue (0 = reject immediately) |
|
|
274
|
+
| `partitionBy` | `PartitionKey` | `'global'` | Partition key strategy |
|
|
275
|
+
|
|
276
|
+
### `TimeoutConfig`
|
|
277
|
+
|
|
278
|
+
| Field | Type | Default | Description |
|
|
279
|
+
| ----------- | -------- | ------- | -------------------------------------- |
|
|
280
|
+
| `executeMs` | `number` | -- | Maximum execution time in milliseconds |
|
|
281
|
+
|
|
282
|
+
### `IpFilterConfig`
|
|
283
|
+
|
|
284
|
+
| Field | Type | Default | Description |
|
|
285
|
+
| ------------------- | ------------------- | --------- | ------------------------------------------- |
|
|
286
|
+
| `allowList` | `string[]` | -- | IP addresses or CIDR ranges to always allow |
|
|
287
|
+
| `denyList` | `string[]` | -- | IP addresses or CIDR ranges to always block |
|
|
288
|
+
| `defaultAction` | `'allow' \| 'deny'` | `'allow'` | Action when IP matches neither list |
|
|
289
|
+
| `trustProxy` | `boolean` | `false` | Trust X-Forwarded-For header |
|
|
290
|
+
| `trustedProxyDepth` | `number` | `1` | Max proxies to trust from X-Forwarded-For |
|
|
291
|
+
|
|
292
|
+
## Storage Backends
|
|
293
|
+
|
|
294
|
+
The guard library delegates all persistence to the `StorageAdapter` interface from `@frontmcp/utils`. Choose a backend based on your deployment:
|
|
295
|
+
|
|
296
|
+
| Backend | Use Case |
|
|
297
|
+
| ------------- | ------------------------------------------------------------------------------------------------------------ |
|
|
298
|
+
| **Memory** | Development, testing, single-process deployments. Not suitable for distributed setups. |
|
|
299
|
+
| **Redis** | Production multi-instance deployments. Provides atomic operations and optional pub/sub for semaphore wakeup. |
|
|
300
|
+
| **Vercel KV** | Vercel-hosted applications. Redis-compatible API. |
|
|
301
|
+
| **Upstash** | Serverless environments. HTTP-based Redis compatible. |
|
|
302
|
+
|
|
303
|
+
If no `storage` config is provided, the factory falls back to in-memory storage and logs a warning.
|
|
304
|
+
|
|
305
|
+
## Error Handling
|
|
306
|
+
|
|
307
|
+
All errors extend `GuardError`, which carries a machine-readable `code` and an HTTP `statusCode`.
|
|
308
|
+
|
|
309
|
+
| Error Class | Code | Status | When |
|
|
310
|
+
| ----------------------- | ------------------- | ------ | ------------------------------------------------------ |
|
|
311
|
+
| `GuardError` | (base) | -- | Base class for all guard errors |
|
|
312
|
+
| `ExecutionTimeoutError` | `EXECUTION_TIMEOUT` | `408` | Execution exceeds configured timeout |
|
|
313
|
+
| `ConcurrencyLimitError` | `CONCURRENCY_LIMIT` | `429` | Concurrency limit reached (no queue or queue disabled) |
|
|
314
|
+
| `QueueTimeoutError` | `QUEUE_TIMEOUT` | `429` | Waited in concurrency queue but timed out |
|
|
315
|
+
| `IpBlockedError` | `IP_BLOCKED` | `403` | Client IP is on the deny list |
|
|
316
|
+
| `IpNotAllowedError` | `IP_NOT_ALLOWED` | `403` | Client IP is not on the allow list |
|
|
317
|
+
|
|
318
|
+
```typescript
|
|
319
|
+
import { GuardError, ExecutionTimeoutError } from '@frontmcp/guard';
|
|
320
|
+
|
|
321
|
+
try {
|
|
322
|
+
await withTimeout(() => slowOp(), 5_000, 'slow-op');
|
|
323
|
+
} catch (err) {
|
|
324
|
+
if (err instanceof ExecutionTimeoutError) {
|
|
325
|
+
console.log(err.code); // 'EXECUTION_TIMEOUT'
|
|
326
|
+
console.log(err.statusCode); // 408
|
|
327
|
+
console.log(err.timeoutMs); // 5000
|
|
328
|
+
}
|
|
329
|
+
}
|
|
330
|
+
```
|
|
331
|
+
|
|
332
|
+
## API Reference
|
|
333
|
+
|
|
334
|
+
### Classes
|
|
335
|
+
|
|
336
|
+
| Export | Module | Description |
|
|
337
|
+
| -------------------------- | ------------- | ------------------------------------------------ |
|
|
338
|
+
| `SlidingWindowRateLimiter` | `rate-limit` | Sliding window counter rate limiter |
|
|
339
|
+
| `DistributedSemaphore` | `concurrency` | Distributed semaphore with ticket-based tracking |
|
|
340
|
+
| `IpFilter` | `ip-filter` | IP allow/deny list with CIDR support |
|
|
341
|
+
| `GuardManager` | `manager` | Central orchestrator for all guard modules |
|
|
342
|
+
|
|
343
|
+
### Functions
|
|
344
|
+
|
|
345
|
+
| Export | Module | Description |
|
|
346
|
+
| --------------------- | --------------- | -------------------------------------------------------- |
|
|
347
|
+
| `withTimeout` | `timeout` | Wrap an async function with a deadline |
|
|
348
|
+
| `resolvePartitionKey` | `partition-key` | Resolve a partition key string from strategy and context |
|
|
349
|
+
| `buildStorageKey` | `partition-key` | Build a namespaced storage key |
|
|
350
|
+
| `createGuardManager` | `manager` | Factory to create and initialize a `GuardManager` |
|
|
351
|
+
|
|
352
|
+
### Error Classes
|
|
353
|
+
|
|
354
|
+
| Export | Module | Description |
|
|
355
|
+
| ----------------------- | -------- | ------------------------- |
|
|
356
|
+
| `GuardError` | `errors` | Base error class |
|
|
357
|
+
| `ExecutionTimeoutError` | `errors` | Timeout exceeded |
|
|
358
|
+
| `ConcurrencyLimitError` | `errors` | Concurrency limit reached |
|
|
359
|
+
| `QueueTimeoutError` | `errors` | Queue wait timed out |
|
|
360
|
+
| `IpBlockedError` | `errors` | IP on deny list |
|
|
361
|
+
| `IpNotAllowedError` | `errors` | IP not on allow list |
|
|
362
|
+
|
|
363
|
+
### Zod Schemas
|
|
364
|
+
|
|
365
|
+
| Export | Module | Description |
|
|
366
|
+
| ------------------------- | --------- | --------------------------------------------------- |
|
|
367
|
+
| `partitionKeySchema` | `schemas` | Validates partition key strategy or custom function |
|
|
368
|
+
| `rateLimitConfigSchema` | `schemas` | Validates `RateLimitConfig` |
|
|
369
|
+
| `concurrencyConfigSchema` | `schemas` | Validates `ConcurrencyConfig` |
|
|
370
|
+
| `timeoutConfigSchema` | `schemas` | Validates `TimeoutConfig` |
|
|
371
|
+
| `ipFilterConfigSchema` | `schemas` | Validates `IpFilterConfig` |
|
|
372
|
+
| `guardConfigSchema` | `schemas` | Validates the full `GuardConfig` |
|
|
373
|
+
|
|
374
|
+
### Types
|
|
375
|
+
|
|
376
|
+
| Export | Module | Description |
|
|
377
|
+
| ------------------------ | --------------- | ------------------------------------------- |
|
|
378
|
+
| `RateLimitConfig` | `rate-limit` | Rate limit configuration |
|
|
379
|
+
| `RateLimitResult` | `rate-limit` | Result from a rate limit check |
|
|
380
|
+
| `ConcurrencyConfig` | `concurrency` | Concurrency control configuration |
|
|
381
|
+
| `SemaphoreTicket` | `concurrency` | Acquired concurrency slot handle |
|
|
382
|
+
| `TimeoutConfig` | `timeout` | Timeout configuration |
|
|
383
|
+
| `IpFilterConfig` | `ip-filter` | IP filter configuration |
|
|
384
|
+
| `IpFilterResult` | `ip-filter` | Result from an IP filter check |
|
|
385
|
+
| `PartitionKeyStrategy` | `partition-key` | Built-in partition key strategies union |
|
|
386
|
+
| `CustomPartitionKeyFn` | `partition-key` | Custom partition key resolver function |
|
|
387
|
+
| `PartitionKeyContext` | `partition-key` | Context passed to partition key resolvers |
|
|
388
|
+
| `PartitionKey` | `partition-key` | Union of strategy string or custom function |
|
|
389
|
+
| `GuardConfig` | `manager` | Full guard configuration |
|
|
390
|
+
| `GuardLogger` | `manager` | Minimal logger interface |
|
|
391
|
+
| `CreateGuardManagerArgs` | `manager` | Arguments for `createGuardManager` |
|
|
392
|
+
|
|
393
|
+
## License
|
|
394
|
+
|
|
395
|
+
Apache-2.0
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Distributed Semaphore
|
|
3
|
+
*
|
|
4
|
+
* Provides concurrency control using the StorageAdapter interface.
|
|
5
|
+
* Each concurrent execution acquires a "ticket" stored in the backend.
|
|
6
|
+
* Active tickets tracked via atomic counter + individual ticket keys with TTL.
|
|
7
|
+
*/
|
|
8
|
+
import type { StorageAdapter } from '@frontmcp/utils';
|
|
9
|
+
import type { SemaphoreTicket } from './types';
|
|
10
|
+
export declare class DistributedSemaphore {
|
|
11
|
+
private readonly storage;
|
|
12
|
+
private readonly ticketTtlSeconds;
|
|
13
|
+
constructor(storage: StorageAdapter, ticketTtlSeconds?: number);
|
|
14
|
+
/**
|
|
15
|
+
* Attempt to acquire a concurrency slot.
|
|
16
|
+
*
|
|
17
|
+
* @returns A SemaphoreTicket if acquired, or null if rejected
|
|
18
|
+
* @throws QueueTimeoutError if queued and timeout expires
|
|
19
|
+
*/
|
|
20
|
+
acquire(key: string, maxConcurrent: number, queueTimeoutMs: number, entityName: string): Promise<SemaphoreTicket | null>;
|
|
21
|
+
private tryAcquire;
|
|
22
|
+
private release;
|
|
23
|
+
private waitForSlot;
|
|
24
|
+
getActiveCount(key: string): Promise<number>;
|
|
25
|
+
forceReset(key: string): Promise<void>;
|
|
26
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Concurrency Control Types
|
|
3
|
+
*/
|
|
4
|
+
import type { PartitionKey } from '../partition-key/types';
|
|
5
|
+
/**
|
|
6
|
+
* Concurrency control configuration.
|
|
7
|
+
*/
|
|
8
|
+
export interface ConcurrencyConfig {
|
|
9
|
+
/** Maximum number of concurrent executions allowed. */
|
|
10
|
+
maxConcurrent: number;
|
|
11
|
+
/** Maximum time in ms to wait in queue (0 = no wait). @default 0 */
|
|
12
|
+
queueTimeoutMs?: number;
|
|
13
|
+
/** Partition key strategy. @default 'global' */
|
|
14
|
+
partitionBy?: PartitionKey;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* A semaphore ticket representing an acquired concurrency slot.
|
|
18
|
+
*/
|
|
19
|
+
export interface SemaphoreTicket {
|
|
20
|
+
ticket: string;
|
|
21
|
+
release: () => Promise<void>;
|
|
22
|
+
}
|