├── .editorconfig
├── .github
└── FUNDING.yml
├── .gitignore
├── .prettierrc
├── LICENSE
├── README.md
├── package-lock.json
├── package.json
├── src
├── config
│ └── constants.js
├── handlers
│ ├── delete.js
│ ├── get.js
│ ├── list.js
│ └── update.js
├── index.js
└── utils
│ ├── authentication.js
│ ├── errorHandling.js
│ └── prometheusQueries.js
├── test
└── index.spec.js
├── vitest.config.js
└── wrangler-example.toml
/.editorconfig:
--------------------------------------------------------------------------------
1 | # http://editorconfig.org
2 | root = true
3 |
4 | [*]
5 | indent_style = tab
6 | end_of_line = lf
7 | charset = utf-8
8 | trim_trailing_whitespace = true
9 | insert_final_newline = true
10 |
11 | [*.yml]
12 | indent_style = space
13 |
--------------------------------------------------------------------------------
/.github/FUNDING.yml:
--------------------------------------------------------------------------------
1 | # These are supported funding model platforms
2 |
3 | github: unredacted
4 | patreon: unredacted_org
5 | open_collective: unredacted
6 | ko_fi: # Replace with a single Ko-fi username
7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9 | liberapay: unredacted
10 | issuehunt: # Replace with a single IssueHunt username
11 | lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
12 | polar: # Replace with a single Polar username
13 | buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
14 | thanks_dev: # Replace with a single thanks.dev username
15 | custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
16 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Logs
2 |
3 | logs
4 | _.log
5 | npm-debug.log_
6 | yarn-debug.log*
7 | yarn-error.log*
8 | lerna-debug.log*
9 | .pnpm-debug.log*
10 |
11 | # Diagnostic reports (https://nodejs.org/api/report.html)
12 |
13 | report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json
14 |
15 | # Runtime data
16 |
17 | pids
18 | _.pid
19 | _.seed
20 | \*.pid.lock
21 |
22 | # Directory for instrumented libs generated by jscoverage/JSCover
23 |
24 | lib-cov
25 |
26 | # Coverage directory used by tools like istanbul
27 |
28 | coverage
29 | \*.lcov
30 |
31 | # nyc test coverage
32 |
33 | .nyc_output
34 |
35 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
36 |
37 | .grunt
38 |
39 | # Bower dependency directory (https://bower.io/)
40 |
41 | bower_components
42 |
43 | # node-waf configuration
44 |
45 | .lock-wscript
46 |
47 | # Compiled binary addons (https://nodejs.org/api/addons.html)
48 |
49 | build/Release
50 |
51 | # Dependency directories
52 |
53 | node_modules/
54 | jspm_packages/
55 |
56 | # Snowpack dependency directory (https://snowpack.dev/)
57 |
58 | web_modules/
59 |
60 | # TypeScript cache
61 |
62 | \*.tsbuildinfo
63 |
64 | # Optional npm cache directory
65 |
66 | .npm
67 |
68 | # Optional eslint cache
69 |
70 | .eslintcache
71 |
72 | # Optional stylelint cache
73 |
74 | .stylelintcache
75 |
76 | # Microbundle cache
77 |
78 | .rpt2_cache/
79 | .rts2_cache_cjs/
80 | .rts2_cache_es/
81 | .rts2_cache_umd/
82 |
83 | # Optional REPL history
84 |
85 | .node_repl_history
86 |
87 | # Output of 'npm pack'
88 |
89 | \*.tgz
90 |
91 | # Yarn Integrity file
92 |
93 | .yarn-integrity
94 |
95 | # dotenv environment variable files
96 |
97 | .env
98 | .env.development.local
99 | .env.test.local
100 | .env.production.local
101 | .env.local
102 |
103 | # parcel-bundler cache (https://parceljs.org/)
104 |
105 | .cache
106 | .parcel-cache
107 |
108 | # Next.js build output
109 |
110 | .next
111 | out
112 |
113 | # Nuxt.js build / generate output
114 |
115 | .nuxt
116 | dist
117 |
118 | # Gatsby files
119 |
120 | .cache/
121 |
122 | # Comment in the public line in if your project uses Gatsby and not Next.js
123 |
124 | # https://nextjs.org/blog/next-9-1#public-directory-support
125 |
126 | # public
127 |
128 | # vuepress build output
129 |
130 | .vuepress/dist
131 |
132 | # vuepress v2.x temp and cache directory
133 |
134 | .temp
135 | .cache
136 |
137 | # Docusaurus cache and generated files
138 |
139 | .docusaurus
140 |
141 | # Serverless directories
142 |
143 | .serverless/
144 |
145 | # FuseBox cache
146 |
147 | .fusebox/
148 |
149 | # DynamoDB Local files
150 |
151 | .dynamodb/
152 |
153 | # TernJS port file
154 |
155 | .tern-port
156 |
157 | # Stores VSCode versions used for testing VSCode extensions
158 |
159 | .vscode-test
160 |
161 | # yarn v2
162 |
163 | .yarn/cache
164 | .yarn/unplugged
165 | .yarn/build-state.yml
166 | .yarn/install-state.gz
167 | .pnp.\*
168 |
169 | # wrangler project
170 |
171 | .dev.vars
172 | .wrangler/
173 | wrangler.toml
174 |
175 | # Misc
176 | .DS_Store
177 |
--------------------------------------------------------------------------------
/.prettierrc:
--------------------------------------------------------------------------------
1 | {
2 | "printWidth": 140,
3 | "singleQuote": true,
4 | "semi": true,
5 | "useTabs": true
6 | }
7 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # FreeSocks Control Plane (FCP)
2 |
3 | This is the (control plane) code behind [FreeSocks](https://freesocks.org) a service that provides free, open & uncensored Outline (Shadowsocks) proxies to people in countries experiencing a high level of Internet censorship.
4 |
5 | The FreeSocks Control Plane (FCP) utilizes [Cloudflare Workers](https://workers.cloudflare.com/) and is written in JavaScript. This repository allows you to stand up your own FreeSocks-like Outline access key distribution platform, and provides insight into how FreeSocks works.
6 |
7 | The FreeSocks Control Plane consists of several core components:
8 |
9 | - GET Script (src/handlers/get.js) - distributes Outline access keys to users.
10 | - DELETE Script (src/handlers/delete.js) - deletes access keys that have not been used after a defined number of days.
11 | - UPDATE Script (src/handlers/update.js) - updates KV JSON data to track the state of access keys (creation, deletion, last used and if a key is currently in use).
12 | - LIST Script (src/handlers/list.js) - lists access key data from KV for admins.
13 |
14 | ## Prerequisites
15 |
16 | - A Cloudflare account with access to the Workers platform.
17 | - The creation of several Workers KV namespaces, which are to be defined in the `wrangler.toml` environment variables.
18 | - A zone on Cloudflare to be used for the FreeSocks Control Plane.
19 | - Cloudflare [wrangler](https://developers.cloudflare.com/workers/wrangler/install-and-update/).
20 | - Ensure you are logged in to Cloudflare with [wrangler](https://developers.cloudflare.com/workers/wrangler/commands/#login)
21 |
22 | ## Defining environment variables
23 |
24 | Check `wrangler-example.toml` for example variables.
25 |
26 | Make a copy of `wrangler-example.toml` to `wrangler.toml` then edit them depending on your requirements.
27 |
28 | Set sensitive variables with `wrangler secret`.
29 |
30 | Set required secrets:
31 |
32 | ```
33 | # For get.js
34 | wrangler secret put TURNSTILE_SITE_KEY
35 | wrangler secret put TURNSTILE_SECRET_KEY
36 |
37 | # For delete.js
38 | wrangler secret put SECRET_AUTH_TOKEN
39 | wrangler secret put VAR_CF_ACCESS_CLIENT_ID
40 | wrangler secret put VAR_CF_ACCESS_CLIENT_SECRET
41 | ```
42 |
43 | ## How to deploy
44 |
45 | To deploy the FCP, you can run:
46 |
47 | ```
48 | wrangler deploy
49 | ```
50 |
51 | ## Updating your FCP code
52 |
53 | 1. Check for breaking changes since you last deployed your Worker, and fix if needed.
54 | 2. Pull the latest code from the repository's directory you have on your system:
55 |
56 | ```
57 | git pull
58 | ```
59 |
60 | Deploy the Worker:
61 |
62 | ```
63 | wrangler deploy
64 | ```
65 |
--------------------------------------------------------------------------------
/package-lock.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "freesocks-control-plane",
3 | "version": "0.0.0",
4 | "lockfileVersion": 3,
5 | "requires": true,
6 | "packages": {
7 | "": {
8 | "name": "freesocks-control-plane",
9 | "version": "0.0.0"
10 | }
11 | }
12 | }
13 |
--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "freesocks-control-plane",
3 | "version": "0.0.0",
4 | "private": true,
5 | "scripts": {
6 | "deploy": "wrangler deploy",
7 | "dev": "wrangler dev",
8 | "start": "wrangler dev",
9 | "test": "vitest"
10 | }
11 | }
12 |
--------------------------------------------------------------------------------
/src/config/constants.js:
--------------------------------------------------------------------------------
1 | export const AUTH_TOKEN = SECRET_AUTH_TOKEN;
2 | export const turnstileSecretKey = TURNSTILE_SECRET_KEY;
3 | export const turnstileSiteKey = TURNSTILE_SITE_KEY;
4 | export const API_ENDPOINTS_NAMESPACE = FREESOCKS_OUTLINE_API_ENDPOINTS;
5 | export const ACCESS_KEYS_NAMESPACE = FREESOCKS_OUTLINE_ACCESS_KEYS;
6 | export const PROM_API_ENDPOINTS_NAMESPACE = FREESOCKS_PROM_API_ENDPOINTS;
7 | export const CF_ACCESS_CLIENT_ID = VAR_CF_ACCESS_CLIENT_ID;
8 | export const CF_ACCESS_CLIENT_SECRET = VAR_CF_ACCESS_CLIENT_SECRET;
9 |
10 | export const EXPIRATION_DAYS = VAR_EXPIRATION_DAYS;
11 | export const PREFIX_DISGUISE = VAR_PREFIX_DISGUISE;
12 | export const WEIGHT_LATENCY = VAR_WEIGHT_LATENCY;
13 | export const WEIGHT_ACCESS_KEY_COUNT = VAR_WEIGHT_ACCESS_KEY_COUNT;
14 | export const API_ENDPOINT_TIMEOUT = VAR_API_ENDPOINT_TIMEOUT;
15 | export const PROM_QUERY_TIME_RANGE = VAR_PROM_QUERY_TIME_RANGE;
16 |
17 | export const STATE_NAMESPACE = FREESOCKS_STATE_KV;
18 | export const MAX_KEYS_PER_RUN = VAR_MAX_KEYS_PER_RUN;
19 | export const MINIMUM_BYTES_THRESHOLD = VAR_MINIMUM_BYTES_THRESHOLD;
20 | export const MAX_RETRIES = VAR_MAX_RETRIES;
21 | export const RETRY_DELAY = VAR_RETRY_DELAY;
--------------------------------------------------------------------------------
/src/handlers/delete.js:
--------------------------------------------------------------------------------
1 | import {
2 | AUTH_TOKEN,
3 | ACCESS_KEYS_NAMESPACE,
4 | API_ENDPOINTS_NAMESPACE,
5 | EXPIRATION_DAYS,
6 | MAX_RETRIES,
7 | RETRY_DELAY,
8 | STATE_NAMESPACE,
9 | MAX_KEYS_PER_RUN
10 | } from '../config/constants.js';
11 | import { verifyAuth } from '../utils/authentication.js';
12 | import { handleError, logError, logInfo } from '../utils/errorHandling.js';
13 |
14 | const DELETE_CURSOR_KEY = 'delete_script_cursor';
15 |
16 | async function retry(fn, maxRetries = MAX_RETRIES, delay = RETRY_DELAY) {
17 | let lastError;
18 | for (let i = 0; i < maxRetries; i++) {
19 | try {
20 | return await fn();
21 | } catch (error) {
22 | lastError = error;
23 | await new Promise(resolve => setTimeout(resolve, delay));
24 | }
25 | }
26 | throw lastError;
27 | }
28 |
29 | export async function handleRequest(request, isCronTriggered) {
30 | logInfo(`handleRequest triggered, isCronTriggered: ${isCronTriggered}`);
31 |
32 | const isDryRun = request && request.headers.get('X-Dry-Run') === 'true';
33 | const targetServer = request && request.headers.get('X-Target-Server');
34 | const targetKey = request && request.headers.get('X-Target-Key');
35 |
36 | if (!isCronTriggered) {
37 | const isAuthorized = await verifyAuth(request, AUTH_TOKEN);
38 | if (!isAuthorized) {
39 | return handleError('Unauthorized', 401);
40 | }
41 | }
42 |
43 | try {
44 | let deleteResults;
45 | if (targetKey) {
46 | deleteResults = await processKeys([targetKey], isDryRun, targetServer);
47 | } else if (targetServer) {
48 | deleteResults = await processKeysForServer(targetServer, isDryRun);
49 | } else {
50 | const startCursor = await retry(() => STATE_NAMESPACE.get(DELETE_CURSOR_KEY));
51 | deleteResults = await processAllKeys(isDryRun, startCursor);
52 |
53 | if (!isDryRun && deleteResults.nextCursor) {
54 | await retry(() => STATE_NAMESPACE.put(DELETE_CURSOR_KEY, deleteResults.nextCursor));
55 | } else if (!isDryRun && !deleteResults.nextCursor) {
56 | await retry(() => STATE_NAMESPACE.delete(DELETE_CURSOR_KEY));
57 | }
58 | }
59 |
60 | deleteResults.isDryRun = isDryRun;
61 | deleteResults.targetServer = targetServer || null;
62 | deleteResults.targetKey = targetKey || null;
63 | deleteResults.expirationDays = EXPIRATION_DAYS;
64 |
65 | return new Response(JSON.stringify(deleteResults, null, 2), {
66 | status: 200,
67 | headers: { 'Content-Type': 'application/json' }
68 | });
69 | } catch (error) {
70 | return handleError('Error deleting access keys', 500, error);
71 | }
72 | }
73 |
74 | async function processKeys(keys, isDryRun, targetServer) {
75 | const deleteResults = {
76 | processedKeys: [],
77 | errors: []
78 | };
79 |
80 | for (const key of keys) {
81 | try {
82 | if (targetServer && !key.startsWith(`${targetServer}-key-`)) {
83 | deleteResults.errors.push(`Key ${key} does not match target server ${targetServer}`);
84 | continue;
85 | }
86 |
87 | const keyData = await retry(() => ACCESS_KEYS_NAMESPACE.get(key));
88 | if (!keyData) {
89 | deleteResults.errors.push(`Key not found: ${key}`);
90 | continue;
91 | }
92 |
93 | await processKeyForDeletion(key, JSON.parse(keyData), isDryRun, deleteResults);
94 | } catch (error) {
95 | logError(`Error processing key ${key}:`, error);
96 | deleteResults.errors.push(`Error processing key ${key}: ${error.message}`);
97 | }
98 | }
99 |
100 | return deleteResults;
101 | }
102 |
103 | async function processKeysForServer(targetServer, isDryRun) {
104 | const deleteResults = {
105 | processedKeys: [],
106 | errors: [],
107 | nextCursor: null
108 | };
109 |
110 | let cursor = null;
111 | let processedCount = 0;
112 |
113 | do {
114 | const listResult = await retry(() => ACCESS_KEYS_NAMESPACE.list({ prefix: `${targetServer}-key-`, cursor, limit: Math.min(MAX_KEYS_PER_RUN - processedCount, 1000) }));
115 |
116 | for (const key of listResult.keys) {
117 | try {
118 | const keyData = JSON.parse(await ACCESS_KEYS_NAMESPACE.get(key.name));
119 | await processKeyForDeletion(key.name, keyData, isDryRun, deleteResults);
120 | processedCount++;
121 | } catch (error) {
122 | logError(`Error processing key ${key.name}:`, error);
123 | deleteResults.errors.push(`Error processing key ${key.name}: ${error.message}`);
124 | }
125 |
126 | if (processedCount >= MAX_KEYS_PER_RUN) {
127 | deleteResults.nextCursor = `${targetServer}:${listResult.cursor}`;
128 | return deleteResults;
129 | }
130 | }
131 |
132 | cursor = listResult.cursor;
133 | } while (cursor);
134 |
135 | return deleteResults;
136 | }
137 |
138 | async function processAllKeys(isDryRun, startCursor) {
139 | const deleteResults = {
140 | processedKeys: [],
141 | errors: [],
142 | nextCursor: null
143 | };
144 |
145 | let globalKeyCount = 0;
146 | const hostnames = await retry(() => API_ENDPOINTS_NAMESPACE.list());
147 | let startHostname = null;
148 | let currentCursor = null;
149 |
150 | if (startCursor) {
151 | [startHostname, currentCursor] = startCursor.split(':');
152 | }
153 |
154 | for (const hostname of hostnames.keys) {
155 | if (startHostname && hostname.name !== startHostname) continue;
156 | startHostname = null;
157 |
158 | try {
159 | const { processedKeys, nextCursor } = await processKeysForServer(hostname.name, isDryRun);
160 | deleteResults.processedKeys.push(...processedKeys);
161 | deleteResults.errors.push(...processedKeys.errors);
162 |
163 | globalKeyCount += processedKeys.length;
164 | if (globalKeyCount >= MAX_KEYS_PER_RUN) {
165 | deleteResults.nextCursor = `${hostname.name}:${nextCursor}`;
166 | break;
167 | }
168 | currentCursor = null;
169 | } catch (error) {
170 | logError(`Error processing hostname ${hostname.name}:`, error);
171 | deleteResults.errors.push(`Error processing hostname ${hostname.name}: ${error.message}`);
172 | }
173 | }
174 |
175 | return deleteResults;
176 | }
177 |
178 | async function processKeyForDeletion(keyName, keyData, isDryRun, deleteResults) {
179 | const now = new Date();
180 | const lastSeen = new Date(keyData.lastSeen);
181 | const daysSinceLastSeen = (now - lastSeen) / (1000 * 60 * 60 * 24);
182 |
183 | const keyInfo = {
184 | key: keyName,
185 | lastSeen: keyData.lastSeen,
186 | daysSinceLastSeen: daysSinceLastSeen.toFixed(2),
187 | currentlyConnected: keyData.currentlyConnected,
188 | expirationDays: EXPIRATION_DAYS,
189 | creationTime: keyData.creationTime,
190 | deletionTime: keyData.deletionTime
191 | };
192 |
193 | const shouldDelete = daysSinceLastSeen > EXPIRATION_DAYS && !keyData.currentlyConnected;
194 |
195 | if (shouldDelete) {
196 | keyInfo.status = isDryRun ? 'Would delete' : 'Deleted';
197 | keyInfo.reason = `Last seen ${daysSinceLastSeen.toFixed(2)} days ago (> ${EXPIRATION_DAYS} days), not currently connected`;
198 |
199 | if (!isDryRun) {
200 | try {
201 | const [hostname, accessKey] = keyName.split('-key-');
202 | const apiEndpointUrl = await retry(() => API_ENDPOINTS_NAMESPACE.get(hostname));
203 |
204 | if (!apiEndpointUrl) {
205 | throw new Error(`API endpoint URL not found for hostname: ${hostname}`);
206 | }
207 |
208 | const deleteResult = await sendDeleteRequest(`${apiEndpointUrl}/access-keys/${accessKey}`);
209 |
210 | if (deleteResult.success) {
211 | keyData.deletionTime = now.toISOString();
212 | keyData.currentlyConnected = null;
213 | await retry(() => ACCESS_KEYS_NAMESPACE.put(keyName, JSON.stringify(keyData)));
214 | keyInfo.deletionTime = keyData.deletionTime;
215 | keyInfo.currentlyConnected = keyData.currentlyConnected;
216 | } else {
217 | throw new Error(`Failed to delete key: ${deleteResult.error}`);
218 | }
219 | } catch (error) {
220 | logError(`Error deleting key ${keyName}:`, error);
221 | keyInfo.status = 'Error';
222 | keyInfo.error = error.message;
223 | }
224 | }
225 | } else {
226 | keyInfo.status = 'Not deleted';
227 | keyInfo.reason = keyData.currentlyConnected
228 | ? 'Currently connected'
229 | : `Last seen ${daysSinceLastSeen.toFixed(2)} days ago (<= ${EXPIRATION_DAYS} days)`;
230 | }
231 |
232 | deleteResults.processedKeys.push(keyInfo);
233 | }
234 |
235 | async function sendDeleteRequest(url) {
236 | try {
237 | logInfo(`Sending DELETE request to: ${url}`);
238 | const response = await fetch(url, { method: 'DELETE' });
239 | if (!response.ok) {
240 | const responseBody = await response.text();
241 | logError(`Failed to delete key. Status: ${response.status}, StatusText: ${response.statusText}`);
242 | logError(`Response body: ${responseBody}`);
243 | return { success: false, error: `Status: ${response.status}, Response: ${responseBody}` };
244 | }
245 | return { success: true };
246 | } catch (error) {
247 | logError(`Error in sendDeleteRequest:`, error);
248 | return { success: false, error: error.message };
249 | }
250 | }
--------------------------------------------------------------------------------
/src/handlers/get.js:
--------------------------------------------------------------------------------
1 | import {
2 | turnstileSecretKey,
3 | turnstileSiteKey,
4 | API_ENDPOINTS_NAMESPACE,
5 | ACCESS_KEYS_NAMESPACE,
6 | EXPIRATION_DAYS,
7 | PREFIX_DISGUISE,
8 | WEIGHT_LATENCY,
9 | WEIGHT_ACCESS_KEY_COUNT,
10 | API_ENDPOINT_TIMEOUT
11 | } from '../config/constants.js';
12 | import { verifyTurnstile } from '../utils/authentication.js';
13 | import { handleError, logError } from '../utils/errorHandling.js';
14 |
15 | // Main request handling function
16 | export async function handleRequest(request) {
17 | const requestHostname = new URL(request.url).hostname;
18 |
19 | if (request.method === "POST") {
20 | const isHuman = await validateFormAndTurnstile(request, turnstileSecretKey);
21 | if (!isHuman) {
22 | return new Response("Cloudflare Turnstile verification failed", { status: 403 });
23 | }
24 |
25 | try {
26 | const endpointKey = await getOptimalApiEndpoint(API_ENDPOINTS_NAMESPACE);
27 | let apiEndpointUrl = await API_ENDPOINTS_NAMESPACE.get(endpointKey);
28 |
29 | if (apiEndpointUrl) {
30 | apiEndpointUrl = modifyApiEndpointUrl(apiEndpointUrl, requestHostname);
31 | }
32 |
33 | if (!apiEndpointUrl) {
34 | return new Response('API endpoint URL not found', { status: 500 });
35 | }
36 |
37 | const accessKeyData = await createNewAccessKey(apiEndpointUrl);
38 | if (accessKeyData && accessKeyData.id) {
39 | const keyId = `${endpointKey}-key-${accessKeyData.id}`;
40 | const currentDate = new Date();
41 |
42 | const keyData = {
43 | creationTime: currentDate.toISOString(),
44 | deletionTime: null,
45 | lastSeen: null,
46 | currentlyConnected: null
47 | };
48 | await ACCESS_KEYS_NAMESPACE.put(keyId, JSON.stringify(keyData));
49 |
50 | const accessKeyOutput = `${accessKeyData.accessUrl}${PREFIX_DISGUISE}`;
51 | const output = generateHtmlOutput(currentDate, accessKeyOutput);
52 | return new Response(output, { headers: { 'content-type': 'text/html' } });
53 | } else {
54 | return new Response('Failed to create access key', { status: 500 });
55 | }
56 | } catch (error) {
57 | logError('Error in creating access key:', error);
58 | if (error.message === 'No available API endpoints.') {
59 | return new Response('Service temporarily unavailable. Please try again later.', { status: 503 });
60 | } else {
61 | return new Response('Error processing your request', { status: 500 });
62 | }
63 | }
64 | } else {
65 | return serveHtmlForm();
66 | }
67 | }
68 |
69 | // Function to modify the API endpoint URL based on the request hostname
70 | function modifyApiEndpointUrl(originalApiEndpointUrl, requestHostname) {
71 | const originalUrl = new URL(originalApiEndpointUrl);
72 | const originalHostnameParts = originalUrl.hostname.split('.');
73 | const requestHostnameParts = requestHostname.split('.');
74 | if (originalHostnameParts.length > 1 && requestHostnameParts.length > 1) {
75 | originalHostnameParts[originalHostnameParts.length - 2] = requestHostnameParts[requestHostnameParts.length - 2];
76 | originalHostnameParts[originalHostnameParts.length - 1] = requestHostnameParts[requestHostnameParts.length - 1];
77 | originalUrl.hostname = originalHostnameParts.join('.');
78 | }
79 | return originalUrl.toString();
80 | }
81 |
82 | // Function to validate the form and Cloudflare Turnstile token
83 | async function validateFormAndTurnstile(request, secret) {
84 | const formData = await request.formData();
85 | const token = formData.get('cf-turnstile-response');
86 | return await verifyTurnstile(token, secret);
87 | }
88 |
89 | // Function to get the optimal API endpoint based on latency and access key count
90 | async function getOptimalApiEndpoint(namespace) {
91 | const endpoints = await namespace.list();
92 | const endpointScores = [];
93 |
94 | const fetchPromises = endpoints.keys.map(async endpoint => {
95 | const apiEndpointUrl = await namespace.get(endpoint.name);
96 | const accessKeysUrl = `${apiEndpointUrl}/access-keys`;
97 |
98 | try {
99 | const controller = new AbortController();
100 | const timeoutId = setTimeout(() => controller.abort(), API_ENDPOINT_TIMEOUT);
101 |
102 | const startTime = performance.now();
103 | const response = await fetch(accessKeysUrl, { signal: controller.signal });
104 | const endTime = performance.now();
105 | const latency = endTime - startTime;
106 |
107 | clearTimeout(timeoutId);
108 |
109 | if (response.ok) {
110 | const accessKeys = await response.json();
111 | const accessKeyCount = accessKeys.accessKeys.length;
112 |
113 | const score = WEIGHT_LATENCY * latency + WEIGHT_ACCESS_KEY_COUNT * accessKeyCount;
114 |
115 | endpointScores.push({ endpoint: endpoint.name, score });
116 | } else {
117 | logError(`Failed to fetch access keys from ${accessKeysUrl}. Status: ${response.status}`);
118 | }
119 | } catch (error) {
120 | if (error.name === 'AbortError') {
121 | logError(`Request to ${accessKeysUrl} timed out.`);
122 | } else {
123 | logError(`Error fetching access keys from ${accessKeysUrl}:`, error);
124 | }
125 | }
126 | });
127 |
128 | try {
129 | await Promise.all(fetchPromises);
130 | } catch (error) {
131 | logError('Error fetching access keys:', error);
132 | }
133 |
134 | if (endpointScores.length === 0) {
135 | throw new Error('No available API endpoints.');
136 | }
137 |
138 | endpointScores.sort((a, b) => a.score - b.score);
139 |
140 | return endpointScores[0].endpoint;
141 | }
142 |
143 | // Function to create a new access key
144 | async function createNewAccessKey(apiEndpointUrl) {
145 | const response = await fetch(apiEndpointUrl + '/access-keys', { method: 'POST' });
146 | if (response.ok) {
147 | return await response.json();
148 | } else {
149 | logError('Failed to create new access key:', response.statusText);
150 | return null;
151 | }
152 | }
153 |
154 | // Function to serve the HTML form
155 | function serveHtmlForm() {
156 | const htmlForm = `
157 |
158 |
159 |
160 | Get an access key
161 |
162 |
181 |
182 |
183 |
186 |
195 |
209 |
210 |
211 | `;
212 |
213 | return new Response(htmlForm, { headers: { 'Content-Type': 'text/html' } });
214 | }
215 |
216 | // Function to generate the HTML output for the access key
217 | function generateHtmlOutput(currentDate, accessKeyOutput) {
218 | return `
219 |
220 |
221 |
222 | Access key generated
223 |
250 |
251 |
252 |
253 |
Access key generated
254 |
Creation date: ${currentDate.toISOString()}
255 |
Expiration date: This key will intelligently expire after ${EXPIRATION_DAYS} days if you don't use it.