-
Notifications
You must be signed in to change notification settings - Fork 59
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #96 from reactjs/sync-9aa84b19
Sync with react.dev @ 9aa84b1
- Loading branch information
Showing
8 changed files
with
371 additions
and
7 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
153 changes: 153 additions & 0 deletions
153
src/content/reference/react/experimental_taintObjectReference.md
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,153 @@ | ||
| --- | ||
| title: experimental_taintObjectReference | ||
| --- | ||
|
|
||
| <Wip> | ||
|
|
||
| **This API is experimental and is not available in a stable version of React yet.** | ||
|
|
||
| You can try it by upgrading React packages to the most recent experimental version: | ||
|
|
||
| - `react@experimental` | ||
| - `react-dom@experimental` | ||
| - `eslint-plugin-react-hooks@experimental` | ||
|
|
||
| Experimental versions of React may contain bugs. Don't use them in production. | ||
|
|
||
| This API is only available inside React Server Components. | ||
|
|
||
| </Wip> | ||
|
|
||
|
|
||
| <Intro> | ||
|
|
||
| `taintObjectReference` lets you prevent a specific object instance from being passed to a Client Component like a `user` object. | ||
|
|
||
| ```js | ||
| experimental_taintObjectReference(message, object); | ||
| ``` | ||
|
|
||
| To prevent passing a key, hash or token, see [`taintUniqueValue`](/reference/react/experimental_taintUniqueValue). | ||
|
|
||
| </Intro> | ||
|
|
||
| <InlineToc /> | ||
|
|
||
| --- | ||
|
|
||
| ## Reference {/*reference*/} | ||
|
|
||
| ### `taintObjectReference(message, object)` {/*taintobjectreference*/} | ||
|
|
||
| Call `taintObjectReference` with an object to register it with React as something that should not be allowed to be passed to the Client as is: | ||
|
|
||
| ```js | ||
| import {experimental_taintObjectReference} from 'react'; | ||
|
|
||
| experimental_taintObjectReference( | ||
| 'Do not pass ALL environment variables to the client.', | ||
| process.env | ||
| ); | ||
| ``` | ||
|
|
||
| [See more examples below.](#usage) | ||
|
|
||
| #### Parameters {/*parameters*/} | ||
|
|
||
| * `message`: The message you want to display if the object gets passed to a Client Component. This message will be displayed as a part of the Error that will be thrown if the object gets passed to a Client Component. | ||
|
|
||
| * `object`: The object to be tainted. Functions and class instances can be passed to `taintObjectReference` as `object`. Functions and classes are already blocked from being passed to Client Components but the React's default error message will be replaced by what you defined in `message`. When a specific instance of a Typed Array is passed to `taintObjectReference` as `object`, any other copies of the Typed Array will not be tainted. | ||
|
|
||
| #### Returns {/*returns*/} | ||
|
|
||
| `experimental_taintObjectReference` returns `undefined`. | ||
|
|
||
| #### Caveats {/*caveats*/} | ||
|
|
||
| - Recreating or cloning a tainted object creates a new untained object which main contain sensetive data. For example, if you have a tainted `user` object, `const userInfo = {name: user.name, ssn: user.ssn}` or `{...user}` will create new objects which are not tainted. `taintObjectReference` only protects against simple mistakes when the object is passed through to a Client Component unchanged. | ||
|
|
||
| <Pitfall> | ||
|
|
||
| **Do not rely on just tainting for security.** Tainting an object doesn't prevent leaking of every possible derived value. For example, the clone of a tainted object will create a new untained object. Using data from a tainted object (e.g. `{secret: taintedObj.secret}`) will create a new value or object that is not tainted. Tainting is a layer of protection, a secure app will have multiple layers of protection, well designed APIs, and isolation patterns. | ||
|
|
||
| </Pitfall> | ||
|
|
||
| --- | ||
|
|
||
| ## Usage {/*usage*/} | ||
|
|
||
| ### Prevent user data from unintentionally reaching the client {/*prevent-user-data-from-unintentionally-reaching-the-client*/} | ||
|
|
||
| A Client Component should never accept objects that carry sensitive data. Ideally, the data fetching functions should not expose data that the current user should not have access to. Sometimes mistakes happen during refactoring. To protect against this mistakes happening down the line we can "taint" the user object in our data API. | ||
|
|
||
| ```js | ||
| import {experimental_taintObjectReference} from 'react'; | ||
|
|
||
| export async function getUser(id) { | ||
| const user = await db`SELECT * FROM users WHERE id = ${id}`; | ||
| experimental_taintObjectReference( | ||
| 'Do not pass the entire user object to the client. ' + | ||
| 'Instead, pick off the specific properties you need for this use case.', | ||
| user, | ||
| ); | ||
| return user; | ||
| } | ||
| ``` | ||
|
|
||
| Now whenever anyone tries to pass this object to a Client Component, an error will be thrown with the passed in error message instead. | ||
|
|
||
| <DeepDive> | ||
|
|
||
| #### Protecting against leaks in data fetching {/*protecting-against-leaks-in-data-fetching*/} | ||
|
|
||
| If you're running a Server Components environment that has access to sensitive data, you have to be careful not to pass objects straight through: | ||
|
|
||
| ```js | ||
| // api.js | ||
| export async function getUser(id) { | ||
| const user = await db`SELECT * FROM users WHERE id = ${id}`; | ||
| return user; | ||
| } | ||
| ``` | ||
|
|
||
| ```js | ||
| import { getUser } from 'api.js'; | ||
| import { InfoCard } from 'components.js'; | ||
|
|
||
| export async function Profile(props) { | ||
| const user = await getUser(props.userId); | ||
| // DO NOT DO THIS | ||
| return <InfoCard user={user} />; | ||
| } | ||
| ``` | ||
|
|
||
| ```js | ||
| // components.js | ||
| "use client"; | ||
|
|
||
| export async function InfoCard({ user }) { | ||
| return <div>{user.name}</div>; | ||
| } | ||
| ``` | ||
|
|
||
| Ideally, the `getUser` should not expose data that the current user should not have access to. To prevent passing the `user` object to a Client Component down the line we can "taint" the user object: | ||
|
|
||
|
|
||
| ```js | ||
| // api.js | ||
| import {experimental_taintObjectReference} from 'react'; | ||
|
|
||
| export async function getUser(id) { | ||
| const user = await db`SELECT * FROM users WHERE id = ${id}`; | ||
| experimental_taintObjectReference( | ||
| 'Do not pass the entire user object to the client. ' + | ||
| 'Instead, pick off the specific properties you need for this use case.', | ||
| user, | ||
| ); | ||
| return user; | ||
| } | ||
| ``` | ||
|
|
||
| Now if anyone tries to pass the `user` object to a Client Component, an error will be thrown with the passed in error message. | ||
|
|
||
| </DeepDive> |
Oops, something went wrong.