Skip to content

fix(audits/server): Prefer using POST #77

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 12, 2023
Merged

fix(audits/server): Prefer using POST #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e133b49
use post
enisdenjo Apr 12, 2023
55b07d8
docs(implementations): audit report [skip ci]
github-actions[bot] Apr 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 3 additions & 40 deletions implementations/apollo-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,16 @@

<ul>
<li><b>37</b> audits in total</li>
<li><span style="font-family: monospace">✅</span> <b>30</b> pass</li>
<li><span style="font-family: monospace">⚠️</span> <b>7</b> warnings (optional)</li>
<li><span style="font-family: monospace">✅</span> <b>31</b> pass</li>
<li><span style="font-family: monospace">⚠️</span> <b>6</b> warnings (optional)</li>
</ul>

<h2>Passing</h2>
<ol>
<li><code>22EB</code> SHOULD accept application/graphql-response+json and match the content-type</li>
<li><code>4655</code> MUST accept application/json and match the content-type</li>
<li><code>47DE</code> SHOULD accept */* and use application/json for the content-type</li>
<li><code>80D8</code> SHOULD assume application/json content-type when accept is missing</li>
<li><code>82A3</code> MUST use utf-8 encoding when responding</li>
<li><code>BF61</code> MUST accept utf-8 encoded request</li>
<li><code>78D5</code> MUST assume utf-8 in request if encoding is unspecified</li>
Expand Down Expand Up @@ -45,44 +46,6 @@
<h2>Warnings</h2>
The server <i>SHOULD</i> support these, but is not required.
<ol>
<li><code>80D8</code> SHOULD assume application/json content-type when accept is missing
<details>
<summary>Response status code is not 200</summary>
<pre><code class="lang-json">{
"statusText": "Bad Request",
"status": 400,
"headers": {
"x-powered-by": "Express",
"etag": "W/\"5b5-gDRXf8j0lbjWbmQpeY60iENT2cI\"",
"date": "<timestamp>",
"content-type": "application/json; charset=utf-8",
"content-length": "1461",
"connection": "close",
"access-control-allow-origin": "*"
},
"body": {
"errors": [
{
"message": "This operation has been blocked as a potential Cross-Site Request Forgery (CSRF). Please either specify a 'content-type' header (with a type that is not one of application/x-www-form-urlencoded, multipart/form-data, text/plain) or provide a non-empty value for one of the following headers: x-apollo-operation-name, apollo-require-preflight\n",
"extensions": {
"stacktrace": [
"BadRequestError: This operation has been blocked as a potential Cross-Site Request Forgery (CSRF). Please either specify a 'content-type' header (with a type that is not one of application/x-www-form-urlencoded, multipart/form-data, text/plain) or provide a non-empty value for one of the following headers: x-apollo-operation-name, apollo-require-preflight",
"",
" at new GraphQLErrorWithCode (file:///home/runner/work/graphql-http/graphql-http/node_modules/@apollo/server/dist/esm/internalErrorClasses.js:7:9)",
" at new BadRequestError (file:///home/runner/work/graphql-http/graphql-http/node_modules/@apollo/server/dist/esm/internalErrorClasses.js:75:9)",
" at preventCsrf (file:///home/runner/work/graphql-http/graphql-http/node_modules/@apollo/server/dist/esm/preventCsrf.js:29:11)",
" at ApolloServer.executeHTTPGraphQLRequest (file:///home/runner/work/graphql-http/graphql-http/node_modules/@apollo/server/dist/esm/ApolloServer.js:478:17)",
" at process.processTicksAndRejections (node:internal/process/task_queues:95:5)"
],
"code": "BAD_REQUEST"
}
}
]
}
}
</code></pre>
</details>
</li>
<li><code>5A70</code> MAY accept application/x-www-form-urlencoded formatted GET requests
<details>
<summary>Response status code is not 200</summary>
Expand Down
4 changes: 2 additions & 2 deletions implementations/apollo-server/report.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"total": 37,
"ok": 30,
"warn": 7,
"ok": 31,
"warn": 6,
"error": 0
}
29 changes: 3 additions & 26 deletions implementations/postgraphile/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@

<ul>
<li><b>37</b> audits in total</li>
<li><span style="font-family: monospace">✅</span> <b>29</b> pass</li>
<li><span style="font-family: monospace">⚠️</span> <b>8</b> warnings (optional)</li>
<li><span style="font-family: monospace">✅</span> <b>30</b> pass</li>
<li><span style="font-family: monospace">⚠️</span> <b>7</b> warnings (optional)</li>
</ul>

<h2>Passing</h2>
<ol>
<li><code>4655</code> MUST accept application/json and match the content-type</li>
<li><code>47DE</code> SHOULD accept */* and use application/json for the content-type</li>
<li><code>80D8</code> SHOULD assume application/json content-type when accept is missing</li>
<li><code>82A3</code> MUST use utf-8 encoding when responding</li>
<li><code>BF61</code> MUST accept utf-8 encoded request</li>
<li><code>78D5</code> MUST assume utf-8 in request if encoding is unspecified</li>
Expand Down Expand Up @@ -65,30 +66,6 @@ The server <i>SHOULD</i> support these, but is not required.
</code></pre>
</details>
</li>
<li><code>80D8</code> SHOULD assume application/json content-type when accept is missing
<details>
<summary>Response status code is not 200</summary>
<pre><code class="lang-json">{
"statusText": "Method Not Allowed",
"status": 405,
"headers": {
"date": "<timestamp>",
"content-type": "application/json; charset=utf-8",
"content-length": "60",
"connection": "close",
"allow": "POST, OPTIONS"
},
"body": {
"errors": [
{
"message": "Only `POST` requests are allowed."
}
]
}
}
</code></pre>
</details>
</li>
<li><code>5A70</code> MAY accept application/x-www-form-urlencoded formatted GET requests
<details>
<summary>Response status code is not 200</summary>
Expand Down
4 changes: 2 additions & 2 deletions implementations/postgraphile/report.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"total": 37,
"ok": 29,
"warn": 8,
"ok": 30,
"warn": 7,
"error": 0
}
10 changes: 7 additions & 3 deletions src/audits/server.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,10 +94,14 @@ export function serverAudits(opts: ServerAuditOptions): Audit[] {
'80D8',
'SHOULD assume application/json content-type when accept is missing',
async () => {
const url = new URL(await getUrl(opts.url));
url.searchParams.set('query', '{ __typename }');
const res = await fetchFn(await getUrl(opts.url), {
method: 'POST',
headers: {
'content-type': 'application/json',
},
body: JSON.stringify({ query: '{ __typename }' }),
});

const res = await fetchFn(url.toString());
ressert(res).status.toBe(200);
ressert(res).header('content-type').toContain('application/json');
},
Expand Down