-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This adds a Remix adapter. We provide a special `getLoadContext` export which is demonstrated in the example application. It currently looks up the IP from an Express or Deno server, but we're waiting on remix-run/remix#10042 before their Deno plugin will provide the argument we need. Closes #1313
1 parent
c0b2903
commit 32d6d41
Showing
39 changed files
with
13,949 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
/.turbo/ | ||
/coverage/ | ||
/node_modules/ | ||
*.d.ts | ||
*.js | ||
!*.config.js |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
module.exports = { | ||
root: true, | ||
extends: ["@arcjet/eslint-config"], | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,135 @@ | ||
# Logs | ||
logs | ||
*.log | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
lerna-debug.log* | ||
.pnpm-debug.log* | ||
|
||
# Diagnostic reports (https://nodejs.org/api/report.html) | ||
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json | ||
|
||
# Runtime data | ||
pids | ||
*.pid | ||
*.seed | ||
*.pid.lock | ||
|
||
# Directory for instrumented libs generated by jscoverage/JSCover | ||
lib-cov | ||
|
||
# Coverage directory used by tools like istanbul | ||
coverage | ||
*.lcov | ||
|
||
# nyc test coverage | ||
.nyc_output | ||
|
||
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) | ||
.grunt | ||
|
||
# Bower dependency directory (https://bower.io/) | ||
bower_components | ||
|
||
# node-waf configuration | ||
.lock-wscript | ||
|
||
# Compiled binary addons (https://nodejs.org/api/addons.html) | ||
build/Release | ||
|
||
# Dependency directories | ||
node_modules/ | ||
jspm_packages/ | ||
|
||
# Snowpack dependency directory (https://snowpack.dev/) | ||
web_modules/ | ||
|
||
# TypeScript cache | ||
*.tsbuildinfo | ||
|
||
# Optional npm cache directory | ||
.npm | ||
|
||
# Optional eslint cache | ||
.eslintcache | ||
|
||
# Optional stylelint cache | ||
.stylelintcache | ||
|
||
# Microbundle cache | ||
.rpt2_cache/ | ||
.rts2_cache_cjs/ | ||
.rts2_cache_es/ | ||
.rts2_cache_umd/ | ||
|
||
# Optional REPL history | ||
.node_repl_history | ||
|
||
# Output of 'npm pack' | ||
*.tgz | ||
|
||
# Yarn Integrity file | ||
.yarn-integrity | ||
|
||
# dotenv environment variable files | ||
.env | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local | ||
.env.local | ||
|
||
# parcel-bundler cache (https://parceljs.org/) | ||
.cache | ||
.parcel-cache | ||
|
||
# Next.js build output | ||
.next | ||
out | ||
|
||
# Nuxt.js build / generate output | ||
.nuxt | ||
dist | ||
|
||
# Gatsby files | ||
.cache/ | ||
# Comment in the public line in if your project uses Gatsby and not Next.js | ||
# https://nextjs.org/blog/next-9-1#public-directory-support | ||
# public | ||
|
||
# vuepress build output | ||
.vuepress/dist | ||
|
||
# vuepress v2.x temp and cache directory | ||
.temp | ||
.cache | ||
|
||
# Docusaurus cache and generated files | ||
.docusaurus | ||
|
||
# Serverless directories | ||
.serverless/ | ||
|
||
# FuseBox cache | ||
.fusebox/ | ||
|
||
# DynamoDB Local files | ||
.dynamodb/ | ||
|
||
# TernJS port file | ||
.tern-port | ||
|
||
# Stores VSCode versions used for testing VSCode extensions | ||
.vscode-test | ||
|
||
# yarn v2 | ||
.yarn/cache | ||
.yarn/unplugged | ||
.yarn/build-state.yml | ||
.yarn/install-state.gz | ||
.pnp.* | ||
|
||
# Generated files | ||
index.js | ||
index.d.ts | ||
test/*.js |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,201 @@ | ||
Apache License | ||
Version 2.0, January 2004 | ||
http://www.apache.org/licenses/ | ||
|
||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
|
||
1. Definitions. | ||
|
||
"License" shall mean the terms and conditions for use, reproduction, | ||
and distribution as defined by Sections 1 through 9 of this document. | ||
|
||
"Licensor" shall mean the copyright owner or entity authorized by | ||
the copyright owner that is granting the License. | ||
|
||
"Legal Entity" shall mean the union of the acting entity and all | ||
other entities that control, are controlled by, or are under common | ||
control with that entity. For the purposes of this definition, | ||
"control" means (i) the power, direct or indirect, to cause the | ||
direction or management of such entity, whether by contract or | ||
otherwise, or (ii) ownership of fifty percent (50%) or more of the | ||
outstanding shares, or (iii) beneficial ownership of such entity. | ||
|
||
"You" (or "Your") shall mean an individual or Legal Entity | ||
exercising permissions granted by this License. | ||
|
||
"Source" form shall mean the preferred form for making modifications, | ||
including but not limited to software source code, documentation | ||
source, and configuration files. | ||
|
||
"Object" form shall mean any form resulting from mechanical | ||
transformation or translation of a Source form, including but | ||
not limited to compiled object code, generated documentation, | ||
and conversions to other media types. | ||
|
||
"Work" shall mean the work of authorship, whether in Source or | ||
Object form, made available under the License, as indicated by a | ||
copyright notice that is included in or attached to the work | ||
(an example is provided in the Appendix below). | ||
|
||
"Derivative Works" shall mean any work, whether in Source or Object | ||
form, that is based on (or derived from) the Work and for which the | ||
editorial revisions, annotations, elaborations, or other modifications | ||
represent, as a whole, an original work of authorship. For the purposes | ||
of this License, Derivative Works shall not include works that remain | ||
separable from, or merely link (or bind by name) to the interfaces of, | ||
the Work and Derivative Works thereof. | ||
|
||
"Contribution" shall mean any work of authorship, including | ||
the original version of the Work and any modifications or additions | ||
to that Work or Derivative Works thereof, that is intentionally | ||
submitted to Licensor for inclusion in the Work by the copyright owner | ||
or by an individual or Legal Entity authorized to submit on behalf of | ||
the copyright owner. For the purposes of this definition, "submitted" | ||
means any form of electronic, verbal, or written communication sent | ||
to the Licensor or its representatives, including but not limited to | ||
communication on electronic mailing lists, source code control systems, | ||
and issue tracking systems that are managed by, or on behalf of, the | ||
Licensor for the purpose of discussing and improving the Work, but | ||
excluding communication that is conspicuously marked or otherwise | ||
designated in writing by the copyright owner as "Not a Contribution." | ||
|
||
"Contributor" shall mean Licensor and any individual or Legal Entity | ||
on behalf of whom a Contribution has been received by Licensor and | ||
subsequently incorporated within the Work. | ||
|
||
2. Grant of Copyright License. Subject to the terms and conditions of | ||
this License, each Contributor hereby grants to You a perpetual, | ||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
copyright license to reproduce, prepare Derivative Works of, | ||
publicly display, publicly perform, sublicense, and distribute the | ||
Work and such Derivative Works in Source or Object form. | ||
|
||
3. Grant of Patent License. Subject to the terms and conditions of | ||
this License, each Contributor hereby grants to You a perpetual, | ||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
(except as stated in this section) patent license to make, have made, | ||
use, offer to sell, sell, import, and otherwise transfer the Work, | ||
where such license applies only to those patent claims licensable | ||
by such Contributor that are necessarily infringed by their | ||
Contribution(s) alone or by combination of their Contribution(s) | ||
with the Work to which such Contribution(s) was submitted. If You | ||
institute patent litigation against any entity (including a | ||
cross-claim or counterclaim in a lawsuit) alleging that the Work | ||
or a Contribution incorporated within the Work constitutes direct | ||
or contributory patent infringement, then any patent licenses | ||
granted to You under this License for that Work shall terminate | ||
as of the date such litigation is filed. | ||
|
||
4. Redistribution. You may reproduce and distribute copies of the | ||
Work or Derivative Works thereof in any medium, with or without | ||
modifications, and in Source or Object form, provided that You | ||
meet the following conditions: | ||
|
||
(a) You must give any other recipients of the Work or | ||
Derivative Works a copy of this License; and | ||
|
||
(b) You must cause any modified files to carry prominent notices | ||
stating that You changed the files; and | ||
|
||
(c) You must retain, in the Source form of any Derivative Works | ||
that You distribute, all copyright, patent, trademark, and | ||
attribution notices from the Source form of the Work, | ||
excluding those notices that do not pertain to any part of | ||
the Derivative Works; and | ||
|
||
(d) If the Work includes a "NOTICE" text file as part of its | ||
distribution, then any Derivative Works that You distribute must | ||
include a readable copy of the attribution notices contained | ||
within such NOTICE file, excluding those notices that do not | ||
pertain to any part of the Derivative Works, in at least one | ||
of the following places: within a NOTICE text file distributed | ||
as part of the Derivative Works; within the Source form or | ||
documentation, if provided along with the Derivative Works; or, | ||
within a display generated by the Derivative Works, if and | ||
wherever such third-party notices normally appear. The contents | ||
of the NOTICE file are for informational purposes only and | ||
do not modify the License. You may add Your own attribution | ||
notices within Derivative Works that You distribute, alongside | ||
or as an addendum to the NOTICE text from the Work, provided | ||
that such additional attribution notices cannot be construed | ||
as modifying the License. | ||
|
||
You may add Your own copyright statement to Your modifications and | ||
may provide additional or different license terms and conditions | ||
for use, reproduction, or distribution of Your modifications, or | ||
for any such Derivative Works as a whole, provided Your use, | ||
reproduction, and distribution of the Work otherwise complies with | ||
the conditions stated in this License. | ||
|
||
5. Submission of Contributions. Unless You explicitly state otherwise, | ||
any Contribution intentionally submitted for inclusion in the Work | ||
by You to the Licensor shall be under the terms and conditions of | ||
this License, without any additional terms or conditions. | ||
Notwithstanding the above, nothing herein shall supersede or modify | ||
the terms of any separate license agreement you may have executed | ||
with Licensor regarding such Contributions. | ||
|
||
6. Trademarks. This License does not grant permission to use the trade | ||
names, trademarks, service marks, or product names of the Licensor, | ||
except as required for reasonable and customary use in describing the | ||
origin of the Work and reproducing the content of the NOTICE file. | ||
|
||
7. Disclaimer of Warranty. Unless required by applicable law or | ||
agreed to in writing, Licensor provides the Work (and each | ||
Contributor provides its Contributions) on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
implied, including, without limitation, any warranties or conditions | ||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | ||
PARTICULAR PURPOSE. You are solely responsible for determining the | ||
appropriateness of using or redistributing the Work and assume any | ||
risks associated with Your exercise of permissions under this License. | ||
|
||
8. Limitation of Liability. In no event and under no legal theory, | ||
whether in tort (including negligence), contract, or otherwise, | ||
unless required by applicable law (such as deliberate and grossly | ||
negligent acts) or agreed to in writing, shall any Contributor be | ||
liable to You for damages, including any direct, indirect, special, | ||
incidental, or consequential damages of any character arising as a | ||
result of this License or out of the use or inability to use the | ||
Work (including but not limited to damages for loss of goodwill, | ||
work stoppage, computer failure or malfunction, or any and all | ||
other commercial damages or losses), even if such Contributor | ||
has been advised of the possibility of such damages. | ||
|
||
9. Accepting Warranty or Additional Liability. While redistributing | ||
the Work or Derivative Works thereof, You may choose to offer, | ||
and charge a fee for, acceptance of support, warranty, indemnity, | ||
or other liability obligations and/or rights consistent with this | ||
License. However, in accepting such obligations, You may act only | ||
on Your own behalf and on Your sole responsibility, not on behalf | ||
of any other Contributor, and only if You agree to indemnify, | ||
defend, and hold each Contributor harmless for any liability | ||
incurred by, or claims asserted against, such Contributor by reason | ||
of your accepting any such warranty or additional liability. | ||
|
||
END OF TERMS AND CONDITIONS | ||
|
||
APPENDIX: How to apply the Apache License to your work. | ||
|
||
To apply the Apache License to your work, attach the following | ||
boilerplate notice, with the fields enclosed by brackets "[]" | ||
replaced with your own identifying information. (Don't include | ||
the brackets!) The text should be enclosed in the appropriate | ||
comment syntax for the file format. We also recommend that a | ||
file or class name and description of purpose be included on the | ||
same "printed page" as the copyright notice for easier | ||
identification within third-party archives. | ||
|
||
Copyright [yyyy] [name of copyright owner] | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
|
||
http://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,140 @@ | ||
<a href="https://arcjet.com" target="_arcjet-home"> | ||
<picture> | ||
<source media="(prefers-color-scheme: dark)" srcset="https://arcjet.com/logo/arcjet-dark-lockup-voyage-horizontal.svg"> | ||
<img src="https://arcjet.com/logo/arcjet-light-lockup-voyage-horizontal.svg" alt="Arcjet Logo" height="128" width="auto"> | ||
</picture> | ||
</a> | ||
|
||
# `@arcjet/remix` | ||
|
||
<p> | ||
<a href="https://www.npmjs.com/package/@arcjet/remix"> | ||
<picture> | ||
<source media="(prefers-color-scheme: dark)" srcset="https://img.shields.io/npm/v/%40arcjet%2Fremix?style=flat-square&label=%E2%9C%A6Aj&labelColor=000000&color=5C5866"> | ||
<img alt="npm badge" src="https://img.shields.io/npm/v/%40arcjet%2Fremix?style=flat-square&label=%E2%9C%A6Aj&labelColor=ECE6F0&color=ECE6F0"> | ||
</picture> | ||
</a> | ||
</p> | ||
|
||
[Arcjet][arcjet] helps developers protect their apps in just a few lines of | ||
code. Implement rate limiting, bot protection, email verification, and defense | ||
against common attacks. | ||
|
||
This is the [Arcjet][arcjet] SDK for [Remix][remix]. | ||
|
||
## Example app | ||
|
||
Try an Arcjet protected app live at [https://example.arcjet.com][example-url] | ||
([source code][example-source]). | ||
|
||
## Installation | ||
|
||
```shell | ||
npm install @arcjet/remix | ||
``` | ||
|
||
## Rate limit + bot detection example | ||
|
||
The [Arcjet rate limit][rate-limit-concepts-docs] example below applies a token | ||
bucket rate limit rule to a route where we identify the user based on their ID | ||
e.g. if they are logged in. The bucket is configured with a maximum capacity of | ||
10 tokens and refills by 5 tokens every 10 seconds. Each request consumes 5 | ||
tokens. | ||
|
||
```tsx | ||
import { useLoaderData } from "@remix-run/react"; | ||
import { json, LoaderFunctionArgs } from "@remix-run/node"; | ||
|
||
import arcjet, { tokenBucket, detectBot } from "@arcjet/remix"; | ||
|
||
const aj = arcjet({ | ||
key: process.env.ARCJET_KEY!, // Get your site key from https://app.arcjet.com | ||
characteristics: ["userId"], // track requests by a custom user ID | ||
rules: [ | ||
// Create a token bucket rate limit. Other algorithms are supported. | ||
tokenBucket({ | ||
mode: "LIVE", // will block requests. Use "DRY_RUN" to log only | ||
refillRate: 5, // refill 5 tokens per interval | ||
interval: 10, // refill every 10 seconds | ||
capacity: 10, // bucket maximum capacity of 10 tokens | ||
}), | ||
detectBot({ | ||
mode: "LIVE", // will block requests. Use "DRY_RUN" to log only | ||
// configured with a list of bots to allow from | ||
// https://arcjet.com/bot-list | ||
allow: [], // "allow none" will block all detected bots | ||
}), | ||
], | ||
}); | ||
|
||
export async function loader(args: LoaderFunctionArgs) { | ||
const decision = await aj.protect(args); | ||
|
||
if (decision.isDenied()) { | ||
if (decision.reason.isRateLimit()) { | ||
throw new Response(null, { | ||
status: 429, | ||
statusText: "Too Many Requests", | ||
}); | ||
} else { | ||
throw new Response(null, { status: 403, statusText: "Forbidden" }); | ||
} | ||
} | ||
|
||
return json({ message: "Hello Arcjet" }); | ||
} | ||
|
||
export default function Index() { | ||
const data = useLoaderData<typeof loader>(); | ||
return <h1>{data.message}</h1>; | ||
} | ||
``` | ||
|
||
## Shield example | ||
|
||
[Arcjet Shield][shield-concepts-docs] protects your application against common | ||
attacks, including the OWASP Top 10. You can run Shield on every request with | ||
negligible performance impact. | ||
|
||
```tsx | ||
import { useLoaderData } from "@remix-run/react"; | ||
import { json, LoaderFunctionArgs } from "@remix-run/node"; | ||
|
||
import arcjet, { shield } from "@arcjet/remix"; | ||
|
||
const aj = arcjet({ | ||
key: process.env.ARCJET_KEY, // Get your site key from https://app.arcjet.com | ||
rules: [ | ||
shield({ | ||
mode: "LIVE", // will block requests. Use "DRY_RUN" to log only | ||
}), | ||
], | ||
}); | ||
|
||
export async function loader(args: LoaderFunctionArgs) { | ||
const decision = await aj.protect(args); | ||
|
||
if (decision.isDenied()) { | ||
throw new Response(null, { status: 403, statusText: "Forbidden" }); | ||
} | ||
|
||
return json({ message: "Hello Arcjet" }); | ||
} | ||
|
||
export default function Index() { | ||
const data = useLoaderData<typeof loader>(); | ||
return <h1>{data.message}</h1>; | ||
} | ||
``` | ||
|
||
## License | ||
|
||
Licensed under the [Apache License, Version 2.0][apache-license]. | ||
|
||
[arcjet]: https://arcjet.com | ||
[remix]: https://remix.run/ | ||
[example-url]: https://example.arcjet.com | ||
[example-source]: https://github.com/arcjet/arcjet-js-example | ||
[rate-limit-concepts-docs]: https://docs.arcjet.com/rate-limiting/concepts | ||
[shield-concepts-docs]: https://docs.arcjet.com/shield/concepts | ||
[apache-license]: http://www.apache.org/licenses/LICENSE-2.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,296 @@ | ||
import core from "arcjet"; | ||
import type { | ||
ArcjetDecision, | ||
ArcjetOptions, | ||
Primitive, | ||
Product, | ||
ArcjetRequest, | ||
ExtraProps, | ||
Arcjet, | ||
CharacteristicProps, | ||
} from "arcjet"; | ||
import findIP from "@arcjet/ip"; | ||
import ArcjetHeaders from "@arcjet/headers"; | ||
import { baseUrl, isDevelopment, logLevel, platform } from "@arcjet/env"; | ||
import { Logger } from "@arcjet/logger"; | ||
import { createClient } from "@arcjet/protocol/client.js"; | ||
import { createTransport } from "@arcjet/transport"; | ||
|
||
// Re-export all named exports from the generic SDK | ||
export * from "arcjet"; | ||
|
||
// TODO: Deduplicate with other packages | ||
function errorMessage(err: unknown): string { | ||
if (err) { | ||
if (typeof err === "string") { | ||
return err; | ||
} | ||
|
||
if ( | ||
typeof err === "object" && | ||
"message" in err && | ||
typeof err.message === "string" | ||
) { | ||
return err.message; | ||
} | ||
} | ||
|
||
return "Unknown problem"; | ||
} | ||
|
||
// Type helpers from https://github.com/sindresorhus/type-fest but adjusted for | ||
// our use. | ||
// | ||
// Simplify: | ||
// https://github.com/sindresorhus/type-fest/blob/964466c9d59c711da57a5297ad954c13132a0001/source/simplify.d.ts | ||
// EmptyObject: | ||
// https://github.com/sindresorhus/type-fest/blob/b9723d4785f01f8d2487c09ee5871a1f615781aa/source/empty-object.d.ts | ||
// | ||
// Licensed: MIT License Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> | ||
// (https://sindresorhus.com) | ||
// | ||
// Permission is hereby granted, free of charge, to any person obtaining a copy | ||
// of this software and associated documentation files (the "Software"), to deal | ||
// in the Software without restriction, including without limitation the rights | ||
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
// copies of the Software, and to permit persons to whom the Software is | ||
// furnished to do so, subject to the following conditions: The above copyright | ||
// notice and this permission notice shall be included in all copies or | ||
// substantial portions of the Software. | ||
// | ||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
// SOFTWARE. | ||
type Simplify<T> = { [KeyType in keyof T]: T[KeyType] } & {}; | ||
declare const emptyObjectSymbol: unique symbol; | ||
type WithoutCustomProps = { | ||
[emptyObjectSymbol]?: never; | ||
}; | ||
|
||
type PlainObject = { | ||
[key: string]: unknown; | ||
}; | ||
|
||
export type RemoteClientOptions = { | ||
baseUrl?: string; | ||
timeout?: number; | ||
}; | ||
|
||
export function createRemoteClient(options?: RemoteClientOptions) { | ||
// The base URL for the Arcjet API. Will default to the standard production | ||
// API unless environment variable `ARCJET_BASE_URL` is set. | ||
const url = options?.baseUrl ?? baseUrl(process.env); | ||
|
||
// The timeout for the Arcjet API in milliseconds. This is set to a low value | ||
// in production so calls fail open. | ||
const timeout = options?.timeout ?? (isDevelopment(process.env) ? 1000 : 500); | ||
|
||
// Transport is the HTTP client that the client uses to make requests. | ||
const transport = createTransport(url); | ||
|
||
const sdkStack = "REMIX"; | ||
const sdkVersion = "__ARCJET_SDK_VERSION__"; | ||
|
||
return createClient({ | ||
transport, | ||
baseUrl: url, | ||
timeout, | ||
sdkStack, | ||
sdkVersion, | ||
}); | ||
} | ||
|
||
export type ArcjetRemixRequest = { | ||
request: Request; | ||
context: { [key: string]: unknown }; | ||
}; | ||
|
||
/** | ||
* The ArcjetRemix client provides a public `protect()` method to | ||
* make a decision about how a Remix request should be handled. | ||
*/ | ||
export interface ArcjetRemix<Props extends PlainObject> { | ||
/** | ||
* Runs a request through the configured protections. The request is | ||
* analyzed and then a decision made on whether to allow, deny, or challenge | ||
* the request. | ||
* | ||
* @param request - A `ArcjetRemixRequest` provided to the fetch handler. | ||
* @param props - Additonal properties required for running rules against a request. | ||
* @returns An {@link ArcjetDecision} indicating Arcjet's decision about the request. | ||
*/ | ||
protect( | ||
request: ArcjetRemixRequest, | ||
// We use this neat trick from https://stackoverflow.com/a/52318137 to make a single spread parameter | ||
// that is required if the ExtraProps aren't strictly an empty object | ||
...props: Props extends WithoutCustomProps ? [] : [Props] | ||
): Promise<ArcjetDecision>; | ||
|
||
/** | ||
* Augments the client with another rule. Useful for varying rules based on | ||
* criteria in your handler—e.g. different rate limit for logged in users. | ||
* | ||
* @param rule The rule to add to this execution. | ||
* @returns An augmented {@link ArcjetRemix} client. | ||
*/ | ||
withRule<Rule extends Primitive | Product>( | ||
rule: Rule, | ||
): ArcjetRemix<Simplify<Props & ExtraProps<Rule>>>; | ||
} | ||
|
||
/** | ||
* Create a new {@link ArcjetRemix} client. Always build your initial client | ||
* outside of a request handler so it persists across requests. If you need to | ||
* augment a client inside a handler, call the `withRule()` function on the base | ||
* client. | ||
* | ||
* @param options - Arcjet configuration options to apply to all requests. | ||
*/ | ||
export default function arcjet< | ||
const Rules extends (Primitive | Product)[], | ||
const Characteristics extends readonly string[], | ||
>( | ||
options: ArcjetOptions<Rules, Characteristics>, | ||
): ArcjetRemix< | ||
Simplify<ExtraProps<Rules> & CharacteristicProps<Characteristics>> | ||
> { | ||
const client = options.client ?? createRemoteClient(); | ||
|
||
const log = options.log | ||
? options.log | ||
: new Logger({ | ||
level: logLevel(process.env), | ||
}); | ||
|
||
function toArcjetRequest<Props extends PlainObject>( | ||
{ request, context }: ArcjetRemixRequest, | ||
props: Props, | ||
): ArcjetRequest<Props> { | ||
const cookies = request.headers.get("cookie") ?? undefined; | ||
|
||
// We construct an ArcjetHeaders to normalize over Headers | ||
const headers = new ArcjetHeaders(request.headers); | ||
|
||
const url = new URL(request.url); | ||
let ip = findIP( | ||
{ | ||
// The `getLoadContext` API will attach the `ip` to the context | ||
ip: context?.ip, | ||
}, | ||
headers, | ||
{ platform: platform(process.env) }, | ||
); | ||
if (ip === "") { | ||
// If the `ip` is empty but we're in development mode, we default the IP | ||
// so the request doesn't fail. | ||
if (isDevelopment(process.env)) { | ||
log.warn("Using 127.0.0.1 as IP address in development mode"); | ||
ip = "127.0.0.1"; | ||
} else { | ||
log.warn( | ||
`Client IP address is missing. If this is a dev environment set the ARCJET_ENV env var to "development"`, | ||
); | ||
} | ||
} | ||
|
||
return { | ||
...props, | ||
ip, | ||
method: request.method, | ||
protocol: url.protocol, | ||
host: url.host, | ||
path: url.pathname, | ||
headers, | ||
cookies, | ||
query: url.search, | ||
}; | ||
} | ||
|
||
function withClient<const Rules extends (Primitive | Product)[]>( | ||
aj: Arcjet<ExtraProps<Rules>>, | ||
): ArcjetRemix<ExtraProps<Rules>> { | ||
return Object.freeze({ | ||
withRule(rule: Primitive | Product) { | ||
const client = aj.withRule(rule); | ||
return withClient(client); | ||
}, | ||
async protect( | ||
details: ArcjetRemixRequest, | ||
...[props]: ExtraProps<Rules> extends WithoutCustomProps | ||
? [] | ||
: [ExtraProps<Rules>] | ||
): Promise<ArcjetDecision> { | ||
// TODO(#220): The generic manipulations get really mad here, so we cast | ||
// Further investigation makes it seem like it has something to do with | ||
// the definition of `props` in the signature but it's hard to track down | ||
const req = toArcjetRequest(details, props ?? {}) as ArcjetRequest< | ||
ExtraProps<Rules> | ||
>; | ||
|
||
const getBody = async () => { | ||
try { | ||
const clonedRequest = details.request.clone(); | ||
// Awaited to throw if it rejects and we'll just return undefined | ||
const body = await clonedRequest.text(); | ||
return body; | ||
} catch (e) { | ||
log.error("failed to get request body: %s", errorMessage(e)); | ||
return; | ||
} | ||
}; | ||
|
||
return aj.protect({ getBody }, req); | ||
}, | ||
}); | ||
} | ||
|
||
const aj = core({ ...options, client, log }); | ||
|
||
return withClient(aj); | ||
} | ||
|
||
/** | ||
* Provides additional details via Remix's AppLoadContext when calling the SDK's | ||
* `protect()` function. | ||
*/ | ||
export function getLoadContext(...args: unknown[]): { ip: string | undefined } { | ||
const maybeReq = args[0]; | ||
if ( | ||
typeof maybeReq === "object" && | ||
maybeReq !== null && | ||
"ip" in maybeReq && | ||
typeof maybeReq.ip === "string" | ||
) { | ||
return { | ||
ip: maybeReq.ip, | ||
}; | ||
} | ||
|
||
const maybeInfo = args[1]; | ||
if ( | ||
typeof maybeInfo === "object" && | ||
maybeInfo !== null && | ||
"remoteAddr" in maybeInfo && | ||
typeof maybeInfo.remoteAddr === "object" && | ||
maybeInfo.remoteAddr !== null && | ||
"transport" in maybeInfo.remoteAddr && | ||
maybeInfo.remoteAddr.transport === "tcp" && | ||
"hostname" in maybeInfo.remoteAddr && | ||
typeof maybeInfo.remoteAddr.hostname === "string" | ||
) { | ||
return { | ||
// According to https://stackoverflow.com/a/71011282, "Technically, it's | ||
// the remote hostname, but it's very likely to be an IP address unless | ||
// you have configured custom DNS settings in your server environment" | ||
ip: maybeInfo.remoteAddr.hostname, | ||
}; | ||
} | ||
|
||
return { | ||
ip: undefined, | ||
}; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
/** @type {import('jest').Config} */ | ||
const config = { | ||
// We only test JS files once compiled with TypeScript | ||
moduleFileExtensions: ["js"], | ||
coverageDirectory: "coverage", | ||
collectCoverage: true, | ||
// If this is set to default (babel) rather than v8, tests fail with the edge | ||
// runtime and the error "EvalError: Code generation from strings disallowed | ||
// for this context". Tracking in | ||
// https://github.com/vercel/edge-runtime/issues/250 | ||
coverageProvider: "v8", | ||
verbose: true, | ||
testEnvironment: "node", | ||
}; | ||
|
||
export default config; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
{ | ||
"name": "@arcjet/remix", | ||
"version": "1.0.0-alpha.27", | ||
"description": "Arcjet SDK for Remix", | ||
"license": "Apache-2.0", | ||
"homepage": "https://arcjet.com", | ||
"repository": { | ||
"type": "git", | ||
"url": "git+https://github.com/arcjet/arcjet-js.git", | ||
"directory": "arcjet-remix" | ||
}, | ||
"bugs": { | ||
"url": "https://github.com/arcjet/arcjet-js/issues", | ||
"email": "support@arcjet.com" | ||
}, | ||
"author": { | ||
"name": "Arcjet", | ||
"email": "support@arcjet.com", | ||
"url": "https://arcjet.com" | ||
}, | ||
"engines": {}, | ||
"type": "module", | ||
"main": "./index.js", | ||
"types": "./index.d.ts", | ||
"files": [ | ||
"LICENSE", | ||
"README.md", | ||
"*.js", | ||
"*.d.ts", | ||
"*.ts", | ||
"!*.config.js" | ||
], | ||
"scripts": { | ||
"prepublishOnly": "npm run build", | ||
"build": "rollup --config rollup.config.js", | ||
"lint": "eslint .", | ||
"pretest": "npm run build", | ||
"test": "NODE_OPTIONS=--experimental-vm-modules jest --passWithNoTests" | ||
}, | ||
"dependencies": { | ||
"@arcjet/env": "1.0.0-alpha.27", | ||
"@arcjet/headers": "1.0.0-alpha.27", | ||
"@arcjet/ip": "1.0.0-alpha.27", | ||
"@arcjet/logger": "1.0.0-alpha.27", | ||
"@arcjet/protocol": "1.0.0-alpha.27", | ||
"@arcjet/transport": "1.0.0-alpha.27", | ||
"arcjet": "1.0.0-alpha.27" | ||
}, | ||
"devDependencies": { | ||
"@arcjet/eslint-config": "1.0.0-alpha.27", | ||
"@arcjet/rollup-config": "1.0.0-alpha.27", | ||
"@arcjet/tsconfig": "1.0.0-alpha.27", | ||
"@jest/globals": "29.7.0", | ||
"@rollup/wasm-node": "4.24.0", | ||
"jest": "29.7.0", | ||
"typescript": "5.6.2" | ||
}, | ||
"publishConfig": { | ||
"access": "public", | ||
"tag": "latest" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
import { createConfig } from "@arcjet/rollup-config"; | ||
|
||
export default createConfig(import.meta.url); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"extends": "@arcjet/tsconfig/base", | ||
"include": ["index.ts"] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# Add your Arcjet key from https://app.arcjet.com | ||
ARCJET_KEY= |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
/** | ||
* This is intended to be a basic starting point for linting in your app. | ||
* It relies on recommended configs out of the box for simplicity, but you can | ||
* and should modify this configuration to best suit your team's needs. | ||
*/ | ||
|
||
/** @type {import('eslint').Linter.Config} */ | ||
module.exports = { | ||
root: true, | ||
parserOptions: { | ||
ecmaVersion: "latest", | ||
sourceType: "module", | ||
ecmaFeatures: { | ||
jsx: true, | ||
}, | ||
}, | ||
env: { | ||
browser: true, | ||
commonjs: true, | ||
es6: true, | ||
}, | ||
ignorePatterns: ["!**/.server", "!**/.client"], | ||
|
||
// Base config | ||
extends: ["eslint:recommended"], | ||
|
||
overrides: [ | ||
// React | ||
{ | ||
files: ["**/*.{js,jsx,ts,tsx}"], | ||
plugins: ["react", "jsx-a11y"], | ||
extends: [ | ||
"plugin:react/recommended", | ||
"plugin:react/jsx-runtime", | ||
"plugin:react-hooks/recommended", | ||
"plugin:jsx-a11y/recommended", | ||
], | ||
settings: { | ||
react: { | ||
version: "detect", | ||
}, | ||
formComponents: ["Form"], | ||
linkComponents: [ | ||
{ name: "Link", linkAttribute: "to" }, | ||
{ name: "NavLink", linkAttribute: "to" }, | ||
], | ||
"import/resolver": { | ||
typescript: {}, | ||
}, | ||
}, | ||
}, | ||
|
||
// Typescript | ||
{ | ||
files: ["**/*.{ts,tsx}"], | ||
plugins: ["@typescript-eslint", "import"], | ||
parser: "@typescript-eslint/parser", | ||
settings: { | ||
"import/internal-regex": "^~/", | ||
"import/resolver": { | ||
node: { | ||
extensions: [".ts", ".tsx"], | ||
}, | ||
typescript: { | ||
alwaysTryTypes: true, | ||
}, | ||
}, | ||
}, | ||
extends: [ | ||
"plugin:@typescript-eslint/recommended", | ||
"plugin:import/recommended", | ||
"plugin:import/typescript", | ||
], | ||
}, | ||
|
||
// Node | ||
{ | ||
files: [".eslintrc.cjs", "server.js"], | ||
env: { | ||
node: true, | ||
}, | ||
}, | ||
], | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
node_modules | ||
|
||
/.cache | ||
/build | ||
.env |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
<a href="https://arcjet.com" target="_arcjet-home"> | ||
<picture> | ||
<source media="(prefers-color-scheme: dark)" srcset="https://arcjet.com/logo/arcjet-dark-lockup-voyage-horizontal.svg"> | ||
<img src="https://arcjet.com/logo/arcjet-light-lockup-voyage-horizontal.svg" alt="Arcjet Logo" height="128" width="auto"> | ||
</picture> | ||
</a> | ||
|
||
# Arcjet protections with Remix | ||
|
||
This example shows how to leverage Arcjet protections in a | ||
[Remix](https://remix.run/) application. | ||
|
||
## How to use | ||
|
||
1. From the root of the project, install the SDK dependencies. | ||
|
||
```bash | ||
npm ci | ||
``` | ||
|
||
2. Enter this directory. | ||
|
||
```bash | ||
cd examples/remix-express | ||
``` | ||
|
||
3. Rename `.env.example` to `.env` and add your Arcjet key. | ||
|
||
4. Start the server. | ||
|
||
```bash | ||
npm start | ||
``` | ||
|
||
5. Visit `http://localhost:3000/`. | ||
|
||
6. Submit the form with some sensitive information and get denied. | ||
|
||
7. Go back to `http://localhost:3000/` and refresh the page a view times to be | ||
rate limited. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
import arcjet, { fixedWindow, sensitiveInfo, shield } from "@arcjet/remix"; | ||
|
||
export const aj = arcjet({ | ||
key: process.env.ARCJET_KEY!, | ||
rules: [ | ||
shield({ mode: "LIVE" }), | ||
fixedWindow({ | ||
mode: "LIVE", | ||
window: "10s", | ||
max: 5 | ||
}), | ||
sensitiveInfo({ | ||
mode: "LIVE", | ||
allow: [] | ||
}), | ||
] | ||
}) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
/** | ||
* By default, Remix will handle hydrating your app on the client for you. | ||
* You are free to delete this file if you'd like to, but if you ever want it revealed again, you can run `npx remix reveal` ✨ | ||
* For more information, see https://remix.run/file-conventions/entry.client | ||
*/ | ||
|
||
import { RemixBrowser } from "@remix-run/react"; | ||
import { startTransition, StrictMode } from "react"; | ||
import { hydrateRoot } from "react-dom/client"; | ||
|
||
startTransition(() => { | ||
hydrateRoot( | ||
document, | ||
<StrictMode> | ||
<RemixBrowser /> | ||
</StrictMode> | ||
); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,140 @@ | ||
/** | ||
* By default, Remix will handle generating the HTTP Response for you. | ||
* You are free to delete this file if you'd like to, but if you ever want it revealed again, you can run `npx remix reveal` ✨ | ||
* For more information, see https://remix.run/file-conventions/entry.server | ||
*/ | ||
|
||
import { PassThrough } from "node:stream"; | ||
|
||
import type { AppLoadContext, EntryContext } from "@remix-run/node"; | ||
import { createReadableStreamFromReadable } from "@remix-run/node"; | ||
import { RemixServer } from "@remix-run/react"; | ||
import { isbot } from "isbot"; | ||
import { renderToPipeableStream } from "react-dom/server"; | ||
|
||
const ABORT_DELAY = 5_000; | ||
|
||
export default function handleRequest( | ||
request: Request, | ||
responseStatusCode: number, | ||
responseHeaders: Headers, | ||
remixContext: EntryContext, | ||
// This is ignored so we can keep it in the template for visibility. Feel | ||
// free to delete this parameter in your app if you're not using it! | ||
// eslint-disable-next-line @typescript-eslint/no-unused-vars | ||
loadContext: AppLoadContext | ||
) { | ||
return isbot(request.headers.get("user-agent") || "") | ||
? handleBotRequest( | ||
request, | ||
responseStatusCode, | ||
responseHeaders, | ||
remixContext | ||
) | ||
: handleBrowserRequest( | ||
request, | ||
responseStatusCode, | ||
responseHeaders, | ||
remixContext | ||
); | ||
} | ||
|
||
function handleBotRequest( | ||
request: Request, | ||
responseStatusCode: number, | ||
responseHeaders: Headers, | ||
remixContext: EntryContext | ||
) { | ||
return new Promise((resolve, reject) => { | ||
let shellRendered = false; | ||
const { pipe, abort } = renderToPipeableStream( | ||
<RemixServer | ||
context={remixContext} | ||
url={request.url} | ||
abortDelay={ABORT_DELAY} | ||
/>, | ||
{ | ||
onAllReady() { | ||
shellRendered = true; | ||
const body = new PassThrough(); | ||
const stream = createReadableStreamFromReadable(body); | ||
|
||
responseHeaders.set("Content-Type", "text/html"); | ||
|
||
resolve( | ||
new Response(stream, { | ||
headers: responseHeaders, | ||
status: responseStatusCode, | ||
}) | ||
); | ||
|
||
pipe(body); | ||
}, | ||
onShellError(error: unknown) { | ||
reject(error); | ||
}, | ||
onError(error: unknown) { | ||
responseStatusCode = 500; | ||
// Log streaming rendering errors from inside the shell. Don't log | ||
// errors encountered during initial shell rendering since they'll | ||
// reject and get logged in handleDocumentRequest. | ||
if (shellRendered) { | ||
console.error(error); | ||
} | ||
}, | ||
} | ||
); | ||
|
||
setTimeout(abort, ABORT_DELAY); | ||
}); | ||
} | ||
|
||
function handleBrowserRequest( | ||
request: Request, | ||
responseStatusCode: number, | ||
responseHeaders: Headers, | ||
remixContext: EntryContext | ||
) { | ||
return new Promise((resolve, reject) => { | ||
let shellRendered = false; | ||
const { pipe, abort } = renderToPipeableStream( | ||
<RemixServer | ||
context={remixContext} | ||
url={request.url} | ||
abortDelay={ABORT_DELAY} | ||
/>, | ||
{ | ||
onShellReady() { | ||
shellRendered = true; | ||
const body = new PassThrough(); | ||
const stream = createReadableStreamFromReadable(body); | ||
|
||
responseHeaders.set("Content-Type", "text/html"); | ||
|
||
resolve( | ||
new Response(stream, { | ||
headers: responseHeaders, | ||
status: responseStatusCode, | ||
}) | ||
); | ||
|
||
pipe(body); | ||
}, | ||
onShellError(error: unknown) { | ||
reject(error); | ||
}, | ||
onError(error: unknown) { | ||
responseStatusCode = 500; | ||
// Log streaming rendering errors from inside the shell. Don't log | ||
// errors encountered during initial shell rendering since they'll | ||
// reject and get logged in handleDocumentRequest. | ||
if (shellRendered) { | ||
console.error(error); | ||
} | ||
}, | ||
} | ||
); | ||
|
||
setTimeout(abort, ABORT_DELAY); | ||
}); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
import { | ||
Links, | ||
Meta, | ||
Outlet, | ||
Scripts, | ||
ScrollRestoration, | ||
} from "@remix-run/react"; | ||
import type { LinksFunction } from "@remix-run/node"; | ||
|
||
import "./tailwind.css"; | ||
|
||
export const links: LinksFunction = () => [ | ||
{ rel: "preconnect", href: "https://fonts.googleapis.com" }, | ||
{ | ||
rel: "preconnect", | ||
href: "https://fonts.gstatic.com", | ||
crossOrigin: "anonymous", | ||
}, | ||
{ | ||
rel: "stylesheet", | ||
href: "https://fonts.googleapis.com/css2?family=Inter:ital,opsz,wght@0,14..32,100..900;1,14..32,100..900&display=swap", | ||
}, | ||
]; | ||
|
||
export function Layout({ children }: { children: React.ReactNode }) { | ||
return ( | ||
<html lang="en"> | ||
<head> | ||
<meta charSet="utf-8" /> | ||
<meta name="viewport" content="width=device-width, initial-scale=1" /> | ||
<Meta /> | ||
<Links /> | ||
</head> | ||
<body> | ||
{children} | ||
<ScrollRestoration /> | ||
<Scripts /> | ||
</body> | ||
</html> | ||
); | ||
} | ||
|
||
export default function App() { | ||
return <Outlet />; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
import type { ActionFunctionArgs, LoaderFunctionArgs, MetaFunction } from "@remix-run/node"; | ||
import { Form, redirect, useLoaderData } from "@remix-run/react"; | ||
import { json } from "@remix-run/node"; | ||
|
||
import { aj } from "../arcjet"; | ||
|
||
export const meta: MetaFunction = () => { | ||
return [ | ||
{ title: "Arcjet + Remix App" }, | ||
{ name: "description", content: "Welcome to the Arcjet + Remix example app!" }, | ||
]; | ||
}; | ||
|
||
export async function loader(args: LoaderFunctionArgs) { | ||
const decision = await aj.protect(args); | ||
|
||
if (decision.isDenied()) { | ||
throw new Response(null, { status: 429, statusText: "Too Many Requests" }) | ||
} | ||
|
||
return json({ message: "Hello Arcjet" }) | ||
} | ||
|
||
export async function action(args: ActionFunctionArgs) { | ||
const decision = await aj.protect(args); | ||
|
||
if (decision.isDenied()) { | ||
throw new Response(null, { status: 400, statusText: "Form contains sensitive info" }) | ||
} | ||
|
||
return redirect("/"); | ||
} | ||
|
||
export default function Index() { | ||
const data = useLoaderData<typeof loader>() | ||
return ( | ||
<div className="flex h-screen items-center justify-center"> | ||
<div className="flex flex-col items-center gap-16"> | ||
<header className="flex flex-col items-center gap-9"> | ||
<h1 className="leading text-2xl font-bold text-gray-800 dark:text-gray-100"> | ||
{data.message} | ||
</h1> | ||
</header> | ||
<Form method="post"> | ||
<input type="text" name="email" defaultValue="192.168.1.1" /> | ||
<div> | ||
<button type="submit">Check Sensitive Info</button> | ||
</div> | ||
</Form> | ||
</div> | ||
</div> | ||
); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
@tailwind base; | ||
@tailwind components; | ||
@tailwind utilities; | ||
|
||
html, | ||
body { | ||
@apply bg-white dark:bg-gray-950; | ||
|
||
@media (prefers-color-scheme: dark) { | ||
color-scheme: dark; | ||
} | ||
} |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
{ | ||
"name": "remix-express", | ||
"private": true, | ||
"sideEffects": false, | ||
"type": "module", | ||
"scripts": { | ||
"build": "remix vite:build", | ||
"dev": "node ./server.js", | ||
"lint": "eslint --ignore-path .gitignore --cache --cache-location ./node_modules/.cache/eslint .", | ||
"start": "node --env-file=.env ./server.js", | ||
"typecheck": "tsc" | ||
}, | ||
"dependencies": { | ||
"@arcjet/remix": "file:../../arcjet-remix", | ||
"@remix-run/express": "^2.12.1", | ||
"@remix-run/node": "^2.12.1", | ||
"@remix-run/react": "^2.12.1", | ||
"compression": "^1.7.4", | ||
"cross-env": "^7.0.3", | ||
"express": "^4.19.2", | ||
"isbot": "^4.1.0", | ||
"morgan": "^1.10.0", | ||
"react": "^18.2.0", | ||
"react-dom": "^18.2.0" | ||
}, | ||
"devDependencies": { | ||
"@remix-run/dev": "^2.12.1", | ||
"@types/compression": "^1.7.5", | ||
"@types/express": "^4.17.20", | ||
"@types/morgan": "^1.9.9", | ||
"@types/react": "^18.2.20", | ||
"@types/react-dom": "^18.2.7", | ||
"@typescript-eslint/eslint-plugin": "^6.7.4", | ||
"@typescript-eslint/parser": "^6.7.4", | ||
"autoprefixer": "^10.4.19", | ||
"eslint": "^8.38.0", | ||
"eslint-import-resolver-typescript": "^3.6.1", | ||
"eslint-plugin-import": "^2.28.1", | ||
"eslint-plugin-jsx-a11y": "^6.7.1", | ||
"eslint-plugin-react": "^7.33.2", | ||
"eslint-plugin-react-hooks": "^4.6.0", | ||
"postcss": "^8.4.38", | ||
"tailwindcss": "^3.4.4", | ||
"typescript": "^5.1.6", | ||
"vite": "^5.1.0" | ||
}, | ||
"engines": { | ||
"node": ">=20.0.0" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
export default { | ||
plugins: { | ||
tailwindcss: {}, | ||
autoprefixer: {}, | ||
}, | ||
}; |
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
import { createRequestHandler } from "@remix-run/express"; | ||
import compression from "compression"; | ||
import express from "express"; | ||
import morgan from "morgan"; | ||
import { getLoadContext } from "@arcjet/remix"; | ||
|
||
const viteDevServer = | ||
process.env.NODE_ENV === "production" | ||
? undefined | ||
: await import("vite").then((vite) => | ||
vite.createServer({ | ||
server: { middlewareMode: true }, | ||
}) | ||
); | ||
|
||
const remixHandler = createRequestHandler({ | ||
build: viteDevServer | ||
? () => viteDevServer.ssrLoadModule("virtual:remix/server-build") | ||
: await import("./build/server/index.js"), | ||
// Ensure you provide Arcjet's `getLoadContext` function so the client's IP | ||
// address will be provided to your `protect()` calls. | ||
getLoadContext, | ||
// If you need to provide you own values in the context, you can use the `...` | ||
// syntax in combination with Arcjet's `getLoadContext` function. For example: | ||
// getLoadContext(...args) { | ||
// return { | ||
// ...getLoadContext(...args), | ||
// anyAdditional: "values" | ||
// } | ||
// }, | ||
}); | ||
|
||
const app = express(); | ||
|
||
app.use(compression()); | ||
|
||
// http://expressjs.com/en/advanced/best-practice-security.html#at-a-minimum-disable-x-powered-by-header | ||
app.disable("x-powered-by"); | ||
|
||
// handle asset requests | ||
if (viteDevServer) { | ||
app.use(viteDevServer.middlewares); | ||
} else { | ||
// Vite fingerprints its assets so we can cache forever. | ||
app.use( | ||
"/assets", | ||
express.static("build/client/assets", { immutable: true, maxAge: "1y" }) | ||
); | ||
} | ||
|
||
// Everything else (like favicon.ico) is cached for an hour. You may want to be | ||
// more aggressive with this caching. | ||
app.use(express.static("build/client", { maxAge: "1h" })); | ||
|
||
app.use(morgan("tiny")); | ||
|
||
// handle SSR requests | ||
app.all("*", remixHandler); | ||
|
||
const port = process.env.PORT || 3000; | ||
app.listen(port, () => | ||
console.log(`Express server listening at http://localhost:${port}`) | ||
); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
import type { Config } from "tailwindcss"; | ||
|
||
export default { | ||
content: ["./app/**/{**,.client,.server}/**/*.{js,jsx,ts,tsx}"], | ||
theme: { | ||
extend: { | ||
fontFamily: { | ||
sans: [ | ||
'"Inter"', | ||
"ui-sans-serif", | ||
"system-ui", | ||
"sans-serif", | ||
'"Apple Color Emoji"', | ||
'"Segoe UI Emoji"', | ||
'"Segoe UI Symbol"', | ||
'"Noto Color Emoji"', | ||
], | ||
}, | ||
}, | ||
}, | ||
plugins: [], | ||
} satisfies Config; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
{ | ||
"include": [ | ||
"**/*.ts", | ||
"**/*.tsx", | ||
"**/.server/**/*.ts", | ||
"**/.server/**/*.tsx", | ||
"**/.client/**/*.ts", | ||
"**/.client/**/*.tsx" | ||
], | ||
"compilerOptions": { | ||
"lib": ["DOM", "DOM.Iterable", "ES2022"], | ||
"types": ["@remix-run/node", "vite/client"], | ||
"isolatedModules": true, | ||
"esModuleInterop": true, | ||
"jsx": "react-jsx", | ||
"module": "ESNext", | ||
"moduleResolution": "Bundler", | ||
"resolveJsonModule": true, | ||
"target": "ES2022", | ||
"strict": true, | ||
"allowJs": true, | ||
"skipLibCheck": true, | ||
"forceConsistentCasingInFileNames": true, | ||
"baseUrl": ".", | ||
"paths": { | ||
"~/*": ["./app/*"] | ||
}, | ||
|
||
// Vite takes care of building everything, not tsc. | ||
"noEmit": true | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
import { vitePlugin as remix } from "@remix-run/dev"; | ||
import { defineConfig } from "vite"; | ||
|
||
export default defineConfig({ | ||
plugins: [ | ||
remix({ | ||
future: { | ||
v3_fetcherPersist: true, | ||
v3_relativeSplatPath: true, | ||
v3_throwAbortReason: true, | ||
}, | ||
}), | ||
], | ||
}); |
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters