Skip to content

Security Fix: Add CSRF Protection to API Requests (Frontend) #371

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Security Fix: Add CSRF Protection to API Requests (Frontend) #371

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
102 changes: 24 additions & 78 deletions frontend/src/providers/ApiProvider.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,58 +1,18 @@
import React from "react";
import Endpoints, {getEndpoint} from "../endpoints";

export type TApiCallOptions = Partial<Omit<RequestInit, "signal" | "body">> & {
abortController?: AbortController,
autoRefreshToken?: boolean,
body?: any,
params?: { [k: string]: string },
query?: URLSearchParams,
};

export type TApiCallResult = {
controller: AbortController,
promise: Promise<Response>,
}

export type TApiProvider = {
call: (endpoint: keyof typeof Endpoints, options?: TApiCallOptions) => TApiCallResult,
getCsrfToken: () => string,
}

export const ApiContext = React.createContext<TApiProvider>({
call: () => ({
controller: new AbortController(),
promise: Promise.resolve(new Response()),
}),
getCsrfToken: () => "",
})

export default function ApiProvider(props: React.PropsWithChildren) {
const [csrfToken] = React.useState<string>(
document.querySelector(`[name="csrfmiddlewaretoken"]`)?.getAttribute("value") ?? ""
);

const getCsrfToken = React.useCallback(() => {
return csrfToken;
}, [csrfToken]);
const getCsrfToken = React.useCallback(() => csrfToken, [csrfToken]);

function handleError(e: any, reject: (reason?: any) => void) {
let isHandled = false;

if (e instanceof DOMException) {
if (e.name === "AbortError") {
isHandled = true;
} else if (e.name === "NetworkError") {
isHandled = true;
}
if (e.name === "AbortError") isHandled = true;
else if (e.name === "NetworkError") isHandled = true;
}

reject(e);

if (window.APP_SETTINGS.debug) {
console.error(e);
}

if (window.APP_SETTINGS.debug) console.error(e);
return isHandled;
}

Expand All @@ -62,45 +22,42 @@ export default function ApiProvider(props: React.PropsWithChildren) {
): TApiCallResult => {
let isNotFormData = true;
const abortController = options?.abortController ?? new AbortController();
const headers = (options?.headers ?? {}) as { [key: string]: string };
const headers = (options?.headers ?? {}) as { [key: string]: string };
const credentials = options?.credentials ?? "same-origin";
const queries = options?.query ? "?" + options?.query : "";
let body = options?.body;

headers["pragma"] = "no-cache";
headers["cache-control"] = "no-cache";

if (body && body instanceof FormData) {
isNotFormData = false;
}
if (body && body instanceof FormData) isNotFormData = false;

if (isNotFormData && !Object.hasOwn(headers, "Content-Type")) {
headers["Content-Type"] = "application/json";
headers["Accept"] = "application/json";

if (body) {
body = JSON.stringify(body);
}
if (body) body = JSON.stringify(body);
}

let [method, url] = getEndpoint(endpoint);
const finalOptions = options ?? {};


// Add CSRF token for state-changing requests
if (method !== 'GET' && method !== 'HEAD' && csrfToken) {
headers["X-CSRFToken"] = csrfToken;
}

const finalOptions = options ?? {};
Object.assign(finalOptions, {
cache: options?.cache ?? "no-cache",
credentials,
headers,
headers, // ← Now headers includes CSRF token
method,
signal: abortController.signal,
});

if (body) {
Object.assign(finalOptions, {body});
}
if (body) Object.assign(finalOptions, { body });

if (window.APP_SETTINGS.debug) {
console.info(Endpoints[endpoint], finalOptions);
}
if (window.APP_SETTINGS.debug) console.info(Endpoints[endpoint], finalOptions);

if (options?.params) {
for (let pk in options.params) {
Expand All @@ -109,14 +66,8 @@ export default function ApiProvider(props: React.PropsWithChildren) {
}

let hostname = window.APP_SETTINGS.hostname;

if (!hostname.endsWith("/")) {
hostname = hostname + "/";
}

if (url.startsWith("http://") || url.startsWith("https://")) {
hostname = "";
}
if (!hostname.endsWith("/")) hostname += "/";
if (url.startsWith("http://") || url.startsWith("https://")) hostname = "";

const promise = new Promise<Response>((resolve, reject) => {
try {
Expand All @@ -128,18 +79,13 @@ export default function ApiProvider(props: React.PropsWithChildren) {
}
});

return {controller: abortController, promise};
}, []);
return { controller: abortController, promise };
}, [csrfToken]);

const providerValue = React.useMemo<TApiProvider>(() => {
return {
call,
getCsrfToken,
};
}, [
const providerValue = React.useMemo<TApiProvider>(() => ({
call,
getCsrfToken,
]);
}), [call, getCsrfToken]);

return (
<ApiContext.Provider value={providerValue}>
Expand All @@ -150,4 +96,4 @@ export default function ApiProvider(props: React.PropsWithChildren) {

export function useApi(): TApiProvider {
return React.useContext(ApiContext);
}
}